package
0.0.44
Repository: https://github.com/xenitab/go-oidc-middleware.git
Documentation: pkg.go.dev

# Functions

New takes Option setters and returns an Options pointer.
NewTokenString takes TokenStringOption setters and returns a TokenStringOptions pointer.
WithAllowedTokenDrift sets the AllowedTokenDrift parameter for an Options pointer.
WithClaimsContextKeyName sets the ClaimsContextKeyName parameter for an Options pointer.
WithDisableIssuerValidation will disable the Issuer validation.
WithDisableKeyID sets the DisableKeyID parameter for an Options pointer.
WithDiscoveryFetchTimeout sets the DiscoveryFetchTimeout parameter for an Options pointer.
WithDiscoveryUri sets the Issuer parameter for an Options pointer.
WithErrorHandler sets the ErrorHandler parameter for an Options pointer.
WithFallbackSignatureAlgorithm sets the FallbackSignatureAlgorithm parameter for an Options pointer.
WithHttpClient sets the HttpClient parameter for an Options pointer.
WithIssuer sets the Issuer parameter for Options.
WithJwksFetchTimeout sets the JwksFetchTimeout parameter for an Options pointer.
WithJwksRateLimit sets the JwksFetchTimeout parameter for an Options pointer.
WithJwksUri sets the JwksUri parameter for an Options pointer.
WithLazyLoadJwks sets the LazyLoadJwks parameter for an Options pointer.
WithRequiredAudience sets the RequiredAudience parameter for an Options pointer.
WithRequiredTokenType sets the RequiredTokenType parameter for an Options pointer.
WithTokenString sets the TokenString parameter for an Options pointer.
WithTokenStringHeaderName sets the HeaderName parameter for a TokenStringOptions pointer.
WithTokenStringListSeparator sets the ListSeparator parameter for a TokenStringOptions pointer.
WithTokenStringPostExtractionFn sets the PostExtractionFn parameter for a TokenStringOptions pointer.
WithTokenStringTokenPrefix sets the TokenPrefix parameter for a TokenStringOptions pointer.

# Constants

ConvertTokenErrorDescription is returned to ErrorHandler if the middleware is unable to convert the token to a map.
DefaultClaimsContextKeyName is of type ClaimsContextKeyName and defaults to "claims".
GetTokenErrorDescription is returned to ErrorHandler if the middleware is unable to get a token from the request.
ParseTokenErrorDescription is returned to ErrorHandler if the middleware is unable to parse the token extracted from the request.

# Structs

OidcError contains context information for the error handler.
Options defines the options for OIDC Middleware.
Response holds an abstract HTTP response that the framework adapter will render.
TokenStringOptions handles the settings for how to extract the token from a request.

# Type aliases

ClaimsContextKeyName is the type for they key value used to pass claims using request context.
ClaimsValidationFn is a generic function to validate calims.
ErrorDescription is used to pass the description of the error to ErrorHandler.
ErrorHandler is called by the middleware if not nil.
Option returns a function that modifies an Options pointer.
TokenStringOption returns a function that modifies a TokenStringOptions pointer.