echo/website/content/middleware/key-auth.md

+++ title = "Key Auth Middleware" description = "Key auth middleware for Echo" [menu.main] name = "Key Auth" parent = "middleware" weight = 5 +++

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

e.Use(middleware.KeyAuth(func(key string) bool {
  return key == "valid-key"
}))

Custom Configuration

Usage

e := echo.New()
e.Use(middleware.KeyAuthWithConfig(middleware.KeyAuthConfig{
  KeyLookup: "query:api-key",
}))

Configuration

// KeyAuthConfig defines the config for KeyAuth middleware.
KeyAuthConfig struct {
  // Skipper defines a function to skip middleware.
  Skipper Skipper

  // 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>"
  KeyLookup string `json:"key_lookup"`

  // AuthScheme to be used in the Authorization header.
  // Optional. Default value "Bearer".
  AuthScheme string

  // Validator is a function to validate key.
  // Required.
  Validator KeyAuthValidator
}

Default Configuration

DefaultKeyAuthConfig = KeyAuthConfig{
  Skipper:    defaultSkipper,
  KeyLookup:  "header:" + echo.HeaderAuthorization,
  AuthScheme: "Bearer",
}