auth

Documentation

Overview

Package auth contains utilities to perform authentication.

Index

• func GenerateNonce() (string, error)
• func GenerateWWWAuthenticate(methods []ValidateMethod, realm string, nonce string) base.HeaderValue
• func Validate(req *base.Request, user string, pass string, methods []ValidateMethod, ...) error
• type Sender
  • func NewSender(wwwAuth base.HeaderValue, user string, pass string) (*Sender, error)
  • func (se *Sender) AddAuthorization(req *base.Request)
• type ValidateMethod

Functions

func GenerateNonce

func GenerateNonce() (string, error)

GenerateNonce generates a nonce that can be used in Validate().

func GenerateWWWAuthenticate

func GenerateWWWAuthenticate(methods []ValidateMethod, realm string, nonce string) base.HeaderValue

GenerateWWWAuthenticate generates a WWW-Authenticate header.

func Validate

func Validate(
	req *base.Request,
	user string,
	pass string,
	methods []ValidateMethod,
	realm string,
	nonce string,
) error

Validate validates a request sent by a client.

Types

type Sender

type Sender struct {
	// contains filtered or unexported fields
}

Sender allows to send credentials.

func NewSender

func NewSender(wwwAuth base.HeaderValue, user string, pass string) (*Sender, error)

NewSender allocates a Sender. It requires a WWW-Authenticate header (provided by the server) and a set of credentials.

func (*Sender) AddAuthorization

func (se *Sender) AddAuthorization(req *base.Request)

AddAuthorization adds the Authorization header to a Request.

type ValidateMethod

type ValidateMethod int

ValidateMethod is a validation method.

const (
	ValidateMethodBasic ValidateMethod = iota
	ValidateMethodDigestMD5
	ValidateMethodSHA256
)

validation methods.