Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

kes

package module

Go to main page

Versions in this module

v0

v0.2.1

Nov 8, 2023

v0.2.0

Aug 9, 2023

Changes in this version

+ const AES256

+ const ChaCha20

+ var ErrIdentityExists = NewError(http.StatusBadRequest, "identity already exists")

+ var ErrPartialWrite = NewError(http.StatusServiceUnavailable, "change committed but not replicated")

+ var ErrPolicyExists = NewError(http.StatusBadRequest, "policy already exists")

+ var ErrSecretVersionNotFound = NewError(http.StatusNotFound, "secret version does not exist")

type API

+ func (a *API) UnmarshalJSON(data []byte) error

+ func (a API) MarshalJSON() ([]byte, error)

type Client

+ func (c *Client) CreatePolicy(ctx context.Context, name string, policy *Policy) error

+ func (c *Client) DescribeCluster(ctx context.Context) (*ClusterInfo, error)

+ func (c *Client) ExpandCluster(ctx context.Context, endpoint string) error

+ func (c *Client) IsReady(ctx context.Context) (bool, error)

+ func (c *Client) ListEnclaves(ctx context.Context, prefix string, n int) ([]string, string, error)

+ func (c *Client) ShrinkCluster(ctx context.Context, endpoint string) error

+ type ClusterInfo struct

+ Leader uint64

+ Nodes map[uint64]string

+ type CreateIdentityRequest struct

+ Admin bool

+ Policy string

+ TTL time.Duration

type Enclave

+ func (e *Enclave) CreateIdentity(ctx context.Context, identity Identity, req *CreateIdentityRequest) error

+ func (e *Enclave) CreatePolicy(ctx context.Context, name string, policy *Policy) error

+ func (e *Enclave) Metrics(ctx context.Context) (Metric, error)

type IdentityInfo

+ ExpiresAt time.Time

+ TTL time.Duration

+ type ImportKeyRequest struct

+ Cipher KeyAlgorithm

+ Key []byte

+ type ListIter struct

+ NextFunc func(context.Context, string, int) ([]T, string, error)

+ func (i *ListIter[T]) Next(ctx context.Context) (item T, err error)

+ func (i *ListIter[T]) SeekTo(ctx context.Context, prefix string) (item T, err error)

type Policy

+ CreatedAt time.Time

+ CreatedBy Identity

+ func (p *Policy) IsSubset(o *Policy) bool

+ func (p *Policy) Verify(r *http.Request) error

+ type Rule struct

type State

+ KeyStoreLatency time.Duration

+ KeyStoreReachable bool

+ KeystoreAvailable bool

+ func (s *State) UnmarshalJSON(data []byte) error

+ func (s State) MarshalJSON() ([]byte, error)

v0.1.0

Feb 14, 2023

Changes in this version

+ var ErrDecrypt = NewError(http.StatusBadRequest, "decryption failed: ciphertext is not authentic")

+ var ErrEnclaveExists = NewError(http.StatusBadRequest, "enclave already exists")

+ var ErrEnclaveNotFound = NewError(http.StatusNotFound, "enclave does not exist")

+ var ErrIdentityNotFound = NewError(http.StatusNotFound, "identity does not exist")

+ var ErrKeyExists = NewError(http.StatusBadRequest, "key already exists")

+ var ErrKeyNotFound = NewError(http.StatusNotFound, "key does not exist")

+ var ErrNotAllowed = NewError(http.StatusForbidden, "not authorized: insufficient permissions")

+ var ErrPolicyNotFound = NewError(http.StatusNotFound, "policy does not exist")

+ var ErrSealed = NewError(http.StatusForbidden, "system is sealed")

+ var ErrSecretExists = NewError(http.StatusNotFound, "secret already exists")

+ var ErrSecretNotFound = NewError(http.StatusNotFound, "secret does not exist")

+ func GenerateCertificate(key APIKey, options ...CertificateOption) (tls.Certificate, error)

+ type API struct

+ MaxBody int64

+ Method string

+ Path string

+ Timeout time.Duration

+ type APIKey interface

+ Identity func() Identity

+ Private func() crypto.PrivateKey

+ Public func() crypto.PublicKey

+ String func() string

