...
The Secret Manager initializes the secret repository and the keystores. It uses secret repository to keep the secret values (encrypted values). These secrets can be accessed through aliases. The keystore is required to create the decryption crypto, which can be used to resolve encrypted secrets values. The The keystore and secret repository Secret Repository are configurable nd the configuration can be done through the 'secret-conf.properties' file found in $GREG_HOMEthrough the <PRODUCT_HOME>/repository/conf/security/
directory.secret-conf.properties
file, which is generated once you execute the Cipher tool.
Secret Repository
This is used to store the secret values. Currently, there is only one secret repository implemented within secure vault and it is called the FileBaseSecretRepository. It uses cipher-text.properties which can be found in $GREG_HOMEthe <GREG_HOME>/repository/conf
directory. It cipher-text.properties
file, and stores aliases vs. their actual secrets in encrypted format (encrypted via a key in keystore). Any secret repositories can be written by implementing the SecretRepository and SecretRepositoryProvider classes.
...
- A file-base secret repository is used. The (<
GREG_HOME>/repository/conf/cipher-text.
properties file can be found in$GREG_HOME/repository/conf
directoryproperties
file). - Carbon Server's primary keystore is used for encrypting and decrypting passwords, which can be found in $GREGthe <
GREG_HOMEHOME>/repository/resources/security/
folder. - DefaultSecretCallbackHandler (org.wso2.carbon.securevault.DefaultSecretCallbackHandler) is used as the password resolver for the keystore and the private key passwords of the Carbon server's primary Keystore.
- SecretManagerSecretCallbackHandler (org.wso2.securevault.secret.handler.SecretManagerSecretCallbackHandler) is used as the password resolver for all the secret values which are defined in the carbon configuration files.
...
- This option allows the user to secure plain text passwords in carbon configuration files.
- Read alias values and their corresponding plain text passwords from the cipher-text.properties file. Note that the CipherTool identifies plain text defined within square brackets as the plain text passwords. If a password is not specified in the cipher-text.properties file for a corresponding alias, the user needs to provide it through the command-line.
- Check whether the alias is a known password alias in Carbon configurations. If the tool modifies the configuration element and file, then replace the configuration element with the alias name. Define a secret callback in the configuration file and add proper name spaces for defining the secure vault.
- Encrypt the plain text value using the primary keystore of the carbon server (Details of the primary keytore is taken from the carbon.xml file, which can be found in $GREG_HOME<
GREG_HOME>/repository/conf
directory/carbon.xml
file.) - Replace plain text values in the cipher-text.properties file with the encrypted passwords.
- Add the default configuration to secret-conf.properties file
...