basicauth

package
v10.6.5+incompatible Latest Latest
Warning

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

Go to latest
Published: May 21, 2018 License: BSD-3-Clause Imports: 5 Imported by: 281

Documentation

Overview

Package basicauth provides http basic authentication via middleware. See _examples/authentication/basicauth

Index

Constants

View Source
const (
	// DefaultBasicAuthRealm is "Authorization Required"
	DefaultBasicAuthRealm = "Authorization Required"
)

Variables

View Source
var DefaultExpireTime time.Time // 0001-01-01 00:00:00 +0000 UTC

DefaultExpireTime zero time

Functions

func Default

func Default(users map[string]string) context.Handler

Default accepts only the users and returns a new Handler which will ask the client for basic auth (username, password), validate that and if valid continues to the next handler, otherwise throws a StatusUnauthorized http error code.

func New

func New(c Config) context.Handler

New accepts basicauth.Config and returns a new Handler which will ask the client for basic auth (username, password), validate that and if valid continues to the next handler, otherwise throws a StatusUnauthorized http error code.

Types

type Config

type Config struct {
	// Users a map of login and the value (username/password)
	Users map[string]string
	// Realm http://tools.ietf.org/html/rfc2617#section-1.2. Default is "Authorization Required"
	Realm string
	// Expires expiration duration, default is 0 never expires
	Expires time.Duration
}

Config the configs for the basicauth middleware

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configs for the BasicAuth middleware

func (Config) User

func (c Config) User(ctx context.Context) (string, string, bool)

User returns the user from context key same as ctx.Request().BasicAuth().

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL