Page History
...
- Early JS7 releases make use of the JS7 - Shiro Identity Service, for migration see JS7 - Shiro Identity Service Migration.
- The connection to an LDAP Server can be secured, see JS7 - LDAP over TLS (using STARTTLS ) and LDAP over SSL (using LDAPS).
This article explains the steps required for configuration of an LDAP Directory Service:
- Step 1: Basic LDAP Configuration
- Step 2: Authentication
- Step 3: Authorization
- Define rolesDefine groupRolesMapping
- Define group/roles mapping
- Define the LDAP attributes to to search for groups
Relevant Tools
- LDAP Browser:
- The screenshots used in this article were made with indicate the Softerra® LDAP Browser that was configured used to connect to use the relevant LDAP Directory Service.
- Command Line Client:
- The examples used in this article are executed with ldapSearch.
...
Proceeding
The following diagram provides an overview of the steps to set up LDAP connections:
...
The LDAP configuration can be managed from the Administration->Manage Identity Services view like this:.
Add Identity Service
In a first step click the Add Identity Service button that brings up the following popup window.
...
- Simple Mode: The most frequently used settings are available.
- Expert Mode:: The full set of settings is available.
Specify General Settings
Find detailed explanations about general settings from See the JS7 - LDAP Identity Service, chapter: Identity Service Settings for detailed explanations about the general settings.
The following table lists the general items used to configure an LDAP connection.
Name | Value | Description |
---|---|---|
LDAP Server URL |
| The protocol, host and the port of the LDAP Server. |
LDAP Start TLS true|false | Checkbox checked or unchecked | To enable Starttls StartTls set the value to See JS7 - LDAP over TLS (using STARTTLS ) and LDAP over SSL (using LDAPS) |
Host Name Verification | trueon|falseoff | Enables host name verification for the server certificate. The default value is off. |
LDAP Truststore Path | Should If the LDAP Server is to be configured for TLS/SSL protocols then the indicated truststore has to include an X.509 certificate specified for the Extended Key Usage of Server Authentication. | |
LDAP Truststore Password | If an LDAP truststore is used and the LDAP truststore is protected by a password, then the password has to be specified. | |
LDAP Truststore Type | If an LDAP truststore is used then the type of the indicated truststore has to be specified being either |
...
The following table lists possible values for authentication with an LDAP Server:
The . The value {0}
will be substituted with the account name.
Name | ValueExample | Description |
---|---|---|
LDAP User DN Template |
| Should This should work from scratch for Microsoft Active Directory®. For login use |
uid={0},ou=People,dc=sos | Use with Microsoft Active Directory® and other LDAP Servers. Look up the For login use The specification of an organizational unit and domain context limits access to hierarchy levels. | |
cn={0},ou=Users,cn={0},ou=Users,dc=sos,dc=berlin,dc=com | Use with Microsoft Active Directory® and other LDAP Servers. The Similar to the example above, the Common Name For login use | |
uid={0},dcuid={0},dc=example,dc=com | Use with This example can be used with a Public LDAP Server. For login use |
Verify Authentication Settings
Verification
Expand | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Verify by use of LDAP BrowserPossible values for the LDAP User DN Template can be derived from an account's properties. The screenshot below screenshot displays such properties from an LDAP Browser: In a first step search with the value from the LDAP User DN Template in the Search DN input field. The query should return only one entry. From the properties of the resulting entry the setting for the account is used and the Verify by use of ldapSearchUsers can check the value of the LDAP User DN Template setting by use of using the ldapSearch utility:
Example for use of with a public LDAP Directory Service The following example uses makes use of a publicly available LDAP Server. To our experience this server provides a good example to make an initial LDAP configuration work.
Note: The option
Verify by use of JOC CockpitTry Users can try to login with an LDAP Accountaccount/Password password combination. Use an Account that you have verified to be correct An account should be used that has been verified by executing the ldapSearch command described above. If there are no Role(s) configured for the Account but the authentication works then you will see the following screen that complains about Should authentication be successful but roles have not been assigned for the account then users will find the following empty page that indicates missing authorization after successful authentication: |
Anchor | ||||
---|---|---|---|---|
|
...
LDAP
: add a Group/Roles mapping. Membership of a user account in security groups of the LDAP Server is mapped to roles in the Identity Service.LDAP-JOC
: add a user account and assign roles with JOC Cockpit. Accounts are managed with the Identity Service in parallel to the LDAP Server. No user passwords are managed with by the JOC Cockpit as authentication is performed with by the LDAP Directory Service.
Anchor | ||||
---|---|---|---|---|
|
For details see JS7 - Manage Roles and Permissions.
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
...
Assign Roles with Identity Service Type LDAP
...
The group/roles mapping defines a search for LDAP groups and a maps resulting LDAP groups to JOC Cockpit roles.
The search for LDAP groups can be executed with one of the following options:
- The LDAP Server makes use a the memberOf attribute. : In this case users can retrieve the list of groups and should proceed with the Approach 1: User Search and should proceed with chapter Using memberOf with User Searchuse of the memberOf Attribute section of this page.
- The LDAP Server does not make use of a the memberOf attribute. : In this case the group contains the Accounts LDAP groups include the accounts that are members of the group. Users should proceed with chapter Using the Approach 2: Group Search for account membership section of this page.
Substitution of the account value
In both searches with groupSearchFilter
and with userSearchFilter
users can specify placeholders:
- In the
groupSearchFilter
and in theuserSearchFilter
users can specify the placeholder%s
, for example:(uid=%s)
- The placeholder
%s
will be substituted with the account from the login. Users can login withdomain\account
oraccount@domain
.
- The placeholder
- Users can specify the placeholder
^s
, for example:(uid=^s)
- The placeholder
^s
will be substituted with the original value from the login, for example:account@domain
.
- The placeholder
...
This approach looks up the account entry and reads the memberOf attribute. This attribute frequently is available from Microsoft Active Directory® LDAP Servers.
Define a userSearchFilter
and a searchBase
to look up the account.
Microsoft Active Directory® supporting the memberOf attribute
...
LDAP Search Base
...
Example: ou=People,dc=sos
...
General
...
LDAP Search Base
...
Example: ou=People,dc=sos
...
The searchBase
is the value of the base DN (or ParentDN in the screenshot above).
Hint:
- If the attribute name in a user's environment does not match the default name memberOf then users can specify the name of the attribute with the
groupNameAttribute
as explained below.
Approach 2: Using Group Search to look up groups that an account is a member of
If the LDAP Server makes use of the memberOf attribute then users can skip this section and proceed with chapter Using memberOf with User Search.
To specify a group search the following settings have to be specified
- LDAP Group Search Base
- LDAP Group Search Filter
- LDAP Group Name Attribute
The groupSearchBase
and groupSearchFilter
for example can be configured like this:
groupSearchBase = ou=Groups,dc=sos
groupSearchFilter = (uniqueMember=uid=%s,ou=People,dc=sos)
...
...
...
Anchor | ||||
---|---|---|---|---|
|
This approach looks up the account in the LDAP Server and reads the memberOf attribute. This attribute frequently is available from Microsoft Active Directory® LDAP Servers.
Users define the LDAP Search Base and LDAP User Search Filter to look up the account.
Name | Required | Example | Description |
---|---|---|---|
LDAP Search Base | yes |
| The specification of an organizational unit and domain context is used to limit access to hierarchy levels. |
LDAP User Search Filter | no | (uid=%s) | The search filter is applied to identify an account within the hierarchy of the LDAP Search Base. The example makes use of the Users can specify placeholders with the LDAP User Search Filter:
Default: |
LDAP Group Name Attribute | no | cn | If the LDAP Server makes use of an attribute that is different to memberOf but that provides the same functionality then users should specify this attribute with their LDAP query. Default: |
Verification
Expand | ||
---|---|---|
| ||
An LDAP Browser can be used to identify matching values for the LDAP Search Base and LDAP User Search Filter. Users can perform an LDAP query with the attributes that match their LDAP Server. The query has to identify a unique account The column Parent DN in the following screenshot holds the LDAP Search Base. |
Anchor | ||||
---|---|---|---|---|
|
This approach looks up groups in the LDAP Server that the account is a member of.
Users define the LDAP Group Search Base and LDAP Group Search Filter to look up groups:
Name | Required | Example | Description |
---|---|---|---|
LDAP Group Search Base | yes |
| The specification of an organizational unit and domain context is used to limit access to hierarchy levels. |
LDAP Group Search Filter | yes | (uniqueMember=uid=%s,ou=People,dc=sos |
...
groupSearchFilter = (uniqueMember=uid=%s,ou=People,dc=sos)
...
title | Verify Authorization Settings |
---|
Verifing the groupSearchFilter with the ldapSearch command
ldapsearch -h localhost -p 389 -b "ou=Groups,dc=sos" -s sub "uniqueMember=uid=ur,ou=People,dc=sos" -x
This search should return the group entries the Account is a member of. Identify the attribute containing the group name that is to be used in the user roles mapping. This can be seen in the next listing
Code Block | ||
---|---|---|
| ||
# extended LDIF
#
# LDAPv3
# base <ou=Groups,dc=sos> with scope subtree
# filter: uniqueMember=uid=ur,ou=People,dc=sos
# requesting: ALL
#
# sos, Groups, sos
dn: cn=sos,ou=Groups,dc=sos
description: Employees of SOS GmbH
objectClass: top
objectClass: groupofuniquenames
cn: sos
uniqueMember: uid=ur,ou=People,dc=sos
uniqueMember: uid=fTester,ou=People,dc=sos
# apl, Groups, sos
dn: cn=apl,ou=Groups,dc=sos
objectClass: top
objectClass: groupofuniquenames
cn: apl
uniqueMember: uid=ur,ou=People,dc=sos
uniqueMember: uid=fTester,ou=People,dc=sos
# search result
search: 2
result: 0 Success
# numResponses: 3
# numEntries: 2
|
Verifing the groupSearchBase and groupSearchFilter with an LDAP Browser
...
The groupNameAttribute
is the name of the attribute that holds the group name.
groupNameAttribute = cn
Hint: The value of this attribute has to be used with the groupRolesMap
attribute. Typical values of the attribute could be cn=groupname,
ou=Groups,dc=sos
.
...
If roles are assigned by JOC Cockpit using the Identity Service Type LDAP-JOC
you can skip this chapter.
If the value of the member of the groups contains the Account name from the login then you can skip this chapter
Sometimes the values of the member do not contain the Account Name from the login but, for example, the cn
of the Account. In this case users have to search for the account first and then to specify the name of the attribute that should be used instead of the account name from the login .
To achieve this, the searchBase
, userSearchFilter
and userNameAttribute
attributes can be specified:
searchBase = ou=People,dc=sos
userSearchFilter = (uid=%s)
...
title | Substitution of the account name |
---|
Verify by use of ldapSearch
This search should return the Account with the given Account name. Identify the attribute that should be used for substitution in the Group Search base if it is not the Account name from the login.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
ldapsearch -h localhost -p 389 -b "ou=People,dc=sos" -s sub "uid=fTester" -x
# This should return the following result
# extended LDIF
#
# LDAPv3
# base <ou=People,dc=sos> with scope subtree
# filter: uid=fTester
# requesting: ALL
#
# fTester, People, sos
dn: uid=fTester,ou=People,dc=sos
mail: info@sos-berlin.com
uid: fTester
givenName: Fritz
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetorgperson
sn: Tester
cn: Fritz Tester
# search result
search: 2
result: 0 Success
# numResponses: 2
# numEntries: 1
|
Verification by use of LDAP Browser
...
Then identify the name of the attribute that contains the value for substitution. For example:
userNameAttribute = cn
Group Roles Mapping
The mapping is configured with the "Expert Mode" of the LDAP Identity Service Settings.
Note that the value of the group depends on the result of the group search. It is the value of the attribute that has been specified with the groupNameAttribute
attribute. This attribute defaults to memberOf. In case that group memberships are looked up by use of the memberOf attribute of an account then the value of the memberOf attribute has to be specified, i.e. the Distinguished Names of group hits.
Example for Group Mapping with Microsoft Active Directory® and memberOf Attribute
A typical mapping when using Microsoft Active Directory® and the memberOf attribute includes to specify each group by its Distinguished Name like this:
CN=Group1,OU=SpecialGroups,OU=Groups,OU=Company,DC=sos-berlin,DC=com ==> all
CN=AnotherGroup,OU=SpecialGroups,OU=Groups,OU=CompanyDC=sos-berlin,DC=com ==> adminitrator
CN=Beginners,OU=SecurityGroups,OU=Groups,OU=Company,DC=sos-berlin,DC=com ==> business_user
Example for Group Mapping with cn Attribute
A mapping that is based on Group Search would apply resulting groups from the value of their Common Name like this:
...
Examples and special configurations
...
Group Search
...
Group Search where the member attribute does not contain the account name but the common name
...
memberOf in the account record
...
) | The LDAP Group Search Filter is applied to identify groups within the hierarchy of the LDAP Group Search Base that the authenticated account is a member of. The LDAP Group Search Filter make use of an attribute that is specific for the LDAP Server product. The example makes use of the Users can specify placeholders with the LDAP Group Search Filter:
| ||
LDAP Group Name Attribute | no | dn | The name of the attribute that identifies the group which results from an LDAP query using LDAP Group Search Base and LDAP Group Search Filter. The value of this attribute is used for the groups/roles mapping.
Default: |
Verification by LDAP Browser
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Users can identify the LDAP Group Search Base in their LDAP Server by navigating to the relevant groups using their LDAP browser: The group entry holds a distinguished name like this:
Users can identify the LDAP Group Search Filter in their LDAP Server by navigating to the relevant groups using their LDAP browser: In this example the attribute is As a result the following LDAP Group Search Filter is used: |
Verification by ldapSearch
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Verify the LDAP Group Search Filter with the ldapSearch Utility This search returns the groups that the account is a member of. Users should identify the value of the LDAP Group Name Attribute attribute in the output of the example.
Verify the LDAP Group Search Base and LDAP Group Search Filter with an LDAP BrowserUsers can verify both attribute values by performing an LDAP query. The result should display all groups the account is a member of. |
Anchor | ||||
---|---|---|---|---|
|
Consider a situation from the above example:
- LDAP query example includes
(uniqueMember=uid=ur,ou=People,dc=sos)
- The value of the
uid
attribute usually is specified by the%s
placeholder and is substituted by theaccount
fromaccount@domain
used for login. This example makes use ofur
. - If the
uid
attribute does not make use of the user'saccount
but some other attribute available for the account then an additional LDAP query is required to the identify the account.
For example, if the uid
attribute holds the value of the cn
attribute then users have to search for the account
first and then specify the name of the attribute that holds the value for the substitution.
The following settings have to be specified:
Name | Required | Example | Description |
---|---|---|---|
LDAP Search Base | yes |
| The specification of an organizational unit and domain context is used to limit access to hierarchy levels. |
LDAP Search User Filter | yes | (uid=%s) | The syntax is the same as explained with Approach 1: User Search and use of the memberOf Attribute |
LDAP User Name Attribute | yes | cn | Specifies the attribute that holds the value to replace the %s placeholder in LDAP Group Search Filter, for example: (uniqueMember=uid=%s,ou=People,dc=sos) |
Verification
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Verify by use of ldapSearchThis LDAP query returns the account with the given account name, for example fTester. Users have to identify the attribute that holds the value that is expected from the
Verify by use of LDAP BrowserUsers can use their LDAP Browser to test the LDAP query that identifies the user account. The result should return a single account. |
Group Roles Mapping
The mapping is configured with the "Expert Mode" of the LDAP Identity Service Settings.
Examples
Group/roles Mapping with Approach 1: User Search and use of the memberOf Attribute
In the JOC Cockpit Identity Service Settings the following group/roles mapping is specified:
Group | Roles |
---|---|
CN=Group1,OU=SpecialGroups,OU=Groups,OU=Company,DC=sos-berlin,DC=com | all |
CN=AnotherGroup,OU=SpecialGroups,OU=Groups,OU=CompanyDC=sos-berlin,DC=com | adminitrator |
CN=Beginners,OU=SecurityGroups,OU=Groups,OU=Company,DC=sos-berlin,DC=com | business_user |
Explanation:
- As Approach 1: User Search and use of the memberOf Attribute is used then distinguished names of groups have to be specified.
Group/roles Mapping with Approach 2: Group Search for account membership
In the JOC Cockpit Identity Service Settings the following group/roles mapping is specified, for example when using the cn
attribute for group names:
Group | Roles |
---|---|
sos | it_operator |
apl | administrator,application_manager |
Explanation:
- As Approach 2: Group Search for account membership is used the group's Common Name is specified.
A public LDAP Server for Testing
An online LDAP Server is available for public access (managed by Forum Systems). This server can be used to test LDAP authentication and authorization.
- The LDAP Server offers two accounts:
gauss
: the user account is assigned theall
role which allows access to any operation in JOC Cockpit.newton
: the user account is assigned theapplication_manager
role which includes to manage scheduling object, but for example does not allow to restart a Controller.- The roles and permissions are described with the JS7 - Default Roles and Permissions article.
- The accounts are members in different LDAP groups that are mapped to respective roles in JOC Cockpit.
The LDAP settings are available for download: PublicLDAP.ldap.json
- The popup window to manage LDAP Server settings offers an Upload button to import downloaded settings.
- The popup window to manage LDAP Server settings offers an Upload button to import downloaded settings.
Both accounts gauss and newton make use of the same password:
User Account
...
public LDAP Server
...
A public LDAP Server for testing the connection
An online public LDAP server which can be accessed using a relatively simple configuration is available from Forum Systems. This server can be used to set up a test environment with LDAP authentication. In this article we will refer to the authentication of two user accounts on this server - gauss and newton - that are each members of a different LDAP group as shown in the following table:
...
Password LDAP Group Role gauss password mathematicians all
newton password scientists
...
application_
...
manager
Logging
References
Use Cases
- For
...
- analysis of LDAP Server connections, authentication and authorization consider increasing the log level and checking the output of JOC Cockpit's
authentication-debug.log
file.