permit at+jwt typ header value in jwt access tokens #126687
Merged
Conversation
This file contains hidden or 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
richard-dennehy added >enhancement :Security/Authentication 
| Hi @richard-dennehy, I've created a changelog YAML for you. |
richard-dennehy commented Apr 11, 2025
Comment on lines 22 to 25
| public static final JwtTypeValidator ID_TOKEN_INSTANCE = new JwtTypeValidator(JOSEObjectType.JWT, null); | ||
| | ||
| // strictly speaking, this should only permit `at+jwt`, but removing the other two options is a breaking change | ||
| public static final JwtTypeValidator ACCESS_TOKEN_INSTANCE = new JwtTypeValidator( |
There was a problem hiding this comment.
split validator into 2, as we don't want to allow at+jwt for ID tokens
| Pinging @elastic/es-security (Team:Security) |
n1v0lg approved these changes Apr 14, 2025
There was a problem hiding this comment.
LGTM 🚀
For additional functional coverage, I'd also tweak one of our JWT REST tests (here) to randomly set a at+jwt header -- provided that it's an application token JWT. This will take a bit of tweaking to the method signature, i.e., something like a boolean flag allowAtJwtType.
Let's also open a backport to 8.19.
| final JwtTypeValidator validator = randomFrom(JwtTypeValidator.ID_TOKEN_INSTANCE, JwtTypeValidator.ACCESS_TOKEN_INSTANCE); | ||
| | ||
| final JWSHeader jwsHeader = JWSHeader.parse( | ||
| Map.of("typ", randomAlphaOfLengthBetween(4, 8), "alg", randomAlphaOfLengthBetween(3, 8)) |
There was a problem hiding this comment.
Could also add AT+JWT here -- this case isn't captured by a random alpha string and seems like an edge-case worth explicitly covering as invalid.
There was a problem hiding this comment.
turns out the parser ignores case - I've added AT+JWT to the success test case instead
| // strictly speaking, this should only permit `at+jwt`, but removing the other two options is a breaking change | ||
| public static final JwtTypeValidator ACCESS_TOKEN_INSTANCE = new JwtTypeValidator( | ||
| JOSEObjectType.JWT, | ||
| new JOSEObjectType("at+jwt"), |
There was a problem hiding this comment.
Nit: let's make this a private constant
richard-dennehy added auto-backport 💚 Backport successful
|
5 tasks
elasticsearchmachine pushed a commit that referenced this pull request Apr 15, 2025
* permit at+jwt typ header value in jwt access tokens * Update docs/changelog/126687.yaml * address review comments * [CI] Auto commit changes from spotless * update Type Validator tests for parser ignoring case --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co>
afoucret pushed a commit to afoucret/elasticsearch that referenced this pull request Apr 16, 2025
* permit at+jwt typ header value in jwt access tokens * Update docs/changelog/126687.yaml * address review comments * [CI] Auto commit changes from spotless * update Type Validator tests for parser ignoring case --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co>
leemthompo added a commit to elastic/docs-content that referenced this pull request Apr 22, 2025
Update JWT documentation to mention `at+jwt` support introduced [here](elastic/elasticsearch#126687) Rendered [here](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1124/deploy-manage/users-roles/cluster-or-deployment-auth/jwt#jwt-validation-header) --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Resolves #119370
Permit
at+jwttypheader values when parsing Access tokens, as required by RFC 9068.We continue to accept
typ=JWTornullto maintain backwards compatibility.