package
1.1.3
Repository: https://github.com/infinitbyte/framework.git
Documentation: pkg.go.dev

# Functions

AuthorizationParser return a token parser, where token extracted form Authorization header.
CookieParser return a token parser, where token extracted form HTTP Cookie.
GetNamedScopes return's all named scopes from auth.info.
JSONBodyParser return a token parser, where token extracted extracted form request body.
NewScope return's a new scope instance.
NoOpAuthenticate implements AuthenticateFunc, it return nil, time.Time{}, ErrNOOP, commonly used when token refreshed/mangaed directly using cache or Append function, and there is no need to parse token and authenticate request.
QueryParser return a token parser, where token extracted form HTTP query string.
SetHash apply token hashing based on HMAC with h and key, To prevent precomputation and length extension attacks, and to mitigates hash map DOS attacks via collisions.
SetParser sets the strategy token parser.
SetScopes sets the scopes to be used when verifying user access token.
SetType sets the authentication token type or scheme, used for HTTP WWW-Authenticate header.
WithNamedScopes add all the provided named scopes to the provided auth.info.
XHeaderParser return a token parser, where token extracted form "X-" header.

# Constants

APIKey Authentication token type or scheme.
Bearer Authentication token type or scheme.

# Variables

ErrInvalidToken indicate a hit of an invalid token format.
ErrNOOP is a soft error similar to EOF, returned by NoOpAuthenticate function to indicate there no op, and signal the caller to unauthenticate the request.
ErrTokenNotFound is returned by authenticating functions for token strategies, when token not found in their store.
ErrTokenScopes is returned by token scopes verification when, token scopes do not grant access to the requested resource.

# Interfaces

Parser parse and extract token from incoming HTTP request.
Scope provide a way to manage permissions to protected resources.

# Type aliases

AuthenticateFunc declare function signature to authenticate request using token.
Type is Authentication token type or scheme.