Domain Object Security (ACLs)

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

复杂的应用程序通常需要定义高于 Web 请求或方法调用级别的访问权限。 相反，安全决策需要包括人员 (Authentication）、位置 (MethodInvocation）和事项 (SomeDomainObject）。 换句话说，授权决策还需要考虑方法调用的实际领域对象实例主体。 想象一下，您正在设计一个宠物诊所的应用程序。 Spring 应用程序有两个主要用户组： 宠物诊所员工和宠物诊所的客户。 员工应可以访问所有数据，而您的客户只能查看他们自己的客户记录。 为了让事情更有趣，您的客户可以允许其他用户查看他们的客户记录，例如 “puppy preschool” 导师或当地 “Pony Club” 主席。 当您使用 Spring Security 作为基础时，您有几种可能的方法：

  • 编写业务方法以实施安全策略。您可以查阅 @42 域对象实例中的集合，以确定哪些用户具有访问权限。通过使用 @43，您可以访问 @44 对象。

  • 编写一个 @45 以使用存储在 @47 对象中的 @46 实例强制实施安全策略。这意味着您的 @48 需要使用自定义 @50 对象填充 @49，以表示主体具有访问权限的每个 @51 域对象实例。

  • 编写一个 @52 以强制实施安全策略，并直接打开目标 @53 域对象。这意味着您的投票者需要访问一个 DAO，以便能够检索 @54 对象。然后可以访问 @55 对象的已批准用户集合，并据此做出相应的决定。

这些方法中的每一种都是完全合法的。然而，第一种方法会将授权检查与您的业务代码相结合。这样做的主要问题包括增强单元测试的难度，以及在其他地方重用 Customer`授权逻辑的难度。从 `Authentication`对象中获取 `GrantedAuthority[]`实例也可以，但无法扩展到大量的 `Customer`对象。如果用户可以访问 5,000 个 `Customer`对象（在这种情况下不太可能，但想象一下如果它是大型马术俱乐部的热门兽医！），那么消耗的内存量和构建 `Authentication`对象所需的时间将是不希望的。最后的方法，直接从外部代码打开 `Customer，可能是这三种方法中最好的。它实现了职责分离，不会滥用内存或 CPU 周期，但它仍然低效，因为 `AccessDecisionVoter`和最终的业务方法本身都会调用负责检索 `Customer`对象的 DAO。每个方法调用访问两次显然是不可取的。此外，对于列出的每种方法，您都需要从头开始编写自己的访问控制列表 (ACL) 持久性和业务逻辑。 幸运的是，还有另一种选择，我们将在后面讨论。

Key Concepts

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 部署中大小的顺序排列，最后列出具有最多行的表格：

  • @59 使我们能够唯一标识系统中的任何主体或权限 (@56 代表 @57)。唯一的列是 ID、SID 的文本表示形式，以及指示文本表示形式指代主体名称或 @60 的标志。因此，对于每个唯一的主体或 @61 都会有一行。在接收权限的上下文中使用时，一个 SID 通常被称为 @58。

  • `ACL_CLASS`允许我们唯一标识系统中的任何域对象类。唯一列为 ID 和 Java 类名。因此，对于我们希望存储 ACL 权限的每个唯一类，都会有一行。

  • `ACL_OBJECT_IDENTITY`存储系统中每个唯一域对象实例的信息。列包括 ID、ACL_CLASS 表的外键、唯一标识符（以便我们了解我们提供信息的 ACL_CLASS 实例）、父级、ACL_SID 表的外键（以表示域对象实例的所有者）、以及我们是否允许 ACL 项从任何父级 ACL 继承。我们为我们存储 ACL 权限的每个域对象实例设置一行。

  • 最后，ACL_ENTRY`存储分配给每个收件人的个别权限。列包括指向 `ACL_OBJECT_IDENTITY 的外键、收件人（即指向 ACL_SID 的外键）、我们是否进行审核，以及表示授予或拒绝实际权限的整数位掩码。我们为每个收到权限以使用域对象的收件人设置一行。

如上一段所述，ACL 系统使用整数位掩码。 但是，您不必了解位移的更精细要点即可使用 ACL 系统。 只要说我们可以切换32位就足够了。 每个位都表示一个权限。 默认情况下，权限为读取（位 0）、写入（位 1）、创建（位 2）、删除（位 3）和管理（位 4）。 您可以实现自己的`Permission`实例，如果您希望使用其他权限，ACL 框架的其余部分将独立于您的扩展而运行。

您应该理解，系统中领域对象的数量与我们选择使用整数位掩码这件事绝对无关。 虽然您有 32 位可用作权限，但您可以拥有数十亿个领域对象实例（这意味着 ACL_OBJECT_IDENTITY 中有数十亿行，可能还有 ACL_ENTRY）。 我们提出这一点，因为我们发现人们有时错误地认为他们需要为每个潜在的领域对象一个位，但事实并非如此。

既然我们已经基本了解了 ACL 系统的作用以及它在表结构级别上的样子，我们需要探索关键接口：

  • Acl: 每个域对象都有一个且仅有一个 Acl 对象，该对象在内部保留 AccessControlEntry 对象并了解 Acl 的所有者。Acl 不会直接指向域对象，而是指向 ObjectIdentity 。 Acl 存储在 ACL_OBJECT_IDENTITY 表中。

  • AccessControlEntry: Acl 包含多个 AccessControlEntry 对象，这些对象在框架中通常缩写为 ACE。每个 ACE 指向 Permission、Sid 和 Acl 的特定元组。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: 为给定的 ObjectIdentity 检索适用的 Acl 。在附带的实现中 (JdbcAclService )，检索操作委托给 LookupStrategy 。 LookupStrategy 提供了一种高度优化的策略来检索 ACL 信息，它使用批处理检索 (BasicLookupStrategy ) 并支持使用物化视图、分层查询和类似的以性能为中心的、非 ANSI SQL 能力的自定义实现。

  • MutableAclService: 可以为持久性呈现已修改的 Acl 。使用此接口是可选的。

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

Spring Security 附带两个样本，演示了 ACL 模块。第一个是 联系信息示例，另一个是 文档管理系统 (DMS) 示例。我们建议查看这些示例。

Getting Started

要开始使用 Spring Security 的 ACL 功能，您需要将 ACL 信息存储在某个地方。这需要在 Spring 中实例化 DataSource。然后将 `DataSource`注入到 `JdbcMutableAclService`和 `BasicLookupStrategy`实例中。前者提供修改器功能，而后者提供高性能 ACL 检索功能。请参阅随 Spring Security 一起提供的某个 示例，了解示例配置。您还需要使用上一节中列出的 four ACL-specific tables填充数据库（有关适当的 SQL 语句，请参阅 ACL 示例）。

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

以下代码片段显示了如何创建 Acl 或修改现有 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)

在前面的示例中，我们检索与标识符编号 44 的 Foo 领域对象关联的 ACL。 然后我们添加一个 ACE，以便名为 “Samantha” 的主体可以 “administer” 该对象。 代码片段相对不言自明，除了 insertAce 方法。 insertAce 方法的第一个参数确定在其中插入新条目的 Acl 中的位置。 在前面的示例中，我们将新 ACE 放置在现有 ACE 的末尾。 最后一个参数是一个布尔值，表示 ACE 是授予还是拒绝。 大多数时候授予 (true）。 但是，如果它拒绝 (false），则权限将被有效阻止。

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

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

请参阅 sample applications以了解如何使用这些类。