[Doc] ACL documentation is missing required 5.x configuration properties

Open Beginner friendly
#10,498 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
java
Domain
authentication, authorization, documentation

Research direction

Start by locating the English and Chinese ACL documentation, then compare their configuration guidance with AbstractAuthenticationStrategy.java, AbstractAuthorizationStrategy.java, AuthMigrator.java, and AuthenticationFactory.java at the cited lines. Update both documents to include the required 5.x properties and confirm that the documented configuration covers authentication, authorization, migration, and metadata providers.

Written by the indexing model from the issue text.

Description

module/doc
Search before creation
  • I had searched in the issues and found no similar issues.
Documentation Related

The ACL documentation (both English and Chinese) only mentions
aclEnable=true as the required broker configuration. However, in
RocketMQ 5.x, the following additional properties are required:

  • authenticationEnabled=true
  • authorizationEnabled=true
  • migrateAuthFromV1Enabled=true
  • authenticationMetadataProvider=org.apache.rocketmq.auth.authentication.provider.LocalAuthenticationMetadataProvider
  • authorizationMetadataProvider=org.apache.rocketmq.auth.authorization.provider.LocalAuthorizationMetadataProvider

Evidence from source code:

  • AbstractAuthenticationStrategy.java:54 — returns immediately if
    authenticationEnabled is false
  • AbstractAuthorizationStrategy.java:54 — same for authorizationEnabled
  • AuthMigrator.java:72 — plain_acl.yml is not loaded without
    migrateAuthFromV1Enabled
  • AuthenticationFactory.java:80-81 — returns null if
    authenticationMetadataProvider is blank, causing
    "authenticationMetadataProvider is not configured" error

Without these properties, ACL either silently allows all traffic or
throws configuration errors.

Are you willing to submit PR?
  • Yes I am willing to submit a PR!
Dominant language
Java
Stars
22.6k
Forks
12k
Avg merge
3d 12h
Merged PRs (30d)
25

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/rocketmq

All issues in apache/rocketmq

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.