basicauth

README

mw-basicauth

Basic HTTP Authentication Middleware for Buffalo

Installation

$ go get 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

• Variables
• func Middleware(auth Authorizer) buffalo.MiddlewareFunc
• type Authorizer

Variables

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")

	// ErrUnauthorized is returned in any case the basic authentication fails
	ErrUnauthorized = errors.New("Unauthorized")
)

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.