Configure TLS certificates for inter-Splunk communication
You can use transport layer security (TLS) certificates to secure connections between various Splunk components. This is known as inter-Splunk communication. Typically, Splunk processes communicate on the TCP/IP network port 8089.
The certificates you use can replace the default certificates that Splunk provides. You can either obtain certificates from a certificate authority, or create and sign them yourself.
Prerequisites for configuring TLS certificates for inter-Splunk communication
Before you can secure communications between Splunk indexers and forwarders, you must have the following:
- One or more TLS certificates.
- You can either obtain third party certificates from a certificate authority, or create and sign them yourself
- After you get the certificates, you must prepare the certificates for use with Splunk platform instances
- The certificates must be in Privacy-Enhanced Mail format and comply with the x.509 public key certificate standard
- You must have a private key file for each certificate file.
- The key files that come with the certificates must be in RSA security format.
- Administrative access to the Splunk Enterprise instances that you want to secure
- An understanding of Splunk configuration files
Configure TLS certificates for communications on the Splunk management port
You can configure TLS certificates on Splunk services that use the management network port.
- Open a shell or command prompt.
- Using this prompt or file system management tools, copy the server certificate and the certificate authority public certificate into an accessible directory on the instance where you want to configure certificates. For example, you can move the files to a destination directory of
- Use a text editor to open the
$SPLUNK_HOME/etc/system/local/server.confconfiguration file for editing.
- In the server.conf file, configure the instance to use the server certificate. Add the following stanzas and settings to the file.
Setting/stanza name Data type Description [sslConfig] n/a Sets up TLS/SSL configurations for inter-Splunk communication. serverCert string The location of the server certificate on the Splunk platform instance. This is the certificate that the machine uses to support inbound connections over TLS/SSL. You can specify either the absolute path to the certificate, such as
/opt/splunk/etc/auth/mycerts/myServerCert.pem, or you can use a relative path, such as
etc/auth/mycerts/myServerCert.pemand the instance uses the Splunk platform instance installation directory.
sslPassword (Optional) string The password that you entered when you created the certificate, if you created a password. requireClientCert (Optional) Boolean Whether or not the Splunk platform instance requires that a connecting client present a valid TLS certificate before the connection can succeed. A value of "true" means that the receiving instance must see a valid certificate to let the client authenticate. A value of "false" means that clients can connect without presenting a certificate. Configure this setting to "true" if you want your receivers to require authentication with certificates. When both the forwarder and receiver have a "true" value for this setting, mutually authenticated TLS or mTLS is active. sslVersions (Optional) comma-separated list The list of SSL versions that the receiver supports. The Splunk platform supports the following versions for SSL and TLS: "ssl3", "tls1.0", "tls1.1", and "tls1.2". cipherSuite (Optional) string The list of cipher suite strings that the TLS/SSL sessions are to use. sslCommonNameToCheck
(Optional except in certain circumstances)
comma-separated list A list of one or more common names upon which the receiving Splunk platform instance checks for a match in the certificate that the client presents upon connecting to the receiver. This setting is only valid if you have configured the 'requireClientCert' setting with a value of "true". If none of the common names in this setting value matches the common name in the certificate of the connecting client, the receiving instance declines the connection as not authorized. sslAltNameToCheck
(Optional except in certain circumstances)
comma-separated list A list of one or more alternate names upon which the receiving Splunk platform instance checks for a match in the certificate that the client presents upon connecting to the receiver. This setting is only valid if you have configured the 'requireClientCert' setting with a value of "true". If none of the alternate names in this setting value matches the alternate name in the certificate of the connecting client, the receiving instance declines the connection as not authorized. sslRootCAPath string The location of the certificate authority certificate.
- Save the server.conf file and close it.
- Using the CLI, restart the splunkd process:
# $SPLUNK_HOME/bin/splunk restart splunkd
Configuration file examples for configuring TLS certificates on the Splunk management port
Following is an example of an inputs.conf configuration file on a receiving indexer. The configuration is as follows:
- The instance uses a certificate that is located in the
- The server certificate was created with a password "myCertificatePassword"
- The instance requires a certificate from clients that connect to ensure mutually authenticated TLS (mTLS).
- The instance checks incoming certificates to ensure that the Common Name field in the certificate contains either "splunk1.mycompany.com" or "splunk2.mycompany.com"
[splunktcp-ssl:9997] disabled=0 [sslConfig] serverCert = /opt/splunk/etc/auth/mycerts/myServerCert.pem sslPassword = myCertificatePassword requireClientCert = true sslVersions *,-ssl2 sslCommonNameToCheck = indexer1.mycompany.com,indexer2.mycompany.com
If you supply a password for your server certificate in the server.conf file by providing a value for the
sslPassword setting, the Splunk platform encrypts that password from clear text when you restart the Splunk platform instance.
The server.conf configuration file establishes and references the location of the certificate authority certificate:
[sslConfig] sslRootCAPath = /opt/splunk/etc/auth/mycerts/myCACertificate.pem
Confirm that the forwarder and indexer configurations work properly. See Test and troubleshoot TLS connections.
Configure Splunk indexing and forwarding to use TLS certificates
Configure Splunk Web to use TLS certificates
This documentation applies to the following versions of Splunk Cloud Platform™: 8.2.2203, 9.0.2205, 9.0.2208