-
-
Notifications
You must be signed in to change notification settings - Fork 393
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BREAKING CHANGE: openid-client v6.x is a complete rewrite of the openid-client module, this is the first time since 0.1.0 (8 years ago) that the API has drastically changed. The new module structure and API focuses on three core principles:
- runtime compatibility (adding support for Deno, Cloudflare Workers, Bun, and other Web API interoperable runtimes)
- tree-shakeability (bundles should not contain features that don't end up being used)
- less options (removing support for processing deprecated response types, cutting down on the number of combinations that need to handled)
To that end openid-client@6 no longer supports the full cartesian matrix of response types and response modes, it no longer supports issuing encrypted assertions, decrypting assertions is limited to only a few algorithms, it no longer supports Dynamic Client Registration or Management, and Self-Issued OpenID Provider responses are also not supported.
The new API makes basic setups simple while allowing some degree of complexity where needed.
openid-client@6 is an ESM module using ES2022 syntax and it depends on WebCryptoAPI and Fetch API globals being available in the JS runtime.
openid-client@6 is written in TypeScript and its exported types come with comment annotations.
(Node.js) Versions 20.x and newer have all the necessary globals. v18.x is being tested in CI as well with the `--experimental-global-webcrypto` CLI flag.
(Node.js) CJS style `let client = require('openid-client')` is possible in versions where `process.features.require_module` is `true`. This is a new Node.js feature slated to be released without a CLI flag in 23.x and 22.x- Loading branch information
Showing
262 changed files
with
19,688 additions
and
14,986 deletions.
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 |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| echo $(electron -i <<< 'process.exit(0)' 2> /dev/null | grep "Using" | awk '{$1=$1};1' | sed -r "s/\x1B\[([0-9]{1,3}(;[0-9]{1,2};?)?)?[mGK]//g") | ||
|
|
||
| electron -i <<< 'process.exit(parseInt(process.versions.node, 10))' &> /dev/null | ||
| NODE_VERSION=$? | ||
| export NODE_OPTIONS='--import=tsx/esm --conditions=browser --no-warnings --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256 ECDHE-RSA-AES256-GCM-SHA384 ECDHE-ECDSA-AES128-GCM-SHA256 ECDHE-ECDSA-AES256-GCM-SHA384"' | ||
|
|
||
| if [[ $NODE_VERSION -eq 18 ]]; then | ||
| export NODE_OPTIONS+=' --experimental-global-webcrypto' | ||
| fi |
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 |
|---|---|---|
| @@ -1,42 +1,56 @@ | ||
| --- | ||
| name: 🐞Bug report | ||
| about: Something is not working as I think it should be | ||
| labels: triage | ||
|
|
||
| --- | ||
|
|
||
| **Describe the bug** | ||
| <!-- A clear and concise description of what the bug is. --> | ||
|
|
||
|
|
||
| **To Reproduce** | ||
| Issuer and Client configuration: (inline or gist) - Don't forget to redact your secrets. | ||
| ```js | ||
| // Issuer configuration (issuer.metadata) and how it is constructed (discovery or manual?) | ||
| { | ||
| // ... | ||
| } | ||
| // Client configuration (client.metadata) and how it is constructed (fromUri or manual?) | ||
| { | ||
| // ... | ||
| } | ||
| ``` | ||
|
|
||
| Steps to reproduce the behaviour: | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| **Expected behaviour** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Environment:** | ||
| - openid-client version: [e.g. v3.14.0] | ||
| - node version: [e.g. v8.9.0] | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. | ||
|
|
||
| - [ ] the bug is happening on latest openid-client too. | ||
| - [ ] i have searched the issues tracker on github for similar issues and couldn't find anything related. | ||
| description: There's a bug I want to report | ||
| labels: | ||
| - triage | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report. Do not use this form to ask questions or make suggestions, use the [appropriate](https://github.com/panva/openid-client/issues/new/choose) Discussions Topic for those. | ||
| - type: textarea | ||
| attributes: | ||
| label: What happened? | ||
| description: A clear and concise description of what the bug is and what you expected to happen instead. | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Version | ||
| description: What exact version of the library do you use? | ||
| placeholder: e.g. v1.0.0 | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| attributes: | ||
| label: Runtime | ||
| description: What JavaScript runtime are you seeing the problem on? | ||
| options: | ||
| - Browser | ||
| - Cloudflare Workers | ||
| - Deno | ||
| - Electron | ||
| - Node.js | ||
| - Other (I will specify below) | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Runtime Details | ||
| description: More information about the runtime (e.g. node version, browser vendor and version, electron version, operating system) | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Code to reproduce | ||
| description: Please copy and paste code to reproduce the issue. This will be automatically formatted into JavaScript code, so no need for backticks. | ||
| render: js | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Required | ||
| options: | ||
| - label: I have searched the issues tracker and discussions for similar topics and couldn't find anything related. | ||
| required: true | ||
| - label: I agree to follow this project's [Code of Conduct](https://github.com/panva/openid-client/blob/main/CODE_OF_CONDUCT.md) | ||
| required: true |
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
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
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
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
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
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
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
Oops, something went wrong.