SecureConfig

case
class SecureConfig(promptForInput: UserInput)
Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def readSecureConfigAtPath(pathToEncryptedConfig: Path): Option[Config]

read the configuration from the given path, prompting for the password via 'promptForInput' should the SecureConfig.SecureEnvVariableName environment variable not be set

read the configuration from the given path, prompting for the password via 'promptForInput' should the SecureConfig.SecureEnvVariableName environment variable not be set

Value Params
pathToEncryptedConfig

the path pointing at the encrypted config

Returns

a configuration if the file exists

def setupSecureConfig(defaultSecureConfigFilePath: Path, requiredPaths: Seq[String]): Path
Value Params
defaultSecureConfigFilePath

the default path to store the configuration in, either from the --secure=x/y/z user arg, and env variable or default

requiredPaths

a potentially empty list of configuration paths which need to have values specified

Returns

the path to the secure config

def updateSecureConfig(configPath: Path, requiredPaths: Seq[String]): Path

prompt for and set some secure values

prompt for and set some secure values

Value Params
configPath

the path where the secure config is written

requiredPaths

a potentially empty list of configuration paths which need to have values specified

Returns

the path to the encrypted configuration file

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product