Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
back

CipherTrust Manager Integration with MongoDB

Integration of MongoDB

search
printsuggest an edit

Integration of MongoDB

This section lists the steps to integrate MongoDB with CipherTrust Manager.

copy link to clipboardPrerequisites

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

  • Ensure that the CipherTrust Manager is installed and configured. For more details, refer to the CipherTrust Manager Documentation.

  • MongoDB communicates with the CipherTrust Manager using the KMIP interface. Ensure that the KMIP interface is configured on the CipherTrust Manager.

  • IP address of the CipherTrust Manager and port of the KMIP interface must be accessible from the MongoDB system.

  • CipherTrust Manager recognizes only registered KMIP clients. Ensure that each node of the MongoDB cluster is registered as a KMIP client on the CipherTrust Manager. Refer to KMIP Client Registration for more details.

copy link to clipboardConfiguration on CipherTrust Manager

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

  1. Creating a Domain (optional)

  2. Creating a User

  3. Assigning User to a Group

  4. Creating or Adding a CA (optional)

  5. Registering a KMIP Client

  6. Configuring the KMIP Interface

copy link to clipboardCreating a Domain (Optional)

Perform the following steps to be performed on CipherTrust Manager:

  1. Navigate to Admin Settings > Domains.

  2. Click Add Domain. The Add Domain page appears.

  3. 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.

  4. Click Save.

  5. Switch to the newly created domain by clicking the top right on the current Domain Name.

copy link to clipboardCreating a User

To create a user, perform the following steps:

  1. Log on to the CipherTrust Manager GUI.

  2. Open the Keys & Access Management application.

  3. On the left pane, click Users. The Users page is displayed.

  4. On the Users page, click Create New User.

  5. On the Create a New User screen provide the following details:

    • Enter Username.

    • Enter Password.

  6. Click Create. The newly created user is listed on the Users page.

Note

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

To create a user, perform the following steps:

  1. Log on to the CipherTrust Manager GUI with the User you created within the sub-domain.

  2. Open the Keys & Access Management application.

  3. On the left pane, click Users. The Users page is displayed.

  4. On the Users page, click Create New User.

  5. On the Create a New User screen provide the following details:

    • Enter Username.

    • Enter Password.

  6. Click Create. The newly created user is listed on the Users page.

copy link to clipboardAssigning User to a Group

Perform the following steps to add user to a group:

  1. Click the ellipsis button (...) corresponding to the user that you created in the previous step.

  2. Click Edit.

  3. Click Group Memberships > Add Group.

  4. In the search bar, type Key Admins and select the check box corresponding to it .

  5. Click Add Group.

copy link to clipboardCreating or Adding a CA (Optional)

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

  1. Navigate to CA > Local. Select Add Local CA, the Add Local CA page appears.

  2. Provide the required information and click Add Local CA. The created Local CA will appear under Pending CAs section.

  3. Click the ellipsis against the Local CA that you created and select the option Self-sign.

  4. Select a valid duration for the Local CA. Click Save.

To add an external CA, perform the following steps:

  1. Navigate to CA > External. Select Add External CA, the Add External Certificate page appears.

  2. Provide the required information.

  3. 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

  4. Click Add External CA

