Where is tls.ncconf located?

On Windows, tls.ncconf is located under C:\Program Files\NCache\config by default. On Linux, it is located under /opt/ncache/config.

How do I enable mutual TLS in tls.ncconf?

Set enable to true and use-mutual-tls to true. Connecting clients must then be configured with valid client certificates.

What values does protocol-version support?

protocol-version supports tls12 for TLS 1.2, tls13 for TLS 1.3, and auto to let the operating system negotiate the highest mutually supported TLS version.

How is a custom TLS certificate configured?

Set custom-certificate-path to the absolute path of a PEM file containing the private key, leaf certificate, and any intermediate certificates in that order. If the private key is password-protected, specify its password using the password element.

TLS Config (tls.ncconf)

NCache stores TLS configuration settings in the tls.ncconf file. The file specifies whether TLS and mutual TLS are enabled, the path and password of a custom certificate when one is used, and the TLS protocol version.

The tls.ncconf file is located at:

Windows: C:\Program Files\NCache\config\tls.ncconf
Linux: /opt/ncache/config/tls.ncconf

Note

If NCache is installed at a custom location, the config directory is available under the corresponding NCache installation directory.

TLS Config Syntax

The following example shows tls.ncconf with TLS enabled, mutual TLS disabled, an NCache-provided certificate, and TLS 1.2 configured:

<tls-info>
  <enable>true</enable>
  <use-mutual-tls>false</use-mutual-tls>
  <custom-certificate-path></custom-certificate-path>
  <protocol-version>tls12</protocol-version>
  <password></password>
</tls-info>

Understanding the TLS Config Tags

The tls.ncconf file contains the following elements:

enable: Specifies whether TLS is enabled. Set this value to true to enable TLS or false to disable it.
use-mutual-tls: Specifies whether connecting clients must present a valid client certificate for mutual TLS. Set this value to true to require client certificate authentication or false to use standard TLS.
custom-certificate-path: Specifies the absolute path of the custom PEM certificate used by NCache. The PEM file must contain the private key, leaf certificate, and any Intermediate certificates in that order. Leave this element empty when using an NCache-provided certificate.
protocol-version: Specifies the TLS protocol version. Supported values are:
- tls12 for TLS 1.2
- tls13 for TLS 1.3
- auto to allow the operating system to negotiate the highest mutually supported TLS version
password: Specifies the password for the private key in the custom PEM certificate, if the private key is password-protected. Leave this element empty if no password is required.

TLS Config (tls.ncconf)

Note

TLS Config Syntax

Understanding the TLS Config Tags

See Also

Contact Us