From edeab6a0d2def544164196fec64d493d947d3430 Mon Sep 17 00:00:00 2001 From: Ryan Breen Date: Sat, 31 Jan 2015 18:33:29 -0500 Subject: [PATCH] Substantial and potentially inaccurate rewrite to docs/agent/encryption. --- .../docs/agent/encryption.html.markdown | 55 +++++++++---------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/website/source/docs/agent/encryption.html.markdown b/website/source/docs/agent/encryption.html.markdown index 6de76cbe09..b51b230088 100644 --- a/website/source/docs/agent/encryption.html.markdown +++ b/website/source/docs/agent/encryption.html.markdown @@ -3,31 +3,31 @@ layout: "docs" page_title: "Encryption" sidebar_current: "docs-agent-encryption" description: |- - The Consul agent supports encrypting all of its network traffic. The exact method of this encryption is described on the encryption internals page. There are two separate systems, one for gossip traffic and one for RPC. + The Consul agent supports encrypting all of its network traffic. The exact method of encryption is described on the encryption internals page. There are two separate encryption systems, one for gossip traffic and one for RPC. --- # Encryption The Consul agent supports encrypting all of its network traffic. The exact -method of this encryption is described on the -[encryption internals page](/docs/internals/security.html). There are two -separate systems, one for gossip traffic and one for RPC. +method of encryption is described on the [encryption internals page](/docs/internals/security.html). +There are two separate encryption systems, one for gossip traffic and one for RPC. ## Gossip Encryption Enabling gossip encryption only requires that you set an encryption key when -starting the Consul agent. The key can be set by setting the `encrypt` parameter -in a configuration file for the agent. The key must be 16-bytes that are base64 -encoded. The easiest method to obtain a cryptographically suitable key is by -using `consul keygen`. +starting the Consul agent. The key can be set via the `encrypt` parameter: this +value of this setting is a configuration file containing the encryption key. + +The key must be 16-bytes, Base64 encoded. As a convenience, Consul contains the +`consul keygen` commmand to generate a cryptographically suitable key: ```text $ consul keygen cg8StVXbQJ0gPvMd9o7yrg== ``` -With that key, you can enable encryption on the agent. You can verify -encryption is enabled because the output will include "Encrypted: true". +With that key, you can enable encryption on the agent. If encryption is enabled, +the output of `consul agent` will include "Encrypted: true": ```text $ cat encrypt.json @@ -53,28 +53,27 @@ order to send and receive cluster information. # RPC Encryption with TLS -Consul supports using TLS to verify the authenticity of servers and clients. For this -to work, Consul requires that all clients and servers have key pairs that are generated -by a single Certificate Authority. This can be a private CA, used only internally. The -CA then signs keys for each of the agents. [Here](https://langui.sh/2009/01/18/openssl-self-signed-ca/) -is a tutorial on generating both a CA and signing keys using OpenSSL. Client certificates -must have extended key usage enabled for client and server authentication. +Consul supports using TLS to verify the authenticity of servers and clients. To enable this, +Consul requires that all clients and servers have key pairs that are generated by a single +Certificate Authority. This can be a private CA, used only internally. The +CA then signs keys for each of the agents, as in +[this tutorial on generationg both a CA and signing keys](https://langui.sh/2009/01/18/openssl-self-signed-ca/) +using OpenSSL. Note: client certificates must have +[Extended Key Usage](https://www.openssl.org/docs/apps/x509v3_config.html#extended_key_usage_) enabled +for client and server authentication. -There are a number of things to consider when setting up TLS for Consul. Either we can -use TLS just to verify the authenticity of the servers, or we can also verify the authenticity -of clients. The former can be used to prevent unauthorized access. This behavior is controlled -using either the `verify_incoming` and `verify_outgoing` [options](/docs/agent/options.html). +When enabling TLS for Consul, we first must decide what we wish to verify. TLS can be used +to verify the authenticity of the servers or also verify the authenticity of clients, controlled +by the `verify_incoming` or `verify_outgoing` [options](/docs/agent/options.html), respectively. -If `verify_outgoing` is set, then agents verify the authenticity of Consuls for outgoing -connections. This means server nodes must present a certificate signed by the `ca_file` that -the agent has. This option must be set on all agents, and there must be a `ca_file` provided -to check the certificate against. If this is set, then all server nodes must have an appropriate -key pair set using `cert_file` and `key_file`. +If `verify_outgoing` is set, agents verify the authenticity of Consul for outgoing +connections. Server nodes must present a certificate signed by the `ca_file` setting that must +be present all agents. All server nodes must have an appropriate key pair set using `cert_file` and `key_file`. If `verify_incoming` is set, then the servers verify the authenticity of all incoming -connections. Servers will also disallow any non-TLS connections. If this is set, then all -clients must have a valid key pair set using `cert_file` and `key_file`. To force clients to -use TLS, `verify_outgoing` must also be set. +connections. Servers will also disallow any non-TLS connections. All clients must have +a valid key pair set using `cert_file` and `key_file`. To force clients to use TLS, +`verify_outgoing` must also be set. TLS is used to secure the RPC calls between agents, but gossip between nodes is done over UDP and is secured using a symmetric key. See above for enabling gossip encryption.