copy link to clipboardRegistering a KMIP Client

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

  • Auto Registration

  • Manual Registration

  1. Create a Registration Token using the following steps:

    1. Log on to the CipherTrust Manager in root domain.

    2. Go to Access Management > Registration Tokens.

    3. Click Create New Registration Token.

    Copy the Registration Token once it is created.

  2. 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. Under Configure KMIP window, select Auto Registration.

    5. Paste the Registration Token.

    6. Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.

    7. Click Update.

  1. Log on to the CipherTrust Manager.

  2. Go to Products > KMIP.

  3. 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. Paste the content of client.csr.

    6. Click Save.

  4. 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

    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.

  5. Go to Registered Clients and click Add Client.

    • Specify client name and paste the Registration Token generated in the above step.

      note

      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.

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

  • Auto Registration

  • Manual Registration

  1. Create a Registration Token in the sub-domain using the following steps:

    1. Log on to the CipherTrust Manager in your specified sub-domain.

    2. Go to Access Management > Registration Tokens.

    3. Click Add Registration Token > Begin.

    4. Add a Name Prefix.

    5. Specify a Token Lifetime value along with the Client Capacity for the token.

    6. Copy the value of the Registration Token once it is created.

    7. Switch to Root Domain.

  2. Turn ON Auto Registration using the following steps:

    1. Log on to the CipherTrust Manager in the root domain.

    2. Go to Admin Settings > Interfaces.

    3. Click the ellipsis button (...) corresponding to the kmip interface.

    4. Click Edit.

    5. Under Configure KMIP window, select Auto Registration.

    6. Paste the Registration Token.

    7. Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.

    8. Click Update.

  1. Log on to the CipherTrust Manager into your domain.

  2. Go to Products > KMIP.

  3. 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 details.

      For domain, the format to enter the Common Name field of the cert is always: <domain name>||<Hostname/IP>

    6. Click Save.

  4. 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.

  5. If you are using External CA then you can select the external CA which was created using openssl and uploaded on the CipherTrust Manager.

  6. Go to Registered Clients and click Add Client.

    1. Specify client name and paste the Registration Token generated in the above step.

      note

      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.

copy link to clipboardConfiguring the KMIP Interface

The KMIP interface can be configured through:

  1. Go to Admin Settings > Interfaces.

  2. On the KMIP Interface, click the ellipsis button (...) and then click View/Edit.

  3. 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.

  4. Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.

  5. Specify selections for Local CA for Automatic Server Certificate Generation as desired.

    note

    Note

    Local CA for Automatic Server Certificate Generation should be set to Turn off auto generation from Local CA in case of External CA.

  6. 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

  7. 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.

  1. Switch to Root Domain.

  2. Go to Admin Settings > Interfaces.

  3. On the KMIP Interface, click the ellipsis button (...) and then click View/Edit.

  4. 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.

  5. Select the mode as TLS, verify client cert, user name taken from client cert, auth request is optional.

  6. Specify selections for Local CA for Automatic Server Certificate Generation as desired.

    note

    Note

    Local CA for Automatic Server Certificate Generation should be set to Turn off auto generation from Local CA in case of External CA.

  7. Select the CA according to your preference.

    1. Login to your sub-domain. Go to CA > Local. Click the ellipsis (...) and copy the contents of your CA Certificate.

    2. Logout of your sub-domain and now login to the root domain.

    3. Go to CA > External > Add External CA.

    4. Enter a name for this Domain CA and select the text radio button and paste the certificate contents.

    5. Click Add External CA.

    6. Go to Admin Settings > Interfaces.

    7. Click the Add icon to add the External CA.

    8. 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.

    1. Go to Admin Settings > Interfaces.

    2. Click the Add icon to add the External CA.

    3. Click Update.

    4. On the KMIP interface, click the ellipsis (...) > Certificate Options > Upload New Certificate > Ok.

    5. Select the Certificate Chain option and click Build Certificate Chain.

    6. 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.

    7. Select certificate Format as PEM.

    8. Click on Upload Certificate.

Further, You need to perform the following configuration on CipherTrust Manager specific to MongoDB:

copy link to clipboardCreating a Client Certificate

Note

  • This section is applicable to KMIP clients registered using Auto Registration but not to External CA.

  • This section is not applicable when using External CA.

  1. Log on to the CipherTrust Manager.

  2. Navigate to the CA > Local CA and click on the name of the CA certificate you need to issue the certificate from.

  3. Click on Issue Certificate.

  4. Enter the Display Name, followed by Common Name.

    Note

    The Common Name of the certificate should be the Hostname/IP of CipherTrust Manager. In case of domains, the Common Name of the certificate should be of the format:

    <domain name>||<Hostname/IP>

    For more information on the format of Common Name of the certificate, refer to LDAP and Multi-Domain Client Usernames in KMIP Certificates.

  5. Select the Algorithm and Size, and click Issue Certificate.

  6. Save the Private Key and the CSR.

  7. Select the Certificate Purpose as client, specify the validity of the certificate in days, and click Issue Certificate.

  8. Download a copy of this certificate by clicking the ellipsis next to the certificate name.

