82427d1a07
Older versions of Go do not format these comments, so we can already
reformat them ahead of time to prevent gofmt linting failing once
we update to Go 1.19 or up.
Result of:
gofmt -s -w $(find . -type f -name '*.go' | grep -v "/vendor/")
With some manual adjusting.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
33 lines
1.6 KiB
Go
33 lines
1.6 KiB
Go
// Package store provides a generic way to store credentials to connect to
|
|
// virtually any kind of remote system.
|
|
// The term `context` comes from the similar feature in Kubernetes kubectl
|
|
// config files.
|
|
//
|
|
// Conceptually, a context is a set of metadata and TLS data, that can be used
|
|
// to connect to various endpoints of a remote system. TLS data and metadata
|
|
// are stored separately, so that in the future, we will be able to store
|
|
// sensitive information in a more secure way, depending on the os we are running
|
|
// on (e.g.: on Windows we could use the user Certificate Store, on macOS the
|
|
// user Keychain...).
|
|
//
|
|
// Current implementation is purely file based with the following structure:
|
|
//
|
|
// ${CONTEXT_ROOT}
|
|
// meta/
|
|
// <context id>/meta.json: contains context medata (key/value pairs) as
|
|
// well as a list of endpoints (themselves containing
|
|
// key/value pair metadata).
|
|
// tls/
|
|
// <context id>/endpoint1/: directory containing TLS data for the endpoint1
|
|
// in the corresponding context.
|
|
//
|
|
// The context store itself has absolutely no knowledge about what a docker
|
|
// endpoint should contain in term of metadata or TLS config. Client code is
|
|
// responsible for generating and parsing endpoint metadata and TLS files. The
|
|
// multi-endpoints approach of this package allows to combine many different
|
|
// endpoints in the same "context".
|
|
//
|
|
// Context IDs are actually SHA256 hashes of the context name, and are there
|
|
// only to avoid dealing with special characters in context names.
|
|
package store
|