apikey

Documentation

Overview

Package apikey provides authentication profile support for APIs that require a pre-generated constant authenticationn key passed via a header, query parameter, or cookie value in each request.

Example

// Initialize the CLI.
cli.Init(&cli.Config{
	AppName:   "example",
	EnvPrefix: "EXAMPLE",
})

// Initialize the API key authentication.
Init("X-API-Key", LocationHeader)

// Mock out a profile to be used in the request.
cli.Creds.Set("profiles.default.api_key", "my-secret")

// Make a request.
req := cli.Client.Get().URL("http://example.com/")
if _, err := req.Do(); err != nil {
	panic(err)
}

// Look at the header that was used in the request. It should match the
// profile's API key value.
fmt.Println(req.Context.Request.Header.Get("X-API-Key"))

Output:

my-secret

Index

• func Init(name string, in Location, extra ...string)
• type Handler
  • func (h *Handler) OnRequest(log *zerolog.Logger, request *http.Request) error
  • func (h *Handler) ProfileKeys() []string
• type Location

Examples

• Package
• Init (Header)
• Init (Query)

Functions

func Init

func Init(name string, in Location, extra ...string)

Init sets up the API key client authentication. Must be called *after* you have called `cli.Init()`. Passing `extra` values will set additional custom keys to store for each profile.

Example (Header)

// Use a custom header for authentication.
Init("X-API-Key", LocationHeader)

Example (Query)

// Use a query parameter for authentication.
Init("apikey", LocationHeader)

Types

type Handler

type Handler struct {
	Name string
	In   Location
	Keys []string
}

Handler sets up the API key authentication flow.

func (*Handler) OnRequest

func (h *Handler) OnRequest(log *zerolog.Logger, request *http.Request) error

OnRequest gets run before the request goes out on the wire.

func (*Handler) ProfileKeys

func (h *Handler) ProfileKeys() []string

ProfileKeys returns the key names for fields to store in the profile.

type Location

type Location int

Location defines how a parameter is sent.

const (
	LocationHeader Location = iota
	LocationQuery
	LocationCookie
)

API key parameter locations, which correspond to the OpenAPI `in` parameter values for the `apikey` security type.