constellation/keyservice
Daniel Weiße 690b50b29d
dev-docs: Go package docs (#958)
* Remove unused package

* Add Go package docs to most packages

Signed-off-by: Daniel Weiße <dw@edgeless.systems>
Signed-off-by: Fabian Kammel <fk@edgeless.systems>
Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Co-authored-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
Co-authored-by: Fabian Kammel <fk@edgeless.systems>
2023-01-19 15:57:50 +01:00
..
cmd Refactor init/recovery to use kms URI 2023-01-19 13:14:55 +01:00
internal dev-docs: Go package docs (#958) 2023-01-19 15:57:50 +01:00
keyserviceproto kms: rename kms to keyservice 2023-01-16 11:56:34 +01:00
Dockerfile kms: rename kms to keyservice 2023-01-16 11:56:34 +01:00
README.md dev-docs: Go package docs (#958) 2023-01-19 15:57:50 +01:00

KeyService

The KeyService is one of Constellation's Kubernetes components, responsible for distributing keys and secrets to other services. This includes the JoinService, which contacts the KeyService to derive state disk keys and measurement secrets for newly-joining, and rejoining nodes, and Constellation's CSI drivers, which contact the KeyService for disk encryption keys.

The service is not exposed outside the cluster, and should be kept for internal usage only.

gRPC API

Keys can be requested through simple gRPC API based on an ID and key length.

Backends

The KeyService supports multiple backends to store keys and manage crypto operations. The default option holds a master secret in memory. Keys are derived on demand from this secret, and not stored anywhere. Other backends make use of external Key Management Systems (KMS) for key derivation and securing a master secret. When using an external KMS backend, encrypted keys are stored in cloud buckets.