api

Jun 20, 2018

Changes in this version

type SecretAuth

+ IdentityPolicies []string

+ TokenPolicies []string

Jun 6, 2018

Changes in this version

+ const EnvRateLimit

type Client

+ func (c *Client) CurrentWrappingLookupFunc() WrappingLookupFunc

+ func (c *Client) SetBackoff(backoff retryablehttp.Backoff)

+ func (c *Client) SetLimiter(rateLimit float64, burst int)

type Config

+ Backoff retryablehttp.Backoff

+ Limiter *rate.Limiter

type RekeyInitRequest

+ RequireVerification bool

type RekeyStatusResponse

+ VerificationNonce string

+ VerificationRequired bool

type RekeyUpdateResponse

+ VerificationNonce string

+ VerificationRequired bool

+ type RekeyVerificationStatusResponse struct

+ N int

+ Nonce string

+ Progress int

+ Started bool

+ T int

+ type RekeyVerificationUpdateResponse struct

+ Complete bool

+ Nonce string

type Request

+ BodyBytes []byte

type Sys

+ func (c *Sys) RekeyRecoveryKeyVerificationCancel() error

+ func (c *Sys) RekeyRecoveryKeyVerificationStatus() (*RekeyVerificationStatusResponse, error)

+ func (c *Sys) RekeyRecoveryKeyVerificationUpdate(shard, nonce string) (*RekeyVerificationUpdateResponse, error)

+ func (c *Sys) RekeyVerificationCancel() error

+ func (c *Sys) RekeyVerificationStatus() (*RekeyVerificationStatusResponse, error)

+ func (c *Sys) RekeyVerificationUpdate(shard, nonce string) (*RekeyVerificationUpdateResponse, error)

Apr 10, 2018

Changes in this version

type AuthConfigInput

+ PassthroughRequestHeaders []string

type AuthConfigOutput

+ PassthroughRequestHeaders []string

type AuthMount

+ Options map[string]string

+ type DeregisterPluginInput struct

+ Name string

type EnableAuthOptions

+ Options map[string]string

+ type GetPluginInput struct

+ Name string

+ type GetPluginResponse struct

+ Args []string

+ Builtin bool

+ Command string

+ Name string

+ SHA256 string

+ type ListPluginsInput struct

+ type ListPluginsResponse struct

+ Names []string

type MountConfigInput

+ Options map[string]string

+ PassthroughRequestHeaders []string

type MountConfigOutput

+ PassthroughRequestHeaders []string

type MountInput

+ Options map[string]string

type MountOutput

+ Options map[string]string

+ type RegisterPluginInput struct

+ Args []string

+ Command string

+ Name string

+ SHA256 string

type Sys

+ func (c *Sys) DeregisterPlugin(i *DeregisterPluginInput) error

+ func (c *Sys) GetPlugin(i *GetPluginInput) (*GetPluginResponse, error)

+ func (c *Sys) ListPlugins(i *ListPluginsInput) (*ListPluginsResponse, error)

+ func (c *Sys) RegisterPlugin(i *RegisterPluginInput) error

Mar 20, 2018

Changes in this version

type AuthConfigInput

+ AuditNonHMACRequestKeys []string

+ AuditNonHMACResponseKeys []string

+ ListingVisibility string

type AuthConfigOutput

+ AuditNonHMACRequestKeys []string

+ AuditNonHMACResponseKeys []string

+ ListingVisibility string

type MountConfigInput

+ AuditNonHMACRequestKeys []string

+ AuditNonHMACResponseKeys []string

+ ListingVisibility string

type MountConfigOutput

+ AuditNonHMACRequestKeys []string

+ AuditNonHMACResponseKeys []string

+ ListingVisibility string

Feb 26, 2018

Changes in this version

type AuthConfigInput

+ DefaultLeaseTTL string

+ MaxLeaseTTL string

Jan 26, 2018

Changes in this version

type HealthResponse

+ ReplicationDRMode string

+ ReplicationPerformanceMode string

type Secret

+ func (s *Secret) TokenAccessor() (string, error)

