apikey

Documentation

Overview

Package apikey is a concrete implementation of the auth abstractions.

Index

• type Authenticator
  • func New(val Validator) (*Authenticator, error)
  • func (a *Authenticator) Authenticate(req *http.Request) (bool, error)
• type Validator

Types

type Authenticator

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

Authenticator authenticates the request based on the header on the following header key and value: Authorization: Apikey {api key}, where {api key} is the key.

func New

func New(val Validator) (*Authenticator, error)

New constructor.

func (*Authenticator) Authenticate

func (a *Authenticator) Authenticate(req *http.Request) (bool, error)

Authenticate parses the header for the specified key and authenticates it.

type Validator

type Validator interface {
	Validate(key string) (bool, error)
}

Validator interface for validating keys.