Menu Search

8.5. Configuration Encryption

The Broker is capable of encrypting passwords and other security items stored in the Broker's configuration. This is means that items such as keystore/truststore passwords, JDBC passwords, and LDAP passwords can be stored in the configuration in a form that is difficult to read.

The Broker ships with an encryptor implementations called AESGCMKeyFile and AESKeyFile. This uses a securely generated random key of 256bit [9] to encrypt the secrets stored within a key file. Of course, the key itself must be guarded carefully, otherwise the passwords encrypted with it may be compromised. For this reason, the Broker ensures that the file's permissions allow the file to be read exclusively by the user account used for running the Broker.


AESKeyFile encryptor is considered as not safe, it is deprecated and will be removed in one of the next releases. AESGCMKeyFile encryptor should be used instead.


If the keyfile is lost or corrupted, the secrets will be irrecoverable.

8.5.1. Configuration

The AESGCMKeyFile or AESKeyFile encryptor providers are enabled/disabled via the Broker attributes within the Web Management Console. On enabling the provider, any existing passwords within the configuration will be automatically rewritten in the encrypted form.

Note that passwords stored by the Authentication Providers PlainPasswordFile and. PlainPasswordFile with the external password files are not encrypted by the key. Use the Scram Authentication Managers instead; these make use of the Configuration Encryption when storing the users' passwords.

8.5.2. Alternate Implementations

If the AESGCMKeyFile encryptor implementation does not meet the needs of the user, perhaps owing to the security standards of their institution, the ConfigurationSecretEncrypter interface is designed as an extension point. Users may implement their own implementation of ConfigurationSecretEncrypter perhaps to employ stronger encryption or delegating the storage of the key to an Enterprise Password Safe.

[9] Java Cryptography Extension (JCE) Unlimited Strength required