vault

Documentation

Index

• type Params
• type Secret
• type SecretID
• type SecretSearchRequest
• type Vault
  • func New(api restapi.Connector) *Vault
  • func (vault *Vault) CreateSecret(name string, allowReadBy []string, allowWriteBy []string, secret interface{}) error
  • func (vault *Vault) CreateUserSecret(secretID SecretID, allowReadBy []string, allowWriteBy []string, ...) error
  • func (vault *Vault) DeleteSecret(name string) error
  • func (vault *Vault) DeleteUserSecret(secretID SecretID) error
  • func (vault *Vault) SearchSecrets(offset, limit int, sortkey, sortdir string, searchBody SecretSearchRequest) ([]Secret, error)
  • func (vault *Vault) Secret(name string) (*Secret, error)
  • func (vault *Vault) SecretMetadata(name string) (*Secret, error)
  • func (vault *Vault) Secrets(offset, limit int) ([]Secret, error)
  • func (vault *Vault) UpdateSecret(name string, allowReadTo []string, allowWriteTo []string, secret interface{}) error
  • func (vault *Vault) UpdateUserSecret(secretID SecretID, allowReadTo []string, allowWriteTo []string, ...) error
  • func (vault *Vault) UserSecret(secretID SecretID) (*Secret, error)
  • func (vault *Vault) UserSecretMetadata(secretID SecretID) (*Secret, error)
  • func (vault *Vault) UserSecrets(secretID SecretID, offset, limit int) ([]Secret, error)
  • func (vault *Vault) VaultSchemas() (*json.RawMessage, error)

Types

type Params

type Params struct {
	Offset  int    `json:"offset,omitempty"`
	Limit   int    `json:"limit,omitempty"`
	Sortkey string `json:"sortkey,omitempty"`
	Sortdir string `json:"sortdir,omitempty"`
}

Params struct for pagination queries.

type Secret

type Secret struct {
	ID         string              `json:"name"`
	Author     string              `json:"author,omitempty"`
	Editor     string              `json:"updated_by,omitempty"`
	Created    string              `json:"created,omitempty"`
	Updated    string              `json:"updated,omitempty"`
	AllowRead  []rolestore.RoleRef `json:"read_roles,omitempty"`
	AllowWrite []rolestore.RoleRef `json:"write_roles,omitempty"`
	Data       json.RawMessage     `json:"data,omitempty"`
}

Secret contains PrivX metadata about secret and its vault

type SecretID

type SecretID struct {
	OwnerID string
	Name    string
}

type SecretSearchRequest

type SecretSearchRequest struct {
	Keywords string   `json:"keywords"`
	Filter   string   `json:"filter"`
	OwnerIDs []string `json:"owner_id"`
}

Search criteria for secrets

type Vault

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

Vault is client instance.

func New

func New(api restapi.Connector) *Vault

New creates a new Vault client instance, using the argument SDK API client.

func (*Vault) CreateSecret

func (vault *Vault) CreateSecret(
	name string,
	allowReadBy []string,
	allowWriteBy []string,
	secret interface{},
) error

CreateSecret create new secret to PrivX Vault

func (*Vault) CreateUserSecret

func (vault *Vault) CreateUserSecret(
	secretID SecretID,
	allowReadBy []string,
	allowWriteBy []string,
	secret interface{},
) error

CreateUserSecret creates a user secret

func (*Vault) DeleteSecret

func (vault *Vault) DeleteSecret(name string) error

DeleteSecret delete existing secret from PrivX vault

func (*Vault) DeleteUserSecret

func (vault *Vault) DeleteUserSecret(secretID SecretID) error

DeleteSecret delete existing secret from PrivX vault

func (*Vault) SearchSecrets

func (vault *Vault) SearchSecrets(offset, limit int, sortkey, sortdir string, searchBody SecretSearchRequest) ([]Secret, error)

SearchSecrets search for existing secrets

func (*Vault) Secret

func (vault *Vault) Secret(name string) (*Secret, error)

Secret gets the content of the argument secret.

func (*Vault) SecretMetadata

func (vault *Vault) SecretMetadata(name string) (*Secret, error)

SecretMetadata returns secret metadata

func (*Vault) Secrets

func (vault *Vault) Secrets(offset, limit int) ([]Secret, error)

Secrets returns secrets client has access to

func (*Vault) UpdateSecret

func (vault *Vault) UpdateSecret(
	name string,
	allowReadTo []string,
	allowWriteTo []string,
	secret interface{},
) error

UpdateSecret existing secret at PrivX Vault

func (*Vault) UpdateUserSecret

func (vault *Vault) UpdateUserSecret(
	secretID SecretID,
	allowReadTo []string,
	allowWriteTo []string,
	secret interface{},
) error

UpdateUserSecret existing secret at PrivX Vault

func (*Vault) UserSecret

func (vault *Vault) UserSecret(secretID SecretID) (*Secret, error)

UserSecret gets the content of the argument user secret.

func (*Vault) UserSecretMetadata

func (vault *Vault) UserSecretMetadata(secretID SecretID) (*Secret, error)

SecretMetadata returns secret metadata

func (*Vault) UserSecrets

func (vault *Vault) UserSecrets(secretID SecretID, offset, limit int) ([]Secret, error)

UserSecrets returns user secrets client has access to

func (*Vault) VaultSchemas

func (vault *Vault) VaultSchemas() (*json.RawMessage, error)

VaultSchemas returns the defined schemas