Enable TLS for MATRIXX Backoffice Customer Tool

Enable Transport Layer Security (TLS) connections for MATRIXX Backoffice Customer Tool with configuration changes and an alias for localhost.

About this task

These steps assume a non self-signed certificate that accepts a host name alias with a host name that resolves to the IP address of the server running MATRIXX Backoffice Customer Tool. For more information about MATRIXX Backoffice Customer Tool security, see the discussion about application security.
Important: Only use certificates obtained from a reputable and trusted certificate authority.

Procedure

  1. Configure the /opt/mtx/conf/webapps/matrixxbct/classes/config/application-default.yaml file.
    For example (customize for your implementation):
    server: 
        port: 6061 
        ssl: 
            enabled: true 
            key-store-type: PKCS12
            key-store: file:///keystore/keystore.p12 
            key-store-password: keystore-password
            key-alias: '*alias.com'
    
    Where:
    • port — The port number to access MATRIXX Backoffice Customer Tool. The default port for RS Gateway is 8080. Setting the port value is optional.
    • enabled — Set to true to enable TLS.
    • key-store-type — The format used for the keystore. Set to JKS for a JKS file.
    • key-store — The path to the keystore containing the certificate.
    • key-store-password — The password used to generate the certificate.
    • key-alias — The key alias.
    Note: If applications.yaml does not exist, create it with the following commands:
    sudo mkdir -p /opt/mtx/conf/webapps/matrixxbct/classes/config 
    sudo chown -R mtx:mtx /opt/mtx/conf/webapps/matrixxbct/classes/config 
    vi application-default.yaml 
  2. If TLS is also enabled for RS Gateway, then the other web apps that communicate with RS Gateway must set the correct URL. For MATRIXX Backoffice Customer Tool, add the following in /opt/mtx/conf/matrixxbct.yaml:
    rsgateway: 
            url: url_for_rs_gateway
    For example:
    rsgateway: 
            url: https://rsgateway.alias.com:6060/rsgateway/data
    

Results

Verify if TLS has been successfully enabled. For example:

wget -d https://admin:[email protected]:6061/matrixxbct/home