Basic Auth

Basic Auth middleware provides HTTP basic authentication.

For valid credentials it calls the next handler.
For missing or invalid credentials, it sends a 401 Unauthorized response.

All core middleware lives in the middleware package:

import "github.com/labstack/echo/v5/middleware"

Usage

e.Use(middleware.BasicAuth(func(c *echo.Context, username, password string) (bool, error) {
  // Use a constant time comparison to prevent timing attacks.
  if subtle.ConstantTimeCompare([]byte(username), []byte("joe")) == 1 &&
    subtle.ConstantTimeCompare([]byte(password), []byte("secret")) == 1 {
    return true, nil
  }
  return false, nil
}))

Custom configuration

e.Use(middleware.BasicAuthWithConfig(middleware.BasicAuthConfig{}))

Configuration

BasicAuthConfig · github.com/labstack/echo/v5@5196b9b

Fields from package source
Field	Type	Description	Source
`Skipper`	`Skipper`	Skipper defines a function to skip middleware.	L23
`Validator`	`BasicAuthValidator`	Validator is a function to validate BasicAuthWithConfig credentials. Note: if request contains multiple basic auth headers this function would be called once for each header until first valid result is returned Required.	L28
`Realm`	`string`	Realm is a string to define realm attribute of BasicAuthWithConfig. Default value "Restricted".	L32
`AllowedCheckLimit`	`uint`	AllowedCheckLimit set how many headers are allowed to be checked. This is useful environments like corporate test environments with application proxies restricting access to environment with their own auth scheme. Defaults to 1.	L38

Functions from package source
Type	Source
`func BasicAuth(fn BasicAuthValidator) echo.MiddlewareFunc`	L87
`func BasicAuthWithConfig(config BasicAuthConfig) echo.MiddlewareFunc`	L92

The Validator has the signature:

type BasicAuthValidator func(c *echo.Context, user string, password string) (bool, error)

Default configuration

// Effective defaults applied when fields are left unset.
BasicAuthConfig{
  Skipper: DefaultSkipper,
  Realm:   "Restricted",
}