This is a cache of https://www.elastic.co/guide/en/elasticsearch/reference/current/configuring-stack-security.html. It is a snapshot of the page at 2024-11-22T01:00:03.124+0000.
Start the Elastic Stack with security enabled automatically | <strong>elasticsearch</strong> Guide [8.16] | Elastic
« elasticsearch security principles Manually configure security »
Elastic Docs ›elasticsearch Guide [8.16] ›Secure the Elastic Stack

Start the Elastic Stack with security enabled automatically

edit

Start the Elastic Stack with security enabled automatically

edit

When you start elasticsearch for the first time, the following security configuration occurs automatically:

  • Certificates and keys for TLS are generated for the transport and HTTP layers.
  • The TLS configuration settings are written to elasticsearch.yml.
  • A password is generated for the elastic user.
  • An enrollment token is generated for Kibana.

You can then start Kibana and enter the enrollment token, which is valid for 30 minutes. This token automatically applies the security settings from your elasticsearch cluster, authenticates to elasticsearch with the built-in kibana service account, and writes the security configuration to kibana.yml.

There are some cases where security can’t be configured automatically because the node startup process detects that the node is already part of a cluster, or that security is already configured or explicitly disabled.

Prerequisites

edit
  • Download and unpack the elasticsearch package distribution for your environment.
  • Download and unpack the kibana package distribution for your environment.

Start elasticsearch and enroll Kibana with security enabled

edit

  1. From the installation directory, start elasticsearch.

    bin/elasticsearch

    The command prints the elastic user password and an enrollment token for Kibana.

  2. Copy the generated elastic password and enrollment token. These credentials are only shown when you start elasticsearch for the first time.

    If you need to reset the password for the elastic user or other built-in users, run the elasticsearch-reset-password tool. To generate new enrollment tokens for Kibana or elasticsearch nodes, run the elasticsearch-create-enrollment-token tool. These tools are available in the elasticsearch bin directory.

    We recommend storing the elastic password as an environment variable in your shell. Example:

    export ELASTIC_PASSWORD="your_password"

  3. (Optional) Open a new terminal and verify that you can connect to your elasticsearch cluster by making an authenticated call.

    curl --cacert config/certs/http_ca.crt -u elastic:$ELASTIC_PASSWORD https://localhost:9200

  4. From the directory where you installed Kibana, start Kibana.

    bin/kibana

  5. Enroll Kibana using either interactive or detached mode.

    • Interactive mode (browser)

      1. In your terminal, click the generated link to open Kibana in your browser.

      2. In your browser, paste the enrollment token that you copied and click the button to connect your Kibana instance with elasticsearch.

        Kibana won’t enter interactive mode if it detects existing credentials for elasticsearch (elasticsearch.username and elasticsearch.password) or an existing URL for elasticsearch.hosts.

    • Detached mode (non-browser)

      Run the kibana-setup tool and pass the generated enrollment token with the --enrollment-token parameter.

      bin/kibana-setup --enrollment-token <enrollment-token>

Enroll additional nodes in your cluster

edit

When elasticsearch starts for the first time, the security auto-configuration process binds the HTTP layer to 0.0.0.0, but only binds the transport layer to localhost. This intended behavior ensures that you can start a single-node cluster with security enabled by default without any additional configuration.

Before enrolling a new node, additional actions such as binding to an address other than localhost or satisfying bootstrap checks are typically necessary in production clusters. During that time, an auto-generated enrollment token could expire, which is why enrollment tokens aren’t generated automatically.

Additionally, only nodes on the same host can join the cluster without additional configuration. If you want nodes from another host to join your cluster, you need to set transport.host to a supported value (such as uncommenting the suggested value of 0.0.0.0), or an IP address that’s bound to an interface where other hosts can reach it. Refer to transport settings for more information.

To enroll new nodes in your cluster, create an enrollment token with the elasticsearch-create-enrollment-token tool on any existing node in your cluster. You can then start a new node with the --enrollment-token parameter so that it joins an existing cluster.

  1. In a separate terminal from where elasticsearch is running, navigate to the directory where you installed elasticsearch and run the elasticsearch-create-enrollment-token tool to generate an enrollment token for your new nodes.

    bin/elasticsearch-create-enrollment-token -s node

    Copy the enrollment token, which you’ll use to enroll new nodes with your elasticsearch cluster.

  2. From the installation directory of your new node, start elasticsearch and pass the enrollment token with the --enrollment-token parameter.

    bin/elasticsearch --enrollment-token <enrollment-token>

    elasticsearch automatically generates certificates and keys in the following directory:

    config/certs
  3. Repeat the previous step for any new nodes that you want to enroll.

Connect clients to elasticsearch

edit

When you start elasticsearch for the first time, TLS is configured automatically for the HTTP layer. A CA certificate is generated and stored on disk at:

/etc/elasticsearch/certs/http_ca.crt

