tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
SSL Certificate Service
    Documentation
    Download PDF

    Installing an SSL Certificate on a Jetty Server

    Last updated: 2024-03-06 17:38:42
    Download PDF

      Overview

      This document describes how to install an SSL certificate on a Jetty server.
      Note:
      The certificate name cloud.tencent.com is used as an example.
      The jetty-distribution-9.4.28.v20200408 version is used as an example.
      The current server OS is CentOS 7. Detailed steps vary slightly by OS.
      Before you install an SSL certificate, enable port 443 on the Jetty server so that HTTPS can be enabled after the certificate is installed. For more information, see How Do I Enable Port 443 for a VM?.
      For detailed directions on how to upload SSL certificate files to a server, see Copying Local Files to CVMs.

      Prerequisites

      Install the remote file copy tool such as WinSCP. The latest official version is recommended. We recommend that you use CVM's file upload feature for deployment to CVM.
      Install the remote login tool such as PuTTY or Xshell. The latest official version is recommended.
      The Jetty service has been installed and configured on the current server.
      The data required to install the SSL certificate includes the following:
      Name
      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 get the server IP address, username, and password.
      If you have selected the By pasting 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.
      The Jetty service is installed in the /usr/local/jetty directory.

      Directions

      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. Remotely log in to the Jetty server. For example, you can use PuTTY for remote login.
      4. In the /usr/local/jetty/jetty-distribution-9.4.28.v20200408/etc directory, run the mkdir cert command to create the cert folder.
      5. Use WinSCP (a tool for copying files between a local computer and a remote computer) to log in to the Jetty server and copy the keystore file cloud.tencent.com.jks from the local directory to the cert folder.
      Note:
      For detailed directions, see Uploading files via WinSCP to a Linux CVM from Windows.
      We recommend that you use CVM's file upload feature for deployment to CVM.
      6. In the /usr/local/jetty/jetty-distribution-9.4.28.v20200408/etc directory, modify the configuration in the jetty-ssl-context.xml file.
      Note:
      KeyStorePath: Set the default value to the certificate path.
      KeyStorePassword: Set the default value to the keystore password. If you have 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 cloud.tencent.com_jks folder.
      KeyManagerPassword: Set the value to the password in the keystorePass.txt file in the cloud.tencent.com_jks folder.
      TrustStorePath: Set the default value to the certificate path.
      <?xml version="1.0"?><!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd">
      <!-- ============================================================= --><!-- SSL ContextFactory configuration                              --><!-- ============================================================= -->
      <!-- 
        To configure Includes / Excludes for Cipher Suites or Protocols see tweak-ssl.xml example at 
        https://www.eclipse.org/jetty/documentation/current/configuring-ssl.html#configuring-sslcontextfactory-cipherSuites
      -->
      <Configure id="sslContextFactory" class="org.eclipse.jetty.util.ssl.SslContextFactory$Server">
        <Set name="Provider"><Property name="jetty.sslContext.provider"/></Set>
        <Set name="KeyStorePath"><Property name="jetty.base" default="." />/<Property name="jetty.sslContext.keyStorePath" deprecated="jetty.keystore" default="etc/cert/cloud.tencent.com.jks"/></Set>
        <Set name="KeyStorePassword"><Property name="jetty.sslContext.keyStorePassword" deprecated="jetty.keystore.password" default="4d5jtdq238j1l"/></Set>
        <Set name="KeyStoreType"><Property name="jetty.sslContext.keyStoreType" default="JKS"/></Set>
        <Set name="KeyStoreProvider"><Property name="jetty.sslContext.keyStoreProvider"/></Set>
        <Set name="KeyManagerPassword"><Property name="jetty.sslContext.keyManagerPassword" deprecated="jetty.keymanager.password" default="4d5jtdq238j1l"/></Set>
        <Set name="TrustStorePath"><Property name="jetty.base" default="." />/<Property name="jetty.sslContext.trustStorePath" deprecated="jetty.truststore" default="etc/cert/cloud.tencent.com.jks"/></Set>
        <Set name="TrustStorePassword"><Property name="jetty.sslContext.trustStorePassword" deprecated="jetty.truststore.password"/></Set>
        <Set name="TrustStoreType"><Property name="jetty.sslContext.trustStoreType"/></Set>
        <Set name="TrustStoreProvider"><Property name="jetty.sslContext.trustStoreProvider"/></Set>
        <Set name="EndpointIdentificationAlgorithm"><Property name="jetty.sslContext.endpointIdentificationAlgorithm"/></Set>
        <Set name="NeedClientAuth"><Property name="jetty.sslContext.needClientAuth" deprecated="jetty.ssl.needClientAuth" default="false"/></Set>
        <Set name="WantClientAuth"><Property name="jetty.sslContext.wantClientAuth" deprecated="jetty.ssl.wantClientAuth" default="false"/></Set>
        <Set name="useCipherSuitesOrder"><Property name="jetty.sslContext.useCipherSuitesOrder" default="true"/></Set>
        <Set name="sslSessionCacheSize"><Property name="jetty.sslContext.sslSessionCacheSize" default="-1"/></Set>
        <Set name="sslSessionTimeout"><Property name="jetty.sslContext.sslSessionTimeout" default="-1"/></Set>
        <Set name="RenegotiationAllowed"><Property name="jetty.sslContext.renegotiationAllowed" default="true"/></Set>
        <Set name="RenegotiationLimit"><Property name="jetty.sslContext.renegotiationLimit" default="5"/></Set>
        <Set name="SniRequired"><Property name="jetty.sslContext.sniRequired" default="false"/></Set>
        <!-- Example of how to configure a PKIX Certificate Path revocation Checker
        <Call id="pkixPreferCrls" class="java.security.cert.PKIXRevocationChecker$Option" name="valueOf"><Arg>PREFER_CRLS</Arg></Call>
        <Call id="pkixSoftFail" class="java.security.cert.PKIXRevocationChecker$Option" name="valueOf"><Arg>SOFT_FAIL</Arg></Call>
        <Call id="pkixNoFallback" class="java.security.cert.PKIXRevocationChecker$Option" name="valueOf"><Arg>NO_FALLBACK</Arg></Call>
        <Call class="java.security.cert.CertPathBuilder" name="getInstance">
       <Arg>PKIX</Arg>
       <Call id="pkixRevocationChecker" name="getRevocationChecker">
         <Call name="setOptions">
           <Arg>
             <Call class="java.util.EnumSet" name="of">
               <Arg><Ref refid="pkixPreferCrls"/></Arg>
               <Arg><Ref refid="pkixSoftFail"/></Arg>
               <Arg><Ref refid="pkixNoFallback"/></Arg>
             </Call>
           </Arg>
         </Call>
       </Call>
        </Call>
        <Set name="PkixCertPathChecker"><Ref refid="pkixRevocationChecker"/></Set>
        -->
      </Configure>
      7. In the /usr/local/jetty/jetty-distribution-9.4.28.v20200408/etc directory, change the port number to 443 in the jetty-ssl.xml file.
       <Call  name="addConnector">
       <Arg>
         <New id="sslConnector" class="org.eclipse.jetty.server.ServerConnector">
           <Arg name="server"><Ref refid="Server" /></Arg>
           <Arg name="acceptors" type="int"><Property name="jetty.ssl.acceptors" deprecated="ssl.acceptors" default="-1"/></Arg>
           <Arg name="selectors" type="int"><Property name="jetty.ssl.selectors" deprecated="ssl.selectors" default="-1"/></Arg>
           <Arg name="factories">
             <Array type="org.eclipse.jetty.server.ConnectionFactory">
               <!-- uncomment to support proxy protocol
               <Item>
                 <New class="org.eclipse.jetty.server.ProxyConnectionFactory"/>
               </Item>-->
             </Array>
           </Arg>
           <Set name="host"><Property name="jetty.ssl.host" deprecated="jetty.host" /></Set>
           <Set name="port"><Property name="jetty.ssl.port" deprecated="ssl.port" default="443" /></Set>
           <Set name="idleTimeout"><Property name="jetty.ssl.idleTimeout" deprecated="ssl.timeout" default="30000"/></Set>
           <Set name="acceptorPriorityDelta"><Property name="jetty.ssl.acceptorPriorityDelta" deprecated="ssl.acceptorPriorityDelta" default="0"/></Set>
           <Set name="acceptQueueSize"><Property name="jetty.ssl.acceptQueueSize" deprecated="ssl.acceptQueueSize" default="0"/></Set>
           <Get name="SelectorManager">
             <Set name="connectTimeout"><Property name="jetty.ssl.connectTimeout" default="15000"/></Set>
           </Get>
         </New>
       </Arg>
        </Call>
      8. In the /usr/local/jetty/jetty-distribution-9.4.28.v20200408 directory, add the following content to the start.ini file:
      etc/jetty-ssl.xml
      etc/jetty-ssl-context.xml
      etc/jetty-https.xml
      9. In the Jetty root directory, run the java -jar start.jar command to start the Jetty server and then you can access it through https://cloud.tencent.com.
      If the security lock icon is displayed in the browser, the certificate has been installed successfully.
      In case of a website access exception, troubleshoot the issue by referring to the following FAQs:
      Website Inaccessible After an SSL Certificate is Deployed
      "Your Connection is Not Secure" is Displayed After the SSL Certificate is Installed
      Why Does the Website Prompt "Connection Is Untrusted"?
      404 Error After the SSL Certificate is Deployed on IIS

      Reminders

      After the certificate is deployed, the following error message may be displayed when you access https://cloud.tencent.com:
      
      If the error message is displayed, copy the ROOT file from the /usr/local/jetty/jetty-distribution-9.4.28.v20200408/demo-base/webapps directory to the /usr/local/jetty/jetty-distribution-9.4.28.v20200408/webapps directory, and then restart the Jetty server.
      Note: If anything goes wrong during this process, contact us.
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy