Secure communication with Elasticsearch

Secure communication with Elasticsearchedit

When sending data to a secured cluster through the elasticsearch output, Filebeat can use any of the following authentication methods:

  • Basic authentication credentials (username and password).
  • Token-based API authentication.
  • A client certificate.

Authentication is specified in the Filebeat configuration file:

  • To use basic authentication, specify the username and password settings under output.elasticsearch. For example:

    output.elasticsearch:
      hosts: ["https://myEShost:9200"]
      username: "filebeat_writer" 
      password: "YOUR_PASSWORD" 

    This user needs the privileges required to publish events to Elasticsearch. To create a user like this, see Create a publishing user.

    This example shows a hard-coded password, but you should store sensitive values in the secrets keystore.

  • To use token-based API key authentication, specify the api_key under output.elasticsearch. For example:

    output.elasticsearch:
      hosts: ["https://myEShost:9200"]
      api_key: "ZCV7VnwBgnX0T19fN8Qe:KnR6yE41RrSowb0kQ0HWoA" 

    This API key must have the privileges required to publish events to Elasticsearch. To create an API key like this, see Grant access using API keys.

  • To use Public Key Infrastructure (PKI) certificates to authenticate users, specify the certificate and key settings under output.elasticsearch. For example:

    output.elasticsearch:
      hosts: ["https://myEShost:9200"]
      ssl.certificate: "/etc/pki/client/cert.pem" 
      ssl.key: "/etc/pki/client/cert.key" 

    The path to the certificate for SSL client authentication

    The client certificate key

    These settings assume that the distinguished name (DN) in the certificate is mapped to the appropriate roles in the role_mapping.yml file on each node in the Elasticsearch cluster. For more information, see Using role mapping files.

    By default, Filebeat uses the list of trusted certificate authorities (CA) from the operating system where Filebeat is running. If the certificate authority that signed your node certificates is not in the host system’s trusted certificate authorities list, you need to add the path to the .pem file that contains your CA’s certificate to the Filebeat configuration. This will configure Filebeat to use a specific list of CA certificates instead of the default list from the OS.

    Here is an example configuration:

    output.elasticsearch:
      hosts: ["https://myEShost:9200"]
      ssl.certificate_authorities: 
        - /etc/pki/my_root_ca.pem
        - /etc/pki/my_other_ca.pem
      ssl.certificate: "/etc/pki/client.pem" 
      ssl.key: "/etc/pki/key.pem" 

    Specify the path to the local .pem file that contains your Certificate Authority’s certificate. This is needed if you use your own CA to sign your node certificates.

    The path to the certificate for SSL client authentication

    The client certificate key

    For any given connection, the SSL/TLS certificates must have a subject that matches the value specified for hosts, or the SSL handshake fails. For example, if you specify hosts: ["foobar:9200"], the certificate MUST include foobar in the subject (CN=foobar) or as a subject alternative name (SAN). Make sure the hostname resolves to the correct IP address. If no DNS is available, then you can associate the IP address with your hostname in /etc/hosts (on Unix) or C:\Windows\System32\drivers\etc\hosts (on Windows).

Secure communication with the Kibana endpointedit

If you’ve configured the Kibana endpoint, you can also specify credentials for authenticating with Kibana under kibana.setup. If no credentials are specified, Kibana will use the configured authentication method in the Elasticsearch output.

For example, specify a unique username and password to connect to Kibana like this:

setup.kibana:
  host: "mykibanahost:5601"
  username: "filebeat_kib_setup" 
  password: "YOUR_PASSWORD" 

This user needs privileges required to set up dashboards. To create a user like this, see Create a setup user.

This example shows a hard-coded password, but you should store sensitive values in the secrets keystore.

Learn more about secure communicationedit

More information on sending data to a secured cluster is available in the configuration reference: