From 36918d1e18f866138cd2d71a5273a79d61dbaa4f Mon Sep 17 00:00:00 2001 From: Taeik Lim Date: Fri, 15 Mar 2024 00:35:47 +0900 Subject: [PATCH] Add required_audience, required_issuer guide to jwt (#6665) * Add required_audience, required_issuer guide to jwt Signed-off-by: Taeik Lim * Update _security/authentication-backends/jwt.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _security/authentication-backends/jwt.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Taeik Lim Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _security/authentication-backends/jwt.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/_security/authentication-backends/jwt.md b/_security/authentication-backends/jwt.md index 846004d4..afcd4c78 100644 --- a/_security/authentication-backends/jwt.md +++ b/_security/authentication-backends/jwt.md @@ -106,6 +106,8 @@ jwt_auth_domain: jwt_url_parameter: null subject_key: null roles_key: null + required_audience: null + required_issuer: null jwt_clock_skew_tolerance_seconds: 20 authentication_backend: type: noop @@ -120,6 +122,8 @@ Name | Description `jwt_url_parameter` | If the token is not transmitted in the HTTP header but rather as an URL parameter, define the name of the parameter here. `subject_key` | The key in the JSON payload that stores the username. If not set, the [subject](https://tools.ietf.org/html/rfc7519#section-4.1.2) registered claim is used. `roles_key` | The key in the JSON payload that stores the user's roles. The value of this key must be a comma-separated list of roles. +`required_audience` | The name of the audience which the JWT must specify. This corresponds [`aud` claim of the JWT](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). +`required_issuer` | The target issuer of JWT stored in the JSON payload. This corresponds to the [`iss` claim of the JWT](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.1). `jwt_clock_skew_tolerance_seconds` | Sets a window of time, in seconds, to compensate for any disparity between the JWT authentication server and OpenSearch node clock times, thereby preventing authentication failures due to the misalignment. Security sets 30 seconds as the default. Use this setting to apply a custom value. Because JWTs are self-contained and the user is authenticated at the HTTP level, no additional `authentication_backend` is needed. Set this value to `noop`.