documize/domain/auth/ldap/ad_test.go

// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
//
// This software (Documize Community Edition) is licensed under
// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
//
// You can operate outside the AGPL restrictions by purchasing
// Documize Enterprise Edition and obtaining a commercial license
// by contacting <sales@documize.com>.
//
// https://documize.com

package ldap

import (
	"crypto/tls"
	"fmt"
	"strings"
	"testing"

	lm "github.com/documize/community/model/auth"
	ld "gopkg.in/ldap.v2"
)

// Works against AD server in Azure confgiured using:
//
// https://auth0.com/docs/connector/test-dc
//
// Ensure VM network settings open up ports 389 and 636.

func TestADServer_UserList(t *testing.T) {
	c := lm.LDAPConfig{}
	c.ServerHost = "40.117.188.17"
	c.ServerPort = 389
	c.EncryptionType = "none"
	c.BaseDN = "DC=mycompany,DC=local"
	c.BindDN = "CN=ad-admin,CN=Users,DC=mycompany,DC=local"
	c.BindPassword = "8B5tNRLvbk8K"
	c.UserFilter = ""
	c.GroupFilter = ""

	address := fmt.Sprintf("%s:%d", c.ServerHost, c.ServerPort)

	t.Log("Connecting to AD server", address)

	l, err := ld.Dial("tcp", address)
	if err != nil {
		t.Error("Error: unable to dial AD server: ", err.Error())
		return
	}
	defer l.Close()

	if c.EncryptionType == "starttls" {
		t.Log("Using StartTLS with AD server")
		err = l.StartTLS(&tls.Config{InsecureSkipVerify: true})
		if err != nil {
			t.Error("Error: unable to startTLS with AD server: ", err.Error())
			return
		}
	}

	// Authenticate with AD server using admin credentials.
	t.Log("Binding AD admin user")
	err = l.Bind(c.BindDN, c.BindPassword)
	if err != nil {
		t.Error("Error: unable to bind specified admin user to AD: ", err.Error())
		return
	}

	// Get users from AD server by using filter
	filter := ""
	attrs := []string{}
	if len(c.GroupFilter) > 0 {
		filter = fmt.Sprintf("(&(objectClass=group)(cn=%s))", c.GroupFilter)
		attrs = []string{"cn"}
	} else {
		filter = "(|(objectCategory=person)(objectClass=user)(objectClass=inetOrgPerson))"
		attrs = []string{"dn", "cn", "givenName", "sn", "mail", "sAMAccountName"}
	}

	searchRequest := ld.NewSearchRequest(
		c.BaseDN,
		ld.ScopeWholeSubtree, ld.NeverDerefAliases, 0, 0, false,
		filter,
		attrs,
		nil,
	)

	sr, err := l.Search(searchRequest)
	if err != nil {
		t.Error("Error: unable to execute directory search: ", err.Error())
		return
	}

	t.Logf("AD search entries found: %d", len(sr.Entries))
	if len(sr.Entries) == 0 {
		t.Error("Received ZERO AD search entries")
		return
	}

	for _, entry := range sr.Entries {
		t.Logf("[%s] %s (%s %s) @ %s\n",
			entry.GetAttributeValue("sAMAccountName"),
			entry.GetAttributeValue("cn"),
			entry.GetAttributeValue("givenName"),
			entry.GetAttributeValue("sn"),
			entry.GetAttributeValue("mail"))
	}
}

