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プレーン テキストのパスワード。
  • AES/CBC/PKCS5Padding

  • DES/CBC/PKCS5Padding

  • DESede/CBC/PKCS5Padding

algorithmKeyアルゴリズム キーは上記で選択したアルゴリズムと一致している必要があります。
  • AES

  • DES

  • DESede

サンプル JSON オブジェクトをご参照ください...


To encrypt your database password:

Step 1: Encrypt the password:

  1. <Bamboo-installation-directory>/tools/atlassian-password に移動します。
  2. 次のコマンドを実行してパスワードを暗号化します。以下に示すオプションのパラメータを使用することもできます。

    java -cp "./*" -c com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher
    See optional arguments...
    • -- silent -s: ロギングを最小限に制限します

    • -- help -h: すべてのパラメータを含むヘルプ メッセージを出力します

    • -- mode -m: パスワード処理方法を暗号化または 復号化として定義します。省略した場合は "encrypt" が使用されます

    • -- password -p: 必要な引数を持つ JSON オブジェクト。省略した場合、入力を求められます。パスワードが履歴に保存されないように、このパラメータを省略することをおすすめします。

  3. When prompted, provide the required arguments in a JSON object. 

Step 2: Secure the generated files:

  1. 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.
    •[timestamp]- Algorithm parameters used to encrypt your password. You will need this file only if you wanted to recreate an encrypted password

Step 3: (optionalStore 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.

  1. Store the two of the generated files as environment variables:

    export com_atlassian_db_config_password_ciphers_algorithm_javax_crypto_spec_SecretKeySpec=/home/bamboo/javax.crypto.spec.SecretKeySpec_123456789
    export com_atlassian_db_config_password_ciphers_algorithm_javax_crypto_SealedObject=/home/bamboo/javax.crypto.SealedObject_123456789
  2. Edit 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:

  1. Go to Bamboo home directory and back up the bamboo.cfg.xml file. Move the backup to a safe place outside of your Bamboo server.

  2. In the bamboo.cfg.xml file, 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.xml file, 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>
  3. Bamboo を再起動します。

To decrypt your database password:

  1. Run the encryption command with the -m decrypt parameter:

    java -cp "./*" -c com.atlassian.db.config.password.ciphers.algorithm.AlgorithmCipher -m decrypt
  2. JSON オブジェクトを求められたら、bamboo.cfg.xml ファイルのいずれかのオブジェクトを指定します。

    Sample JSON object when using file paths...


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:[timestamp]

これらのファイルを見つけたら、JSON オブジェクトで 2 つの追加フィールドを使用して暗号化ツールでその場所を指すことができます。これらのフィールドの説明とサンプル JSON オブジェクトは次のとおりです。

フィールド 説明
keyFilePathPath to a file that contains the key used to encrypt your original password, e.g. javax.crypto.spec.SecretKeySpec_[timestamp].

ファイル パスを環境変数として保存した場合、このパラメータを省略できます。

algorithmParametersFilePathPath to a file that contains the algorithm parameters used to encrypt your original password, e.g.[timestamp].

Example of a JSON object with all fields:

{"plainTextPassword":"yourPassword", "algorithm":"AES/CBC/PKCS5PADDING", "algorithmKey":"AES", "algorithmParametersFilePath":"", "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.

最終更新日 2021 年 7 月 13 日


Powered by Confluence and Scroll Viewport.