authorization

Documentation

Index

• Constants
• Variables
• type OAuthHandler
  • func NewHandler(options *Options) (*OAuthHandler, error)
  • func (h *OAuthHandler) Authorized(r *http.Request) ([]string, error)
  • func (h *OAuthHandler) IsAuthenticated(r *http.Request) string
  • func (h *OAuthHandler) RegisterAPI(root string) *mux.Router
• type Options

Constants

const (
	ScopeAll = "all"
)

Scopes

Variables

var (
	ErrNotAuthorized       = errors.New("not authorized")
	ErrInvalidClient       = errors.New("invalid client")
	ErrInvalidAuth         = errors.New("invalid auth")
	ErrMissingRedirect     = errors.New("missing redirect_uri")
	ErrInvalidResponseType = errors.New("response_type unsupported")
)

Error Values

Types

type OAuthHandler

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

OAuthHandler provides OAuth2 capabilities.

func NewHandler

func NewHandler(options *Options) (*OAuthHandler, error)

NewHandler creates and initializes a new OAuthHandler

func (*OAuthHandler) Authorized

func (h *OAuthHandler) Authorized(r *http.Request) ([]string, error)

Authorized returns the authorized scopes for a request, or an error if the request does not have sufficient authorization.

func (*OAuthHandler) IsAuthenticated

func (h *OAuthHandler) IsAuthenticated(r *http.Request) string

IsAuthenticated checks the request for a Bearer token

func (*OAuthHandler) RegisterAPI

func (h *OAuthHandler) RegisterAPI(root string) *mux.Router

RegisterAPI returns a router that handles OAuth routes.

type Options

type Options struct {
	TokenTTL time.Duration
	GrantTTL time.Duration
	CacheDir string
	Users    *user.Registry
}

Options encapsulates OAuth Handler options.