mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-04 01:49:15 +00:00
fe36861ada
X-Pack security supports built-in authentication service `token-service` that allows access tokens to be used to access Elasticsearch without using Basic authentication. The tokens are generated by `token-service` based on OAuth2 spec. The access token is a short-lived token (defaults to 20m) and refresh token with a lifetime of 24 hours, making them unsuitable for long-lived or recurring tasks where the system might go offline thereby failing refresh of tokens. This commit introduces a built-in authentication service `api-key-service` that adds support for long-lived tokens aka API keys to access Elasticsearch. The `api-key-service` is consulted after `token-service` in the authentication chain. By default, if TLS is enabled then `api-key-service` is also enabled. The service can be disabled using the configuration setting. The API keys:- - by default do not have an expiration but expiration can be configured where the API keys need to be expired after a certain amount of time. - when generated will keep authentication information of the user that generated them. - can be defined with a role describing the privileges for accessing Elasticsearch and will be limited by the role of the user that generated them - can be invalidated via invalidation API - information can be retrieved via a get API - that have been expired or invalidated will be retained for 1 week before being deleted. The expired API keys remover task handles this. Following are the API key management APIs:- 1. Create API Key - `PUT/POST /_security/api_key` 2. Get API key(s) - `GET /_security/api_key` 3. Invalidate API Key(s) `DELETE /_security/api_key` The API keys can be used to access Elasticsearch using `Authorization` header, where the auth scheme is `ApiKey` and the credentials, is the base64 encoding of API key Id and API key separated by a colon. Example:- ``` curl -H "Authorization: ApiKey YXBpLWtleS1pZDphcGkta2V5" http://localhost:9200/_cluster/health ``` Closes #34383
105 lines
3.2 KiB
Plaintext
105 lines
3.2 KiB
Plaintext
[role="xpack"]
|
|
[[security-api]]
|
|
== Security APIs
|
|
|
|
You can use the following APIs to perform security activities.
|
|
|
|
* <<security-api-authenticate>>
|
|
* <<security-api-clear-cache>>
|
|
* <<security-api-has-privileges>>
|
|
* <<security-api-ssl>>
|
|
|
|
[float]
|
|
[[security-api-app-privileges]]
|
|
=== Application privileges
|
|
|
|
You can use the following APIs to add, update, retrieve, and remove application
|
|
privileges:
|
|
|
|
* <<security-api-put-privileges,Create or update privileges>>
|
|
* <<security-api-delete-privilege,Delete privileges>>
|
|
* <<security-api-get-privileges,Get privileges>>
|
|
|
|
[float]
|
|
[[security-role-mapping-apis]]
|
|
=== Role mappings
|
|
|
|
You can use the following APIs to add, remove, update, and retrieve role mappings:
|
|
|
|
* <<security-api-put-role-mapping,Create or update role mappings>>
|
|
* <<security-api-delete-role-mapping,Delete role mappings>>
|
|
* <<security-api-get-role-mapping,Get role mappings>>
|
|
|
|
[float]
|
|
[[security-role-apis]]
|
|
=== Roles
|
|
|
|
You can use the following APIs to add, remove, update, and retrieve roles in the native realm:
|
|
|
|
* <<security-api-put-role,Create or update roles>>
|
|
* <<security-api-clear-role-cache,Clear roles cache>>
|
|
* <<security-api-delete-role,Delete roles>>
|
|
* <<security-api-get-role,Get roles>>
|
|
|
|
[float]
|
|
[[security-token-apis]]
|
|
=== Tokens
|
|
|
|
You can use the following APIs to create and invalidate bearer tokens for access
|
|
without requiring basic authentication:
|
|
|
|
* <<security-api-get-token,Get token>>
|
|
* <<security-api-invalidate-token,Invalidate token>>
|
|
|
|
[float]
|
|
[[security-api-keys]]
|
|
=== API Keys
|
|
|
|
You can use the following APIs to create, retrieve and invalidate API keys for access
|
|
without requiring basic authentication:
|
|
|
|
* <<security-api-create-api-key,Create API Key>>
|
|
* <<security-api-get-api-key,Get API Key>>
|
|
* <<security-api-invalidate-api-key,Invalidate API Key>>
|
|
|
|
[float]
|
|
[[security-user-apis]]
|
|
=== Users
|
|
|
|
You can use the following APIs to add, remove, update, or retrieve users in the
|
|
native realm:
|
|
|
|
* <<security-api-put-user,Create or update users>>
|
|
* <<security-api-change-password,Change passwords>>
|
|
* <<security-api-delete-user,Delete users>>
|
|
* <<security-api-disable-user,Disable users>>
|
|
* <<security-api-enable-user,Enable users>>
|
|
* <<security-api-get-user,Get users>>
|
|
|
|
|
|
include::security/authenticate.asciidoc[]
|
|
include::security/change-password.asciidoc[]
|
|
include::security/clear-cache.asciidoc[]
|
|
include::security/clear-roles-cache.asciidoc[]
|
|
include::security/put-app-privileges.asciidoc[]
|
|
include::security/create-role-mappings.asciidoc[]
|
|
include::security/create-roles.asciidoc[]
|
|
include::security/create-users.asciidoc[]
|
|
include::security/delete-app-privileges.asciidoc[]
|
|
include::security/delete-role-mappings.asciidoc[]
|
|
include::security/delete-roles.asciidoc[]
|
|
include::security/delete-users.asciidoc[]
|
|
include::security/disable-users.asciidoc[]
|
|
include::security/enable-users.asciidoc[]
|
|
include::security/get-app-privileges.asciidoc[]
|
|
include::security/get-role-mappings.asciidoc[]
|
|
include::security/get-roles.asciidoc[]
|
|
include::security/get-tokens.asciidoc[]
|
|
include::security/get-users.asciidoc[]
|
|
include::security/has-privileges.asciidoc[]
|
|
include::security/invalidate-tokens.asciidoc[]
|
|
include::security/ssl.asciidoc[]
|
|
include::security/create-api-keys.asciidoc[]
|
|
include::security/invalidate-api-keys.asciidoc[]
|
|
include::security/get-api-keys.asciidoc[]
|