+ func GenerateAPIKey(rand io.Reader) (APIKey, error)

+ func ParseAPIKey(s string) (APIKey, error)

+ type AuditEvent struct

+ APIPath string

+ ClientIP net.IP

+ ClientIdentity Identity

+ ResponseTime time.Duration

+ StatusCode int

+ Timestamp time.Time

+ type AuditStream struct

+ func NewAuditStream(r io.Reader) *AuditStream

+ func (s *AuditStream) Close() (err error)

+ func (s *AuditStream) Event() AuditEvent

+ func (s *AuditStream) Next() bool

+ func (s *AuditStream) WriteTo(w io.Writer) (int64, error)

+ type CCP struct

+ Ciphertext []byte

+ Context []byte

+ type CertificateOption func(*x509.Certificate)

+ type Client struct

+ Endpoints []string

+ HTTPClient http.Client

+ func NewClient(endpoint string, cert tls.Certificate) *Client

+ func NewClientWithConfig(endpoint string, config *tls.Config) *Client

+ func (c *Client) APIs(ctx context.Context) ([]API, error)

+ func (c *Client) AssignPolicy(ctx context.Context, policy string, identity Identity) error

+ func (c *Client) AuditLog(ctx context.Context) (*AuditStream, error)

+ func (c *Client) CreateEnclave(ctx context.Context, name string, admin Identity) error

+ func (c *Client) CreateKey(ctx context.Context, name string) error

+ func (c *Client) CreateSecret(ctx context.Context, name string, value []byte, options *SecretOptions) error

+ func (c *Client) Decrypt(ctx context.Context, name string, ciphertext, context []byte) ([]byte, error)

+ func (c *Client) DecryptAll(ctx context.Context, name string, ciphertexts ...CCP) ([]PCP, error)

+ func (c *Client) DeleteEnclave(ctx context.Context, name string) error

+ func (c *Client) DeleteIdentity(ctx context.Context, identity Identity) error

+ func (c *Client) DeleteKey(ctx context.Context, name string) error

+ func (c *Client) DeletePolicy(ctx context.Context, name string) error

+ func (c *Client) DeleteSecret(ctx context.Context, name string) error

+ func (c *Client) DescribeEnclave(ctx context.Context, name string) (*EnclaveInfo, error)

+ func (c *Client) DescribeIdentity(ctx context.Context, identity Identity) (*IdentityInfo, error)

+ func (c *Client) DescribeKey(ctx context.Context, name string) (*KeyInfo, error)

+ func (c *Client) DescribePolicy(ctx context.Context, name string) (*PolicyInfo, error)

+ func (c *Client) DescribeSecret(ctx context.Context, name string) (*SecretInfo, error)

+ func (c *Client) DescribeSelf(ctx context.Context) (*IdentityInfo, *Policy, error)

+ func (c *Client) Enclave(name string) *Enclave

+ func (c *Client) Encrypt(ctx context.Context, name string, plaintext, context []byte) ([]byte, error)

+ func (c *Client) ErrorLog(ctx context.Context) (*ErrorStream, error)

+ func (c *Client) GenerateKey(ctx context.Context, name string, context []byte) (DEK, error)

+ func (c *Client) GetPolicy(ctx context.Context, name string) (*Policy, error)

+ func (c *Client) ImportKey(ctx context.Context, name string, key []byte) error

+ func (c *Client) ListIdentities(ctx context.Context, pattern string) (*IdentityIterator, error)

+ func (c *Client) ListKeys(ctx context.Context, pattern string) (*KeyIterator, error)

+ func (c *Client) ListPolicies(ctx context.Context, pattern string) (*PolicyIterator, error)

+ func (c *Client) ListSecrets(ctx context.Context, pattern string) (*SecretIter, error)

+ func (c *Client) Metrics(ctx context.Context) (Metric, error)

+ func (c *Client) ReadSecret(ctx context.Context, name string) ([]byte, *SecretInfo, error)

+ func (c *Client) SetPolicy(ctx context.Context, name string, policy *Policy) error

+ func (c *Client) Status(ctx context.Context) (State, error)

+ func (c *Client) Version(ctx context.Context) (string, error)

+ type ConnError struct

