Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: add scopes validator for logical evalulation #1608

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add scopes validator for logical evalulation #1608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/oathkeeper/pipeline/authn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,9 @@ Token Introspection to check if the token is valid and if the token was granted
- `introspection_url` (string, required) - The OAuth 2.0 Token Introspection endpoint.
- `scope_strategy` (string, optional) - Sets the strategy to be used to validate/match the token scope. Supports "hierarchic",
"exact", "wildcard", "none". Defaults to "none".
- `scope_validation` (string, optional) - Sets the validation strategy to be used to validate/match the token scopes. Supports
"default", "any". Defaults to "default" requiring all scopes to match. Strategy set to "any" works as logical OR - any matched
scope will pass the validation.
- `required_scope` ([]string, optional) - Sets what scope is required by the URL and when performing OAuth 2.0 Client Credentials
request, the scope will be included in the request.
- `target_audience` ([]string, optional) - Sets what audience is required by the URL.
Expand Down Expand Up @@ -620,6 +623,7 @@ authenticators:
config:
introspection_url: https://my-website.com/oauth2/introspection
scope_strategy: exact
scope_validation: default
required_scope:
- photo
- profile
Expand Down Expand Up @@ -660,6 +664,7 @@ authenticators:
config:
introspection_url: https://my-website.com/oauth2/introspection
scope_strategy: exact
scope_validation: any
required_scope:
- photo
- profile
Expand Down Expand Up @@ -769,6 +774,9 @@ verify the signature of it.
- `jwks_ttl` (duration, optional) - The duration for which fetched JWKs should be cached internally. Defaults to "30s".
- `scope_strategy` (string, optional) - Sets the strategy to be used to validate/match the scope. Supports "hierarchic", "exact",
"wildcard", "none". Defaults to "none".
- `scope_validation` (string, optional) - Sets the validation strategy to be used to validate/match the token scopes. Supports
"default", "any". Defaults to "default" requiring all scopes to match. Strategy set to "any" works as logical OR - any matched
scope will pass the validation.
- If `trusted_issuers` ([]string) is set, the JWT must contain a value for claim `iss` that matches _exactly_ (case-sensitive) one
of the values of `trusted_issuers`. If no values are configured, the issuer will be ignored.
- If `target_audience` ([]string) is set, the JWT must contain all values (exact, case-sensitive) in the claim `aud`. If no values
Expand Down
Loading