Setting up SSL/TLS

Configuring SSL with CipherTrust Manager

Standard SSL communication requires a certificate that identifies the server. This certificate is signed by a certificate authority (CA) known to both the server and the client. During the SSL handshake, the server certificate is passed to the client. The client uses a copy of the CA certificate to validate the server certificate, thus authenticating the server.

While the CA can be a third-party CA or your corporate CA, you will most likely use a local CA on the CipherTrust Manager appliance. If you are not using a local CA, consult your CA documentation for instructions on signing requests and exporting certificates.

To use an SSL connection when communicating with the CipherTrust Manager appliance, configure the server and the client.

To configure the server:

1. Create a server certificate. (If you are using a cluster, each member must have its own, unique certificate). To create a server certificate, follow these steps:

   1. Creating a Local CA

   2. Creating a CSR on the console

   3. Signing a Certificate Request with a Local CA

2. Make the certificate active. Refer to Activating the Server Certificate.

3. Enabling SSL connection.

   1. Log on to the console as an administrator with Certificate Authorities access control.

   2. Navigate to Settings > Interfaces.

   3. Under Interface Configurations, edit NAE interface and select a TLS option in the Mode field. Available options are:

      1. TLS, allow anonymous logins, ignore client cert

      2. TLS, user must supply password, ignore client cert

      3. TLS, allow anonymous logins, verify client cert

      4. TLS, user must supply password, verify client cert

      5. Verify client cert, username taken from client cert, auth request is optional

      6. Verify client cert, password is needed, username in cert must match username in authentication request

To configure the client, you must:

1. Place a copy of the CA certificate on your client. Refer to Downloading a Local CA Certificate.

2. Update the IngrianNAE.properties file as follows:

   Protocol=ssl
   CA_File=<location and name of the CA certificate file>‌‌
   

Authenticating Server Certificate on CipherTrust Manager

This section describes the procedure to configure SSL for server certificate authentication.

Creating a Local CA‌‌

To create a local CA:

1. Log on to the console as an administrator with Certificate Authorities access control.

2. Click CA > Local CA.

3. Under the Local Certificate Authorities section, click Local CA.

4. On the Local CA window, enter the fields as needed.

5. Click Create Local CA. It is added in the Pending CAs.

6. From the Pending CAs list, click the local CA that you want to create. A window containing property and value of the CA displays.

7. You can either self-sign Certificate Signing Request (CSR) or upload a certificate signed by an external CA.

   Note

   For uploading a certificate signed by an external CA, you must have installed the external CA certificate.

   Once the CA is verified, it is listed under the Local Certificate Authorities section.

   In the Local Certificate Authorities list, you can view Subject, Serial#, Activation, Expiration, and State.

   You can also delete, view certificate details, and download the local certificate.

   Note

   Only a local CA can sign certificate requests on CipherTrust Manager appliance. If you are using a CA that does not reside on CipherTrust Manager appliance you cannot use the console to sign certificate requests.

Downloading a Local CA Certificate‌‌

To download a local CA certificate from CipherTrust Manager appliance:

1. Log in to the console as an administrator with Certificate Authorities access controls.

2. Navigate to CA > Local Certificate Authorities, click the ellipsis icon, and select Download to download a local CA. You should place the CA certificate in a secure location and modify access appropriately.

   Update the following parameters in your IngrianNAE.properties file:

   Protocol=ssl
   CA_File=<path to CA cert>\localca.crt
   

   Note

   Use the CA_File parameter in the IngrianNAE.properties file to indicate the name and location of the CA certificate.

Creating a CSR on the Console‌‌

To create a certificate signing request on the console:

1. Log on to the console as an administrator with Certificates access control.

2. Click CA.

3. Under the CSR Tool section, click Create CSR.

4. On the Create CSR window, enter the fields as needed (Common Name is mandatory).

5. Click Create. You'll be prompted with two options: save csr and save private key.

   1. Click save csr to save the CSR in the .pem format.

      Note

      You must save the Private Key to continue.

   2. Click save private key to save the private key in .pem format.

      Note

      For generation of public/private key pairs for server certificates only RSA algorithm is supported.

Signing a Certificate Request with a Local CA‌‌

To sign a certificate request with a local CA:

1. Log in to the console as an administrator with Certificates access control.

2. Navigate to CA > Local Certificate Authorities and click on the local CA from which you want to sign the CSR.

3. Click Upload CSR.

4. Copy the saved CSR in the previous section and paste it on the Upload Externally Generated CSR window. The copied text must include the header (-----BEGIN CERTIFICATE REQUEST-----) and footer (-----END CERTIFICATE REQUEST-----).

5. From the Certificate Purpose list, select server.

6. In the Duration in days field, enter the life span of the certificate. Enter minimum 365 days.

