Dubbo Authorization Policy

Dubbo Authorization Policy

Configuration for access control on Dubbo services.

Authorization Policy scope (target) is determined by “metadata/namespace” and an optional “selector”.

“metadata/namespace” tells which namespace the policy applies. If set to root namespace, the policy applies to all namespaces in a mesh.

DubboAuthorizationPolicy

DubboAuthorizationPolicy enables access control on Dubbo services.

Field Type Description Required

Field	Type	Description	Required
`rules`	`Rule[]`	Optional. A list of rules to match the request. A match occurs when at least one rule matches the request. If not set, the match will never occur. This is equivalent to setting a default of deny for the target workloads.	No
`action`	`Action`	Optional. The action to take if the request is matched with the rules.	No

rules

Rule[]

Optional. A list of rules to match the request. A match occurs when at least one rule matches the request.

If not set, the match will never occur. This is equivalent to setting a default of deny for the target workloads.

action

Action

Optional. The action to take if the request is matched with the rules.

Rule

Rule matches requests from a list of sources that perform a list of operations subject to a list of conditions. A match occurs when at least one source, one operation and all conditions matches the request. An empty rule is always matched.

Any string field in the rule supports Exact, Prefix, Suffix and Presence match:

Exact match: “abc” will match on value “abc”.
Prefix match: “abc*” will match on value “abc” and “abcd”.
Suffix match: “*abc” will match on value “abc” and “xabc”.
Presence match: “*” will match when value is not empty.

Field Type Description Required

Field	Type	Description	Required
`from`	`From[]`	Optional. from specifies the source of a request. If not set, any source is allowed.	No
`to`	`To[]`	Optional. to specifies the operation of a request. If not set, any operation is allowed.	No

from

From[]

Optional. from specifies the source of a request.

If not set, any source is allowed.

to

To[]

Optional. to specifies the operation of a request.

If not set, any operation is allowed.

Source

Source specifies the source identities of a request. Fields in the source are ANDed together.

For example, the following source matches if the principal is “admin” or “dev” and the namespace is “prod” or “test”.

principals: ["admin", "dev"]
namespaces: ["prod", "test"]

Field	Type	Description	Required
`principals`	`string[]`	Optional. A list of source peer identities (i.e. service account), which matches to the “source.principal” attribute. This field requires mTLS enabled. If not set, any principal is allowed.	No
`notPrincipals`	`string[]`	Optional. A list of negative match of source peer identities.	No
`namespaces`	`string[]`	Optional. A list of namespaces, which matches to the “source.namespace” attribute. This field requires mTLS enabled. If not set, any namespace is allowed.	No
`notNamespaces`	`string[]`	Optional. A list of negative match of namespaces.	No

Operation

Operation specifies the operations of a request. Fields in the operation are ANDed together.

For example, the following operation matches if the Dubbo interface is “org.apache.dubbo.samples.basic.api.DemoService” and the method is “sayHello”.

interfaces: ["org.apache.dubbo.samples.basic.api.DemoService"]
methods: ["sayHello"]

Field	Type	Description	Required
`interfaces`	`string[]`	Optional. A list of interfaces, which matches to the Dubbo interface. If not set, any interfaces is allowed.	No
`notInterfaces`	`string[]`	Optional. A list of negative match of interfaces.	No
`methods`	`string[]`	Optional. A list of methods, which matches to the Dubbo methods. If not set, any method is allowed.	No
`notMethods`	`string[]`	Optional. A list of negative match of methods.	No

Rule.From

From includes a list or sources.

Field	Type	Description	Required
`source`	`Source`	Source specifies the source of a request.	No

Rule.To

To includes a list or operations.

Field	Type	Description	Required
`operation`	`Operation`	Operation specifies the operation of a request.	No

DubboAuthorizationPolicy.Action

Action specifies the operation to take.

Name	Description
`ALLOW`	Allow a request only if it matches the rules. This is the default type.
`DENY`	Deny a request if it matches any of the rules.

DubboAuthorizationPolicy.Action

Action specifies the operation to take.

Name	Description
`ALLOW`	Allow a request only if it matches the rules. This is the default type.
`DENY`	Deny a request if it matches any of the rules.

Last modified May 23, 2022: 增加 v1.1 文档目录 (431bf1a)