auth

Documentation

Index

• Variables
• type Context
• type Manager
  • func NewManager(options Options) (Manager, error)
• type Options

Variables

var ErrBadAuth = key.ErrBadAuth

ErrBadAuth is an error because of incorrect auth

var ErrInternalError = errors.New("internal error")

ErrInternalError is an error because of internal error

var ErrMissingProductListClaim = errors.New("api_product_list claim is required")

ErrMissingProductListClaim is an error when missing api_product_list claim

var ErrNoAuth = errors.New("missing authentication")

ErrNoAuth is an error because of missing auth

Types

type Context

type Context struct {
	context.Context
	ClientID         string
	AccessToken      string
	Application      string
	APIProducts      []string
	Expires          time.Time
	DeveloperEmail   string
	Scopes           []string
	APIKey           string
	CustomAttributes string
	AnalyticsProduct string // A single product to attatch to analytics records based on matched operations.
}

A Context wraps all the various information that is needed to make requests through the Apigee adapter.

type Manager

type Manager interface {
	Close()
	Authenticate(ctx context.Context, apiKey string, claims map[string]interface{}, apiKeyClaimKey string) (*Context, error)
}

A Manager wraps all things related to auth processing

func NewManager

func NewManager(options Options) (Manager, error)

NewManager constructs a new Manager for JWT functions. Call Close() when done.

type Options

type Options struct {
	// Client is a configured HTTPClient
	Client *http.Client
	// APIKeyCacheDuration is the length of time APIKeys are cached when unable to refresh
	APIKeyCacheDuration time.Duration
	// Org is organization
	Org string
	// JWKSProviders
	JWTProviders []jwt.Provider
}

Options allows us to specify options for how this auth manager will run