+ Err error

+ Host string

+ func IsConnError(err error) (*ConnError, bool)

+ func (c *ConnError) Error() string

+ func (c *ConnError) Temporary() bool

+ func (c *ConnError) Timeout() bool

+ func (c *ConnError) Unwrap() error

+ type DEK struct

+ Ciphertext []byte

+ Plaintext []byte

+ type Enclave struct

+ Endpoints []string

+ HTTPClient http.Client

+ Name string

+ func NewEnclave(endpoint, name string, certificate tls.Certificate) *Enclave

+ func NewEnclaveWithConfig(endpoint, name string, config *tls.Config) *Enclave

+ func (e *Enclave) AssignPolicy(ctx context.Context, policy string, identity Identity) error

+ func (e *Enclave) CreateKey(ctx context.Context, name string) error

+ func (e *Enclave) CreateSecret(ctx context.Context, name string, value []byte, options *SecretOptions) error

+ func (e *Enclave) Decrypt(ctx context.Context, name string, ciphertext, context []byte) ([]byte, error)

+ func (e *Enclave) DecryptAll(ctx context.Context, name string, ciphertexts ...CCP) ([]PCP, error)

+ func (e *Enclave) DeleteIdentity(ctx context.Context, identity Identity) error

+ func (e *Enclave) DeleteKey(ctx context.Context, name string) error

+ func (e *Enclave) DeletePolicy(ctx context.Context, name string) error

+ func (e *Enclave) DeleteSecret(ctx context.Context, name string) error

+ func (e *Enclave) DescribeIdentity(ctx context.Context, identity Identity) (*IdentityInfo, error)

+ func (e *Enclave) DescribeKey(ctx context.Context, name string) (*KeyInfo, error)

+ func (e *Enclave) DescribePolicy(ctx context.Context, name string) (*PolicyInfo, error)

+ func (e *Enclave) DescribeSecret(ctx context.Context, name string) (*SecretInfo, error)

+ func (e *Enclave) DescribeSelf(ctx context.Context) (*IdentityInfo, *Policy, error)

+ func (e *Enclave) Encrypt(ctx context.Context, name string, plaintext, context []byte) ([]byte, error)

+ func (e *Enclave) GenerateKey(ctx context.Context, name string, context []byte) (DEK, error)

+ func (e *Enclave) GetPolicy(ctx context.Context, name string) (*Policy, error)

+ func (e *Enclave) ImportKey(ctx context.Context, name string, key []byte) error

+ func (e *Enclave) ListIdentities(ctx context.Context, pattern string) (*IdentityIterator, error)

+ func (e *Enclave) ListKeys(ctx context.Context, pattern string) (*KeyIterator, error)

+ func (e *Enclave) ListPolicies(ctx context.Context, pattern string) (*PolicyIterator, error)

+ func (e *Enclave) ListSecrets(ctx context.Context, pattern string) (*SecretIter, error)

+ func (e *Enclave) ReadSecret(ctx context.Context, name string) ([]byte, *SecretInfo, error)

+ func (e *Enclave) SetPolicy(ctx context.Context, name string, policy *Policy) error

+ type EnclaveInfo struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ type Error struct

+ func NewError(code int, msg string) Error

+ func (e Error) Error() string

+ func (e Error) Status() int

+ type ErrorEvent struct

+ Message string

+ type ErrorStream struct

+ func NewErrorStream(r io.Reader) *ErrorStream

+ func (s *ErrorStream) Close() error

+ func (s *ErrorStream) Event() ErrorEvent

+ func (s *ErrorStream) Message() string

+ func (s *ErrorStream) Next() bool

+ func (s *ErrorStream) WriteTo(w io.Writer) (int64, error)

+ type Identity string

+ const IdentityUnknown

+ func (id Identity) IsUnknown() bool

+ func (id Identity) String() string

+ type IdentityInfo struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Identity Identity

+ IsAdmin bool

+ Policy string

+ type IdentityIterator struct

+ func (i *IdentityIterator) Close() error

+ func (i *IdentityIterator) CreatedAt() time.Time

+ func (i *IdentityIterator) CreatedBy() Identity

+ func (i *IdentityIterator) Identity() Identity

