oauth2

Documentation

Index

• func ExpiresAt(c ClaimsResolver) time.Time
• func Scope(c ClaimsResolver) []string
• type ClaimsResolver
• type ErrorResolver
• type ResponseError
  • func (e ResponseError) Error() string
  • func (e ResponseError) New() ErrorResolver

Functions

func ExpiresAt

func ExpiresAt(c ClaimsResolver) time.Time

ExpiresAt returns the result of calling the GetExpiresAt method on c, if c type contains an GetExpiresAt method returning time. Otherwise, ExpiresAt returns zero time.

func Scope

func Scope(c ClaimsResolver) []string

Scope returns the result of calling the GetScope method on c, if c type contains an GetScope method returning slice of strings. Otherwise, Scope returns empty slice.

Types

type ClaimsResolver

type ClaimsResolver interface {
	// New returns new instance pointer from the same type.
	New() ClaimsResolver
	// Verify the authorization response claims.
	Verify(claims.VerifyOptions) error
	// Resolve returns user info resolved from the authorization response claims.
	Resolve() auth.Info
}

ClaimsResolver provides context information about an authorization response.

type ErrorResolver

type ErrorResolver interface {
	error
	// New returns new instance pointer from the same type.
	New() ErrorResolver
}

ErrorResolver provides context information about an authorization error response.

type ResponseError

type ResponseError struct {
	// Reason is the error reason or code,
	// In RFC 6749 called error.
	Reason string `json:"error"`
	// URI identifying a human-readable web page with
	// information about the error.
	URI string `json:"error_uri"`
	// Description is a text providing additional information,
	// used to assist in understanding the error that occurred.
	Description string `json:"error_description"`
}

ResponseError implements ErrorResolver and provides context information about an authorization error response as defined in RFC 6749.

func (ResponseError) Error

func (e ResponseError) Error() string

func (ResponseError) New

func (e ResponseError) New() ErrorResolver

New returns new ResponseError as ErrorResolver.