go-dovecot-sasl

Go library implementing Dovecot authentication protocol 1.1.The library is based onemersion/go-sasl.

• Specification:https://wiki.dovecot.org/Design/AuthProtocol

Examples

Client

s, err := net.Dial("unix", "/var/lib/dovecot/sasl.sock")if err != nil {    // Handle error.}cl := dovecotsasl.NewClient(s)err := cl.Do("SMTP",     sasl.NewPlainClient("", "foxcpp", "1234"),     dovecotsasl.RemoteIP(net.IPv4(1,2,3,4)),    dovecotsasl.Secured,)if err != nil {    // Nope!}// Authenticated!

Server

l, err := net.Listen("unix", "/var/lib/maddy/sasl.sock")if err != nil {    // Handle error.}var authenticator sasl.PlainAuthenticator = func(_, user, pass string) error {    if user == "foxcpp" && pass == "1234" {        return nil    }    return errors.New("nope!")}s := NewServer()s.AddMechanism("PLAIN", dovecotsasl.Mechanism{},     func(*dovecotsasl.AuthReq) sasl.Server {        return sasl.NewPlainServer(authenticator)    })go s.Serve(l)

License

MIT.

Constants¶

const (TempFail     = "temp_fail"AuthzFail    = "authz_fail"UserDisabled = "user_disabled"PassExpired  = "pass_expired")

const (Secured         = "secured"CertUsername    = "cert_username"ValidClientCert = "valid-client-cert"NoPenalty       = "no-penalty")

Variables¶

Functions¶

func LocalIP(ipnet.IP)string

func LocalPort(iuint16)string

func RemoteIP(ipnet.IP)string

func RemotePort(iuint16)string

Types¶

type AuthFail struct {RequestIDstringCodeFailCodeReasonstring}

func (afAuthFail) Error()string

type AuthReq struct {RequestIDstringMechanismstringServicestringLocalIPnet.IPLocalPortuint16RemoteIPnet.IPRemotePortuint16SecuredboolValidClientCertboolNoPenaltyboolCertUsernameboolIR []byte}

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

func NewClient(netConnnet.Conn) (*Client,error)

func (cl *Client) Close()error

func (c *Client) ConnInfo()ConnInfo

func (c *Client) Do(servicestring, cl sasl.Client, extraParams ...string)error

type ConnInfo struct {CPID, SPIDstringCUIDstringCookiestringMechs map[string]Mechanism}

type FailCodestring

type Mechanism struct {AnonymousboolPlaintextboolDictonaryboolActiveboolForwardSecrecyboolMutualAuthboolPrivatebool}

type Server struct {Log *log.Logger// contains filtered or unexported fields}

func NewServer() *Server

func (s *Server) AddMechanism(namestring, infoMechanism, handler func(*AuthReq) sasl.Server)

func (s *Server) Close()error

func (s *Server) Serve(lnet.Listener)error