status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

contrib: add description of cert relationship diagram 

And links to code
This commit is contained in:
Daniel Nephin 2021-07-08 17:07:15 -04:00
parent 440db2985a
commit c5c5d7777c
1 changed files with 30 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/service-mesh/ca/README.md
View File

@ -3,6 +3,17 @@
The Certificate Authority subsystem manages a CA trust chain for issuing certificates to The Certificate Authority subsystem manages a CA trust chain for issuing certificates to
services and client agents (via auto-encrypt and auto-config). services and client agents (via auto-encrypt and auto-config).
The code for the Certificate Authority is in the following packages:
1. most of the core logic is in [agent/consul/leader_connect_ca.go]
2. the providers are in [agent/connect/ca]
3. the RPC interface is in [agent/consul/connect_ca_endpoint.go]
[agent/consul/leader_connect_ca.go]: https://github.com/hashicorp/consul/blob/main/agent/consul/leader_connect_ca.go
[agent/connect/ca]: https://github.com/hashicorp/consul/blob/main/agent/connect/ca/
[agent/consul/connect_ca_endpoint.go]: https://github.com/hashicorp/consul/blob/main/agent/consul/connect_ca_endpoint.go
## Architecture ## Architecture
### High level overview ### High level overview
@ -10,6 +21,7 @@ services and client agents (via auto-encrypt and auto-config).
In Consul the leader is responsible for handling of the CA management. In Consul the leader is responsible for handling of the CA management.
When a leader election happen, and the elected leader do not have any root CA available it will start a process of creating a set of CA certificate. When a leader election happen, and the elected leader do not have any root CA available it will start a process of creating a set of CA certificate.
Those certificates will use to authenticate/encrypt communication between services (service mesh) or between `Consul client agent` (auto-encrypt/auto-config). This process is described in the following diagram: Those certificates will use to authenticate/encrypt communication between services (service mesh) or between `Consul client agent` (auto-encrypt/auto-config). This process is described in the following diagram:
![CA creation](./hl-ca-overview.svg) ![CA creation](./hl-ca-overview.svg)
<sup>[source](./hl-ca-overview.mmd)</sup> <sup>[source](./hl-ca-overview.mmd)</sup>
@ -28,17 +40,25 @@ secondary.
<sup>[source](./cert-relationship.mmd)</sup> <sup>[source](./cert-relationship.mmd)</sup>
TODO: describe the relationship
* what does it mean for the external root CA to be optional In most cases there is an external root CA that provides an intermediate CA that Consul
* it always exists , unless the Consul CA provider is used AND it has generated the CA uses as the Primary Root CA. The only except to this is when the Consul CA Provider is
root. used without specifying a `RootCert`. In this one case Consul will generate the the Root CA
* relationship between Primary Root CA and Signing CA in the primary from the provided primary key, and it will be used in the primary as the top of the chain
* sometimes its the same thing (Consul, and AWS providers) of trust.
* sometimes it is different (Vault provider)
* client agent cert is used by auto-encrypt for Agent HTTP TLS (and client side of RPC In the primary datacenter, the Consul and AWS providers use the Primary Root CA to sign
TLS) leaf certificates. The Vault provider uses an intermediate CA to sign leaf certificates.
* leaf cert service is the cert used by a service in the mesh
Leaf certificates are created for two purposes:
1. the Leaf Cert Service is used by envoy proxies in the mesh to perform mTLS with other
services.
2. the Leaf Cert Client Agent is created by auto-encrypt and auto-config. It is used by
client agents for HTTP API TLS, and for mTLS for RPC requests to servers.
Any secondary datacenters receive an intermediate certificate, signed by the Primary Root
CA, which is used as the CA certificate to sign leaf certificates in the secondary
datacenter.
### detailed call flow ### detailed call flow
- sequence diagram for leader election - sequence diagram for leader election