plain

Documentation

Overview

Package plain provides PLAIN sasl authentication as specified in RFC4616.

Index

• func Plain(authFn func(context.Context) (Auth, error)) sasl.Mechanism
• type Auth
  • func (a Auth) AsMechanism() sasl.Mechanism

Functions

func Plain

func Plain(authFn func(context.Context) (Auth, error)) sasl.Mechanism

Plain returns a sasl mechanism that will call authFn whenever sasl authentication is needed. The returned Auth is used for a single session.

Types

type Auth

type Auth struct {
	// Zid is an optional authorization ID to use in authenticating.
	Zid string

	// User is username to use for authentication.
	User string

	// Pass is the password to use for authentication.
	Pass string
	// contains filtered or unexported fields
}

Auth contains information for authentication.

func (Auth) AsMechanism

func (a Auth) AsMechanism() sasl.Mechanism

AsMechanism returns a sasl mechanism that will use 'a' as credentials for all sasl sessions.

This is a shortcut for using the Plain function and is useful when you do not need to live-rotate credentials.