tencent cloud

Feedback

Installing an SSL Certificate (JKS Format) on a Tomcat Server

Last updated: 2022-03-15 14:54:37

    Overview

    This document describes how to install an SSL certificate (JKS format) on a Tomcat server.

    Note:

    • The certificate name cloud.tencent.com is used as an example.
    • Tomcat 9.0.56 is used as an example.
    • The current server OS is Windows Server 2016 Chinese. Detailed steps vary slightly with the OS.
    • Before you install an SSL certificate, enable port 443 on the Tomcat server so that HTTPS can be enabled after the certificate is installed. For more information, please see How Do I Enable Port 443 for a VM?
    • For more information about how to upload SSL certificate files to a server, please see Copying Local Files to CVMs.

    Prerequisites

    • The Tomcat service has been installed and configured on the server.
    • The data required to install the SSL certificate includes the following:
      Item Description
      Server IP address IP address of the server, which is used to connect the PC to the server.
      Username The username used to log in to the server.
      Password The password used to log in to the server.
    Note:

    • For a CVM instance purchased on the Tencent Cloud official website, log in to the CVM console to obtain the server IP address, username, and password.
    • If you have selected the Paste CSR method when applying for the SSL certificate, or your certificate brand is Wotrus, the option to download the JKS certificate file is not provided. Instead, you need to manually convert the format to generate a keystore as follows:
      • Access the conversion tool.
      • Upload the certificate and private key files in the Nginx folder to the conversion tool, enter the keystore password, click Submit, and convert the certificate to a .jks certificate.

    Directions

    Certificate Installation

    1. Log in to the SSL Certificate Service console, and click Download for the certificate you need to install.
    2. In the pop-up window, select JKS for the server type, click Download, and decompress the cloud.tencent.com certificate file package to the local directory.
      After decompression, you can get the certificate file of the corresponding type, which includes the cloud.tencent.com_jks folder.
      • Folder: cloud.tencent.com_jks
      • Files in the folder:
        • cloud.tencent.com.jks: keystore file
        • keystorePass.txt: password file (if you have set a private key password, this file will not be generated)
    3. Copy the keystore file cloud.tencent.com.jks to the conf directory of the Tomcat installation directory as follows:
    4. Edit the server.xml file in the conf directory by adding the following:
      <Connector port="443" protocol="HTTP/1.1" SSLEnabled="true"
      maxThreads="150" scheme="https" secure="true"
      # Path of the certificate
      keystoreFile="Tomcat installation directory/conf/cloud.tencent.com.jks" 
      # Keystore password
      keystorePass="******"
      clientAuth="false"/>
      

    For details about the server.xml file, see below:

    Note:

    To avoid format issues, you are not advised to copy the content of server.xml directly.

    <?xml version="1.0" encoding="UTF-8"?>
    <Server port="8005" shutdown="SHUTDOWN">
       <Listener className="org.apache.catalina.startup.VersionLoggerListener" />
       <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
       <Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
       <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
       <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
    <GlobalNamingResources>
       <Resource name="UserDatabase" auth="Container"
                 type="org.apache.catalina.UserDatabase"
                 description="User database that can be updated and saved"
                 factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
                 pathname="conf/tomcat-users.xml" />
    </GlobalNamingResources>
      <Service name="Catalina">
            <Connector port="80" protocol="HTTP/1.1" connectionTimeout="20000"  redirectPort="8443" />
           <Connector port="443" protocol="HTTP/1.1"
                  maxThreads="150" SSLEnabled="true" scheme="https" secure="true"
                  clientAuth="false"
                   keystoreFile="Tomcat installation directory/conf/cloud.tencent.com.jks"
                   keystorePass="******" />
           <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
       <Engine name="Catalina" defaultHost="cloud.tencent.com">
           <Realm className="org.apache.catalina.realm.LockOutRealm">
           <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
                  resourceName="UserDatabase"/>
           </Realm>
        <Host name="cloud.tencent.com"  appBase="webapps" 
           unpackWARs="true" autoDeploy="true" >
           <Context path="" docBase ="Knews" />
           <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
              prefix="localhost_access_log" suffix=".txt"  
              pattern="%h %l %u %t "%r" %s %b" />
         </Host>
       </Engine>
     </Service>
    </Server>
    

    The main parameters of the configuration file are described as below:

    • keystoreFile: location of the keystore file. You can specify an absolute path or a path relative to the <CATALINA_HOME> (Tomcat installation directory) environment variable. If this parameter is not set, Tomcat reads the file named ".keystore" from the user directory of the current OS user.
    • keystorePass: keystore password. If you set a private key password when applying for the certificate, enter the private key password; otherwise, enter the password in the keystorePass.txt file in the Tomcat folder.
    • clientAuth: If it is set to true, Tomcat requires all SSL clients to provide a security certificate for identity verification.
    1. Confirm whether the Tomcat server is started.
      • If the Tomcat server is already started, you need to run the following .bat scripts in sequence in the bin directory of the Tomcat installation directory to shut down and restart it:
        shutdown.bat  (Shut down the Tomcat server)
        startup.bat (Start the Tomcat server)
        
    • If the Tomcat server is not started, you need to run the following .bat script in the bin directory of the Tomcat installation directory to start it:
      startup.bat
      
      
    1. If the server is started successfully, you can access it through https://cloud.tencent.com.

    (Optional) security configuration for automatic redirect from HTTP to HTTPS

    You can redirect HTTP requests to HTTPS by configuring the following settings:

    1. Edit the web.xml file in the conf directory of the Tomcat installation directory and find the &lt;\/welcome-file-list> tag as follows:
    2. Insert a new line after &lt;\/welcome-file-list> and add the following:
      <login-config>
      <!-- Authorization setting for SSL -->
      <auth-method>CLIENT-CERT</auth-method>
      <realm-name>Client Cert Users-only Area</realm-name>
      </login-config>
      <security-constraint>
      <!-- Authorization setting for SSL -->
      <web-resource-collection>
        <web-resource-name>SSL</web-resource-name>
        <url-pattern>/*</url-pattern>
      </web-resource-collection>
      <user-data-constraint>
        <transport-guarantee>CONFIDENTIAL</transport-guarantee>
      </user-data-constraint>
      </security-constraint>
      
    1. Edit the server.xml file in the Tomcat installation directory by changing the redirectPort parameter to the port of the SSL connector, i.e., port 443, as shown below:
      <Connector port="80" protocol="HTTP/1.1"
      connectionTimeout="20000"
      redirectPort="443" />
      
    Note:

    This change allows a non-SSL connector to redirect to an SSL connector.

    1. Run the following .bat script in the /bin directory of the Tomcat installation directory to shut down the Tomcat server:

      shutdown.bat
      
    2. Run the following command to confirm whether there is a problem with the configuration:

      configtest.bat
      
      
    • If yes, reconfigure or fix the problem as prompted.
    • If no, proceed to the next step.
    1. Run the following .bat script to start the Tomcat server. In this way, you can access it through http://cloud.tencent.com.
      startup.bat
      
      
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support