<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[15661] CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/15661">15661</a></dd>
<dt>Author</dt> <dd>dre@apple.com</dd>
<dt>Date</dt> <dd>2016-06-09 13:41:10 -0700 (Thu, 09 Jun 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add doc for LDAP directory service</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#CalendarServertrunkdocAdminDirectoryServiceLDAPrst">CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkdocAdminDirectoryServiceLDAPrst"></a>
<div class="addfile"><h4>Added: CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst (0 => 15661)</h4>
<pre class="diff"><span>
<span class="info">--- 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)
</span><span class="lines">@@ -0,0 +1,196 @@
</span><ins>+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.
+
</ins></span></pre>
</div>
</div>
</body>
</html>