sasl

README

go-sasl

go-sasl is a pure golang client-side SASL implementation as defined by RFC 4422.

It supports the following mechanisms: PLAIN, EXTERNAL. Support for other mechanisms may be added in the future.

Contributing

Open an issue or PR if you want to add more SASL mechanisms.

License

MIT License (c) 2018 Mukesh Sharma

Documentation

Index

• Constants
• type Client
  • func NewClient(mech string, options Options) (Client, error)
  • func NewDigestMD5Client() (Client, error)
  • func NewExternalClient(authorizationID []byte) (Client, error)
  • func NewPlainClient(authenticationID []byte, authorizationID []byte, password []byte) (Client, error)
• type Options

Constants

const (
	// PLAIN represents plain mechanism
	PLAIN = "plain"
	// EXTERNAL represents external mechanism
	EXTERNAL = "external"
	// DIGEST_MD5 represents digest-md5 mechanism
	DIGEST_MD5 = "digest-md5"
)

Types

type Client

type Client interface {
	EvaluateChallenge([]byte) ([]byte, error)
	Wrap([]byte) ([]byte, error)
	Unwrap([]byte) ([]byte, error)
	IsComplete() bool
	Mechanism() string
	HasInitialResponse() bool
}

Client is SASL client interface

func NewClient

func NewClient(mech string, options Options) (Client, error)

NewClient creates new SASL client

func NewDigestMD5Client

func NewDigestMD5Client() (Client, error)

NewDigestMD5Client creates a SASL DigestMd5 mechanism with optional authorization ID

func NewExternalClient

func NewExternalClient(authorizationID []byte) (Client, error)

NewExternalClient creates a SASL External mechanism with optional authorization ID

func NewPlainClient

func NewPlainClient(authenticationID []byte, authorizationID []byte, password []byte) (Client, error)

NewPlainClient creates a SASL mechanism with client credentials that it needs to participate in Plain authentication exchange with the server.

type Options

type Options struct {
	AuthorizationID  []byte
	AuthenticationID []byte
	Password         []byte
}

Options represent SASL client options. Different mechanims have different required fields