Net-attached HSM: Configuring a Thales DPoD

A Hardware Security Module (HSM) can be configured to store and protect cryptographic keys in a centralized, high-assurance appliance, providing a root of trust for sensitive cryptographic data transactions.

The following describes how to configure a Thales DPoD for the Next Generation Hardware Appliance by registering the appliance and connecting it to the HSM.

For more information on the Thales DPoD refer to the documentation that you received with your purchase of the HSM.

To configure a Thales DPoD for your Next Generation Hardware Appliance, follow the steps below.

If you run into issues after the configuration, you can get HSM specific log messages from a HSM Support Package.
For further information please refer to Create an HSM Log.

Connect the Next Generation Hardware Appliance with the Thales DPoD

To connect the Next Generation Hardware Appliance with the HSM:

1. Log in to your Next Generation Hardware Appliance.

2. Open the Security page or click Configure HSM in the Overview.

3. In the HSM Configuration section, click + Add External HSM in the HSM Selection field.

4. The Add an external HSM window opens.
   Select Thales DPoD to access the Configuration fields.

5. Click Select HSM Type to continue. 

6. Upload your DPoD service client.zip file.

7. Finalize with Save HSM Configuration.

8. A modal dialog requests to confirm your configuration.
   Save HSM Configuration

9. Proceed with Activate.

The HSM device is now configured and displayed in the DPoD Service Client section.

Usage Information

CryptoToken Configuration
The following note can be found in the info box:

In order to use this HSM in EJBCA, you need to select the following
PKCS#11 library in the P11NG CryptoToken configuration:
Reference: PKCS#11 Proxy - Thales DPoD

The last line in Usage Information displays the options:

Remove HSM Configuration
To remove the HSM configuration you need to type REMOVE HSM CONFIGURATION into the Confirm Action field.
Click Cancel/Remove.
If remove is chosen the application will restart.

If changes have been made to the sections:
HSM Client Authentication Configuration
Secure Channel Client Configuration
Miscellaneous Configurations

these can be made with undone with Cancel or saved with Save HSM Configuration.

Abort
Click Abort to terminate the process of configuring a HSM.

Save HSM Configuration
Click Save HSM Configuration to save changes made on the HSM configuration.

After the DPoD file is successfully uploaded, there is an option to modify the already uploaded DPoD file. The checksum of the service client and the partition serial number of the uploaded DPoD zip file are additionally displayed. Click Remove Service Client to upload a new zip file. 

On the Security page of the application, the status of the HSM Driver will change from Not Connected to Connected as soon as the configuration is completed.

On the Overview page of the application, the status in the HSM Overview also changes to Connected as soon as the configuration is completed. During configuration, the appliance is in the Restarting status. During this time, it is not available.

Once EJBCA is running again, you can proceed with adding a crypto token.

Add a Crypto Token in EJBCA Enterprise

To create a crypto token:

1. On the Overview page of the Next Generation Hardware Appliance, click Admin Web for EJBCA in the Application Overview column.

2. The EJBCA Enterprise page opens.
   Check whether the Create new CA checkbox is selected.

3. Open the CA Functions drop-down menu in the top menu.

4. In the CA Functions section, select Crypto Tokens.

5. On the Manage Crypto Tokens page, click Create New...

The individual configuration of the Crypto Token depends on the configuration of the HSM!
For detailed Information please see managing crypto tokens.

HSM Troubleshooting

In the section HSM Driver Controls the current HSM Driver Status is displayed.
In case of HSM problems, the HSM driver can be restarted via the Restart button.