fs

Documentation

Index

• func CreateIdentitySet(filename string, rootKey key.Key, admin kes.Identity) error
• func CreateKeyStore(path string) error
• func CreatePolicySet(path string) error
• func Init(path string, init *InitConfig, seal *SealConfig) (sys.Vault, []sys.UnsealKey, error)
• func Open(path string, errorLog *log.Logger) (sys.Vault, error)
• func OpenIdentitySet(filename string, rootKey key.Key, errorLog *log.Logger) (auth.IdentitySet, error)
• func OpenKeyStore(path string, key key.Key, errorLog *log.Logger) (key.Store, error)
• func OpenPolicySet(path string, key key.Key, errorLog *log.Logger) (auth.PolicySet, error)
• func WriteInitConfig(filename string, config *InitConfig) error
• type InitConfig
  • func ReadInitConfig(filename string) (*InitConfig, error)
• type SealConfig

Functions

func CreateIdentitySet

func CreateIdentitySet(filename string, rootKey key.Key, admin kes.Identity) error

CreateIdentitySet creates a new auth.IdentitySet at the given path with the given admin identity.

func CreateKeyStore

func CreateKeyStore(path string) error

CreateKeyStore creates a new key.Store at the given path.

func CreatePolicySet

func CreatePolicySet(path string) error

CreatePolicySet creates a new auth.PolicySet at the given path.

func Init

func Init(path string, init *InitConfig, seal *SealConfig) (sys.Vault, []sys.UnsealKey, error)

Init initializes a stateful KES deployment within the given path using the InitConfig and SealConfig.

It returns an initialized Vault and a set of UnsealKeys to unseal the Vault in the future.

func Open

func Open(path string, errorLog *log.Logger) (sys.Vault, error)

Open returns a new Vault that reads its initial and seal configuration from config files within the given path.

func OpenIdentitySet

func OpenIdentitySet(filename string, rootKey key.Key, errorLog *log.Logger) (auth.IdentitySet, error)

OpenIdentitySet opens a new auth.IdentitySet at the given path.

func OpenKeyStore

func OpenKeyStore(path string, key key.Key, errorLog *log.Logger) (key.Store, error)

OpenKeyStore opens the key.Store at the given path.

func OpenPolicySet

func OpenPolicySet(path string, key key.Key, errorLog *log.Logger) (auth.PolicySet, error)

OpenPolicySet opens the auth.PolicySet at the given path.

func WriteInitConfig

func WriteInitConfig(filename string, config *InitConfig) error

WriteInitConfig writes the YAML representation of the given InitConfig to a file.

Types

type InitConfig

type InitConfig struct {
	Version string

	Address yml.String

	PrivateKey yml.String

	Certificate yml.String

	Password yml.String

	VerifyClientCerts yml.Bool
}

InitConfig contains the initial configuration for a stateful KES deployment.

func ReadInitConfig

func ReadInitConfig(filename string) (*InitConfig, error)

ReadInitConfig reads and parses the InitConfig YAML representation from the given file.

type SealConfig

type SealConfig struct {
	SysAdmin kes.Identity

	Sealer sys.Sealer
}

SealConfig contains the initial seal configuration for a stateful KESdeployment.