Configuring Security in Kibana

edit

Configuring Security in Kibana

edit

Kibana users have to log in when X-Pack security is enabled on your cluster. You configure X-Pack security roles for your Kibana users to control what data those users can access.

Most requests made through Kibana to Elasticsearch are authenticated by using the credentials of the logged-in user. There are, however, a few internal requests that the Kibana server needs to make to the Elasticsearch cluster. For this reason, you must configure credentials for the Kibana server to use for those requests.

With X-Pack security enabled, if you load a Kibana dashboard that accesses data in an index that you are not authorized to view, you get an error that indicates the index does not exist. X-Pack security does not currently provide a way to control which users can load which dashboards.

To use Kibana with X-Pack security:

  1. Configure security in Elasticsearch.
  2. Configure Kibana to use the appropriate built-in user.

    Update the following settings in the kibana.yml configuration file:

    elasticsearch.username: "kibana"
    elasticsearch.password: "kibanapassword"

    The Kibana server submits requests as this user to access the cluster monitoring APIs and the .kibana index. The server does not need access to user indices.

    The password for the built-in kibana user is typically set as part of the X-Pack security configuration process on Elasticsearch. For more information, see Built-in users.

  3. Set the xpack.security.encryptionKey property in the kibana.yml configuration file. You can use any text string that is 32 characters or longer as the encryption key.

    xpack.security.encryptionKey: "something_at_least_32_characters"

    For more information, see Security Settings in Kibana.

  4. Optional: Change the default session duration. By default, sessions stay active until the browser is closed. To change the duration, set the xpack.security.sessionTimeout property in the kibana.yml configuration file. The timeout is specified in milliseconds. For example, set the timeout to 600000 to expire sessions after 10 minutes:

    xpack.security.sessionTimeout: 600000
  5. Optional: Configure Kibana to encrypt communications.
  6. Restart Kibana.
  7. Choose an authentication mechanism and grant users the privileges they need to use Kibana.

    For more information on Basic Authentication and additional methods of authenticating Kibana users, see Authentication.

    You can manage privileges on the Management / Security / Roles page in Kibana.

    If you’re using the native realm with Basic Authentication, you can assign roles using the Management / Security / Users page in Kibana or the user management APIs. For example, the following creates a user named jacknich and assigns it the kibana_user role:

    POST /_xpack/security/user/jacknich
    {
      "password" : "t0pS3cr3t",
      "roles" : [ "kibana_user" ]
    }
  8. Grant users access to the indices that they will be working with in Kibana.

    You can define as many different roles for your Kibana users as you need.

    For example, create roles that have read and view_index_metadata privileges on specific index patterns. For more information, see User authorization.

  9. Verify that you can log in as a user. If you are running Kibana locally, go to https://localhost:5601 and enter the credentials for a user you’ve assigned a Kibana user role. For example, you could log in as the jacknich user created above.

    This must be a user who has been assigned the kibana_user role. Kibana server credentials should only be used internally by the Kibana server.

For more information about the settings in these steps, see Security Settings.