This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Applying changes to configuration files
On Windows, use securityadmin.bat in place of securityadmin.sh. For more information, see Windows usage.
The Security plugin stores its configuration—including users, roles, permissions, and backend settings—in a system index on the OpenSearch cluster. Storing these settings in an index lets you change settings without restarting the cluster and eliminates the need to edit configuration files on every individual node. This is accomplished by running the
The first job of the script is to initialize the
.opendistro_security index. This loads your initial configuration into the index using the configuration files in
/config/opensearch-security. After the
.opendistro_security index is initialized, you can use OpenSearch Dashboards or the REST API to manage your users, roles, and permissions.
The script can be found at
/plugins/opensearch-security/tools/securityadmin.sh. This is a relative path showing where the
securityadmin.sh script is located. The absolute path depends on the directory where you’ve installed OpenSearch. For example, if you use Docker to install OpenSearch, the path will resemble the following:
A word of caution
If you make changes to the configuration files in
config/opensearch-security, OpenSearch does not automatically apply these changes. Instead, you must run
securityadmin.sh to load the updated files into the index.
securityadmin.sh overwrites one or more portions of the
.opendistro_security index. Run it with extreme care to avoid losing your existing resources. Consider the following example:
- You initialize the
- You create ten users using the REST API.
- You decide to create a new reserved user using
- You run
securityadmin.shagain to load the new reserved user into the index.
- You lose all ten users that you created using the REST API.
To avoid this situation, back up your current configuration before making changes and re-running the script:
./securityadmin.sh -backup my-backup-directory \ -icl \ -nhnv \ -cacert ../../../config/root-ca.pem \ -cert ../../../config/kirk.pem \ -key ../../../config/kirk-key.pem
If you use the
-f argument rather than
-cd, you can load a single YAML file into the index rather than the entire directory of YAML files. For example, if you create ten new roles, you can safely load
internal_users.yml into the index without losing your roles; only the internal users get overwritten.
./securityadmin.sh -f ../../../config/opensearch-security/internal_users.yml \ -t internalusers \ -icl \ -nhnv \ -cacert ../../../config/root-ca.pem \ -cert ../../../config/kirk.pem \ -key ../../../config/kirk-key.pem
To resolve all environment variables before applying the security configurations, use the
./securityadmin.sh -cd ../../../config/opensearch-security/ \ -rev \ -cacert ../../../root-ca.pem \ -cert ../../../kirk.pem \ -key ../../../kirk.key.pem
The following example shows an environment variable in the
Configure the admin certificate
In order to use
securityadmin.sh, you must add the distinguished names (DNs) of all admin certificates to
opensearch.yml. If you use the demo certificates, for example,
opensearch.yml might contain the following lines for the
plugins.security.authcz.admin_dn: - CN=kirk,OU=client,O=client,L=test,C=DE
You can’t use node certificates as admin certificates. The two must be separate. Also, do not add whitespace between the parts of the DN.
securityadmin.sh tool can be run from any machine that has access to the HTTP port of your OpenSearch cluster (the default port is 9200). You can change the Security plugin configuration without having to access your nodes through SSH.
securityadmin.sh requires that SSL/TLS transport is enabled on your opensearch cluster. In other words, make sure that the
plugins.security.ssl.http.enabled: true is set in
opensearch.yml before proceeding.
Each node also includes the tool at
plugins/opensearch-security/tools/securityadmin.sh. You might need to make the script executable before running it:
chmod +x plugins/opensearch-security/tools/securityadmin.sh
To print all available command line options, run the script with no arguments:
To load your initial configuration (all YAML files), you might use the following command:
./securityadmin.sh -cd ../../../config/opensearch-security/ -icl -nhnv \ -cacert ../../../config/root-ca.pem \ -cert ../../../config/kirk.pem \ -key ../../../config/kirk-key.pem
-cdoption specifies where the Security plugin configuration files can be found.
--ignore-clustername) option tells the Security plugin to upload the configuration regardless of the cluster name. As an alternative, you can also specify the cluster name with the
- Because the demo certificates are self-signed, this command disables hostname verification with the
-keyoptions define the location of your root CA certificate, the admin certificate, and the private key for the admin certificate. If the private key has a password, specify it with the
The following table shows the PEM options.
| ||The location of the PEM file containing the admin certificate and all intermediate certificates, if any. You can use an absolute or relative path. Relative paths are resolved relative to the execution directory of |
| ||The location of the PEM file containing the private key of the admin certificate. You can use an absolute or relative path. Relative paths are resolved relative to the execution directory of |
| ||The password of the private key of the admin certificate, if any.|
| ||The location of the PEM file containing the root certificate. You can use an absolute or relative path. Relative paths are resolved relative to the execution directory of |
Apply all YAML files in
config/opensearch-security/ using PEM certificates:
/usr/share/opensearch/plugins/opensearch-security/tools/securityadmin.sh \ -cacert /etc/opensearch/root-ca.pem \ -cert /etc/opensearch/kirk.pem \ -key /etc/opensearch/kirk-key.pem \ -cd /usr/share/opensearch/config/opensearch-security/
Apply a single YAML file (
config.yml) using PEM certificates:
./securityadmin.sh \ -f ../../../config/opensearch-security/config.yml \ -icl -nhnv -cert /etc/opensearch/kirk.pem \ -cacert /etc/opensearch/root-ca.pem \ -key /etc/opensearch/kirk-key.pem \ -t config
Apply all YAML files in
config/opensearch-security/ with keystore and truststore files:
./securityadmin.sh \ -cd /usr/share/opensearch/config/opensearch-security/ \ -ks /path/to/keystore.jks \ -kspass changeit \ -ts /path/to/truststore.jks \ -tspass changeit -nhnv -icl
Using securityadmin with keystore and truststore files
You can also use keystore files in JKS format in conjunction with
./securityadmin.sh -cd ../../../config/opensearch-security -icl -nhnv -ts <path/to/truststore> -tspass <truststore password> -ks <path/to/keystore> -kspass <keystore password>
Use the following options to control the key and truststore settings.
| ||The location of the keystore containing the admin certificate and all intermediate certificates, if any. You can use an absolute or relative path. Relative paths are resolved relative to the execution directory of |
| ||The password for the keystore.|
| ||The key store type, either JKS or PKCS#12/PFX. If not specified, the Security plugin tries to determine the type from the file extension.|
| ||The alias of the admin certificate, if any.|
| ||The location of the truststore containing the root certificate. You can use an absolute or relative path. Relative paths are resolved relative to the execution directory of |
| ||The password for the truststore.|
| ||The truststore type, either JKS or PKCS#12/PFX. If not specified, the Security plugin tries to determine the type from the file extension.|
| ||The alias for the root certificate, if any.|
If you run a default OpenSearch installation, which listens on port 9200 and uses
opensearch as a cluster name, you can omit the following settings altogether. Otherwise, specify your OpenSearch settings by using the following switches.
| ||OpenSearch hostname. Default is |
| ||OpenSearch port. Default is 9200 - not the HTTP port.|
| ||Cluster name. Default is |
| ||Ignore cluster name.|
| ||Sniff cluster nodes. Sniffing detects available nodes using the OpenSearch |
| ||Execute |
Certificate validation settings
Use the following options to control certificate validation.
| ||Do not validate hostname. Default is false.|
| ||Do not resolve hostname. Only relevant if |
| ||Do not use OpenSSL, even if available. Default is to use OpenSSL if it is available.|
Configuration files settings
The following switches define which configuration files you want to push to the Security plugin. You can either push a single file or specify a directory containing one or more configuration files.
| ||Directory containing multiple Security plugin configuration files.|
| ||Single configuration file. Can’t be used with |
| ||File type.|
| ||Reload the current configuration and flush the internal cache.|
To upload all configuration files in a directory, use this:
./securityadmin.sh -cd ../../../config/opensearch-security -ts ... -tspass ... -ks ... -kspass ...
If you want to push a single configuration file, use this:
./securityadmin.sh -f ../../../config/opensearch-security/internal_users.yml -t internalusers \ -ts ... -tspass ... -ks ... -kspass ...
The file type must be one of the following:
You probably won’t need to change cipher settings. If you need to, use the following options.
| ||Comma-separated list of enabled TLS ciphers.|
| ||Comma-separated list of enabled TLS protocols.|
Backup, restore, and migrate
You can download all current configuration files from your cluster with the following command:
./securityadmin.sh -backup my-backup-directory -ts ... -tspass ... -ks ... -kspass ...
This command dumps the current Security plugin configuration from your cluster to individual files in the directory you specify. You can then use these files as backups or to load the configuration into a different cluster. This command is useful when moving a proof-of-concept to production or if you need to add additional reserved or hidden resources:
./securityadmin.sh \ -backup my-backup-directory \ -icl \ -nhnv \ -cacert ../../../config/root-ca.pem \ -cert ../../../config/kirk.pem \ -key ../../../config/kirk-key.pem
To upload the dumped files to another cluster:
./securityadmin.sh -h production.example.com -p 9301 -cd /etc/backup/ -ts ... -tspass ... -ks ... -kspass ...
To migrate configuration YAML files from the Open Distro for Elasticsearch 0.x.x format to the OpenSearch 1.x.x format:
./securityadmin.sh -migrate ../../../config/opensearch-security -ts ... -tspass ... -ks ... -kspass ...
| ||Retrieve the current Security plugin configuration from a running cluster and dump it to the working directory.|
| ||Migrate configuration YAML files from Open Distro for Elasticsearch 0.x.x to OpenSearch 1.x.x.|
| ||Delete the Security plugin configuration index and exit. This option is useful if the cluster state is red due to a corrupted Security plugin index.|
| ||Enable shard allocation and exit. This option is useful if you disabled shard allocation while performing a full cluster restart and need to recreate the Security plugin index.|
| ||Displays information about the used admin certificate.|
| ||By default, the Security plugin caches authenticated users, along with their roles and permissions, for one hour. This option reloads the current Security plugin configuration stored in your cluster, invalidating any cached users, roles, and permissions.|
| ||The Security plugin index name. Default is |
| ||Set explicit number of replicas or auto-expand expression for the |
| ||Enable replica auto-expand.|
| ||Disable replica auto-expand.|
| ||Update the replica settings.|
On Windows, the equivalent of
securityadmin.sh is the
securityadmin.bat script located in the
When running the example commands in the preceding sections, use the command prompt or Powershell. Open the command prompt by entering
cmd or Powershell by entering
powershell in the search box next to Start on the taskbar.
For example, to print all available command line options, run the script with no arguments:
When entering a multiline command, use the caret (
^) character to escape the next character in the command line.
For example, to load your initial configuration (all YAML files), use the following command:
.\securityadmin.bat -cd ..\..\..\config\opensearch-security\ -icl -nhnv ^ -cacert ..\..\..\config\root-ca.pem ^ -cert ..\..\..\config\kirk.pem ^ -key ..\..\..\config\kirk-key.pem