command

type AuditDisableCommand ¶

type AuditDisableCommand struct {
	meta.Meta
}

AuditDisableCommand is a Command that mounts a new mount.

func (c *AuditDisableCommand) Help() string

func (c *AuditDisableCommand) Run(args []string) int

func (c *AuditDisableCommand) Synopsis() string

type AuditEnableCommand ¶

type AuditEnableCommand struct {
	meta.Meta
	// contains filtered or unexported fields
}

AuditEnableCommand is a Command that mounts a new mount.

func (c *AuditEnableCommand) Help() string

func (c *AuditEnableCommand) Run(args []string) int

func (c *AuditEnableCommand) Synopsis() string

type AuditListCommand ¶

type AuditListCommand struct {
	meta.Meta
}

AuditListCommand is a Command that lists the enabled audits.

func (c *AuditListCommand) Help() string

func (c *AuditListCommand) Run(args []string) int

func (c *AuditListCommand) Synopsis() string

type AuthCommand ¶

type AuthCommand struct {
	meta.Meta

	Handlers map[string]AuthHandler
	// contains filtered or unexported fields
}

AuthCommand is a Command that handles authentication.

func (c *AuthCommand) Help() string

func (c *AuthCommand) Run(args []string) int

func (c *AuthCommand) Synopsis() string

type AuthDisableCommand ¶

type AuthDisableCommand struct {
	meta.Meta
}

AuthDisableCommand is a Command that enables a new endpoint.

func (c *AuthDisableCommand) Help() string

func (c *AuthDisableCommand) Run(args []string) int

func (c *AuthDisableCommand) Synopsis() string

type AuthEnableCommand ¶

type AuthEnableCommand struct {
	meta.Meta
}

AuthEnableCommand is a Command that enables a new endpoint.

func (c *AuthEnableCommand) Help() string

func (c *AuthEnableCommand) Run(args []string) int

func (c *AuthEnableCommand) Synopsis() string

type AuthHandler ¶

type AuthHandler interface {
	Auth(*api.Client, map[string]string) (string, error)
	Help() string
}

AuthHandler is the interface that any auth handlers must implement to enable auth via the CLI.

type CapabilitiesCommand ¶

type CapabilitiesCommand struct {
	meta.Meta
}

CapabilitiesCommand is a Command that enables a new endpoint.

func (c *CapabilitiesCommand) Help() string

func (c *CapabilitiesCommand) Run(args []string) int

func (c *CapabilitiesCommand) Synopsis() string

type DefaultConfig ¶

type DefaultConfig struct {
	// TokenHelper is the executable/command that is executed for storing
	// and retrieving the authentication token for the Vault CLI. If this
	// is not specified, then vault's internal token store will be used, which
	// stores the token on disk unencrypted.
	TokenHelper string `hcl:"token_helper"`
}

Config is the CLI configuration for Vault that can be specified via a `$HOME/.vault` file which is HCL-formatted (therefore HCL or JSON).

func Config() (*DefaultConfig, error)

func LoadConfig(path string) (*DefaultConfig, error)

func ParseConfig(contents string) (*DefaultConfig, error)

type DeleteCommand ¶

type DeleteCommand struct {
	meta.Meta
}

DeleteCommand is a Command that puts data into the Vault.

func (c *DeleteCommand) Help() string

func (c *DeleteCommand) Run(args []string) int

func (c *DeleteCommand) Synopsis() string

type Formatter ¶

type Formatter interface {
	Output(ui cli.Ui, secret *api.Secret, data interface{}) error
}

type GenerateRootCommand ¶

type GenerateRootCommand struct {
	meta.Meta

	// Key can be used to pre-seed the key. If it is set, it will not
	// be asked with the `password` helper.
	Key string

	// The nonce for the rekey request to send along
	Nonce string
}

GenerateRootCommand is a Command that generates a new root token.

func (c *GenerateRootCommand) Help() string

func (c *GenerateRootCommand) Run(args []string) int

func (c *GenerateRootCommand) Synopsis() string

type InitCommand ¶

type InitCommand struct {
	meta.Meta
}

InitCommand is a Command that initializes a new Vault server.

func (c *InitCommand) Help() string

func (c *InitCommand) Run(args []string) int

func (c *InitCommand) Synopsis() string

type JsonFormatter ¶

type JsonFormatter struct {
}

An output formatter for json output of an object

func (j JsonFormatter) Output(ui cli.Ui, secret *api.Secret, data interface{}) error

type KeyStatusCommand ¶

type KeyStatusCommand struct {
	meta.Meta
}

KeyStatusCommand is a Command that provides information about the key status

func (c *KeyStatusCommand) Help() string

func (c *KeyStatusCommand) Run(args []string) int

func (c *KeyStatusCommand) Synopsis() string

type ListCommand ¶

type ListCommand struct {
	meta.Meta
}

ListCommand is a Command that lists data from the Vault.

func (c *ListCommand) Help() string

func (c *ListCommand) Run(args []string) int

func (c *ListCommand) Synopsis() string

type MountCommand ¶

type MountCommand struct {
	meta.Meta
}

MountCommand is a Command that mounts a new mount.

func (c *MountCommand) Help() string

func (c *MountCommand) Run(args []string) int

func (c *MountCommand) Synopsis() string

type MountTuneCommand ¶

type MountTuneCommand struct {
	meta.Meta
}

MountTuneCommand is a Command that remounts a mounted secret backend to a new endpoint.

func (c *MountTuneCommand) Help() string

func (c *MountTuneCommand) Run(args []string) int

func (c *MountTuneCommand) Synopsis() string

type MountsCommand ¶

type MountsCommand struct {
	meta.Meta
}

MountsCommand is a Command that lists the mounts.

func (c *MountsCommand) Help() string

func (c *MountsCommand) Run(args []string) int

func (c *MountsCommand) Synopsis() string

type PathHelpCommand ¶

type PathHelpCommand struct {
	meta.Meta
}

PathHelpCommand is a Command that lists the mounts.

func (c *PathHelpCommand) Help() string

func (c *PathHelpCommand) Run(args []string) int

func (c *PathHelpCommand) Synopsis() string

type PolicyDeleteCommand ¶

type PolicyDeleteCommand struct {
	meta.Meta
}

PolicyDeleteCommand is a Command that enables a new endpoint.

func (c *PolicyDeleteCommand) Help() string

func (c *PolicyDeleteCommand) Run(args []string) int

func (c *PolicyDeleteCommand) Synopsis() string

type PolicyListCommand ¶

type PolicyListCommand struct {
	meta.Meta
}

PolicyListCommand is a Command that enables a new endpoint.

func (c *PolicyListCommand) Help() string

func (c *PolicyListCommand) Run(args []string) int

func (c *PolicyListCommand) Synopsis() string

type PolicyWriteCommand ¶

type PolicyWriteCommand struct {
	meta.Meta
}

PolicyWriteCommand is a Command that enables a new endpoint.

func (c *PolicyWriteCommand) Help() string

func (c *PolicyWriteCommand) Run(args []string) int

func (c *PolicyWriteCommand) Synopsis() string

type ReadCommand ¶

type ReadCommand struct {
	meta.Meta
}

ReadCommand is a Command that reads data from the Vault.

func (c *ReadCommand) Help() string

func (c *ReadCommand) Run(args []string) int

func (c *ReadCommand) Synopsis() string

type RekeyCommand ¶

type RekeyCommand struct {
	meta.Meta

	// Key can be used to pre-seed the key. If it is set, it will not
	// be asked with the `password` helper.
	Key string

	// The nonce for the rekey request to send along
	Nonce string

	// Whether to use the recovery key instead of barrier key, if available
	RecoveryKey bool
}

RekeyCommand is a Command that rekeys the vault.

func (c *RekeyCommand) Help() string

func (c *RekeyCommand) Run(args []string) int

func (c *RekeyCommand) Synopsis() string

type RemountCommand ¶

type RemountCommand struct {
	meta.Meta
}

RemountCommand is a Command that remounts a mounted secret backend to a new endpoint.

func (c *RemountCommand) Help() string

func (c *RemountCommand) Run(args []string) int

func (c *RemountCommand) Synopsis() string

type RenewCommand ¶

type RenewCommand struct {
	meta.Meta
}

RenewCommand is a Command that mounts a new mount.

func (c *RenewCommand) Help() string

func (c *RenewCommand) Run(args []string) int

func (c *RenewCommand) Synopsis() string

type RevokeCommand ¶

type RevokeCommand struct {
	meta.Meta
}

RevokeCommand is a Command that mounts a new mount.

func (c *RevokeCommand) Help() string

func (c *RevokeCommand) Run(args []string) int

func (c *RevokeCommand) Synopsis() string

type RotateCommand ¶

type RotateCommand struct {
	meta.Meta
}

RotateCommand is a Command that rotates the encryption key being used

func (c *RotateCommand) Help() string

func (c *RotateCommand) Run(args []string) int

func (c *RotateCommand) Synopsis() string

type SSHCommand ¶

type SSHCommand struct {
	meta.Meta
}

SSHCommand is a Command that establishes a SSH connection with target by generating a dynamic key

func (c *SSHCommand) Help() string

func (c *SSHCommand) Run(args []string) int

func (c *SSHCommand) Synopsis() string

type SSHCredentialResp ¶

type SSHCredentialResp struct {
	KeyType  string `mapstructure:"key_type"`
	Key      string `mapstructure:"key"`
	Username string `mapstructure:"username"`
	IP       string `mapstructure:"ip"`
	Port     string `mapstructure:"port"`
}

Structure to hold the fields returned when asked for a credential from SSHh backend.

type SealCommand ¶

type SealCommand struct {
	meta.Meta
}

SealCommand is a Command that seals the vault.

func (c *SealCommand) Help() string

func (c *SealCommand) Run(args []string) int

func (c *SealCommand) Synopsis() string

type ServerCommand ¶

type ServerCommand struct {
	AuditBackends      map[string]audit.Factory
	CredentialBackends map[string]logical.Factory
	LogicalBackends    map[string]logical.Factory

	ShutdownCh chan struct{}
	SighupCh   chan struct{}

	WaitGroup *sync.WaitGroup

	meta.Meta
	// contains filtered or unexported fields
}

ServerCommand is a Command that starts the Vault server.

func (c *ServerCommand) Help() string

func (c *ServerCommand) Reload(configPath []string) error

func (c *ServerCommand) Run(args []string) int

func (c *ServerCommand) Synopsis() string

type StatusCommand ¶

type StatusCommand struct {
	meta.Meta
}

StatusCommand is a Command that outputs the status of whether Vault is sealed or not as well as HA information.

func (c *StatusCommand) Help() string

func (c *StatusCommand) Run(args []string) int

func (c *StatusCommand) Synopsis() string

type StepDownCommand ¶

type StepDownCommand struct {
	meta.Meta
}

StepDownCommand is a Command that seals the vault.

func (c *StepDownCommand) Help() string

func (c *StepDownCommand) Run(args []string) int

func (c *StepDownCommand) Synopsis() string

type TableFormatter ¶

type TableFormatter struct {
}

An output formatter for table output of an object

func (t TableFormatter) Output(ui cli.Ui, secret *api.Secret, data interface{}) error

func (t TableFormatter) OutputList(ui cli.Ui, secret *api.Secret, list []interface{}) error

func (t TableFormatter) OutputSecret(ui cli.Ui, secret, s *api.Secret) error

type TokenCreateCommand ¶

type TokenCreateCommand struct {
	meta.Meta
}

TokenCreateCommand is a Command that mounts a new mount.

func (c *TokenCreateCommand) Help() string

func (c *TokenCreateCommand) Run(args []string) int

func (c *TokenCreateCommand) Synopsis() string

type TokenLookupCommand ¶

type TokenLookupCommand struct {
	meta.Meta
}

TokenLookupCommand is a Command that outputs details about the provided.

func (c *TokenLookupCommand) Help() string

func (c *TokenLookupCommand) Run(args []string) int

func (c *TokenLookupCommand) Synopsis() string

type TokenRenewCommand ¶

type TokenRenewCommand struct {
	meta.Meta
}

TokenRenewCommand is a Command that mounts a new mount.

func (c *TokenRenewCommand) Help() string

func (c *TokenRenewCommand) Run(args []string) int

func (c *TokenRenewCommand) Synopsis() string

type TokenRevokeCommand ¶

type TokenRevokeCommand struct {
	meta.Meta
}

TokenRevokeCommand is a Command that mounts a new mount.

func (c *TokenRevokeCommand) Help() string

func (c *TokenRevokeCommand) Run(args []string) int

func (c *TokenRevokeCommand) Synopsis() string

type UnmountCommand ¶

type UnmountCommand struct {
	meta.Meta
}

UnmountCommand is a Command that mounts a new mount.

func (c *UnmountCommand) Help() string

func (c *UnmountCommand) Run(args []string) int

func (c *UnmountCommand) Synopsis() string

type UnsealCommand ¶

type UnsealCommand struct {
	meta.Meta

	// Key can be used to pre-seed the key. If it is set, it will not
	// be asked with the `password` helper.
	Key string
}

UnsealCommand is a Command that unseals the vault.

func (c *UnsealCommand) Help() string

func (c *UnsealCommand) Run(args []string) int

func (c *UnsealCommand) Synopsis() string

type UnwrapCommand ¶

type UnwrapCommand struct {
	meta.Meta
}

UnwrapCommand is a Command that behaves like ReadCommand but specifically for unwrapping cubbyhole-wrapped secrets

func (c *UnwrapCommand) Help() string

func (c *UnwrapCommand) Run(args []string) int

func (c *UnwrapCommand) Synopsis() string

type VersionCommand ¶

type VersionCommand struct {
	VersionInfo *version.VersionInfo
	Ui          cli.Ui
}

VersionCommand is a Command implementation prints the version.

func (c *VersionCommand) Help() string

func (c *VersionCommand) Run(_ []string) int

func (c *VersionCommand) Synopsis() string

type WriteCommand ¶

type WriteCommand struct {
	meta.Meta
	// contains filtered or unexported fields
}

WriteCommand is a Command that puts data into the Vault.

func (c *WriteCommand) Help() string

func (c *WriteCommand) Run(args []string) int

func (c *WriteCommand) Synopsis() string

type YamlFormatter ¶

type YamlFormatter struct {
}

An output formatter for yaml output format of an object

func (y YamlFormatter) Output(ui cli.Ui, secret *api.Secret, data interface{}) error