vault

Documentation

Index

• type Client
  • func NewClient(cfg *ClientConfig) (*Client, error)
  • func NewClientWithToken(cfg *ClientConfig, token string) (*Client, error)
  • func (c *Client) GenerateNewAppRoleSecret(secretID, appRoleName string) (string, error)
  • func (c *Client) GetAppRoleName() (string, error)
  • func (c *Client) GetAppRoleSecretIDTtl(secretID, roleName string) (time.Duration, error)
  • func (c *Client) GetKvSecret(path string) (map[string]string, error)
  • func (c *Client) GetOIDCTokenByValidation(roleID string) (string, error)
  • func (c *Client) GetSecret(path string) (*api.Secret, error)
  • func (c *Client) MustRevokeToken()
  • func (c *Client) RevokeToken() error
  • func (c *Client) WriteKvSecret(path string, newSecret map[string]string) error
• type ClientConfig

Types

type Client

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

Client handles communication with Vault

func NewClient

func NewClient(cfg *ClientConfig) (*Client, error)

func NewClientWithToken

func NewClientWithToken(cfg *ClientConfig, token string) (*Client, error)

func (*Client) GenerateNewAppRoleSecret

func (c *Client) GenerateNewAppRoleSecret(secretID, appRoleName string) (string, error)

GenerateNewAppRoleSecret creates a new secret-id

func (*Client) GetAppRoleName

func (c *Client) GetAppRoleName() (string, error)

GetAppRoleName returns the AppRole role name which was used to authenticate. Returns "" when AppRole authentication wasn't used

func (*Client) GetAppRoleSecretIDTtl

func (c *Client) GetAppRoleSecretIDTtl(secretID, roleName string) (time.Duration, error)

GetAppRoleSecretIDTtl returns the remaining time until the given secret-id expires

func (*Client) GetKvSecret

func (c *Client) GetKvSecret(path string) (map[string]string, error)

GetKvSecret reads secret from the KV engine. It Automatically transforms the logical path to the HTTP API Path for the corresponding KV Engine version

func (*Client) GetOIDCTokenByValidation

func (c *Client) GetOIDCTokenByValidation(roleID string) (string, error)

GetOIDCTokenByValidation returns the token if token is expired then get a new token else return old token

func (*Client) GetSecret

func (c *Client) GetSecret(path string) (*api.Secret, error)

GetSecret uses the given path to fetch a secret from vault

func (*Client) MustRevokeToken

func (c *Client) MustRevokeToken()

MustRevokeToken same as RevokeToken but the program is terminated with an error if this fails. Should be used in defer statements only.

func (*Client) RevokeToken

func (c *Client) RevokeToken() error

RevokeToken revokes the token which is currently used. The client can't be used anymore after this function was called.

func (*Client) WriteKvSecret

func (c *Client) WriteKvSecret(path string, newSecret map[string]string) error

WriteKvSecret writes secret to kv engine

type ClientConfig

type ClientConfig struct {
	*vaultAPI.Config
	Namespace         string
	AppRoleMountPoint string
	RoleID            string
	SecretID          string
}