Create a DNS token

This topic describes how to create a token that enables the Consul DNS to query services in the network when ACLs are enabled.

Introduction

The Consul binary ships with a DNS server that you can use for service discovery in your network. The agent that fulfills DNS lookups requires appropriate ACL permissions to discover services, nodes, and prepared queries registered in Consul.

A Consul agent must be configured with a token linked to policies that grant the appropriate set of permissions.

Specify the default token to the Consul agent to authorize the agent to respond to DNS queries. Refer to DNS usage overview for details on configuring and using Consul DNS.

Requirements

Core ACL functionality is available in all versions of Consul.

The DNS token must be linked to policies that grant the following permissions:

  • service:read: Enables the agent to perform service lookups for DNS
  • node:read: Enables node lookups over DNS
  • query:read: Enables the agent to perform prepared query lookups for DNS

Authentication

You must provide an ACL token linked to a policy with acl:write permissions to create and modify ACL tokens and policies using the CLI or API.

You can provide the token manually using the -token option on the command line, but we recommend setting the CONSUL_HTTP_TOKEN environment variable to simplify your workflow:

  1. $ export CONSUL_HTTP_TOKEN=<acl-token-secret-id>

The Consul CLI automatically reads the CONSUL_HTTP_TOKEN environment variable so that you do not have to pass the token to every Consul CLI command.

To authenticate calls to the Consul HTTP API, you must provide the token in the X-Consul-Token header for each call:

  1. $ curl --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" ...

To learn about alternative ways to authenticate, refer to the following documentation:

DNS token in Consul OSS

To create a token for DNS, you must define a policy, register the policy with Consul, and link the policy to a token.

Define a policy

You can send policy definitions as command line or API arguments or define them in an external HCL or JSON file. Refer to ACL Rules for details about all of the rules you can use in your policies.

The following example policy is defined in a file. The policy grants the appropriate permissions to enable a Consul agent to respond to DNS queries.

  1. node_prefix "" {
  2.   policy = "read"
  3. }
  4. service_prefix "" {
  5.   policy = "read"
  6. }
  7. query_prefix "" {
  8.   policy = "read"
  9. }
  1. {
  2.   "node_prefix": {
  3.     "": [{
  4.       "policy": "read"
  5.     }]
  6.   },
  7.   "query_prefix": {
  8.     "": [{
  9.       "policy": "read"
  10.     }]
  11.   },
  12.   "service_prefix": {
  13.     "": [{
  14.       "policy": "read"
  15.     }]
  16.   }
  17. }

Register the policy with Consul

After defining the policy, you can register the policy with Consul using the command line or API endpoint.

Run the consul acl policy create command and specify the policy rules to create a policy. Refer to Consul ACL Policy Create for details about the consul acl policy create command.

The following example registers a policy defined in dns-access.hcl.

  1. $ consul acl policy create \
  2.     -name "dns-access" -rules @dns-access.hcl \
  3.     -description "DNS Policy"

Send a PUT request to the /acl/policy endpoint and specify the policy rules in the request body to create a policy. Refer to ACL Policy HTTP API for additional information about using the API endpoint.

The following example registers the policy defined in dns-access.hcl. You must embed policy rules in the Rules field of the request body.

  1. $ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
  2.   --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
  3.   --data '{
  4.   "Name": "dns-access",
  5.   "Description": "DNS Policy",
  6.   "Rules": "node_prefix \"\" {\n  policy = \"read\"\n}\nservice_prefix \"\" {\n  policy = \"read\"\n}\nquery_prefix \"\" {\n  policy = \"read\"\n}\n"
  7. }'

After registering the policy into Consul, you can create and link tokens using the Consul command line or API endpoint. You can also enable Consul to dynamically create tokens from trusted external systems using an auth method.

Run the consul acl token create command and specify the policy name or ID to create a token linked to the policy. Refer to Consul ACL Token Create for details about the consul acl token create command.

The following command creates the ACL token linked to the policy dns-access.

  1. $ consul acl token create \
  2.     -description "DNS token" \
  3.     -policy-name "dns-access"

Send a PUT request to the /acl/token endpoint and specify the policy name or ID in the request to create an ACL token linked to the policy. Refer to ACL Token HTTP API for additional information about using the API endpoint.

The following example creates the ACL token linked to the policy dns-access.

  1. $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
  2.   --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
  3.   --data '{
  4.   "Policies": [
  5.     {
  6.       "Name": "dns-access"
  7.     }
  8.   ]
  9. }'

