Integration with CipherTrust Manager

This section lists the steps to integrate HPE EDF with CipherTrust Manager.

Prerequisites
Configuration on CipherTrust Manager
Configuration on HPE EDF

Prerequisites

This section provides the prerequisites for integration of HPE EDF with CipherTrust Manager.

Ensure that the CipherTrust Manager is installed and configured. For more details, refer to the CipherTrust Manager documentation.
HPE EDF communicates with the CipherTrust Manager using the KMIP interface. Ensure that the KMIP interface is configured on the CipherTrust Manager. Refer to CipherTrust Manager Administration Guide for details.
IP address of the CipherTrust Manager and port of the KMIP interface must be accessible from the HPE EDF system.
CipherTrust Manager recognizes only registered KMIP clients. Ensure that each node of the HPE EDF cluster is registered as a KMIP client on the CipherTrust Manager. Refer to KMIP Client Registration for more details.

Configuration on CipherTrust Manager

To configure the CipherTrust Manager, you need to perform the following steps:

Creating a Domain (optional)
Creating a User
Assigning User to a Group
Creating or Adding a CA (optional)
Registering a KMIP Client
Configuring the KMIP Interface

Creating a Domain (Optional)

Perform the following steps to be performed on CipherTrust Manager:

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 the sub-domain user management through this domain.
Click Save.
Switch to the newly created domain by clicking the top right on the current Domain Name.

Creating a User

Root Domain

To create a user, perform the following steps:

Log on to the CipherTrust Manager GUI.
Open the Access Management application.
On the left navigation pane, click Users. The Users page is displayed.
On the Users page, click Add User.
On the Add User page, provide the following details:
- Select the required Connection Type
- Select the checkbox against the required Allowed Client Type.
- Enter Full Name
- Enter Username
- Enter the desired Password. Re-enter the password in the Password Match field.
Click Add User. The newly created user will now appear on the Users page.

Sub-Domain

Note

To create a user in sub-domain, you must enable Allow Subdomain User management.

To create a user, perform the following steps:

Log on to the CipherTrust Manager GUI with the User you created within the sub-domain.
Open the Access Management application.
On the left pane, click Users. The Users page is displayed.
On the Users page, click Add User.
On the Add User page, provide the following details:
- Select the required Connection Type
- Select the checkbox against the required Allowed Client Type.
- Enter Full Name
- Enter Username
- Enter Password. Re-enter the password in the Password Match field.
Click Add User. The newly created user will now appear on the Users page.

Assigning User to a Group

Perform the following steps to add user to a group:

Navigate to the Users page.
Click the ellipsis button (...) corresponding to the user that you created in the previous step.
Click Edit/View.
Click Group Memberships > Add Group.
In the search bar, enter the desired Group name and select the check box corresponding to it. For example, Key Admins or Key Users.
Click Add Group.

Creating or Adding a CA (Optional)

Local CA

To create/add a Self-signed local CA, perform the following steps:

Navigate to CA > Local. Select Add Local CA, the Add Local CA page appears.
Provide the required information and click Add Local CA. The created Local CA will appear under Pending CAs section.
Click the ellipsis against the Local CA that you created and select the option Self-sign.
Select a valid duration for the Local CA. Click Save.

External CA

To add an external CA, perform the following steps:

Navigate to CA > External. The External Certificate Authorities page appears. Select Add External CA, the Add External Certificate page appears.
Provide the required information.
If you want to upload the external CA, select the File Upload option and click Upload Certificate. Browse and select the required External CA.
OR
Select Text and paste the contents of External Certificate.
Click Add External CA.

Registering a KMIP Client

Root Domain

You can register a KMIP client on the CipherTrust Manager through:

Auto Registration
Manual Registration

Auto-Registration

Log on to the CipherTrust Manager.
Go to Products > KMIP.
Create Client Profile using the following steps:
1. Navigate to Client Profile and click Add Profile.
2. Add a Profile Name.
3. Click Save. The new profile is created.
Create Registration Token using the following steps:
1. Go to Registration Token and click New Registration Token > Begin.
2. Add a Name Prefix.
3. Specify a Token Lifetime value along with the Client Capacity for the token.
4. Click Select CA.
5. Select the CA type as Local/External depending on what you are using.
6. Select the appropriate CA from the dropdown menu and click Select Profile.
7. Select the Client Profile from the dropdown which you have created in the above step.
8. Click Create Token.
9. Copy the value of the Token created and click Done.
Note
If you are using External CA then you can select the external CA that you created and uploaded on the CipherTrust Manager.
Turn ON Auto Registration using the following steps:
1. Go to Admin Settings > Interfaces.
2. Click the ellipsis button (...) corresponding to the kmip interface.
3. Click View/Edit.
4. On the Interface Detail window, perform the following:
  - Select the Interface Mode as TLS, verify client cert, user name taken from client cert, auth request is optional.
  - Select Auto Registration checkbox.
  - Paste the Registration Token.
  - Add the CA (Local or External) to the list of Trusted CAs. The CA will reflect uder the dropdown menu of Local/External Trusted CAs depending upon CA that you created.
  - Click Update.

Manual Registration

