Integrate Delinea Secret Server with an Entrust nShield HSM

There are two cryptography API options for this integration: the CNG cryptography provider, and the PKCS #11. Both are covered in this section.

Configure the Delinea Secret Server using the CNG cryptography provider

  1. Select Windows Start > Entrust nShield Security World > CNG configuration wizard. The nShield CNG Providers Configuration Wizard appears.

  2. Select Next twice.

  3. Select Use the existing security world if one was created in deploy-entrust-nshield.adoc#install-security-world-hsm.

  4. Select Next twice.

  5. Select the protection method. If you are using OCS protection, insert your OCS card into the proper slot.

    Example for OCS protection:

    cng ocs protection
  6. Run certutil -csptest > <filename> on a command window.

    For example:

    C:\Users\Administrator.INTEROP>certutil -csptest > Documents\cryptographic-providers
  7. Search for Provider Name: nCipher in the file created above, and make sure that it shows Pass.

    csp ncipher pass
  8. Log in to the Delinea Secret Server via a browser at https://localhost/SecretServer.

  9. From the menu in the left pane, select Settings > All settings > General > HSM. The HSM configuration page appears.

    hsm configuration
  10. Select Enable HSM. Then select Next.

  11. In the Enable HSM window, select as follows. Then select Next.

    Parameter Value

    API type

    CNG

    Persistent provider

    nCipher Security World Key Storage Provider

    Key type

    RSA

    Key size

    Your selection

    Padding type

    OAEP (PKCS1 is not supported)

    For example:

    select nshield as provider cng
  12. Check the HSM Provider Test Results. Then select Next.

    verify hsm provider cng
  13. In the Verify HSM configuration page select Save.

    update hsm configuration cng
  14. In the Notice about HSM configuration change, recycle the application pool. Then select Continue.

    recycle application pool
  15. Refresh the browser. Then from the menu in the left pane, select Settings > All settings > General > HSM. Notice the completed HSM configuration.

    hsm enabled cng

Configure the Delinea Secret Server using the PKCS #11 API

  1. Log in to the Delinea Secret Server via a browser at https://localhost/SecretServer.

  2. If the HSM was previously configured using the CNG cryptography provider, select Disable HSM, recycle the application pool, and refresh the browser. Otherwise, continue to the next step.

  3. Copy the HSM cryptoki library (dll) for PKCS #11 to the Secret Sever application pool as shown:

    C:\Users\Administrator.INTEROP>copy "C:\Program Files\nCipher\nfast\toolkits\pkcs11\cknfast.dll" C:\inetpub\wwwroot\SecretServer\pkcs11\.
            1 file(s) copied.
  4. If you are using OCS protection, insert your OCS card into the proper slot.

  5. From the menu in the left pane, select Settings > All settings > General > HSM. The HSM configuration page appears.

    hsm configuration
  6. Select Enable HSM. Then select Next.

  7. In the Enable HSM window, select as follows. Then select Next.

    Parameter Value

    API type

    PKCS11

    Library name

    cknfast.dll

    Token label

    <OCS cardset name>

    User pin

    <OCS cardset passphrase>

    Key type

    AES

    Key size

    256

    For example:

    select nshield as provider pkcs11
  8. Check the HSM Provider Test Results. Then select Next.

    verify hsm provider pkcs11
  9. In the Verify HSM configuration page select Save.

    update hsm configuration pkcs11
  10. In the Notice about HSM configuration change, recycle the application pool. Then select Continue.

    recycle application pool
  11. Refresh the browser. Then from the menu in the left pane, select Settings > All settings > General > HSM. Notice the completed HSM configuration.

    hsm enabled pkcs11

Verify integration

  1. List the keys protected by the HSM using the nfkminfo utility.

    C:\Users\Administrator.INTEROP>nfkminfo -l
    
    Keys protected by cardsets:
     key_pkcs11_ucedb3d45a28e5a6b22b033684ce589d9e198272c2-5c65ec9a8fd17ea4ff069e88f552f926d35252d0 `5a7ea9ae-d562-40c5-9091-25f76d55b529'
  2. Notice the Key identifier in the completed HSM configuration matches the nfkminfo utility output above. In this case the key corresponds to the the Delinea Secret Server using the PKCS #11 API.

This completes the integration of Delinea Secret Server with the Entrust nShield HSM. Secrets created in Delinea Secret Server will use encryption keys that are stored in the HSM.