auth

Documentation

Overview

Package auth provides an IP and user credentials based authentication handler.

Index

• type Authentication
  • func New(ips map[string]bool, user string, hash []byte, pass []byte) Authentication
  • func (a Authentication) Handler(remoteAddr net.Addr, mechanism string, username []byte, password []byte, ...) (bool, error)

Types

type Authentication

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

Authentication implements the AuthHandler interface.

func New

func New(
	ips map[string]bool,
	user string,
	hash []byte,
	pass []byte,
) Authentication

New creates a new Authentication config. ips are required for IP access restriction. user is required for LOGIN, PLAIN and CRAM-MD5 authentication. hash (recommended) or pass is required for LOGIN and PLAIN authentication. pass is required for CRAM-MD5 authentication (requires plain text password).

func (Authentication) Handler

func (a Authentication) Handler(
	remoteAddr net.Addr,
	mechanism string,
	username []byte,
	password []byte,
	shared []byte,
) (bool, error)

Handler validates remote IPs and user credentials.