Log on to the CipherTrust Manager.
Go to Products > KMIP.
Create Client Profile using the following steps:
1. Go to Client Profile and click Add Profile.
2. Add a Profile Name.
3. Select CN in Username Location in Certificate.
4. Click Certificate Details.
5. You can either paste the content of a generated client.csr or you can create one, by filling in the required details.
6. Click Save.
Create Registration Token using the following steps:
1. Go to Registration Token and click New Registration Token > Begin.
2. Add a Name Prefix.
3. Specify a Token Lifetime value along with the Client Capacity for the token.
4. Click Select CA.
5. Select the CA type as Local/External depending on what you are using.
6. Select the appropriate CA from the dropdown menu and click Select Profile.
7. Select the Client Profile from the dropdown which you have created in the above step.
8. Click Create Token.
9. Copy the value of the Token created and click Done.
Note
If you are using External CA then you can select the external CA that you created and uploaded on the CipherTrust Manager.
Go to Registered Clients and click Add Client.
- Specify client name and paste the Registration Token that you generated in the above step.
  Note
  If you are using external CA then you either upload the file using Upload Certificate or paste the signed client certificate in the Client Certificate field.
- Click Save to save the client certificate.

Sub-Domain

You can register a KMIP client on the CipherTrust Manager through:

Auto Registration
Manual Registration

Auto-Registration

Log on to the CipherTrust Manager into your domain.
Go to Products > KMIP.
Create Client Profile using the following steps:
1. Navigate to Client Profile and click Add Profile.
2. Add a Profile Name.
3. Click Save. The new profile is created.
Create Registration Token using the following steps:
1. Go to Registration Token and click New Registration Token > Begin.
2. Add a Name Prefix.
3. Specify a Token Lifetime value along with the Client Capacity for the token.
4. Click Select CA.
5. Select the CA type as Local/External depending on what you are using.
6. Select the appropriate CA from the dropdown menu and click Select Profile.
7. Select the Client Profile from the dropdown which you have created in the above step.
8. Click Create Token.
9. Copy the value of the Token created and click Done.
Note
If you are using External CA then you can select the external CA that you created and uploaded on the CipherTrust Manager.
Turn ON Auto Registration using the following steps:
1. Go to Admin Settings > Interfaces.
2. Click the ellipsis button (...) corresponding to the kmip interface.
3. Click Edit.
4. On the Interface Detail window, perform the following:
  - Select the Interface Mode as TLS, verify client cert, user name taken from client cert, auth request is optional.
  - Select Auto Registration checkbox.
  - Paste the Registration Token.
  - Add the CA (Local or External) to the list of Trusted CAs. The CA will reflect uder the dropdown menu of Local/External Trusted CAs depending upon CA that you created.
  - Click Update.

Manual Registration

Log on to the CipherTrust Manager into your domain.
Go to Products > KMIP.
Create Client Profile using the following steps:
1. Go to Client Profile and click Add Profile.
2. Add a Profile Name.
3. Select CN in Username Location in Certificate.
4. Expand the Certificate Details section.
5. You can either paste the content of a generated client.csr or you can create one, by filling in the required details.
  For domain, the format to enter the Common Name field of the cert is always: domainName||domainUser
6. Click Save.
Create a Registration Token using the following steps:
1. Go to Registration Token and click New Registration Token > Begin.
2. Add a Name Prefix.
3. Specify a Token Lifetime value along with the Client Capacity for the token.
4. Click Select CA.
5. Select the CA type as Local/External depending on what you are using.
6. Select the appropriate CA from the dropdown menu and click Select Profile.
7. Select the Client Profile from the dropdown which you have created in the above step.
8. Click Create Token.
9. Copy the value of the Token created and click Done.
If you are using External CA then you can select the external CA which you created earlier. Refer to External CA under Creating or Adding a CA.
Go to Registered Clients and click Add Client.
1. 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.
2. Click Save to save the client certificate.

Configuring the KMIP Interface

The KMIP interface can be configured through:

Root Domain

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, the 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 Local CA then select the CA under Local Trusted CAs
- If you are using External CA then select the CA under External Trusted CAs provided you have the external CA that you created and uploaded on the CipherTrust Manager. For more information on creating or uploading CA, refer to Creating or Adding a CA.

Sub-Domain

Configuration on HPE EDF

Perform the following steps to integrate HPE Ezmeral Data Fabric with the CipherTrust Manager:

Create a directory named tokens at /opt/mapr/conf/ to store the key files and change the owner to mapr.
```
mkdir /opt/mapr/conf/tokens
chown mapr:mapr /opt/mapr/conf/tokens
```
Run the following command to create the KMIP token for the first time and initialize the KMIP configuration:
```
mrhsm init
-sopin <PIN for SO>
-label "CipherTrustManager"
-storetype kmip
```

After the Keystore is initialized, configure your KMIP settings using mrhsm set to configure the IP, Port, Certificates, KMIP Version, and the SO Pin.

mrhsm set
-sopin <PIN for SO>
-ip comma-separated list of KMIP server IP addresses>
-port <KMIP port number. Default is 5696>
-cacert <Path to KMIP server CA certificate in PEM format>
-clientcert <Path to client certificate in PEM format>
-clientkey <Path to client private key in PEM format>
-kmipversion 1.1
-storetype kmip

Use the mrhsm info command to view the updated HSM configuration information and status.
```
mrhsm info
```
Run the following command to enable DARE on the current node:
```
mrhsm enable -dare
```
After the above command is executed, the keys are generated and you can verify the integration by matching the UUID keys.

Integration with CipherTrust Manager

Prerequisites

Configuration on CipherTrust Manager

Creating a Domain (Optional)

Creating a User

Assigning User to a Group

Creating or Adding a CA (Optional)

Registering a KMIP Client

Configuring the KMIP Interface

Configuration on HPE EDF

On this page

Suggest A Change