/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.aspects.security;
import java.security.Principal;
import java.util.HashSet;
import java.util.Set;
import org.jboss.aop.joinpoint.Invocation;
import org.jboss.logging.Logger;
import org.jboss.security.AnybodyPrincipal;
import org.jboss.security.AuthenticationManager;
import org.jboss.security.AuthorizationManager;
import org.jboss.security.NobodyPrincipal;
import org.jboss.security.RealmMapping;
import org.jboss.security.RunAsIdentity;
import org.jboss.security.SimplePrincipal;
/**
* The RoleBasedAuthorizationInterceptor checks that the caller principal is authorized to call a method by verifing
* that it contains at least one of the required roled.
*
* @author <a href="bill@jboss.org">Bill Burke</a>
* @author <a href="on@ibis.odessa.ua">Oleg Nitz</a>
* @author <a href="mailto:Scott.Stark@jboss.org">Scott Stark</a>.
* @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>.
* @version $Revision: 46061 $
*/
public class RoleBasedAuthorizationInterceptor implements org.jboss.aop.advice.Interceptor
{
protected Logger log = Logger.getLogger(this.getClass());
protected AuthenticationManager authenticationManager;
protected AuthorizationManager authorizationManager;
protected RealmMapping realmMapping;
/**
* <p>
* Creates an instance of {@code RoleBasedAuthorizationInterceptor} using the specified {@code AuthenticationManager}
* and {@code RealmMapping} implementations.
* </p>
*
* @param manager the {@code AuthenticationManager} instance to be used when the caller hasn't been previously
* authenticated.
* @param realmMapping the {@code RealmMapping} instance to be used to determine if the caller has or has not the
* required roles.
* @deprecated use {@code #RoleBasedAuthorizationInterceptor(AuthenticationManager, AuthorizationManager)} instead.
*/
@Deprecated
public RoleBasedAuthorizationInterceptor(AuthenticationManager manager, RealmMapping realmMapping)
{
this.authenticationManager = manager;
this.realmMapping = realmMapping;
}
/**
* <p>
* Creates an instance of {@code RoleBasedAuthorizationInterceptor} using the specified {@code AuthenticationManager}
* and {@code AuthorizationManager} implementations.
* </p>
*
* @param authManager the {@code AuthenticationManager} instance to be used when the caller hasn't been previously
* authenticated.
* @param authzManager the {@code AuthorizationManager} instance to be used to determine if the caller is authorized
* to access the protected resource. This typically means checking if the caller has been assigned to one
* or more required roles.
*/
public RoleBasedAuthorizationInterceptor(AuthenticationManager authManager, AuthorizationManager authzManager)
{
this.authenticationManager = authManager;
this.authorizationManager = authzManager;
}
/*
* (non-Javadoc)
*
* @see org.jboss.aop.advice.Interceptor#getName()
*/
public String getName()
{
return "RoleBasedAuthorizationInterceptor";
}
/**
* <p>
* Obtains the roles that have access to the method represented by the specified {@code Invocation}.
* </p>
*
* @param invocation the object that contains the metadata of the method being called.
* @return a {@code Set<Principal>} containing the allowed roles.
*/
@SuppressWarnings("unchecked")
protected Set<Principal> getRoleSet(Invocation invocation)
{
Set<Principal> roles = (Set<Principal>) invocation.getMetaData("security", "roles");
if (roles == null)
roles = getAnnotationRoleSet(invocation);
return roles;
}
/**
* <p>
* Obtains the roles that have been specified through annotations from the {@code Invocation} object.
* </p>
*
* @param invocation the object that contains the metadata of the method being called.
* @return a {@code Set<Principal>} containing the roles that have been specified through annotations.
*/
protected Set<Principal> getAnnotationRoleSet(Invocation invocation)
{
Set<Principal> set = new HashSet<Principal>();
Exclude exclude = (Exclude) invocation.resolveAnnotation(Exclude.class);
if (exclude != null)
{
set.add(NobodyPrincipal.NOBODY_PRINCIPAL);
return set;
}
Unchecked unchecked = (Unchecked) invocation.resolveAnnotation(Unchecked.class);
if (unchecked != null)
{
set.add(AnybodyPrincipal.ANYBODY_PRINCIPAL);
return set;
}
Permissions permissions = (Permissions) invocation.resolveAnnotation(Permissions.class);
if (permissions == null)
{
// Default behavior is unchecked
set.add(AnybodyPrincipal.ANYBODY_PRINCIPAL);
return set;
}
for (int i = 0; i < permissions.value().length; i++)
{
set.add(new SimplePrincipal(permissions.value()[i]));
}
return set;
}
/**
* Check if the principal is authorized to call the method by verifying that the it containes at least one of the
* required roles.
*/
public Object invoke(Invocation invocation) throws Throwable
{
// If there is not a security manager then there is no authorization
// required
if (this.authenticationManager == null)
{
return invocation.invokeNext();
}
if (this.authorizationManager == null && realmMapping == null)
{
throw new SecurityException("Authorization manager has not been set");
}
Set<Principal> roles = getRoleSet(invocation);
if (roles == null)
{
/*
* REVISIT: for better message String message = "No method permissions assigned. to " + "method=" +
* invocation.getMethod().getName() + ", interface=" + invocation.getType();
*/
String message = "No method permissions assigned.";
log.error(message);
throw new SecurityException(message);
}
// Check if the caller is allowed to access the method
org.jboss.security.RunAs callerRunAsIdentity = SecurityActions.peekRunAsIdentity();
if (roles.contains(AnybodyPrincipal.ANYBODY_PRINCIPAL) == false)
{
// The caller is using a the caller identity
if (callerRunAsIdentity == null)
{
Principal principal = SecurityActions.getPrincipal();
// Now actually check if the current caller has one of the required method roles
boolean hasRole = this.authorizationManager != null ?
this.authorizationManager.doesUserHaveRole(principal, roles) :
this.realmMapping.doesUserHaveRole(principal, roles);
if (hasRole == false)
{
Set<Principal> userRoles = this.authorizationManager != null ?
this.authorizationManager.getUserRoles(principal) :
this.realmMapping.getUserRoles(principal);
String msg = "Insufficient permissions, principal=" + principal + ", requiredRoles=" + roles
+ ", principalRoles=" + userRoles;
log.error(msg);
throw new SecurityException(msg);
}
}
// The caller is using a run-as identity
else
{
// Check that the run-as role is in the set of method roles
if (callerRunAsIdentity instanceof RunAsIdentity)
{
RunAsIdentity rai = (RunAsIdentity) callerRunAsIdentity;
if (rai.doesUserHaveRole(roles) == false)
{
String msg = "Insufficient permissions, runAsPrincipal=" + rai.getName() + ", requiredRoles=" + roles
+ ", runAsRoles=" + rai.getRunAsRoles();
log.error(msg);
throw new SecurityException(msg);
}
}
else
throw new RuntimeException("Unknown RunAs type");
}
}
return invocation.invokeNext();
}
}