package
0.33.0
Repository: https://github.com/target/goalert.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
Package basic implements a simple auth provider and backend that identifies a user via username & password combination.
Package github implements an auth provider and backend that identifies a user via github account.
No description provided by the author
No description provided by the author

# Functions

ClearCookie will clear and expire the cookie with the given name, for all API prefixes.
Delay will block for a random delay (or until the context is Done).
GetToken will return the auth token associated with a request.
NewHandler creates a new Handler using the provided config.
SetCookie will set a cookie value for all API prefixes, respecting the current config parameters.
SetCookieAge behaves like SetCookie but also sets the MaxAge.

# Constants

CookieName is the name of the auth session cookie.

# Structs

Field represents a single form field for authentication.
Handler will serve authentication requests for registered identity providers.
HandlerConfig provides configuration for the auth handler.
Identity represents a user's proven identity.
ProviderInfo holds the details for using a provider.
RouteInfo represents path information for the current request.
UserSession represents an active user session.

# Interfaces

An IdentityProvider provides an option for a user to login (identify themselves).
A Redirector provides a target URL for redirecting a user.

# Type aliases

An Error can be returned to indicate an error message that should be displayed to the user attempting to authenticate.
RedirectURL is a convenience type that can be returned as an error resulting in redirection.