Updating property files on application servers to use a custom key

Applies to: On premises

After you configure a custom encryption key, update the property files on your application servers to use the custom encryption key.

Before you begin

The following tasks must be completed before you begin:

Procedure

  1. Stop all OpenPages application servers, admin and non-admin.
  2. Copy the keystore.properties file to the <OP_HOME>/aurora/bin directory.
  3. Edit the aurora.properties file.
    1. Go to the <OP_HOME>/aurora/conf directory.
    2. Make a backup copy of the aurora.properties file.
    3. Open the aurora.properties file in a text editor.
    4. Change the following password value after the equal sign to plain text.
      security.system.password=<openpages_system_password>
    5. 9.1.1 and earlier Change the following password value after the equal sign to plain text.
      database.PASSWORD=<openpages_db_password>
    6. Save and close the file.
      When you restart the servers later in this task, the passwords are re-encrypted with the custom encryption key.
  4. Edit the aurora_auth.config file.
    1. Go to the <OP_HOME>/aurora/conf directory.
    2. Make a backup copy of the aurora_auth.config file.
    3. Open the aurora_auth.config file in a text editor.
    4. Locate the security.search.user.credentials parameter
    5. Change the value after the equal sign to plain text.
    6. Save and close the file.
      When you restart the servers later in this task, the password is re-encrypted with the custom key that you specified.
  5. Edit the bootstrap.properties file.
    1. Go to the <OP_HOME>/wlp-usr/servers/<server_name>Server<#> directory.
    2. Make a backup copy of the bootstrap.properties file.
    3. Open the bootstrap.properties file in a text editor.
    4. Change the following password value after the equal sign to plain text.
      op.jdbc.password=<jdbc_password>
    5. Save and close the file.
      When you restart the servers later in this task, the passwords are re-encrypted with the custom encryption key.
  6. Edit the op-backup-restore.env file.
    1. Go to the <OP_HOME>/aurora/bin directory.
    2. Make a backup copy of the op-backup-restore.env file.
    3. Open the op-backup-restore.env file in a text editor.
    4. Change the following password values after the equal sign to plain text.
      IBM® Db2®
      DB_OP_PWD: Type the password of the schema owner for the OpenPages database.
      Oracle
      • DB_SYSTEM_PWD: Type the password of the SYSTEM user for the OpenPages database.
      • DB_SYS_PWD: Type the password of the DBA user for the OpenPages database.
      • DB_OP_PWD: Type the password of the schema owner for the OpenPages database.
    5. Save and close the file.
  7. Re-encrypt the passwords in the op-backup-restore.env file with the custom encryption key that you specified.
    1. Go to the <OP_HOME>/aurora/bin directory.
    2. Run the following command:
      Windows
      OPBackup.cmd secure
      Linux
      ./OPBackup.sh secure
    3. Open the op-backup-restore.env file in a text editor and verify that the passwords are encrypted.
  8. If you are using a horizontal cluster, do steps 2-6 on each application server in the cluster.
  9. Start all OpenPages application servers, admin and non-admin.

Results

The passwords are encrypted with the custom encryption key that you specified in the keystore.properties file.