Documentation
¶
Overview ¶
Special thanks to Echo: https://github.com/labstack/echo/blob/master/middleware/key_auth.go
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ConfigDefault = Config{ SuccessHandler: func(c *fiber.Ctx) error { return c.Next() }, ErrorHandler: func(c *fiber.Ctx, err error) error { if errors.Is(err, ErrMissingOrMalformedAPIKey) { return c.Status(fiber.StatusUnauthorized).SendString(err.Error()) } return c.Status(fiber.StatusUnauthorized).SendString("Invalid or expired API Key") }, KeyLookup: "header:" + fiber.HeaderAuthorization, AuthScheme: "Bearer", ContextKey: "token", }
ConfigDefault is the default config
View Source
var ErrMissingOrMalformedAPIKey = errors.New("missing or malformed API Key")
When there is no request of the key thrown ErrMissingOrMalformedAPIKey
Functions ¶
Types ¶
type Config ¶
type Config struct {
// Next defines a function to skip middleware.
// Optional. Default: nil
Next func(*fiber.Ctx) bool
// SuccessHandler defines a function which is executed for a valid key.
// Optional. Default: nil
SuccessHandler fiber.Handler
// ErrorHandler defines a function which is executed for an invalid key.
// It may be used to define a custom error.
// Optional. Default: 401 Invalid or expired key
ErrorHandler fiber.ErrorHandler
// KeyLookup is a string in the form of "<source>:<name>" that is used
// to extract key from the request.
// Optional. Default value "header:Authorization".
// Possible values:
// - "header:<name>"
// - "query:<name>"
// - "form:<name>"
// - "param:<name>"
// - "cookie:<name>"
KeyLookup string
// AuthScheme to be used in the Authorization header.
// Optional. Default value "Bearer".
AuthScheme string
// Validator is a function to validate key.
Validator func(*fiber.Ctx, string) (bool, error)
// Context key to store the bearertoken from the token into context.
// Optional. Default: "token".
ContextKey string
}
Config defines the config for middleware.
Source Files
Click to show internal directories.
Click to hide internal directories.