Skip to content

Commit b76950d

Browse files
authored
Merge pull request #5717 from lashinijay/add-warning
Add warning note for introspection endpoint when include_validation_context_as_jwt_in_reponse is enabled
2 parents f73fc33 + 5aadf49 commit b76950d

File tree

8 files changed

+40
-0
lines changed

8 files changed

+40
-0
lines changed

en/identity-server/5.10.0/docs/learn/jwt-token-generation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ with the validation response.
99

1010
Add and configure the following properties as shown below in the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder.
1111

12+
!!! warning "Introspection can reveal user information"
13+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
14+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
15+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
16+
1217
```toml
1318
[oauth.token.validation]
1419
include_validation_context_as_jwt_in_reponse = "true"

en/identity-server/5.10.0/docs/learn/verifying-openid-connect-id-token-signatures.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ public class ValidateRSASignature {
7676

7777
Configuration to switch between signed and unsigned ID tokens. With default configurations, the ID token is always signed. If you want to switch off ID token signing, add the following configuration changes in the `<IS_HOME>/repository/conf/deployment.toml` file.
7878

79+
!!! warning "Introspection can reveal user information"
80+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
81+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
82+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
83+
7984
```xml
8085
[oauth.token.validation]
8186
include_validation_context_as_jwt_in_reponse= true

en/identity-server/5.11.0/docs/learn/jwt-token-generation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ with the validation response.
99

1010
Add and configure the following properties as shown below in the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder.
1111

12+
!!! warning "Introspection can reveal user information"
13+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
14+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
15+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
16+
1217
```toml
1318
[oauth.token.validation]
1419
include_validation_context_as_jwt_in_reponse = "true"

en/identity-server/5.11.0/docs/learn/verifying-openid-connect-id-token-signatures.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ public class ValidateRSASignature {
7676

7777
Configuration to switch between signed and unsigned ID tokens. With default configurations, the ID token is always signed. If you want to switch off ID token signing, add the following configuration changes in the `<IS_HOME>/repository/conf/deployment.toml` file.
7878

79+
!!! warning "Introspection can reveal user information"
80+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
81+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
82+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
83+
7984
```xml
8085
[oauth.token.validation]
8186
include_validation_context_as_jwt_in_reponse= true

en/identity-server/5.9.0/docs/learn/jwt-token-generation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ with the validation response.
99

1010
Add and configure the following properties as shown below in the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder.
1111

12+
!!! warning "Introspection can reveal user information"
13+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
14+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
15+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
16+
1217
```toml
1318
[oauth.token.validation]
1419
include_validation_context_as_jwt_in_reponse = "true"

en/identity-server/5.9.0/docs/learn/verifying-openid-connect-id-token-signatures.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ public class ValidateRSASignature {
7676

7777
Configuration to switch between signed and unsigned ID tokens. With default configurations, the ID token is always signed. If you want to switch off ID token signing, add the following configuration changes in the `<IS_HOME>/repository/conf/deployment.toml` file.
7878

79+
!!! warning "Introspection can reveal user information"
80+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
81+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
82+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
83+
7984
```xml
8085
[oauth.token.validation]
8186
include_validation_context_as_jwt_in_reponse= true

en/identity-server/6.0.0/docs/guides/access-delegation/get-user-claims-as-a-jwt.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ You can configure this for all tenants by configuring the `deployment.toml` file
3636

3737
1. Add and configure the following properties as shown below in the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder.
3838

39+
!!! warning "Introspection can reveal user information"
40+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
41+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
42+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
43+
3944
```toml
4045
[oauth.token.validation]
4146
include_validation_context_as_jwt_in_reponse = "true"

en/identity-server/6.1.0/docs/guides/access-delegation/get-user-claims-as-a-jwt.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ You can configure this for all tenants by configuring the `deployment.toml` file
3636

3737
1. Add and configure the following properties as shown below in the `deployment.toml` file found in the `<IS_HOME>/repository/conf` folder.
3838

39+
!!! warning "Introspection can reveal user information"
40+
Enabling the configuration `include_validation_context_as_jwt_in_reponse` allows the introspection endpoint to return user claims in the `token_string` (JWT).
41+
API gateways and resource servers that introspect tokens may therefore receive user information if they send the introspect request with `required_claims`.
42+
Enable this only if required, and ensure that access to the introspection endpoint is strictly controlled.
43+
3944
```toml
4045
[oauth.token.validation]
4146
include_validation_context_as_jwt_in_reponse = "true"

0 commit comments

Comments
 (0)