copy link to clipboardConfiguration on MongoDB

You can integrate MongoDB with the CipherTrust Manager using either of the following methods:

note

Note

These options are available with MongoDB Enterprise only.

copy link to clipboardIntegrate Using a New Key

  1. Create a client certifcate. Refer to Creating a Client Certificate if you are auto-registering your KMIP client.

  2. Concatenate the clientcertificate.pem and clientkey.pem files into a single file using:

    cat clientcertificate.pem clientkey.pem > client.pem

  3. In case of domains, concatenate the Domain CA and Root CA into a single file using:

    cat domainCA.pem rootCA.pem > ca.pem

  4. Start MongoDB manually using the following parameters to create an encryption key:

    mongod --enableEncryption
--kmipServerName <IP/Hostname of the CipherTrust Manager>
--kmipPort <KMIP port number of the CipherTrust Manager>
--kmipServerCAFile ca.pem
--kmipClientCertificateFile client.pem
--dbPath /var/lib/mongodb
    note

    Note

    You will need to add the CipherTrust Manager’s hostname to the /etc/hosts file on your MongoDB server so that the name can be resolved to the IP address of the CipherTrust Manager.

copy link to clipboardIntegrate Using an Existing Key

  1. Create a client certifcate. Refer to Creating a Client Certificate if you are auto-registering your KMIP client.

  2. Concatenate the clientcertificate.pem and clientkey.pem files into a single file using:

    cat clientcertificate.pem clientkey.pem > client.pem

  3. In case of domains, concatenate the Domain CA and Root CA into a single file using:

    cat domainCA.pem rootCA.pem > ca.pem

  4. Create a key on the CipherTrust Manager using the AES Algorithm. Set the state as Pre-Active.

    {
"name": "Test_Key",
"usageMask": 12,
"algorithm": "aes",
"meta": {
    "ownerId": "local|mongodb"
},
"state": "Pre-Active",
"deactivationDate": "2023-10-02T14:24:37.436073Z",
"protectStopDate": "2023-10-02T14:24:37.436073Z",
"aliases": [
    {
    "alias": "altname2",
    "type": "string"
    },
    {
    "alias": "altname2:keysecure:gemalto:com",
    "type": "uri"
    }
]
}

    e. Click POST.

  5. Add the key management security options to /etc/mongod.conf.

    The MongoDB configuration file contains a security section. In this section, update the KMIP server name, certificate details, KMIP port number, and Key ID to use the CipherTrust Manager as a key management service.

    security:
enableEncryption: true
kmip:
    serverName: <IP/Hostname of the CipherTrust Manager>
    port: <KMIP port number of the CipherTrust Manager>
    serverCAFile: <Path to the CA certificate>
    clientCertificateFile: <Path to the client.pem>
    keyIdentifier: <ID of the key created on the CipherTrust Manager>

  6. Start MongoDB manually using the following parameters:

    mongod --enableEncryption
--kmipServerName <IP/Hostname of the CipherTrust Manager>
--kmipPort <KMIP port number of the CipherTrust Manager>
--kmipServerCAFile ca.pem
--kmipClientCertificateFile client.pem
--kmipKeyIdentifier <ID of the key created on the CipherTrust Manager>
    note

    Note

    You will need to add the CipherTrust Manager’s hostname to the /etc/hosts file on your MongoDB server so that the name can be resolved to the IP address of the CipherTrust Manager.

After the service starts successfully, encryption is enabled and the integration is complete.

On this page