Merge branch 'mdb.master' of ssh://git-master.openldap.org/~git/git/openldap

[openldap] / doc / man / man5 / slapo-pcache.5

diff --git a/doc/man/man5/slapo-pcache.5 b/doc/man/man5/slapo-pcache.5
index ccaf8b79cd33dacaf99a5614298cca3098fdfce8..ef8fb212ad210f3ad8dfe734e9b60b67953c9a98 100644 (file)
--- a/doc/man/man5/slapo-pcache.5
+++ b/doc/man/man5/slapo-pcache.5
@@ -1,5 +1,5 @@
 .TH SLAPO-PCACHE 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2009 The OpenLDAP Foundation, All Rights Reserved.
+.\" Copyright 1998-2011 The OpenLDAP Foundation, All Rights Reserved.
 .\" Copying restrictions apply.  See the COPYRIGHT file.
 .\" Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
 .\" $OpenLDAP$
@@ -49,7 +49,8 @@ with the
 .BR meta ,
 and
 .BR sql
-backends.
+backends. Please note that the underlying backend must have a configured
+.BR rootdn.
 .TP
 .B pcache <database> <max_entries> <numattrsets> <entry_limit> <cc_period> 
 The directive enables proxy caching in the current backend and sets general
@@ -78,6 +79,7 @@ special attributes "*" (all user attributes), "+" (all operational attributes)
 or both; in the latter case, any other attribute is redundant and should
 be avoided for clarity.  A set of attributes can contain "1.1" as the only
 attribute; in this case, only the presence of the entries is cached.
+Attributes prefixed by "undef:" need not be present in the schema.
 
 .TP
 .B pcacheMaxQueries <queries>
@@ -133,6 +135,29 @@ will only be refreshed while they have not expired, so the <ttl> should
 be larger than the <ttr> for this option to be useful. Entries are not
 refreshed by default (<ttr> set to 0).
 
+.TP
+.B pcacheBind <filter_template> <attrset_index> <ttr> <scope> <base>
+Specifies a template for caching Simple Bind credentials based on an
+already defined \fBpcacheTemplate\fP. The <filter_template> is similar
+to a <template_string> except that it may have some values present. Its
+purpose is to allow the overlay to generate filters similar to what other
+applications do when they do a Search immediately before a Bind. E.g.,
+if a client like nss_ldap is configured to search for a user with the
+filter "(&(objectClass=posixAccount)(uid=<username>))" then the corresponding
+template "(&(objectClass=posixAccount)(uid=))" should be used here. When
+converted to a regular template e.g. "(&(objectClass=)(uid=))" this
+template and the <attrset_index> must match an already defined
+\fBpcacheTemplate\fP clause. The "time to refresh" <ttr> determines the
+time interval after which the cached credentials may be refreshed. The
+first Bind request that occurs after that time will trigger the refresh
+attempt. Refreshes are not performed when the overlay is Offline. There
+is no "time to live" parameter for the Bind credentials; the credentials
+will expire according to the \fBpcacheTemplate\fP ttl. The <scope> and
+<base> should match the search scope and base used by the authentication
+clients. The cached credentials are not stored in cleartext, they are
+hashed using the default password hash.
+By default Bind caching is not enabled.
+
 .TP
 .B pcachePosition { head | tail }
 Specifies whether the response callback should be placed at the
@@ -189,7 +214,7 @@ cachesize 100
 .LP
 Any valid directives for the chosen database type may be used. Indexing
 should be used as appropriate for the queries being handled. In addition,
-an equality index on the \fBqueryid\fP attribute should be configured, to
+an equality index on the \fBpcacheQueryid\fP attribute should be configured, to
 assist in the removal of expired query data.
 .SH BACKWARD COMPATIBILITY
 The configuration keywords have been renamed and the older form is
@@ -230,7 +255,7 @@ will not be reflected in the response of the cache at least (and at most)
 for the duration of the
 .B pcacheTemplate
 .BR TTL .
-These inconsistencies can be minimized by by careful use of the TTR.
+These inconsistencies can be minimized by careful use of the TTR.
 
 The remote server should expose the
 .B objectClass