+ func (s *Secret) TokenID() (string, error)

+ func (s *Secret) TokenIsRenewable() (bool, error)

+ func (s *Secret) TokenMetadata() (map[string]string, error)

+ func (s *Secret) TokenPolicies() ([]string, error)

+ func (s *Secret) TokenRemainingUses() (int, error)

+ func (s *Secret) TokenTTL() (time.Duration, error)

Dec 21, 2017

Changes in this version

type AuthMount

+ SealWrap bool

type EnableAuthOptions

+ SealWrap bool

type RenewerInput

+ Increment int

type SealStatusResponse

+ RecoverySeal bool

Nov 14, 2017

Changes in this version

+ const EnvVaultMFA

type Client

+ func (c *Client) SetHeaders(headers http.Header)

+ func (c *Client) SetMFACreds(creds []string)

+ func (c *Client) SetPolicyOverride(override bool)

type Config

+ Error error

type GenerateRootStatusResponse

+ EncodedToken string

type MountInput

+ SealWrap bool

type MountOutput

+ SealWrap bool

type RekeyInitRequest

+ StoredShares int

type Request

+ MFAHeaderVals []string

+ PolicyOverride bool

type SealStatusResponse

+ Type string

type SecretWrapInfo

+ Accessor string

type Sys

+ func (c *Sys) GenerateDROperationTokenCancel() error

+ func (c *Sys) GenerateDROperationTokenInit(otp, pgpKey string) (*GenerateRootStatusResponse, error)

+ func (c *Sys) GenerateDROperationTokenStatus() (*GenerateRootStatusResponse, error)

+ func (c *Sys) GenerateDROperationTokenUpdate(shard, nonce string) (*GenerateRootStatusResponse, error)

Sep 5, 2017

Changes in this version

+ type AuthConfigInput struct

+ PluginName string

type EnableAuthOptions

+ Config AuthConfigInput

type MountInput

+ PluginName string

type SSH

+ func (c *SSH) SignKey(role string, data map[string]interface{}) (*Secret, error)

Aug 9, 2017

Changes in this version

+ const EnvVaultClientTimeout

+ var DefaultRenewerGrace = 15 * time.Second

+ var DefaultRenewerRenewBuffer = 5

+ var ErrRenewerMissingInput = errors.New("missing input to renewer")

+ var ErrRenewerMissingSecret = errors.New("missing secret to renew")

+ var ErrRenewerNoSecretData = errors.New("returned empty secret data")

+ var ErrRenewerNotRenewable = errors.New("secret is not renewable")

type AuthConfigOutput

+ PluginName string

type AuthMount

+ Accessor string

+ type CORSRequest struct

+ AllowedOrigins string

+ Enabled bool

+ type CORSResponse struct

+ AllowedOrigins string

+ Enabled bool

type Client

+ func (c *Client) Clone() (*Client, error)

+ func (c *Client) NewRenewer(i *RenewerInput) (*Renewer, error)

+ func (c *Client) SetClientTimeout(timeout time.Duration)

type Config

+ Timeout time.Duration

type EnableAuthOptions

+ PluginName string

type LeaderResponse

+ LeaderClusterAddress string

type MountConfigInput

+ PluginName string

type MountConfigOutput

+ PluginName string

type MountOutput

+ Accessor string

+ type RenewOutput struct

+ RenewedAt time.Time

+ Secret *Secret

+ type Renewer struct

+ func (r *Renewer) DoneCh() <-chan error

+ func (r *Renewer) Renew()

+ func (r *Renewer) RenewCh() <-chan *RenewOutput

+ func (r *Renewer) Stop()

+ type RenewerInput struct

+ Grace time.Duration

+ Rand *rand.Rand

+ RenewBuffer int

+ Secret *Secret

type Request

+ Headers http.Header

type SecretWrapInfo

+ CreationPath string

type Sys

+ func (c *Sys) CORSStatus() (*CORSResponse, error)

+ func (c *Sys) ConfigureCORS(req *CORSRequest) (*CORSResponse, error)

