Home
HCL Sametime® Administration Guide 12.0.1
Securing
This section provides information on securing your HCL Sametime environments.
Securing connections
The various connections to Sametime can be secured using TLS.
Securing connections between the Sametime mux and the Connect and Embedded clients
There are several connection methods to connect to the Sametime server. This topic includes the steps to encrypt connections between the clients and the Sametime mux using TLS.
Configuring the encryption settings on Docker and Podman

HCL Sametime® Administration Guide 12.0.1
- Accessibility features for Sametime
  Accessibility features help users who have a disability, such as restricted mobility or limited vision, use information technology products successfully. HCL® strives to provide products with usable access for everyone.
- What's new
  HCL Sametime and HCL Sametime Premium 12.0.1 provide many new features, enhancements and fixes to servers and clients. Additional releases to version 12.0.1 also provides updates to the product.
- Planning
  This section describes the system requirements and server configurations needed for HCL Sametime and HCL Sametime Premium.
- Installing
  This section provides information on installing the servers for Sametime and Sametime Premium.
- Configuring
  This section provides information on configuring the HCL Sametime server. Configuration tasks are dependent on the deployment environment.
- Securing
  This section provides information on securing your HCL Sametime environments.
  - Encryption usage in Sametime
    HCL Sametime uses several types of encryption to protect data.
  - Securing connections
    The various connections to Sametime can be secured using TLS.
    - Obtaining the cert.key and cert.crt files for Sametime
    - Creating a truststore with a third-party certificate
      When creating a connection between the Sametime server and a service using TLS, a truststore is needed. The truststore is used to store certificates for Sametime.
    - Implementing the Global TLS Scope for Docker
    - Securing connections between the Sametime mux and the Connect and Embedded clients
      There are several connection methods to connect to the Sametime server. This topic includes the steps to encrypt connections between the clients and the Sametime mux using TLS.
      - Creating a keystore for Sametime mux
        A keystore consists of a private key and a certificate. Sametime supports both a third-party certificate, signed by a Certification Authority (CA), or a self-signed certificate. Request a certificate and private key from your CA for the hostname used by the Sametime mux. This is the microservice that listens on port 1533 for requests from the Sametime Connect clients (installed clients on desktop). In Kubernetes, the mux is either a Kubernetes service (for example, a load balancer type service) or a Kubernetes ingress service for on-premise Kubernetes. For Docker deployments, the mux listens on port 1533 and does not require any additional service.
      - Configuring TLS for Sametime mux on Kubernetes
      - Configuring the encryption settings on Docker and Podman
    - Securing connections between Sametime servers and LDAP
      When Sametime is configured to connect to an LDAP server, the Sametime servers makes five separate connections to the LDAP server.
  - Enabling Single Sign-on
    The HCL Sametime server installer enables required JSON Web Token (JWT) authentication. Additionally, the Sametime server supports Security Assertion Markup Language (SAML) and Lightweight Third Party Authentication (LTPA) Single Sign-on (SSO).
  - Setting up TLS for the Mongo database
    You can update the MongoDB connection with the Sametime server to encrypt data flowing between the Sametime server and a TLS-enabled MongoDB. This step is optional but is recommended for multi-Kubernetes-cluster deployments.
  - Replacing the TLS certificates for Web Chat and Meetings
    The Sametime server is pre-configured with a self-signed certificate. You can replace the self-signed certificate with a third party certificate.
  - Applying Let's Encrypt certificates
    This topic describes how to replace the self-signed certificate with a third-party certificate.
- Administering
  This section provides information on administering on Sametime environments.
- Troubleshooting
  This section provides information on troubleshooting and supporting Sametime environments.
- Uninstalling Sametime
  In the event that Sametime must be removed, follow the procedure for the platform that Sametime is installed on.
- Migrating and Upgrading
  This section provides information on migrating data from an earlier release to Sametime 12.
- Notices

Configuring the encryption settings on Docker and Podman

About this task

The Docker and Podman commands are similar. The only difference is that docker precedes the command when issued in a Docker environment and podman precedes the name in a Podman environment. Example commands used in the Sametime documentation are shown using Docker. For Podman, change docker to podman.

Procedure

Create a mux.env with the following setting and values appropriate for your configuration.


STI__Debug__VPMX_DISABLE_CONFIGURATION_UPDATE=1
STI__Debug__VPMX_PORT=1533
STI__Debug__VPMX_TLS_PORT=1533
STI__Config__VPMX_CAPACITY=20000
STI__Config__ST_TLS_KEY_STORE_TYPE=p12
STI__Config__ST_TLS_KEY_STORE_FILE=/local/sametimemuxdata/keystore.p12
STI__Config__ST_TLS_KEY_STORE_PASSWORD=keystorepass

Add mux.env to the environment file variable in to the mux section of docker-compose.yml file.
```
env file:
 -mux.env
```

Map the keyfile into the container


volumes:
  - ./keystore.p12:/local/sametimemuxdata/keystore.p12

Start the Sametime server to apply the changes.
```
docker compose up -d
```

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.