auth

Documentation

Overview

Package auth contains utilities to perform authentication.

Index

• func GenerateNonce() string
• func GenerateWWWAuthenticate(methods []headers.AuthMethod, realm string, nonce string) base.HeaderValue
• func Validate(req *base.Request, user string, pass string, baseURL *url.URL, ...) error
• type Sender
  • func NewSender(v base.HeaderValue, user string, pass string) (*Sender, error)
  • func (se *Sender) AddAuthorization(req *base.Request)
• type Validator
  • func NewValidator(user string, pass string, methods []headers.AuthMethod) *Validator
  • func (va *Validator) Header() base.HeaderValue
  • func (va *Validator) ValidateRequest(req *base.Request, baseURL *url.URL) error

Functions

func GenerateNonce

func GenerateNonce() string

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

func GenerateWWWAuthenticate

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

GenerateWWWAuthenticate generates a WWW-Authenticate header.

func Validate

func Validate(
	req *base.Request,
	user string,
	pass string,
	baseURL *url.URL,
	methods []headers.AuthMethod,
	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(v 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 Validator

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

Validator allows to validate credentials generated by a Sender.

Deprecated: Validator{} has been replaced by Validate()

func NewValidator

func NewValidator(user string, pass string, methods []headers.AuthMethod) *Validator

NewValidator allocates a Validator. If methods is nil, the Basic and Digest methods are used.

Deprecated: Validator{} has been replaced by Validate()

func (*Validator) Header

func (va *Validator) Header() base.HeaderValue

Header generates the WWW-Authenticate header needed by a client to authenticate.

Deprecated: Validator{} has been replaced by Validate()

func (*Validator) ValidateRequest

func (va *Validator) ValidateRequest(req *base.Request, baseURL *url.URL) error

ValidateRequest validates a request sent by a client.

Deprecated: Validator{} has been replaced by Validate()