领域对象安全性 (ACLs)

本节介绍 Spring Security 如何通过访问控制列表 (ACL) 提供领域对象安全性。

复杂应用程序通常需要定义超出 Web 请求或方法调用级别的访问权限。相反,安全决策需要包括谁 (Authentication)、何处 (MethodInvocation) 以及什么 (SomeDomainObject)。换句话话,授权决策还需要考虑方法调用所针对的实际领域对象实例。

想象一下,您正在为宠物诊所设计一个应用程序。您的基于 Spring 的应用程序有两个主要用户群体:宠物诊所的员工和宠物诊所的客户。员工应该能够访问所有数据,而客户应该只能看到他们自己的客户记录。为了让事情更有趣一些,您的客户可以允许其他用户查看他们的客户记录,例如他们的“幼犬幼儿园”导师或他们当地“小马俱乐部”的主席。当您使用 Spring Security 作为基础时,有几种可能的方法

  • 编写您的业务方法来强制执行安全性。您可以查阅 Customer 领域对象实例中的集合来确定哪些用户有权访问。通过使用 SecurityContextHolder.getContext().getAuthentication(),您可以访问 Authentication 对象。

  • 编写一个 AccessDecisionVoter 来根据存储在 Authentication 对象中的 GrantedAuthority[] 实例强制执行安全性。这意味着您的 AuthenticationManager 需要使用自定义的 GrantedAuthority[] 对象填充 Authentication,以表示主体有权访问的每个 Customer 领域对象实例。

  • 编写一个 AccessDecisionVoter 来强制执行安全性并直接打开目标 Customer 领域对象。这意味着您的投票者需要访问一个 DAO,该 DAO 允许其检索 Customer 对象。然后,它可以访问 Customer 对象的已批准用户集合并做出适当的决定。

这些方法中的每一种都是完全合法的。然而,第一种方法将您的授权检查与您的业务代码耦合在一起。这带来的主要问题包括单元测试的难度增加,以及在其他地方重用 Customer 授权逻辑会更加困难。从 Authentication 对象中获取 GrantedAuthority[] 实例也可以,但无法扩展到大量 Customer 对象。如果一个用户可以访问 5,000 个 Customer 对象(在本例中不太可能,但想象一下如果这是一个大型小马俱乐部很受欢迎的兽医!),那么消耗的内存量和构建 Authentication 对象所需的时间将是不可取的。最后一种方法,即直接从外部代码打开 Customer,可能是这三种方法中最好的。它实现了关注点分离,并且没有滥用内存或 CPU 周期,但它仍然效率低下,因为 AccessDecisionVoter 和最终的业务方法本身都会调用负责检索 Customer 对象的 DAO。每次方法调用进行两次访问显然是不可取的。此外,对于列出的每种方法,您都需要从头开始编写自己的访问控制列表 (ACL) 持久化和业务逻辑。

幸运的是,还有另一种替代方案,我们稍后会讨论。

关键概念

Spring Security 的 ACL 服务打包在 spring-security-acl-xxx.jar 中。您需要将此 JAR 添加到类路径中才能使用 Spring Security 的领域对象实例安全性功能。

Spring Security 的领域对象实例安全性功能围绕访问控制列表 (ACL) 的概念展开。系统中的每个领域对象实例都有自己的 ACL,并且 ACL 记录了谁可以和谁不能使用该领域对象的详细信息。考虑到这一点,Spring Security 为您的应用程序提供了三个主要的 ACL 相关功能

  • 一种有效检索所有领域对象 ACL 条目的方法(以及修改这些 ACL)

  • 一种确保在方法调用前,给定主体被允许使用您的对象的方法

  • 一种确保在方法调用后,给定主体被允许使用您的对象(或其返回内容)的方法

正如第一个要点所示,Spring Security ACL 模块的主要功能之一是提供一种高性能的 ACL 检索方式。这种 ACL 存储库功能极其重要,因为系统中的每个领域对象实例都可能包含多个访问控制条目,并且每个 ACL 都可能以树状结构继承自其他 ACL(Spring Security 支持此功能,并且非常常用)。Spring Security 的 ACL 功能经过精心设计,旨在提供高性能的 ACL 检索,同时支持可插拔的缓存、最小化死锁的数据库更新、独立于 ORM 框架(我们直接使用 JDBC)、适当的封装以及透明的数据库更新。

