Setting up CipherTrust HSM for KTS and Key HSM

Learn how to integrate Ranger KMS, KTS, and Key HSM with the CipherTrust HSM appliance.

This task describes how to set up the CipherTrust hardware security moudule (HSM) appliance provided by Thales. The process describes configuring the NAE port using CipherTrust Manager, setting up and configuring Key HSM in your cluster, and validating keys using CipherTrust Manager.

You must have installed the following in your environment:
  • Thales CipherTrust Manger
  • Ranger Key Management System, Key Trustee Server and Key HSM
  • Java (jdk1.8.0.232)

For more information about installing Ranger KMS, KTS and Key HSM, see Configuring NAE port in Thales CipherTrust Manager

  1. Log in to Thales CipherTrust Manager.
  2. In CipherTrust Manager > Admin Settings, select Add Interface.
  3. In Type, Select NAE (default).
  4. In Network Interface, selectAll.
  5. In Port, type a value for the port number.
  6. In Mode, select one of the following options to match your environment:
    • No TLS, user must supply password.
    • TLS, Ignore client cert. user must supply password.
  7. Click Add.
  8. Create a user.
    1. In Access Management > Users, click Create New User .
    2. In Create a New User, provide a username, password, and other required information.
    3. Click Create.
Setting up a cluster and configuring Key HSM
  1. In your Key HSM root directory, make sure that appropriate versions of Key HSM files are available with proper permissions.
    cd /usr/share/keytrustee-server-keyhsm/ 
  2. If SSL is enabled on CipherTrust Manager run the following command:
    echo "thales_machine_ip  nae.keysecure.local" >> /etc/hosts              
  3. Setup Key HSM service.
    keyhsm setup keysecure
    -- Configuring keyHsm General Setup --
    Cloudera Recommends to use as the listener port for Key HSM 
    Please enter Key HSM SSL listener IP address: [] Hit Enter
    Will attempt to setup listener on
    Please enter Key HSM SSL listener PORT number: 9090
    validate Port:                                    :[ Successful ]
    -- Ingrian HSM Credential Configuration --
    Please enter HSM login USERNAME: username
    Please enter HSM login PASSWORD: password
    Please enter HSM IP Address or Hostname:
    Please enter HSM Port number: 9000
    Valid address:                                    :[ Successful ]
    Use SSL? [Y/n] Y (If TSL is enabled on NAE port then press Y else type n and hit enter and act accordingly)
    Trust this server? [y/N] y
    Trusted server:                                   :[ Successful ]                      
  4. Validate the Key HSM service.
    $ service keyhsm validate 
  5. Start the Key HSM service.
    $ service keyhsm start
  6. Configure Key HSM to trust KTS.
    $ keyhsm trust /var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee.pem
  7. Configure KTS to trust the Key HSM server.
    $ ktadmin keyhsm --server --trust 
  8. Restart the Key HSM service.
    $ service keyhsm restart 
  9. Restart the KTS from Cloudera Manager UI.
  10. Test the HSM.
    curl -k https://$(hostname -f):11371/test_hsm                
  11. Login to the Ranger UI using keyadmin user role for creating an encryption zone key and do further validation.
Validating Keys in Cipher Trust HSM
  1. In Thales Cipher Trust Manager > Left Navigation Panel, click Keys.
Keys created in the above steps should be present, as shown in the following image:
Figure 1. Validating Keys in CipherTrust Manager
Validating Keys in CipherTrust Manager
Further keys for zone operation can be created using Ranger UI with keyadmin role credentials and also using hadoop commands.