+ func (c *Sys) DisableCORS() (*CORSResponse, error)

type TokenAuth

+ func (c *TokenAuth) RenewTokenAsSelf(token string, increment int) (*Secret, error)

Jun 7, 2017

Changes in this version

+ type HealthResponse struct

+ ClusterID string

+ ClusterName string

+ Initialized bool

+ Sealed bool

+ ServerTimeUTC int64

+ Standby bool

+ Version string

type Sys

+ func (c *Sys) Health() (*HealthResponse, error)

Mar 16, 2017

Changes in this version

+ const EnvVaultToken

type Audit

+ Local bool

type AuthMount

+ Local bool

type Client

+ func (c *Client) SetMaxRetries(retries int)

+ type EnableAuditOptions struct

+ Description string

+ Local bool

+ Options map[string]string

+ Type string

+ type EnableAuthOptions struct

+ Description string

+ Local bool

+ Type string

type MountConfigInput

+ ForceNoCache bool

type MountConfigOutput

+ ForceNoCache bool

type MountInput

+ Local bool

type MountOutput

+ Local bool

type Sys

+ func (c *Sys) EnableAuditWithOptions(path string, options *EnableAuditOptions) error

+ func (c *Sys) EnableAuthWithOptions(path string, options *EnableAuthOptions) error

Feb 7, 2017

Changes in this version

type SealStatusResponse

+ Nonce string

Dec 6, 2016

Changes in this version

type Client

+ func (c *Client) Address() string

Oct 5, 2016

Changes in this version

+ var DefaultWrappingLookupFunc = func(operation, path string) string

+ var DefaultWrappingTTL = "5m"

type InitRequest

+ RootTokenPGPKey string

type SSHHelperConfig

+ TLSServerName string

type TokenAuth

+ func (c *TokenAuth) CreateOrphan(opts *TokenCreateRequest) (*Secret, error)

Aug 21, 2016

Changes in this version

+ const EnvVaultMaxRetries

+ type AuthConfigOutput struct

+ DefaultLeaseTTL int

+ MaxLeaseTTL int

type AuthMount

+ Config AuthConfigOutput

type Client

+ func (c *Client) SetAddress(addr string) error

type Config

+ MaxRetries int

+ func (c *Config) ConfigureTLS(t *TLSConfig) error

type InitResponse

+ KeysB64 []string

+ RecoveryKeysB64 []string

type RekeyRetrieveResponse

+ KeysB64 map[string][]string

type RekeyUpdateResponse

+ KeysB64 []string

type SSHHelperConfig

+ AllowedRoles string

type SSHVerifyResponse

+ RoleName string

type SealStatusResponse

+ ClusterID string

+ ClusterName string

+ Version string

type Secret

+ RequestID string

+ type TLSConfig struct

+ CACert string

+ CAPath string

+ ClientCert string

+ ClientKey string

+ Insecure bool

+ TLSServerName string

type TokenCreateRequest

+ Period string

Jun 14, 2016

Changes in this version

+ const EnvVaultWrapTTL

type Client

+ func (c *Client) SetWrappingLookupFunc(lookupFunc WrappingLookupFunc)

type InitRequest

+ RecoveryPGPKeys []string

+ RecoveryShares int

+ RecoveryThreshold int

+ StoredShares int

type InitResponse

+ RecoveryKeys []string

type Logical

+ func (c *Logical) Unwrap(wrappingToken string) (*Secret, error)

type Request

+ WrapTTL string

type Secret

+ WrapInfo *SecretWrapInfo

+ type SecretWrapInfo struct

+ CreationTime time.Time

+ TTL int

+ Token string

+ WrappedAccessor string

type Sys

+ func (c *Sys) RekeyDeleteRecoveryBackup() error

+ func (c *Sys) RekeyRecoveryKeyCancel() error

+ func (c *Sys) RekeyRecoveryKeyInit(config *RekeyInitRequest) (*RekeyStatusResponse, error)

+ func (c *Sys) RekeyRecoveryKeyStatus() (*RekeyStatusResponse, error)

+ func (c *Sys) RekeyRecoveryKeyUpdate(shard, nonce string) (*RekeyUpdateResponse, error)

+ func (c *Sys) RekeyRetrieveRecoveryBackup() (*RekeyRetrieveResponse, error)

type TokenCreateRequest

+ ExplicitMaxTTL string

+ Renewable *bool

+ type WrappingLookupFunc func(operation, path string) string

Mar 16, 2016

Changes in this version

type Audit

+ Path string

+ type CapabilitiesResponse struct

+ Capabilities []string

type SSHHelperConfig

+ func ParseSSHHelperConfig(contents string) (*SSHHelperConfig, error)

type SecretAuth

+ Accessor string

type Sys

+ func (c *Sys) Capabilities(token, path string) ([]string, error)

+ func (c *Sys) CapabilitiesSelf(path string) ([]string, error)

+ func (c *Sys) RevokeForce(id string) error

+ func (c *Sys) StepDown() error

type TokenAuth

+ func (c *TokenAuth) CreateWithRole(opts *TokenCreateRequest, roleName string) (*Secret, error)

+ func (c *TokenAuth) LookupAccessor(accessor string) (*Secret, error)

+ func (c *TokenAuth) RevokeAccessor(accessor string) error

Feb 25, 2016

Changes in this version

+ const EnvVaultTLSServerName

+ const SSHHelperDefaultMountPoint

type Client

+ func (c *Client) SSHHelper() *SSHHelper

+ func (c *Client) SSHHelperWithMountPoint(mountPoint string) *SSHHelper

+ type SSHHelper struct

+ MountPoint string

+ func (c *SSHHelper) Verify(otp string) (*SSHVerifyResponse, error)

+ type SSHHelperConfig struct

+ AllowedCidrList string

+ CACert string

+ CAPath string

+ SSHMountPoint string

+ TLSSkipVerify bool

+ VaultAddr string

+ func LoadSSHHelperConfig(path string) (*SSHHelperConfig, error)

+ func (c *SSHHelperConfig) NewClient() (*Client, error)

+ func (c *SSHHelperConfig) SetTLSParameters(clientConfig *Config, certPool *x509.CertPool)

Feb 10, 2016

Changes in this version

+ type GenerateRootStatusResponse struct

+ Complete bool

+ EncodedRootToken string

+ Nonce string

+ PGPFingerprint string

+ Progress int

+ Required int

+ Started bool

type Logical

+ func (c *Logical) List(path string) (*Secret, error)

type RekeyInitRequest

+ Backup bool

+ type RekeyRetrieveResponse struct

+ Keys map[string][]string

+ Nonce string

type RekeyStatusResponse

+ Backup bool

+ Nonce string

+ PGPFingerprints []string

type RekeyUpdateResponse

+ Backup bool

+ Nonce string

+ PGPFingerprints []string

type Sys

+ func (c *Sys) GenerateRootCancel() error

+ func (c *Sys) GenerateRootInit(otp, pgpKey string) error

+ func (c *Sys) GenerateRootStatus() (*GenerateRootStatusResponse, error)

+ func (c *Sys) GenerateRootUpdate(shard, nonce string) (*GenerateRootStatusResponse, error)

+ func (c *Sys) RekeyDeleteBackup() error

+ func (c *Sys) RekeyRetrieveBackup() (*RekeyRetrieveResponse, error)

type TokenAuth

+ func (c *TokenAuth) Lookup(token string) (*Secret, error)

Dec 10, 2015

Changes in this version

+ const EnvVaultAddress

+ const EnvVaultCACert

+ const EnvVaultCAPath

+ const EnvVaultClientCert

+ const EnvVaultClientKey

+ const EnvVaultInsecure

+ func LoadCACert(path string) (*x509.CertPool, error)

+ func LoadCAPath(path string) (*x509.CertPool, error)

type Config

+ func (c *Config) ReadEnvironment() error

type SSHAgentConfig

+ func (c *SSHAgentConfig) SetTLSParameters(clientConfig *Config, certPool *x509.CertPool)