鉴于数据库对于 ACL 模块的操作至关重要,我们需要探讨实现中默认使用的四个主要表。这些表按照在典型的 Spring Security ACL 部署中的大小顺序排列,行数最多的表列在最后

  • ACL_SID 允许我们唯一地标识系统中的任何主体或权限(“SID” 代表 “Security IDentity”)。唯一的列是 ID、SID 的文本表示以及一个标志,用于指示文本表示是引用主体名称还是 GrantedAuthority。因此,每个唯一的主体或 GrantedAuthority 对应一行。在接收权限的上下文中,SID 通常被称为“接收者”。

  • ACL_CLASS 允许我们唯一地标识系统中的任何领域对象类。唯一的列是 ID 和 Java 类名。因此,每个我们希望存储 ACL 权限的唯一类对应一行。

  • ACL_OBJECT_IDENTITY 存储系统中每个唯一领域对象实例的信息。列包括 ID、指向 ACL_CLASS 表的外键、唯一标识符(以便我们知道提供信息的 ACL_CLASS 实例)、父项、指向 ACL_SID 表的外键(表示领域对象实例的所有者)以及我们是否允许 ACL 条目继承任何父 ACL。每个我们存储 ACL 权限的领域对象实例对应一行。

  • 最后,ACL_ENTRY 存储分配给每个接收者的 individual permissions。列包括指向 ACL_OBJECT_IDENTITY 的外键、接收者(即指向 ACL_SID 的外键)、是否进行审计以及表示授予或拒绝的实际权限的整数位掩码。每个获得与领域对象交互权限的接收者对应一行。

正如上一段所述,ACL 系统使用整数位掩码。然而,您无需了解位移的细节即可使用 ACL 系统。可以说,我们有 32 位可以打开或关闭。每个位代表一个权限。默认情况下,权限包括读 (bit 0)、写 (bit 1)、创建 (bit 2)、删除 (bit 3) 和管理 (bit 4)。如果您希望使用其他权限,可以实现自己的 Permission 实例,ACL 框架的其余部分可以在不知道您的扩展的情况下运行。

您应该理解,系统中领域对象的数量与我们选择使用整数位掩码这一事实完全无关。虽然您有 32 位权限可用,但您可能拥有数十亿个领域对象实例(这意味着 ACL_OBJECT_IDENTITY 中有数十亿行,可能 ACL_ENTRY 中也有)。我们之所以指出这一点,是因为我们发现人们有时会错误地认为每个潜在领域对象需要一个位,情况并非如此。

现在我们已经对 ACL 系统做了基本概述,以及它在表结构层面的样子,接下来我们需要探讨关键接口

  • Acl:每个领域对象只有一个 Acl 对象,它内部持有 AccessControlEntry 对象并知道 Acl 的所有者。一个 Acl 不直接引用领域对象,而是引用一个 ObjectIdentityAcl 存储在 ACL_OBJECT_IDENTITY 表中。

  • AccessControlEntry:一个 Acl 持有多个 AccessControlEntry 对象,在框架中通常缩写为 ACE。每个 ACE 指代一个特定的 PermissionSidAcl 的组合。一个 ACE 也可以是授予或非授予的,并包含审计设置。ACE 存储在 ACL_ENTRY 表中。

  • Permission:权限代表一个特定的不可变位掩码,并提供位掩码和输出信息的便利函数。上面介绍的基本权限(位 0 到位 4)包含在 BasePermission 类中。

  • Sid:ACL 模块需要引用主体和 GrantedAuthority[] 实例。Sid 接口提供了一层间接性(“SID” 是 “Security IDentity” 的缩写)。常见的类包括 PrincipalSid(表示 Authentication 对象内部的主体)和 GrantedAuthoritySid。安全身份信息存储在 ACL_SID 表中。

  • ObjectIdentity:每个领域对象在 ACL 模块内部由一个 ObjectIdentity 表示。默认实现称为 ObjectIdentityImpl

  • AclService:检索适用于给定 ObjectIdentityAcl。在附带的实现 (JdbcAclService) 中,检索操作委托给 LookupStrategyLookupStrategy 提供了一种高度优化的策略来检索 ACL 信息,使用批量检索 (BasicLookupStrategy) 并支持使用物化视图、层次查询和类似以性能为中心、非 ANSI SQL 功能的自定义实现。

  • MutableAclService:允许将修改后的 Acl 用于持久化。此接口的使用是可选的。

请注意,我们的 AclService 和相关的数据库类都使用 ANSI SQL。因此,这应该适用于所有主要的数据库。在撰写本文时,该系统已成功在 Hypersonic SQL、PostgreSQL、Microsoft SQL Server 和 Oracle 上进行测试。

