Home > Documentation > Administration > Administrative tasks > Configuring security > Administering security realms > LDAP Realm |
A guide to deploying LDAP realms in Geronimo. The samples reflect settings that are valid for the default ApacheDS setup.
Geronimo can be configured to use the Apache Directory Server for its directory service. As of Geronimo 1.1 ApacheDS is not installed by default. If you do not have ApacheDS installed in your environment here are a serie of quick steps to install it as a Geronimo Plugin.
To set up ApacheDS in Geronimo install the plugin as follows:
Update Repository List
link.LDAP Security Realms can be deployed easily from within the Geronimo Console using the Security Realms portlet.
From the Security Realms portlet:
An LDAP Realm can also be deployed from the command line using the Deployer tool. The configuration options are set in the first ldap-login
gbean in the sample file. For configuration option details see LDAP Login Module Configuration.
To deploy the ldap-realm.xml run the following command from the <geronimo_home>/bin directory:
java -jar deployer.jar --user system --password manager deploy <ldap_home>/<filename>.xml
Once deployed you should see a confirmation message similar to the following example:
The following XML example uses parameters that are valid for the default ApacheDS server setup.
The following section is a reference for users needing to deploy custom LDAP realms and outlines the LDAP Login Module configuration parameters as well as different possible configurations for retrieving LDAP user roles.
Tip: The key to working with the LDAP module is: KNOW YOUR LDAP SCHEMA.
Option | Description |
---|---|
initialContextFactory | The class name of the initial context factory. Usually |
connectionURL | The LDAP connection URL, such as ldap://localhost:1389 . Note that the usual LDAP port is 389. |
connectionUsername | The DN used by the login module itself for authentication to the directory server. |
connectionPassword | The credential (password) that is used by the login module to authenticate itself to the directory server. |
connectionProtocol | The security protocol to use. This value is determined by the service provider. This can be left blank. An example would be SSL. |
authentication | The security level to use. Its value is one of the following strings: "none", "simple", "strong". If this property is unspecified the behavior is determined by the service provider. |
userBase | The base DN for the group membership search. |
userSearchMatching | The filter specification for how to search for user entries. RFC 2254 filters are allowed. In addition you can pass a parameter to the search filter instead of the literal value. For example: this is RFC 2254 filter spec: (cn=Babs Jensen). If you want to parameterize the value of the CN attribute type, specify (cn = {0}). This integer refers to the parameter number. Parameter value is the user name. This query must return exactly one object. |
userSearchSubtree | Defines the directory search scope for user entries. If set to true, the directory search scope is SUBTREE, if set to false, the directory search scope is ONE-LEVEL. |
roleBase | The base DN for the group membership search. |
roleName | The LDAP attribute that identifies the group name in the entry returned from the group membership search. Note that group membership query is defined by the |
roleSearchMatching | The filter specification for how to search for roles. RFC 2254 filters are allowed. In addition you can pass parameters to the search filter instead of the literal value. For example: (uniqueMember = {0}). This integer refers to the parameter number. This parameter is the DN of the authenticated user. Note that if role membership for the user is defined in the member-of-like attribute (see |
roleSearchSubtree | Defines the directory search scope for roles. If set to true, the directory search scope is SUBTREE, if set to false, the directory search scope is ONE-LEVEL. |
userRoleName | The group membership attribute of a user entry. Different LDAP schemas represent user group membership in different ways. Examples are: memberOf, isMemberOf, member, etc. Values of these attributes are identifiers of groups that a user is a member of. For example, if you have: memberOf: cn=admin,ou=groups,dc=foo, specify memberOf as the value for the |
The LDAPLoginModule can be configured to find user roles (group memberships) using two different methods:
To use this method the roleName and roleSearchMatching options must be set. The LDAPLoginModule will perform an LDAP search using the roleSearchMatching filter to search for the authenticating user's distinguished name within each group entry's roleName
attribute. To skip this method the roleName
option MUST be left unset. If the roleName
option is set and the roleSearchMatching
option is left unset then the LDAPLoginModule
will attempt to perform the search and throw an exception.
To use this method the userRoleName option must be set with the name of the user entry's attribute that contains the group membership list. To skip this method the userRoleName should be unset.
Bookmark this on Delicious Digg this | Privacy Policy - Copyright © 2003-2009, The Apache Software Foundation, Licensed under ASL 2.0. |