Security: Configuring a Securosys Primus HSM or a Securosys CloudHSM

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.
Optionally, you can use the software-based SoftHSM implementation for demonstration or testing purposes.

The following describes how to configure a Securosys Primus HSM or Securosys CloudHSM for the Software Appliance by registering the Software Appliance and connecting it to the HSM.

For more information on the Securosys HSM, refer to the Securosys product documentation that you received with your purchase of the HSM.

To configure a Securosys Primus HSM or a Securosys CloudHSM for your Software 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 Software Appliance with the Securosys Primus HSM or Securosys CloudHSM

To connect the Software Appliance with the HSM:

1. Log in to your Software Appliance and open the Security page or click Configure HSM in the Overview.

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

   

3. The Add an external HSM window opens.
   Select Securosys Primus HSM to access the Configuration fields.

4. Click Select HSM Type to continue. 
   

   

Securosys Primus HSM or Securosys CloudHSM Configuration

There are 3 different tables that are currently empty. 

1. one is for the HSM Devices,

   

2. one is for the Slots,

   

3. and one is for Permanent Secrets.

   

4. Further down there is a Miscellaneous section where you can provide details.
   The individual sections are: Wait Delay, Wait Retries, Trace Level or set the Trace PKCS#11 function inputs.
   

   

5. Adjust the settings if applicable.

6. Confirm your entries with Save HSM Configuration.

7. In the Overview you can now see that the Securosys Primus HSM is listed, but Not Connected and no device is configured yet.
   

   

   
   Go back to the Security page and proceed with Add HSM Device.

Add HSM Device

1. To add a HSM Device click Add HSM Device in the Primus HSM Devices table.

2. Start with entering the HSM IP Address / FQDN (Fully Qualified Domain Name) to add a device.

3. Enter the HSM Port.

4. If applicable specify the Priority in selecting a redundant HSM. If you configure the first HSM leave the value 0.

For more information on how to set the priority, please refer to the Securosys Primus HSM or Securosys CloudHSM product documentation that you received when you purchased the HSM.

1. Click Add HSM Device.

   1. The corresponding form for the certificate opens.

      • HSM IP Address / FQDN:
        Enter the IP address or the Fully Qualified Domain Name (FQDN) of the HSM.
        Only IPv4 addresses are supported.

      • The HSM Port is already set by default.

      • Priority:
        Specify the priority when selecting a redundant HSM.
        The smaller the value, the higher the priority.
        The value can be between 0 and 127.

2. Confirm your entries with Add HSM Device.
   

   

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

13. Proceed with Activate.

The device will now be listed in the table Primus HSM Devices.
Here you can now preform actions such as Edit Device or Remove Device.

You can of course add multiple devices. Just repeat the process as described before.

Managed HSM Slots

There are no slots configured for this HSM at this time.

Add HSM Slot

1. To add a slot click Add HSM Slot.

2. At the first line: HSM Device, select the HSM for which the slot is to be defined. If several HSM Devices are configured, you can open the corresponding list using the drop-down menu.

3. Continue to specify the Slot ID.

4. Next you must specify a Username.

5. You can configure an optional Client ID to identify the client or the application.
   
   

   

Slot Setup

1. Enter the slot Setup Password.

2. Provide the PKCS#11 Password of the slot (PIN/Password).
   
   
   

   

   
   If there is a proxy in front of the HSM, the proxy settings have to be added first. If this is not the case, you can click Add HSM Slot to confirm the HSM slot configuration.

Proxy Settings

1. Add the Proxy User.

2. Enter the Proxy Password.
   
   

   

3. Click Add HSM Slot to confirm the HSM slot configuration.

4. Finalize with Save.

Permanent Secrets

After the configuration of the HSM Slots, the user name (partition) will be displayed under Permanent Secrets.

Re-Initialize Permanent Secrets

It is possible to Re-Initialize Permanent Secrets for the User or for the Proxy.

1. From the list Permanent Secrets select the line of the Username you want to edit.

2. In the column Actions click Re-Initialize to open the form.

3. Enter the New Credentials.

4. To confirm your settings click Re-Initialize.
   
   

   

5. Finalize with Save.

On the Security page of the appliance, 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 appliance, 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.

Usage Information

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

In order to use this HSM in SignServer, you need to select the following
PKCS#11 library in the P11NG CryptoWorker configuration:
Reference: PKCS#11 Proxy - Securosys Primus HSM

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 Remove to remove the configuration or Cancel to close the modal dialog.
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.

Once the SignServer is running again, you can proceed with adding a Crypto Worker.

Add a Crypto Worker in SignServer

To create a Crypto Worker:

1. In the Overview page of the Software Appliance, click Admin Web for SignServer.

2. The SignServer page opens.

3. Click Add... to continue.
   
   

   

4. In the top menu, select Worker. You can choose the method you want to use to configure the Worker. In this example we will work with From Template.
   Click From Template to continue.
   
   

   

5. Open the drop-down menu under Load from Template. Here you can select the worker to be configured. In this example we will work with p11ng-crypto.properties.
   Click Next to continue.
   
   

   

   
   

6. The Configuration page opens.
   Scroll down a little bit.
   WORKERGENID1.SHAREDLIBRARYNAME
   In Webconf open the Security page.
   Scroll down to HSM Configuration.
   The Usage Information displays the requested entry.
   Here: PKCS#1 Proxy - Securosys Primus HSM
   
   

   

   
   
   

   

   
   
   WORKERGENID1.SHAREDLIBRARYNAME=P11 Proxy should be configured as default.
   
   

   

   
   
   Scroll down a little bit.
   Method for pointing out which slot to use:
   # Method will specifying the slot to use.

   1. If the Slot is to be addressed by number:
      type SLOT_NUMBER SLOTLABELTYPE=SLOT_LABEL.

   2. If the Slot is to be addressed by label:
      type SLOT_LABEL SLOTLABELTYPE=SLOT_INDEX.

   3. To address the Slot via the SLOT_ INDEX of occurrence is not recommended because the list order is not stable.
      To deselect it, put # in front of it.
      To enable it, remove # in front of it.
      The # can be replaced for the slot to be used and specify the number of the HSM slot instead.
      
      

      

      
      
      #WORKERGENID1.PIN=foo123 here the password can be enabled or disabled.
      To deselect it, put # in front of it.
      To enable it, remove # in front of it.
      
      

      

      
      
      # Optional PKCS#11 attributes is used for key generation, you can select the attributes.
      To deselect it, put # in front of it.
      To enable it, remove # in front of it.
      
      

      

      
      
      WORKERGENID1.DEFAULTKEY=testkey0 here you can add an existing key or use the default key.
      Click Apply to save the settings.
      
      

      

   

   The token (CryptoTokenP11NG1) is automatically logged in when the PIN is set in the Crypto Worker configuration.

7. The Worker is not activated yet. Click on the created token and you will see the information about the token in the Status Summary.
   
   

   

8. Click the Configuration tab to view the full configuration of the token.
   
   

   

   
   

9. If the configuration meets your needs, click the Crypto Token tab. Edit them if necessary.
   
   

   

10. Click Activate.
    
    

    

    
    
    

    This step is optional!
    The latest version of SignServer logs on automatically if the correct PIN is defined in the configuration as described in step 6.
    
    In the field Authentication Code enter the optional password from Step 6. Here foo123.
    Click Activate.
    
    

    

11. If the default key exists and has been activated, the Crypto Worker is now ACTIVE.

    

For more information please see Worker Crypto Token Page.

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.