Key Auth

Key auth middleware provides a key based authentication.

  • For valid key it calls the next handler.
  • For invalid key, it sends “401 - Unauthorized” response.
  • For missing key, it sends “400 - Bad Request” response.

Usage

  1. e.Use(middleware.KeyAuth(func(key string, c echo.Context) (bool, error) {
  2.   return key == "valid-key", nil
  3. }))

Custom Configuration

Usage

  1. e := echo.New()
  2. e.Use(middleware.KeyAuthWithConfig(middleware.KeyAuthConfig{
  3.   KeyLookup: "query:api-key",
  4.   Validator: func(key string, c echo.Context) (bool, error) {
  5.             return key == "valid-key", nil
  6.         },
  7. }))

Configuration

  1. KeyAuthConfig struct {
  2.   // Skipper defines a function to skip middleware.
  3.   Skipper Skipper
  5.   // KeyLookup is a string in the form of "<source>:<name>" that is used
  6.   // to extract key from the request.
  7.   // Optional. Default value "header:Authorization".
  8.   // Possible values:
  9.   // - "header:<name>"
  10.   // - "query:<name>"
  11.   // - "cookie:<name>"
  12.   // - "form:<name>"
  13.   KeyLookup string `yaml:"key_lookup"`
  15.   // AuthScheme to be used in the Authorization header.
  16.   // Optional. Default value "Bearer".
  17.   AuthScheme string
  19.   // Validator is a function to validate key.
  20.   // Required.
  21.   Validator KeyAuthValidator
  23.   // ErrorHandler defines a function which is executed for an invalid key.
  24.   // It may be used to define a custom error.
  25.   ErrorHandler KeyAuthErrorHandler
  26. }

Default Configuration

  1. DefaultKeyAuthConfig = KeyAuthConfig{
  2.   Skipper:    DefaultSkipper,
  3.   KeyLookup:  "header:" + echo.HeaderAuthorization,
  4.   AuthScheme: "Bearer",
  5. }