mech

Documentation

Index

• Variables
• type AuthzID
• type Challenge
• type Context
• type Email
• type Group
• type HashFunc
• type IterationCount
• type Mechanism
• type Option
• type Parameter
• type Password
• type Payload
• type RandomSequence
• type Response
• type Salt
• type Store
  • func NewStore() Store
• type Token
• type Type
  • func Types() []Type
  • func (t Type) String() string
• type Username

Variables

var ErrNotFound = errors.New("not found")

ErrNotFound represents a not found error.

Types

type AuthzID

type AuthzID string

AuthzID represents an authorization ID option.

type Challenge

type Challenge []byte

Challenge represents a challenge.

type Context

type Context interface {
	// Store represents a SASL mechanism store.
	Store
	// Mechanism returns the mechanism.
	Mechanism() Mechanism
	// Next returns the next response.
	Next(...Parameter) (Response, error)
	// Step returns the current step number. The step number is incremented by one after each call to Next.
	Step() int
	// Done returns true if the context is completed.
	Done() bool
	// Dispose disposes the context.
	Dispose() error
}

Context represents a SASL mechanism context.

type Email

type Email string

Email represents an email.

type Group

type Group string

Group represents a group option.

type HashFunc

type HashFunc func() hash.Hash

HashFunc represents a hash function.

type IterationCount

type IterationCount int

IterationCount represents an iteration count.

type Mechanism

type Mechanism interface {
	// Name returns the mechanism name.
	Name() string
	// Type returns the mechanism type.
	Type() Type
	// SetOptions sets the mechanism options before starting.
	SetOptions(...Option) error
	// Start returns the initial context.
	Start(...Option) (Context, error)
}

Mechanism represents a SASL mechanism.

type Option

type Option = any

Option represents a SASL mechanism option.

type Parameter

type Parameter = any

Parameter represents a SASL mechanism parameter.

type Password

type Password string

Password represents a password option.

type Payload

type Payload []byte

Payload represents a payload.

type RandomSequence

type RandomSequence string

RandomSequence represents a random sequence.

type Response

type Response interface {
	// Bytes returns the response bytes.
	Bytes() []byte
	// String returns the response as a string.
	String() string
}

Response represents a SASL mechanism response.

type Salt

type Salt []byte

Salt represents a salt.

type Store

type Store interface {
	// SetValue sets the context value.
	SetValue(key string, value any)
	// Value returns the context value.
	Value(key string) (any, bool)
	// ValueTo returns the context value as a specific type.
	ValueTo(key string, v any) bool
}

Store represents a SASL mechanism store.

func NewStore

func NewStore() Store

NewContext returns a new Context.

type Token

type Token string

Token represents a token.

type Type

type Type int

Type represents a SASL mechanism type.

const (
	Client Type = iota
	Server
)

func Types

func Types() []Type

Types returns the SASL mechanism types.

func (Type) String

func (t Type) String() string

String returns the SASL mechanism type.

type Username

type Username string

Username represents a username option.