Fail on encode and decode of bad JWS header values #174
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
The JWS spec: https://tools.ietf.org/html/draft-ietf-jose-json-web-signature-41#section-4.1.4 States that if `kid` is present then it **MUST** be a string. Currently, the library allows silent creation of invalid JWS (and thus, JWT), as it allows any type for `kid`. This commit adds checks to help ensure output meets the spec. * Add jwt.api_jws.PyJWS._validate_headers for validating JWS headers on encode and decode * Add tests
|
@gabrielg good catch. @mark-adams this looks good to me. |
|
|
||
| def _validate_kid(self, kid): | ||
| if not isinstance(kid, string_types): | ||
| raise TypeError('Key ID header parameter must be a string') |
There was a problem hiding this comment.
I think this should probably use InvalidTokenError similar to other validation errors.
|
👍 Once you changeover that exception to be a The only reason we didn't have similar validation in here for that already was that we are preparing full JWK support as part of 2.0, but this seems like something reasonable to add now. Thanks for contributing! |
|
Cool, changed |
mark-adams
added a commit
that referenced
this pull request
Jul 23, 2015
Fail on encode and decode of bad JWS header values
|
@mark-adams should we release this already? |
This was referenced Aug 22, 2016
This was referenced Sep 21, 2016
This was referenced Apr 19, 2017
This was referenced Jun 21, 2017
This was referenced Jul 1, 2017
This was referenced Jul 18, 2017
This was referenced Nov 12, 2017
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 JWS spec states that if
kidis present then it MUST be a string. Currently, the library allows silent creation of invalid JWS (and thus, JWT), as it allows any type forkid.Allowing arbitrary types is both against the spec, and has some potential security ramifications that I've seen crop up. Since header values can be used pre-verification (and in the case of
kid, might be required to verify), some more strictness around them and ensuring they meet the spec makes sense.