auth

Documentation

Overview

Package auth provides authentication implementation(s) that can be used to limit access to the (gRPC) server. Specific implementations are in each sub package.

Index

• Constants
• Variables
• type CtxKey

Constants

const (
	MetaKeyAuthorization = "authorization"
)

Meta* are the keys to metadata.

See https://godoc.org/google.golang.org/grpc/metadata#New

Variables

var (
	// Server Side
	ErrMissingMetadata        = status.Error(codes.InvalidArgument, "missing metadata")
	ErrMissingAuthorization   = status.Error(codes.InvalidArgument, "missing authorization")
	ErrCorruptedAuthorization = status.Error(codes.InvalidArgument, "unexpected number of authentication values")
	ErrFailedToAuthenticate   = status.Error(codes.Unauthenticated, "unable to authenticate user")
	ErrCannotAuthorize        = status.Error(codes.FailedPrecondition, "cannot authorize message")
)

Err* are sentinel errors

Types

type CtxKey

type CtxKey string

CtxKey is a type just to prevent collisions

const (
	CtxKeyRoles CtxKey = "roles"
)

CtxKey* are context keys specific to this auth package.