RocketMQ ACL使用指南
什么是ACL?
RocketMQ在4.4.0版本开始支持ACL。ACL是access control list的简称，俗称访问控制列表。访问控制，基本上会涉及到用户、资源、权限、角色等概念，那在RocketMQ中上述会对应哪些对象呢？
用户
用户是访问控制的基础要素，也不难理解，RocketMQ ACL必然也会引入用户的概念，即支持用户名、密码。资源
资源，需要保护的对象，在RocketMQ中，消息发送涉及的Topic、消息消费涉及的消费组，应该进行保护，故可以抽象成资源。权限
针对资源，能进行的操作，角色
RocketMQ中，只定义两种角色：是否是管理员。
另外，RocketMQ还支持按照客户端IP进行白名单设置。
ACL基本流程图
在讲解如何使用ACL之前，我们先简单看一下RocketMQ ACL的请求流程：
如何配置ACL
3.1 acl配置文件
acl默认的配置文件名：plain_acl.yml,需要放在{ROCKETMQ_HOME}/store/config目录下。下面对其配置项一一介绍。
3.1.1 globalWhiteRemoteAddresses
全局白名单，其类型为数组，即支持多个配置。其支持的配置格式如下：
空
表示不设置白名单，该条规则默认返回false。"*"
表示全部匹配，该条规则直接返回true，将会阻断其他规则的判断，请慎重使用。192.168.0.{100,101}
多地址配置模式，ip地址的最后一组，使用{}，大括号中多个ip地址，用英文逗号(,)隔开。192.168.1.100,192.168.2.100
直接使用,分隔，配置多个ip地址。192.168..或192.168.100-200.10-20
每个IP段使用 "*" 或"-"表示范围。
3.1.2 accounts
配置用户信息，该类型为数组类型。拥有accessKey、secretKey、whiteRemoteAddress、admin、defaultTopicPerm、defaultGroupPerm、topicPerms、groupPerms子元素。
3.1.2.1 accessKey
登录用户名，长度必须大于6个字符。
3.1.2.2 secretKey
登录密码。长度必须大于6个字符。
3.1.2.3 whiteRemoteAddress
用户级别的IP地址白名单。其类型为一个字符串，其配置规则与globalWhiteRemoteAddresses，但只能配置一条规则。
3.1.2.4 admin
boolean类型，设置是否是admin。如下权限只有admin=true时才有权限执行。
UPDATE_AND_CREATE_TOPIC
更新或创建主题。UPDATE_BROKER_CONFIG
更新Broker配置。DELETE_TOPIC_IN_BROKER
删除主题。UPDATE_AND_CREATE_SUBSCRIPTIONGROUP
更新或创建订阅组信息。DELETE_SUBSCRIPTIONGROUP
删除订阅组信息。
3.1.2.5 defaultTopicPerm
默认topic权限。该值默认为DENY(拒绝)。
3.1.2.6 defaultGroupPerm
默认消费组权限，该值默认为DENY(拒绝)，建议值为SUB。
3.1.2.7 topicPerms
设置topic的权限。其类型为数组，其可选择值在下节介绍。
3.1.2.8 groupPerms
设置消费组的权限。其类型为数组，其可选择值在下节介绍。可以为每一消费组配置不一样的权限。
3.2 RocketMQ ACL权限可选值
DENY
拒绝。PUB
拥有发送权限。SUB
拥有订阅权限。
3.3、权限验证流程
上面定义了全局白名单、用户级别的白名单，用户级别的权限，为了更好的配置ACL权限规则，下面给出权限匹配逻辑。
使用示例
4.1 Broker端安装
首先，需要在broker.conf文件中，增加参数aclEnable=true。并拷贝distribution/conf/plain_acl.yml文件到${ROCKETMQ_HOME}/conf目录。
broker.conf的配置文件如下：
1brokerClusterName = DefaultCluster
2brokerName = broker-b
3brokerId = 0
4deleteWhen = 04
5fileReservedTime = 48
6brokerRole = ASYNC_MASTER
7flushDiskType = ASYNC_FLUSH
8listenPort=10915
9storePathRootDir=E:/SH2019/tmp/rocketmq_home/rocketmq4.5MB/store
10storePathCommitLog=E:/SH2019/tmp/rocketmq_home/rocketmq4.5MB/store/commitlog
11namesrvAddr=127.0.0.1:9876
12autoCreateTopicEnable=false
13aclEnable=true
plain_acl.yml文件内容如下：
1globalWhiteRemoteAddresses:
2
3accounts:
4- accessKey: RocketMQ
5 secretKey: 12345678
6 whiteRemoteAddress:
7 admin: false
8 defaultTopicPerm: DENY
9 defaultGroupPerm: SUB
10 topicPerms:
11 - TopicTest=PUB
12 groupPerms:
13 # the group should convert to retry topic
14 - oms_consumer_group=DENY
15
16- accessKey: admin
17 secretKey: 12345678
18 whiteRemoteAddress:
19 # if it is admin, it could access all resources
20 admin: true
从上面的配置可知，用户RocketMQ只能发送TopicTest的消息，其他topic无权限发送；拒绝oms_consumer_group消费组的消息消费，其他消费组默认可消费。
4.2 消息发送端示例
1public class AclProducer {
2 public static void main(String[] args) throws MQClientException, InterruptedException {
3 DefaultMQProducer producer = new DefaultMQProducer("please_rename_unique_group_name", getAclRPCHook());
4 producer.setNamesrvAddr("127.0.0.1:9876");
5 producer.start();
6 for (int i = 0; i < 1; i++) {
7 try {
8 Message msg = new Message("TopicTest3" ,"TagA" , ("Hello RocketMQ " + i).getBytes(RemotingHelper.DEFAULT_CHARSET));
9 SendResult sendResult = producer.send(msg);
10 System.out.printf("%s%n", sendResult);
11 } catch (Exception e) {
12 e.printStackTrace();
13 Thread.sleep(1000);
14 }
15 }
16 producer.shutdown();
17 }
18
19 static RPCHook getAclRPCHook() {
20 return new AclClientRPCHook(new SessionCredentials("rocketmq","12345678"));
21 }
22}
运行效果如图所示：
4.3 消息消费端示例
1public class AclConsumer {
2
3 public static void main(String[] args) throws InterruptedException, MQClientException {
4 DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("oms_consumer_group", getAclRPCHook(),new AllocateMessageQueueAveragely());
5 consumer.setConsumeFromWhere(ConsumeFromWhere.CONSUME_FROM_FIRST_OFFSET);
6 consumer.subscribe("TopicTest", "*");
7 consumer.setNamesrvAddr("127.0.0.1:9876");
8 consumer.registerMessageListener(new MessageListenerConcurrently() {
9
10 public ConsumeConcurrentlyStatus consumeMessage(List<MessageExt> msgs,
11 ConsumeConcurrentlyContext context) {
12 System.out.printf("%s Receive New Messages: %s %n", Thread.currentThread().getName(), msgs);
13 return ConsumeConcurrentlyStatus.CONSUME_SUCCESS;
14 }
15 });
16 consumer.start();
17 System.out.printf("Consumer Started.%n");
18 }
19
20 static RPCHook getAclRPCHook() {
21 return new AclClientRPCHook(new SessionCredentials("rocketmq","12345678"));
22 }
23}
发现并不没有消费消息，符合预期。
关于RocketMQ ACL的使用就介绍到这里了，下一篇将介绍RocketMQ ACL实现原理。
更多文章请关注如下公众号：
推荐阅读：
1、RocketMQ实战：生产环境中，autoCreateTopicEnable为什么不能设置为true