Enabling TLS server certificate validation between the Gateway Server and the Application Server

The Gateway Server communicates with the Application Server component of TrueSight Capacity Optimization. 

Gateway Server supports only self-signed certificates. So, there is no need for a new certificate to communicate with the Application Server. Only the Application Server and the ETL Engine are needed to be signed.

When you install the Gateway Server, a self-signed certificate is also installed. However, it is recommended to install a security certificate that is issued by a competent public certificate authority (CA). 

Complete the following tasks to configure the Application Server to use TLS:

  1. Obtain a signed security certificate for the Application Server
  2. Install the signed certificates into the truststore of Application Server
  3. Configure the Application Server to use TLS

Before you begin

Obtaining a signed security certificate for the Application Server

You must obtain a certificate that is signed by a CA. Usually, the security department of your organization can provide you this certificate or you can request for it from the CA that your organization recommends. For information about requesting for a signed certificate, see Creating-a-request-for-a-CA-signed-certificate.

Installing the signed certificates into the truststore of Application Server

If you are switching the Application Server to a new machine, you must reinstall the product to point the installation to the new Application server. For more information, see Installing Application Server.

The Application Server uses the cotruststore.ts truststore to communicate with other components. This truststore is bundled along with the Server installation and is located in the <Server Installation Directory>/secure directory.

Steps to install the signed certificates into the truststore of Application Server
  1. Log on to the host computer where the Application Server is installed.

  2. The keytool utility that is used to generate and import the certificates is present in the <Application Server Installation Directory>/jre/bin directory. The default <Application Server Installation Directory> is /opt/bmc/BCO.

    Add this directory path to the PATH environment variable by running the following command:

    # Linux

    export PATH=<Application Server Installation Directory>/jre/bin:$PATH

  3. Navigate to the directory where the cotruststore.ts truststore file is located.

    Windows: <Application Server Installation Directory>\secure

    Linux: <Application Server Installation Directory>/secure

    Note

    Take a backup of the \secure folder and save it in a location that is not in the Application Server install path. If you need to reinstall the Application Server in case it stops processing, you can restore this backed up folder.


  4. Copy cotruststore.ts truststore file and rename it as cotruststore-update.ts.

  5. List all the keys in the cotruststore-update.ts truststore file by running the following command:

    keytool -list -keystore <Application Server Installation Directory>/secure/cotruststore.ts -storepass changeit -storetype JKS

    Note

    changeit is the default password for the cotruststore-update.ts truststore.

  6. Delete the existing certificate alias, dummy, if it exists, by running the following command:

    keytool -delete -alias dummy -keystore <Application Server Installation Directory>/secure/cotruststore-update.ts -storepass changeit

    Parameter description

    dummy: Alias name for the root certificate. If the alias name of the root certificate is different, then use the relevant name in the preceding command.

  7. Run the list command again to verify that the aliases are deleted:

    keytool -list -keystore cotruststore-update.ts -storepass changeit

  8. Copy the RootCA.cer, intermediateCA.cer, and TSCO.cer to the current directory, and import these certificates into the cotruststore-update.ts truststore by running the following command:

    keytool -importcert -trustcacerts -alias root -keystore loginvault-update.ks -storepass changeit -file RootCA.cer

    You are prompted with the Trust this certificate question, type Yes

    keytool -importcert -trustcacerts -alias intermediateCA -keystore loginvault-update.ks -storepass changeit -file intermediateCA.cer

    You are prompted with the Trust this certificate question, type Yes

    keytool -v -importcert -alias coserver -keystore <Application Server Installation directory>/secure/ cotruststore-update.ts -storepass changeit -storetype JKS -file TSCO.cer -trustcacerts

    You are prompted with the Trust this certificate question, type Yes

  9. Navigate to the directory where the cotruststore.ts truststore is located.

    Windows: <Application Server Installation Directory>\conf\secure

    Linux: <Application Server Installation Directory>/conf/secure

  10. Rename the cotruststore.ts truststore file as cotruststore.ts.orig.
  11. Copy cotruststore-update.ts truststore file and rename it as cotruststore.ts.
  12. Restart the Application Server.

Configuring the Application Server to use TLS

Complete the following steps on all the computers where the Application Server components and ETL Engine Server are installed:

  1.  Navigate to the <Server Installation Directory>/tools directory and run the switchTLSmode.pl script.

    #Example
    switchTLSmode.pl -on -tspwd -flow internal
    Click here for switchTLSmode.pl command details
    #Syntax
    perl switchTLSmode.pl [-h or --help] [ -on|-off ] [ -dbport port ] [ -tspwd ] [-flow internal,auth,codb,externaldb,all]

     

    Parameter reference
    -h or --help: Prints the help for the command.

    -on|off: on option enables TLS mode of communication. off option disables TLS mode of communication.

    -dbport: Provide the port number that is configured for the database communication. (This option is required only when the database port is changed.)

    -tspwd: Provide the truststore password. The default password is: changeit. It is recommended to change this password.

    -flow: Provide the communication channel for which you want to enable or disable TLS 1.2 with server certificate validation based on your value for the -on|off parameter.

    internal: Enables or disables TLS 1.2 with server certificate validation for communication among the internal Capacity Optimization components.

    auth: Enables or disables TLS 1.2 with server certificate validation for communication between the authentication component (Remedy Single Sign-On Server or LDAP server) and Application Server.

    codb: Enables or disables TLS 1.2 with server certificate validation for communication between internal database (Oracle/PostgreSQL) and internal Capacity Optimization components.

    externaldb: Enables or disables TLS 1.2 with server certificate validation for communication between external database and ETL Engine Server.

    all: Enables or disables TLS 1.2 with server certificate validation communication for all the supported channels.

  2. When you are prompted, enter the password to access the truststore.The communication channels between the Application Server and the Gateway Server are now TLS 1.2 enabled with server certificate validation.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*