View Component 25.2
View Component Help

# Set up an SSL Connection

There are several ways to set up Secure Socket Layer (SSL) connections for Knowledge Discovery components. For example, you can:

- Configure an SSL gateway. You configure incoming communications to a unified configuration Proxy component to use SSL connections, but communications between components are plain.

- Configure SSL between all components in a unified configuration. All communications into Knowledge Discovery, and between components, are configured with SSL connections.

- Configure SSL between stand-alone components.

In all cases the basic principle of configuring SSL is the same, but the exact configuration varies.

To configure SSL connections

1. Set the SSLConfig parameter to the name of the section in which you define SSL options. The configuration sections where you set SSLConfig vary depending on your setup. In general:

   - For incoming ACI calls, set SSLConfig in the `[Server]` section.

   - For incoming Index actions, set SSLConfig in the `[IndexServer]` section.

   - For incoming Service actions, set SSLConfig in the `[Service]` section.

   - For outgoing ACI calls to Knowledge Discovery components, set SSLConfig in each component section. For example, `[AgentDRE]`.

   For example:

       [Server]
       SSLConfig=SSLOption1

2. For each `SSLOption` you define, create a new configuration section to contain the SSL options.

   For example:

       [SSLOption1]

3. Within each SSL options section, you can specify the following SSL parameters:

   SSLMethod | Determines which SSL protocol to use: TLSV1.3, TLSV1.2, TLSV1, SSLV3, or Negotiate, which uses the highest protocol supported by both client and server. OpenText recommends that you use `TLSV1.3`, unless interoperability with older systems requires use of less secure protocols.
   SSLCertificate | The SSL Certificate file to use to identify this component to a peer. The certificate can be in either ASN1 or PEM format. OpenText recommends that you use the PEM format. This parameter requires a matching SSLPrivateKey value.
   SSLPrivateKey | The private security key for the SSL certificate. The security key can be in either ASN1 or PEM format. This parameter requires a matching SSLCertificate value. The private key can be password protected. See SSLPrivateKeyPassword.
   SSLCACertificate | The Certificate Authority certificate indicating that this component trusts only communication with a peer that offers a certificate signed by the specified CAs.
   SSLCheckCertificate | Requests a certificate signed by a trusted authority from peers. Setting SSLCACertificate implicitly sets this parameter to `True`. If you set SSLCACertificate to `False`, the component encrypts communications, but does not request certificates from peers.
   SSLCheckCommonName | Determines whether the host name listed in the peer certificate (that is, the CommonName or “CN” attribute) resolves to the same IP address as the peer itself, as determined by the network connection. This parameter helps verify the identity of the peer. For example, if the host name in a certificate is `eip.example.com` and resolves to an IP address of `12.3.4.56`, the peer must share the same IP address.
   SSLPrivateKeyPassword | If the file defined in SSLPrivateKey is password protected, use this parameter to specify the password. The password can be in plain text or in basic or AES encryption format.

Related Topics

- Password Encryption

Copyright 2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery View Component 25.2

Topic Title: Set up an SSL Connection