secrets

Documentation

Index

• type Option
  • func WithQuery(q string) Option
  • func WithSort(sort string) Option
  • func WithSortDirection(d SortDirection) Option
• type Options
• type Secret
  • func NewPassword(name string, username string, password string, url string) *Secret
• type Secrets
  • func New(vlt *vault.Vault) *Secrets
  • func (v *Secrets) Get(id string) (*Secret, error)
  • func (v *Secrets) List(opt ...Option) ([]*Secret, error)
  • func (v *Secrets) Save(secret *Secret) (*Secret, bool, error)
• type SortDirection
• type Type

Types

type Option

type Option func(*Options)

Option ...

func WithQuery

func WithQuery(q string) Option

WithQuery ...

func WithSort

func WithSort(sort string) Option

WithSort ...

func WithSortDirection

func WithSortDirection(d SortDirection) Option

WithSortDirection ...

type Options

type Options struct {
	Query         string
	Sort          string
	SortDirection SortDirection
}

Options ...

type Secret

type Secret struct {
	ID   string `json:"id"`
	Type Type   `json:"type"`

	Name string `json:"name"`

	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`

	URL   string `json:"url,omitempty"`
	Notes string `json:"notes,omitempty"`

	CreatedAt time.Time `json:"createdAt,omitempty"`
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
}

Secret to keep.

func NewPassword

func NewPassword(name string, username string, password string, url string) *Secret

NewPassword creates a new password secret.

type Secrets

type Secrets struct {
	*vault.Vault
}

Secrets vault.

func New

func New(vlt *vault.Vault) *Secrets

New secrets vault.

func (*Secrets) Get

func (v *Secrets) Get(id string) (*Secret, error)

Get a secret.

func (*Secrets) List

func (v *Secrets) List(opt ...Option) ([]*Secret, error)

List ...

func (*Secrets) Save

func (v *Secrets) Save(secret *Secret) (*Secret, bool, error)

Save a secret. Returns true if secret was updated.

type SortDirection

type SortDirection string

SortDirection direction for sorting.

const (
	// Ascending direction.
	Ascending SortDirection = "asc"
	// Descending direction.
	Descending SortDirection = "desc"
)

type Type

type Type string

Type types for secret.

const (
	UnknownType  Type = ""
	PasswordType Type = "password"
	NoteType     Type = "note"
)

Types for Secret.