basicauth

Documentation

Overview

Package basicauth implements HTTP Basic Authentication.

Index

• func New(c middleware.Controller) (middleware.Middleware, error)
• type BasicAuth
  • func (a BasicAuth) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type Rule

Functions

func New

func New(c middleware.Controller) (middleware.Middleware, error)

New constructs a new BasicAuth middleware instance.

Types

type BasicAuth

type BasicAuth struct {
	Next  middleware.Handler
	Rules []Rule
}

BasicAuth is middleware to protect resources with a username and password. Note that HTTP Basic Authentication is not secure by itself and should not be used to protect important assets without HTTPS. Even then, the security of HTTP Basic Auth is disputed. Use discretion when deciding what to protect with BasicAuth.

func (BasicAuth) ServeHTTP

func (a BasicAuth) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

ServeHTTP implements the middleware.Handler interface.

type Rule

type Rule struct {
	Username  string
	Password  string
	Resources []string
}

Rule represents a BasicAuth rule. A username and password combination protect the associated resources, which are file or directory paths.