Integration with CipherTrust Manager
This section lists the steps to integrate Nutanix AHV with CipherTrust Manager.
Prerequisites
This section provides the prerequisites for integration of Nutanix AHV with CipherTrust Manager.
Ensure that CipherTrust Manager is installed and configured. For more details, refer to the CipherTrust Manager Documentation.
IP address of the CipherTrust Manager and port of the KMIP interface must be accessible from the Nutanix cluster.
CipherTrust Manager recognizes only registered KMIP clients. Ensure that each node of the Nutanix cluster is registered as a KMIP client on the CipherTrust Manager.
Configuration on CipherTrust Manager
To configure the CipherTrust Manager for the integration, you need to perform the following steps:
Creating a Domain (Optional)
Perform the following steps on CipherTrust Manager:
Note
This step is optional and needs to be performed only if you want to integrate within a domain.
Navigate to Admin Settings > Domains.
Click Add Domain. The Add Domain page appears.
Specify the following information:
Name: Enter the domain name.
Admins: Select the admins (one or more) from the list available in the drop down. For example, admin.
Parent CA: Select parent CA as root CA.
Allow Subdomain User Management: Select this check box if you want to enable user management in the subdomain through this domain.
Click Save.
Click on the current domain name at the top right corner to switch to this newly created domain.
Creating a User
To create a user, perform the following steps:
Log on to the CipherTrust Manager UI.
Navigate to Access Management > Users.
On the Users page, click Create User.
Provide the following details:
Username
Password
Email
Click Add User. The newly created user is now listed on the Users page.
To create a user, perform the following steps:
Note
You can only create users in sub domains if you have enabled Allow Subdomain User Management while creating a domain.
Log on to the CipherTrust Manager UI with the User you created within the Sub Domain.
Navigate to Access Management > Users.
On the Users page, click Create User.
Provide the following details:
Username
Password
Email
Click Add User. The newly created user is now listed on the Users page.
Assigning the User to a Group
Perform the following steps to add user to a group:
Click on the ellipsis corresponding to the user that you created in the previous step.
Click Edit/View > Groups.
In the search bar, type Key Admins or Key Users and select Add, depending on the level of access you want to grant the user.
Registering a KMIP Client
You can register a KMIP client on the CipherTrust Manager through:
Auto Registration
Manual Registration
Create a Registration Token using the following steps:
Log on to the CipherTrust Manager in the root domain.
Go to Access Management > Registration Tokens.
Click Add New Registration Token > Begin.
Add a Name Prefix and specify a Token Lifetime value along with the Client Capacity for the token.
Click Select CA.
Select the CA type as Local/External depending on your preference.
Select the appropriate CA from the dropdown and click Create Token.
Copy the value of the Registration Token once it is created.
Enable Auto Registration using the following steps:
Go to Admin Settings > Interfaces.
Click on the ellipsis corresponding to the KMIP interface.
Click View/Edit.
Select the Auto Registration checkbox and paste the copied value of the Registration Token.
Select OU for the field Username Location in Certificate.
Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.
Scroll down and click Update to save your settings.
Log on to the CipherTrust Manager.
Go to Products > KMIP.
Create a Client Profile using the following steps:
Go to Client Profile and click Add Profile.
Add a Profile Name.
Select OU for the Username Location in Certificate field.
Expand the Certificate Details section.
Paste the contents of the CSRs obtained from Nutanix.
Click Save.
Create Registration Token using the following steps:
Go to Registration Token and click New Registration Token > Begin.
Add a Name Prefix.
Specify a Token Lifetime value along with the Client Capacity for the token.
Click Select CA.
Select the CA type as Local/External depending on what your preference.
Select the appropriate CA from the dropdown menu and click Select Profile.
Select the Client Profile from the dropdown which you have created in the above step.
Click Create Token.
Copy the value of the Token created and click Done.
Note
If you are using External CA then you can select the external CA which was created using openssl and uploaded on the CipherTrust Manager. For more details, refer to the CipherTrust Manager Documentation.
Go to Registered Clients and click Add Client.
Specify client name and paste the Registration Token generated in the above step.
Note
If you are using external CA then you need to paste the signed client certificate in the Client Certificate field.
Click Save to save a copy of the client certificate.
- Repeat this process for each CSR corresponding to a a node on Nutanix AHV.
You can register a KMIP client on the CipherTrust Manager through:
Auto Registration
Manual Registration
Create a Registration Token in the sub-domain using the following steps:
Log on to the CipherTrust Manager in your specified subdomain.
Go to Access Management > Registration Tokens.
Click Add Registration Token > Begin.
Add a Name Prefix.
Specify a value for the Token Lifetime along with the Client Capacity for the token.
Click Select CA.
Select the CA type as Local/External depending on your requirements.
Copy the value of the Registration Token once it is created.
Note
By default, Auto Registration is disabled.
Enable Auto Registration using the following steps:
Log on to CipherTrust Manager in the root domain.
Go to Admin Settings > Interfaces.
Click the ellipsis corresponding to the KMIP interface.
Click View/Edit.
Select the checkbox corresponding to Auto Registration.
Select OU for the field Username Location in Certificate.
Paste the copied value of the Registration Token.
Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.
Scroll down and click Update to save your interface configuration.
Log on to the CipherTrust Manager into your domain.
Go to Products > KMIP.
Create Client Profile using the following steps:
Go to Client Profile and click Add Profile.
Add a Profile Name.
Select OU in Username Location in Certificate.
Expand the Certificate Details section.
Paste the content from the CSRs generated by Nutanix.
Click Save.
Create a Registration Token using the following steps:
Go to Registration Token and click New Registration Token > Begin.
Add a Name Prefix.
Specify a Token Lifetime value along with the Client Capacity for the token.
Click Select CA.
Select the CA type as Local/External depending on your requirements.
Select the appropriate CA from the dropdown menu and click Select Profile.
Select the Client Profile from the dropdown which you have created in the above step.
Click Create Token.
Copy the value of the Token and click Done.
Note
If you are using External CA then you can select the external CA which was created using openssl and uploaded on the CipherTrust Manager. For more details, refer to the CipherTrust Manager Documentation.
Go to Registered Clients and click Add Client.
Specify client name and paste the Registration Token generated in the above step.
Note
If you are using External CA then you need to paste the signed client certificate in the Client Certificate field.
Click Save to save the client certificate.
Configuring the KMIP Interface
The KMIP interface can be configured through:
Go to Admin Settings > Interfaces.
On the KMIP Interface, click the ellipsis button (...) and then click View/Edit.
Select the Auto Registration checkbox if you auto-registered your KMIP client and paste the value of the registration token that you created.
Note
By default, Auto Registration is disabled.
Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.
Specify selections for Local CA for Automatic Server Certificate Generation as desired.
Note
Local CA for Automatic Server Certificate Generation should be set to Turn off auto generation from Local CA in case of External CA.
Select the CA according to your preference:
If you are using External CA then select the CA under External Trusted CAs
If you are using Local CA then select the CA under Local Trusted CAs
If you are using an External CA, expand the Upload Certificate section:
In the Certificate field, paste the contents of Server Certificate, CA, and Server Key file in the same order. Do not introduce any space or character or symbol between the contents of these files.
Select certificate Format as PEM.
Password field is optional and can be skipped.
Click Update.
Switch to Root Domain.
Go to Admin Settings > Interfaces.
On the KMIP Interface, click the ellipsis and then click View/Edit.
Select the Auto Registration checkbox if you auto-registered your KMIP client and paste the value of the registration token that you created.
Note
By default, Auto Registration is disabled.
Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.
Specify selections for Local CA for Automatic Server Certificate Generation as desired.
Note
Local CA for Automatic Server Certificate Generation should be set to Turn off auto generation from Local CA in case of External CA.
Select the CA according to your preference.
Login to your sub-domain. Go to CA > Local. Click the ellipsis (...) and copy the contents of your CA Certificate.
Logout of your sub-domain and now login to the root domain.
Go to CA > External > Add External CA.
Enter a name for this Domain CA and select the text radio button and paste the certificate contents.
Click Add External CA.
Go to Admin Settings > Interfaces.
Click the Add icon to add the External CA.
Click Update.
Note
If you are using an External CA in the root Domain, you need to add the CA as an External CA in both the root domain as well as the sub-domain and modify the interface accordingly.
Go to Admin Settings > Interfaces.
Click the Add icon to add the External CA.
Click Update.
On the KMIP interface, click the ellipsis (...) > Certificate Options > Upload New Certificate > Ok.
Select the Certificate Chain option and click Build Certificate Chain.
Click on Text and paste the contents of Server Certificate, CA, and Server Key file in the same order. Do not introduce any space, character or symbol between the contents of these files.
Select certificate Format as PEM.
Click on Upload Certificate.
Issuing CSR(s) for Each Node of Nutanix AHV
Log on to the Nutanix Prism Element, go to Settings > Data-at-Rest-Encryption.
Click Edit Configuration.
Under Select Key Management Server (KMS), select An external KMS and click Save KMS Type.
In the Certificate Signing Request Information section:
- Specify Email, Organization, Organizational Unit, Country Code, City, and State.
Note
The value for the OU field should be the same as the user you created on CipherTrust Manager in one of the previous steps.
Click Save CSR Info.
Click Download CSRs.
This will initiate a download of a compressed zip containing all your CSRs. Save this file locally and extract it's contents to a folder.
Note
In case of domains, the Organizational Unit field for the CSR must be of the format: domainName||domainUser.
Getting the CSR(s) signed from CipherTrust Manager
Note
In this section, we are using the Local Root CA of CipherTrust Manager to sign the CSRs. However, you can use any other CA as per your convenience.
Note
This step is applicable only for Auto-Registered KMIP clients.
Log on to CipherTrust Manager.
Go to CA > Local.
Click on the ellipsis corresponding to the existing Local CA and click Download to save a copy of the CA certificate.
Click on the Name of this Local CA and click Upload CSR
Paste the contents of one of the CSR files, specify a name for the certificate.
Select the Certificate Purpose as client and click Issue Certificate.
Repeat the signing process for all the remaining CSRs for each of the nodes.
Configuring CipherTrust Manager as an External KMS on Nutanix AHV
To configure the CipherTrust Manager as an external KMS:
On the Nutanix Prism Element UI, go to Settings > Data at Rest Encryption.
Click Edit Configuration.
Scroll down to Key Management Server and perform the following steps:
Click Add New Key Management Server > Add Address.
Enter a name for the Key Management Server.
Enter the IP address and the KMIP port of the CipherTrust Manager.
Repeat the above steps for each node of CipherTrust Manager if you have a clustered setup.
Scroll down to the KMS CA Certificates section and perform the following steps:
Click Add New Certificate Authority.
Click Upload CA Certificate.
Specify a name for the CA.
Click Save.
Scroll down to the Key Management Server section and perform the following steps:
Click Manage Certificates for the desired key management server. The Manage Signed Certificates screen is displayed.
Upload the node certificates. Perform either of the following:
Click Upload Files and upload all the certificates at once.
Click the Upload link for each node separately.
Test whether the certificates are correct. Perform either of the following:
Click Test all nodes to test the certificates for all nodes at once.
Click the Test CS (or Re-Test CS) link for each node separately.
Confirm that the status has changed to Verified.
Enabling encryption on Nutanix AHV
Log on to the Nutanix Prism Element UI.
Click on the Settings icon on the toolbar's right side to open the Settings menu.
Navigate to Data-at-rest Encryption under Security in the left pane of the Settings.
Toggle on the Encryption option.
In the confirmation pop-up window, type ENCRYPT and then click Encrypt.
This will trigger the encryption of the Nutanix cluster. This step usually takes some time to complete. Once done, the cluster encryption is configured and enabled.