func TestADServer_Groups(t *testing.T) {
	c := lm.LDAPConfig{}
	c.ServerHost = "40.117.188.17"
	c.ServerPort = 389
	c.EncryptionType = "none"
	c.BaseDN = "DC=mycompany,DC=local"
	c.BindDN = "CN=ad-admin,CN=Users,DC=mycompany,DC=local"
	c.BindPassword = "8B5tNRLvbk8K"
	c.UserFilter = ""
	c.GroupFilter = "(|(cn=Accounting)(cn=IT))"

	address := fmt.Sprintf("%s:%d", c.ServerHost, c.ServerPort)
	t.Log("Connecting to AD server", address)
	l, err := ld.Dial("tcp", address)
	if err != nil {
		t.Error("Error: unable to dial AD server: ", err.Error())
		return
	}
	defer l.Close()

	if c.EncryptionType == "starttls" {
		t.Log("Using StartTLS with AD server")
		err = l.StartTLS(&tls.Config{InsecureSkipVerify: true})
		if err != nil {
			t.Error("Error: unable to startTLS with AD server: ", err.Error())
			return
		}
	}

	// Authenticate with AD server using admin credentials.
	t.Log("Binding AD admin user")
	err = l.Bind(c.BindDN, c.BindPassword)
	if err != nil {
		t.Error("Error: unable to bind specified admin user to AD: ", err.Error())
		return
	}

	// Get users from AD server by using filter
	filter := ""
	attrs := []string{}
	if len(c.GroupFilter) > 0 {
		filter = c.GroupFilter
		attrs = []string{"dn", "cn", "member"}
	} else if len(c.UserFilter) > 0 {
		filter = c.UserFilter
		attrs = []string{"dn", "cn", "givenName", "sn", "mail", "sAMAccountName"}
	} else {
		filter = "(|(objectClass=person)(objectClass=user)(objectClass=inetOrgPerson))"
		attrs = []string{"dn", "cn", "givenName", "sn", "mail", "sAMAccountName"}
	}

	searchRequest := ld.NewSearchRequest(
		c.BaseDN,
		ld.ScopeWholeSubtree, ld.NeverDerefAliases, 0, 0, false,
		filter,
		attrs,
		nil,
	)

	t.Log("AD search filter:", filter)
	sr, err := l.Search(searchRequest)
	if err != nil {
		t.Error("Error: unable to execute directory search: ", err.Error())
		return
	}

	t.Logf("AD search entries found: %d", len(sr.Entries))
	if len(sr.Entries) == 0 {
		t.Error("Received ZERO AD search entries")
		return
	}

	// Get list of group members for each group found.
	for _, group := range sr.Entries {
		rawMembers := group.GetAttributeValues("member")
		fmt.Printf("%s", group.DN)

		if len(rawMembers) == 0 {
			t.Log("Error: group member attribute returned no users")
			continue
		}

		t.Logf("AD group contains %d members", len(rawMembers))

		for _, entry := range rawMembers {
			// get CN element from DN
			parts := strings.Split(entry, ",")
			if len(parts) == 0 {
				continue
			}
			filter := fmt.Sprintf("(%s)", parts[0])

			usr := ld.NewSearchRequest(
				c.BaseDN,
				ld.ScopeWholeSubtree, ld.NeverDerefAliases, 0, 0, false,
				filter,
				[]string{"dn", "cn", "givenName", "sn", "mail", "sAMAccountName"},
				nil,
			)
			ue, err := l.Search(usr)
			if err != nil {
				t.Log("Error: unable to execute directory search for group member: ", err.Error())
				continue
			}

			if len(ue.Entries) > 0 {
				for _, ur := range ue.Entries {
					t.Logf("[%s] %s (%s %s) @ %s\n",
						ur.GetAttributeValue("sAMAccountName"),
						ur.GetAttributeValue("cn"),
						ur.GetAttributeValue("givenName"),
						ur.GetAttributeValue("sn"),
						ur.GetAttributeValue("mail"))
				}
			} else {
				t.Log("group member search failed:", filter)
			}
		}
	}
}

func TestADServer_Authenticate(t *testing.T) {
	c := lm.LDAPConfig{}
	c.ServerHost = "40.117.188.17"
	c.ServerPort = 389
	c.EncryptionType = "none"
	c.BaseDN = "DC=mycompany,DC=local"
	c.BindDN = "CN=ad-admin,CN=Users,DC=mycompany,DC=local"
	c.BindPassword = "8B5tNRLvbk8K"
	c.UserFilter = ""
	c.GroupFilter = ""

	address := fmt.Sprintf("%s:%d", c.ServerHost, c.ServerPort)
	t.Log("Connecting to AD server", address)
	l, err := ld.Dial("tcp", address)
	if err != nil {
		t.Error("Error: unable to dial AD server: ", err.Error())
		return
	}
	defer l.Close()

	if c.EncryptionType == "starttls" {
		t.Log("Using StartTLS with AD server")
		err = l.StartTLS(&tls.Config{InsecureSkipVerify: true})
		if err != nil {
			t.Error("Error: unable to startTLS with AD server: ", err.Error())
			return
		}
	}

	// Authenticate with AD server using admin credentials.
	t.Log("Binding AD admin user")
	err = l.Bind(c.BindDN, c.BindPassword)
	if err != nil {
		t.Error("Error: unable to bind specified admin user to AD: ", err.Error())
		return
	}

	username := `bob.johnson`
	password := "Pass@word1!"
	filter := fmt.Sprintf("(sAMAccountName=%s)", username)

	searchRequest := ld.NewSearchRequest(
		c.BaseDN,
		ld.ScopeWholeSubtree, ld.NeverDerefAliases, 0, 0, false,
		filter,
		[]string{"mail"},
		nil,
	)

	t.Log("AD search filter:", filter)
	sr, err := l.Search(searchRequest)
	if err != nil {
		t.Error("Error: unable to execute directory search: ", err.Error())
		return
	}

	if len(sr.Entries) == 0 {
		t.Error("Error: user not found")
		return
	}
	if len(sr.Entries) != 1 {
		t.Error("Error: too many users found during authentication")
		return
	}

	userdn := sr.Entries[0].DN

	// Bind as the user to verify their password
	err = l.Bind(userdn, password)
	if err != nil {
		t.Error("Error: invalid credentials", err.Error())
		return
	}

	t.Log("Authenticated", username)
}