Page History

On this page:

By default, Teamwork Cloud and Web Application Platform use a self-signed certificate generated during installation. However, for production environments, it is strongly recommended that you use a certificate signed by a trusted Certificate Authority (CA). Follow the steps outlined on this page to replace the self-signed certificate with a CA certificate and Java keystore, provided that you either have a private key and certificate signed by a trusted CA, or a PFX file containing the private key and signed certificate.

Changing the self-signed certificate to a CA certificate

The new certificate will have to be converted to a Java keystore for Teamwork Cloud components. Use the following procedure to update the keystore file with your new certificate and private key files.

To change the self-signed certificate using the keystore file

1. Locate the default keystore file at <install_root>/configuration/keystore.p12.

2. Update the keystore file with the new private/public key:

   1. Create a PKCS 12 file with the OpenSSL tool:

      Code Block
      language bash theme DJango linenumbers true
      openssl pkcs12 -export -name teamworkcloud -in teamworkcloud.crt -inkey server.key -out keystore.p12

      Note
      In the example above, teamworkcloud is a sample alias. If you use a different alias, remember to update it in the <Teamwork_Cloud_installation_directory>\WebAppPlatform\shared\conf\authserver.properties file.

   2. Copy the keystore.p12 file to the <install_root>/configuration directory, replacing the default file with the new one.

3. Add the public certificate file to the <install_root>/configuration directory.

   Note
   The public certificate file, or .crt, is the public key from the private/public (.key/.crt) key pair.

4. (Recommended) Secure .key and .p12 files with a password. Make sure to keep the .key file in a safe place.

If the default configuration (file names, locations, passwords, aliases, etc.) is not changed, no additional steps are necessary. However, if you are changing the default configuration, then you also need to update the relevant properties in the corresponding files, as described below.

Updating Teamwork Cloud configuration

Update the default values for the properties indicated below in the <install_root>/configuration/application.conf file if any of the applicable values were changed.

https {
        # the file name of the certificate or the key store (should be a full path)
        file = "configuration/teamworkcloud.crt"
}

ssl {
		keystorePath = "configuration/keystore.p12"
		keystoreType = "pkcs12"
		keystorePassword = "nomagic"
		keyPassword = "nomagic"
}

cassandra {
		enabled = false
		keystorePath = "configuration/keystore.p12"
		keystoreType = "pkcs12"
		keystorePassword = "nomagic"
		truststorePath = "configuration/keystore.p12"
		truststoreType = "pkcs12"
		truststorePassword = "nomagic"
}

Updating AuthServer configuration

Update the default values for the properties indicated below in the <install_root>/WebAppPlatform/shared/conf/authserver.properties file if any of the applicable values were changed.

authentication.server.key-store=../configuration/keystore.p12
authentication.server.key-store-type=PKCS12
authentication.server.key-store-password=nomagic
authentication.server.key-password=nomagic
authentication.server.key-alias=teamworkcloud

Updating Web Application platform configuration

Update the default values for the properties indicated below in the <install_root>/WebAppPlatform/conf/server.xml file if any of the applicable values were changed.

<Certificate    certificateKeystoreFile="../configuration/keystore.p12" 
				certificateKeystorePassword="nomagic" 
				type="RSA" 
/>

Both services (Teamwork Cloud and WebApp) must be restarted once all of the configuration changes are completed.

Useful OpenSSL Commands

To check a private key:

openssl rsa -in <private_key_file> -check

To check a signed certificate:

openssl x509 -in <certificate.crt> -text -noout

To check a PKCS#12 file (.pfx or .p12):

openssl pkcs12 -info -in keyStorekeystore.p12

Related pages

• Managing HTTPS and SSL on server
• Enabling secure connection between client and server