mirror of https://github.com/zap-proto/fiber.git synced 2026-10-30 15:06:23 +00:00

Files

T

Benjamin GrosseandGitHub 0c4df7176a fix: don't constrain middlewares' context-keys to strings 🐛 (#2751 )

* Revert "Revert "🐛 requestid.Config.ContextKey is interface{} (#2369)" (#2742)"

This reverts commit 21ea005b07.

* fix: request ContextKey default value condition

Should check for `nil` since it is `any`.

* fix: don't constrain middlewares' context-keys to strings

`context` recommends using "unexported type" as context keys to avoid
collisions https://pkg.go.dev/github.com/gofiber/fiber/v2#Ctx.Locals.

The official go blog also recommends this https://go.dev/blog/context.

`fiber.Ctx.Locals(key any, value any)` correctly allows consumers to
use unexported types or e.g. strings.

But some fiber middlewares constrain their context-keys to `string` in
their "default config structs", making it impossible to use unexported
types.

This PR removes the `string` _constraint_ from all middlewares, allowing
to now use unexported types as per the official guidelines. However
the default value is still a string, so it's not a breaking change, and
anyone still using strings as context keys is not affected.

2023-12-12 14:55:29 +01:00

3.8 KiB

Raw Permalink Blame History

id
basicauth

BasicAuth

Basic Authentication middleware for Fiber that provides an HTTP basic authentication. It calls the next handler for valid credentials and 401 Unauthorized or a custom response for missing or invalid credentials.

Signatures

func New(config Config) fiber.Handler

Examples

Import the middleware package that is part of the Fiber web framework

import (
  "github.com/gofiber/fiber/v2"
  "github.com/gofiber/fiber/v2/middleware/basicauth"
)

After you initiate your Fiber app, you can use the following possibilities:

// Provide a minimal config
app.Use(basicauth.New(basicauth.Config{
    Users: map[string]string{
        "john":  "doe",
        "admin": "123456",
    },
}))

// Or extend your config for customization
app.Use(basicauth.New(basicauth.Config{
    Users: map[string]string{
        "john":  "doe",
        "admin": "123456",
    },
    Realm: "Forbidden",
    Authorizer: func(user, pass string) bool {
        if user == "john" && pass == "doe" {
            return true
        }
        if user == "admin" && pass == "123456" {
            return true
        }
        return false
    },
    Unauthorized: func(c *fiber.Ctx) error {
        return c.SendFile("./unauthorized.html")
    },
    ContextUsername: "_user",
    ContextPassword: "_pass",
}))

Config

Property	Type	Description	Default
Next	`func(*fiber.Ctx) bool`	Next defines a function to skip this middleware when returned true.	`nil`
Users	`map[string]string`	Users defines the allowed credentials.	`map[string]string{}`
Realm	`string`	Realm is a string to define the realm attribute of BasicAuth. The realm identifies the system to authenticate against and can be used by clients to save credentials.	`"Restricted"`
Authorizer	`func(string, string) bool`	Authorizer defines a function to check the credentials. It will be called with a username and password and is expected to return true or false to indicate approval.	`nil`
Unauthorized	`fiber.Handler`	Unauthorized defines the response body for unauthorized responses.	`nil`
ContextUsername	`interface{}`	ContextUsername is the key to store the username in Locals.	`"username"`
ContextPassword	`interface{}`	ContextPassword is the key to store the password in Locals.	`"password"`

Default Config

var ConfigDefault = Config{
    Next:            nil,
    Users:           map[string]string{},
    Realm:           "Restricted",
    Authorizer:      nil,
    Unauthorized:    nil,
    ContextUsername: "username",
    ContextPassword: "password",
}

3.8 KiB Raw Permalink Blame History