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: provide option to prevent falling back to jwksUri with getKeysInterceptor #389

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: provide option to prevent falling back to jwksUri with getKeysInterceptor #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1277af
feat: provide option to prevent falling back to jwksUri with getKeysI…
sam-super Nov 30, 2023
23bc427
Merge branch 'master' into feat-disable-jwks-uri-fallback
sam-super Jan 4, 2024
8458ca5
Merge branch 'master' into feat-disable-jwks-uri-fallback
sam-super Jan 30, 2024
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
3 changes: 2 additions & 1 deletion EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This repository holds a number of example integrations found in the [examples](.
- `requestHeaders`: (_optional_) an object of headers to pass to the request
- `requestAgent`: (_optional_) a Node `http.Agent` to be passed to the http(s) request
- `getKeysInterceptor`: (_optional_) a promise returning function hook [(details)](#loading-keys-from-local-file-environment-variable-or-other-externals)
- `jwksUriFallback`: (_optional_) boolean to determine fallback behaviour if `getKeysInterceptor` doesn't return keys which match the `kid` on the request (defaults to `true`, so it will fall back to `jwksUri`).
- `cacheMaxAge`: (_optional_) the duration for which to store a cached JWKS in ms (default 600,000 or 10 minutes)
- `jwksRequestsPerMinute`: (_optional_) max number of requests allowed to the JWKS URI per minute (defaults to 10)

Expand Down Expand Up @@ -92,7 +93,7 @@ You can configure a proxy with using a [custom http(s) agent](https://github.com

## Loading keys from local file, environment variable, or other externals

The `getKeysInterceptor` property can be used to fetch keys before sending a request to the `jwksUri` endpoint. This can be helpful when wanting to load keys from a file, env variable, or an external cache. If a KID cannot be found in the keys returned from the interceptor, it will fallback to the `jwksUri` endpoint. This property will continue to work with the provided LRU cache, if the cache is enabled.
The `getKeysInterceptor` property can be used to fetch keys before sending a request to the `jwksUri` endpoint. This can be helpful when wanting to load keys from a file, env variable, or an external cache. If a KID cannot be found in the keys returned from the interceptor, it will fall back to the `jwksUri` endpoint. If you don't want to fall back to `jwksUri` set `jwksUriFallback: false`. This property will continue to work with the provided LRU cache, if the cache is enabled.

```js
const client = new JwksClient({
Expand Down
Loading
Loading