DNS token in Consul Enterprise

To create a token for DNS, you must define a policy, register the policy with Consul, and link the policy to a token.

Define a policy

You can send policy definitions as command line or API arguments or define them in an external HCL or JSON file. Refer to ACL Rules for details about all of the rules you can use in your policies.

The following example policy is defined in a file. The policy grants the appropriate permissions to enable a Consul agent to respond to DNS queries for resources in any namespace in any partition.

  1. partition_prefix "" {
  2.   namespace_prefix "" {
  3.     node_prefix "" {
  4.       policy = "read"
  5.     }
  6.     service_prefix "" {
  7.       policy = "read"
  8.     }
  9.     query_prefix "" {
  10.       policy = "read"
  11.     }
  12.   }
  13. }
  1. {
  2.   "partition_prefix": {
  3.     "": [{
  4.       "namespace_prefix": {
  5.         "": [{
  6.           "node_prefix": {
  7.             "": [{
  8.               "policy": "read"
  9.             }]
  10.           },
  11.           "query_prefix": {
  12.             "": [{
  13.               "policy": "read"
  14.             }]
  15.           },
  16.           "service_prefix": {
  17.             "": [{
  18.               "policy": "read"
  19.             }]
  20.           }
  21.         }]
  22.       }
  23.     }]
  24.   }
  25. }

Register the policy with Consul

After defining the policy, you can register the policy with Consul using the command line or API endpoint.

You can specify an admin partition when creating policies in Consul Enterprise. The policy is only valid in the specified admin partition. The example policy contains permissions for multiple namespaces in multiple partitions. You must create ACL policies that grant permissions for multiple namespaces in multiple partitions in the default namespace and the default partition.

Run the consul acl policy create command and specify the policy rules to create a policy. Refer to Consul ACL Policy Create for details about the consul acl policy create command.

  1. consul acl policy create -partition "default" -namespace "default" \
  2.   -name dns-access -rules @dns-access.hcl \
  3.   -description "DNS Policy"

Send a PUT request to the /acl/policy endpoint and specify the policy rules in the request body to create a policy. Refer to ACL Policy HTTP API for additional information about using the API endpoint.

The following example registers the policy defined in dns-access.hcl. You must embed policy rules in the Rules field of the request body.

  1. $ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
  2.   --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
  3.   --data '{
  4.   "Name": "dns-access",
  5.   "Description": "DNS Policy",
  6.   "Partition": "default",
  7.   "Namespace": "default",
  8.   "Rules": "partition_prefix \"\" {\n  namespace_prefix \"\" {\n    node_prefix \"\" {\n      policy = \"read\"\n    }\n    service_prefix \"\" {\n      policy = \"read\"\n    }\n    query_prefix \"\" {\n      policy = \"read\"\n    }\n  }\n}\n"
  9. }'

After registering the policy into Consul, you can create and link tokens using the Consul command line or API endpoint. You can also enable Consul to dynamically create tokens from trusted external systems using an auth method.

Run the consul acl token create command and specify the policy name or ID to create a token linked to the policy. Refer to Consul ACL Token Create for details about the consul acl token create command.

The following command creates the ACL token linked to the policy dns-access.

  1. $ consul acl token create -partition "default" -namespace "default" \
  2.     -description "DNS token" \
  3.     -policy-name "dns-access"

Send a PUT request to the /acl/token endpoint and specify the policy name or ID in the request to create an ACL token linked to the policy. Refer to ACL Token HTTP API for additional information about using the API endpoint.

The following example creates the ACL token linked to the policy dns-access.

  1. $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
  2.   --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
  3.   --data '{
  4.   "Policies": [
  5.     {
  6.       "Name": "dns-access"
  7.     }
  8.   ],
  9.   "Partition": "default",
  10.   "Namespace": "default"
  11. }'

Apply the token

Configure the Consul agent with the token by either specifying the token in the agent configuration file or by using the consul set-agent-token command.

Apply the token in a file

Specify the token in the default field of the agent configuration file so that the agent can present it and register into the catalog on startup.

  1. acl = {
  2.   enabled = true
  3.   tokens = {
  4.     default = "<token>"
  5.     ...
  6.   }
  7.   ...
  8. }

Apply the token with a command

Set the default token using the acl.token.default command. The following command configures a running Consul agent token with the specified token.

  1. $ consul set-agent-token default <acl-token-secret-id>