secret

Documentation

Index

• Constants
• type Iter
• type Secret
  • func NewSecret(value []byte, owner kes.Identity) Secret
  • func (s *Secret) Bytes() []byte
  • func (s *Secret) CreatedAt() time.Time
  • func (s *Secret) CreatedBy() kes.Identity
  • func (s *Secret) MarshalBinary() ([]byte, error)
  • func (s *Secret) ModTime() time.Time
  • func (s *Secret) Type() kes.SecretType
  • func (s *Secret) UnmarshalBinary(data []byte) error

Constants

const MaxSize = 1 * mem.MiB

MaxSize is the maximum size of a secret.

Types

type Iter

type Iter interface {
	// Next fetches the next secret entry. It returns
	// false when there are no more entries or once it
	// encounters an error.
	//
	// Once Next returns false, it returns false on any
	// subsequent Next call.
	Next() bool

	// Name returns the name of the latest fetched entry.
	// It returns the same name until Next is called again.
	//
	// As long as Next hasn't been called once or once Next
	// returns false, Name returns the empty string.
	Name() string

	// Close closes the Iter. Once closed, any subsequent
	// Next call returns false.
	//
	// Close returns the first error encountered while iterating
	// over the entires, if any. Otherwise, it returns the error
	// encountered while cleaning up any resources, if any.
	// Subsequent calls to Close return the same error.
	Close() error
}

Iter is an iterator over secrets.

type Secret

type Secret struct {
	// contains filtered or unexported fields
}

Secret is a generic secret, like a password, API key, or private key.

func NewSecret

func NewSecret(value []byte, owner kes.Identity) Secret

NewSecret returns a new generic Secret from the given value.

Its CreatedAt timestamp is time.Now and its CreatedBy identity is the owner.

func (*Secret) Bytes

func (s *Secret) Bytes() []byte

Bytes returns the Secret value.

func (*Secret) CreatedAt

func (s *Secret) CreatedAt() time.Time

CreatedAt returns the point in time when the secret has been created.

func (*Secret) CreatedBy

func (s *Secret) CreatedBy() kes.Identity

CreatedBy returns the identity that created the secret.

func (*Secret) MarshalBinary

func (s *Secret) MarshalBinary() ([]byte, error)

MarshalBinary returns the Secret's binary representation.

func (*Secret) ModTime

func (s *Secret) ModTime() time.Time

ModTime returns the most recent point in time at which the secret has been modified. If the secret has never been modified, its ModTime is equal to its CreatedAt time.

func (*Secret) Type

func (s *Secret) Type() kes.SecretType

Type returns the Secret's type.

func (*Secret) UnmarshalBinary

func (s *Secret) UnmarshalBinary(data []byte) error

UnmarshalBinary unmarshals the Secret's binary representation.