ldapauthserver

Documentation

Index

• func Init()
• type AuthServerLdap
  • func (asl *AuthServerLdap) AuthMethod(user string) (string, error)
  • func (asl *AuthServerLdap) Negotiate(c *mysqlconn.Conn, user string) (mysqlconn.Getter, error)
  • func (asl *AuthServerLdap) Salt() ([]byte, error)
  • func (asl *AuthServerLdap) ValidateHash(salt []byte, user string, authResponse []byte) (mysqlconn.Getter, error)
• type Client
• type ClientImpl
  • func (lci *ClientImpl) Connect(network string, config *ServerConfig) error
• type LdapUserData
  • func (lud *LdapUserData) Get() *querypb.VTGateCallerID
• type ServerConfig

Functions

func Init

func Init()

Init is public so it can be called from plugin_auth_ldap.go (go/cmd/vtgate)

Types

type AuthServerLdap

type AuthServerLdap struct {
	Client
	ServerConfig
	Method         string
	User           string
	Password       string
	GroupQuery     string
	UserDnPattern  string
	RefreshSeconds time.Duration
}

AuthServerLdap implements AuthServer with an LDAP backend

func (*AuthServerLdap) AuthMethod

func (asl *AuthServerLdap) AuthMethod(user string) (string, error)

AuthMethod is part of the AuthServer interface.

func (*AuthServerLdap) Negotiate

func (asl *AuthServerLdap) Negotiate(c *mysqlconn.Conn, user string) (mysqlconn.Getter, error)

Negotiate is part of the AuthServer interface.

func (*AuthServerLdap) Salt

func (asl *AuthServerLdap) Salt() ([]byte, error)

Salt will be unused in AuthServerLdap.

func (*AuthServerLdap) ValidateHash

func (asl *AuthServerLdap) ValidateHash(salt []byte, user string, authResponse []byte) (mysqlconn.Getter, error)

ValidateHash is unimplemented for AuthServerLdap.

type Client

type Client interface {
	Connect(network string, config *ServerConfig) error
	Close()
	Bind(string, string) error
	Search(*ldap.SearchRequest) (*ldap.SearchResult, error)
}

Client provides an interface we can mock

type ClientImpl

type ClientImpl struct {
	*ldap.Conn
}

ClientImpl is the real implementation of LdapClient

func (*ClientImpl) Connect

func (lci *ClientImpl) Connect(network string, config *ServerConfig) error

Connect calls ldap.Dial and then upgrades the connection to TLS This must be called before any other methods

type LdapUserData

type LdapUserData struct {
	sync.Mutex
	// contains filtered or unexported fields
}

LdapUserData holds username and LDAP groups as well as enough data to intelligently update itself.

func (*LdapUserData) Get

func (lud *LdapUserData) Get() *querypb.VTGateCallerID

Get returns wrapped username and LDAP groups and possibly updates the cache

type ServerConfig

type ServerConfig struct {
	LdapServer string
	LdapCert   string
	LdapKey    string
	LdapCA     string
}

ServerConfig holds the config for and LDAP server * include port in ldapServer, "ldap.example.com:386"