Versions Compared

Version Old Version 9 New Version 10
Changes made by

Paul Zachos

Josefin Klang (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • You started using a productive Identity Manager installation while still using the supplied, insecure example keys. Those must be replaced by your own keys and any existing secret fields must be re-keyed with those keys.

  • You started using an Identity Manager installation based on soft-tokens for encrypting secret fields, and you want to improve security by switching to keys generated by a Hardware Security Module (HSM). Any existing keys must be re-keyed with the new keys.

  • The keys for secret field encryption have been compromised and existing secrets need to be re-keyed with new keys.

  • You want to change the keys for encryption of secret fields for any other reason and have existing secret fields in the database.

Prerequisites

This is a summary of what must be in place before the migration starts.Before the migration start, the following prerequisites apply:

  • A Windows host.

  • The same Java version as for the corresponding Identity Manager release is installed and its java.exe in your PATH. See Identity Manager requirements and interoperability.

  • Java has the Unlimited Strength Jurisdiction Policy Files installed.

  • The new keypair has been generated.

  • For every tenant on the system have access to:

    • tenant ID

    • administrative username + and password

Step-by-step instructions

...

  1. Open the file config/encryption-config.xml.

  2. Update the EncryptedFields and NewEncryptedFields field descriptors and their referenced keys as described below. For more information on this file, see 24.R1: Sign and encrypt engine in Identity Manager.

    • EncryptedFields is the old, to be replaced, descriptor. Adapt its values to match the ones that are currently set up in Identity Manager.
      In this example, EncryptedFields references oldEncCert as its key. Change the referenced key to match the one that is currently referenced in Identity Manager.

    • NewEncryptedFields is the new descriptor, holding the information of the replacement key. Change its values accordingly.
      In this example, NewEncryptedFields references newEncCert as its key. Change the referenced key to match the key that will replace the old one in Identity Manager.

Example : encryption-config.xml

...

Warning

The secret field store in the database is tenant-aware, even though the descriptors and keys are not.
Therefore The migration has to must be executed separatelyfor every single tenant before changing keys and descriptors in Identity Manager.

Configure migration for a tenant

...

During the migration, logs will be printed out to the console and in the file logs/idm_migration.log. If necessary, edit log4j.xml to customize the path of the log messages. Among other things, information  Information on previous runs of this tool by the same tenant will be logged, as well as other information.

Check for success

When Secret Fields Key Updater is finished, look in the logfile.

  • If you see the message "SUCCESS: Encrypted Fields Keypair changed!", the operation was successful. In this case, proceed with the next tenant, if any left, otherwise with the next section.

  • If you see the message "FAILED: Changing the Encrypted Fields Keypair FAILED with status ...", the application has failed. Restore your database from the dump you created earlier and contact Nexus.

After migration of all tenants

Make sure update is sucessful

Make sure the Secret Fields Key Updater successfully ran for every single tenant on the system.

Set up Identity Manager to use the new keypair

  1. For docker:
    Open docker/compose/identitymanager/config/signencrypt.xml for editing.
    or:
    For WAR file deployment: 
    Open  Open WEB-INF/classes/engineSignEncryptConfig.xml in Identity Manager Operator, Identity Manager Admin, and Identity Manager Tenant for editing.

  2. Change the attributes of the EncryptedFields descriptor and its referenced key to the values needed for the new keypair, as you set them for the NewEncryptedFields descriptor in the migration application. Note that the descriptor's name must still be EncryptedFields and not NewEncryptedFields for Identity Manager.

  3. For docker:
    Run docker compose up from within  docker/compose/identitymanager/<webappname>/ for all Identity Manager applications (Admin, Operator, and Tenant) to recreate the docker containers.
    or:
    For WAR file deployment:
    Start Identity Manager.