Spring Security 附带了两个示例,演示了 ACL 模块。第一个是联系人示例 (Contacts Sample),另一个是文档管理系统 (DMS) 示例 (Document Management System (DMS) Sample)。我们建议查看这些示例。

入门

要开始使用 Spring Security 的 ACL 功能,您需要将 ACL 信息存储在某个地方。这需要在 Spring 中实例化一个 DataSource。然后将 DataSource 注入到 JdbcMutableAclServiceBasicLookupStrategy 实例中。前者提供修改功能,后者提供高性能的 ACL 检索功能。请参阅 Spring Security 附带的示例之一以获取示例配置。您还需要使用上一节中列出的四个 ACL 特定表来填充数据库(有关适当的 SQL 语句,请参阅 ACL 示例)。

创建所需 schema 并实例化 JdbcMutableAclService 后,您需要确保您的领域模型支持与 Spring Security ACL 包的互操作性。希望 ObjectIdentityImpl 能够满足要求,因为它提供了多种使用方式。大多数人的领域对象都包含一个 public Serializable getId() 方法。如果返回类型是 long 或与 long 兼容(例如 int),您可能会发现无需进一步考虑 ObjectIdentity 问题。ACL 模块的许多部分都依赖于 long 类型的标识符。如果您不使用 long(或 intbyte 等),您可能需要重新实现许多类。我们不打算在 Spring Security 的 ACL 模块中支持非 long 类型的标识符,因为 long 类型已经与所有数据库序列兼容,是最常见的标识符数据类型,并且长度足以容纳所有常见的使用场景。

以下代码片段展示了如何创建或修改现有的 Acl

  • Java

  • Kotlin

// Prepare the information we'd like in our access control entry (ACE)
ObjectIdentity oi = new ObjectIdentityImpl(Foo.class, new Long(44));
Sid sid = new PrincipalSid("Samantha");
Permission p = BasePermission.ADMINISTRATION;

// Create or update the relevant ACL
MutableAcl acl = null;
try {
acl = (MutableAcl) aclService.readAclById(oi);
} catch (NotFoundException nfe) {
acl = aclService.createAcl(oi);
}

// Now grant some permissions via an access control entry (ACE)
acl.insertAce(acl.getEntries().length, p, sid, true);
aclService.updateAcl(acl);
val oi: ObjectIdentity = ObjectIdentityImpl(Foo::class.java, 44)
val sid: Sid = PrincipalSid("Samantha")
val p: Permission = BasePermission.ADMINISTRATION

// Create or update the relevant ACL
var acl: MutableAcl? = null
acl = try {
aclService.readAclById(oi) as MutableAcl
} catch (nfe: NotFoundException) {
aclService.createAcl(oi)
}

// Now grant some permissions via an access control entry (ACE)
acl!!.insertAce(acl.entries.size, p, sid, true)
aclService.updateAcl(acl)

在前面的示例中,我们检索了与 ID 为 44 的 Foo 领域对象关联的 ACL。然后我们添加了一个 ACE,以便名为“Samantha”的主体可以“管理”该对象。代码片段相对容易理解,除了 insertAce 方法。insertAce 方法的第一个参数决定了新条目插入 Acl 的位置。在前面的示例中,我们将新的 ACE 放在现有 ACE 的末尾。最后一个参数是一个布尔值,指示 ACE 是授予还是拒绝。大多数情况下是授予 (true)。但是,如果它是拒绝 (false),则权限将被有效地阻止。

Spring Security 不提供任何特殊集成来作为您的 DAO 或 repository 操作的一部分自动创建、更新或删除 ACL。相反,您需要为您的各个领域对象编写类似于前面示例中所示的代码。您应该考虑在您的服务层使用 AOP 来自动将 ACL 信息与您的服务层操作集成。我们发现这种方法是有效的。

一旦您使用这里描述的技术在数据库中存储了一些 ACL 信息,下一步就是实际使用 ACL 信息作为授权决策逻辑的一部分。您这里有多种选择。您可以编写自己的 AccessDecisionVoterAfterInvocationProvider,它们分别在方法调用之前或之后触发。这些类将使用 AclService 检索相关的 ACL,然后调用 Acl.isGranted(Permission[] permission, Sid[] sids, boolean administrativeMode) 来决定是否授予或拒绝权限。或者,您可以使用我们的 AclEntryVoterAclEntryAfterInvocationProviderAclEntryAfterInvocationCollectionFilteringProvider 类。所有这些类都提供了基于声明性方法在运行时评估 ACL 信息,使您无需编写任何代码。

请参阅示例应用程序以了解如何使用这些类。