Skip to content

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

@SummCoder

Description

@SummCoder

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!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions