View source for Generic LDAP Integration

{{Directory Services Preamble|LDAP server}}

== Accessing Directory Service Integration ==
{{Directory Services Accessing Configuration|LDAP server|Mldap_sync_01.png}}

== Connection to the LDAP Directory Service ==
For synchronization MailStore Server requires information on how to connect to the LDAP directory service and how to obtain the required data from it.

=== LDAP Connection ===
{| class="wikitable"
! width=250px | Name
! Description
|-
| Server Name
| DNS name or IP address of your LDAP server
|-
| Protocol
| Configure whether the connection to the LDAP server is to be unencrypted on port 389, LDAP-TLS on port 389, or LDAP-SSL on port 636
|-
| Accept all certificates (only when using LDAP-TLS or LDAP-SSL)
| {{Option_Accept_all_certificates}}
|-
| Administrative DN
| Distinguished Name (DN) or user name of a user with appropriate privileges on the LDAP server
|-
| Password
| Password of the user specified in Administrative DN
|-
| Base DN
| LDAP base DN, if needed
|}

=== User Filter and Attributes ===
{| class="wikitable"
! width=250px | Name
! Description
|-
| Filter (optional)
| Filter LDAP objects to return only user objects with email addresses
|-
| User Name
| The LDAP attribute containing the username that you wish MailStore to use
|-
| Local Part Only (E-mail Addresses / UPN)
| If unchecked, MailStore will use the full username including domain portion, e.g. ''username@example.com''. If checked, MailStore will only use the local part of the User Name specified, e.g. the ''username''
|-
| Full Name (optional)
| The full name of the user, for display purposes within MailStore
|-
| E-mail Addresses (opt.)
| The LDAP attribute containing the user's email address. This can contain multiple, comma separated, e-mail addresses
|}

=== Group Filter and Attributes ===
{| class="wikitable"
! width=250px | Name
! Description
|-
| Filter
| LDAP filter to return only group objects
|-
| Name
| The LDAP attribute that contains the common name of a group
|-
| Description (optional)
| The LDAP attribute that contains a human readable description for each group
|-
| Members
| The LDAP attribute that contains the common name of group members
|-
| Search Filter for Members
| LDAP filter to resolve group members when members are not specified as a DN string as part of the group results. MailStore will fill in the <tt>{member}</tt> variable with values from the ''Members'' attribute
|-
| Group
| The actual group(s) containing users that MailStore Server will synchronize
|}
{{Directory Services Authentication|LDAP server}}
{{Directory Services Options|LDAP server}}
{{Directory Services Assign Default Privileges}}

== Configuration Samples ==

=== Active Directory ===
It is possible to connect LDAP Generic to Active Directory, allowing for more flexibility and control than MailStore's built-in Active Directory support. For example, LDAP Generic will allow you to accept invalid or self-signed certificates when using LDAP-SSL or LDAP-TLS, use custom filters or change which attributes are used by MailStore.

It is assumed that the Active Directory LDAP service is reachable by the MailStore instance on TCP port 389 or 636, including opening ports in the firewall, where applicable.

As most Active Directory configurations are quite similar, it will be possible to copy/paste most of the examples below, making only minor modifications based on your environment.

==== LDAP Connection ====
{| class="wikitable"
! width=250px | Name
! Value
! Description
|-
| Server Name
| <tt>dc001.example.com</tt>
| DNS name or IP address of an Active Directory domain controller.
|-
| rowspan=3 | Protocol 
| <tt>LDAP</tt>
| Do not use transport encryption
|-
| <tt>LDAP-TLS</tt>
| Use TLS as transport encryption
|-
| <tt>LDAP-SSL</tt>
| Use SSL as transport encryption
|-
| rowspan=2| Accept all certificates
| ''Enabled''
| Establish a TLS/SSL encrypted connection, even if the certificate validation failed.
|-
| ''Disabled''
| Do not establish a TLS/SSL encrypted connection, if the certificate validation failed.
|-
| Administrative DN
| <tt>mailstore@example.com</tt>
| Active Directory account for MailStore's use
|-
| Password
| <tt>MySecretPassword</tt>
| Password of the user specified in ''Administrative DN'' above
|-
| Base DN
| ''Empty''
| LDAP base DN will be detected automatically in Active Directory environments
|}

==== User Filter and Attributes ====
{| class="wikitable"
! width=250px | Name
! Value
! Description
|-
|rowspan = 4 | Filter (optional)
|<tt>(objectCategory=User)</tt>
|All users
|-
|<tt>(&(objectCategory=User)(mail=*))''</tt>
|All users with Active Directory e-mail addresses
|-
|<tt>(&(objectCategory=User)(proxyAddresses=*))</tt>
|All users with Exchange e-mail addresses
|-
|<tt>(&(objectCategory=User)(proxyAddresses=*)(mail=*))</tt>
|All users with Exchange e-mail addresses who are also listed in the global address book
|-
|rowspan = 2 |User Name
|<tt>userPrincipalName</tt>
| Use Active Directory user name as MailStore user name
|-
|<tt>sAMAccountName</tt>
| Use pre-Windows 2000 user name as MailStore user name
|-
|rowspan = 2 |Local Part Only (E-mail Addresses / UPN)
|''Enabled''
| Only use the local part from the Active Directory user name in UPN format
|-
|''Disabled''
| Use the full Active Directory user name in UPN format
|-
|Full Name (optional)
|<tt>displayName</tt>
|The user's visible name in Active Directory
|-
|rowspan = 2 |E-mail Addresses (opt.)
|<tt>proxyAddresses</tt>
|Exchange environments
|-
|<tt>mail</tt>
|Non-Exchange environments
|}

==== Group Filter and Attributes ====
{| class="wikitable"
! width=250px | Name
! Value
! Description
|-
| Filter
| <tt>(objectCategory=Group)</tt>
| All objects of category ''Group'', usually all groups
|-
| Name
| <tt>cn</tt>
| Use the value of the LDAP attribute ''CN'' as group name
|-
| Description (optional)
| <tt>description</tt>
| Use the value of the LDAP attribute ''description'' as group name
|-
| Members
| <tt>member</tt>
| Use the value LDAP attribute ''member'' to determine group members
|-
| Search Filter for Members
| ''emtpy''
| Group members are returned as Distinguished Names
|-
| Group
| <tt>MailStore Users</tt>
| Synchronize only users from the ''MailStore Users'' group
|}

=== OpenLDAP ===
OpenLDAP is a commonly used LDAP server, configuration will require some knowledge of your LDAP environment.

It is assumed that the LDAP service is reachable by the MailStore instance on TCP port 389 or 636, including opening ports in the firewall, where applicable.

As OpenLDAP is very flexible, configuration options vary from server to server and you may need to make significant modifications to the examples below to fit the schema used in your environment.

==== LDAP Connection ====
{| class="wikitable"
! width=250px | Name
! Value
! Description
|-
| Server Name
| <tt>directory.example.com</tt>
| DNS name or IP address of the OpenLDAP server.
|-
| rowspan=3 | Protocol 
| <tt>LDAP</tt>
| Do not use transport encryption
|-
| <tt>LDAP-TLS</tt>
| Use TLS as transport encryption
|-
| <tt>LDAP-SSL</tt>
| Use SSL as transport encryption
|-
| rowspan=2| Accept all certificates
| ''Enabled''
| Establish a TLS/SSL encrypted connection, even if the certificate validation failed.
|-
| ''Disabled''
| Do not establish a TLS/SSL encrypted connection, if the certificate validation failed.
|-
| Administrative DN
| <tt>cn=admin,dc=example,dc=com</tt>
| LDAP username that MailStore should use for accessing the OpenLDAP server
|-
| Password
| <tt>MySecretPassword</tt>
| Password of the user specified in ''Administrative DN'' above
|-
| Base DN
| <tt>dc=example,dc=com</tt>
| The Base-DN of the LDAP directory
|}

==== User Filter and Attributes ====
{| class="wikitable"
! width=250px | Name
! Value
! Description
|-
|rowspan = 2 | Filter (optional)
|<tt>(objectClass=posixAccount)</tt>
|All objects of type ''posixAccount'', usually all users
|-
|<tt>(&(objectClass=posixAccount)(mail=*))</tt>
|All users with configured email address
|-
|rowspan = 2 |User Name
|<tt>uid</tt>
| Use the value of LDAP attribute ''UID'' as MailStore user name
|-
|<tt>cn</tt>
| Use the value of LDAP attribute ''CN'' as MailStore user name
|-
|rowspan = 2 |Local Part Only (E-mail Addresses / UPN)
|''Enabled''
| Only use the local part from a user name in UPN format
|-
|''Disabled''
| Use the full user name in UPN format
|-
|Full Name (optional)
|<tt>displayName</tt>
| Use the value of LDAP attribute ''displayName'' as MailStore user name
|-
|E-mail Addresses (opt.)
|<tt>mail</tt>
| Use the values of LDAP attribute ''mail'' for the email addresses of MailStore users
|}

==== Group Filter and Attributes ====
{| class="wikitable"
! width=250px | Name
! Value
! Description
|-
| Filter
| <tt>(objectClass=posixGroup)</tt>
| All objects of category ''posixGroup'', usually all groups
|-
| Name
| <tt>cn</tt>
| Use the value of the LDAP attribute ''CN'' as group name
|-
| Description (optional)
| <tt>description</tt>
| Use the value of the LDAP attribute ''description'' as group name
|-
| Members
| <tt>member</tt>
| Use the value LDAP attribute ''member'' to determine group members
|-
| rowspan=2 | Search Filter for Members
| ''emtpy''
| Group members are returned as Distinguished Names
|-
| <tt><nowiki>(|(&(objectClass=posixAccount)(uid={member}))(&(objectClass=posixGroup)(cn={member})))</nowiki></tt>
| members in ''memberUid'' are only given as plain user or group names
|-
| Group
| <tt>MailStore Users</tt>
| Synchronize only users from the ''MailStore Users'' group
|}

{{Directory Services Run Synchronization}}
[[File:mads_sync_02.png|center|450px]]


{{Directory Services Test Authentication}}
{{Directory Services Login with Directory Services Credentials|LDAP server}}

[[de:Generische_LDAP-Integration]]
[[en:Generic LDAP Integration]]