fish.payara.microprofile.jwtauth.cdi.JwtAuthCdiExtension Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2017-2021 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package fish.payara.microprofile.jwtauth.cdi;
import fish.payara.microprofile.jwtauth.eesecurity.JWTAuthenticationMechanism;
import fish.payara.microprofile.jwtauth.eesecurity.SignedJWTIdentityStore;
import jakarta.annotation.security.RolesAllowed;
import jakarta.enterprise.context.SessionScoped;
import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.spi.AfterBeanDiscovery;
import jakarta.enterprise.inject.spi.Annotated;
import jakarta.enterprise.inject.spi.Bean;
import jakarta.enterprise.inject.spi.BeanManager;
import jakarta.enterprise.inject.spi.BeforeBeanDiscovery;
import jakarta.enterprise.inject.spi.DeploymentException;
import jakarta.enterprise.inject.spi.Extension;
import jakarta.enterprise.inject.spi.InjectionPoint;
import jakarta.enterprise.inject.spi.ProcessBean;
import jakarta.enterprise.inject.spi.ProcessInjectionTarget;
import jakarta.enterprise.inject.spi.ProcessManagedBean;
import jakarta.enterprise.inject.spi.ProcessSessionBean;
import org.eclipse.microprofile.auth.LoginConfig;
import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.ConfigProvider;
import org.eclipse.microprofile.jwt.Claim;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import static org.eclipse.microprofile.jwt.Claims.UNKNOWN;
import static org.eclipse.microprofile.jwt.config.Names.VERIFIER_PUBLIC_KEY;
import static org.eclipse.microprofile.jwt.config.Names.VERIFIER_PUBLIC_KEY_LOCATION;
/**
* This CDI extension installs the {@link JWTAuthenticationMechanism} and related {@link SignedJWTIdentityStore}
* when the LoginConfig annotation is encountered (MP-JWT 1.0 5).
*
*
* Additionally this extension checks that injection of claims are in the right scope (non-transitively, 7.1.3).
*
* @author Arjan Tijms
*/
public class JwtAuthCdiExtension implements Extension {
/**
* Tracks whether a LoginConfig annotation has been encountered and thus
* a mechanism needs to be installed.
*/
private boolean addJWTAuthenticationMechanism;
private final Set roles = new HashSet<>();
public void register(@Observes BeforeBeanDiscovery beforeBean, BeanManager beanManager) {
beforeBean.addAnnotatedType(beanManager.createAnnotatedType(InjectionPointGenerator.class), "JWT InjectionPointGenerator ");
}
/**
* This method tries to find the LoginConfig annotation and if does flags that fact.
*
*/
public void findLoginConfigAnnotation(@Observes ProcessBean eventIn, BeanManager beanManager) {
ProcessBean event = eventIn; // JDK8 u60 workaround
LoginConfig loginConfig = event.getAnnotated().getAnnotation(LoginConfig.class);
if (loginConfig != null && loginConfig.authMethod().equals("MP-JWT")) {
addJWTAuthenticationMechanism = true;
}
}
/**
* Find all the roles used by the @RolesAllowed annotation, so these can be programmatically
* declared later on.
*
*/
public void findRoles(@Observes ProcessManagedBean eventIn, BeanManager beanManager) {
ProcessManagedBean event = eventIn; // JDK8 u60 workaround
if (event instanceof ProcessSessionBean) {
// @RolesAllowed on session beans is already handled
return;
}
List annotatedElements = new ArrayList<>(event.getAnnotatedBeanClass().getMethods());
annotatedElements.add(event.getAnnotatedBeanClass());
for (Annotated annotated : annotatedElements) {
RolesAllowed rolesAllowed = annotated.getAnnotation(RolesAllowed.class);
if (rolesAllowed != null) {
roles.addAll(Arrays.asList(rolesAllowed.value()));
}
}
}
public void checkInjectIntoRightScope(@Observes ProcessInjectionTarget eventIn, BeanManager beanManager) {
ProcessInjectionTarget event = eventIn; // JDK8 u60 workaround
for (InjectionPoint injectionPoint : event.getInjectionTarget().getInjectionPoints()) {
Claim claim = hasClaim(injectionPoint);
if (claim != null) {
// MP-JWT 1.0 7.1.3.
Bean bean = injectionPoint.getBean();
Class scope = bean != null ? injectionPoint.getBean().getScope() : null;
if (scope != null && scope.equals(SessionScoped.class)) {
throw new DeploymentException(
"Can't inject using qualifier " + Claim.class + " in a target with scope " + scope);
}
if (!claim.value().equals("") && claim.standard() != UNKNOWN && !claim.value().equals(claim.standard().name())) {
throw new DeploymentException(
"Claim value " + claim.value() + " should be equal to claim standard " + claim.standard().name() +
" or one of those should be left at their default value");
}
}
}
}
public void installMechanismIfNeeded(@Observes AfterBeanDiscovery eventIn, BeanManager beanManager) {
AfterBeanDiscovery afterBeanDiscovery = eventIn; // JDK8 u60 workaround
if (addJWTAuthenticationMechanism) {
validateConfigValue();
CdiInitEventHandler.installAuthenticationMechanism(afterBeanDiscovery);
}
}
private void validateConfigValue() {
Config config = ConfigProvider.getConfig();
if (config.getOptionalValue(VERIFIER_PUBLIC_KEY, String.class).isPresent()
&& config.getOptionalValue(VERIFIER_PUBLIC_KEY_LOCATION, String.class).isPresent()) {
throw new DeploymentException(
"Both properties mp.jwt.verify.publickey and mp.jwt.verify.publickey.location must not be defined"
);
}
}
public Set getRoles() {
return roles;
}
public boolean isAddJWTAuthenticationMechanism() {
return addJWTAuthenticationMechanism;
}
private static Claim hasClaim(InjectionPoint injectionPoint) {
for (Annotation qualifier : injectionPoint.getQualifiers()) {
if (qualifier.annotationType().equals(Claim.class)) {
return (Claim) qualifier;
}
}
return null;
}
}