vault

Documentation

Index

• type AuthResponse
  • func (a *AuthResponse) String() string
• type AuthStrategy
• type Client
  • func NewClient() *Client
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) GetHTTPClient() *http.Client
  • func (c *Client) Login() error
  • func (c *Client) Read(path string) ([]byte, error)
  • func (c *Client) RevokeToken()
  • func (c *Client) SetToken(req *http.Request)
• type Strategy
  • func AppIDStrategy(fs vfs.Filesystem) *Strategy
  • func AppRoleStrategy(fs vfs.Filesystem) *Strategy
  • func GitHubStrategy(fs vfs.Filesystem) *Strategy
  • func UserPassStrategy(fs vfs.Filesystem) *Strategy
  • func (a *Strategy) Do(req *http.Request) (*http.Response, error)
  • func (a *Strategy) GetHTTPClient() *http.Client
  • func (a *Strategy) GetToken(addr *url.URL) (string, error)
  • func (a *Strategy) Revokable() bool
  • func (a *Strategy) SetToken(req *http.Request)
• type TokenStrategy
  • func NewTokenStrategy(fs vfs.Filesystem) *TokenStrategy
  • func (a *TokenStrategy) GetToken(addr *url.URL) (string, error)
  • func (a *TokenStrategy) Revokable() bool

Types

type AuthResponse

type AuthResponse struct {
	Auth struct {
		ClientToken   string   `json:"client_token"`
		LeaseDuration int64    `json:"lease_duration"`
		Metadata      struct{} `json:"metadata"`
		Policies      []string `json:"policies"`
		Renewable     bool     `json:"renewable"`
	} `json:"auth"`
}

AuthResponse - the Auth response

func (*AuthResponse) String

func (a *AuthResponse) String() string

type AuthStrategy

type AuthStrategy interface {
	GetToken(addr *url.URL) (string, error)
	Revokable() bool
}

AuthStrategy -

type Client

type Client struct {
	Addr *url.URL
	Auth AuthStrategy
	// contains filtered or unexported fields
}

Client -

func NewClient

func NewClient() *Client

NewClient - instantiate a new

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

Do wraps http.Client.Do

func (*Client) GetHTTPClient

func (c *Client) GetHTTPClient() *http.Client

GetHTTPClient returns a client configured w/X-Vault-Token header

func (*Client) Login

func (c *Client) Login() error

Login - log in to Vault with the discovered auth backend and save the token

func (*Client) Read

func (c *Client) Read(path string) ([]byte, error)

func (*Client) RevokeToken

func (c *Client) RevokeToken()

RevokeToken - revoke the current auth token - effectively logging out

func (*Client) SetToken

func (c *Client) SetToken(req *http.Request)

SetToken adds an X-Vault-Token header to the request

type Strategy

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

Strategy - an auth strategy configured through the Vault API

func AppIDStrategy

func AppIDStrategy(fs vfs.Filesystem) *Strategy

AppIDStrategy - app-id auth backend

func AppRoleStrategy

func AppRoleStrategy(fs vfs.Filesystem) *Strategy

AppRoleStrategy - approle auth backend

func GitHubStrategy

func GitHubStrategy(fs vfs.Filesystem) *Strategy

GitHubStrategy - github auth backend

func UserPassStrategy

func UserPassStrategy(fs vfs.Filesystem) *Strategy

UserPassStrategy - userpass auth backend

func (*Strategy) Do

func (a *Strategy) Do(req *http.Request) (*http.Response, error)

Do wraps http.Client.Do

func (*Strategy) GetHTTPClient

func (a *Strategy) GetHTTPClient() *http.Client

GetHTTPClient configures the HTTP client with a timeout

func (*Strategy) GetToken

func (a *Strategy) GetToken(addr *url.URL) (string, error)

GetToken - log in to the app-id auth backend and return the client token

func (*Strategy) Revokable

func (a *Strategy) Revokable() bool

Revokable -

func (*Strategy) SetToken

func (a *Strategy) SetToken(req *http.Request)

SetToken is a no-op here as a token hasn't been acquired yet

type TokenStrategy

type TokenStrategy struct {
	Token string
}

TokenStrategy - a pass-through strategy for situations where we already have a Vault token.

func NewTokenStrategy

func NewTokenStrategy(fs vfs.Filesystem) *TokenStrategy

NewTokenStrategy - Try to create a new TokenStrategy. If we can't nil will be returned.

func (*TokenStrategy) GetToken

func (a *TokenStrategy) GetToken(addr *url.URL) (string, error)

GetToken - return the token

func (*TokenStrategy) Revokable

func (a *TokenStrategy) Revokable() bool

Revokable -