ldap

README

go-ldap-client

Simple ldap client to authenticate, retrieve basic information and groups for a user.

Usage

Go Doc

See example. The only external dependency is gopkg.in/ldap.v2.

package main

import (
	"log"

	"github.com/joffcom/go-ldap-client"
)

func main() {
	client := &ldap.LDAPClient{
		Base:         "dc=example,dc=com",
		Host:         "ldap.example.com",
		Port:         389,
		UseSSL:       false,
		PageSize:     500,
		BindDN:       "uid=readonlysuer,ou=People,dc=example,dc=com",
		BindPassword: "readonlypassword",
		UserFilter:   "(uid=%s)",
		GroupFilter: "(memberUid=%s)",
		Attributes:   []string{"givenName", "sn", "mail", "uid"},
	}
	// It is the responsibility of the caller to close the connection
	defer client.Close()

	ok, user, err := client.Authenticate("username", "password")
	if err != nil {
		log.Fatalf("Error authenticating user %s: %+v", "username", err)
	}
	if !ok {
		log.Fatalf("Authenticating failed for user %s", "username")
	}
	log.Printf("User: %+v", user)
	
	groups, err := client.GetGroupsOfUser("username")
	if err != nil {
		log.Fatalf("Error getting groups for user %s: %+v", "username", err)
	}
	log.Printf("Groups: %+v", groups) 
}

SSL (ldaps)

If you use SSL, you will need to pass the server name for certificate verification or skip domain name verification e.g.client.ServerName = "ldap.example.com".

Why?

There are already tons of ldap libraries for golang but most of them are just forks of another one, most of them are too low level or too limited (e.g. do not return errors which make it hard to troubleshoot issues).

Documentation

Overview

Package ldap provides a simple ldap client to authenticate, retrieve basic information and groups for a user.

Index

• type LDAPClient
  • func (lc *LDAPClient) Authenticate(username, password string) (bool, map[string]string, error)
  • func (lc *LDAPClient) Close()
  • func (lc *LDAPClient) Connect() error
  • func (lc *LDAPClient) GetAllGroups() ([]string, error)
  • func (lc *LDAPClient) GetAllUsers(userField string) ([]string, error)
  • func (lc *LDAPClient) GetGroupsOfUser(username string) ([]string, error)

Examples

• LDAPClient.Authenticate
• LDAPClient.GetAllGroups
• LDAPClient.GetAllUsers
• LDAPClient.GetGroupsOfUser

Types

type LDAPClient

type LDAPClient struct {
	Attributes         []string
	Base               string
	BindDN             string
	BindPassword       string
	GroupFilter        string // e.g. "(memberUid=%s)"
	Host               string
	ServerName         string
	UserFilter         string // e.g. "(uid=%s)"
	PageSize           uint32
	Conn               *ldap.Conn
	Port               int
	InsecureSkipVerify bool
	UseSSL             bool
	SkipTLS            bool
	ClientCertificates []tls.Certificate // Adding client certificates
}

func (*LDAPClient) Authenticate

func (lc *LDAPClient) Authenticate(username, password string) (bool, map[string]string, error)

Authenticate authenticates the user against the ldap backend.

Example

ExampleLDAPClient_Authenticate shows how a typical application can verify a login attempt

client := setupClient()

ok, user, err := client.Authenticate("username", "password")
if err != nil {
	log.Fatalf("Error authenticating user %s: %+v", "username", err)
}
if !ok {
	log.Fatalf("Authenticating failed for user %s", "username")
}
log.Printf("User: %+v", user)

func (*LDAPClient) Close

func (lc *LDAPClient) Close()

Close closes the ldap backend connection.

func (*LDAPClient) Connect

func (lc *LDAPClient) Connect() error

Connect connects to the ldap backend.

func (*LDAPClient) GetAllGroups

func (lc *LDAPClient) GetAllGroups() ([]string, error)

GetAllGroups returns all the available groups

Example

ExampleLDAPClient_GetAllGroups shows how to retrieve all groups

client := setupClient()

groups, err := client.GetAllGroups()
if err != nil {
	log.Fatalf("Error getting groups: %+v", err)
}
log.Printf("Groups: %+v", groups)

func (*LDAPClient) GetAllUsers

func (lc *LDAPClient) GetAllUsers(userField string) ([]string, error)

GetAllUsers returns all users

Example

ExampleLDAPClient_GetAllUsers shows how to retrieve all users

client := setupClient()

users, err := client.GetAllUsers("sAMAccountName")
if err != nil {
	log.Fatalf("Error getting users: %+v", err)
}
log.Printf("Users: %+v", users)

func (*LDAPClient) GetGroupsOfUser

func (lc *LDAPClient) GetGroupsOfUser(username string) ([]string, error)

GetGroupsOfUser returns the group for a user.

Example

ExampleLDAPClient_GetGroupsOfUser shows how to retrieve user groups

client := setupClient()

groups, err := client.GetGroupsOfUser("username")
if err != nil {
	log.Fatalf("Error getting groups for user %s: %+v", "username", err)
}
log.Printf("Groups: %+v", groups)