apikey

Documentation

Index

• Constants
• type Credential
  • func NewCredential(keyID string, secret string, opts ...Option) (Credential, error)
  • func (c Credential) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
  • func (c Credential) RequireTransportSecurity() bool
• type Option
  • func WithHMAC(enable bool) Option
  • func WithInsecureTransport(insecure bool) Option

Constants

const (
	IDHeader     = "tmprl-api-key-id"
	SecretHeader = "tmprl-api-secret-key"

	RequestSignatureHeader           = "tmprl-request-signature"
	RequestSignatureAlgorithmHeader  = "tmprl-request-signature-algorithm"
	RequestDatetimeHeader            = "tmprl-request-datetime"
	DefaultRequestSignatureAlgorithm = "tmprl-hmac-sha256"
)

Types

type Credential

type Credential struct {
	ID string
	// contains filtered or unexported fields
}

func NewCredential

func NewCredential(keyID string, secret string, opts ...Option) (Credential, error)

func (Credential) GetRequestMetadata

func (c Credential) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)

func (Credential) RequireTransportSecurity

func (c Credential) RequireTransportSecurity() bool

type Option

type Option = func(c *Credential)

func WithHMAC

func WithHMAC(enable bool) Option

func WithInsecureTransport

func WithInsecureTransport(insecure bool) Option