remove unused ACL class
Justin Clark-Casey (justincc)
parent
5b80e3fc18
commit
f393e10ea4
|
|
@ -1,252 +0,0 @@
|
||||||
/*
|
|
||||||
* Copyright (c) Contributors, http://opensimulator.org/
|
|
||||||
* See CONTRIBUTORS.TXT for a full list of copyright holders.
|
|
||||||
*
|
|
||||||
* Redistribution and use in source and binary forms, with or without
|
|
||||||
* modification, are permitted provided that the following conditions are met:
|
|
||||||
* * Redistributions of source code must retain the above copyright
|
|
||||||
* notice, this list of conditions and the following disclaimer.
|
|
||||||
* * Redistributions in binary form must reproduce the above copyright
|
|
||||||
* notice, this list of conditions and the following disclaimer in the
|
|
||||||
* documentation and/or other materials provided with the distribution.
|
|
||||||
* * Neither the name of the OpenSimulator Project nor the
|
|
||||||
* names of its contributors may be used to endorse or promote products
|
|
||||||
* derived from this software without specific prior written permission.
|
|
||||||
*
|
|
||||||
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
|
|
||||||
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
||||||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
|
|
||||||
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
||||||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
||||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
||||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
||||||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
|
|
||||||
namespace OpenSim.Framework
|
|
||||||
{
|
|
||||||
// ACL Class
|
|
||||||
// Modelled after the structure of the Zend ACL Framework Library
|
|
||||||
// with one key difference - the tree will search for all matching
|
|
||||||
// permissions rather than just the first. Deny permissions will
|
|
||||||
// override all others.
|
|
||||||
|
|
||||||
#region ACL Core Class
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Access Control List Engine
|
|
||||||
/// </summary>
|
|
||||||
public class ACL
|
|
||||||
{
|
|
||||||
private Dictionary<string, Resource> Resources = new Dictionary<string, Resource>();
|
|
||||||
private Dictionary<string, Role> Roles = new Dictionary<string, Role>();
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds a new role
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="role"></param>
|
|
||||||
/// <returns></returns>
|
|
||||||
public ACL AddRole(Role role)
|
|
||||||
{
|
|
||||||
if (Roles.ContainsKey(role.Name))
|
|
||||||
throw new AlreadyContainsRoleException(role);
|
|
||||||
|
|
||||||
Roles.Add(role.Name, role);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Adds a new resource
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="resource"></param>
|
|
||||||
/// <returns></returns>
|
|
||||||
public ACL AddResource(Resource resource)
|
|
||||||
{
|
|
||||||
Resources.Add(resource.Name, resource);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Permision for user/roll on a resource
|
|
||||||
/// </summary>
|
|
||||||
/// <param name="role"></param>
|
|
||||||
/// <param name="resource"></param>
|
|
||||||
/// <returns></returns>
|
|
||||||
public Permission HasPermission(string role, string resource)
|
|
||||||
{
|
|
||||||
if (!Roles.ContainsKey(role))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
if (!Resources.ContainsKey(resource))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
return Roles[role].RequestPermission(resource);
|
|
||||||
}
|
|
||||||
|
|
||||||
public ACL GrantPermission(string role, string resource)
|
|
||||||
{
|
|
||||||
if (!Roles.ContainsKey(role))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
if (!Resources.ContainsKey(resource))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
Roles[role].GivePermission(resource, Permission.Allow);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ACL DenyPermission(string role, string resource)
|
|
||||||
{
|
|
||||||
if (!Roles.ContainsKey(role))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
if (!Resources.ContainsKey(resource))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
Roles[role].GivePermission(resource, Permission.Deny);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ACL ResetPermission(string role, string resource)
|
|
||||||
{
|
|
||||||
if (!Roles.ContainsKey(role))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
if (!Resources.ContainsKey(resource))
|
|
||||||
throw new KeyNotFoundException();
|
|
||||||
|
|
||||||
Roles[role].GivePermission(resource, Permission.None);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
|
|
||||||
#region Exceptions
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Thrown when an ACL attempts to add a duplicate role.
|
|
||||||
/// </summary>
|
|
||||||
public class AlreadyContainsRoleException : Exception
|
|
||||||
{
|
|
||||||
protected Role m_role;
|
|
||||||
|
|
||||||
public AlreadyContainsRoleException(Role role)
|
|
||||||
{
|
|
||||||
m_role = role;
|
|
||||||
}
|
|
||||||
|
|
||||||
public Role ErrorRole
|
|
||||||
{
|
|
||||||
get { return m_role; }
|
|
||||||
}
|
|
||||||
|
|
||||||
public override string ToString()
|
|
||||||
{
|
|
||||||
return "This ACL already contains a role called '" + m_role.Name + "'.";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
|
|
||||||
#region Roles and Resources
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Does this Role have permission to access a specified Resource?
|
|
||||||
/// </summary>
|
|
||||||
public enum Permission
|
|
||||||
{
|
|
||||||
Deny,
|
|
||||||
None,
|
|
||||||
Allow
|
|
||||||
} ;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// A role class, for use with Users or Groups
|
|
||||||
/// </summary>
|
|
||||||
public class Role
|
|
||||||
{
|
|
||||||
private string m_name;
|
|
||||||
private Role[] m_parents;
|
|
||||||
private Dictionary<string, Permission> m_resources = new Dictionary<string, Permission>();
|
|
||||||
|
|
||||||
public Role(string name)
|
|
||||||
{
|
|
||||||
m_name = name;
|
|
||||||
m_parents = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
public Role(string name, Role[] parents)
|
|
||||||
{
|
|
||||||
m_name = name;
|
|
||||||
m_parents = parents;
|
|
||||||
}
|
|
||||||
|
|
||||||
public string Name
|
|
||||||
{
|
|
||||||
get { return m_name; }
|
|
||||||
}
|
|
||||||
|
|
||||||
public Permission RequestPermission(string resource)
|
|
||||||
{
|
|
||||||
return RequestPermission(resource, Permission.None);
|
|
||||||
}
|
|
||||||
|
|
||||||
public Permission RequestPermission(string resource, Permission current)
|
|
||||||
{
|
|
||||||
// Deny permissions always override any others
|
|
||||||
if (current == Permission.Deny)
|
|
||||||
return current;
|
|
||||||
|
|
||||||
Permission temp = Permission.None;
|
|
||||||
|
|
||||||
// Pickup non-None permissions
|
|
||||||
if (m_resources.ContainsKey(resource) && m_resources[resource] != Permission.None)
|
|
||||||
temp = m_resources[resource];
|
|
||||||
|
|
||||||
if (m_parents != null)
|
|
||||||
{
|
|
||||||
foreach (Role parent in m_parents)
|
|
||||||
{
|
|
||||||
temp = parent.RequestPermission(resource, temp);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return temp;
|
|
||||||
}
|
|
||||||
|
|
||||||
public void GivePermission(string resource, Permission perm)
|
|
||||||
{
|
|
||||||
m_resources[resource] = perm;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public class Resource
|
|
||||||
{
|
|
||||||
private string m_name;
|
|
||||||
|
|
||||||
public Resource(string name)
|
|
||||||
{
|
|
||||||
m_name = name;
|
|
||||||
}
|
|
||||||
|
|
||||||
public string Name
|
|
||||||
{
|
|
||||||
get { return m_name; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -1,125 +0,0 @@
|
||||||
/*
|
|
||||||
* Copyright (c) Contributors, http://opensimulator.org/
|
|
||||||
* See CONTRIBUTORS.TXT for a full list of copyright holders.
|
|
||||||
*
|
|
||||||
* Redistribution and use in source and binary forms, with or without
|
|
||||||
* modification, are permitted provided that the following conditions are met:
|
|
||||||
* * Redistributions of source code must retain the above copyright
|
|
||||||
* notice, this list of conditions and the following disclaimer.
|
|
||||||
* * Redistributions in binary form must reproduce the above copyright
|
|
||||||
* notice, this list of conditions and the following disclaimer in the
|
|
||||||
* documentation and/or other materials provided with the distribution.
|
|
||||||
* * Neither the name of the OpenSimulator Project nor the
|
|
||||||
* names of its contributors may be used to endorse or promote products
|
|
||||||
* derived from this software without specific prior written permission.
|
|
||||||
*
|
|
||||||
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
|
|
||||||
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
||||||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
|
|
||||||
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
||||||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
||||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
||||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
||||||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
using System;
|
|
||||||
using NUnit.Framework;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
|
|
||||||
|
|
||||||
namespace OpenSim.Framework.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public class ACLTest
|
|
||||||
{
|
|
||||||
#region Tests
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// ACL Test class
|
|
||||||
/// </summary>
|
|
||||||
[Test]
|
|
||||||
public void ACLTest01()
|
|
||||||
{
|
|
||||||
ACL acl = new ACL();
|
|
||||||
|
|
||||||
Role Guests = new Role("Guests");
|
|
||||||
acl.AddRole(Guests);
|
|
||||||
|
|
||||||
Role[] parents = new Role[1];
|
|
||||||
parents[0] = Guests;
|
|
||||||
|
|
||||||
Role JoeGuest = new Role("JoeGuest", parents);
|
|
||||||
acl.AddRole(JoeGuest);
|
|
||||||
|
|
||||||
Resource CanBuild = new Resource("CanBuild");
|
|
||||||
acl.AddResource(CanBuild);
|
|
||||||
|
|
||||||
|
|
||||||
acl.GrantPermission("Guests", "CanBuild");
|
|
||||||
|
|
||||||
Permission perm = acl.HasPermission("JoeGuest", "CanBuild");
|
|
||||||
Assert.That(perm == Permission.Allow, "JoeGuest should have permission to build");
|
|
||||||
perm = Permission.None;
|
|
||||||
try
|
|
||||||
{
|
|
||||||
perm = acl.HasPermission("unknownGuest", "CanBuild");
|
|
||||||
|
|
||||||
}
|
|
||||||
catch (KeyNotFoundException)
|
|
||||||
{
|
|
||||||
|
|
||||||
|
|
||||||
}
|
|
||||||
catch (Exception)
|
|
||||||
{
|
|
||||||
Assert.That(false,"Exception thrown should have been KeyNotFoundException");
|
|
||||||
}
|
|
||||||
Assert.That(perm == Permission.None,"Permission None should be set because exception should have been thrown");
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void KnownButPermissionDenyAndPermissionNoneUserTest()
|
|
||||||
{
|
|
||||||
ACL acl = new ACL();
|
|
||||||
|
|
||||||
Role Guests = new Role("Guests");
|
|
||||||
acl.AddRole(Guests);
|
|
||||||
Role Administrators = new Role("Administrators");
|
|
||||||
acl.AddRole(Administrators);
|
|
||||||
Role[] Guestparents = new Role[1];
|
|
||||||
Role[] Adminparents = new Role[1];
|
|
||||||
|
|
||||||
Guestparents[0] = Guests;
|
|
||||||
Adminparents[0] = Administrators;
|
|
||||||
|
|
||||||
Role JoeGuest = new Role("JoeGuest", Guestparents);
|
|
||||||
acl.AddRole(JoeGuest);
|
|
||||||
|
|
||||||
Resource CanBuild = new Resource("CanBuild");
|
|
||||||
acl.AddResource(CanBuild);
|
|
||||||
|
|
||||||
Resource CanScript = new Resource("CanScript");
|
|
||||||
acl.AddResource(CanScript);
|
|
||||||
|
|
||||||
Resource CanRestart = new Resource("CanRestart");
|
|
||||||
acl.AddResource(CanRestart);
|
|
||||||
|
|
||||||
acl.GrantPermission("Guests", "CanBuild");
|
|
||||||
acl.DenyPermission("Guests", "CanRestart");
|
|
||||||
|
|
||||||
acl.GrantPermission("Administrators", "CanScript");
|
|
||||||
|
|
||||||
acl.GrantPermission("Administrators", "CanRestart");
|
|
||||||
Permission setPermission = acl.HasPermission("JoeGuest", "CanRestart");
|
|
||||||
Assert.That(setPermission == Permission.Deny, "Guests Should not be able to restart");
|
|
||||||
Assert.That(acl.HasPermission("JoeGuest", "CanScript") == Permission.None,
|
|
||||||
"No Explicit Permissions set so should be Permission.None");
|
|
||||||
}
|
|
||||||
|
|
||||||
#endregion
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue