kms

package module

Go to main page

Versions in this module

v0

v0.4.0

Feb 21, 2024

Changes in this version

+ var ErrDecrypt = Error

+ type AddClusterNodeRequest struct

+ Host string

+ func (r *AddClusterNodeRequest) MarshalPB(v *pb.AddClusterNodeRequest) error

+ func (r *AddClusterNodeRequest) UnmarshalPB(v *pb.AddClusterNodeRequest) error

+ type BackupDBRequest struct

type Client

+ func (c *Client) GetIdentity(ctx context.Context, req *IdentityRequest) (*IdentityResponse, error)

+ func (c *Client) Hosts() []string

+ func (c *Client) ImportKey(ctx context.Context, req *ImportKeyRequest) error

+ func (c *Client) Live(ctx context.Context, req *LivenessRequest) error

+ func (c *Client) ReadDB(ctx context.Context) (*ReadDBResponse, error)

+ func (c *Client) Ready(ctx context.Context, req *ReadinessRequest) error

+ func (c *Client) Send(ctx context.Context, req *Request) (*http.Response, error)

+ func (c *Client) Version(ctx context.Context, req *VersionRequest) ([]*VersionResponse, error)

+ type ClusterStatusRequest struct

+ func (r *ClusterStatusRequest) MarshalPB(*pb.ClusterStatusRequest) error

+ func (r *ClusterStatusRequest) UnmarshalPB(*pb.ClusterStatusRequest) error

type CreateEnclaveRequest

+ func (r *CreateEnclaveRequest) MarshalPB(v *pb.CreateEnclaveRequest) error

+ func (r *CreateEnclaveRequest) UnmarshalPB(v *pb.CreateEnclaveRequest) error

type DecryptRequest

+ AssociatedData []byte

type DeleteEnclaveRequest

+ func (r *DeleteEnclaveRequest) MarshalPB(v *pb.DeleteEnclaveRequest) error

+ func (r *DeleteEnclaveRequest) UnmarshalPB(v *pb.DeleteEnclaveRequest) error

type DeleteIdentityRequest

+ func (r *DeleteIdentityRequest) MarshalPB(v *pb.DeleteIdentityRequest) error

+ func (r *DeleteIdentityRequest) UnmarshalPB(v *pb.DeleteIdentityRequest) error

type DeletePolicyRequest

+ func (r *DeletePolicyRequest) MarshalPB(v *pb.DeletePolicyRequest) error

+ func (r *DeletePolicyRequest) UnmarshalPB(v *pb.DeletePolicyRequest) error

+ type EnclaveStatusRequest struct

+ Name string

+ func (r *EnclaveStatusRequest) MarshalPB(v *pb.CreateEnclaveRequest) error

+ func (r *EnclaveStatusRequest) UnmarshalPB(v *pb.EnclaveStatusRequest) error

+ type EnclaveStatusResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ func (r *EnclaveStatusResponse) MarshalPB(v *pb.EnclaveStatusResponse) error

+ func (r *EnclaveStatusResponse) UnmarshalPB(v *pb.EnclaveStatusResponse) error

type EncryptRequest

+ Version int

type GenerateKeyRequest

+ AssociatedData []byte

+ Version int

+ type HostError struct

+ Err error

+ Host string

+ func AsHostError(err error) *HostError

+ func UnwrapHostErrors(err error) []*HostError

+ func (e *HostError) Error() string

+ func (e *HostError) Temporary() bool

+ func (e *HostError) Timeout() bool

+ func (e *HostError) Unwrap() error

type IdentityRequest

+ func (r *IdentityRequest) MarshalPB(v *pb.IdentityRequest) error

+ func (r *IdentityRequest) UnmarshalPB(v *pb.IdentityRequest) error

+ type IdentityResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Identity Identity

+ IsServiceAccount bool

+ Policy string

+ Privilege Privilege

+ ServiceAccounts []Identity

+ func (r *IdentityResponse) MarshalPB(v *pb.IdentityResponse) error

+ func (r *IdentityResponse) UnmarshalPB(v *pb.IdentityResponse) error

+ type ImportKeyRequest struct

+ Enclave string

+ Key []byte

+ Name string

+ Type SecretKeyType

+ func (r *ImportKeyRequest) MarshalPB(v *pb.ImportKeyRequest) error

+ func (r *ImportKeyRequest) UnmarshalPB(v *pb.ImportKeyRequest) error

+ type KeyStatusRequest struct

+ Enclave string

+ Name string

+ Version int

+ func (r *KeyStatusRequest) MarshalPB(v *pb.KeyStatusRequest) error

+ func (r *KeyStatusRequest) UnmarshalPB(v *pb.KeyStatusRequest) error

+ type KeyStatusResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ Type SecretKeyType

+ Version int

+ func (r *KeyStatusResponse) MarshalPB(v *pb.KeyStatusResponse) error

+ func (r *KeyStatusResponse) UnmarshalPB(v *pb.KeyStatusResponse) error

type ListRequest

+ func (r *ListRequest) MarshalPB(v *pb.ListRequest) error

+ func (r *ListRequest) UnmarshalPB(v *pb.ListRequest) error

+ type LivenessRequest struct

+ Hosts []string

type PolicyRequest

+ func (r *PolicyRequest) MarshalPB(v *pb.PolicyRequest) error

+ func (r *PolicyRequest) UnmarshalPB(v *pb.PolicyRequest) error

+ type PolicyStatusResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ func (r *PolicyStatusResponse) MarshalPB(v *pb.PolicyStatusResponse) error

+ func (r *PolicyStatusResponse) UnmarshalPB(v *pb.PolicyStatusResponse) error

+ type ReadDBResponse struct

+ Body io.ReadCloser

+ func (r *ReadDBResponse) Close() error

+ func (r *ReadDBResponse) Read(b []byte) (int, error)

+ type ReadinessRequest struct

+ Hosts []string

+ Write bool

+ type RemoveClusterNodeRequest struct

+ Host string

+ func (r *RemoveClusterNodeRequest) MarshalPB(v *pb.RemoveClusterNodeRequest) error

+ func (r *RemoveClusterNodeRequest) UnmarshalPB(v *pb.RemoveClusterNodeRequest) error

+ type Request struct

+ Body []byte

+ Enclave string

+ Host string

+ type RuleSet map[string]Rule

+ func (r *RuleSet) MarshalPB(v *pb.RuleSet) error

+ func (r *RuleSet) UnmarshalJSON(b []byte) error

+ func (r *RuleSet) UnmarshalPB(v *pb.RuleSet) error

+ func (r RuleSet) MarshalJSON() ([]byte, error)

type SecretKeyType

+ func ParseSecretKeyType(s string) (SecretKeyType, error)

+ type ServerStatusRequest struct

+ Hosts []string

type ServerStatusResponse

+ Host string

+ type VersionRequest struct

+ Hosts []string

type VersionResponse

+ Host string

v0.3.0

Jan 16, 2024

Changes in this version

+ var ErrIdentityNotFound = Error

+ var ErrPermission = Error

+ var ErrPolicyNotFound = Error

+ type AssignPolicyRequest struct

+ Enclave string

+ Identity Identity

+ Policy string

+ func (r *AssignPolicyRequest) MarshalPB(v *pb.AssignPolicyRequest) error

+ func (r *AssignPolicyRequest) UnmarshalPB(v *pb.AssignPolicyRequest) error

type Client

+ func (c *Client) AssignPolicy(ctx context.Context, req *AssignPolicyRequest) error

+ func (c *Client) CreateIdentity(ctx context.Context, req *CreateIdentityRequest) error

+ func (c *Client) CreatePolicy(ctx context.Context, req *CreatePolicyRequest) error

+ func (c *Client) DeleteIdentity(ctx context.Context, req *DeleteIdentityRequest) error

+ func (c *Client) DeleteKey(ctx context.Context, req *DeleteKeyRequest) error

+ func (c *Client) DeletePolicy(ctx context.Context, req *DeletePolicyRequest) error

+ func (c *Client) DescribeIdentity(ctx context.Context, req *IdentityRequest) (*DescribeIdentityResponse, error)

+ func (c *Client) DescribePolicy(ctx context.Context, req *PolicyRequest) (*DescribePolicyResponse, error)

+ func (c *Client) EditCluster(ctx context.Context, req *EditClusterRequest) error

+ func (c *Client) GetPolicy(ctx context.Context, req *PolicyRequest) (*PolicyResponse, error)

+ func (c *Client) ListEnclaves(ctx context.Context, req *ListRequest) (*Page[DescribeEnclaveResponse], error)

+ func (c *Client) ListIdentities(ctx context.Context, req *ListRequest) (*Page[DescribeIdentityResponse], error)

+ func (c *Client) ListKeys(ctx context.Context, req *ListRequest) (*Page[DescribeKeyVersionResponse], error)

+ func (c *Client) ListPolicies(ctx context.Context, req *ListRequest) (*Page[DescribePolicyResponse], error)

+ type CreateIdentityRequest struct

+ Enclave string

+ Identity Identity

+ IsServiceAccount bool

+ Privilege Privilege

+ func (r *CreateIdentityRequest) MarshalPB(v *pb.CreateIdentityRequest) error

+ func (r *CreateIdentityRequest) UnmarshalPB(v *pb.CreateIdentityRequest) error

type CreateKeyRequest

+ AddVersion bool

+ type CreatePolicyRequest struct

+ Allow map[string]Rule

+ Deny map[string]Rule

+ Enclave string

+ Name string

+ func (r *CreatePolicyRequest) MarshalPB(v *pb.CreatePolicyRequest) error

+ func (r *CreatePolicyRequest) UnmarshalPB(v *pb.CreatePolicyRequest) error

type DecryptRequest

+ Name string

+ type DeleteIdentityRequest struct

+ Enclave string

+ Identity Identity

+ type DeleteKeyRequest struct

+ AllVersions bool

+ Enclave string

+ Name string

+ Version int

+ func (r *DeleteKeyRequest) MarshalPB(v *pb.DeleteKeyRequest) error

+ func (r *DeleteKeyRequest) UnmarshalPB(v *pb.DeleteKeyRequest) error

+ type DeletePolicyRequest struct

+ Enclave string

+ Name string

+ type DescribeIdentityResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Identity Identity

+ IsServiceAccount bool

+ Policy string

+ Privilege Privilege

+ ServiceAccounts []Identity

+ func (r *DescribeIdentityResponse) MarshalPB(v *pb.DescribeIdentityResponse) error

+ func (r *DescribeIdentityResponse) UnmarshalPB(v *pb.DescribeIdentityResponse) error

type DescribeKeyVersionRequest

+ Name string

+ type DescribePolicyResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ func (r *DescribePolicyResponse) MarshalPB(v *pb.DescribePolicyResponse) error

+ func (r *DescribePolicyResponse) UnmarshalPB(v *pb.DescribePolicyResponse) error

+ type EditClusterRequest struct

+ Host string

+ Remove []int

+ func (r *EditClusterRequest) MarshalPB(v *pb.EditClusterRequest) error

+ func (r *EditClusterRequest) UnmarshalPB(v *pb.EditClusterRequest) error

type EncryptRequest

+ Name string

type GenerateKeyRequest

+ Name string

+ type IdentityRequest struct

+ Enclave string

+ Identity Identity

type ListRequest

+ Enclave string

+ type Page struct

+ ContinueAt string

+ Items []T

+ type PolicyRequest struct

+ Enclave string

+ Name string

+ type PolicyResponse struct

+ Allow map[string]Rule

+ CreatedAt time.Time

+ CreatedBy Identity

+ Deny map[string]Rule

+ Name string

+ func (r *PolicyResponse) MarshalPB(v *pb.PolicyResponse) error

+ func (r *PolicyResponse) UnmarshalPB(v *pb.PolicyResponse) error

+ type Privilege uint

+ const Admin

+ const SysAdmin

+ const User

+ func ParsePrivilege(s string) (Privilege, error)

+ func (p Privilege) String() string

+ type Rule struct

+ func (r Rule) String() string

v0.2.0

Dec 4, 2023

Changes in this version

+ type AddNodeRequest struct

+ Host string

type Client

+ func (c *Client) AddNode(ctx context.Context, req *AddNodeRequest) error

+ func (c *Client) ClusterStatus(ctx context.Context, _ *StatusRequest) (*ClusterStatusResponse, error)

+ func (c *Client) CreateEnclave(ctx context.Context, req *CreateEnclaveRequest) error

+ func (c *Client) CreateKey(ctx context.Context, req *CreateKeyRequest) error

+ func (c *Client) DeleteEnclave(ctx context.Context, req *DeleteEnclaveRequest) error

+ func (c *Client) DescribeEnclave(ctx context.Context, req *DescribeEnclaveRequest) (*DescribeEnclaveResponse, error)

+ func (c *Client) DescribeKeyVersion(ctx context.Context, req *DescribeKeyVersionRequest) (*DescribeKeyVersionResponse, error)

+ func (c *Client) ListEnclaveNames(ctx context.Context, req *ListRequest) (*ListResponse[string], error)

+ func (c *Client) ListKeyNames(ctx context.Context, req *ListRequest) (*ListResponse[string], error)

+ func (c *Client) RemoveNode(ctx context.Context, req *RemoveNodeRequest) error

+ func (c *Client) ServerStatus(ctx context.Context, endpoint string, _ *NodeStatusRequest) (*ServerStatusResponse, error)

+ type ClusterStatusResponse struct

+ NodesDown map[int]string

+ NodesUp map[int]*ServerStatusResponse

+ func (s *ClusterStatusResponse) MarshalPB(v *pb.ClusterStatusResponse) error

+ func (s *ClusterStatusResponse) UnmarshalPB(v *pb.ClusterStatusResponse) error

+ type CreateEnclaveRequest struct

+ Name string

+ type CreateKeyRequest struct

+ Enclave string

+ Name string

+ Type SecretKeyType

+ func (r *CreateKeyRequest) MarshalPB(v *pb.CreateKeyRequest) error

+ func (r *CreateKeyRequest) UnmarshalPB(v *pb.CreateKeyRequest) error

type DecryptRequest

+ Enclave string

+ Key string

+ type DeleteEnclaveRequest struct

+ Name string

+ type DescribeEnclaveRequest struct

+ Name string

+ type DescribeEnclaveResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ func (r *DescribeEnclaveResponse) MarshalPB(v *pb.DescribeEnclaveResponse) error

+ func (r *DescribeEnclaveResponse) UnmarshalPB(v *pb.DescribeEnclaveResponse) error

+ type DescribeKeyVersionRequest struct

+ Enclave string

+ Key string

+ type DescribeKeyVersionResponse struct

+ CreatedAt time.Time

+ CreatedBy Identity

+ Name string

+ Type SecretKeyType

+ Version int

+ func (r *DescribeKeyVersionResponse) MarshalPB(v *pb.DescribeKeyVersionResponse) error

+ func (r *DescribeKeyVersionResponse) UnmarshalPB(v *pb.DescribeKeyVersionResponse) error

type EncryptRequest

+ Enclave string

+ Key string

type GenerateKeyRequest

+ Enclave string

+ Key string

+ type Iter struct

+ NextFn func(context.Context, *ListRequest) (*ListResponse[T], error)

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

+ func (i *Iter[T]) SeekTo(ctx context.Context, req *ListRequest) (item T, err error)

+ type ListRequest struct

+ ContinueAt string

+ Limit int

+ Prefix string

+ type ListResponse struct

+ ContinueAt string

+ Items []T

+ type RemoveNodeRequest struct

+ Host string

+ type SecretKeyType uint

+ const AES256

+ const ChaCha20

+ func (s SecretKeyType) String() string

+ type ServerStatusResponse struct

+ APIVersion string

+ CPUArch string

+ CPUs uint

+ Commit uint64

+ ElectionTimeout time.Duration

+ Endpoint string

+ HeapMemInUse uint64

+ HeartbeatInterval time.Duration

+ ID int

+ LastHeartbeat time.Duration

+ LeaderID int

+ Nodes map[int]string

+ OS string

+ Role string

+ StackMemInUse uint64

+ UpTime time.Duration

+ UsableCPUs uint

+ Version string

+ func (s *ServerStatusResponse) MarshalPB(v *pb.ServerStatusResponse) error

+ func (s *ServerStatusResponse) UnmarshalPB(v *pb.ServerStatusResponse) error

+ type VersionResponse struct

+ APIVersion string

+ Commit string

+ Version string

+ func (r *VersionResponse) MarshalPB(v *pb.VersionResponse) error

+ func (r *VersionResponse) UnmarshalPB(v *pb.VersionResponse) error

