client

Documentation

Index

• func WithClient(ctx context.Context, c *Client) context.Context
• type Client
  • func GetClient(ctx context.Context) *Client
  • func New(dir string) *Client
  • func (c *Client) Passphrase(ctx context.Context, key, reason string) (string, error)
  • func (c *Client) Ping(ctx context.Context) error
  • func (c *Client) Remove(ctx context.Context, key string) error

Functions

func WithClient

func WithClient(ctx context.Context, c *Client) context.Context

WithClient returns a context with a client instance set.

Types

type Client

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

Client is a agent client

func GetClient

func GetClient(ctx context.Context) *Client

GetClient returns a client instance, if set. May be nil.

func New

func New(dir string) *Client

New creates a new client

func (*Client) Passphrase

func (c *Client) Passphrase(ctx context.Context, key, reason string) (string, error)

Passphrase asks for a passphrase from the agent

func (*Client) Ping

func (c *Client) Ping(ctx context.Context) error

Ping checks connectivity to the agent

func (*Client) Remove

func (c *Client) Remove(ctx context.Context, key string) error

Remove un-caches a single key