Repository navigation
Allow JWS header with algorithms not in the Algorithm enum #53415
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.
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
Open
dmitrygx
wants to merge
2
commits into
keycloak:main
Choose a base branch
from
dmitrygx:53413-jws-custom-alg
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+167
−52
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
109 changes: 109 additions & 0 deletions
109
core/src/test/java/org/keycloak/jose/jws/JWSHeaderTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /* | ||
| * Copyright 2026 Red Hat, Inc. and/or its affiliates | ||
| * and other contributors as indicated by the @author tags. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.keycloak.jose.jws; | ||
|
|
||
| import java.nio.charset.StandardCharsets; | ||
| import java.security.KeyPairGenerator; | ||
| import java.util.Arrays; | ||
| import java.util.Base64; | ||
|
|
||
| import org.keycloak.TokenVerifier; | ||
| import org.keycloak.common.VerificationException; | ||
| import org.keycloak.crypto.SignatureVerifierContext; | ||
| import org.keycloak.representations.AccessToken; | ||
| import org.keycloak.util.JsonSerialization; | ||
|
|
||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| public class JWSHeaderTest { | ||
|
|
||
| @Test | ||
| public void knownAlgorithm() throws Exception { | ||
| JWSHeader header = JsonSerialization.readValue("{\"alg\":\"ES256\",\"typ\":\"JWT\"}", JWSHeader.class); | ||
| Assert.assertEquals(Algorithm.ES256, header.getAlgorithm()); | ||
| Assert.assertEquals("ES256", header.getRawAlgorithm()); | ||
| Assert.assertEquals("{\"alg\":\"ES256\",\"typ\":\"JWT\"}", JsonSerialization.writeValueAsString(header)); | ||
| } | ||
|
|
||
| @Test | ||
| public void customAlgorithm() throws Exception { | ||
| JWSHeader header = JsonSerialization.readValue("{\"alg\":\"CUSTOM256\",\"typ\":\"JWT\",\"kid\":\"k1\"}", JWSHeader.class); | ||
| Assert.assertNull(header.getAlgorithm()); | ||
| Assert.assertEquals("CUSTOM256", header.getRawAlgorithm()); | ||
| Assert.assertEquals("k1", header.getKeyId()); | ||
| Assert.assertEquals("{\"alg\":\"CUSTOM256\",\"typ\":\"JWT\",\"kid\":\"k1\"}", JsonSerialization.writeValueAsString(header)); | ||
| } | ||
|
|
||
| @Test | ||
| public void customAlgorithmInToken() throws Exception { | ||
| String token = encode("{\"alg\":\"CUSTOM256\",\"typ\":\"JWT\"}") + "." + encode("{\"sub\":\"user\"}") + "." + encode("signature"); | ||
|
|
||
| JWSInput input = new JWSInput(token); | ||
| Assert.assertEquals("CUSTOM256", input.getHeader().getRawAlgorithm()); | ||
|
|
||
| TokenVerifier<AccessToken> verifier = TokenVerifier.create(token, AccessToken.class) | ||
| .publicKey(KeyPairGenerator.getInstance("RSA").generateKeyPair().getPublic()); | ||
| Assert.assertEquals("user", verifier.getToken().getSubject()); | ||
| VerificationException e = Assert.assertThrows(VerificationException.class, verifier::verifySignature); | ||
| Assert.assertEquals("Unknown or unsupported token algorithm", e.getMessage()); | ||
|
dmitrygx marked this conversation as resolved.
Resolved
|
||
| } | ||
|
|
||
| @Test | ||
| public void customAlgorithmWithVerifierContext() throws Exception { | ||
| String token = encode("{\"alg\":\"CUSTOM256\",\"typ\":\"JWT\",\"kid\":\"k1\"}") + "." + encode("{\"sub\":\"user\"}") + "." + encode("signature"); | ||
|
|
||
| AccessToken accessToken = TokenVerifier.create(token, AccessToken.class) | ||
| .verifierContext(new CustomVerifier("signature")) | ||
| .verify() | ||
| .getToken(); | ||
| Assert.assertEquals("user", accessToken.getSubject()); | ||
|
|
||
| TokenVerifier<AccessToken> invalid = TokenVerifier.create(token, AccessToken.class) | ||
| .verifierContext(new CustomVerifier("other")); | ||
| Assert.assertThrows(VerificationException.class, invalid::verify); | ||
| } | ||
|
|
||
| private static String encode(String s) { | ||
| return Base64.getUrlEncoder().withoutPadding().encodeToString(s.getBytes(StandardCharsets.UTF_8)); | ||
| } | ||
|
|
||
| private static class CustomVerifier implements SignatureVerifierContext { | ||
|
|
||
| private final byte[] expectedSignature; | ||
|
|
||
| CustomVerifier(String expectedSignature) { | ||
| this.expectedSignature = expectedSignature.getBytes(StandardCharsets.UTF_8); | ||
| } | ||
|
|
||
| @Override | ||
| public String getKid() { | ||
| return "k1"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getAlgorithm() { | ||
| return "CUSTOM256"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean verify(byte[] data, byte[] signature) { | ||
| return Arrays.equals(expectedSignature, signature); | ||
| } | ||
| } | ||
| } | ||
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.