PKI user authentication

Add a realm configuration for a pki realm to elasticsearch.yml under the xpack.security.authc.realms.pki namespace. You must explicitly set the order attribute. See PKI realm settings for all of the options you can set for a pki realm.

For example, the following snippet shows the most basic pki realm configuration:

xpack:
  security:
    authc:
      realms:
        pki:
          pki1:
            order: 1

With this configuration, any certificate trusted by the Elasticsearch SSL/TLS layer is accepted for authentication. The username is the common name (CN) extracted from the DN in the Subject field of the end-entity certificate. This configuration is not sufficient to permit PKI authentication to Kibana; additional steps are required.

Optional: The username is defined by the username_pattern. If you want to use something other than the CN of the Subject DN as the username, you can specify a regex to extract the desired username. The regex is applied on the Subject DN.

For example, the regex in the following configuration extracts the email address from the Subject DN:

xpack:
  security:
    authc:
      realms:
        pki:
          pki1:
            order: 1
            username_pattern: "EMAILADDRESS=(.*?)(?:,|$)"

Enable client authentication on the desired network layers (transport or http).

When clients connect directly to Elasticsearch and are not proxy-authenticated, the PKI realm relies on the TLS settings of the node’s network interface. The realm can be configured to be more restrictive than the underlying network connection. That is, it is possible to configure the node such that some connections are accepted by the network interface but then fail to be authenticated by the PKI realm. However, the reverse is not possible. The PKI realm cannot authenticate a connection that has been refused by the network interface.

In particular this means:

For an explanation of these settings, see General TLS settings.

The relevant network interface (transport or http) must be configured to trust any certificate that is to be used within the PKI realm. However, it is possible to configure the PKI realm to trust only a subset of the certificates accepted by the network interface. This is useful when the SSL/TLS layer trusts clients with certificates that are signed by a different CA than the one that signs your users' certificates.

To configure the PKI realm with its own truststore, specify the truststore.path option. The path must be located within the Elasticsearch configuration directory (ES_PATH_CONF). For example:

xpack:
  security:
    authc:
      realms:
        pki:
          pki1:
            order: 1
            truststore:
              path: "pki1_truststore.jks"

If the truststore is password protected, the password should be configured by adding the appropriate secure_password setting to the Elasticsearch keystore. For example, the following command adds the password for the example realm above:

bin/elasticsearch-keystore add \
xpack.security.authc.realms.pki.pki1.truststore.secure_password

The certificate_authorities option can be used as an alternative to the truststore.path setting, when the certificate files are PEM formatted. The setting accepts a list. The two options are exclusive, they cannot be both used simultaneously.

Map roles for PKI users.

You map roles for PKI users through the role mapping APIs or by using a file stored on each node. Both configuration options are merged together. When a user authenticates against a PKI realm, the privileges for that user are the union of all privileges defined by the roles to which the user is mapped.

You identify a user by the distinguished name in their certificate. For example, the following mapping configuration maps John Doe to the user role using the role mapping API:

resp = client.security.put_role_mapping(
    name="users",
    roles=[
        "user"
    ],
    rules={
        "field": {
            "dn": "cn=John Doe,ou=example,o=com"
        }
    },
    enabled=True,
)
print(resp)

const response = await client.security.putRoleMapping({
  name: "users",
  roles: ["user"],
  rules: {
    field: {
      dn: "cn=John Doe,ou=example,o=com",
    },
  },
  enabled: true,
});
console.log(response);

PUT /_security/role_mapping/users
{
  "roles" : [ "user" ],
  "rules" : { "field" : {
    "dn" : "cn=John Doe,ou=example,o=com" 
  } },
  "enabled": true
}

Alternatively, use a role-mapping file. For example:

user: 
  - "cn=John Doe,ou=example,o=com" 

The file’s path defaults to ES_PATH_CONF/role_mapping.yml. You can specify a different path (which must be within ES_PATH_CONF) by using the files.role_mapping realm setting (e.g. xpack.security.authc.realms.pki.pki1.files.role_mapping).

The distinguished name for a PKI user follows X.500 naming conventions which place the most specific fields (like cn or uid) at the beginning of the name and the most general fields (like o or dc) at the end of the name. Some tools, such as openssl, may print out the subject name in a different format.

One way that you can determine the correct DN for a certificate is to use the authenticate API (use the relevant PKI certificate as the means of authentication) and inspect the metadata field in the result. The user’s distinguished name will be populated under the pki_dn key. You can also use the authenticate API to validate your role mapping.

For more information, see Mapping users and groups to roles.