Default to RFC 7638 kid fingerprint generation #194
Merged
Conversation
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
|
Failing tests will be fixed by #195. |
jessieay
reviewed
Apr 16, 2023
|
Thank you for the detailed explanation on these |
|
@nbulaj Could you also take a look at this one? |
The switch from the `json-jwt` to `jwt` gem in doorkeeper-gem#177 changed the default `kid` generation from RFC 7638 (https://www.rfc-editor.org/rfc/rfc7638) to a format based on the SHA256 digest of the key elements. However, clients may fail if the the `kid` generated by `IdToken` does not match a key listed in JWKS discovery endpoint, which may be implemented by the application using RFC 7638-based `kid` values. To restore the previous behavior, applications have to set a global setting: ``` JWT.configuration.jwk.kid_generator_type = :rfc7638_thumbprint ``` However, relying on this global setting is not ideal since other keys may depend on the legacy `kid` values. In keeping with semantic versioning, restore the `kid` generation to RFC 7638. Whether this should be customizable can be discussed later. Closes doorkeeper-gem#193
|
Released with 1.8.6 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The switch from the
json-jwttojwtgem in #177 changed the defaultkidgeneration from RFC 7638(https://www.rfc-editor.org/rfc/rfc7638) to a format based on the SHA256 digest of the key elements.
However, clients may fail if the the
kidgenerated byIdTokendoes not match a key listed in JWKS discovery endpoint, which may be implemented by the application using RFC 7638-basedkidvalues. To restore the previous behavior, applications have to set a global setting:However, relying on this global setting is not ideal since other keys may depend on the legacy
kidvalues.In keeping with semantic versioning, restore the
kidgeneration to RFC 7638. Whether this should be customizable can be discussed later.Closes #193