Documentation
¶
Index ¶
- func Build(ctx context.Context, name string) (secrets.Keeper, error)
- func CheckConfig(ctx context.Context, c *config.Config) error
- func Decode(ctx context.Context, name string) (any, error)
- func Exists(ctx context.Context, name string) bool
- func PinEntry(title, desc, prompt, ok string) (string, error)
- func StartServer(logger *log.Logger, kpr secrets.Keeper) error
- func StopServer(immediacy StopImmediacy) error
- func Validate(ctx context.Context, name string) error
- func WithBuilder(ctx context.Context, c *config.Config) context.Context
- type StopImmediacy
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckConfig ¶
CheckConfig validates the configuration for all of ghost.
func Decode ¶
Decode decodes the configuration for the named secret keeper into its preferred configuration type. This is useful for tools that want to manipulate the configuration directly. This will have any secret references resolved and lookups performed.
func PinEntry ¶
PinEntry is a tool that makes it easier to display a dialog prompting the user for a password.
func StartServer ¶
StartServer starts the keeper server. As of this writing, it will always be configured to run in an automatically named unix socket in the system's temp directory. It will also write a pid file to the same directory.
func StopServer ¶
func StopServer(immediacy StopImmediacy) error
StopServer stops the keeper server. The given immediacy indicates how quickly the server should be stopped.
Types ¶
type StopImmediacy ¶
type StopImmediacy int
StopImmediacy is used to indicate how quickly the server should be stopped.
const ( StopGraceful StopImmediacy = iota // stop eventually (SIGHUP) StopQuick // stop soon (SIGQUIT) StopNow // stop now (SIGKILL) )
Source Files