+ func (i *IdentityIterator) Next() bool

+ func (i *IdentityIterator) Policy() string

+ func (i *IdentityIterator) Value() IdentityInfo

+ func (i *IdentityIterator) Values(n int) ([]IdentityInfo, error)

+ func (i *IdentityIterator) WriteTo(w io.Writer) (int64, error)

+ type KeyAlgorithm uint

+ const AES256_GCM_SHA256

+ const KeyAlgorithmUndefined

+ const XCHACHA20_POLY1305

+ func (a *KeyAlgorithm) UnmarshalText(text []byte) error

+ func (a KeyAlgorithm) MarshalText() ([]byte, error)

+ func (a KeyAlgorithm) String() string

+ type KeyInfo struct

+ Algorithm KeyAlgorithm

+ CreatedAt time.Time

+ CreatedBy Identity

+ ID string

+ Name string

+ func (k *KeyInfo) MarshalJSON() ([]byte, error)

+ func (k *KeyInfo) UnmarshalJSON(text []byte) error

+ type KeyIterator struct

+ func (i *KeyIterator) Algorithm() KeyAlgorithm

+ func (i *KeyIterator) Close() error

+ func (i *KeyIterator) CreatedAt() time.Time

+ func (i *KeyIterator) CreatedBy() Identity

+ func (i *KeyIterator) ID() string

+ func (i *KeyIterator) Name() string

+ func (i *KeyIterator) Next() bool

+ func (i *KeyIterator) Value() KeyInfo

+ func (i *KeyIterator) Values(n int) ([]KeyInfo, error)

+ func (i *KeyIterator) WriteTo(w io.Writer) (int64, error)

+ type Metric struct

+ AuditEvents uint64

+ CPUs int

+ ErrorEvents uint64

+ HeapAlloc uint64

+ HeapObjects uint64

+ LatencyHistogram map[time.Duration]uint64

+ RequestActive uint64

+ RequestErr uint64

+ RequestFail uint64

+ RequestOK uint64

+ StackAlloc uint64

+ Threads int

+ UpTime time.Duration

+ UsableCPUs int

+ func (m *Metric) RequestN() uint64

+ type PCP struct

+ Context []byte

+ Plaintext []byte

+ type Policy struct

+ Allow []string

+ Deny []string

+ Info PolicyInfo

+ type PolicyInfo struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ type PolicyIterator struct

+ func (i *PolicyIterator) Close() error

+ func (i *PolicyIterator) CreatedAt() time.Time

+ func (i *PolicyIterator) CreatedBy() Identity

+ func (i *PolicyIterator) Name() string

+ func (i *PolicyIterator) Next() bool

+ func (i *PolicyIterator) Value() PolicyInfo

+ func (i *PolicyIterator) Values(n int) ([]PolicyInfo, error)

+ func (i *PolicyIterator) WriteTo(w io.Writer) (int64, error)

+ type SecretInfo struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ ModTime time.Time

+ Name string

+ Type SecretType

+ func (s *SecretInfo) MarshalJSON() ([]byte, error)

+ func (s *SecretInfo) UnmarshalJSON(data []byte) error

+ type SecretIter struct

+ func (i *SecretIter) Close() error

+ func (i *SecretIter) CreatedAt() time.Time

+ func (i *SecretIter) CreatedBy() Identity

+ func (i *SecretIter) ModTime() time.Time

+ func (i *SecretIter) Name() string

+ func (i *SecretIter) Next() bool

+ func (i *SecretIter) Type() SecretType

+ func (i *SecretIter) Value() SecretInfo

+ func (i *SecretIter) Values(n int) ([]SecretInfo, error)

+ func (i *SecretIter) WriteTo(w io.Writer) (int64, error)

+ type SecretOptions struct

+ Type SecretType

+ type SecretType uint

+ const SecretGeneric

+ func (s *SecretType) UnmarshalText(text []byte) error

+ func (s SecretType) MarshalText() ([]byte, error)

+ func (s SecretType) String() string

+ type State struct

+ Arch string

+ CPUs int

+ HeapAlloc uint64

+ OS string

+ StackAlloc uint64

+ UpTime time.Duration

+ UsableCPUs int

+ Version string