Security: Configuring a TrustWay Proteccio netHSM

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 TrustWay Proteccio netHSM for the Software Appliance by registering the Software Appliance and connecting it to the HSM.

For more information on the TrustWay Proteccio netHSM refer to the documentation that you received with your purchase of the HSM.

To configure a TrustWay Proteccio netHSM 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 TrustWay Proteccio netHSM

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 TrustWay Proteccio netHSM to access the Configuration fields.

4. Click Select HSM Type to continue. 
   

   

5. The HSM Client Version section is displayed on the Security page.

6. Click on the HSM client version to be used.
   

   

7. Click Add HSM Device in the TrustWay Proteccio netHSM Devices section.
   The corresponding form Add HSM Device for the certificate opens.
   
   For Trustway Proteccio 3.01.05 and 3.06.05
   

   • HSM IP Address:
     Enter the IP address of the TrustWay Proteccio netHSM.
     Only IPv4 addresses are supported.

   • Upload the TrustWay Proteccio netHSM Server Certificate for connection, by dragging and dropping or by selecting the file.
     
     Confirm with Add HSM Device.
     
     

     

     
     
     For Trustway Proteccio 4.05.04
     

   • HSM IP Address:
     Enter the IP address of the TrustWay Proteccio netHSM.
     Only IPv4 addresses are supported.

   • Upload the TrustWay Proteccio netHSM Server Certificate for connection, by dragging and dropping or by selecting the file.

   • Secure Channel Client Configuration

     This step is optional only necessary if the Secure Channel is enabled on the HSM side or is to be used in the future.

     If a Trustway Proteccio 4.05.04 HSM client version has been selected, there is an additional function.
     Download Secure Channel Client Key.
     Then upload Secure Channel Client Key to your TrustWay Proteccio netHSM.
     The driver page will show connected even if the secure channel has not yet been successfully established (e.g. if the client key has not yet been uploaded to the HSM whitelist).
     
     Confirm with Add HSM Device.
     

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 a table in the TrustWay Proteccio netHSM Devices section.
Here you can now preform actions such as Edit Device or Remove Device.

HSM Client Authentication Configuration

In this section, the HSM Server Certificate is displayed after saving the HSM configuration.

Secure Channel Client Configuration for Trustway Proteccio 4.05.04

In this section, the Secure Channel Client Key is displayed after saving the HSM configuration.

Miscellaneous Configurations

All HSMs in the same group must have the same

1. hardware,

2. firmware,

3. key material,

4. and software configuration.

In addition, the same cryptographic configuration must be used.
The HSMs must be installed with the same install secret and user password.
Check mark the applicable option.

1. Use Load balancing Mode
   Load balancing mode mirrors keys to other HSMs to ensure redundancy.

2. Use Short Timeout
   Short Timeout reduces the response timeout for requests sent by the client host.
   

   

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: TrustWay Proteccio netHSM

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.

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 the SignServer is running again, you can proceed with adding a crypto token.

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.
   WORKERGENID1.NAME=CryptoTokenP11NG1: this name can be customized (CryptoTokenP11NG1) as desired.
   
   

   

   
   
   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 - Trustway Proteccio NetHSM
   

   

   
   
   

   

   
   
   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. The Crypto Token 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.

For information about error codes, please refer to the TrustWay Proteccio netHSM Developer Guide.