7. Click Issue Certificate.

   The newly created certificate is listed under Parent Issuer. This certificate can be used as the server certificate for the NAE Server.

8. Once the certificate has been issued, click the ellipsis icon, and select Download to download the certificate.

Activating the Server Certificate‌‌

To activate the server certificate:

1. Log on to the Management Console as an administrator.

2. Navigate to Settings > Interfaces.

3. For NAE interface, click icon in the Action column.

4. In the Local CA for Automatic Server Certificate Generation field, select Turn off auto generation from a local CA.

   Note

   In the Local CA for Automatic Server Certificate Generation field, if you select any CA then just click Update. It will automatically generate a server certificate and make it active.

5. Expand Upload Certificate.

6. In the Certificate text box, paste the server certificate, CA certificate, and key in the PEM format or base64 encoded PKCS#12 format.

   Note

   The list of certificates must be added from server cert to root ca in the ascending order. If there are any intermediate CAs, they can be added. The key can be anywhere. Maintaining this order is important: <server cert> <ca cert> <key>

7. Select Format.

8. Click Upload New Certificate and then click Update. Restart the application after uploading the certificate.

Authenticating Client Certificate on CipherTrust Manager

This SSL configuration requires that both the server and the client provide certificates. Each certificate is signed by a trusted CA known to both the server and the client. Most likely, you will use one CA to sign both the certificates. During the SSL handshake, the certificates are exchanged. Both the client and the server use the CA certificate to validate each others' certificate, thus authenticating the other party.

To enable client certificate authentication, you must first successfully configure SSL. Then, you must make additional configuration changes to the client and the server.

To configure the client:

1. Create a client certificate. This involves two steps:

   1. Generating a Client Certificate Request with OpenSSL

   2. Signing a Certificate Request and Downloading the Certificate

      You can create a certificate request using OpenSSL. You can then sign the request with the local CA on the CipherTrust Manager appliance. Once signed, the certificate request becomes a valid certificate.

      If you are not using a local CA, consult your CA documentation for instructions on signing requests and exporting certificates.

2. Update the IngrianNAE.properties file as follows:

   Cert_File=<location and name of the client certificate> Key_File=<location and name of the client’s key file> Passphrase=<the passphrase used to unlock the client’s key file>

To configure the server, you must upload a CA certificate on the server.

Generating a Client Certificate Request with OpenSSL‌‌

To generate a client certificate request:

1. Open the command window.

2. If you are using OpenSSL, run the following command:

   openssl req -out clientreq -newkey rsa:2048 -keyout clientkey
   

   Note

   By default, both the certificate request and private key will be created in the working directory. You can generate them in another directory by including a location in the certificate request and key name.

   For example, to create them in the C:\client_certs directory, use the following command:

   openssl req -out C:\client_certs\clientreq -newkey rsa:2048 - keyout C:\client_certs\clientkey

   The certificate request generation process will then request the following details:

   • A PEM passphrase to encode the private key: The passphrase that encodes the private key is the first passphrase you provide after issuing the above command. This will be the Passphrase parameter in the IngrianNAE.properties file.

   • The distinguished name: The distinguished name is a series of fields whose values are incorporated into the certificate request. These fields include country name, state or province name, locality name, organization name, organizational unit name, common name, and email address.

   • A challenge password: This challenge password is NOT used in the CipherTrust Manager environment.

   • An optional company name.

Signing a Certificate Request and Downloading the Certificate‌‌

This section describes how to sign a certificate request with a local CA and then download the certificate. You must download the certificate immediately after it is signed by the CA.

To sign a certificate request with a local CA:

1. Log on to the console as an administrator with Certificate Authorities access controls.

2. Navigate to CA > Local Certificate Authorities and click the local CA by which you want to sign the CSR.

3. Click Upload CSR.

4. Copy the CSR and paste it on the Upload Externally Generated CSR window. The copied text must include the header (-----BEGIN CERTIFICATE REQUEST-----) and footer (-----END CERTIFICATE REQUEST-----).

5. From the Certificate Purpose list, select client.

6. In the Duration in days field, enter the life span of the certificate. Enter minimum 365 days.

7. Click Issue Certificate. The newly created certificate is listed under Parent Issuer.

8. Click the image button to save the certificate on your local machine.

   Note

   You should place the certificate in a secure location and modify access appropriately.

9. Update the following parameters in the IngrianNAE.properties file:

   Cert_File=<path to client cert>\client.crt Key_File=<path to client key>\clientkey
   Passphrase=<the passphrase used to unlock the client's key file>
   

   Note

   Restart the database after updating the properties file for the changes to take effect. Use the Cert_File parameter in the IngrianNAE.properties file to indicate the name and location of the client certificate.