Skip to content

fix: skip unsupported keys when loading JWK set in IdTokenVerifier #1176

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.

Sign up for GitHub

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
arib06 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: skip unsupported keys when loading JWK set in IdTokenVerifier #1176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion ...-oauth-client/src/main/java/com/google/api/client/auth/openidconnect/IdTokenVerifier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,10 @@ public Map<String, PublicKey> load(String certificateUrl) throws Exception {
} else {
for (JsonWebKey key : jwks.keys) {
try {
keyCacheBuilder.put(key.kid, buildPublicKey(key));
PublicKey publicKey = buildPublicKey(key);
if (publicKey != null && key.kid != null) {
keyCacheBuilder.put(key.kid, publicKey);
}
} catch (NoSuchAlgorithmException
| InvalidKeySpecException
| InvalidParameterSpecException ignored) {
Expand Down
20 changes: 20 additions & 0 deletions ...th-client/src/test/java/com/google/api/client/auth/openidconnect/IdTokenVerifierTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,26 @@ public void testVerifyRs256Token() throws IOException {
assertTrue(tokenVerifier.verify(IdToken.parse(JSON_FACTORY, FEDERATED_SIGNON_RS256_TOKEN)));
}

public void testVerifyRs256TokenSkipsUnsupportedKeyInKeySet() throws IOException {
// A JWK Set may legitimately contain a key this client cannot build a PublicKey from, e.g. a
// key whose algorithm is not RS256/ES256. That key must be skipped so the remaining valid keys
// are still usable, instead of aborting the whole key set.
String unsupportedKey =
"{\"kid\":\"unsupported\",\"kty\":\"oct\",\"alg\":\"HS256\",\"k\":\"c2VjcmV0\"},";
String keysWithUnsupportedKey =
readResourceAsString("federated_keys.json")
.replace("\"keys\": [", "\"keys\": [" + unsupportedKey);
HttpTransportFactory httpTransportFactory =
mockTransport("https://www.googleapis.com/oauth2/v3/certs", keysWithUnsupportedKey);
MockClock clock = new MockClock(1587625988000L);
IdTokenVerifier tokenVerifier =
new IdTokenVerifier.Builder()
.setClock(clock)
.setHttpTransportFactory(httpTransportFactory)
.build();
assertTrue(tokenVerifier.verify(IdToken.parse(JSON_FACTORY, FEDERATED_SIGNON_RS256_TOKEN)));
}

public void testVerifyRs256TokenWithLegacyCertificateUrlFormat()
throws IOException, VerificationException {
HttpTransportFactory httpTransportFactory =
Expand Down
Loading