[CalendarServer-changes] [15661] CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst
source_changes at macosforge.org
source_changes at macosforge.org
Thu Jun 9 13:41:10 PDT 2016
Revision: 15661
http://trac.calendarserver.org//changeset/15661
Author: dre at apple.com
Date: 2016-06-09 13:41:10 -0700 (Thu, 09 Jun 2016)
Log Message:
-----------
Add doc for LDAP directory service
Added Paths:
-----------
CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst
Added: CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst
===================================================================
--- CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst (rev 0)
+++ CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst 2016-06-09 20:41:10 UTC (rev 15661)
@@ -0,0 +1,196 @@
+LDAP Directory Service
+=======================
+
+The LDAP directory service allows CalendarServer to query an LDAP
+server to retrieve principal information for users, groups,
+locations, and resources.
+
+**Configuring the Calendar Server**
+
+The full name of the service is
+``twistedcaldav.directory.ldapdirectory.LdapDirectoryService``, and a
+sample configuration is shown below. To use LDAP with CalendarServer,
+you will almost certainly have to customize at least some of the config
+options, due to the nature of LDAP's arbitrary and often site-specific
+nomenclature. Anyone familiar with LDAP in general should have no
+problem understanding how to configure CalendarServer to use LDAP.
+
+Note that although multiple directory services may be used concurrently,
+a given record type may only be handled by one directory service.
+
+Sample LDAP configuration:
+
+::
+
+ <key>DirectoryService</key>
+ <dict>
+ <key>type</key>
+ <string>ldap</string>
+
+ <key>params</key>
+ <dict>
+ <key>recordTypes</key>
+ <array>
+ <string>users</string>
+ <string>groups</string>
+ <string>locations</string>
+ <string>resources</string>
+ <string>addresses</string>
+ </array>
+ <key>uri</key>
+ <string>ldap://ldap.example.com/</string>
+ <key>credentials</key>
+ <dict>
+ <key>dn</key>
+ <string>uid=caladmin,ou=people,o=example.com</string>
+ <key>password</key>
+ <string>xyzzy</string>
+ </dict>
+ <key>rdnSchema</key>
+ <dict>
+ <key>base</key>
+ <string>o=example.com</string>
+ <key>users</key>
+ <string>ou=people</string>
+ <key>groups</key>
+ <string>ou=groups</string>
+ <key>locations</key>
+ <string>ou=places</string>
+ <key>resources</key>
+ <string>ou=resources</string>
+ <key>addresses</key>
+ <string>ou=buildings</string>
+ </dict>
+ <key>mapping</key>
+ <dict>
+ <key>uid</key>
+ <array>
+ <string>apple-generateduid</string>
+ </array>
+ <key>guid</key>
+ <array>
+ <string>apple-generateduid</string>
+ </array>
+ <key>shortNames</key>
+ <array>
+ <string>uid</string>
+ </array>
+ <key>fullNames</key>
+ <array>
+ <string>cn</string>
+ </array>
+ <key>emailAddresses</key>
+ <array>
+ <string>mail</string>
+ </array>
+ <key>memberDNs</key>
+ <array>
+ <string>uniqueMember</string>
+ </array>
+ <key>hasCalendars</key>
+ <array>
+ <string>calStatus:active</string>
+ </array>
+ <key>autoScheduleMode</key>
+ <array>
+ <string>icsAutoaccept:true:acceptIfFreeDeclineIfBusy</string>
+ <string>icsAutoaccept:false:none</string>
+ </array>
+ <key>readWriteProxy</key>
+ <array>
+ <string>calRWProxy</string>
+ </array>
+ <key>readOnlyProxy</key>
+ <array>
+ <string>calROProxy</string>
+ </array>
+ </dict>
+ <key>extraFilters</key>
+ <dict>
+ <key>users</key>
+ <string>(calStatus=active)</string>
+ <key>groups</key>
+ <string></string>
+ <key>locations</key>
+ <string>(calStatus=active)</string>
+ <key>resources</key>
+ <string>(calStatus=active)</string>
+ <key>addresses</key>
+ <string></string>
+ </dict>
+ </dict>
+ </dict>
+
+Configuring Principals
+----------------------
+
+The "mapping" section of the above configuration defines the mapping
+between record attributes used by CalendarServer and the LDAP
+attribute used to store this information in the configured LDAP
+server. The mapping 'key' is the CalendarServer name for the
+attribute, and the string value is the associated LDAP attribute name.
+
+``uid``
+
+ Typically equivalent to short name or login name. Single value.
+
+``guid``
+
+ A globally unique identifier for the principal. Must be a UUID
+ string that complies with `RFC 4122`_.
+
+ .. _RFC 4122: http://tools.ietf.org/html/rfc4122
+
+``shortNames``
+
+ The principal's short names (typically equivalent to login names).
+ Multiple values allowed.
+
+``fullNames``
+
+ The principal's full name (or description).
+
+``emailAddresses``
+
+ The principal's email address(es).
+
+``memberDNs``
+
+ Valid only for groups, this is a list of DNs of group members. Valid
+ group member record types are: users, groups, resources. One should
+ avoid creating "loops" by having two groups include each other.
+
+``hasCalendars``
+
+ The value of this config key is used to control whether a principal is
+ allowed to participate in calendaring on this server. The value is a
+ two part string delimited by a colon. The first part is the LDAP
+ attribute name to query, and the second part is the LDAP value of this
+ attribute that indicates a principal is allowed to do calendaring.
+
+``AutoScheduleMode``
+
+ This configures how (or whether) the server will automatically
+ process scheduling messages for the corresponding principal. For
+ example, when a
+ scheduling message arrives, if it does not conflict with an existing
+ meeting it can be automatically accepted into the principal's main
+ calendar; if it does conflict it can be automatically declined. The
+ available modes are:
+
+http://trac.calendarserver.org/browser/CalendarServer/trunk/calendarserver/tools/principals.py#L47
+
+
+``readWriteProxy``
+
+ Specifies the attribute used to store the name of a group
+ whose members are granted read-write proxy (delegate ) access to the
+ corresponding principal.
+
+
+``readOnlyProxy``
+
+ Specifies the attribute used to store the name of a group
+ whose members are granted read-only proxy (delegate) access to the
+ corresponding principal.
+
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20160609/3fbbce75/attachment-0001.html>
More information about the calendarserver-changes
mailing list