secret

Documentation

Index

• Constants
• type Client
  • func NewClient(vault string, cred auth.Credential, options ...ClientOption) (*Client, error)
  • func (c Client) Get(ctx context.Context, name string, options ...Option) (Secret, error)
  • func (c Client) GetSecrets(ctx context.Context, names []string, options ...Option) (map[string]Secret, error)
  • func (c *Client) SetVault(vault string)
  • func (c Client) Vault() string
• type ClientOption
  • func WithClientVersions(versions map[string]string) ClientOption
  • func WithCloud(c cloud.Cloud) ClientOption
  • func WithConcurrency(n int) ClientOption
  • func WithHTTPClient(client request.Client) ClientOption
  • func WithRetryPolicy(r httpr.RetryPolicy) ClientOption
  • func WithTimeout(d time.Duration) ClientOption
• type Option
  • func WithVersions(versions map[string]string) Option
• type Options
• type Secret

Constants

const (
	// SecretNotFound is the error code returned when a secret is not found.
	SecretNotFound = "SecretNotFound"
)

Types

type Client

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

Client contains methods to call the Azure Key Vault REST API and base settings for handling the requests.

func NewClient

func NewClient(vault string, cred auth.Credential, options ...ClientOption) (*Client, error)

NewClient creates and returns a new *Client.

func (Client) Get

func (c Client) Get(ctx context.Context, name string, options ...Option) (Secret, error)

Get a secret.

func (Client) GetSecrets

func (c Client) GetSecrets(ctx context.Context, names []string, options ...Option) (map[string]Secret, error)

GetSecrets gets secrets by names.

func (*Client) SetVault

func (c *Client) SetVault(vault string)

SetVault sets the vault for the client.

func (Client) Vault

func (c Client) Vault() string

Vault returns the vault for the client.

type ClientOption

type ClientOption func(c *Client)

ClientOption is a function that sets options to *Client.

func WithClientVersions

func WithClientVersions(versions map[string]string) ClientOption

WithClientVersions sets secret versions on the secret client based on the provided map. The key of the map should be the secret name, and the value should be the version.

func WithCloud

func WithCloud(c cloud.Cloud) ClientOption

WithCloud sets the Azure cloud for secret retrieval.

func WithConcurrency

func WithConcurrency(n int) ClientOption

WithConcurrency sets the concurrency for secret retrieval.

func WithHTTPClient

func WithHTTPClient(client request.Client) ClientOption

WithHTTPClient sets the HTTP client for secret retrieval.

func WithRetryPolicy

func WithRetryPolicy(r httpr.RetryPolicy) ClientOption

WithRetryPolicy sets the retry policy for secret retrieval.

func WithTimeout

func WithTimeout(d time.Duration) ClientOption

WithTimeout sets timeout for secret retrieval.

type Option

type Option func(o *Options)

Option is a function that sets options for client operations.

func WithVersions

func WithVersions(versions map[string]string) Option

WithVersions sets secret versions on the secret requests based on the provided map. The key of the map should be the secret name, and the value should be the version. Overrides the versions set on the client.

type Options

type Options struct {
	Versions map[string]string
}

Options for client operations.

type Secret

type Secret struct {
	Value string `json:"value"`
}

Secret represents a secret as returned from the Key Vault REST API.