jeanouii commented on code in PR #1738: URL: https://github.com/apache/activemq/pull/1738#discussion_r2904059312
########## activemq-jaas/src/main/java/org/apache/activemq/jaas/OAuth2LoginModule.java: ########## @@ -0,0 +1,342 @@ +/** + * 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.activemq.jaas; + +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.security.Principal; +import java.text.ParseException; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.security.auth.Subject; +import javax.security.auth.callback.Callback; +import javax.security.auth.callback.CallbackHandler; +import javax.security.auth.callback.PasswordCallback; +import javax.security.auth.callback.UnsupportedCallbackException; +import javax.security.auth.login.FailedLoginException; +import javax.security.auth.login.LoginException; +import javax.security.auth.spi.LoginModule; + +import com.nimbusds.jose.JOSEException; +import com.nimbusds.jose.JWSAlgorithm; +import com.nimbusds.jose.jwk.source.JWKSource; +import com.nimbusds.jose.jwk.source.JWKSourceBuilder; +import com.nimbusds.jose.proc.BadJOSEException; +import com.nimbusds.jose.proc.JWSKeySelector; +import com.nimbusds.jose.proc.JWSVerificationKeySelector; +import com.nimbusds.jose.proc.SecurityContext; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.jwt.proc.ConfigurableJWTProcessor; +import com.nimbusds.jwt.proc.DefaultJWTClaimsVerifier; +import com.nimbusds.jwt.proc.DefaultJWTProcessor; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A JAAS LoginModule that authenticates users via OAuth2 JWT access tokens. + * <p> + * The client passes the JWT access token as the password in the connection info. + * The module validates the token signature using the JWKS endpoint and verifies + * standard claims (issuer, audience, expiration). + * <p> + * Configuration options (in login.config): + * <ul> + * <li>{@code oauth2.jwksUrl} (required) - URL to the JWKS endpoint for signature verification</li> + * <li>{@code oauth2.issuer} (required) - Expected token issuer (iss claim)</li> + * <li>{@code oauth2.audience} (optional) - Expected token audience (aud claim)</li> + * <li>{@code oauth2.usernameClaim} (optional, default: "sub") - JWT claim to use as username</li> + * <li>{@code oauth2.groupsClaim} (optional, default: "groups") - JWT claim containing group memberships</li> + * <li>{@code debug} (optional) - Enable debug logging</li> + * </ul> + * <p> + * Example login.config: + * <pre> + * activemq-oauth2 { + * org.apache.activemq.jaas.OAuth2LoginModule required + * oauth2.jwksUrl="https://idp.example.com/.well-known/jwks.json"; + * oauth2.issuer="https://idp.example.com"; + * oauth2.audience="activemq" + * oauth2.usernameClaim="preferred_username" + * oauth2.groupsClaim="roles"; + * }; + * </pre> + */ +public class OAuth2LoginModule implements LoginModule { + + private static final Logger LOG = LoggerFactory.getLogger(OAuth2LoginModule.class); + + static final String JWKS_URL_OPTION = "oauth2.jwksUrl"; + static final String ISSUER_OPTION = "oauth2.issuer"; + static final String AUDIENCE_OPTION = "oauth2.audience"; + static final String USERNAME_CLAIM_OPTION = "oauth2.usernameClaim"; + static final String GROUPS_CLAIM_OPTION = "oauth2.groupsClaim"; + + private static final String DEFAULT_USERNAME_CLAIM = "sub"; + private static final String DEFAULT_GROUPS_CLAIM = "groups"; + + private Subject subject; + private CallbackHandler callbackHandler; + private boolean debug; + + private String jwksUrl; + private String issuer; + private String audience; + private String usernameClaim; + private String groupsClaim; + + private String user; + private final Set<Principal> principals = new HashSet<>(); + private boolean succeeded; + private boolean commitSucceeded; + + private ConfigurableJWTProcessor<SecurityContext> jwtProcessor; + + @Override + public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> options) { + this.subject = subject; + this.callbackHandler = callbackHandler; + this.succeeded = false; + this.debug = Boolean.parseBoolean((String) options.get("debug")); + + this.jwksUrl = (String) options.get(JWKS_URL_OPTION); + this.issuer = (String) options.get(ISSUER_OPTION); + this.audience = (String) options.get(AUDIENCE_OPTION); + + String userClaim = (String) options.get(USERNAME_CLAIM_OPTION); + this.usernameClaim = (userClaim != null && !userClaim.isEmpty()) ? userClaim : DEFAULT_USERNAME_CLAIM; + + String grpClaim = (String) options.get(GROUPS_CLAIM_OPTION); + this.groupsClaim = (grpClaim != null && !grpClaim.isEmpty()) ? grpClaim : DEFAULT_GROUPS_CLAIM; + + if (debug) { + LOG.debug("OAuth2LoginModule initialized with jwksUrl={}, issuer={}, audience={}, usernameClaim={}, groupsClaim={}", + jwksUrl, issuer, audience, usernameClaim, groupsClaim); + } + } + + @Override + public boolean login() throws LoginException { + if (jwksUrl == null || jwksUrl.isEmpty()) { Review Comment: I think if this is required, it could go in the init. No need to let the broker start and login module initialize if we know upfront it will fail at login, generating tons of similar exceptions. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information, visit: https://activemq.apache.org/contact
