Custom Roles Provider Extensionedit

If you need to retrieve user roles from a system not supported out-of-the-box by X-Pack security, you can create a custom roles provider to retrieve and resolve roles. You implement a custom roles provider as an X-Pack extension.

Implementing a Custom Roles Provideredit

To create a custom roles provider:

  1. Implement the interface BiConsumer<Set<String>, ActionListener<Set<RoleDescriptor>>>. That is to say, the implementation consists of one method that takes a set of strings, which are the role names to resolve, and an ActionListener, on which the set of resolved role descriptors are passed on as the response.
  2. The custom roles provider implementation must take special care to not block on any I/O operations. It is the responsibility of the implementation to ensure asynchronous behavior and non-blocking calls, which is made easier by the fact that the ActionListener is provided on which to send the response when the roles have been resolved and the response is ready.

To package your custom roles provider as a plugin:

  1. Implement an extension class for your roles provider that extends org.elasticsearch.xpack.extensions.XPackExtension. There you need to override one or more of the following methods:

    public List<BiConsumer<Set<String>, ActionListener<Set<RoleDescriptor>>>>
    getRolesProviders(Settings settings, ResourceWatcherService resourceWatcherService) {

    The getRolesProviders method is used to provide a list of custom roles providers that will be used to resolve role names, if the role names could not be resolved by the reserved roles or native roles stores. The list should be returned in the order that the custom role providers should be invoked to resolve roles. For example, if getRolesProviders returns two instances of roles providers, and both of them are able to resolve role A, then the resolved role descriptor that will be used for role A will be the one resolved by the first roles provider in the list.

    public List<String> getSettingsFilter() {

    The getSettingsFilter method returns a list of setting names that should be filtered from the settings APIs as they may contain sensitive credentials.

  2. Create a build configuration file for the plugin; Gradle is our recommendation.
  3. Create a descriptor file for the extension.
  4. Bundle all in a single zip file.

Using a Custom Roles Provider to Resolve Rolesedit

To use a custom roles provider:

  1. Install the roles provider extension on each node in the cluster. You run bin/x-pack/extension with the install sub-command and specify the URL pointing to the zip file that contains the extension. For example:

    bin/x-pack/extension install file:///<path>/
  2. Add any configuration parameters for any of the custom roles provider implementations to elasticsearch.yml. The settings are not namespaced and you have access to any settings when constructing the custom roles providers, although it is recommended to have a namespacing convention for custom roles providers to keep your elasticsearch.yml configuration easy to understand.

    For example, if you have a custom roles provider that resolves roles from reading a blob in an S3 bucket on AWS, then you would specify settings in elasticsearch.yml such as:

    custom_roles_provider.s3_roles_provider.bucket: roles
    custom_roles_provider.s3_roles_provider.region: us-east-1
    custom_roles_provider.s3_roles_provider.secret_key: xxx
    custom_roles_provider.s3_roles_provider.access_key: xxx

    These settings will be available as the first parameter in the getRolesProviders method, from where you will create and return the custom roles provider instances.

  3. Restart Elasticsearch.