EncryptionKey

Passwords can be encrypted using the EncryptionUtil Java class, or the command-line "encrypt.bat" or "encrypt.sh" scripts if those are available to you. In order for the passwor...

sharedJavadoc: EncryptionKey

Notes

Passwords can be encrypted using the EncryptionUtil Java class, or the command-line "encrypt.bat" or "encrypt.sh" scripts if those are available to you.

In order for the password to be decrypted properly, you need to specify the encryption key used to encrypt it. The key can obtained from a few supported locations. The combination of the password key "value" and "source" is used to properly locate the key.

Examples

The following looks for the encryption key in an environment variable named MY_KEY_VAR.

YAML

passwordKey:
  source: ENVIRONMENT
  value: MY_KEY_VAR

JSON

{
  "passwordKey": {
    "source": "ENVIRONMENT",
    "value": "MY_KEY_VAR"
  }
}

XML

<passwordKey>
  <source>ENVIRONMENT</source>
  <value>MY_KEY_VAR</value>
</passwordKey>

Usage

Full configuration skeleton, with every option and its default

YAML

size: 0
source: KEY
value: string

JSON

{
  "size": 0,
  "source": "KEY",
  "value": "string"
}

XML

<encryptionKey>
  <size>0</size>
  <source>KEY</source>
  <value>string</value>
</encryptionKey>

Properties

Property	Type	Required	Default
size	integer	No	-
source	enum	No	-
value	string	No	-

Property Details

size

Size of the encryption key, in bits. If specified, it must be supported by your version of Java

source

What the encryption key value refers to.

Allowed Values

• KEY
• FILE
• ENVIRONMENT
• PROPERTY

value

Pointer to the an encryption key, or the encryption key itself.