LDAP Util library

Description/Features

A library that provides a simplified interface to LDAP user lookups that make use of pre-existing LDAP configuration in atlassian-user.xml and (deprecated) osuser.xml.

Install

In order to do this you need to have LDAP authentication setup and working. See LDAP User Management for more details.

Get the dependant JAR's

This plugin has one dependency on commons-digester, providing XML parser support used to process the Confluence atlassian-user.xml file. For JIRA, no such library is required. There are two use cases:

System referenced code (eg the NTLM authenticator for confluence)

In which case, the dependent JAR need to go into WEB-INF/lib, but confluence already comes with a digester jar so there is nothing to do in this scenario.

Confluence plugin (eg the Custom Space User Management plugin)

In which case, the dependant JAR need to be marked as 'compile' dependency of the plugins POM.

Using ldaputil in confluence plugins If you want to make use of the LDAP util library, you need to have a 'compile' dependency for commons-digester (an earlier version is already bundled with confluence) as its needed for atlassian-user parsing, the additions to your pom should be: <!-- ldap util compile dependency so it gets bundled with the plugin --> <dependency> <groupId>com.dolby.confluence.net</groupId> <artifactId>ldaputil</artifactId> <version>1.0.10</version> </dependency> <!-- atlassian-user.xml parser --> <dependency> <groupId>commons-digester</groupId> <artifactId>commons-digester</artifactId> <version>1.8</version> <scope>compile</scope> </dependency>

Release Notes

LDAP Util configuration

Although you don't have to specify any LDAP configuration, some choices are available, if you want to change anything you need to unpack the ldaputil jar and edit ldaputils.properties, or provide it programatically at the point of use.

Common configuration

These could be changed if needed

Key	Default	Valid Values	Description
ldaputil.providerType	atlassian-user	osuser,atlassian-user	use Atlassian user config
ldaputil.ldap.narrowingFilterExpression	(objectclass=user)	any	this can be used to restrict the LDAP lookup
ldaputil.ldap.fullNameFormat	0	0,1	0= Lastname, Firstname , 1 = Firstname Lastname (no comma)
ldaputil.ldap.forceUserIDCase	2	0,1,2	0=force lower, 1=force upper, 2=use reflect stored value
ldaputil.ldap.subtreeScope	2	0,1,2	0=object scope, 1=one-level scope, 2=subtree scope
ldaputil.ldap.emailAliasesLdapAttribute	proxyAddresses	any ldap attribute	'proxyAddresses' is the Active Directory attribute that houses email aliases
ldaputil.ldap.emailAliasesLdapAttributeSearchPrefix	n/a	comma separated values	This prefix will be used to optionally 'pull out email address' from LDAP, I see in Active Directory many entries such as 'smtp:user@company.co.uk'. The values are case sensitive as the comparison is done in Java not LDAP filters, for example 'smtp:,SMTP:'
ldaputil.ldap.emailAliasesLdapAttributeParser	n/a	implementer of my ILDAPEmailAliasProcessor, eg LDAPUtilsActiveDirectoryEmailAliasExtractor	If specified, this class handles the extraction of email aliases from an LDAP lookup NamingEnumeration

Denotes optional field.

Configuration based on 'atlassian-user'

If you are using 'atlassian-user' no changes are required.

Configuration based on 'osuser'

The ldap attribute keys need configuring in the property file (unpack the jar, edit, repack), the existing values are suited to Active Directory - configure as appropriate, and/or comment here for my info. all keys are required.