From 59e754365255d8fc6ce7c1ca7312e4c774619863 Mon Sep 17 00:00:00 2001 From: markphelps Date: Tue, 9 Jan 2024 18:59:00 +0000 Subject: [PATCH 1/2] chore: format code --- authentication/methods.mdx | 5 +++-- authentication/overview.mdx | 2 +- configuration/authentication.mdx | 7 +++---- configuration/overview.mdx | 15 +++++++-------- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/authentication/methods.mdx b/authentication/methods.mdx index 0c48ef9..2a3e7c6 100644 --- a/authentication/methods.mdx +++ b/authentication/methods.mdx @@ -273,9 +273,10 @@ The expiration can be used to schedule when to next request a new client token. JWT authentication is useful for scenarios where you want to integrate Flipt with an existing authentication system. - JWT authentication is **not** supported by the Flipt UI as it is not a session compatible authentication method. + JWT authentication is **not** supported by the Flipt UI as it is not a session + compatible authentication method. ![JWT Authentication Flow](/images/authentication/jwt.svg) -The JWT issued by the the Authorization Server can then be used to authenticate with Flipt as outlined in [Using JSON Web Tokens](/authentication/using-jwts). \ No newline at end of file +The JWT issued by the the Authorization Server can then be used to authenticate with Flipt as outlined in [Using JSON Web Tokens](/authentication/using-jwts). diff --git a/authentication/overview.mdx b/authentication/overview.mdx index 25854cd..9553377 100644 --- a/authentication/overview.mdx +++ b/authentication/overview.mdx @@ -54,7 +54,7 @@ Once a `client token` has been acquired, it can be supplied via request metadata Flipt can also authenticate requests using externally created and signed [JSON Web Tokens](https://jwt.io/). This is useful for integrating with existing authentication systems with Flipt. -To enable JWT authentication, you will need to configure Flipt with the public key used to verify the JWT signature. +To enable JWT authentication, you will need to configure Flipt with the public key used to verify the JWT signature. See the [Configuration: JWT Authentication](/configuration/authentication#json-web-token) documentation for details. diff --git a/configuration/authentication.mdx b/configuration/authentication.mdx index 016ebd9..5e61ac4 100644 --- a/configuration/authentication.mdx +++ b/configuration/authentication.mdx @@ -358,7 +358,8 @@ Flipt supports key verification using the following methods: - PEM (Privacy Enhanced Mail) encoded public key -These methods are mutually exclusive, meaning that only one of them can be configured at a time. + These methods are mutually exclusive, meaning that only one of them can be + configured at a time. #### JWKS URL @@ -395,9 +396,7 @@ Flipt supports validating the following claims: - `nbf` (not before) - `iat` (issued at) - - The `exp`, `nbf`, and `iat` claims are validated by default. - +The `exp`, `nbf`, and `iat` claims are validated by default. To enable claim validation, configure the values in the `validate_claims` configuration option to the expected values. diff --git a/configuration/overview.mdx b/configuration/overview.mdx index 3ad6409..1899a62 100644 --- a/configuration/overview.mdx +++ b/configuration/overview.mdx @@ -186,14 +186,13 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" #### Authentication Methods: JWT -| Property | Description | Default | Since | -| ------------------------------------------------- | ---------------------------------------------------------------- | ------- | ------- | -| authentication.methods.jwt.enabled | Enable JWT authentication | false | v1.35.0 | -| authentication.methods.jwt.jwks_url | URL to retrieve JWKS for JWT validation | | v1.35.0 | -| authentication.methods.jwt.public_key_file | Path to public key file for JWT validation | | v1.35.0 | -| authentication.methods.jwt.validate_claims.issuer | The issuer claim to validate on JWT tokens | | v1.35.0 | -| authentication.methods.jwt.validate_claims.audiences | The audience claim (list) to validate on JWT tokens | | v1.35.0 | - +| Property | Description | Default | Since | +| ---------------------------------------------------- | --------------------------------------------------- | ------- | ------- | +| authentication.methods.jwt.enabled | Enable JWT authentication | false | v1.35.0 | +| authentication.methods.jwt.jwks_url | URL to retrieve JWKS for JWT validation | | v1.35.0 | +| authentication.methods.jwt.public_key_file | Path to public key file for JWT validation | | v1.35.0 | +| authentication.methods.jwt.validate_claims.issuer | The issuer claim to validate on JWT tokens | | v1.35.0 | +| authentication.methods.jwt.validate_claims.audiences | The audience claim (list) to validate on JWT tokens | | v1.35.0 | ### Database From 9bbeb39756e9380429235573179957c5273dd6a4 Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Tue, 9 Jan 2024 20:10:31 -0500 Subject: [PATCH 2/2] chore: Update authentication/methods.mdx Co-authored-by: Yoofi Quansah --- authentication/methods.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/authentication/methods.mdx b/authentication/methods.mdx index 2a3e7c6..602a614 100644 --- a/authentication/methods.mdx +++ b/authentication/methods.mdx @@ -279,4 +279,4 @@ JWT authentication is useful for scenarios where you want to integrate Flipt wit ![JWT Authentication Flow](/images/authentication/jwt.svg) -The JWT issued by the the Authorization Server can then be used to authenticate with Flipt as outlined in [Using JSON Web Tokens](/authentication/using-jwts). +The JWT issued by the Authorization Server can then be used to authenticate with Flipt as outlined in [Using JSON Web Tokens](/authentication/using-jwts).