5.4. 使用 LDAP 进行身份验证和授权
LDAP 登录模块通过根据存储在中央 X.500 目录服务器中的用户数据检查传入凭据来启用身份验证和授权。它通过 org.apache.activemq.artemis.spi.core.security.jaas.LDAPLoginModule
实施。
5.4.1. 配置 LDAP 以验证客户端
以下示例流程演示了如何使用 LDAP 验证客户端。
流程
-
打开 &
lt;broker_instance_dir> /etc/broker.xml
配置文件。 在
security-settings
元素中,添加一个security-setting
元素来配置权限。例如:<security-settings> <security-setting match="#"> <permission type="createDurableQueue" roles="user"/> <permission type="deleteDurableQueue" roles="user"/> <permission type="createNonDurableQueue" roles="user"/> <permission type="deleteNonDurableQueue" roles="user"/> <permission type="send" roles="user"/> <permission type="consume" roles="user"/> </security-setting> </security-settings>
前面的配置 将所有 队列的特定权限
分配给用户
角色的成员。-
打开 &
lt;broker_instance_dir> /etc/login.config
文件。 根据您要使用的目录服务配置 LDAP 登录模块。
如果您使用 Microsoft Active Directory 目录服务,请添加类似以下示例的配置:
activemq { org.apache.activemq.artemis.spi.core.security.jaas.LDAPLoginModule required debug=true initialContextFactory=com.sun.jndi.ldap.LdapCtxFactory connectionURL="LDAP://localhost:389" connectionUsername="CN=Administrator,CN=Users,OU=System,DC=example,DC=com" connectionPassword=redhat.123 connectionProtocol=s connectionTimeout="5000" authentication=simple userBase="dc=example,dc=com" userSearchMatching="(CN={0})" userSearchSubtree=true readTimeout="5000" roleBase="dc=example,dc=com" roleName=cn roleSearchMatching="(member={0})" roleSearchSubtree=true ; };
注意如果您使用 Microsoft Active Directory,并且您需要为
connectionUsername
的属性指定的值包含一个空格(如OU=System Accounts
),那么您必须将该值放在一对双引号(""
)中,并使用反斜杠(\
)转义对对中的每个双引号。例如:connectionUsername="CN=Administrator,CN=Users,OU=\"System Accounts\",DC=example,DC=com"
。如果您使用 ApacheDS 目录服务,请添加类似以下示例的配置:
activemq { org.apache.activemq.artemis.spi.core.security.jaas.LDAPLoginModule required debug=true initialContextFactory=com.sun.jndi.ldap.LdapCtxFactory connectionURL="ldap://localhost:10389" connectionUsername="uid=admin,ou=system" connectionPassword=secret connectionProtocol=s connectionTimeout=5000 authentication=simple userBase="dc=example,dc=com" userSearchMatching="(uid={0})" userSearchSubtree=true userRoleName= readTimeout=5000 roleBase="dc=example,dc=com" roleName=cn roleSearchMatching="(member={0})" roleSearchSubtree=true ; };
debug
-
打开调试(
true
)或关闭(false
)。默认值为false
。 initialContextFactory
-
必须始终设置为
com.sun.jndi.ldap.LdapCtxFactory
connectionURL
-
使用 LDAP URL __<ldap://Host:Port> 的目录服务器的位置。可以选择通过添加正斜杠
/
,后跟目录树中特定节点的 DN 来证明此 URL。Apache DS 的默认端口为10389
,而对于 Microsoft AD,默认为389
。 connectionUsername
-
打开与目录服务器连接的用户的可分辨名称(DN)。例如:
uid=admin,ou=system
。目录服务器通常需要客户端提供用户名/密码凭证来打开连接。 connectionPassword
-
与
connectionUsername
的 DN 匹配的密码。在目录服务器中,在 Directory Information Tree (DIT)中,密码通常作为userPassword
属性存储在对应的目录条目中。 connectionProtocol
- 支持任何值,但实际没有被使用。必须明确设置这个选项,因为它没有默认值。
connectionTimeout
以毫秒为单位指定代理连接到目录服务器的最长时间。如果代理无法连接到该目录,它会中止连接尝试。如果为此属性指定 0 或更小的值,则会使用底层 TCP 协议的超时值。如果没有指定值,代理会无限期等待建立连接,或者底层网络超时。
当为连接请求连接池时,此属性指定代理达到最大池大小并且池中所有连接都被使用时的最大时间。如果您指定的值为零或更少,代理会无限期等待连接可用。否则,代理会在达到最长等待时间时中止连接尝试。
身份验证
-
指定绑定到 LDAP 服务器时使用的身份验证方法。这个参数可以设置为
simple
(需要用户名和密码)或none
(允许匿名访问)。 userBase
-
选择 DIT 的特定子树来搜索用户条目。子树由 DN 指定,用于指定子树的基本节点。例如,通过将此选项设置为
ou=User,ou=ActiveMQ,ou=system
,对用户条目的搜索仅限于ou=User,ou=ActiveMQ,ou=system
节点下的子树。 userSearchMatching
-
指定一个 LDAP 搜索过滤器,它应用到
userBase
所选的子树。详情请查看以下 第 5.4.1.1 节 “搜索匹配参数” 部分。 userSearchSubtree
-
指定用户条目的搜索深度,相对于
userBase
指定的节点。这个选项是一个布尔值。指定一个false
值表示搜索尝试匹配userBase
节点的子条目之一(映射到javax.naming.directory.SearchControls.ONELEVEL_SCOPE
)。指定一个true
值表示搜索尝试匹配属于userBase
节点 子树 的任何条目(映射到javax.naming.directory.SearchControls.SUBTREE_SCOPE
)。 userRoleName
- 包含用户的角色名称的用户条目属性的名称。角色名称由代理的授权插件解释为组名称。如果省略这个选项,则不会从用户条目中提取角色名称。
readTimeout
- 指定代理可以从目录服务器接收响应到 LDAP 请求的最大时间(以毫秒为单位)。如果代理没有从目录服务器收到响应,代理会中止请求。如果您指定的值为零或更少,或者未指定值,代理会无限期等待从目录服务器响应 LDAP 请求的响应。
roleBase
-
如果角色数据存储在目录服务器中,可以使用角色选项的组合(
roleBase
、roleSearchMatching
、roleSearchSubtree
、roleName
和 roleName )作为指定userRoleName
选项的替代选择。此选项选择 DIT 的特定子树来搜索角色/组条目。子树由 DN 指定,用于指定子树的基本节点。例如,通过将此选项设置为ou=Group,ou=ActiveMQ,ou=system
,对 role/group 条目的搜索仅限于ou=Group,ou=ActiveMQ,ou=system
节点下的子树。 roleName
- 包含角色/组名称的角色条目的属性类型(如 C、O、OU 等)。如果省略了这个选项,则有效禁用角色搜索功能。
roleSearchMatching
-
指定一个 LDAP 搜索过滤器,它应用到
roleBase
所选的子树。详情请查看以下 第 5.4.1.1 节 “搜索匹配参数” 部分。 roleSearchSubtree
指定角色条目的搜索深度,相对于
roleBase
指定的节点。如果设置为false
(默认值),搜索会尝试匹配roleBase
节点的子条目之一(映射到javax.naming.directory.SearchControls.ONELEVEL_SCOPE
)。如果为true
,它会尝试匹配属于 roleBase 节点子树的任何条目(映射到javax.naming.directory.SearchControls.SUBTREE_SCOPE
)。注意Apache DS 使用 DN 路径的
OID
部分。Microsoft Active Directory 使用CN
部分。例如,您可以在 Apache DS 中使用 DN 路径,如oid=testuser,dc=example,dc=com
,而您可以在 Microsoft Active Directory 中使用 DN 路径,如cn=testuser,dc=example,dc=com
。
- 启动或重启代理(服务或进程)。
5.4.1.1. 搜索匹配参数
userSearchMatching
在传递给 LDAP 搜索操作前,此配置参数中提供的字符串值受到字符串替换,如
java.text.MessageFormat
类所实现。
这意味着,特殊字符串
{0}
被用户名替代,如从传入的客户端凭证中提取。替换后,字符串被解释为 LDAP 搜索过滤器(语法由 IETF 标准 RFC 2254 定义)。
例如,如果此选项设置为
(uid={0})
,且收到的用户名是jdoe
,搜索过滤器会在字符串替换后变为(uid=jdoe)
。
如果生成的搜索过滤器应用到用户 base
ou=User,ou=ActiveMQ,ou=system
所选择的子树,它将匹配条目uid=jdoe,ou=User,ou=ActiveMQ,ou=system
。
roleSearchMatching
这的工作方式与
userSearchMatching
选项类似,但它支持两种替换字符串。
替换字符串
{0}
替换了匹配用户条目(即用户搜索的结果)的完整 DN。例如,对于用户jdoe
,替换的字符串可以是uid=jdoe,ou=User,ou=ActiveMQ,ou=system
。
替换字符串
{1}
会替换接收到的用户名。例如,jdoe
.
如果此选项设为
(member=uid={1})
,且接收到的用户名为jdoe
,在进行了字符串替换后,搜索过滤器变为(member=uid=jdoe)
(假设使用 ApacheDS 搜索过滤器语法)。
如果生成的搜索过滤器被应用由角色基础 (
ou=Group,ou=ActiveMQ,ou=system
) 所选择的子树,它将匹配具有member
属性等于uid=jdoe
(member
属性的值是一个 DN)。
必须始终设置这个选项,即使角色搜索被禁用,因为它没有默认值。如果使用 OpenLDAP,搜索过滤器的语法为
(member:=uid=jdoe)
。
其他资源
- 有关搜索过滤器语法的简短介绍,请参阅 Oracle JNDI 教程。
5.4.2. 配置 LDAP 授权
LegacyLDAPSecuritySettingPlugin
安全设置插件读取之前在 AMQ 6 中由 LDAPAuthorizationMap
和 cachedLDAPAuthorizationMap
控制的安全信息,并在可能的情况下将这个信息转换为对应的 AMQ 7 安全设置。
AMQ 6 和 AMQ 7 中的代理的安全实现不匹配。因此,插件在两个版本之间执行一些转换,以实现接近等效的功能。
以下示例演示了如何配置插件。
流程
-
打开 &
lt;broker_instance_dir> /etc/broker.xml
配置文件。 在
security-settings
元素中,添加security-setting-plugin
元素。例如:<security-settings> <security-setting-plugin class-name="org.apache.activemq.artemis.core.server.impl.LegacyLDAPSecuritySettingPlugin"> <setting name="initialContextFactory" value="com.sun.jndi.ldap.LdapCtxFactory"/> <setting name="connectionURL" value="ldap://localhost:1024"/>`ou=destinations,o=ActiveMQ,ou=system` <setting name="connectionUsername" value="uid=admin,ou=system"/> <setting name="connectionPassword" value="secret"/> <setting name="connectionProtocol" value="s"/> <setting name="authentication" value="simple"/> </security-setting-plugin> </security-settings>
class-name
-
实现是
org.apache.activemq.artemis.core.server.impl.LegacyLDAPSecuritySettingPlugin
。 initialContextFactory
-
用于连接到 LDAP 的初始上下文工厂。它必须始终设置为
com.sun.jndi.ldap.LdapCtxFactory
(默认值)。 connectionURL
-
使用 LDAP URL <ldap://Host:Port> 指定 目录服务器 的位置。您可以选择通过添加正斜杠
/
,后跟目录树中特定节点的可分辨名称(DN)来证明此 URL。例如:ldap://ldapserver:10389/ou=system
。默认值为ldap://localhost:1024
。 connectionUsername
-
打开到目录服务器连接的用户的 DN。例如:
uid=admin,ou=system
。目录服务器通常需要客户端提供用户名/密码凭证来打开连接。 connectionPassword
-
与
connectionUsername
的 DN 匹配的密码。在目录服务器中,在 Directory Information Tree (DIT)中,密码通常作为userPassword
属性存储在对应的目录条目中。 connectionProtocol
- 当前未使用。未来,此选项可能会允许您选择连接到目录服务器的安全套接字层(SSL)。必须明确设置这个选项,因为它没有默认值。
身份验证
指定绑定到 LDAP 服务器时使用的身份验证方法。此参数的有效值为
simple
(用户名和密码)或none
(匿名)。默认值为simple
。注意不支持 简单的身份验证和安全层(SASL)身份验证。
前面配置示例中没有显示的其他设置有:
destinationBase
-
指定其子项为所有目的地提供权限的节点的 DN。在这种情况下,DN 是一个字面值(即,在属性值上不会执行字符串替换)。例如,此属性的典型值为
ou=destinations,o=ActiveMQ,ou=system
默认值为ou=destinations,o=ActiveMQ,ou=system
。 filter
-
指定 LDAP 搜索过滤器,用于查找任何类型的目的地的权限。search 过滤器尝试匹配队列或主题节点的其中一个子项或后代。默认值为
(cn=*)
。 roleAttribute
-
指定节点的一个属性,它匹配其值是一个角色的 DN 的
filter
。默认值为uniqueMember
。 adminPermissionValue
-
指定与
admin
权限匹配的值。默认值为admin
。 readPermissionValue
-
指定匹配
read
权限的值。默认值为read
。 writePermissionValue
-
指定匹配
write
权限的值。默认值为write
。 enableListener
-
指定是否启用在 LDAP 服务器中自动接收更新的监听程序,并实时更新代理的授权配置。默认值为
true
。 mapAdminToManage
指定是否将传统(即 AMQ 6)
admin
的权限映射到 AMQ 7manage
权限。请查看下表中映射语义的详情。默认值为false
。LDAP 中定义的队列或主题的名称充当安全设置的"match",权限值从 AMQ 6 类型映射到 AMQ 7 类型,并且角色映射为原样。由于 LDAP 中定义的队列或主题的名称充当安全设置的匹配项,因此可能无法将安全设置应用到 JMS 目的地。这是因为 AMQ 7 始终根据需要使用 "jms.queue." 或 "jms.topic." 前缀 JMS 目的地。
AMQ 6 有三种权限类型 -
读
、写
和admin
。这些权限类型在 ActiveMQ 网站上描述; 安全。AMQ 7 具有以下权限类型:
-
createAddress
-
deleteAddress
-
createDurableQueue
-
deleteDurableQueue
-
createNonDurableQueue
-
deleteNonDurableQueue
-
send
-
消耗
-
管理
浏览
下表显示了安全设置插件如何将 AMQ 6 权限类型映射到 AMQ 7 权限类型:
AMQ 6 权限类型 AMQ 7 权限类型 读取
消耗、浏览
write
send
admin
createAddress, deleteAddress, createDurableQueue, deleteDurableQueue, createNonDurableQueue, deleteNonDurableQueue, manage (如果
mapAdminToManage
设置为true
)如下所示,在有些情况下,插件在 AMQ 6 和 AMQ 7 权限类型之间执行一些转换,以实现等效性:
-
映射默认不包括 AMQ 7
管理
权限类型,因为 AMQ 6 中没有类似的权限类型。但是,如果mapAdminToManage
设为true
,则插件会将 AMQ 6admin
权限映射到 AMQ 7管理权限
。 -
AMQ 6 中的
admin
权限类型决定代理是否在目的地不存在时自动创建目的地,用户会向它发送一条消息。如果用户有权发送消息到目的地,AMQ 7 会自动创建目的地。因此,插件将旧的admin
权限映射到上面显示的 AMQ 7 权限。如果mapAdminToManage
设为true
,则该插件也会将 AMQ 6admin
权限映射到 AMQ 7manage
权限。
-
映射默认不包括 AMQ 7
-
allowQueueAdminOnRead
是否要将旧的读取权限映射到 createDurableQueue、createNonDurableQueue 和 deleteDurableQueue 权限,以便 JMS 客户端能否创建不可变且不可激活的订阅,而无需 admin 权限。这在 AMQ 6 中允许。默认值为 false。
下表显示了当
allowQueueAdminOnRead
为true
时,安全设置插件如何将 AMQ 6 权限类型映射到 AMQ 7 权限类型:AMQ 6 权限类型 AMQ 7 权限类型 读取
consume, browse, createDurableQueue, createNonDurableQueue, deleteDurableQueue
write
send
admin
createAddress, deleteAddress, deleteNonDurableQueue, manage (如果
mapAdminToManage
设为true
)
5.4.3. 在 login.config 文件中加密密码
由于组织经常使用 LDAP 安全地存储数据,所以 login.config
文件可以包含代理与机构的 LDAP 服务器通信所需的配置。此配置文件通常包含登录 LDAP 服务器的密码,因此此密码需要加密。
先决条件
-
确保您已修改了
login.config
文件以添加所需属性,如 第 5.4.2 节 “配置 LDAP 授权” 所述。
流程
以下流程演示了如何屏蔽 < broker_instance_dir> /etc/login.config
文件中的 connectionPassword
参数的值。
在命令提示符中,使用
mask
工具加密密码:$ <broker_instance_dir>/bin/artemis mask <password>
result: 3a34fd21b82bf2a822fa49a8d8fa115d
打开 &
lt;broker_instance_dir> /etc/login.config
文件。找到connectionPassword
参数:connectionPassword = <password>
将纯文本密码替换为加密值:
connectionPassword = 3a34fd21b82bf2a822fa49a8d8fa115d
使用标识符
"ENC ()"
嵌套加密值:connectionPassword = "ENC(3a34fd21b82bf2a822fa49a8d8fa115d)"
login.config
文件现在包含屏蔽的密码。由于密码使用 "ENC ()"
标识符嵌套,所以 AMQ Broker 在使用前会对其进行解密。
其他资源
- 有关 AMQ Broker 中包含的配置文件的更多信息,请参阅 AMQ Broker 配置文件和位置。
5.4.4. 映射外部角色
您可以从外部身份验证供应商(如 LDAP)将角色映射到代理内部使用的角色。
要映射外部角色,请在 broker.xml
配置文件中的 security-settings
元素中创建 role-mapping 条目。例如:
<security-settings> ... <role-mapping from="cn=admins,ou=Group,ou=ActiveMQ,ou=system" to="my-admin-role"/> <role-mapping from="cn=users,ou=Group,ou=ActiveMQ,ou=system" to="my-user-role"/> </security-settings>
- 角色映射是可添加的。这意味着用户将保留原始角色以及新分配的角色。
- 角色映射仅影响授权队列访问的角色,不提供启用 Web 控制台访问的方法。