Set up minimal security for Elasticsearch
editSet up minimal security for Elasticsearch
editYou enable the Elasticsearch security features and then create passwords for built-in users. You can add more users later, but using the built-in users simplifies the process of enabling security for your cluster.
The minimal security scenario is not sufficient for production mode clusters. If your cluster has multiple nodes, you must enable minimal security and then configure Transport Layer Security (TLS) between nodes.
Prerequisites
edit- Install and configure Elasticsearch and Kibana. See Getting started with the Elastic Stack.
-
Verify that you are using a license that includes the specific security features you want.
The basic license includes minimal security settings for the Elastic Stack, so you can just download the distribution and get to work. You can also enable a free trial license to access all features of the Elastic Stack. See subscriptions and license management.
Enable Elasticsearch security features
editWhen you use the basic license, the Elasticsearch security features are disabled by default. Enabling the Elasticsearch security features enables basic authentication so that you can run a local cluster with username and password authentication.
- On every node in your cluster, stop both Kibana and Elasticsearch if they are running.
-
On every node in your cluster, add the
xpack.security.enabled
setting to the$ES_PATH_CONF/elasticsearch.yml
file and set the value totrue
:xpack.security.enabled: true
The
$ES_PATH_CONF
variable is the path for the Elasticsearch configuration files. If you installed Elasticsearch using archive distributions (zip
ortar.gz
), the variable defaults to$ES_HOME/config
. If you used package distributions (Debian or RPM), the variable defaults to/etc/elasticsearch
. -
If your cluster has a single node, add the
discovery.type
setting in the$ES_PATH_CONF/elasticsearch.yml
file and set the value tosingle-node
. This setting ensures that your node does not inadvertently connect to other clusters that might be running on your network.discovery.type: single-node
Create passwords for built-in users
editTo communicate with the cluster, you must configure a username for the built-in users. Unless you enable anonymous access, all requests that don’t include a user name and password are rejected.
You only need to set passwords for the elastic
and kibana_system
users
when enabling minimal or basic security.
-
On every node in your cluster, start Elasticsearch. For example, if you installed Elasticsearch with a
.tar.gz
package, run the following command from theES_HOME
directory:./bin/elasticsearch
-
In another terminal window, set the passwords for the built-in users by running the
elasticsearch-setup-passwords
utility.You can run the
elasticsearch-setup-passwords
utility against any node in your cluster. However, you should only run this utility one time for the entire cluster.Using the
auto
parameter outputs randomly-generated passwords to the console that you can change later if necessary:./bin/elasticsearch-setup-passwords auto
If you want to use your own passwords, run the command with the
interactive
parameter instead of theauto
parameter. Using this mode steps you through password configuration for all of the built-in users../bin/elasticsearch-setup-passwords interactive
- Save the generated passwords. You’ll need them to add the built-in user to Kibana.
After you set a password for the elastic
user, you cannot run the
elasticsearch-setup-passwords
command a second time.
Next: Configure Kibana to connect to Elasticsearch with a password
Configure Kibana to connect to Elasticsearch with a password
editWhen the Elasticsearch security features are enabled, users must log in to Kibana with a valid username and password.
You’ll configure Kibana to use the built-in kibana_system
user and the password that
you created earlier. Kibana performs some background tasks that require use of the
kibana_system
user.
This account is not meant for individual users and does not have permission to log in
to Kibana from a browser. Instead, you’ll log in to Kibana as the elastic
superuser.
-
Add the
elasticsearch.username
setting to theKIB_PATH_CONF/kibana.yml
file and set the value to thekibana_system
user:elasticsearch.username: "kibana_system"
The
KIB_PATH_CONF
variable is the path for the Kibana configuration files. If you installed Kibana using archive distributions (zip
ortar.gz
), the variable defaults toKIB_HOME/config
. If you used package distributions (Debian or RPM), the variable defaults to/etc/kibana
. -
From the directory where you installed Kibana, run the following commands to create the Kibana keystore and add the secure settings:
-
Create the Kibana keystore:
./bin/kibana-keystore create
-
Add the password for the
kibana_system
user to the Kibana keystore:./bin/kibana-keystore add elasticsearch.password
When prompted, enter the password for the
kibana_system
user.
-
-
Restart Kibana. For example, if you installed Kibana with a
.tar.gz
package, run the following command from the Kibana directory:./bin/kibana
-
Log in to Kibana as the
elastic
user. Use this superuser account to manage spaces, create new users, and assign roles. If you’re running Kibana locally, go tohttp://localhost:5601
to view the login page.
What’s next?
editCongratulations! You enabled password protection for your local cluster to
prevent unauthorized access. You can log in to Kibana securely as the elastic
user and create additional users and roles. If you’re running a single-node cluster, then you can stop here.
If your cluster has multiple nodes, then you must configure Transport Layer Security (TLS) between nodes. Production mode clusters will not start if you do not enable TLS.
Set up basic security for the Elastic Stack to secure all internal communication between nodes in your cluster.