credential

Documentation

Index

• Constants
• Variables
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type Provider
  • func MustNewAPIKey(value ...string) *Provider
  • func MustNewBase64(value ...string) *Provider
  • func MustNewEnv(value ...string) *Provider
  • func MustNewFile(value ...string) *Provider
  • func MustNewHmac(value ...string) *Provider
  • func NewAPIKey(value ...string) (*Provider, error)
  • func NewBase64(value ...string) (*Provider, error)
  • func NewEnv(_ ...string) (*Provider, error)
  • func NewFile(value ...string) (*Provider, error)
  • func NewHmac(value ...string) (*Provider, error)
  • func Parse(cfg string) (*Provider, error)
  • func (p *Provider) Protocol() string
  • func (p *Provider) Value() []string

Constants

const (
	// ProtocolHmac will hold access key and secret key credential.
	//
	// HMAC means hash-based message authentication code, it may be inaccurate to represent credential
	// protocol ak/sk(access key + secret key with hmac), but it's simple and no confuse with other
	// protocol, so just keep this.
	//
	// value = [Access Key, Secret Key]
	ProtocolHmac = "hmac"
	// ProtocolAPIKey will hold api key credential.
	//
	// value = [API Key]
	ProtocolAPIKey = "apikey"
	// ProtocolFile will hold file credential.
	//
	// value = [File Path], service decide how to use this file
	ProtocolFile = "file"
	// ProtocolEnv will represent credential from env.
	//
	// value = [], service retrieves credential value from env.
	ProtocolEnv = "env"
	// ProtocolBase64 will represents credential binary data in base64
	//
	// Storage service like gcs will take token files as input, we provide base64 protocol so that user
	// can pass token binary data directly.
	ProtocolBase64 = "base64"
)

Variables

var (
	// ErrUnsupportedProtocol means protocol is unsupported
	ErrUnsupportedProtocol = errors.New("unsupported protocol")
	// ErrInvalidValue means value is invalid.
	ErrInvalidValue = errors.New("invalid value")
)

Types

type Error

type Error struct {
	Op  string
	Err error

	Protocol string
	Values   []string
}

Error represents error related to credential.

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap implements xerrors.Wrapper

type Provider

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

Provider will provide credential protocol and values.

func MustNewAPIKey

func MustNewAPIKey(value ...string) *Provider

MustNewAPIKey make sure Provider must be created if no panic happened.

func MustNewBase64

func MustNewBase64(value ...string) *Provider

MustNewBase64 make sure Provider must be created if no panic happened.

func MustNewEnv

func MustNewEnv(value ...string) *Provider

MustNewEnv make sure Provider must be created if no panic happened.

func MustNewFile

func MustNewFile(value ...string) *Provider

MustNewFile make sure Provider must be created if no panic happened.

func MustNewHmac

func MustNewHmac(value ...string) *Provider

MustNewHmac make sure Provider must be created if no panic happened.

func NewAPIKey

func NewAPIKey(value ...string) (*Provider, error)

NewAPIKey create a api key provider.

func NewBase64

func NewBase64(value ...string) (*Provider, error)

NewBase64 create a base64 provider.

func NewEnv

func NewEnv(_ ...string) (*Provider, error)

NewEnv create a env provider.

func NewFile

func NewFile(value ...string) (*Provider, error)

NewFile create a file provider.

func NewHmac

func NewHmac(value ...string) (*Provider, error)

NewHmac create a hmac provider.

func Parse

func Parse(cfg string) (*Provider, error)

Parse will parse config string to create a credential Provider.

func (*Provider) Protocol

func (p *Provider) Protocol() string

Protocol provides current credential's protocol.

func (*Provider) Value

func (p *Provider) Value() []string

Value provides current credential's value in string array.