The hex-encoded SHA-256 fingerprint of this certificate is also output to the terminal. Any clients that connect to elasticsearch, such as the elasticsearch Clients, Beats, standalone Elastic Agents, and Logstash must validate that they trust the certificate that elasticsearch uses for HTTPS. Fleet Server and Fleet-managed Elastic Agents are automatically configured to trust the CA certificate. Other clients can establish trust by using either the fingerprint of the CA certificate or the CA certificate itself.

If the auto-configuration process already completed, you can still obtain the fingerprint of the security certificate. You can also copy the CA certificate to your machine and configure your client to use it.

Use the CA fingerprint

edit

Copy the fingerprint value that’s output to your terminal when elasticsearch starts, and configure your client to use this fingerprint to establish trust when it connects to elasticsearch.

If the auto-configuration process already completed, you can still obtain the fingerprint of the security certificate by running the following command. The path is to the auto-generated CA certificate for the HTTP layer.

openssl x509 -fingerprint -sha256 -in config/certs/http_ca.crt

The command returns the security certificate, including the fingerprint. The issuer should be elasticsearch security auto-configuration HTTP CA.

issuer= /CN=elasticsearch security auto-configuration HTTP CA
SHA256 Fingerprint=<fingerprint>

Use the CA certificate

edit

If your library doesn’t support a method of validating the fingerprint, the auto-generated CA certificate is created in the following directory on each elasticsearch node:

/etc/elasticsearch/certs/http_ca.crt

Copy the http_ca.crt file to your machine and configure your client to use this certificate to establish trust when it connects to elasticsearch.

What’s next?

edit

Congratulations! You’ve successfully started the Elastic Stack with security enabled. elasticsearch and Kibana are secured with TLS on the HTTP layer, and internode communication is encrypted. If you want to enable HTTPS for web traffic, you can encrypt traffic between your browser and Kibana.

Security certificates and keys

edit

When you install elasticsearch, the following certificates and keys are generated in the elasticsearch configuration directory, which are used to connect a Kibana instance to your secured elasticsearch cluster and to encrypt internode communication. The files are listed here for reference.

http_ca.crt
The CA certificate that is used to sign the certificates for the HTTP layer of this elasticsearch cluster.
http.p12
Keystore that contains the key and certificate for the HTTP layer for this node.
transport.p12
Keystore that contains the key and certificate for the transport layer for all the nodes in your cluster.

http.p12 and transport.p12 are password-protected PKCS#12 keystores. elasticsearch stores the passwords for these keystores as secure settings. To retrieve the passwords so that you can inspect or change the keystore contents, use the bin/elasticsearch-keystore tool.

Use the following command to retrieve the password for http.p12:

bin/elasticsearch-keystore show xpack.security.http.ssl.keystore.secure_password

Use the following command to retrieve the password for transport.p12:

bin/elasticsearch-keystore show xpack.security.transport.ssl.keystore.secure_password

Additionally, when you use the enrollment token to connect Kibana to a secured elasticsearch cluster, the HTTP layer CA certificate is retrieved from elasticsearch and stored in the Kibana /data directory. This file establishes trust between Kibana and the elasticsearch Certificate Authority (CA) for the HTTP layer.

Cases when security auto configuration is skipped

edit

When you start elasticsearch for the first time, the node startup process tries to automatically configure security for you. The process runs some checks to determine:

  • If this is the first time that the node is starting
  • Whether security is already configured
  • If the startup process can modify the node configuration

If any of those checks fail, there’s a good indication that you manually configured security, or don’t want security to be configured automatically. In these cases, the node starts normally using the existing configuration.

If you redirect elasticsearch output to a file, security autoconfiguration is skipped. Autoconfigured credentials can only be viewed on the terminal the first time you start elasticsearch. If you need to redirect output to a file, start elasticsearch without redirection the first time and use redirection on all subsequent starts.

Existing environment detected

edit

If certain directories already exist, there’s a strong indication that the node was started previously. Similarly, if certain files don’t exist, or we can’t read or write to specific files or directories, then we’re likely not running as the user who installed elasticsearch or an administrator imposed restrictions. If any of the following environment checks are true, security isn’t configured automatically.

The elasticsearch /data directory exists and isn’t empty
The existence of this directory is a strong indicator that the node was started previously, and might already be part of a cluster.
The elasticsearch.yml file doesn’t exist (or isn’t readable), or the elasticsearch.keystore isn’t readable
If either of these files aren’t readable, we can’t determine whether elasticsearch security features are already enabled. This state can also indicate that the node startup process isn’t running as a user with sufficient privileges to modify the node configuration.
The elasticsearch configuration directory isn’t writable
This state likely indicates that an administrator made this directory read-only, or that the user who is starting elasticsearch is not the user that installed elasticsearch.

Existing settings detected

edit

The following settings are incompatible with security auto configuration. If any of these settings exist, the node startup process skips configuring security automatically and the node starts normally.

« elasticsearch security principles Manually configure security »