[java-oidc-common] branch main updated: JCOMOIDC-55 - Add auth_time validator activation condition
Phil Smart
philip.smart at jisc.ac.uk
Thu Dec 15 12:13:33 UTC 2022
This is an automated email from the git hooks/post-receive script.
philsmart pushed a commit to branch main
in repository java-oidc-common.
View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=723ef7d1c5e9e56d10e8ffc9d9d14689daa84f40
The following commit(s) were added to refs/heads/main by this push:
new 723ef7d JCOMOIDC-55 - Add auth_time validator activation condition
723ef7d is described below
commit 723ef7d1c5e9e56d10e8ffc9d9d14689daa84f40
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Thu Dec 15 12:13:31 2022 +0000
JCOMOIDC-55 - Add auth_time validator activation condition
https://shibboleth.atlassian.net/browse/JCOMOIDC-55
---
.../impl/AuthTimeRequestedActivationCondition.java | 101 ++++++++++++++
.../AuthTimeRequestedActivationConditionTest.java | 150 +++++++++++++++++++++
2 files changed, 251 insertions(+)
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/AuthTimeRequestedActivationCondition.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/AuthTimeRequestedActivationCondition.java
new file mode 100644
index 0000000..9d8e930
--- /dev/null
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jwt/claims/impl/AuthTimeRequestedActivationCondition.java
@@ -0,0 +1,101 @@
+/*
+ * Licensed to the University Corporation for Advanced Internet Development,
+ * Inc. (UCAID) under one or more contributor license agreements. See the
+ * NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The UCAID licenses this file to You 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 net.shibboleth.oidc.security.jwt.claims.impl;
+
+import java.util.function.BiPredicate;
+import java.util.function.Function;
+
+import javax.annotation.Nonnull;
+
+import org.opensaml.profile.context.ProfileRequestContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.nimbusds.jwt.JWTClaimsSet;
+import com.nimbusds.openid.connect.sdk.OIDCClaimsRequest;
+import com.nimbusds.openid.connect.sdk.claims.ClaimRequirement;
+import com.nimbusds.openid.connect.sdk.claims.ClaimsSetRequest;
+import com.nimbusds.openid.connect.sdk.claims.ClaimsSetRequest.Entry;
+
+import net.shibboleth.oidc.profile.core.OIDCAuthenticationRequest;
+import net.shibboleth.utilities.java.support.annotation.ParameterName;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+
+/**
+ * Has the auth_time claim been requested?
+ *
+ * <p>Either via an explicit 'auth_time' claim request, or because the 'max_age' parameter was used.</p>
+ *
+ * <p>If the 'auth_time' claim was requested but as voluntary, check the claim exists in the claims set.</p>
+ */
+public final class AuthTimeRequestedActivationCondition implements BiPredicate<ProfileRequestContext, JWTClaimsSet> {
+
+ /** Class logger. */
+ @Nonnull private final Logger log = LoggerFactory.getLogger(AuthTimeRequestedActivationCondition.class);
+
+ /** Strategy to find the authentication request.*/
+ @Nonnull private final
+ Function<ProfileRequestContext, OIDCAuthenticationRequest> authenticationRequestLookupStrategy;
+
+ public AuthTimeRequestedActivationCondition(@ParameterName(name = "authenticationRequestLookupStrategy")
+ @Nonnull final Function<ProfileRequestContext, OIDCAuthenticationRequest> strategy) {
+ authenticationRequestLookupStrategy = Constraint.isNotNull(strategy,
+ "authenticationRequestLookupStrategy can not be null");
+ }
+
+ @Override
+ public boolean test(@Nonnull final ProfileRequestContext prc, @Nonnull final JWTClaimsSet claims) {
+
+ final OIDCAuthenticationRequest authRequest = authenticationRequestLookupStrategy.apply(prc);
+
+ if (authRequest == null) {
+ // If we can not make a sensible decision, just return true to check the claim.
+ // Should never happen.
+ log.warn("Authentication request not found in profile context, is the authenticationRequestLookupStrategy "
+ + "configured correctly? The 'auth_time' is now active");
+ return true;
+ }
+
+ if (authRequest.getMaxAge() != null) {
+ return true;
+ }
+ final OIDCClaimsRequest requestedClaims = authRequest.getRequestedClaims();
+ if (requestedClaims != null) {
+ final ClaimsSetRequest idTokenRequested = requestedClaims.getIDTokenClaimsRequest();
+ if (idTokenRequested == null) {
+ // Is not requested, so do not test
+ return false;
+ }
+ final Entry authTime = idTokenRequested.get("auth_time");
+ if (authTime != null) {
+ if (authTime.getClaimRequirement() == ClaimRequirement.ESSENTIAL) {
+ // Is essential, so we should check it even if it does not exist in the claims
+ return true;
+ }
+ if (authTime.getClaimRequirement() == ClaimRequirement.VOLUNTARY) {
+ // Is voluntary, so check if it exists in the returned claims. If it does, make sure to check it.
+ return claims.getClaim("auth_time") != null;
+ }
+ }
+ }
+
+ // Default is false if no reason it would have been requested
+ return false;
+ }
+
+}
diff --git a/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/AuthTimeRequestedActivationConditionTest.java b/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/AuthTimeRequestedActivationConditionTest.java
new file mode 100644
index 0000000..b5bfb6d
--- /dev/null
+++ b/oidc-common-crypto-impl/src/test/java/net/shibboleth/oidc/security/jwt/claims/impl/AuthTimeRequestedActivationConditionTest.java
@@ -0,0 +1,150 @@
+
+package net.shibboleth.oidc.security.jwt.claims.impl;
+
+import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertTrue;
+
+import java.time.Duration;
+
+import javax.annotation.Nonnull;
+
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import com.nimbusds.jwt.JWTClaimsSet;
+import com.nimbusds.oauth2.sdk.id.ClientID;
+import com.nimbusds.openid.connect.sdk.OIDCClaimsRequest;
+import com.nimbusds.openid.connect.sdk.claims.ClaimRequirement;
+import com.nimbusds.openid.connect.sdk.claims.ClaimsSetRequest;
+
+import net.shibboleth.oidc.jwt.claims.JWTValidationException;
+import net.shibboleth.oidc.profile.core.OIDCAuthenticationRequest;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+
+public class AuthTimeRequestedActivationConditionTest extends AbstractClaimsValidatorTest {
+
+ /** The validator to test.*/
+ @Nonnull private AuthTimeRequestedActivationCondition condition;
+
+
+ @Override
+ @BeforeMethod
+ public void setup() throws ComponentInitializationException {
+ super.setup();
+
+ }
+
+ @Test
+ public void testRequired_AuthTimeNotRequested() throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertFalse(authTimeRequest);
+ }
+
+ @Test
+ public void testRequired_AuthTimeRequestedViaMaxAge() throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+ request.setMaxAge(Duration.ofSeconds(60));
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertTrue(authTimeRequest);
+ }
+
+ @Test
+ public void testRequired_AuthTimeRequestedViaEssentialClaim() throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+
+ final ClaimsSetRequest idTokenClaimsRequest =
+ new ClaimsSetRequest().add(new ClaimsSetRequest.Entry("auth_time").withClaimRequirement(ClaimRequirement.ESSENTIAL));
+
+ final OIDCClaimsRequest requested = new OIDCClaimsRequest().withIDTokenClaimsRequest(idTokenClaimsRequest);
+ request.setRequestedClaims(requested);
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertTrue(authTimeRequest);
+ }
+
+ @Test
+ public void testRequired_AuthTimeRequestedViaVoluntaryClaim_IncludedInClaims()
+ throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+
+ final ClaimsSetRequest idTokenClaimsRequest =
+ new ClaimsSetRequest().add(
+ new ClaimsSetRequest.Entry("auth_time").withClaimRequirement(ClaimRequirement.VOLUNTARY));
+
+ final OIDCClaimsRequest requested = new OIDCClaimsRequest().withIDTokenClaimsRequest(idTokenClaimsRequest);
+ request.setRequestedClaims(requested);
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client")
+ .claim("auth_time", "9999").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertTrue(authTimeRequest);
+ }
+
+ @Test
+ public void testNotRequired_AuthTimeRequestedViaVoluntaryClaim_NotIncludedInClaims()
+ throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+
+ final ClaimsSetRequest idTokenClaimsRequest =
+ new ClaimsSetRequest().add(
+ new ClaimsSetRequest.Entry("auth_time").withClaimRequirement(ClaimRequirement.VOLUNTARY));
+
+ final OIDCClaimsRequest requested = new OIDCClaimsRequest().withIDTokenClaimsRequest(idTokenClaimsRequest);
+ request.setRequestedClaims(requested);
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertFalse(authTimeRequest);
+ }
+
+ @Test
+ public void testNotRequired_NoMaxAge_NoAuthTimeRequest()
+ throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertFalse(authTimeRequest);
+ }
+
+ @Test
+ public void testNotRequired_RequestedClaimsWithoutIdTokenRequested()
+ throws JWTValidationException, ComponentInitializationException {
+
+ final OIDCAuthenticationRequest request = new OIDCAuthenticationRequest(new ClientID("mock-client"));
+ final OIDCClaimsRequest requested = new OIDCClaimsRequest();
+ request.setRequestedClaims(requested);
+
+ condition = new AuthTimeRequestedActivationCondition((prc) -> request);
+
+ final JWTClaimsSet claimsSet = new JWTClaimsSet.Builder().audience("mock-client").build();
+ final boolean authTimeRequest = condition.test(prc, claimsSet);
+
+ assertFalse(authTimeRequest);
+ }
+
+}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list