kirktrue commented on a change in pull request #11284: URL: https://github.com/apache/kafka/pull/11284#discussion_r733897632
########## File path: clients/src/main/java/org/apache/kafka/common/security/oauthbearer/secured/ValidatorAccessTokenValidator.java ########## @@ -0,0 +1,209 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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 org.apache.kafka.common.security.oauthbearer.secured; + +import static org.jose4j.jwa.AlgorithmConstraints.DISALLOW_NONE; + +import java.util.Collection; +import java.util.Collections; +import java.util.Set; +import org.apache.kafka.common.security.oauthbearer.OAuthBearerToken; +import org.jose4j.jwt.JwtClaims; +import org.jose4j.jwt.MalformedClaimException; +import org.jose4j.jwt.NumericDate; +import org.jose4j.jwt.ReservedClaimNames; +import org.jose4j.jwt.consumer.InvalidJwtException; +import org.jose4j.jwt.consumer.JwtConsumer; +import org.jose4j.jwt.consumer.JwtConsumerBuilder; +import org.jose4j.jwt.consumer.JwtContext; +import org.jose4j.keys.resolvers.VerificationKeyResolver; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * ValidatorAccessTokenValidator is an implementation of {@link AccessTokenValidator} that is used + * by the broker to perform more extensive validation of the JWT access token that is received + * from the client, but ultimately from posting the client credentials to the OAuth/OIDC provider's + * token endpoint. + * + * The validation steps performed (primary by the jose4j library) are: + * + * <ol> + * <li> + * Basic structural validation of the <code>b64token</code> value as defined in + * <a href="https://tools.ietf.org/html/rfc6750#section-2.1";>RFC 6750 Section 2.1</a> + * </li> + * <li>Basic conversion of the token into an in-memory data structure</li> + * <li> + * Presence of scope, <code>exp</code>, subject, <code>iss</code>, and + * <code>iat</code> claims + * </li> + * <li> + * Signature matching validation against the <code>kid</code> and those provided b + * the OAuth/OIDC provider's JWKS + * </li> + * </ol> + */ + +public class ValidatorAccessTokenValidator implements AccessTokenValidator { + + private static final Logger log = LoggerFactory.getLogger(ValidatorAccessTokenValidator.class); + + private final JwtConsumer jwtConsumer; + + private final String scopeClaimName; + + private final String subClaimName; + + /** + * Creates a new ValidatorAccessTokenValidator that will be used by the broker for more + * thorough validation of the JWT. + * + * @param clockSkew The optional value (in seconds) to allow for differences + * between the time of the OAuth/OIDC identity provider and + * the broker. If <code>null</code> is provided, the broker + * and the OAUth/OIDC identity provider are assumed to have + * very close clock settings. + * @param expectedAudiences The (optional) set the broker will use to verify that + * the JWT was issued for one of the expected audiences. + * The JWT will be inspected for the standard OAuth + * <code>aud</code> claim and if this value is set, the + * broker will match the value from JWT's <code>aud</code> + * claim to see if there is an exact match. If there is no + * match, the broker will reject the JWT and authentication + * will fail. May be <code>null</code> to not perform an Review comment: Completed the thought so that it now reads: ``` May be <code>null</code> to not perform any check to verify the JWT's audience matches any fixed set of known/expected audiences. ``` Thanks for catching that. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
