/*
* 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.security.authorization.modules.ejb;
import java.lang.reflect.Method;
import java.security.Principal;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import javax.security.auth.Subject;
import org.jboss.logging.Logger;
import org.jboss.security.AnybodyPrincipal;
import org.jboss.security.RunAs;
import org.jboss.security.RunAsIdentity;
import org.jboss.security.SecurityRoleRef;
import org.jboss.security.authorization.AuthorizationContext;
import org.jboss.security.authorization.PolicyRegistration;
import org.jboss.security.authorization.Resource;
import org.jboss.security.authorization.ResourceKeys;
import org.jboss.security.authorization.modules.AuthorizationModuleDelegate;
import org.jboss.security.authorization.resources.EJBResource;
import org.jboss.security.identity.Role;
import org.jboss.security.identity.RoleGroup;
import org.jboss.security.identity.plugins.SimpleRole;
import org.jboss.security.identity.plugins.SimpleRoleGroup;
//$Id: EJBPolicyModuleDelegate.java 68749 2008-01-09 20:25:39Z anil.saldhana@jboss.com $
/**
* Authorization Module delegate that deals with the authorization decisions
* for the EJB Layer (Default Behavior)
* @author <a href="mailto:Anil.Saldhana@jboss.org">Anil Saldhana</a>
* @since Jul 6, 2006
* @version $Revision: 68749 $
*/
public class EJBPolicyModuleDelegate extends AuthorizationModuleDelegate
{
private String ejbName = null;
private Method ejbMethod = null;
private Principal ejbPrincipal = null;
//private Set<Principal> methodRoles = null;
private RoleGroup methodRoles = null;
private String methodInterface = null;
private RunAs callerRunAs = null;
private String roleName = null;
private Boolean roleRefCheck = Boolean.FALSE;
private Set<SecurityRoleRef> securityRoleReferences = null;
private final Role ANYBODY_ROLE = new SimpleRole(AnybodyPrincipal.ANYBODY);
public EJBPolicyModuleDelegate()
{
log = Logger.getLogger(getClass());
trace = log.isTraceEnabled();
}
/**
* @see AuthorizationModuleDelegate#authorize(Resource)
*/
public int authorize(Resource resource, Subject callerSubject, RoleGroup role)
{
if(resource instanceof EJBResource == false)
throw new IllegalArgumentException("resource is not an EJBResource");
EJBResource ejbResource = (EJBResource) resource;
//Get the context map
Map<String,Object> map = resource.getMap();
if(map == null)
throw new IllegalStateException("Map from the Resource is null");
/*AuthorizationManager am = (AuthorizationManager) map.get("authorizationManager");
if(am == null)
throw new IllegalStateException("Authorization Manager is null");
if(am instanceof PolicyRegistration)
this.policyRegistration = (PolicyRegistration) am; */
this.policyRegistration = (PolicyRegistration) map.get(ResourceKeys.POLICY_REGISTRATION);
this.roleName = (String)map.get(ResourceKeys.ROLENAME);
this.roleRefCheck = (Boolean)map.get(ResourceKeys.ROLEREF_PERM_CHECK);
this.callerRunAs = ejbResource.getCallerRunAsIdentity();
this.ejbMethod = ejbResource.getEjbMethod();
this.ejbName = ejbResource.getEjbName();
this.ejbPrincipal = ejbResource.getPrincipal();
this.methodInterface = ejbResource.getEjbMethodInterface();
this.methodRoles = ejbResource.getEjbMethodRoles();
this.securityRoleReferences = ejbResource.getSecurityRoleReferences();
if(this.roleRefCheck == Boolean.TRUE)
return checkRoleRef(role);
else
return process(role);
}
//Private Methods
/**
* Process the request
* @param request
* @param sc
* @return
*/
private int process(RoleGroup principalRole)
{
boolean allowed = true;
//Get the method permissions
if (methodRoles == null)
{
if(this.ejbMethod == null)
throw new IllegalStateException("ejbMethod is null");
String method = this.ejbMethod.getName();
String msg = "No method permissions assigned to method=" + method
+ ", interface=" + methodInterface;
if(trace)
log.trace("Exception:"+msg);
return AuthorizationContext.DENY;
}
else if (trace)
{
log.trace("method=" + this.ejbMethod + ", interface=" + this.methodInterface
+ ", requiredRoles=" + methodRoles);
}
// Check if the caller is allowed to access the method
if(methodRoles.containsAll(ANYBODY_ROLE) == false)
//if (methodRoles.contains(AnybodyPrincipal.ANYBODY_PRINCIPAL) == false)
{
// The caller is using a the caller identity
if (callerRunAs == null)
{
//AuthorizationManager am = (AuthorizationManager)policyRegistration;
// Now actually check if the current caller has one of the required method roles
if(principalRole == null)
throw new IllegalStateException("Principal Role is null");
if(methodRoles.containsAtleastOneRole(principalRole) == false)
{
if(this.ejbMethod == null)
throw new IllegalStateException("ejbMethod is null");
//Set<Principal> userRoles = am.getUserRoles(ejbPrincipal);
String method = this.ejbMethod.getName();
String msg = "Insufficient method permissions, principal=" + ejbPrincipal
+ ", ejbName=" + this.ejbName
+ ", method=" + method + ", interface=" + this.methodInterface
+ ", requiredRoles=" + methodRoles + ", principalRoles=" + principalRole;
if(trace)
log.trace("Exception:"+msg);
allowed = false;
}
/*// Now actually check if the current caller has one of the required method roles
if (am.doesUserHaveRole(ejbPrincipal, methodRoles) == false)
{
if(this.ejbMethod == null)
throw new IllegalStateException("ejbMethod is null");
Set<Principal> userRoles = am.getUserRoles(ejbPrincipal);
String method = this.ejbMethod.getName();
String msg = "Insufficient method permissions, principal=" + ejbPrincipal
+ ", ejbName=" + this.ejbName
+ ", method=" + method + ", interface=" + this.methodInterface
+ ", requiredRoles=" + methodRoles + ", principalRoles=" + userRoles;
if(trace)
log.trace("Exception:"+msg);
allowed = false;
}*/
}
// The caller is using a run-as identity
else
{
if(callerRunAs instanceof RunAsIdentity)
{
RunAsIdentity callerRunAsIdentity = (RunAsIdentity) callerRunAs;
RoleGroup srg = new SimpleRoleGroup(callerRunAsIdentity.getRunAsRoles());
// Check that the run-as role is in the set of method roles
if(srg.containsAtleastOneRole(methodRoles) == false)
{
String method = this.ejbMethod.getName();
String msg = "Insufficient method permissions, principal=" + ejbPrincipal
+ ", ejbName=" + this.ejbName
+ ", method=" + method + ", interface=" + this.methodInterface
+ ", requiredRoles=" + methodRoles + ", runAsRoles="
+ callerRunAsIdentity.getRunAsRoles();
if(trace)
log.trace("Exception:"+msg);
allowed = false;
}
/*// Check that the run-as role is in the set of method roles
if (callerRunAsIdentity.doesUserHaveRole(methodRoles) == false)
{
String method = this.ejbMethod.getName();
String msg = "Insufficient method permissions, principal=" + ejbPrincipal
+ ", ejbName=" + this.ejbName
+ ", method=" + method + ", interface=" + this.methodInterface
+ ", requiredRoles=" + methodRoles + ", runAsRoles="
+ callerRunAsIdentity.getRunAsRoles();
if(trace)
log.trace("Exception:"+msg);
allowed = false;
}*/
}
}
}
return allowed ? AuthorizationContext.PERMIT : AuthorizationContext.DENY;
}
private int checkRoleRef(RoleGroup principalRole)
{
//AuthorizationManager am = (AuthorizationManager)policyRegistration;
//Check the caller of this beans run-as identity
if (ejbPrincipal == null && callerRunAs == null)
{
if(trace)
log.trace("ejbPrincipal = null,callerRunAsIdentity = null => DENY" );
return AuthorizationContext.DENY;
}
// Map the role name used by Bean Provider to the security role
// link in the deployment descriptor. The EJB 1.1 spec requires
// the security role refs in the descriptor but for backward
// compability we're not enforcing this requirement.
//
// TODO (2.3): add a conditional check using jboss.xml <enforce-ejb-restrictions> element
// which will throw an exception in case no matching
// security ref is found.
boolean matchFound = false;
Iterator<SecurityRoleRef> it = this.securityRoleReferences.iterator();
while ( it.hasNext())
{
SecurityRoleRef meta = it.next();
if (meta.getName().equals(roleName))
{
roleName = meta.getLink();
matchFound = true;
break;
}
}
if (!matchFound)
log.trace("no match found for security role " + roleName +
" in the deployment descriptor for ejb " + this.ejbName);
/*HashSet<Principal> set = new HashSet<Principal>();
set.add(new SimplePrincipal(roleName));*/
Role deploymentrole = new SimpleRole(roleName);
boolean allowed = false;
if (callerRunAs == null)
allowed = principalRole.containsRole(deploymentrole);
//allowed = am.doesUserHaveRole(ejbPrincipal, set);
else
{
if(callerRunAs instanceof RunAsIdentity)
{
RunAsIdentity callerRunAsIdentity = (RunAsIdentity) callerRunAs;
SimpleRoleGroup srg = new SimpleRoleGroup(callerRunAsIdentity.getRunAsRoles());
allowed = srg.containsRole(deploymentrole);
//allowed = callerRunAsIdentity.doesUserHaveRole(set);
}
}
return allowed ? AuthorizationContext.PERMIT : AuthorizationContext.DENY;
}
}