-
Notifications
You must be signed in to change notification settings - Fork 8.7k
[OID4VCI]: Fix getAttestationRequirements() for non-JWT proof types
#50724
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
Awambeng
wants to merge
2
commits into
keycloak:main
Choose a base branch
from
adorsys:issue-50521
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.
+195
−26
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
180 changes: 180 additions & 0 deletions
180
...t/java/org/keycloak/protocol/oid4vc/issuance/keybinding/AttestationValidatorUtilTest.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,180 @@ | ||
| package org.keycloak.protocol.oid4vc.issuance.keybinding; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import org.keycloak.protocol.oid4vc.issuance.VCIssuanceContext; | ||
| import org.keycloak.protocol.oid4vc.model.KeyAttestationsRequired; | ||
| import org.keycloak.protocol.oid4vc.model.ProofType; | ||
| import org.keycloak.protocol.oid4vc.model.ProofTypesSupported; | ||
| import org.keycloak.protocol.oid4vc.model.SupportedCredentialConfiguration; | ||
| import org.keycloak.protocol.oid4vc.model.SupportedProofTypeData; | ||
| import org.keycloak.utils.AbstractUtilSessionTest; | ||
|
|
||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
|
|
||
| public class AttestationValidatorUtilTest extends AbstractUtilSessionTest { | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReadsFromJwtKeyWhenRequested() { | ||
| KeyAttestationsRequired jwtAttestation = new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("hardware")) | ||
| .setUserAuthentication(List.of("pin")); | ||
|
|
||
| VCIssuanceContext ctx = createContextWithAttestation( | ||
| jwtAttestation, | ||
| new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("tpm")) | ||
| .setUserAuthentication(List.of("fingerprint")) | ||
| ); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.JWT); | ||
|
|
||
| Assertions.assertNotNull(result); | ||
| assertEquals(List.of("hardware"), result.getKeyStorage(), | ||
| "Should read key_storage from the jwt proof type entry"); | ||
| assertEquals(List.of("pin"), result.getUserAuthentication(), | ||
| "Should read user_authentication from the jwt proof type entry"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReadsFromAttestationKeyWhenRequested() { | ||
| KeyAttestationsRequired attestationAttestation = new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("tpm")) | ||
| .setUserAuthentication(List.of("fingerprint")); | ||
|
|
||
| VCIssuanceContext ctx = createContextWithAttestation( | ||
| new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("hardware")) | ||
| .setUserAuthentication(List.of("pin")), | ||
| attestationAttestation | ||
| ); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.ATTESTATION); | ||
|
|
||
| Assertions.assertNotNull(result); | ||
| assertEquals(List.of("tpm"), result.getKeyStorage(), | ||
| "Should read key_storage from the attestation proof type entry"); | ||
| assertEquals(List.of("fingerprint"), result.getUserAuthentication(), | ||
| "Should read user_authentication from the attestation proof type entry"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReturnsNullWhenProofTypeKeyNotFound() { | ||
| VCIssuanceContext ctx = createContextWithAttestation( | ||
| new KeyAttestationsRequired().setKeyStorage(List.of("hardware")), | ||
| null | ||
| ); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, "unknown_proof_type"); | ||
|
|
||
| assertNull(result, "Should return null when proof type key does not exist"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReturnsNullWhenConfigIsNull() { | ||
| VCIssuanceContext ctx = new VCIssuanceContext(); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.JWT); | ||
|
|
||
| assertNull(result, "Should return null when credentialConfig is null"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReturnsNullWhenProofTypesSupportedIsNull() { | ||
| VCIssuanceContext ctx = new VCIssuanceContext(); | ||
| ctx.setCredentialConfig(new SupportedCredentialConfiguration()); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.JWT); | ||
|
|
||
| assertNull(result, "Should return null when proofTypesSupported is null"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReturnsNullWhenSupportedProofTypesIsEmpty() { | ||
| // supportedProofTypes is always an initialized HashMap (never null), so this covers the empty-map case. | ||
| VCIssuanceContext ctx = new VCIssuanceContext(); | ||
| SupportedCredentialConfiguration config = new SupportedCredentialConfiguration(); | ||
| config.setProofTypesSupported(new ProofTypesSupported()); | ||
| ctx.setCredentialConfig(config); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.JWT); | ||
|
|
||
| assertNull(result, "Should return null when supportedProofTypes map is empty"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReturnsJwtFallbackWhenProofTypeKeyIsNull() { | ||
| // null proofTypeKey falls back to "jwt" for backward compatibility. | ||
| KeyAttestationsRequired jwtReq = new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("hardware")) | ||
| .setUserAuthentication(List.of("pin")); | ||
|
|
||
| VCIssuanceContext ctx = createContextWithAttestation(jwtReq, null); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, null); | ||
|
|
||
| Assertions.assertNotNull(result, "Should return attestation requirements using JWT fallback when proofTypeKey is null"); | ||
| assertEquals(List.of("hardware"), result.getKeyStorage()); | ||
| assertEquals(List.of("pin"), result.getUserAuthentication()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_JwtAndAttestationProduceDifferentResults() { | ||
| KeyAttestationsRequired jwtReq = new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("hardware")); | ||
| KeyAttestationsRequired attestationReq = new KeyAttestationsRequired() | ||
| .setKeyStorage(List.of("tpm", "secure_enclave")); | ||
|
|
||
| VCIssuanceContext ctx = createContextWithAttestation(jwtReq, attestationReq); | ||
|
|
||
| KeyAttestationsRequired jwtResult = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.JWT); | ||
| KeyAttestationsRequired attestationResult = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.ATTESTATION); | ||
|
|
||
| Assertions.assertNotNull(jwtResult); | ||
| assertEquals(List.of("hardware"), jwtResult.getKeyStorage()); | ||
| Assertions.assertNotNull(attestationResult); | ||
| assertEquals(List.of("tpm", "secure_enclave"), attestationResult.getKeyStorage()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetAttestationRequirements_ReturnsNullWhenProofTypeEntryHasNoAttestationRequired() { | ||
| VCIssuanceContext ctx = new VCIssuanceContext(); | ||
| SupportedCredentialConfiguration config = new SupportedCredentialConfiguration(); | ||
| ProofTypesSupported proofTypesSupported = new ProofTypesSupported(); | ||
| proofTypesSupported.getSupportedProofTypes().put(ProofType.JWT, | ||
| new SupportedProofTypeData(List.of("ES256"), null)); | ||
| config.setProofTypesSupported(proofTypesSupported); | ||
| ctx.setCredentialConfig(config); | ||
|
|
||
| KeyAttestationsRequired result = AttestationValidatorUtil.getAttestationRequirements(ctx, ProofType.JWT); | ||
|
|
||
| assertNull(result, "Should return null when the proof type entry has null key_attestations_required"); | ||
| } | ||
|
|
||
| private static VCIssuanceContext createContextWithAttestation( | ||
| KeyAttestationsRequired jwtAttestation, | ||
| KeyAttestationsRequired attestationAttestation) { | ||
| VCIssuanceContext ctx = new VCIssuanceContext(); | ||
| SupportedCredentialConfiguration config = new SupportedCredentialConfiguration(); | ||
| ProofTypesSupported proofTypesSupported = new ProofTypesSupported(); | ||
| Map<String, SupportedProofTypeData> proofTypes = proofTypesSupported.getSupportedProofTypes(); | ||
|
|
||
| if (jwtAttestation != null) { | ||
| proofTypes.put(ProofType.JWT, | ||
| new SupportedProofTypeData(List.of("ES256"), jwtAttestation)); | ||
| } | ||
| if (attestationAttestation != null) { | ||
| proofTypes.put(ProofType.ATTESTATION, | ||
| new SupportedProofTypeData(List.of("ES256"), attestationAttestation)); | ||
| } | ||
|
|
||
| config.setProofTypesSupported(proofTypesSupported); | ||
| ctx.setCredentialConfig(config); | ||
| return ctx; | ||
| } | ||
| } |
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.