Installing an SSL Certificate on a Tomcat Server

Prerequisites

• The certificate has been issued and the certificate status is Issued.
• You have downloaded the SSL certificate. For details, see Downloading a Certificate.
• You have installed the OpenSSL tool.

  Download the latest OpenSSL installation package from https://www.openssl.org/source/. The OpenSSL must be 1.0.1g or later.

• You have installed Keytool.

  Keytool is typically included in the Java Development Kit (JDK) tool package.

Constraints

• Before installing the certificate, enable port 443 on the server where the SSL certificate is installed and add port 443 to the security group. Otherwise, HTTPS cannot be enabled after the installation.
• If a domain name maps to multiple servers, deploy the certificate on each server.
• The domain name to be run on the target server must be the same as the one associated with the certificate. Otherwise, the web browser will display a message indicating that the domain name is insecure.

Procedure

The installation process is as follows (for Tomcat 7 servers):

Step 1: Obtaining Files → Step 2: Creating a Directory → Step 3: Modifying Configuration Files → Step 4: Restarting the Tomcat → Step 5: Verifying the Effect

Step 1: Obtaining Files

Before installing a certificate, obtain the certificate file and password file. Perform the following operations based on the value selected for CSR when applying for a certificate:

• If you select System generated CSR for CSR when applying for a certificate, perform the operations according to the instructions in System generated CSR.
• If you select Upload a CSR for CSR when applying for a certificate, perform the operations according to the instructions in Upload a CSR.

Detailed operations are as follows:

• System generated CSR
  1. Decompress the downloaded certificate file on your local PC.
     The downloaded file contains the Apache, IIS, Nginx, and Tomcat folders as well as the domain.csr file. Figure 1 shows an example.

     Figure 1 Decompressing an SSL certificate package on a local computer
     
  2. Obtain Certificate ID_Domain name bound to the certificate_server.jks and Certificate ID_Domain name bound to the certificate_keystorePass.txt from Certificate ID_Domain name bound to the certificate_Tomcat.
• Upload a CSR
  1. Decompress the downloaded certificate package to obtain the Certificate ID_Domain name bound to the certificate_server.pem file.

     The Certificate ID_Domain name bound to the certificate_server.pem file contains two segments of certificate codes -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----, which are the server certificate and intermediate CA certificate respectively.

  2. Use OpenSSL to convert the PEM certificate into a PFX certificate and obtain the server.pfx file.
     1. Save the PEM certificate and the private key server.key generated during CSR generation to the bin directory in the OpenSSL installation directory.
     2. In the bin directory of the OpenSSL installation directory, run the following command to convert the PEM certificate into a PFX certificate and press Enter:

        openssl pkcs12 -export -out server.pfx -inkey server.key -in Certificate ID_Domain name bound to the certificate_server.pem

        The command output is as follows:

        Enter Export Password:

     3. Enter the password of the PFX certificate and press Enter.

        The password is user-defined. Set it as required.

        The command output is as follows:

        Verifying - Enter Export Password:

        

        Record the password of the PFX certificate. The password of the JKS certificate must be the same as that of the PFX certificate. Otherwise, the Tomcat service may fail to start.

        To improve password security, set the password based on the following rules:

        • Consists of 8 to 32 characters.
        • Must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters ~`!@#$%^&*()_+|{}:"<>?-=\[];',./
     4. Re-enter the password of the PFX certificate and press Enter.

        If no error information is displayed, the server.pfx file has been generated in the OpenSSL installation directory.

  3. Use Keytool to convert the PFX certificate into a JKS certificate and obtain the server.jks file.
     1. Copy the server.pfx file generated in 2 to the %JAVA_HOME%/jdk/bin directory.
     2. In the %JAVA_HOME%/jdk/bin directory, run the following command and press Enter:

        keytool -importkeystore -srckeystore server.pfx -destkeystore server.jks -srcstoretype PKCS12 -deststoretype JKS

        The following message is displayed.

        Enter the destination keystore password:

     3. Enter the password of the JKS certificate and press Enter.
        

        Set the password of the JKS certificate to the same as that of the PFX certificate. Otherwise, Tomcat may fail to start.

        The command output is as follows:

        Re-enter the new password:

     4. Re-enter the password of the JKS certificate and press Enter.

        The command output is as follows:

        Enter the source keystore password:

     5. Enter the password of the PFX certificate set in 2.c and press Enter.

        If information similar to the following is displayed, the conversion is successful and the server.jks file has been generated in the OpenSSL installation directory.

        Entry for alias 1 imported successfully.
        Import command completed: 1 entry successfully imported, 0 entries failed or canceled

     6. Create a keystorePass.txt file in the %JAVA_HOME%/jdk/bin directory and save the password of the JKS certificate in the file.
  4. Place the converted certificate file server.jks and the new password file keystorePass.txt in the same directory.

Step 2: Creating a Directory

Create a cert directory in the Tomcat installation directory, and copy the server.jks and keystorePass.txt files to the cert directory.

Step 3: Modifying Configuration Files

Before modifying the configuration file, back up the configuration file. You are advised to deploy the configuration file in the test environment and then configure it on the production environment to avoid service interruptions caused by incorrect configurations.

Step 4: Restarting the Tomcat

Run the ./shutdown.sh command in the bin directory of Tomcat to stop the Tomcat service.

After 10 seconds, run the ./startup.sh command to start the Tomcat service. If the process is automatically started by the daemon process, you do not need to manually start the process.

Step 5: Verifying the Effect

After the deployment succeeds, in the address bar of the browser, enter https://Domain name and press Enter.

If a security padlock is displayed in the address bar of the browser, the certificate has been installed successfully.

• If the browser still displays a message indicating that the website is insecure, fix the issue by referring to Why Does the Website Still Display a Message Indicating that the Website Is Insecure After an SSL Certificate Is Deployed?
• If the website cannot be accessed using a domain name, fix the issue by referring to Why Is My Website Inaccessible by Domain Name After an SSL Certificate Is Installed?