-
Notifications
You must be signed in to change notification settings - Fork 136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reboot/fix/OIDC auth introspect #3183
Merged
+60
−629
Merged
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
0afab3e
auto fixes
fb6fbac
wip
f8366d4
updated the doc for OIDC - validation with JWKs
Shobhajayanna f933178
Merge branch 'docs-staging' into reboot/fix/oidc-auth-introspect
Shobhajayanna 40960d7
minor language fix
janan07 e5abc9e
updated trouble shooting section
Shobhajayanna a4e9050
Merge branch 'docs-staging' into reboot/fix/oidc-auth-introspect
Shobhajayanna f921e64
Merge branch 'docs-staging' into reboot/fix/oidc-auth-introspect
Shobhajayanna 461be29
minor language refactoring
janan07 7ab6a48
fixing comments
Shobhajayanna 4dd0040
fixed the review comments.
Shobhajayanna 2b5a651
Merge branch 'docs-staging' into reboot/fix/oidc-auth-introspect
Shobhajayanna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
updated the doc for OIDC - validation with JWKs
commit f8366d402a835885c95a4194ce109c370b0274a6
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,12 +39,11 @@ The following diagram illustrates the interactions between the participants of t | |
|
||
- The Gateway validates the access token | ||
|
||
<!-- | ||
- The Gateway validates the access token at the provider's OIDC/introspection end-point. If the access token is validated, the outcome is cached for a short time (20 sec by default). | ||
--> | ||
- The Gateway validates the access token by comparing the key id of the token against the key ids obtained from the authorization server's JWK keys endpoint,URL to end point should be set using the property jwks_uri. If the access token is validated, the outcome is cached for a short time (20 sec by default). | ||
|
||
- The JWK Keys obtained from the authorization server's endpoint are cached for a while to prevent the repeated calls to the endpoint. It can be set using the property jwks.refreshInternalHours (it's 1 hour by default) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please make "for a while" more specific. Perhaps, " The JWK Keys obtained from the authorization server's endpoint can be cached for a specified interval to prevent the repeated calls to the endpoint." |
||
|
||
- In subsequent calls with the same token, the Gateway reuses the cached validation outcome. <!-- As such, round trips to the OIDC /introspection end-point are not required between short intervals, when the client needs to access multiple resources in a row to complete a unit of work -->. The caching interval is configurable with a default value of 20 seconds, which is typically a sufficient time to allow most client operations requiring multiple API requests to complete, while also providing adequate protection against unauthorized access. | ||
- In subsequent calls with the same token, the Gateway reuses the cached validation outcome. As such, round trips to the OIDC /parsing the jwt token for validation with the keys obtained from from the authorization server's JWK keys endpoint are not required between short intervals, when the client needs to access multiple resources in a row to complete a unit of work. The caching interval is configurable with a default value of 20 seconds, which is typically a sufficient time to allow most client operations requiring multiple API requests to complete, while also providing adequate protection against unauthorized access. | ||
- The API ML Gateway fetches the distributed user identity from the distributed access token and maps this user identity to the user mainframe identity using SAF. | ||
- The API ML Gateway calls the requested mainframe service/s with mainframe user credentials (Zowe, SAF JWT, or pass-ticket) which are expected by the target mainframe service. | ||
|
||
|
@@ -100,7 +99,7 @@ Use the following procedure to enable the feature to use an OIDC Access Token as | |
Specifies the value of the client identification (`client_id`) assigned by the OIDC provider to the API ML Gateway. | ||
|
||
- **`components.gateway.apiml.security.oidc.clientSecret`** | ||
Specifies the client secret assigned by the OIDC provider to the API ML Gateway. This parameter is used in combination with the `client_id` in Access Token validation requests at the `/introspect` endpoint of the OIDC provider. | ||
Specifies the client secret assigned by the OIDC provider to the API ML Gateway. This parameter is used in combination with the `client_id` to obtain JWKs from jwks.uri of the OIDC provider. | ||
|
||
- **`components.gateway.apiml.security.oidc.registry`** | ||
Specifies the SAF registry used to group the identities recognized as having a OIDC identity mapping. The registry name is the string used during the creation of the mapping between the dustributed and mainframe user identities. For more information, see the [ESM configuration](#esm-configuration). | ||
|
@@ -169,4 +168,3 @@ The client application is not properly configured in the API ML Gateway. | |
|
||
**Solution** | ||
Check that the `client_id` and `client_secret` configured in the API ML Gateway correspond to the `client_id` and `client_secret` of the client application as configured in the OIDC provider. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review this sentence. I suggest this be two sentences.
"the key ids obtained from the authorization server's JWK keys endpoint,URL to end point should be set"