Content Server Manual / Version 2406.1
Table Of ContentsIn order to encrypt passwords stored in property files, you can use an encryption service. For configuration of an encryption service consult Chapter 4, Encryption Service Setup in Deployment Manual.
Note
The encryptpasswordproperty tool requires the "Properties File Setup" configuration approach
of the Java Keystore based encryption service. However, encryption services can also be provided by
CoreMedia plugins. If you are using an encryption service from a plugin, consult the plugin documentation,
which might provide an alternative to this tool. In case no alternative is provided by the plugin,
the property encryption feature is not supported by the plugins encryption service.
Password Encryption
For each password you want to encrypt take the following steps:
Login as a user who can access the keystore and password file. Switch to the installation directory of the command line tools and enter the following command where
<plaintextpassword>should be replaced with the password you want to encrypt:bin/cm encryptpasswordproperty <plaintextpassword>
The command output is the encrypted password (which includes the curly brackets!) and some informational text. Use the
-roption (bin/cm encryptpasswordproperty -r <plaintextpassword>) to have the tool just dump out the encrypted password without other information.
Note
The tool will generate a unique value for the same plain text value each time you invoke it.
Copy the password (including the curly brackets) into your respective properties file. You can append a comment after the closing curly bracket to add information. For example:
sql.store.password={G/7UZ7hPQnGZ/xX4J/7b8FNp/ybEH/JU
Qp5c8NRoDEQSlK5ypbkwotfu6j8U1SHr
QifmKeAQUvou/+ES34/pRHs=} --- generated by User xxx on 28/03/2024
Verify a password
If you want to verify that a given encrypted password actually represents a given plaintext password, use
cm encryptpasswordproperty -c <plaintext password> <encrypted entry>
where <plaintext password> should be replaced with the password and <encrypted
entry> with the result of the encryption tool. The command will provide you with textual information
whether these passwords match. The command returns with return value "0" whether the tokens match or not.
Troubleshooting
The encryption service must not only be configured for the encryptpasswordproperty tool,
but also for every app using the encrypted password, for instance schemaaccess.
View the respective app log file. If an encrypted password cannot be decrypted, you will see an error message in your log file telling you so. Since password decryption is verified early on (fail fast), you will find the error messages shortly after the component, service, or server starts.
