basicauth

Documentation

Index

• Constants
• Variables
• func Default(users map[string]string) iris.HandlerFunc
• func New(c Config) iris.HandlerFunc
• type Config
  • func DefaultConfig() Config
  • func (c Config) MergeSingle(cfg Config) (config Config)
  • func (c Config) User(ctx *iris.Context) string

Constants

const (
	// DefaultBasicAuthRealm is "Authorization Required"
	DefaultBasicAuthRealm = "Authorization Required"
	// DefaultBasicAuthContextKey is the "auth"
	// this key is used to do context.Set("user", theUsernameFromBasicAuth)
	DefaultBasicAuthContextKey = "user"
)

Variables

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

DefaultExpireTime zero time

Functions

func Default

func Default(users map[string]string) iris.HandlerFunc

Default takes one parameter, the users returns a HandlerFunc use: iris.UseFunc(Default(...)), iris.Get(...,Default(...),...)

func New

func New(c Config) iris.HandlerFunc

New takes one parameter, the Config returns a HandlerFunc use: iris.UseFunc(New(...)), iris.Get(...,New(...),...)

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
	// ContextKey the key for ctx.GetString(...). Default is 'user'
	ContextKey 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) MergeSingle

func (c Config) MergeSingle(cfg Config) (config Config)

MergeSingle merges the default with the given config and returns the result

func (Config) User

func (c Config) User(ctx *iris.Context) string

User returns the user from context key same as 'ctx.GetString("user")' but cannot be used by the developer, this is only here in order to understand how you can get the authenticated username