vaulted

Documentation

Index

• Constants
• Variables
• func ListVaults() ([]string, error)
• func RemoveVault(name string) error
• func SealVault(name, password string, vault *Vault) error
• func VaultExists(name string) bool
• type AWSCredentials
• type AWSKey
• type Details
  • func (d Details) Bytes(name string) []byte
  • func (d Details) Clone() Details
  • func (d Details) Int(name string) int
  • func (d Details) SetBytes(name string, value []byte)
  • func (d Details) SetInt(name string, value int)
  • func (d Details) SetString(name string, value string)
  • func (d Details) String(name string) string
• type Environment
  • func GetEnvironment(name, password string) (*Environment, error)
  • func (e *Environment) Spawn(cmd []string, extraVars map[string]string) (*int, error)
• type EnvironmentFile
• type ProxyKeyring
  • func NewProxyKeyring(upstreamAuthSock string) (*ProxyKeyring, error)
  • func (pk *ProxyKeyring) Add(key agent.AddedKey) error
  • func (pk *ProxyKeyring) Close() error
  • func (pk *ProxyKeyring) List() ([]*agent.Key, error)
  • func (pk *ProxyKeyring) Listen() (string, error)
  • func (pk *ProxyKeyring) Lock(passphrase []byte) error
  • func (pk *ProxyKeyring) Remove(key ssh.PublicKey) error
  • func (pk *ProxyKeyring) RemoveAll() error
  • func (pk *ProxyKeyring) Serve() error
  • func (pk *ProxyKeyring) Sign(key ssh.PublicKey, data []byte) (*ssh.Signature, error)
  • func (pk *ProxyKeyring) Signers() ([]ssh.Signer, error)
  • func (pk *ProxyKeyring) Unlock(passphrase []byte) error
• type Vault
  • func OpenVault(name, password string) (*Vault, error)
  • func (v *Vault) CreateEnvironment(extraVars map[string]string) (*Environment, error)
• type VaultFile
• type VaultKey

Constants

const (
	DefaultSessionName = "VaultedSession"
)

Variables

var (
	ErrInvalidPassword         = errors.New("Invalid password")
	ErrInvalidKeyConfig        = errors.New("Invalid key configuration")
	ErrInvalidEncryptionConfig = errors.New("Invalid encryption configuration")
)

var (
	ErrInvalidCommand = errors.New("Invalid command")
)

var STSDurationDefault = time.Hour

Functions

func ListVaults

func ListVaults() ([]string, error)

func RemoveVault

func RemoveVault(name string) error

func SealVault

func SealVault(name, password string, vault *Vault) error

func VaultExists

func VaultExists(name string) bool

Types

type AWSCredentials

type AWSCredentials struct {
	ID     string `json:"id"`
	Secret string `json:"secret"`
	Token  string `json:"token,omitempty"`
}

type AWSKey

type AWSKey struct {
	AWSCredentials
	MFA                     string `json:"mfa,omitempty"`
	Role                    string `json:"role,omitempty"`
	ForgoTempCredGeneration bool   `json:"forgoTempCredGeneration"`
}

type Details

type Details map[string]interface{}

func (Details) Bytes

func (d Details) Bytes(name string) []byte

func (Details) Clone

func (d Details) Clone() Details

func (Details) Int

func (d Details) Int(name string) int

func (Details) SetBytes

func (d Details) SetBytes(name string, value []byte)

func (Details) SetInt

func (d Details) SetInt(name string, value int)

func (Details) SetString

func (d Details) SetString(name string, value string)

func (Details) String

func (d Details) String(name string) string

type Environment

type Environment struct {
	Expiration int64             `json:"expiration"`
	Vars       map[string]string `json:"vars"`
	AWSCreds   *AWSCredentials   `json:"aws_creds,omitempty"`
	SSHKeys    map[string]string `json:"ssh_keys,omitempty"`
}

func GetEnvironment

func GetEnvironment(name, password string) (*Environment, error)

func (*Environment) Spawn

func (e *Environment) Spawn(cmd []string, extraVars map[string]string) (*int, error)

type EnvironmentFile

type EnvironmentFile struct {
	Method     string  `json:"method"`
	Details    Details `json:"details,omitempty"`
	Ciphertext []byte  `json:"ciphertext"`
}

type ProxyKeyring

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

func NewProxyKeyring

func NewProxyKeyring(upstreamAuthSock string) (*ProxyKeyring, error)

func (*ProxyKeyring) Add

func (pk *ProxyKeyring) Add(key agent.AddedKey) error

func (*ProxyKeyring) Close

func (pk *ProxyKeyring) Close() error

func (*ProxyKeyring) List

func (pk *ProxyKeyring) List() ([]*agent.Key, error)

func (*ProxyKeyring) Listen

func (pk *ProxyKeyring) Listen() (string, error)

func (*ProxyKeyring) Lock

func (pk *ProxyKeyring) Lock(passphrase []byte) error

func (*ProxyKeyring) Remove

func (pk *ProxyKeyring) Remove(key ssh.PublicKey) error

func (*ProxyKeyring) RemoveAll

func (pk *ProxyKeyring) RemoveAll() error

func (*ProxyKeyring) Serve

func (pk *ProxyKeyring) Serve() error

func (*ProxyKeyring) Sign

func (pk *ProxyKeyring) Sign(key ssh.PublicKey, data []byte) (*ssh.Signature, error)

func (*ProxyKeyring) Signers

func (pk *ProxyKeyring) Signers() ([]ssh.Signer, error)

func (*ProxyKeyring) Unlock

func (pk *ProxyKeyring) Unlock(passphrase []byte) error

type Vault

type Vault struct {
	Vars     map[string]string `json:"vars"`
	AWSKey   *AWSKey           `json:"aws_key,omitempty"`
	SSHKeys  map[string]string `json:"ssh_keys,omitempty"`
	Duration time.Duration     `json:"duration,omitempty"`
}

func OpenVault

func OpenVault(name, password string) (*Vault, error)

func (*Vault) CreateEnvironment

func (v *Vault) CreateEnvironment(extraVars map[string]string) (*Environment, error)

type VaultFile

type VaultFile struct {
	Key *VaultKey `json:"key"`

	Method     string  `json:"method"`
	Details    Details `json:"details,omitempty"`
	Ciphertext []byte  `json:"ciphertext"`
}

type VaultKey

type VaultKey struct {
	Method  string  `json:"method"`
	Details Details `json:"details"`
}