1
0
mirror of https://github.com/labstack/echo.git synced 2025-01-26 03:20:08 +02:00
echo/website/content/middleware/basic-auth.md

60 lines
1.1 KiB
Markdown
Raw Normal View History

+++
title = "BasicAuth Middleware"
description = "Basic auth middleware for Echo"
[menu.side]
name = "BasicAuth"
parent = "middleware"
weight = 5
+++
## BasicAuth Middleware
BasicAuth middleware provides an HTTP basic authentication.
- For valid credentials it calls the next handler.
- For invalid credentials, it sends "401 - Unauthorized" response.
- For empty or invalid `Authorization` header, it sends "400 - Bad Request" response.
*Usage*
```go
e := echo.New()
e.Use(middleware.BasicAuth(func(username, password string) bool {
if username == "joe" && password == "secret" {
return true
}
return false
}))
```
### Custom Configuration
*Usage*
```go
e := echo.New()
e.Use(middleware.BasicAuthWithConfig(middleware.BasicAuthConfig{},
}))
```
### Configuration
```go
BasicAuthConfig struct {
// Skipper defines a function to skip middleware.
Skipper Skipper
// Validator is a function to validate BasicAuth credentials.
// Required.
Validator BasicAuthValidator
}
```
*Default Configuration*
```go
DefaultBasicAuthConfig = BasicAuthConfig{
Skipper: defaultSkipper,
}
```