basicauth

package module
Version: v1.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 31, 2020 License: MIT Imports: 5 Imported by: 0

README

GoDoc Build Status Go Report Card

Basic HTTP Authentication Middleware for Buffalo

Installation

$ go get -u github.com/gobuffalo/mw-basicauth

Usage

auth := func(c buffalo.Context, u, p string) (bool, error) {
    return (u == "username" && p == "password"), nil
}
app.Use(basicauth.Middleware(auth))

Hitting protected endpoints

  1. Base64 Encode username:password, which becomes dXNlcm5hbWU6cGFzc3dvcmQK in the aforementioned example

  2. Then pass the following HTTP header along with all requests to protected endpoints: Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQK

Documentation

Index

Constants

View Source
const Version = "v1.0.7"

Variables

View Source
var (
	// ErrNoCreds is returned when no basic auth credentials are defined
	ErrNoCreds = errors.New("no basic auth credentials defined")

	// ErrAuthFail is returned when the client fails basic authentication
	ErrAuthFail = errors.New("invalid basic auth username or password")
)

Functions

func Middleware

func Middleware(auth Authorizer) buffalo.MiddlewareFunc

Middleware enables basic authentication

Types

type Authorizer

type Authorizer func(buffalo.Context, string, string) (bool, error)

Authorizer is used to authenticate the basic auth username/password. Should return true/false and/or an error.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL