luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #11487 from hashicorp/docs/admin-partitions-feedback-acl-policies-redux 

changed 'segments' in this page to 'resource labels' to disambiguate from 'network segments
updated the code snippets to use CodeBlock component and to include JSON
This commit is contained in:
trujillo-adam 2021-11-10 07:56:54 -08:00 committed by GitHub
parent d396faf246 66ad4e7d3d
commit 8ea10fa959
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 557 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/content/docs/agent/options.mdx
View File

@ -231,6 +231,7 @@ The options below are all specified on the command-line.
Like [`enable_script_checks`](#_enable_script_checks), but only enable them when Like [`enable_script_checks`](#_enable_script_checks), but only enable them when
they are defined in the local configuration files. Script checks defined in HTTP they are defined in the local configuration files. Script checks defined in HTTP
API registrations will still not be allowed. API registrations will still not be allowed.
- `-encrypt` ((#\_encrypt)) - Specifies the secret key to use for encryption - `-encrypt` ((#\_encrypt)) - Specifies the secret key to use for encryption
of Consul network traffic. This key must be 32-bytes that are Base64-encoded. The of Consul network traffic. This key must be 32-bytes that are Base64-encoded. The
@ -1483,10 +1484,9 @@ bind_addr = "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/8\" | attr
- `enable_script_checks` Equivalent to the [`-enable-script-checks` command-line flag](#_enable_script_checks). - `enable_script_checks` Equivalent to the [`-enable-script-checks` command-line flag](#_enable_script_checks).
~> **Security Warning:** Enabling script checks in some configurations may ACLs must be enabled for agents and the `enable_script_checks` option must be set to `true` to enable script checks in Consul 0.9.0 and later. See [Registering and Querying Node Information](/docs/security/acl/acl-rules#registering-and-querying-node-information) for related information.
introduce a remote execution vulnerability which is known to be targeted by
malware. We strongly recommend `enable_local_script_checks` instead. See [this ~> **Security Warning:** Enabling script checks in some configurations may introduce a known remote execution vulnerability targeted by malware. We strongly recommend `enable_local_script_checks` instead. Refer to the following article for additional guidance: [_Protecting Consul from RCE Risk in Specific Configurations_](https://www.hashicorp.com/blog/protecting-consul-from-rce-risk-in-specific-configurations)
blog post](https://www.hashicorp.com/blog/protecting-consul-from-rce-risk-in-specific-configurations)
for more details. for more details.
- `enable_local_script_checks` Equivalent to the [`-enable-local-script-checks` command-line flag](#_enable_local_script_checks). - `enable_local_script_checks` Equivalent to the [`-enable-local-script-checks` command-line flag](#_enable_local_script_checks).

663
website/content/docs/security/acl/acl-rules.mdx
View File

@ -18,37 +18,82 @@ This topic describes how to configure rules for Consul's access control list (AC
ACL rules describe the level of access to resources. A rule is composed of a resource declaration and an access level defined with the `policy` keyword and a [policy disposition](#policy-dispositions). The following syntax describes the basic structure of a rule: ACL rules describe the level of access to resources. A rule is composed of a resource declaration and an access level defined with the `policy` keyword and a [policy disposition](#policy-dispositions). The following syntax describes the basic structure of a rule:
<CodeTabs heading="Basic syntax for configuring an ACL rule">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
<resource> { <resource> {
policy = "<policy disposition>" policy = "<policy disposition>"
} }
``` ```
### Segments </CodeBlockConfig>
<CodeBlockConfig lineNumbers>
Many resources take an additional value that limits the scope of the rule to a resource _segment_. A resource segment can be the name of a specific set of resources, such as nodes configured with the same `name` value.
The following syntax describes how to include a resource segment in the rule: ```json
"<resource>": [{
"policy": "<policy disposition>"
}]
```
</CodeBlockConfig>
</CodeTabs>
### Resource Labels
Many resources take an additional value that limits the scope of the rule to resources with the same label. A resource label can be the name of a specific set of resources, such as nodes configured with the same `name` value.
The following syntax describes how to include a resource label in the rule:
<CodeTabs heading="Syntax for applying an ACL rule to named resources">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
<resource> "<segment>" { <resource> "<label>" {
policy = "<policy disposition>" policy = "<policy disposition>"
} }
``` ```
Segmentation provides operators with more granular control over access to the resouce. Some resources, however, do not take a segment value. The following resource areas _can not_ be segmented: </CodeBlockConfig>
<CodeBlockConfig lineNumbers>
```json
"<resource>": [{
"<label>": [{
"policy": "<policy disposition>"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Labels provide operators with more granular control over access to the resouce, but the following resource types do not take a label:
* `acl` * `acl`
* `keyring` * `keyring`
* `mesh` * `mesh`
* `operator` * `operator`
Use the following syntax to create rules for non-segmented resources: Use the following syntax to create rules for these resources:
<CodeTabs heading="Syntax for resources that take ACL rule configurations directly">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
<resource> = "<policy disposition>" <resource> = "<policy disposition>"
``` ```
</CodeBlockConfig>
<CodeBlockConfig lineNumbers>
```json
"<resource>": "<policy disposition>"
```
</CodeBlockConfig>
</CodeTabs>
### Policy Dispositions ### Policy Dispositions
Use the `policy` keyword and one of the following access levels to set a policy disposition: Use the `policy` keyword and one of the following access levels to set a policy disposition:
@ -57,38 +102,86 @@ Use the `policy` keyword and one of the following access levels to set a policy
- `write`: Allows the resource to be read and modified. - `write`: Allows the resource to be read and modified.
- `deny`: Denies read and write access to the resource. - `deny`: Denies read and write access to the resource.
You can also use a special `list` access level to allows access to all keys under a segment in the Consul KV. The `list` access level can only be used with the `key_prefix` resource. The [`acl.enable_key_list_policy`](/docs/agent/options#acl_enable_key_list_policy) setting must be set to `true`. The special `list` access level provices access to all keys with the specified resource label in the Consul KV. The `list` access level can only be used with the `key_prefix` resource. The [`acl.enable_key_list_policy`](/docs/agent/options#acl_enable_key_list_policy) setting must be set to `true`.
### Matching and Prefix Values ### Matching and Prefix Values
You can define rules for resource segments based on exact matches or by using resource prefixes to match several resource segments beginning with the same value. Matching segments on exact values is described in the [Segments](#segments) section. You can define rules for labeled resources based on exact matches or by using resource prefixes to match several resource labels beginning with the same value. Matching resource labels on exact values is described in the [Resource Labels](#resource-labels) section.
The following example rule is an exact match that denies access to `web-prod` service segments: The following example rule is an exact match that denies access to services labeled `web-prod`:
<CodeTabs heading="Example rule that denies access to services named 'web-prod'">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
service "web-prod" { service "web-prod" {
policy = "deny" policy = "deny"
} }
``` ```
You can append the resource with `_prefix` to match all resource segments beginning with the same value. The following example rule allows `write` access to all service segments that begin with "web": </CodeBlockConfig>
<CodeBlockConfig lineNumbers>
```json
"service": [{
"web-prod" : [{
"policy" : "deny"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
You can append the resource with `_prefix` to match all resource labels beginning with the same value. The following example rule allows `write` access to all services with labels that begin with "web":
<CodeTabs heading="Example rule that grants read and write access to services with names beginning with 'web'">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
service_prefix "web" { service_prefix "web" {
policy = "write" policy = "write"
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig lineNumbers>
Prefix-based resource segments can also contain an empty string, which configures the rule to apply to all resources of the declared type. The following example rule allows `read` access to all `service` resources: ```json
"service_prefix": [{
"web" : [{
"policy" : "write"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Prefix-based resource labels can also contain an empty string, which configures the rule to apply to all resources of the declared type. The following example rule allows `read` access to all `service` resources:
<CodeTabs heading="Example rule that grants read access to all services">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
service_prefix "" { service_prefix "" {
policy = "read" policy = "read"
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig lineNumbers>
```json
"service_prefix" : [{
"" : [{
"policy" :"read"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
When using prefix-based rules, the most specific prefix match determines the action. In a real-world scenario, a combination of rules would be combined to create a flexible policy. Each team or business unit would use tokesn based on polcies that enforce several rules, for example: When using prefix-based rules, the most specific prefix match determines the action. In a real-world scenario, a combination of rules would be combined to create a flexible policy. Each team or business unit would use tokesn based on polcies that enforce several rules, for example:
* A rule that denies access to a specific resource segment * A rule that denies access to a specific resource label
* A prefix-based rule that allows write access to a class of resources * A prefix-based rule that allows write access to a class of resources
* An empty prefix that grants read-only access to all resource within the declared class * An empty prefix that grants read-only access to all resource within the declared class
@ -105,9 +198,10 @@ Exact matching rules will only apply to the exact resource specified. The order
Define rules using the Define rules using the
[HashiCorp Configuration Language (HCL)](https://github.com/hashicorp/hcl/). [HashiCorp Configuration Language (HCL)](https://github.com/hashicorp/hcl/).
HCL is human readable and interoperable with JSON, making it easy to automate rule generation. HCL is human readable and interoperable with JSON, making it easy to automate rule generation.
The following examples show the same rule formatted in HCL and JSON: The following examples show the same rules formatted in HCL and JSON:
#### HCL <CodeTabs heading="Example rules">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
# These control access to the key/value store. # These control access to the key/value store.
@ -129,30 +223,50 @@ key "foo/bar/secret" {
operator = "read" operator = "read"
``` ```
#### JSON </CodeBlockConfig>
<CodeBlockConfig lineNumbers>
```json ```json
{ {
"key_prefix": { "key": [
"": { {
"policy": "read" "foo/bar/secret": [
}, {
"foo/": { "policy": "deny"
"policy": "write" }
}, ]
"foo/private/": {
"policy": "deny"
} }
}, ],
"key": { "key_prefix": [
"foo/bar/secret": { {
"policy": "deny" "": [
{
"policy": "read"
}
]
},
{
"foo/": [
{
"policy": "write"
}
]
},
{
"foo/private/": [
{
"policy": "deny"
}
]
} }
}, ],
"operator": "read" "operator": "read"
} }
``` ```
</CodeBlockConfig>
</CodeTabs>
## Defining Rules with the ACL API ## Defining Rules with the ACL API
You can configure ACLs remotely by calling the ACL HTTP API endpoint and including rules in the payload. The endpoint takes data formatted in HCL or JSON. Refer to the [ACL HTTP API endpoint documentation](/api/acl/acl) for details about the API. You can configure ACLs remotely by calling the ACL HTTP API endpoint and including rules in the payload. The endpoint takes data formatted in HCL or JSON. Refer to the [ACL HTTP API endpoint documentation](/api/acl/acl) for details about the API.
@ -202,7 +316,7 @@ This will grant the rules provided to the [bearer of that token](/api#authentica
The following table provides an overview of the resources you can use to create ACL rules. The following table provides an overview of the resources you can use to create ACL rules.
| Resource | Description | Segments | | Resource | Description | Labels |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------| |-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `acl` | Controls access to ACL operations in the [ACL API](/api/acl/acl). <br/>See [ACL Resource Rules](#acl-resource-rules) for details. | No | | `acl` | Controls access to ACL operations in the [ACL API](/api/acl/acl). <br/>See [ACL Resource Rules](#acl-resource-rules) for details. | No |
| `admin_partition`<br/>`admin_partition_prefix` | <EnterpriseAlert inline /> Controls access to one or more admin partitions. <br/>See [Admin Partition Rules](#admin-partition-rules) for details. | Yes | | `admin_partition`<br/>`admin_partition_prefix` | <EnterpriseAlert inline /> Controls access to one or more admin partitions. <br/>See [Admin Partition Rules](#admin-partition-rules) for details. | Yes |
@ -210,7 +324,7 @@ The following table provides an overview of the resources you can use to create
| `event`<br/>`event_prefix` | Controls access to event operations in the [Event API](/api/event), such as firing and listing events. <br/>See [Event Rules](#event-rules) for details. | Yes | | `event`<br/>`event_prefix` | Controls access to event operations in the [Event API](/api/event), such as firing and listing events. <br/>See [Event Rules](#event-rules) for details. | Yes |
| `key`<br/>`key_prefix` &nbsp; | Controls access to key/value store operations in the [KV API](/api/kv). <br/>Can also use the `list` access level when setting the policy disposition. <br/>Has additional value options in Consul Enterprise for integrating with [Sentinel](https://docs.hashicorp.com/sentinel/consul). <br/>See [Key/Value Rules](#key-value-rules) for details. | Yes | | `key`<br/>`key_prefix` &nbsp; | Controls access to key/value store operations in the [KV API](/api/kv). <br/>Can also use the `list` access level when setting the policy disposition. <br/>Has additional value options in Consul Enterprise for integrating with [Sentinel](https://docs.hashicorp.com/sentinel/consul). <br/>See [Key/Value Rules](#key-value-rules) for details. | Yes |
| `keyring` &nbsp; &nbsp; &nbsp; | Controls access to keyring operations in the [Keyring API](/api/keyring). <br/>See [Keyring Rules](#keyring-rules) for details. | No | | `keyring` &nbsp; &nbsp; &nbsp; | Controls access to keyring operations in the [Keyring API](/api/keyring). <br/>See [Keyring Rules](#keyring-rules) for details. | No |
| `mesh` &nbsp; &nbsp; &nbsp; | Provides operator-level permissions for resources in the admin partition, such as ingress gateways or mesh proxy defaults. See [Mesh Rules](#mesh-rulres) for details. | No | | `mesh` &nbsp; &nbsp; &nbsp; | Provides operator-level permissions for resources in the admin partition, such as ingress gateways or mesh proxy defaults. See [Mesh Rules](#mesh-rules) for details. | No |
| `namespace`<br/>`namespace_prefix` | <EnterpriseAlert inline /> Controls access to one or more namespaces. <br/>See [Namespace Rules](#namespace-rules) for details. | Yes | | `namespace`<br/>`namespace_prefix` | <EnterpriseAlert inline /> Controls access to one or more namespaces. <br/>See [Namespace Rules](#namespace-rules) for details. | Yes |
| `node`<br/>`node_prefix` &nbsp; | Controls access to node-level registration and read access to the [Catalog API](/api/catalog). <br/>See [Node Rules](#node-rules) for details. | Yes | | `node`<br/>`node_prefix` &nbsp; | Controls access to node-level registration and read access to the [Catalog API](/api/catalog). <br/>See [Node Rules](#node-rules) for details. | Yes |
| `operator` &nbsp; &nbsp; &nbsp; | Controls access to cluster-level operations available in the [Operator API](/api/operator) excluding keyring API endpoints. <br/>See [Operator Rules](#operator-rules) for details. | No | | `operator` &nbsp; &nbsp; &nbsp; | Controls access to cluster-level operations available in the [Operator API](/api/operator) excluding keyring API endpoints. <br/>See [Operator Rules](#operator-rules) for details. | No |
@ -226,14 +340,27 @@ The `acl` resource controls access to ACL operations in the [ACL API](/api/acl/a
The `acl = "write"` rule is also required to create snapshots. This is because all token secrets are contained within the snapshot. The `acl = "write"` rule is also required to create snapshots. This is because all token secrets are contained within the snapshot.
Rules for ACL resources are non-segmented. Rules for ACL resources do not use labels.
In the following example, `write` access to the ACL API. The rule enables the operator to read or write ACLs, as well as discover the secret ID of any token. In the following example, `write` access to the ACL API. The rule enables the operator to read or write ACLs, as well as discover the secret ID of any token.
<CodeTabs heading="Example acl rule">
<CodeBlockConfig>
```hcl ```hcl
acl = "write" acl = "write"
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
```json
"acl" : "write"
```
</CodeBlockConfig>
</CodeTabs>
### Admin Partition Rules <EnterpriseAlert inline /> ### Admin Partition Rules <EnterpriseAlert inline />
The `admin_partition` and `admin_partition_prefix` resource controls access to one or more admin partitions. The `admin_partition` and `admin_partition_prefix` resource controls access to one or more admin partitions.
@ -242,6 +369,9 @@ You can include any number of namespace rules inside the admin partition.
In the following example, the agent has write access to the `ex-namespace` namespace, as well as namespaces prefixed with `ex-` in the `example` partition. In the following example, the agent has write access to the `ex-namespace` namespace, as well as namespaces prefixed with `ex-` in the `example` partition.
The `mesh` resource is also scoped to the admin partition rule, which grants `write` access to mesh-level resources in the partition: The `mesh` resource is also scoped to the admin partition rule, which grants `write` access to mesh-level resources in the partition:
<CodeTabs heading="Example admin partition rules">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
admin_partition "example" { admin_partition "example" {
mesh = "write" mesh = "write"
@ -261,13 +391,66 @@ admin_partition_prefix "ex-" {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
```json
{
"admin_partition": [{
"example": [{
"mesh": "write",
"node": [{
"my-node": [{
"policy": "write"
}],
"namespace": [{
"ex-namespace": [{
"policy": "read"
}]
}],
"namespace_prefix": [{
"exns-": [{
"policy": "read"
}]
}]
}]
}]
}]
},
{
"admin_partition_prefix": [{
"": [{
"policy": "read"
}],
"example": [{
"mesh": "read",
"node": [{
"my-node": [{
"policy": "read"
}]
}],
"namespace": [{
"ex-namespace": [{
"policy": "read"
}]
}]
}]
}]
}
```
</CodeBlockConfig>
</CodeTabs>
### Agent Rules ### Agent Rules
The `agent` and `agent_prefix` resources control access to the utility operations in the [Agent API](/api/agent), The `agent` and `agent_prefix` resources control access to the utility operations in the [Agent API](/api/agent),
such as join and leave. All of the catalog-related operations are covered by the [`node` or `node_prefix`](#node-rules) such as join and leave. All of the catalog-related operations are covered by the [`node` or `node_prefix`](#node-rules)
and [`service` or `service_prefix`](#service-rules) policies instead. and [`service` or `service_prefix`](#service-rules) policies instead.
Agent rules look like this: <CodeTabs heading="Example agent rules">
<CodeBlockConfig lineNumbers>
```hcl ```hcl
agent_prefix "" { agent_prefix "" {
@ -281,6 +464,28 @@ agent_prefix "bar" {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig lineNumbers>
```json
"agent_prefix" : [{
"" : [{
"policy" : "read"
}],
"bar" : [{
"policy" : "deny"
}]
}],
"agent" : [{
"foo" : [{
"policy" : "write"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Agent rules are keyed by the node name they apply to. In the example above the rules Agent rules are keyed by the node name they apply to. In the example above the rules
allow read-only access to any node name by using the empty prefix, read-write access to allow read-only access to any node name by using the empty prefix, read-write access to
the node with the _exact_ name `foo`, and denies all access to any node name that starts the node with the _exact_ name `foo`, and denies all access to any node name that starts
@ -296,7 +501,8 @@ write access to these operations even if no ACL resolution capability is availab
The `event` and `event_prefix` resources control access to event operations in the [Event API](/api/event), such as The `event` and `event_prefix` resources control access to event operations in the [Event API](/api/event), such as
firing events and listing events. firing events and listing events.
Event rules look like this: <CodeTabs heading="Example event rules">
<CodeBlockConfig>
```hcl ```hcl
event_prefix "" { event_prefix "" {
@ -306,8 +512,26 @@ event "deploy" {
policy = "write" policy = "write"
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
Event rules are segmented by the event name they apply to. In the example above, the rules allow ```json
"event_prefix" : [{
"" : [{
"policy" : "read"
}]
}],
"event" : [{
"deploy" : [{
"policy" : "write"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Event rules are labeled with the event name they apply to. In the example above, the rules allow
read-only access to any event, and firing of the "deploy" event. read-only access to any event, and firing of the "deploy" event.
The [`consul exec`](/commands/exec) command uses events with the "\_rexec" prefix during The [`consul exec`](/commands/exec) command uses events with the "\_rexec" prefix during
@ -317,8 +541,10 @@ give agents a token with access to this event prefix, in addition to configuring
### Key/Value Rules ### Key/Value Rules
The `key` and `key_prefix` resources control access to key/value store operations in the [KV API](/api/kv). Key The `key` and `key_prefix` resources control access to key/value store operations in the [KV API](/api/kv).
rules look like this:
<CodeTabs heading="Example key rules">
<CodeBlockConfig>
```hcl ```hcl
key_prefix "" { key_prefix "" {
@ -331,15 +557,38 @@ key "bar" {
policy = "deny" policy = "deny"
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
Key rules are segmented by the key name they apply to. In the example above, the rules allow read-only access ```json
"key_prefix" : [{
"" : [{
"policy" : "read"
}]
}],
"key" : [{
"foo" : [{
"policy" : "write"
}],
"bar" : [{
"policy" : "deny"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Key rules are labeled with the key name they apply to. In the example above, the rules allow read-only access
to any key name with the empty prefix rule, allow read-write access to the "foo" key, and deny access to the "bar" key. to any key name with the empty prefix rule, allow read-write access to the "foo" key, and deny access to the "bar" key.
#### List Policy for Keys #### List Policy for Keys
Consul 1.0 introduces a new `list` policy for keys that is only enforced when opted in via the boolean config param "acl.enable_key_list_policy". Enable the `list` policy disposition (Consul 1.0+) by setting the `acl.enable_key_list_policy` parameter to `true`. The disposition provides recursive access to `key` entries. Refer to the [KV API](/api/kv#recurse) documentation for additional information. In the following example, `key` resources that start with `bar` are listed.
`list` controls access to recursively list entries and keys, and enables more fine grained policies. With "acl.enable_key_list_policy",
recursive reads via [the KV API](/api/kv#recurse) with an invalid token result in a 403. Example:
<CodeTabs heading="Example 'key' rules">
<CodeBlockConfig>
```hcl ```hcl
key_prefix "" { key_prefix "" {
@ -355,6 +604,26 @@ key_prefix "baz" {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
```json
"key_prefix" : [{
"" : [{
"policy" : "deny"
}],
"bar" : [{
"policy" : "list"
}],
"baz" : [{
"policy" : "read"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
In the example above, the rules allow reading the key "baz", and only allow recursive reads on the prefix "bar". In the example above, the rules allow reading the key "baz", and only allow recursive reads on the prefix "bar".
A token with `write` access on a prefix also has `list` access. A token with `list` access on a prefix also has `read` access on all its suffixes. A token with `write` access on a prefix also has `list` access. A token with `list` access on a prefix also has `read` access on all its suffixes.
@ -362,8 +631,7 @@ A token with `write` access on a prefix also has `list` access. A token with `li
#### Sentinel Integration <EnterpriseAlert inline /> #### Sentinel Integration <EnterpriseAlert inline />
Consul Enterprise supports additional optional fields for key write policies for Consul Enterprise supports additional optional fields for key write policies for
[Sentinel](https://docs.hashicorp.com/sentinel/consul/) integration. An example key rule with a [Sentinel](https://docs.hashicorp.com/sentinel/consul/) integration.
Sentinel code policy looks like this:
```hcl ```hcl
key "foo" { key "foo" {
@ -382,24 +650,45 @@ For more detailed information, see the [Consul Sentinel documentation](/docs/age
### Keyring Rules ### Keyring Rules
The `keyring` resource controls access to keyring operations in the The `keyring` resource controls access to keyring operations in the [Keyring API](/api/operator/keyring). Only one keyring policy is allowed per rule set. The value is set to one of the policy dispositions, but may be read and updated.
[Keyring API](/api/operator/keyring).
Keyring rules look like this: <CodeTabs heading="Example keyring rule">
<CodeBlockConfig>
```hcl ```hcl
keyring = "write" keyring = "write"
``` ```
There's only one keyring policy allowed per rule set, and its value is set to one of the policy </CodeBlockConfig>
dispositions. In the example above, the keyring may be read and updated. <CodeBlockConfig>
```json
"keyring" : "write"
```
</CodeBlockConfig>
</CodeTabs>
### Mesh Rules ### Mesh Rules
The `mesh` resource controls access to ingress gateways, terminating gateways, and mesh configuration entries. The `mesh` resource controls access to ingress gateways, terminating gateways, and mesh configuration entries. The following rule grants read and write access:
See [Admin Partition Rules](#admin-partition-rules) for an example rule that uses the `mesh` resource. <CodeTabs heading="Example mesh rule">
<CodeBlockConfig>
```hcl
mesh = "write"
```
</CodeBlockConfig>
<CodeBlockConfig>
```json
"mesh" : "write"
```
</CodeBlockConfig>
</CodeTabs>
See [Admin Partition Rules](#admin-partition-rules) for another example rule that uses the `mesh` resource.
### Namespace Rules <EnterpriseAlert inline /> ### Namespace Rules <EnterpriseAlert inline />
@ -409,6 +698,9 @@ The `namespace` and `namespace_prefix` resource controls access to Consul namesp
The following examples describe how namespace rules can be defined in a policy: The following examples describe how namespace rules can be defined in a policy:
<CodeTabs heading="Example namespace rules">
<CodeBlockConfig>
```hcl ```hcl
namespace_prefix "" { namespace_prefix "" {
@ -421,13 +713,15 @@ namespace_prefix "" {
node_prefix "" { node_prefix "" {
policy = "read" policy = "read"
} }
# grants permission to create and edit all namespace
policy = "write"
} }
namespace "foo" { namespace "foo" {
# grants permission to manage ACLs only for the foo namespace # grants permission to manage ACLs only for the foo namespace
acl = "write" acl = "write"
# grants permission to rename the foo namespace # grants permission to create and edit the foo namespace
policy = "write" policy = "write"
# grants write permissions to the KV for namespace foo # grants write permissions to the KV for namespace foo
@ -451,6 +745,57 @@ namespace "foo" {
} }
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
```json
{
"namespace": [{
"foo": [{
"acl": "write",
"key_prefix": [{
"": [{
"policy": "write"
}]
}],
"node_prefix": [{
"": [{
"policy": "read"
}]
}],
"policy": "write",
"service_prefix": [{
"": [{
"policy": "write"
}]
}],
"session_prefix": [{
"": [{
"policy": "write"
}]
}]
}]
}],
"namespace_prefix": [{
"": [{
"node_prefix": [{
"": [{
"policy": "read"
}]
}],
"policy": "write",
"service_prefix": [{
"": [{
"policy": "read"
}]
}]
}]
}]
}
```
</CodeBlockConfig>
</CodeTabs>
#### Restrictions #### Restrictions
@ -475,11 +820,19 @@ specific namespace are prevented from accessing resources in another namespace.
### Node Rules ### Node Rules
The `node` and `node_prefix` resources controls node-level registration and read access to the [Catalog API](/api/catalog), The `node` and `node_prefix` resources control access to the following API behaviors:
service discovery with the [Health API](/api/health), and filters results in [Agent API](/api/agent)
operations like fetching the list of cluster members.
Node rules look like this: * node-level registration and read access to the [Catalog API](/api/catalog)
* service discovery with the [Health API](/api/health)
* filtering results in [Agent API](/api/agent) operations, such as fetching the list of cluster members.
You can use resource labels to scope the rule to a specific resource or set of resources.
The following example rule uses an empty prefix label, which provides read-only access to all nodes.
The rule also provides read-write access to the `app` node and denies all access to the `admin` node:
<CodeTabs heading="Example node rules">
<CodeBlockConfig>
```hcl ```hcl
node_prefix "" { node_prefix "" {
@ -493,64 +846,78 @@ node "admin" {
} }
``` ```
Node rules are segmented by the node name they apply to. In the example above, the rules allow read-only access to any node name with the empty prefix, allow </CodeBlockConfig>
read-write access to the "app" node, and deny all access to the "admin" node. <CodeBlockConfig>
Agents need to be configured with an [`acl.tokens.agent`](/docs/agent/options#acl_tokens_agent) ```json
with at least "write" privileges to their own node name in order to register their information with "node_prefix" : [{
the catalog, such as node metadata and tagged addresses. If this is configured incorrectly, the agent "" : [{
will print an error to the console when it tries to sync its state with the catalog. "policy" : "read"
}],
"app" : [{
"policy" : "write"
}],
"admin" : [{
"policy" : "deny"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Consul's DNS interface is also affected by restrictions on node rules. If the #### Registering and Querying Node Information
[`acl.token.default`](/docs/agent/options#acl_tokens_default) used by the agent does not have "read" access to a
given node, then the DNS interface will return no records when queried for it.
When reading from the catalog or retrieving information from the health endpoints, node rules are Agents must be configured with `write` privileges for their own node name so that the agent can register their node metadata, tagged addresses, and other information in the catalog.
used to filter the results of the query. This allows for configurations where a token has access If configured incorrectly, the agent will print an error to the console when it tries to sync its state with the catalog.
to a given service name, but only on an allowed subset of node names. Configure `write` access in the [`acl.tokens.agent`](/docs/agent/options#acl_tokens_agent) parameter.
Node rules come into play when using the [Agent API](/api/agent) to register node-level The [`acl.token.default`](/docs/agent/options#acl_tokens_default) used by the agent should have `read` access to a given node so that the DNS interface can be queried.
checks. The agent will check tokens locally as a check is registered, and Consul also performs
periodic [anti-entropy](/docs/internals/anti-entropy) syncs, which may require an
ACL token to complete. To accommodate this, Consul provides two methods of configuring ACL tokens
to use for registration events:
1. Using the [acl.tokens.default](/docs/agent/options#acl_tokens_default) configuration Node rules are used to filter query results when reading from the catalog or retrieving information from the health endpoints. This allows for configurations where a token has access to a given service name, but only on an allowed subset of node names.
directive. This allows a single token to be configured globally and used
during all check registration operations.
2. Providing an ACL token with service and check definitions at
registration time. This allows for greater flexibility and enables the use
of multiple tokens on the same agent. Examples of what this looks like are
available for both [services](/docs/agent/services) and
[checks](/docs/agent/checks). Tokens may also be passed to the
[HTTP API](/api) for operations that require them.
In addition to ACLs, in Consul 0.9.0 and later, the agent must be configured with Consul agents check tokens locally when health checks are registered and when Consul performs periodic [anti-entropy](/docs/internals/anti-entropy) syncs.
[`enable_script_checks`](/docs/agent/options#_enable_script_checks) set to `true` in order to enable These actions may required an ACL token to complete. Use the following methods to configure ACL tokens for registration events:
script checks.
* Configure a global token in the [acl.tokens.default](/docs/agent/options#acl_tokens_default) parameter.
This allows a single token to be used during all check registration operations.
* Provide an ACL token with service and check definitions at registration time.
This allows for greater flexibility and enables the use of multiple tokens on the same agent.
Refer to the [services](/docs/agent/services) and [checks](/docs/agent/checks) documentation for examples.
Tokens may also be passed to the [HTTP API](/api) for operations that require them.
### Operator Rules ### Operator Rules
The `operator` resource controls access to cluster-level operations in the The `operator` resource controls access to cluster-level operations in the
[Operator API](/api/operator), other than the [Keyring API](/api/operator/keyring). [Operator API](/api/operator), other than the [Keyring API](/api/operator/keyring).
Operator rules look like this: Only one operator rule allowed per rule set. In the following example, the token may be used to query the operator endpoints for
diagnostic purposes but it will not make changes.
<CodeTabs heading="Example operator rule">
<CodeBlockConfig>
```hcl ```hcl
operator = "read" operator = "read"
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
```json
"operator" : "read"
```
</CodeBlockConfig>
</CodeTabs>
There's only one operator rule allowed per rule set, and its value is set to one of the policy
dispositions. In the example above, the token could be used to query the operator endpoints for
diagnostic purposes but not make any changes.
### Prepared Query Rules ### Prepared Query Rules
The `query` and `query_prefix` resources control access to create, update, and delete prepared queries in the The `query` and `query_prefix` resources control access to create, update, and delete prepared queries in the
[Prepared Query API](/api/query). Executing queries is subject to `node`/`node_prefix` and `service`/`service_prefix` [Prepared Query API](/api/query). Specify the resource label in query rules to determine the scope of the rule.
policies, as will be explained below. The resource label in the following example is empty. As a result, the rules allow read-only access to query resources with any name.
The rules also grant read-write access to the query named `foo`, which allows control of the query namespace to be delegated based on ACLs:
Query rules look like this: <CodeTabs heading="Example query rules">
<CodeBlockConfig>
```hcl ```hcl
query_prefix "" { query_prefix "" {
@ -561,9 +928,26 @@ query "foo" {
} }
``` ```
Query rules are segmented by the query name they apply to. In the example above, the rules allow read-only </CodeBlockConfig>
access to any query name with the empty prefix, and allow read-write access to the query named "foo". <CodeBlockConfig>
This allows control of the query namespace to be delegated based on ACLs.
```json
"query_prefix" : [{
"" : [{
"policy" : "read"
}]
}],
"query" : [{
"foo" : [{
"policy" : "write"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Executing queries is subject to `node`/`node_prefix` and `service`/`service_prefix`
policies.
There are a few variations when using ACLs with prepared queries, each of which uses ACLs in one of two There are a few variations when using ACLs with prepared queries, each of which uses ACLs in one of two
ways: open, protected by unguessable IDs or closed, managed by ACL policies. These variations are covered ways: open, protected by unguessable IDs or closed, managed by ACL policies. These variations are covered
@ -618,8 +1002,8 @@ Capturing ACL Tokens is analogous to
`SECURITY DEFINER` attribute which can be set on functions, and using the client's ACL `SECURITY DEFINER` attribute which can be set on functions, and using the client's ACL
Token is similar to the complementary `SECURITY INVOKER` attribute. Token is similar to the complementary `SECURITY INVOKER` attribute.
Prepared queries were originally introduced in Consul 0.6.0, and ACL behavior remained Prepared queries were originally introduced in Consul 0.6.0. The ACL behavior remained
unchanged through version 0.6.3, but was then changed to allow better management of the unchanged through version 0.6.3, but versions after 0.6.3 included changes that improve management of the
prepared query namespace. prepared query namespace.
These differences are outlined in the table below: These differences are outlined in the table below:
@ -635,10 +1019,13 @@ These differences are outlined in the table below:
### Service Rules ### Service Rules
The `service` and `service_prefix` resources control service-level registration and read access to the [Catalog API](/api/catalog) The `service` and `service_prefix` resources control service-level registration and read access to the [Catalog API](/api/catalog) and service discovery with the [Health API](/api/health).
and service discovery with the [Health API](/api/health). Specify the resource label in service rules to set the scope of the rule.
The resource label in the following example is empty. As a result, the rules allow read-only access to any service name with the empty prefix.
The rules also allow read-write access to the `app` service and deny all access to the `admin` service:
Service rules look like this: <CodeTabs heading="Example service rules">
<CodeBlockConfig>
```hcl ```hcl
service_prefix "" { service_prefix "" {
@ -651,13 +1038,29 @@ service "admin" {
policy = "deny" policy = "deny"
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
Service rules are segmented by the service name they apply to. In the example above, the rules allow read-only ```json
access to any service name with the empty prefix, allow read-write access to the "app" service, and deny all "service_prefix" : [{
access to the "admin" service. "" : [{
"policy" : "read"
}]
}],
"service" : [{
"app" : [{
"policy" : "write"
}],
"admin" : [{
"policy" : "deny"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>
Consul's DNS interface is affected by restrictions on service rules. If the Consul's DNS interface is affected by restrictions on service rules. If the
[`acl.tokens.default`](/docs/agent/options#acl_tokens_default) used by the agent does not have "read" access to a [`acl.tokens.default`](/docs/agent/options#acl_tokens_default) used by the agent does not have `read` access to a
given service, then the DNS interface will return no records when queried for it. given service, then the DNS interface will return no records when queried for it.
When reading from the catalog or retrieving information from the health endpoints, service rules are When reading from the catalog or retrieving information from the health endpoints, service rules are
@ -692,6 +1095,9 @@ Service rules are also used to grant read or write access to intentions. The
following policy provides read-write access to the "app" service, and explicitly following policy provides read-write access to the "app" service, and explicitly
grants `intentions:read` access to view intentions associated with the "app" service. grants `intentions:read` access to view intentions associated with the "app" service.
<CodeTabs heading="Example service rule with intentions">
<CodeBlockConfig>
```hcl ```hcl
service "app" { service "app" {
policy = "write" policy = "write"
@ -699,6 +1105,20 @@ service "app" {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig>
```json
"service" : [{
"app" : [{
"policy" : "write"
}],
"intentions" : "read"
}]
```
</CodeBlockConfig>
</CodeTabs>
Refer to [Intention Management Permissions](/docs/connect/intentions#intention-management-permissions) Refer to [Intention Management Permissions](/docs/connect/intentions#intention-management-permissions)
for more information about managing intentions access with service rules. for more information about managing intentions access with service rules.
@ -706,7 +1126,12 @@ for more information about managing intentions access with service rules.
The `session` and `session_prefix` resources controls access to [Session API](/api/session) operations. The `session` and `session_prefix` resources controls access to [Session API](/api/session) operations.
Session rules look like this: Specify the resource label in session rules to set the scope of the rule.
The resource label in the following example is empty. As a result, the rules allow read-only access to all sessions.
The rules also allow creating sessions on the node named `app` and deny all access to any sessions on the `admin` node:
<CodeTabs heading="Example session rules">
<CodeBlockConfig>
```hcl ```hcl
session_prefix "" { session_prefix "" {
@ -720,6 +1145,24 @@ session "admin" {
} }
``` ```
Session rules are segmented by the node name they apply to. In the example above, the rules allow read-only </CodeBlockConfig>
access to sessions on node name with the empty prefix, allow creating sessions on the node named "app", <CodeBlockConfig>
and deny all access to any sessions on the "admin" node.
```json
"session_prefix" : [{
"" : [{
"policy" : "read"
}]
}],
"session" : [{
"app" : [{
"policy" : "write"
}],
"admin" : [{
"policy" : "deny"
}]
}]
```
</CodeBlockConfig>
</CodeTabs>