LDAP Connector module
| Edition | DX Core |
|---|---|
License |
|
Issues |
|
Maven site |
|
Latest |
1.10.4 |
Magnolia LDAP Connector is a JAAS login module that connects to any LDAP v3 directory service. The LDAP Connector is used in intranet environments where an enterprise user management infrastructure already exists. With JAAS you can meet single sign-on requirements or connect to legacy LDAP servers.
Installing with Maven
Maven is the easiest way to install the module. Add the following to your bundle:
<dependency>
<groupId>info.magnolia</groupId>
<artifactId>magnolia-ldap</artifactId>
<version>1.10.4</version>
</dependency>Module configuration
Since module version 1.9, the configuration of the following is done directly in the user manager:
-
allowPartialResults -
ignoreGroupsWithIllegalName -
pageSize -
envPropertiesPredicate
LDAP configuration
An LDAP configuration file tells Magnolia where to find your LDAP directory server. The file also says whether Magnolia should resolve users, groups or both from the directory.
The
LDAP
Connector module bundle provides two sample files in the
configuration-samples folder:
-
ldap.propertiesdefines an LDAP server. -
ad.propertiesdefines an Active Directory server.
Properties (LDAP and/or Active Directory)
Properties used in the ldap.properties and/or
ad.properties file(s):
File(s)
| Property | Description | ||
|---|---|---|---|
|
required URL of the LDAP/AD service provider. Example: both |
||
|
required, default is the LDAP provider’s default User or program doing the authentication. Use an appropriate DN/CN for your server. Example: Originally interchangeable with the now deprecated both |
||
|
required Password or encrypted data such as a digital certificate that the implementation uses to authenticate the client. Originally interchangeable with the now deprecated both |
||
|
optional, default is `none` Authentication mechanism (password encryption) used. Possible values are
both |
||
|
optional, default is `ignore` Indicates to the service provider how to handle
referrals.
Valid values are If the LDAP/AD service provider receives a referral despite you having
set the property to To deal with the both |
||
|
optional (but recommended) The class name of the of the initial context. The class must implement
the The default value for java.naming.factory.initial will depend on your
container or Java configuration. For example, the default configuration
for Apache Tomcat specifies the class
both |
||
|
required Defines the initial connect point to the directory service. Example: both |
||
|
required Name mapping(s) taking the form
See also: Accessing properties from LDAP both |
||
|
optional When searching a user from a wide initialSearchAttribute, a custom
filter might come in handy. Be aware that attribute used for resolving
Example:
both |
||
|
optional Custom filter can be used also when searching all users from a wide initialSearchAttribute. Example: ADUserManager default users search filter is:
both |
||
|
required (if The value is a class responsible for resolving groups assigned to a
user. The class must implement the
Implementations:
both |
||
|
required (if A class responsible for resolving roles assigned to a user. The class
must implement the Implementations:
ad. |
||
|
optional, default is Set ad. |
||
|
required (only if The name of the user attribute which specifies the groups the user is a member of. Example: ldap. |
||
|
required (if A filter used to find groups the user is a member of. Example:
ldap. |
||
|
required (if The value of the Example: both |
||
|
required (only if either The name of the group ID attribute in LDAP/AD. Example: both |
||
|
optional (only if either A subtree for groups in the LDAP/AD structure if groups are managed in
different subtree than the users. If missing then the
Example: both |
||
|
optional (only if either
A filter for searching groups in LDAP/AD. both |
||
|
required (only if either The name of the group attribute which specifies the members belonging to the group. Example: Deprecated properties:
Instead, use |
magnolia.properties
Put the`ldap.properties` or ad.properties file inside your Magnolia
webapp, for example in
/<CATALINA_HOME>/webapps/<contextPath>/WEB-INF/config. Reference the
file location from a
magnolia.properties
file using the jndi.ldap.config property. Set the value to an absolute
or relative path inside the webapp. You can also use the
${magnolia.home} variable.
magnolia.properties
jndi.ldap.config=WEB-INF/config/ldap.propertiesConfiguring multiple directory servers
To configure multiple LDAP and AD directories, use the pattern
jndi.ldap.config.<realmName> where realmName corresponds to a realm
name in the user manager.
Example: Configuring multiple directory servers in
magnolia.properties.
magnolia.properties
jndi.ldap.config.ad=WEB-INF/config/ad.properties
jndi.ldap.config.ldap=WEB-INF/config/ldap.properties
jndi.ldap.config=WEB-INF/config/default-ldap.propertiesExplanation:
-
A user manager with realm name
adwill use an Active Directory property file defined under thejndi.ldap.config.adkey. -
A user manager with realm name
ldapwill use an LDAP property file defined under thejndi.ldap.config.ldapkey. -
A user manager with realm name
externalwill use the default LDAP property file defined under thejndi.ldap.configkey since no specific property file is configured for this realm.
Corresponding user manager configuration:
A custom configuration resolver
(WARNING: LDAP module 1.9+) You can write your own configuration resolver in JAVA. Add the following component to your module descriptor,
<components>
<id>main</id>
<component>
<type>info.magnolia.jaas.sp.ldap.config.ConfigResolver</type>
<implementation>your-own-resolver-class</implementation>
</component>
</components>change the implementation class accordingly, and make sure that your module depends on (i.e. is loaded after) Magnolia’s LDAP module.
JAAS login configuration
Magnolia uses the Java Authentication and Authorization Service (JAAS) to authenticate users. When you store users in a directory outside of Magnolia configure the directory as a LoginModule. You can list several LoginModules. Authentication proceeds down the module list in the order you specify with flags, see javax.security.auth.login.Configuration. Depending on the servlet container you use the configuration for JAAS is slightly different.
jaas.config for Tomcat
For the Tomcat application server, create a jaas.config file and list
the LoginModules in the following format:
jaas.config syntax
magnolia {
<LoginModule> <flag> <options>;
<LoginModule> <flag> <options>;
<LoginModule> <flag> <options>;
};| Property | Description |
|---|---|
|
required A class that implements the desired authentication technology. Implementations:
Set also the |
|
required The flag indicates whether success of the preceding LoginModule is
|
|
optional Options is a space-separated list of LoginModule-specific values which are passed directly to the LoginModule. The options are defined by the LoginModule itself, and control its behavior. Options for
Example 1: Authenticate against Magnolia on Tomcat jaas.config Example 2: Authenticate against LDAP on Tomcat jaas.config Notes about example 2:
|
User manager
You also need to configure an external UserManager. WARNING: Make
sure it is placed before the admin but after the system user
managers. Any other order may result in 401 errors (authentication
failed) during publishing and unpublishing of content.
| Property | Description | ||
|---|---|---|---|
|
optional, default is Allows duplicate usernames in different realms. Only applicable to
|
||
|
required A class that implements the info.magnolia.cms.security.UserManager interface. Implementations:
|
||
|
optional, default is Allows to disable caching if set to |
||
|
required Realm name corresponding to JAAS login configuration. |
||
|
optional, default is Indicates what methods are used to deal with the
|
||
|
optional A subnode which allows you to specify a custom |
||
|
The class that implements the The default class used is
Two additional implementations are available:
|
||
|
optional A subnode which specifies the If not defined explicitly then the predicate accepts anything within the following namespaces:
|
||
|
The class that implements the The default class is
|
||
|
optional A subnode which defines the decoding method of the admin password used
by the
|
||
|
The decoder is available in three implementations:
|
||
|
optional, default is Specifies the number of objects to be returned in a single search result. |
User managers and caching
By default the ad and ldap user managers use a basic cache
(Cache modules) to avoid
repeated calls to LDAP/AD. If
Ehcache is
used then the default configuration is automatically bootstrapped into
/modules/cache/config/cacheFactory/caches/ldap-user-manager-cache. You
can disable caching by adding the disableCache property to the
manager’s node and setting it to true, for example.
Accessing properties from LDAP
If you need to access more user properties than name, full name and
language, extend
info.magnolia.jaas.sp.ldap.LDAPAuthenticationModule#setEntity to push
the desired properties into the Entity object, and the
info.magnolia.cms.security.ExternalUserManager/info.magnolia.cms.security.ExternalUser
pair to expose it.
Same-name users in different realms
If you are resolving roles or groups, add the
allowCrossRealmDuplicateNames property under
/server/security/userManagers/admin and set its value to true. This
property allows you to create users with the same name in different
realms when replicating LDAP/AD users in the repository. By default,
Magnolia does not allow the same user name to be repeated.
See also: Configuring multiple directory servers
Groups and roles
LDAP typically mirrors the organization structure. If your company has a
Marketing department then create a marketing group in the LDAP
directory and assign employees to the group. Magnolia also organizes
users into groups.
Magnolia also has
roles. A
role grants a user permission to do something. For example, the editor
role grants the user permission to edit content. Permissions are
configured using
access
control lists. A role can be assigned directly to a user or to a group.
When you authenticate users against an LDAP directory a resolver class finds the groups and roles the user belongs to. This process is called resolving. Since the role is the element that grants the user permission to do something, you must resolve at least roles. You can optionally also resolve groups.
Group resolving
A groupResolverClass configured in
ldap.properties finds groups in the LDAP
directory and matches them to groups in Magnolia. The group names must
match exactly.
Choose a resolver depending on where the groups are stored:
-
info.magnolia.jaas.sp.ldap.resolver.MagnoliaGroupResolverresolves groups from Magnolia. -
info.magnolia.jaas.sp.ldap.resolver.OpenLDAPGroupResolverresolves groups from any LDAP directory. -
info.magnolia.jaas.sp.ldap.resolver.ADGroupResolverresolves groups from Active Directory.
Best practice
When you store groups in LDAP, create one matching group per role in Magnolia. Assign roles to the group in Magnolia in order to grant users the permissions they need. This minimizes the number of groups you need to create in Magnolia.
When creating a group name, make sure that it does not contain
an illegal character. See also the ignoreGroupsWithIllegalName
property in module configuration.
|
Role resolving
A roleResolverClass configured in
ldap.properties finds roles. Roles must always be
stored in Magnolia, they cannot be stored in the LDAP directory. The
reason is that the ACLs that grant permissions are attached to roles.
Magnolia provides one role resolver:
-
info.magnolia.jaas.sp.ldap.resolver.MagnoliaRoleResolverresolves roles from theuserrolesworkspace in Magnolia.
Testing and validating LDAP Configuration
You can use the magnolia-ldap-tester, a standalone module for testing ldap/ad configuration outside of Magnolia. The module is available from Magnolia Nexus: magnolia-ldap-tester-1.10.4.jar
Use the following command to execute the jar:
java -jar magnolia-ldap-tester-1.10.4.jar <LoginModule class name> <config.properties> <username> <password><LoginModule class name> should be either
info.magnolia.jaas.sp.ldap.LDAPAuthenticationModule or
info.magnolia.jaas.sp.ldap.ADAuthenticationModule, depending on which
one you’re using in jaas.config (or login-config.xml with JBoss).
The tool simulates a user login with the given credentials and
configuration, outputs the main results, and logs everything else in
magnolia-ldap-tester.log.
A successful login attempt looks like this in the log:
INFO i.m.jaas.sp.ldap.ConnectionFactory - Trying to log in as
cn=jsmith,dc=example,dc=com with a password.
DEBUG i.m.jaas.sp.ldap.ConnectionFactory - Login succeeded.
DEBUG i.m.j.s.l.Tester$MockSecuritySupport - Getting user jsmith from realm admin
INFO info.magnolia.ldap.tool.LDAPTester - Login result: true
INFO info.magnolia.ldap.tool.LDAPTester - Commit result: true
DEBUG info.magnolia.ldap.tool.LDAPTester - Subject:
DEBUG info.magnolia.ldap.tool.LDAPTester - User: null
INFO info.magnolia.ldap.tool.LDAPTester -
Properties: {title=jsmith,
email=john.smith@example.com,
name=jsmith,
fullName=jsmith,
password=secret}
DEBUG info.magnolia.ldap.tool.LDAPTester -
State: {groupNames=[],
statusValue=1,
roleNames=[]}
INFO info.magnolia.ldap.tool.LDAPTester - Group names: (none)
INFO info.magnolia.ldap.tool.LDAPTester - Role names: (none)
DEBUG info.magnolia.ldap.tool.LDAPTester - AttributesMapDo not expect to see any groups or roles assigned. The tester tool does not connect to Magnolia in any way. It connects to the LDAP. It is normal for group assignments handled in Magnolia not to show up.