Versions Compared

Key

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

This article includes updates for Smart ID Identity Manager 24.R1.

...

For more information, see Configure Tomcat below.

Prerequisites

  • Installed Smart ID 24.R1 or later

  • Installed and running HSM with PKCS#11 library available on the Identity Manager server

...

Do the Identity Manager HSM configuration in the file engineSignEncryptConfig.xml in the WEB-INF/classes folder for each of the relevant Identity Manager clients, i.e. IDM Admin and IDM Operator.
In case of Docker deployment, the file docker/compose/identitymanager/config/signencrypt.xml needs to be edited instead.

...

All four use different HSM certificates, see below in the keys section. The example uses the Utimaco CryptoServer with IDM Identity Manager running on Windows.

Example extract of config XML

...

Configuration attribute

Value

Comments

asymCipher

RSA/ECB/OAEPWithSHA-384AndMGF1Padding

Must be declared so the iD2 provider accepts it:

  • "None" is not supported as cipher mode but "ECB" is

  • In OAEP padding, all SHA-x hashes must be given with a dash in the name

<keys> section:

type name

HSM

Must be "HSM" for keys stored in the HSM.

locationValue

  • Either the absolute path of the HSM's P11 DLL/.so (without extension)
    OR

  • the DLL/.so's filename without extension

pin

The user PIN of the HSM.

The pin.encrypted attribute is also supported to scramble the PIN.

Note that for Docker deployments it is required to scramble the PINs before starting the IDM Identity Manager Admin and IDM Identity Manager Operator containers (stop them by invoking docker compose down from within docker/compose/identitymanager/admin and docker/compose/identitymanager/operator, if already running).
This is done by first replacing each pin="thePlainTextPin" with pin.encrypted="thePlainTextPin" and then invoking the following command from within the docker/compose/identitymanager/bootstrap folder: docker compose run --rm scramble_sign_encrypt_config

alias

The alias of the respective key.

In the HSM, the keypair and the certificate must be stored within the same label/alias.

slot

Optional if your keys are stored in HSM slot 0.

Note that the first slot is not guaranteed to be 0. Slot numbering may differ, depending on the HSM.

...

  • bcmail-*.jar

  • bcpgp-*.jar

  • bcpkix-*.jar

  • bcprov-*.jar (including bcprov-ext-*.jar)

Additional information

Expand
titleUseful links