auth

Documentation

Overview

Package auth contains utilities to perform authentication.

Index

• func GenerateNonce() (string, error)
• func GenerateWWWAuthenticate(methods []VerifyMethod, realm string, nonce string) base.HeaderValue
• func Verify(req *base.Request, user string, pass string, methods []VerifyMethod, ...) error
• type Sender
  • func (se *Sender) AddAuthorization(req *base.Request)
  • func (se *Sender) Initialize() error
• type VerifyMethod

Functions

func GenerateNonce

func GenerateNonce() (string, error)

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

func GenerateWWWAuthenticate

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

GenerateWWWAuthenticate generates a WWW-Authenticate header.

func Verify

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

Verify verifies a request sent by a client.

Types

type Sender

type Sender struct {
	WWWAuth base.HeaderValue
	User    string
	Pass    string
	// contains filtered or unexported fields
}

Sender allows to send credentials. 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.

func (*Sender) Initialize

func (se *Sender) Initialize() error

Initialize initializes a Sender.

type VerifyMethod

type VerifyMethod int

VerifyMethod is a validation method.

const (
	VerifyMethodBasic VerifyMethod = iota
	VerifyMethodDigestMD5
	VerifyMethodDigestSHA256
)

validation methods.