search cancel

How to Install an SSL Certificate for Symantec Encryption Management Server (PGP Server - Or renewal of expiring cert)

book

Article ID: 180416

calendar_today

Updated On:

Products

Encryption Management Server Gateway Email Encryption

Issue/Introduction

This article explains how to create a Certificate Signing Request (CSR) for an SSL certificate and then import the certificate to Symantec Encryption Management Server (PGP Server).

We will also discuss the process to "Renew" a certificate that will soon expire.

Environment

Symantec Encryption Management Server 3.4.2 and above.

Resolution

Services such as clustering and Web Email Protection use the TLS protocol and require a server TLS certificate which includes the host name for the IP address of the server on which the service is running. To issue a certificate, the Certificate Authority needs information found in a certificate request (CSR).

Because Web Email Protection is public facing, it is recommended to get a certificate from a Trusted Certificate Authority, such as Digicert to be able to assign the certs.

If the PGP Server is in the mailflow, it is also highly recommended to get a trusted certificate for TLS Email communications to be seamless.


There are four stages to this process:

  1. Create the Certificate Signing Request (CSR) file and submit it to the CA (Certificate Authority).
  2. Ensure that PGP Server trusts the certificates in the server certificate's issuing chain or certification path (Keys, Trusted Keys on the PGP Server).
  3. Import the signed server certificate.
  4. Assign the certificate to the correct network interface of PGP Server.

Section 1 of 4: Create and Submit a Certificate Signing Request (CSR)

  1. Log into the admin console.
  2. Navigate to System / Network and click on the Certificates button at the bottom of the page.
  3. Click the Generate CSR button.

    NOTE:  You can also choose to generate a Self Signed Certificate if you do not intend to use an external or internal Certificate Authority.
     
  4. Type in the Fully Qualified Domain Name (FQDN) for the server. For example, keys.example.com.
  5. Do not enter an email address in the Contact Email field. TLS certificates do not generally include an email address.
  6. Optionally, enter your organization's name in the Organization Name field.
  7. Optionally, enter your organization's unit designation in the Organization Unit field.
  8. Optionally, enter a city or locality, as appropriate, in the City/Locality field.
  9. Optionally, enter a state or province, as appropriate, in the Province/State field.
  10. Optionally, enter a two letter ISO 3166 country code in the Country field.
  11. To generate a Certificate Signing Request (CSR), click the Generate CSR button.
  12. The CSR window opens, showing the BEGIN CERTIFICATE REQUEST text.
  13. Select all of the text, copy and paste it into a text editor and save the file. Then click the OK button.
  14. The certificate appears on the Certificate page as Pending. If you click on the certificate name you will see the CSR text and can copy it again if required.
  15. Submit the text file containing the CSR or its contents to your Certificate Authority (CA).
  16. The CA will send a public server certificate back to you. The CA will also send you the root certificate and any intermediate certificates.

 

Section 2 of 4: Ensure that the Certificates in the Issuing Chain are Trusted

Before you import the server certificate, you must ensure that Encryption Management Server trusts the certificates in the server certificate's issuing chain or certification path. Every server certificate has an issuing chain of certificates. Generally, the Certificate Authority will send you these certificates or direct you to a web site from where you can download them. There is always a root certificate in the issuing chain and at least one intermediate certificate. To ensure that Encryption Management server trusts them please do the following:

  1. From the admin console, click on Keys / Trusted Keys.
  2. Search for the name of the certificate to check if it is already present. If you find a certificate that has a similar name to the one you are looking for, check whether the expiry date matches and, to be completely sure it is the same certificate, check the fingerprint / thumbprint.
  3. If the certificate is not already present, click on the Add Trusted Key button.
  4. Click on the Choose File button, browse to the location of the **Root Certificate** and click Open. Note that the certificate must be in Base-64 encoded format, not DER encoded binary format.
  5. At a minimum, click to enable the option Trust key for verifying SSL/TLS certificates.
    TIP: Check all the boxes so it's easy to find the cert you just imported as it will show "FULL".
  6. If Encryption Management Server processes email, enable the option Trust key for verifying mail encryption keys.
  7. Click the Save button.
  8. Repeat the above steps to import the root certificate and all applicable **Intermediate Certificates** (Some CAs may have one intermediate, some may have multiple, check with your CA to ensure you have all of them present.  Double-click the Root Certificate you have and under Certificate Path, check the chain).

    IMPORTANT TIP: Check the thumbprint/fingerprint of the Root Certificate Authority and Intermediate Certificate Authority and make sure they are listed in the Trusted keys.  This will make it possible for the certificate chain file to be created once you assign the certificate to the interface.

    Also, if you have generated your certificate from another server, you must export the entire keypair (Public and Private) to the SEE Management Server.  

 

Section 3 of 4: Import the Server Certificate

  1. Open the server certificate that the Certificate Authority sent you in a text editor and copy all the text to the clipboard.
  2. From the administration console, click on System / Network and then click the Certificates button.
  3. Click the + button in the Import column of the pending certificate you are adding. The Add Certificate to Key dialog box appears.
  4. Paste the certificate text from the clipboard into the Certificate Block box.
  5. Click Save to import the new certificate.

Next, you will assign the certificate from the previous steps to the network interface.

  1. Click on System / Network.
  2. Select the correct Interface from the interface drop down list.
  3. Select the new certificate from the Assigned Certificate drop down list.
  4. Click Save.

Note for Sans Alternative Names attribute
Symantec Encryption Management Server does not have the ability to create a SANs for additional hostnames for the PGP server.  If you would like to have this functionality, please log a new support ticket with Symantec Encryption to be added to this feature request.

As a workaround, generate the CSR, and your Certificate Authority should allow you to add these attributes manually and then the certificate can be added to the PGP server.

 

Section 4 of 4: Certificate Renewal (for certs that will soon expire)

If the TLS Certificate assigned under System, Network, is going to expire soon, the PGP server will typically provide a warning on the login screen to remind you.
If you do not renew the certificate, there could be issues with various aspects of the server. It is better to get the certificate renewed a few weeks prior to key expiration.

To be able to "renew" the certificate, you will go through the same process above to generate a new CSR request as shown in "Section 1" of this article. 

If you run into any snags, or need an option to renew, please reach out to  Symantec Encryption Support for further guidance. 

Additional Information

EPG-23670
EPG-27210

178609 - How to create an SSL certificate to be used to secure Client Communication with the Symantec Endpoint Encryption Management Server

176302 - Renewing the Endpoint Encryption Management Server TLS certificate

154069 - Best Practices: Environmental Requirements for Symantec Encryption Management Server clustering (AKA PGP Server)

227219 - Making Symantec Endpoint Encryption Management Server Public Facing

227509 - Migrating from Symantec Encryption Desktop to Symantec Endpoint Encryption (Drive Encryption components)

257339 - How to Create and Assign a Subordinate/Intermediate Certificate for SMIME/Certificate Signing with PGP Server

180416 - How to Install an SSL Certificate for Symantec Encryption Management Server (PGP Server)

180143 - HOW TO: Work with Trusted Keys and Certificates on Symantec Encryption Management Server

155218 - HOW TO: Generate a new self-signed Organization Certificate for PGP Server for SMIME Email Encryption