type Secret

+ Warnings []string

type Sys

+ func (c *Sys) AuditHash(path string, input string) (string, error)

+ func (c *Sys) ResetUnsealProcess() (*SealStatusResponse, error)

type TokenAuth

+ func (c *TokenAuth) LookupSelf() (*Secret, error)

+ func (c *TokenAuth) RenewSelf(increment int) (*Secret, error)

+ func (c *TokenAuth) RevokeSelf() error

type TokenCreateRequest

+ NoDefaultPolicy bool

+ TTL string

Sep 28, 2015

Changes in this version

+ const SSHAgentDefaultMountPoint

+ const VerifyEchoRequest

+ const VerifyEchoResponse

type Client

+ func (c *Client) SSH() *SSH

+ func (c *Client) SSHAgent() *SSHAgent

+ func (c *Client) SSHAgentWithMountPoint(mountPoint string) *SSHAgent

+ func (c *Client) SSHWithMountPoint(mountPoint string) *SSH

type InitRequest

+ PGPKeys []string

+ type MountConfigInput struct

+ DefaultLeaseTTL string

+ MaxLeaseTTL string

+ type MountConfigOutput struct

+ DefaultLeaseTTL int

+ MaxLeaseTTL int

+ type MountInput struct

+ Config MountConfigInput

+ Description string

+ Type string

+ type MountOutput struct

+ Config MountConfigOutput

+ Description string

+ Type string

type RekeyInitRequest

+ PGPKeys []string

type Request

+ ClientToken string

+ type SSH struct

+ MountPoint string

+ func (c *SSH) Credential(role string, data map[string]interface{}) (*Secret, error)

+ type SSHAgent struct

+ MountPoint string

+ func (c *SSHAgent) Verify(otp string) (*SSHVerifyResponse, error)

+ type SSHAgentConfig struct

+ AllowedCidrList string

+ CACert string

+ CAPath string

+ SSHMountPoint string

+ TLSSkipVerify bool

+ VaultAddr string

+ func LoadSSHAgentConfig(path string) (*SSHAgentConfig, error)

+ func (c *SSHAgentConfig) NewClient() (*Client, error)

+ func (c *SSHAgentConfig) TLSClient(certPool *x509.CertPool) *http.Client

+ type SSHVerifyResponse struct

+ IP string

+ Message string

+ Username string

type Sys

+ func (c *Sys) MountConfig(path string) error

+ func (c *Sys) TuneMount(path string, config MountConfigInput) error

Jul 13, 2015

Changes in this version

+ type KeyStatus struct

+ InstallTime time.Time

+ Term int

+ type RekeyInitRequest struct

+ SecretShares int

+ SecretThreshold int

+ type RekeyStatusResponse struct

+ N int

+ Progress int

+ Required int

+ Started bool

+ T int

+ type RekeyUpdateResponse struct

+ Complete bool

+ Keys []string

type Sys

+ func (c *Sys) KeyStatus() (*KeyStatus, error)

+ func (c *Sys) RekeyCancel() error

+ func (c *Sys) RekeyInit(config *RekeyInitRequest) error

+ func (c *Sys) RekeyStatus() (*RekeyStatusResponse, error)

+ func (c *Sys) RekeyUpdate(shard string) (*RekeyUpdateResponse, error)

+ func (c *Sys) Rotate() error

Apr 28, 2015

Changes in this version

+ const AuthCookieName

+ type Audit struct

+ Description string

+ Options map[string]string

+ Type string

+ type Auth struct

+ func (a *Auth) Token() *TokenAuth

+ type AuthMount struct

+ Description string

+ Type string

+ type Client struct

+ func NewClient(c *Config) (*Client, error)

+ func (c *Client) Auth() *Auth

+ func (c *Client) ClearToken()

+ func (c *Client) Help(path string) (*Help, error)

+ func (c *Client) Logical() *Logical

+ func (c *Client) NewRequest(method, path string) *Request

+ func (c *Client) RawRequest(r *Request) (*Response, error)

+ func (c *Client) SetToken(v string)

