Advanced database password encryption
To add extra security to your Bamboo instance, you can encrypt the database password that is stored in the configuration file used by Bamboo to access your database. In this advanced method, you can use the Cipher algorithm that allows you to choose the algorithm used to encrypt your password. It provides more security as you don't have to store the encrypted password anywhere in the configuration file, which makes it difficult to find and decrypt.
This solution is an obfuscation, which doesn’t assure real security. Bamboo still needs to use the plain text password to connect to your database, so the configuration will contain all the information needed to decrypt the password. An attacker could act like Bamboo to obtain the password. We recommend that you secure the server where Bamboo and the database reside.
はじめる前に
Prepare a JSON object which contains all arguments required to encrypt your password using the following information:
| フィールド | 説明 |
|---|---|
plainTextPassword | プレーン テキストのパスワード。 |
algorithm | 以下のアルゴリズムから1つ選択します。
|
algorithmKey | アルゴリズム キーは上記で選択したアルゴリズムと一致している必要があります。
|
To encrypt your database password:
Step 1: Encrypt the password:
<Bamboo-installation-directory>/tools/atlassian-passwordに移動します。次のコマンドを実行してパスワードを暗号化します。以下に示すオプションのパラメータを使用することもできます。
java -cp "./*" com.atlassian.db.config.password.tools.CipherTool -c com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher- When prompted, provide the required arguments in a JSON object.
Step 2: Secure the generated files:
Secure the generated files:
Move the files generated by the tool to a secure place, and change them to read-only. Bamboo needs to be able to access and read those files to decrypt your password and connect to the database.
次のファイルが生成されています。
javax.crypto.SealedObject_[timestamp] - file with the encrypted password.javax.crypto.spec.SecretKeySpec_[timestamp]- key used to encrypt your password. You will need this file to decrypt your password.java.security.AlgorithmParameters_[timestamp]-Algorithm parameters used to encrypt your password. You will need this file only if you wanted to recreate an encrypted password.
Step 3: (optional) Store file paths as environment variables:
You can store paths to the generated files as environment variables. If the paths aren't present in the bamboo.cfg.xml file, Bamboo will automatically look for them in the specific environment variables. In this way, file paths will not be stored in the bamboo.cfg.xml file, making it difficult to locate the files used for encryption.
Store the two of the generated files as environment variables:
com_atlassian_db_config_password_ciphers_algorithm_javax_crypto_spec_SecretKeySpec com_atlassian_db_config_password_ciphers_algorithm_javax_crypto_SealedObjectEdit the output from Step 1 and remove paths to the files. The final output should look similar to the following JSON object:
<property name="jdbc.password.decrypter.classname">com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher</property> <property name="hibernate.connection.password">{}</property>
Step 4: Adding the encrypted password to bamboo.cfg.xml:
Go to Bamboo home directory and back up the
bamboo.cfg.xmlfile. Move the backup to a safe place outside of your Bamboo server.- In the
bamboo.cfg.xmlfile, replace the content of the<property name="hibernate.connection.password">tag with the output JSON object. Depending on whether you used environment variables or not, adjust the JSON object to one of the following examples:ファイル パスを環境変数として保存した場合、出力からパスを削除します。以下の例のようになります。
<property name="jdbc.password.decrypter.classname">com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher</property> <property name="hibernate.connection.password">{}</property>If you didn't use environment variables and want to stick to file paths in the
bamboo.cfg.xmlfile, make sure you updated them after moving the files to a secure place. The output should look like the following example:<property name="jdbc.password.decrypter.classname">com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher</property> <property name="hibernate.connection.password">{"sealedObjectFilePath":"javax.crypto.SealedObject_1621327067811","keyFilePath":"javax.crypto.spec.SecretKeySpec_1621327067777"}</property>You need to additionally escape the file paths and change double quotes (") surrounding the path to single quotes (') to avoid JSON parsing errors. The paths should look like the following example:
<property name="jdbc.password.decrypter.classname">com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher</property> <property name="hibernate.connection.password">{"sealedObjectFilePath":'C:\\bamboo\\javax.crypto.SealedObject_123456789',"keyFilePath":"'C:\\bamboo\\javax.crypto.spec.SecretKeySpec_123456789'"}</property>
- Bamboo を再起動します。
To decrypt your database password:
Run the encryption command with the -m decrypt parameter:
java -cp "./*" com.atlassian.db.config.password.tools.CipherTool -c com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher -m decryptJSON オブジェクトを求められたら、
bamboo.cfg.xmlファイルのいずれかのオブジェクトを指定します。
暗号化されたパスワードの再作成
When you lose the encrypted password and encrypt the plain text password once again, the new encrypted password will look differently. This is not an issue, as it will still represent the same plain text password. However, in some cases, you might want to keep the consistency, for example by having the same encrypted password for all Bamboo Data Center nodes.
以前とまったく同じ方法でパスワードを暗号化するには、元のパスワードの暗号化に使用したキーとアルゴリズム パラメータが必要です。いずれもも暗号化ツールによって生成され、以下のファイルに保存されています。
Key:
javax.crypto.spec.SecretKeySpec_[timestamp]- Algorithm parameters:
java.security.AlgorithmParameters_[timestamp]
これらのファイルを見つけたら、JSON オブジェクトで 2 つの追加フィールドを使用して暗号化ツールでその場所を指すことができます。これらのフィールドの説明とサンプル JSON オブジェクトは次のとおりです。
| フィールド | 説明 |
|---|---|
keyFilePath | Path to a file that contains the key used to encrypt your original password, e.g. javax.crypto.spec.SecretKeySpec_[timestamp].ファイル パスを環境変数として保存した場合、このパラメータを省略できます。 |
algorithmParametersFilePath | Path to a file that contains the algorithm parameters used to encrypt your original password, e.g. java.security.AlgorithmParameters_[timestamp]. |
Example of a JSON object with all fields:
{"plainTextPassword":"yourPassword", "algorithm":"AES/CBC/PKCS5PADDING", "algorithmKey":"AES", "algorithmParametersFilePath":"java.security.AlgorithmParameters_123456789", "keyFilePath":"javax.crypto.spec.SecretKeySpec_123456789"}To encrypt the password, follow the steps in Step 1, and use the JSON object with they key and algorithm parameters.