org.apache.cxf.interceptor.security.AbstractAuthorizingInInterceptor Maven / Gradle / Ivy
/**
* 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.cxf.interceptor.security;
import java.lang.reflect.Method;
import java.util.Collections;
import java.util.List;
import java.util.logging.Logger;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.frontend.MethodDispatcher;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.message.Message;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.apache.cxf.security.SecurityContext;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.model.BindingOperationInfo;
public abstract class AbstractAuthorizingInInterceptor extends AbstractPhaseInterceptor {
private static final Logger LOG = LogUtils.getL7dLogger(AbstractAuthorizingInInterceptor.class);
private static final String ALL_ROLES = "*";
public AbstractAuthorizingInInterceptor() {
super(Phase.PRE_INVOKE);
}
public void handleMessage(Message message) throws Fault {
SecurityContext sc = message.get(SecurityContext.class);
if (sc == null) {
return;
}
Method method = getTargetMethod(message);
if (authorize(sc, method)) {
return;
}
throw new AccessDeniedException("Unauthorized");
}
protected Method getTargetMethod(Message m) {
BindingOperationInfo bop = m.getExchange().get(BindingOperationInfo.class);
if (bop != null) {
MethodDispatcher md = (MethodDispatcher)
m.getExchange().get(Service.class).get(MethodDispatcher.class.getName());
return md.getMethod(bop);
}
Method method = (Method)m.get("org.apache.cxf.resource.method");
if (method != null) {
return method;
}
throw new AccessDeniedException("Method is not available : Unauthorized");
}
protected boolean authorize(SecurityContext sc, Method method) {
List expectedRoles = getExpectedRoles(method);
if (expectedRoles.isEmpty()) {
List denyRoles = getDenyRoles(method);
return denyRoles.isEmpty() ? true : isUserInRole(sc, denyRoles, true);
}
if (isUserInRole(sc, expectedRoles, false)) {
return true;
}
if (sc.getUserPrincipal() != null) {
LOG.fine(sc.getUserPrincipal().getName() + " is not authorized");
}
return false;
}
protected boolean isUserInRole(SecurityContext sc, List roles, boolean deny) {
if (roles.size() == 1 && ALL_ROLES.equals(roles.get(0))) {
return !deny;
}
for (String role : roles) {
if (sc.isUserInRole(role)) {
return !deny;
}
}
return deny;
}
/**
* Returns a list of expected roles for a given method.
* @param method Method
* @return list, empty if no roles are available
*/
protected abstract List getExpectedRoles(Method method);
/**
* Returns a list of roles to be denied for a given method.
* @param method Method
* @return list, empty if no roles are available
*/
protected List getDenyRoles(Method method) {
return Collections.emptyList();
}
}