blob: a5353c4fcec59f46a36afbb3c69a4e3cf74117b7 [file] [log] [blame]
/*
* 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.directory.fortress.core.samples;
import org.apache.directory.fortress.core.AdminMgr;
import org.apache.directory.fortress.core.AdminMgrFactory;
import org.apache.directory.fortress.core.GlobalErrIds;
import org.apache.directory.fortress.core.ReviewMgr;
import org.apache.directory.fortress.core.ReviewMgrFactory;
import org.apache.directory.fortress.core.model.PermObj;
import org.apache.directory.fortress.core.model.Permission;
import org.apache.directory.fortress.core.model.Role;
import org.apache.directory.fortress.core.SecurityException;
import org.apache.directory.fortress.core.impl.TestUtils;
import org.apache.directory.fortress.core.model.User;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
/**
* CreatePermSample JUnit Test demonstrates creation of Fortress permissions. It also shows how
* permissions may be granted to Roles and Users.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class CreatePermSample extends TestCase
{
private static final String CLS_NM = CreatePermSample.class.getName();
private static final Logger LOG = LoggerFactory.getLogger( CLS_NM );
public static final String TEST_PERM_OBJECT = "sampleObject1";
public static final String TEST_PERM_OPERATION_PREFIX = "OPER";
/**
* @param name
*/
public CreatePermSample(String name)
{
super(name);
}
/**
* Run the permission test cases.
*
* @return Test
*/
public static Test suite()
{
TestSuite suite = new TestSuite();
if(!AllSamplesJUnitTest.isFirstRun())
{
suite.addTest(new CreatePermSample("testRevokePermissionRole"));
suite.addTest(new CreatePermSample("testDelPermObjects"));
}
suite.addTest(new CreatePermSample("testAddPermObjects"));
suite.addTest(new CreatePermSample("testAddPermOperations"));
suite.addTest(new CreatePermSample("testGrantPermissionRole"));
suite.addTest(new CreatePermSample("testGrantPermissionUser"));
suite.addTest(new CreatePermSample("testRevokePermissionUser"));
return suite;
}
/**
* This test will remove the RBAC Role name associated with a particular Permission Operation node in ldap.
*/
public static void testRevokePermissionRole()
{
String szLocation = ".testRevokePermissionRole";
if(AllSamplesJUnitTest.isFirstRun())
{
return;
}
try
{
// Instantiate the AdminMgr implementation which is used to provision RBAC policies.
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
// Iterate over roles...
for (int i = 1; i < 11; i++)
{
Role inRole = new Role(CreateRoleSample.TEST_ROLE_PREFIX + i);
List<Permission> perms = reviewMgr.rolePermissions(inRole);
for(Permission perm : perms)
{
// This API removes the 'oamRoles' attribute associated with Role from the 'oamOperation' ldap object class:
adminMgr.revokePermission(perm, inRole);
}
}
// Iterate to ensure all Operation entities no longer contain Role assignments (for test purposes only):
for (int j = 1; j < 6; j++)
{
// Permissions contain Object to Operation mapping and once created can then be targeted for assignment to Role entities in ldap:
Permission inPerm = new Permission(TEST_PERM_OBJECT, TEST_PERM_OPERATION_PREFIX + j);
// now retrieve the list of Roles that are still assigned to perm. This should be a null list because of revocation performed above:
List<String> assignedRoles = reviewMgr.permissionRoles(inPerm);
assertTrue(assignedRoles.size() == 0);
LOG.info(szLocation + " permission roles revocation check for object [" + inPerm.getObjName() + "] operation name [" + inPerm.getOpName() + "] revocation success");
}
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
* Removal of Permission Object node from ldap will also remove any child Operation nodes that are located
* directly below.
*/
public static void testDelPermObjects()
{
String szLocation = ".testDelPermObjects";
if(AllSamplesJUnitTest.isFirstRun())
{
return;
}
try
{
// Instantiate the AdminMgr implementation which is used to provision RBAC policies.
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// this will remove the object along with any operations associated with it:
adminMgr.deletePermObj(new PermObj(TEST_PERM_OBJECT, CreatePermOrgSample.TEST_PERM_OU_NM));
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
try
{
// this should fail:
reviewMgr.readPermObj(new PermObj(TEST_PERM_OBJECT));
fail(szLocation + " permission object delete failed");
}
catch (SecurityException se)
{
assertTrue(szLocation + " excep id check", se.getErrorId() == GlobalErrIds.PERM_OBJ_NOT_FOUND);
// pass
}
LOG.info(szLocation + " permission object [" + TEST_PERM_OBJECT + "] success");
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
public static void testDeleteShoppingCartObjects()
{
String szLocation = ".testDeleteShoppingCartObjects";
if(AllSamplesJUnitTest.isFirstRun())
{
return;
}
try
{
// Instantiate the AdminMgr first
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Now Instantiate the Object
PermObj shoppingCart = new PermObj("ShoppingCart", "KillerBikes.com");
// Add it to the directory
adminMgr.deletePermObj(shoppingCart);
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
* The Fortress object entity must be created before operations may be granted. There is a one-to-many
* relationship between objects and operations.
*/
public static void testAddPermObjects()
{
String szLocation = ".testAddPermObjects";
try
{
// Instantiate the AdminMgr implementation which is used to provision RBAC policies.
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Add the PermObj entity to ldap. The PermObj entity must have a name and an OrgUnit affiliation.
adminMgr.addPermObj(new PermObj(TEST_PERM_OBJECT, CreatePermOrgSample.TEST_PERM_OU_NM));
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
// now read the newly created Object entity back:
PermObj outObj = reviewMgr.readPermObj(new PermObj(TEST_PERM_OBJECT));
// Do some validations.
assertNotNull(outObj);
assertTrue(szLocation + " failed obj name check", TEST_PERM_OBJECT.equals(outObj.getObjName()));
assertTrue(szLocation + " failed obj ou check", CreatePermOrgSample.TEST_PERM_OU_NM.equals(outObj.getOu()));
LOG.info(szLocation + " permission object [" + outObj.getObjName() + "] success");
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
*
*/
public static void testAddShoppingCartObjects()
{
String szLocation = ".testAddShoppingCartObjects";
try
{
// Instantiate the AdminMgr first
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Now Instantiate the Object
PermObj shoppingCart = new PermObj("ShoppingCart", "KillerBikes.com");
// Add it to the directory
adminMgr.addPermObj(shoppingCart);
// Now create the permission operations and grant...
Permission create = new Permission(shoppingCart.getObjName(), "create");
adminMgr.addPermission(create);
adminMgr.grantPermission(create, new Role("Customer"));
Permission read = new Permission(shoppingCart.getObjName(), "read");
adminMgr.addPermission(read);
adminMgr.grantPermission(read, new Role("Customer"));
Permission update = new Permission(shoppingCart.getObjName(), "update");
adminMgr.addPermission(update);
adminMgr.grantPermission(update, new Role("Admin"));
Permission delete = new Permission(shoppingCart.getObjName(), "delete");
adminMgr.addPermission(delete);
adminMgr.grantPermission(delete, new Role("Manager"));
Permission checkout = new Permission(shoppingCart.getObjName(), "checkout");
adminMgr.addPermission(checkout);
adminMgr.grantPermission(delete, new Role("Customer"));
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
* The Permission entity contains operation name along with any assigned Role and User entities. The Permission
* ldap node is located as child node of Permission Object node.
*/
public static void testAddPermOperations()
{
String szLocation = ".testAddPermOperations";
try
{
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
for (int i = 1; i < 6; i++)
{
// The Permission entity is associated with PermObj (name) entity and is uniquely identified by Operation name:
Permission inPerm = new Permission(TEST_PERM_OBJECT, TEST_PERM_OPERATION_PREFIX + i);
// The Permission entity will be a child node of specified PermObject entity.
adminMgr.addPermission(inPerm);
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
// now read the newly created Permission entity back.
Permission outPerm = reviewMgr.readPermission(inPerm);
// Do some validations.
assertNotNull(outPerm);
assertTrue(szLocation + " failed permission check", outPerm.equals(inPerm));
LOG.info(szLocation + " permission object [" + outPerm.getObjName() + "] operation name [" + outPerm.getOpName() + "] success");
}
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
* Permissions contain a multi-occurring String attribute that contains the Role name(s) for which it is granted to.
* The checkAccess method will determine if User has been assigned to a Role that Permission has been granted to.
*/
public static void testGrantPermissionRole()
{
String szLocation = ".testGrantPermissionRole";
try
{
// Instantiate the AdminMgr implementation which is used to provision RBAC policies.
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Iterate over roles...
for (int i = 1; i < 11; i++)
{
Role inRole = new Role(CreateRoleSample.TEST_ROLE_PREFIX + i);
for (int j = 1; j < 6; j++)
{
// Permissions contain Object to Operation mapping and once created can then be targeted for assignment to Role entities in ldap:
Permission inPerm = new Permission(TEST_PERM_OBJECT, TEST_PERM_OPERATION_PREFIX + j);
// This API add a 'oamRoles' attribute associated with Role to the 'oamOperation' ldap object class:
adminMgr.grantPermission(inPerm, inRole);
LOG.info(szLocation + " permission role [" + inRole.getName() + "] object [" + inPerm.getObjName() + "] operation name [" + inPerm.getOpName() + "] success");
}
}
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
// Iterate test to ensure that all Roles contain the associated Operation assignments:
for (int i = 1; i < 11; i++)
{
// Create this Role to interrogate the system to return all assigned Operation entities:
Role inRole = new Role(CreateRoleSample.TEST_ROLE_PREFIX + i);
// Read the list of permissions that have been granted to test Role:
List<Permission> assignedPerms = reviewMgr.rolePermissions(inRole);
assertTrue(szLocation + " list check, expected: 5, actual:" + assignedPerms.size(), assignedPerms.size() == 5);
}
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
* Fortress allows Permissions to be granted directly to User entities. Note this is not an RBAC specified
* capability but can otherwise be useful for certain circumstances.
*/
public static void testGrantPermissionUser()
{
String szLocation = ".testGrantPermissionUser";
User inUser = new User(CreateUserSample.TEST_USERID);
try
{
// Instantiate the AdminMgr implementation which is used to provision RBAC policies.
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Iterate over perms...
for (int i = 1; i < 6; i++)
{
// Permissions contain Object to Operation mapping and once created can then be targeted for assignment to User entities in ldap:
Permission inPerm = new Permission(TEST_PERM_OBJECT, TEST_PERM_OPERATION_PREFIX + i);
// This API add a 'oamUsers' attribute associated with User to the 'oamOperation' ldap object class:
adminMgr.grantPermission(inPerm, inUser);
LOG.info(szLocation + " permission user [" + inUser.getUserId() + "] object [" + inPerm.getObjName() + "] operation name [" + inPerm.getOpName() + "] success");
}
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
// Iterate over roles...
for (int i = 1; i < 6; i++)
{
// now read the list of Permissions that have been granted to the test User:
List<Permission> assignedUserPerms = reviewMgr.userPermissions(inUser);
assertTrue(szLocation + " list check, expected: 5, actual:" + assignedUserPerms.size(), assignedUserPerms.size() == 5);
}
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
/**
* Test will remove the associated User attribute from Permission Operation nodes in LDAP.
*/
public static void testRevokePermissionUser()
{
String szLocation = ".testRevokePermissionUser";
if(AllSamplesJUnitTest.isFirstRun())
{
return;
}
User inUser = new User(CreateUserSample.TEST_USERID);
try
{
// Instantiate the AdminMgr implementation which is used to provision RBAC policies.
AdminMgr adminMgr = AdminMgrFactory.createInstance(TestUtils.getContext());
// Iterate over perms...
for (int i = 1; i < 6; i++)
{
// Permissions contain Object to Operation mapping and once created can then be targeted for assignment of User entities in ldap:
Permission inPerm = new Permission(TEST_PERM_OBJECT, TEST_PERM_OPERATION_PREFIX + i);
// This API will remove the 'oamUsers' attribute associated with User in 'oamOperation' ldap object class:
adminMgr.revokePermission(inPerm, inUser);
// Instantiate the ReviewMgr implementation which is used to interrogate policy information.
ReviewMgr reviewMgr = ReviewMgrFactory.createInstance(TestUtils.getContext());
// now read the list of Users that are still granted. This should be a null list because of revocation performed above:
List<String> assignedUsers = reviewMgr.permissionUsers(inPerm);
assertTrue(assignedUsers.size() == 0);
LOG.info(szLocation + " permission user [" + inUser.getUserId() + "] object [" + inPerm.getObjName() + "] operation name [" + inPerm.getOpName() + "] success");
}
}
catch (SecurityException ex)
{
LOG.error(szLocation + " caught SecurityException rc=" + ex.getErrorId() + ", msg=" + ex.getMessage(), ex);
fail(ex.getMessage());
}
}
}