WARNING: Version 1.0.1 of Beats has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Command Line Options Developer Guide: Creating a New Beat »
Elastic Docs ›Beats Platform Reference [1.0.1]

HTTPS and Basic Authentication

edit

HTTPS and Basic Authentication

edit

To secure the communication between a Beat and Elasticsearch, you can use HTTPS and basic authentication. Here is a sample configuration:

elasticsearch:
  username: packetbeat 
  password: verysecret 
  protocol: https 
  hosts: ["elasticsearch.example.com:9200"] 
  save_topology: true

The username to use for authenticating to Elasticsearch.

The password to use for authenticating to Elasticsearch.

This setting enables the HTTPS protocol.

The IP and port of the Elasticsearch nodes.

Elasticsearch doesn’t have built-in basic authentication, but you can achieve it either by using a web proxy or by using the Shield commercial plugin.

The Beat verifies the validity of the server certificates and only accepts trusted certificates. Creating a correct SSL/TLS infrastructure is outside the scope of this document, but a good guide to follow is the Running a Certificate Authority appendix from the Shield guide.

By default the Beat uses the list of trusted certificate authorities from the operating system where the Beat is running. You can configure a Beat to use a specific list of CA certificates instead of the list from the OS. Here is an example:

elasticsearch:
  username: packetbeat
  password: verysecret
  protocol: https
  hosts: ["elasticsearch.example.com:9200"]
  save_topology: true
  certificate_authorities: 
    - /etc/pki/my_root_ca.pem
    - /etc/pki/my_other_ca.pem

The list of CA certificates to trust

For any given connection, the SSL/TLS certificates must have a subject that matches the value specified for hosts, or the TLS 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 systems).

pass::[<?page_header <b>PLEASE NOTE:</b><br/>Always refer to the documentation in master for the latest information about contributing to Beats.?>]

« Command Line Options Developer Guide: Creating a New Beat »