+ func (c *Client) Sys() *Sys

+ func (c *Client) Token() string

+ type Config struct

+ Address string

+ HttpClient *http.Client

+ func DefaultConfig() *Config

+ type ErrorResponse struct

+ Errors []string

+ type Help struct

+ Help string

+ SeeAlso []string

+ type InitRequest struct

+ SecretShares int

+ SecretThreshold int

+ type InitResponse struct

+ Keys []string

+ RootToken string

+ type InitStatusResponse struct

+ Initialized bool

+ type LeaderResponse struct

+ HAEnabled bool

+ IsSelf bool

+ LeaderAddress string

+ type Logical struct

+ func (c *Logical) Delete(path string) (*Secret, error)

+ func (c *Logical) Read(path string) (*Secret, error)

+ func (c *Logical) Write(path string, data map[string]interface{}) (*Secret, error)

+ type Mount struct

+ Description string

+ Type string

+ type Request struct

+ Body io.Reader

+ BodySize int64

+ Method string

+ Obj interface{}

+ Params url.Values

+ URL *url.URL

+ func (r *Request) ResetJSONBody() error

+ func (r *Request) SetJSONBody(val interface{}) error

+ func (r *Request) ToHTTP() (*http.Request, error)

+ type Response struct

+ func (r *Response) DecodeJSON(out interface{}) error

+ func (r *Response) Error() error

+ type SealStatusResponse struct

+ N int

+ Progress int

+ Sealed bool

+ T int

+ type Secret struct

+ Auth *SecretAuth

+ Data map[string]interface{}

+ LeaseDuration int

+ LeaseID string

+ Renewable bool

+ func ParseSecret(r io.Reader) (*Secret, error)

+ type SecretAuth struct

+ ClientToken string

+ LeaseDuration int

+ Metadata map[string]string

+ Policies []string

+ Renewable bool

+ type Sys struct

+ func (c *Sys) DeletePolicy(name string) error

+ func (c *Sys) DisableAudit(path string) error

+ func (c *Sys) DisableAuth(path string) error

+ func (c *Sys) EnableAudit(path string, auditType string, desc string, opts map[string]string) error

+ func (c *Sys) EnableAuth(path, authType, desc string) error

+ func (c *Sys) GetPolicy(name string) (string, error)

+ func (c *Sys) Init(opts *InitRequest) (*InitResponse, error)

+ func (c *Sys) InitStatus() (bool, error)

+ func (c *Sys) Leader() (*LeaderResponse, error)

+ func (c *Sys) ListAudit() (map[string]*Audit, error)

+ func (c *Sys) ListAuth() (map[string]*AuthMount, error)

+ func (c *Sys) ListMounts() (map[string]*Mount, error)

+ func (c *Sys) ListPolicies() ([]string, error)

+ func (c *Sys) Login(vars map[string]string) error

+ func (c *Sys) Mount(path, mountType, description string) error

+ func (c *Sys) PutPolicy(name, rules string) error

+ func (c *Sys) Remount(from, to string) error

+ func (c *Sys) Renew(id string, increment int) (*Secret, error)

+ func (c *Sys) Revoke(id string) error

+ func (c *Sys) RevokePrefix(id string) error

+ func (c *Sys) Seal() error

+ func (c *Sys) SealStatus() (*SealStatusResponse, error)

+ func (c *Sys) Unmount(path string) error

+ func (c *Sys) Unseal(shard string) (*SealStatusResponse, error)

+ type TokenAuth struct

+ func (c *TokenAuth) Create(opts *TokenCreateRequest) (*Secret, error)

+ func (c *TokenAuth) Renew(token string, increment int) (*Secret, error)

+ func (c *TokenAuth) RevokeOrphan(token string) error

+ func (c *TokenAuth) RevokePrefix(token string) error

+ func (c *TokenAuth) RevokeTree(token string) error

+ type TokenCreateRequest struct

+ DisplayName string

+ ID string

+ Lease string

+ Metadata map[string]string

+ NoParent bool

+ NumUses int

+ Policies []string