diff --git a/website/content/docs/agent/options.mdx b/website/content/docs/agent/options.mdx index 5ebe54320..1fff6541c 100644 --- a/website/content/docs/agent/options.mdx +++ b/website/content/docs/agent/options.mdx @@ -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 they are defined in the local configuration files. Script checks defined in HTTP API registrations will still not be allowed. + - `-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 @@ -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). - ~> **Security Warning:** Enabling script checks in some configurations may - introduce a remote execution vulnerability which is known to be targeted by - malware. We strongly recommend `enable_local_script_checks` instead. See [this - blog post](https://www.hashicorp.com/blog/protecting-consul-from-rce-risk-in-specific-configurations) + 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. + + ~> **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) for more details. - `enable_local_script_checks` Equivalent to the [`-enable-local-script-checks` command-line flag](#_enable_local_script_checks). diff --git a/website/content/docs/security/acl/acl-rules.mdx b/website/content/docs/security/acl/acl-rules.mdx index cfdf6459d..73c9bf7f6 100644 --- a/website/content/docs/security/acl/acl-rules.mdx +++ b/website/content/docs/security/acl/acl-rules.mdx @@ -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: + + + ```hcl { policy = "" -} + } ``` -### Segments - -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 +"": [{ + "policy": "" + }] +``` + + + + +### 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: + + + ```hcl - "" { + " + + +```json +"": [{ + " + + +Labels provide operators with more granular control over access to the resouce, but the following resource types do not take a label: * `acl` * `keyring` * `mesh` * `operator` -Use the following syntax to create rules for non-segmented resources: +Use the following syntax to create rules for these resources: + + + ```hcl = "" ``` + + + +```json +"": "" +``` + + + + ### Policy Dispositions 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. - `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 -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`: + + + ```hcl service "web-prod" { 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": + + + +```json +"service": [{ + "web-prod" : [{ + "policy" : "deny" + }] +}] +``` + + + +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": + + + ```hcl service_prefix "web" { policy = "write" } ``` + + -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" + }] +}] +``` + + + + +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: + + + ```hcl service_prefix "" { policy = "read" } ``` + + + +```json +"service_prefix" : [{ + "" : [{ + "policy" :"read" + }] +}] +``` + + + 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 * 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 [HashiCorp Configuration Language (HCL)](https://github.com/hashicorp/hcl/). 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 + + ```hcl # These control access to the key/value store. @@ -129,30 +223,50 @@ key "foo/bar/secret" { operator = "read" ``` -#### JSON + + ```json { - "key_prefix": { - "": { - "policy": "read" - }, - "foo/": { - "policy": "write" - }, - "foo/private/": { - "policy": "deny" + "key": [ + { + "foo/bar/secret": [ + { + "policy": "deny" + } + ] } - }, - "key": { - "foo/bar/secret": { - "policy": "deny" + ], + "key_prefix": [ + { + "": [ + { + "policy": "read" + } + ] + }, + { + "foo/": [ + { + "policy": "write" + } + ] + }, + { + "foo/private/": [ + { + "policy": "deny" + } + ] } - }, + ], "operator": "read" } ``` + + + ## 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. @@ -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. -| Resource | Description | Segments | +| Resource | Description | Labels | |-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | `acl` | Controls access to ACL operations in the [ACL API](/api/acl/acl).
See [ACL Resource Rules](#acl-resource-rules) for details. | No | | `admin_partition`
`admin_partition_prefix` | Controls access to one or more admin partitions.
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`
`event_prefix` | Controls access to event operations in the [Event API](/api/event), such as firing and listing events.
See [Event Rules](#event-rules) for details. | Yes | | `key`
`key_prefix`   | Controls access to key/value store operations in the [KV API](/api/kv).
Can also use the `list` access level when setting the policy disposition.
Has additional value options in Consul Enterprise for integrating with [Sentinel](https://docs.hashicorp.com/sentinel/consul).
See [Key/Value Rules](#key-value-rules) for details. | Yes | | `keyring`       | Controls access to keyring operations in the [Keyring API](/api/keyring).
See [Keyring Rules](#keyring-rules) for details. | No | -| `mesh`       | 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`       | 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`
`namespace_prefix` | Controls access to one or more namespaces.
See [Namespace Rules](#namespace-rules) for details. | Yes | | `node`
`node_prefix`   | Controls access to node-level registration and read access to the [Catalog API](/api/catalog).
See [Node Rules](#node-rules) for details. | Yes | | `operator`       | Controls access to cluster-level operations available in the [Operator API](/api/operator) excluding keyring API endpoints.
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. -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. + + + ```hcl acl = "write" ``` + + + +```json +"acl" : "write" +``` + + + + ### Admin Partition Rules 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. The `mesh` resource is also scoped to the admin partition rule, which grants `write` access to mesh-level resources in the partition: + + + ```hcl admin_partition "example" { mesh = "write" @@ -261,13 +391,66 @@ admin_partition_prefix "ex-" { } ``` + + + +```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" + }] + }] + }] + }] +} +``` + + + + + ### Agent Rules 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) and [`service` or `service_prefix`](#service-rules) policies instead. -Agent rules look like this: + + ```hcl agent_prefix "" { @@ -281,6 +464,28 @@ agent_prefix "bar" { } ``` + + + +```json +"agent_prefix" : [{ + "" : [{ + "policy" : "read" + }], + "bar" : [{ + "policy" : "deny" + }] + }], +"agent" : [{ + "foo" : [{ + "policy" : "write" + }] +}] +``` + + + + 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 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 firing events and listing events. -Event rules look like this: + + ```hcl event_prefix "" { @@ -306,8 +512,26 @@ event "deploy" { policy = "write" } ``` + + -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" + }] +}] +``` + + + + +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. 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 -The `key` and `key_prefix` resources control access to key/value store operations in the [KV API](/api/kv). Key -rules look like this: +The `key` and `key_prefix` resources control access to key/value store operations in the [KV API](/api/kv). + + + ```hcl key_prefix "" { @@ -331,15 +557,38 @@ key "bar" { policy = "deny" } ``` + + -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" + }] +}] +``` + + + + +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. #### 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". -`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: +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. + + + + ```hcl key_prefix "" { @@ -355,6 +604,26 @@ key_prefix "baz" { } ``` + + + +```json +"key_prefix" : [{ + "" : [{ + "policy" : "deny" + }], + "bar" : [{ + "policy" : "list" + }], + "baz" : [{ + "policy" : "read" + }] +}] +``` + + + + 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. @@ -362,8 +631,7 @@ A token with `write` access on a prefix also has `list` access. A token with `li #### Sentinel Integration 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 code policy looks like this: +[Sentinel](https://docs.hashicorp.com/sentinel/consul/) integration. ```hcl key "foo" { @@ -382,24 +650,45 @@ For more detailed information, see the [Consul Sentinel documentation](/docs/age ### Keyring Rules -The `keyring` resource controls access to keyring operations in the -[Keyring API](/api/operator/keyring). +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 rules look like this: + + ```hcl keyring = "write" ``` -There's only one keyring policy allowed per rule set, and its value is set to one of the policy -dispositions. In the example above, the keyring may be read and updated. + + + +```json +"keyring" : "write" +``` + + + ### 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. - + + + +```hcl +mesh = "write" +``` + + + +```json +"mesh" : "write" +``` + + + +See [Admin Partition Rules](#admin-partition-rules) for another example rule that uses the `mesh` resource. ### Namespace Rules @@ -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: + + + ```hcl namespace_prefix "" { @@ -421,13 +713,15 @@ namespace_prefix "" { node_prefix "" { policy = "read" } + # grants permission to create and edit all namespace + policy = "write" } namespace "foo" { # grants permission to manage ACLs only for the foo namespace acl = "write" - # grants permission to rename the foo namespace + # grants permission to create and edit the foo namespace policy = "write" # grants write permissions to the KV for namespace foo @@ -451,6 +745,57 @@ namespace "foo" { } } ``` + + + +```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" + }] + }] + }] + }] +} +``` + + + #### Restrictions @@ -475,11 +820,19 @@ specific namespace are prevented from accessing resources in another namespace. ### Node Rules -The `node` and `node_prefix` resources controls node-level registration and read access to the [Catalog API](/api/catalog), -service discovery with the [Health API](/api/health), and filters results in [Agent API](/api/agent) -operations like fetching the list of cluster members. +The `node` and `node_prefix` resources control access to the following API behaviors: -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: + + + ```hcl 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 -read-write access to the "app" node, and deny all access to the "admin" node. + + -Agents need to be configured with an [`acl.tokens.agent`](/docs/agent/options#acl_tokens_agent) -with at least "write" privileges to their own node name in order to register their information with -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. +```json +"node_prefix" : [{ + "" : [{ + "policy" : "read" + }], + "app" : [{ + "policy" : "write" + }], + "admin" : [{ + "policy" : "deny" + }] +}] +``` + + -Consul's DNS interface is also affected by restrictions on node rules. If the -[`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. +#### Registering and Querying Node Information -When reading from the catalog or retrieving information from the health endpoints, node rules are -used to filter the results of the query. This allows for configurations where a token has access -to a given service name, but only on an allowed subset of node names. +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. +If configured incorrectly, the agent will print an error to the console when it tries to sync its state with the catalog. +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 -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: +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. -1. Using the [acl.tokens.default](/docs/agent/options#acl_tokens_default) configuration - 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. +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. -In addition to ACLs, in Consul 0.9.0 and later, the agent must be configured with -[`enable_script_checks`](/docs/agent/options#_enable_script_checks) set to `true` in order to enable -script checks. +Consul agents check tokens locally when health checks are registered and when Consul performs periodic [anti-entropy](/docs/internals/anti-entropy) syncs. +These actions may required an ACL token to complete. Use the following methods to configure ACL tokens for registration events: + +* 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 The `operator` resource controls access to cluster-level operations in the [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. + + + ```hcl operator = "read" ``` + + + +```json +"operator" : "read" +``` + + -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 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` -policies, as will be explained below. +[Prepared Query API](/api/query). Specify the resource label in query rules to determine the scope of the rule. +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: + + ```hcl 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 -access to any query name with the empty prefix, and allow read-write access to the query named "foo". -This allows control of the query namespace to be delegated based on ACLs. + + + +```json +"query_prefix" : [{ + "" : [{ + "policy" : "read" + }] +}], +"query" : [{ + "foo" : [{ + "policy" : "write" + }] +}] +``` + + + +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 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 Token is similar to the complementary `SECURITY INVOKER` attribute. -Prepared queries were originally introduced in Consul 0.6.0, and ACL behavior remained -unchanged through version 0.6.3, but was then changed to allow better management of the +Prepared queries were originally introduced in Consul 0.6.0. The ACL behavior remained +unchanged through version 0.6.3, but versions after 0.6.3 included changes that improve management of the prepared query namespace. These differences are outlined in the table below: @@ -635,10 +1019,13 @@ These differences are outlined in the table below: ### Service Rules -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). +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). +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: + + ```hcl service_prefix "" { @@ -651,13 +1038,29 @@ service "admin" { policy = "deny" } ``` + + -Service rules are segmented by the service name they apply to. In the example above, the rules allow read-only -access to any service name with the empty prefix, allow read-write access to the "app" service, and deny all -access to the "admin" service. +```json +"service_prefix" : [{ + "" : [{ + "policy" : "read" + }] +}], +"service" : [{ + "app" : [{ + "policy" : "write" + }], + "admin" : [{ + "policy" : "deny" + }] +}] +``` + + 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. 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 grants `intentions:read` access to view intentions associated with the "app" service. + + + ```hcl service "app" { policy = "write" @@ -699,6 +1105,20 @@ service "app" { } ``` + + + +```json +"service" : [{ + "app" : [{ + "policy" : "write" + }], + "intentions" : "read" +}] +``` + + + Refer to [Intention Management Permissions](/docs/connect/intentions#intention-management-permissions) 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. -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: + + + ```hcl 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 -access to sessions on node name with the empty prefix, allow creating sessions on the node named "app", -and deny all access to any sessions on the "admin" node. + + + +```json +"session_prefix" : [{ + "" : [{ + "policy" : "read" + }] +}], +"session" : [{ + "app" : [{ + "policy" : "write" + }], + "admin" : [{ + "policy" : "deny" + }] +}] +``` + + + \ No newline at end of file