v0.1.0

Dec 2, 2023

Changes in this version

+ var ErrEnclaveExists = Error

+ var ErrEnclaveNotFound = Error

+ var ErrKeyExists = Error

+ var ErrKeyNotFound = Error

+ type APIKey interface

+ Identity func() Identity

+ Private func() crypto.PrivateKey

+ Public func() crypto.PublicKey

+ String func() string

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

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

+ type Client struct

+ func NewClient(conf *Config) (*Client, error)

+ func (c *Client) Decrypt(ctx context.Context, enclave, key string, req *DecryptRequest) (*DecryptResponse, error)

+ func (c *Client) Encrypt(ctx context.Context, enclave, key string, req *EncryptRequest) (*EncryptResponse, error)

+ func (c *Client) GenerateKey(ctx context.Context, enclave, key string, req *GenerateKeyRequest) (*GenerateKeyResponse, error)

+ func (c *Client) NodeStatus(ctx context.Context, endpoint string, _ *NodeStatusRequest) (*NodeStatusResponse, error)

+ func (c *Client) Status(ctx context.Context, _ *StatusRequest) (*StatusResponse, error)

+ type Config struct

+ APIKey APIKey

+ Endpoints []string

+ TLS *tls.Config

+ type DecryptRequest struct

+ AssociateData []byte

+ Ciphertext []byte

+ Version int

+ func (r *DecryptRequest) MarshalPB(v *pb.DecryptRequest) error

+ func (r *DecryptRequest) UnmarshalPB(v *pb.DecryptRequest) error

+ type DecryptResponse struct

+ Plaintext []byte

+ func (r *DecryptResponse) MarshalPB(v *pb.DecryptResponse) error

+ func (r *DecryptResponse) UnmarshalPB(v *pb.DecryptResponse) error

+ type EncryptRequest struct

+ AssociatedData []byte

+ Plaintext []byte

+ func (r *EncryptRequest) MarshalPB(v *pb.EncryptRequest) error

+ func (r *EncryptRequest) UnmarshalPB(v *pb.EncryptRequest) error

+ type EncryptResponse struct

+ Ciphertext []byte

+ Version int

+ func (r *EncryptResponse) MarshalPB(v *pb.EncryptResponse) error

+ func (r *EncryptResponse) UnmarshalPB(v *pb.EncryptResponse) error

+ type Error struct

+ Code int

+ Err string

+ func (e Error) Error() string

+ func (e Error) Status() int

+ type GenerateKeyRequest struct

+ AssociateData []byte

+ Length int

+ func (r *GenerateKeyRequest) MarshalPB(v *pb.GenerateKeyRequest) error

+ func (r *GenerateKeyRequest) UnmarshalPB(v *pb.GenerateKeyRequest) error

+ type GenerateKeyResponse struct

+ Ciphertext []byte

+ Plaintext []byte

+ Version int

+ func (r *GenerateKeyResponse) MarshalPB(v *pb.GenerateKeyResponse) error

+ func (r *GenerateKeyResponse) UnmarshalPB(v *pb.GenerateKeyResponse) error

+ type Identity string

+ func (i Identity) String() string

+ type NodeStatusRequest struct

+ type NodeStatusResponse struct

+ APIVersion string

+ CPUArch string

+ CPUs uint

+ Commit uint64

+ ElectionTimeout time.Duration

+ Endpoint string

+ HeapMemInUse uint64

+ HeartbeatInterval time.Duration

+ ID int

+ LastHeartbeat time.Duration

+ LeaderID int

+ Nodes map[int]string

+ OS string

+ Role string

+ StackMemInUse uint64

+ UpTime time.Duration

+ UsableCPUs uint

+ Version string

+ func (s *NodeStatusResponse) MarshalPB(v *pb.NodeStatusResponse) error

+ func (s *NodeStatusResponse) UnmarshalPB(v *pb.NodeStatusResponse) error

+ type StatusRequest struct

+ type StatusResponse struct

+ NodesDown map[int]string

+ NodesUp map[int]*NodeStatusResponse

+ func (s *StatusResponse) MarshalPB(v *pb.StatusResponse) error

+ func (s *StatusResponse) UnmarshalPB(v *pb.StatusResponse) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL