Object

args4c

SecretConfig

Related Doc: package args4c

Permalink

object SecretConfig

Makes available a means to initialize a sensitive, encrypted config file via SecretConfig.writeSecretsUsingPrompt and ConfigApp.secretConfigForArgs

The idea is that a (service) user-only readable, password-protected AES encrypted config file can be set up via reading entries from standard input, and an application an use those configuration entries thereafter by taking the password from standard input.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SecretConfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Prompt = String

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val SecretEnvVariableName: String

    Permalink

    The environment variable which, if set, will be used to decrypt an encrypted config file (e.g.

    The environment variable which, if set, will be used to decrypt an encrypted config file (e.g. "--secret" for the default or "--secret=password.conf" for specifying one)

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def readConfigPassword(readLine: (String) ⇒ String): Array[Byte]

    Permalink

    readLine

    the standard-in read function

    returns

    the application config password used to encrypt the config

    Attributes
    protected

  17. def readSecretConfig(pathToEncryptedConfig: Path, readLine: (String) ⇒ String): Option[Config]

    Permalink

    read the configuration from the given path, prompting for the password via 'readLine' should the SecretEnvVariableName environment variable not be set

    read the configuration from the given path, prompting for the password via 'readLine' should the SecretEnvVariableName environment variable not be set

    pathToEncryptedConfig

    the path pointing at the encrypted config

    readLine

    the readline function to get user input

    returns

    a configuration if the file exists

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. def writeSecretsUsingPrompt(secretConfigFilePath: String, readLine: (Prompt) ⇒ String): Path

    Permalink

    prompt for and set some secret values

    prompt for and set some secret values

    readLine

    a means to accept user input for a particular prompt

    returns

    the path to the encrypted configuration file

Inherited from AnyRef

Inherited from Any

Ungrouped