<!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>[15664] 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/15664">15664</a></dd>
<dt>Author</dt> <dd>dre@apple.com</dd>
<dt>Date</dt> <dd>2016-06-09 15:16:11 -0700 (Thu, 09 Jun 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Updates to LDAP doc</pre>
<h3>Modified 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="modfile"><h4>Modified: CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst (15663 => 15664)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst 2016-06-09 21:06:10 UTC (rev 15663)
+++ CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst 2016-06-09 22:16:11 UTC (rev 15664)
</span><span class="lines">@@ -3,13 +3,21 @@
</span><span class="cx">
</span><span class="cx"> The LDAP directory service allows CalendarServer to query an LDAP
</span><span class="cx"> server to retrieve principal information for users, groups,
</span><del>-locations, and resources.
</del><ins>+locations, resources, and addresses. This service is implemented by
+`twext.who.ldap`_.
</ins><span class="cx">
</span><ins>+ .. _twext.who.ldap: http://trac.calendarserver.org/browser/twext/trunk/twext/who/ldap
+
+When using this service, a separate process called the Directory Proxy Service
+is instantiated to handle interactions with the LDAP server. This process
+maintains an in-memory cache of directory services data. Worker processes
+communicate with the DPS over an AMP socket. Each worker process also maintains
+an in-memory cache of directory services data. Each cache TTL can be configured
+separately.
+
</ins><span class="cx"> **Configuring the Calendar Server**
</span><span class="cx">
</span><del>-The full name of the service is
-``twistedcaldav.directory.ldapdirectory.LdapDirectoryService``, and a
-sample configuration is shown below. To use LDAP with CalendarServer,
</del><ins>+A sample caldavd.plist configuration is shown below. To use LDAP with CalendarServer,
</ins><span class="cx"> you will almost certainly have to customize at least some of the config
</span><span class="cx"> options, due to the nature of LDAP's arbitrary and often site-specific
</span><span class="cx"> nomenclature. Anyone familiar with LDAP in general should have no
</span><span class="lines">@@ -96,6 +104,10 @@
</span><span class="cx"> <string>icsAutoaccept:true:acceptIfFreeDeclineIfBusy</string>
</span><span class="cx"> <string>icsAutoaccept:false:none</string>
</span><span class="cx"> </array>
</span><ins>+ <key>autoAcceptGroup</key>
+ <array>
+ <string>autoAcceptGroup</string>
+ </array>
</ins><span class="cx"> <key>readWriteProxy</key>
</span><span class="cx"> <array>
</span><span class="cx"> <string>calRWProxy</string>
</span><span class="lines">@@ -121,14 +133,15 @@
</span><span class="cx"> </dict>
</span><span class="cx"> </dict>
</span><span class="cx">
</span><del>-Configuring Principals
-----------------------
</del><ins>+**Configuring Principals**
</ins><span class="cx">
</span><span class="cx"> The "mapping" section of the above configuration defines the mapping
</span><span class="cx"> between record attributes used by CalendarServer and the LDAP
</span><span class="cx"> attribute used to store this information in the configured LDAP
</span><span class="cx"> server. The mapping 'key' is the CalendarServer name for the
</span><span class="cx"> attribute, and the string value is the associated LDAP attribute name.
</span><ins>+extraFilters specifies, for each record type, an LDAP query predicate
+that will be applied to all queries on that record type.
</ins><span class="cx">
</span><span class="cx"> ``uid``
</span><span class="cx">
</span><span class="lines">@@ -180,17 +193,77 @@
</span><span class="cx">
</span><span class="cx"> http://trac.calendarserver.org/browser/CalendarServer/trunk/calendarserver/tools/principals.py#L47
</span><span class="cx">
</span><ins>+``autoAcceptGroup``
</ins><span class="cx">
</span><ins>+ Specifies the uid of a group whose members will be excempt from any
+ AutoScheduleMode setting on the corresponding principal. For example,
+ if a location is configured with an AutoScheduleMode of 'none' with
+ the intention that a read-write delegate will manually accept or deny
+ invitations to that location, invitations from members of the autoAcceptGroup
+ will be automatically accepted if the requested time slot is free.
+
</ins><span class="cx"> ``readWriteProxy``
</span><span class="cx">
</span><del>- Specifies the attribute used to store the name of a group
- whose members are granted read-write proxy (delegate ) access to the
</del><ins>+ Specifies the attribute used to store the uid of a group
+ whose members are granted read-write proxy (delegate) access to the
</ins><span class="cx"> corresponding principal.
</span><span class="cx">
</span><del>-
</del><span class="cx"> ``readOnlyProxy``
</span><span class="cx">
</span><del>- Specifies the attribute used to store the name of a group
</del><ins>+ Specifies the attribute used to store the uid of a group
</ins><span class="cx"> whose members are granted read-only proxy (delegate) access to the
</span><span class="cx"> corresponding principal.
</span><span class="cx">
</span><ins>+**Other LDAP params**
+
+The following settings are available in the 'params' dictionary of the LDAP configuration.
+
+``threadPoolmax``
+``connectionMax``
+
+ These two settings are integers used to limit the concurrency of LDAP query handling in the DPS.
+ There is a subtle but important difference between these two options: threadPoolMax
+ applies to all LDAP interactions INCLUDING authentication, while connectionMax
+ applies to all LDAP interactions EXCEPT authentication. threadPoolMax should always be
+ set to a value greater than connectionMax to prevent LDAP authentications from becomming
+ starved if the LDAP connection pool is full (i.e. connectionMax has been reached).
+
+``tries``
+
+ Specifies the number of times an LDAP query should be retried if it fails for unexpected reasons.
+
+``warningThresholdSeconds``
+
+ Specifies the duration of an LDAP query in seconds above which a warning will be logged.
+
+``useTLS``
+
+ A boolean that instructs the DPS to connect to the LDAP service using TLS.
+
+**Related settings**
+
+The following settings are available *outside* the LDAP directory service configuration (i.e.
+the DirectoryProxy dict is a top-level dict in caldavd.plist):
+
+::
+
+ <key>DirectoryProxy</key>
+ <dict>
+ <key>SocketPath</key>
+ <string>directory-proxy.sock</string>
+
+ <key>InProcessCachingSeconds</key>
+ <integer>60</integer>
+
+ <key>InSidecarCachingSeconds</key>
+ <integer>120</integer>
+ </dict>
+
+``SocketPath``
+
+ The unix domain socket used by AMP for communication between the DPS and workers
+
+``InProcessCachingSeconds``
+``InSidecarCachingSeconds``
+
+ The TTL of directory services data in worker processes and the DPS, respectively.
</ins></span></pre>
</div>
</div>
</body>
</html>