git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-pcache.5

   1 .TH SLAPO-PCACHE 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2006 The OpenLDAP Foundation, All Rights Reserved.
   3 .\" Copying restrictions apply.  See the COPYRIGHT file.
   4 .\" Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
   5 .\" $OpenLDAP$
   6 .SH NAME
   7 slapo-pcache \- proxycache overlay
   8 .SH SYNOPSIS
   9 ETCDIR/slapd.conf
  10 .SH DESCRIPTION
  11 The
  12 .B pcache
  13 overlay to
  14 .BR slapd (8)
  15 allows caching of LDAP search requests (queries) in a local database.
  16 For an incoming query, the
  17 proxy cache determines its corresponding \fBtemplate\fP. If the template
  18 was specified as cacheable using the \fBproxytemplate\fP directive
  19 and the request is contained in a cached request, it is answered from
  20 the proxy cache.
  21 Otherwise, the search is performed as usual and cacheable search results
  22 are saved in the cache for use in future queries.
  23 .LP
  24
  25 A template is defined by a filter string and an index identifying a set of
  26 attributes. The \fBtemplate string\fP for a query can be obtained by
  27 removing assertion values from the RFC 2254 representation of its search
  28 filter. A query belongs to a template if its template string and set of
  29 projected attributes correspond to a cacheable template.
  30 Examples of template strings are \fB(mail=)\fP, \fB(|(sn=)(cn=))\fP,
  31 \fB(&(sn=)(givenName=))\fP.
  32
  33 .LP
  34 The config directives that are specific to the
  35 .B proxycache
  36 overlay can be prefixed by
  37 .BR proxycache\- ,
  38 to avoid conflicts with directives specific to the underlying database
  39 or to other stacked overlays.  This may be particularly useful for those
  40 directives that refer to the backend used for local storage.
  41 The following cache specific directives can be used to configure the proxy
  42 cache:
  43 .TP
  44 .B overlay pcache
  45 This directive adds the proxy cache overlay to the current backend. The
  46 proxy cache overlay may be used with any backend but is intended for use
  47 with the
  48 .BR ldap ,
  49 .BR meta ,
  50 and
  51 .BR sql
  52 backends.
  53 .TP
  54 .B proxycache <database> <max_entries> <numattrsets> <entry_limit> <cc_period>
  55 The directive enables proxy caching in the current backend and sets general
  56 cache parameters. A <database> backend will be used internally to maintain
  57 the cached entries. The chosen database will need to be configured as well,
  58 as shown below. Cache replacement is invoked when the cache size grows to
  59 <max_entries> entries and continues till the cache size drops below this size.
  60 <numattrsets> should be equal to the number of following \fBproxyattrset\fP
  61 directives. Queries are cached only if they correspond to a cacheable template
  62 (specified by the \fBproxytemplate\fP directive) and the number of entries
  63 returned is less than <entry_limit>. Consistency check is performed every
  64 <cc_period> duration (specified in secs). In each cycle queries with expired
  65 "time to live(\fBTTL\fP)" are removed. A sample cache configuration is:
  66 .LP
  67 .RS
  68 proxycache \fBbdb 10000 1 50 100\fP
  69 .RE
  70 .TP
  71 .B proxycachequeries <queries>
  72 Specify the maximum number of queries to cache. The default is 10000.
  73
  74 .TP
  75 .B proxyattrset <index> <attrs...>
  76 Used to associate a set of attributes <attrs..> with an <index>. Each attribute
  77 set is associated with an integer from 0 to <numattrsets>-1. These indices are
  78 used by the \fBproxytemplate\fP directive to define cacheable templates.
  79
  80 .TP
  81 .B proxytemplate <template_string> <attrset_index> <ttl> [<negttl>]
  82 Specifies a cacheable template and "time to live" (in sec) <ttl> of queries
  83 belonging to the template. An optional <negttl> can be used to specify
  84 that negative results (i.e., queries that returned zero entries)
  85 should also be cached for the specified number of seconds. Negative
  86 results are not cached by default.
  87
  88 .TP
  89 .B response-callback { head | tail }
  90 Specifies whether the response callback should be placed at the
  91 .B tail
  92 (the default) or at the
  93 .B head
  94 (actually, wherever the stacking sequence would make it appear)
  95 of the callback list.  This affects how the overlay interacts with other
  96 overlays, since the proxycache overlay should be executed as early
  97 as possible (and thus configured as late as possible), to get
  98 a chance to return the cached results; however, if executed early
  99 at response, it would cache entries that may be later "massaged"
 100 by other databases and thus returned \fIafter\fP massaging the first
 101 time, and \fIbefore\fP massaging when cached.
 102
 103 .TP
 104 There are some constraints:
 105
 106 all values must be positive;
 107
 108 .B <entry_limit>
 109 must be less than or equal to
 110 .BR <max_entries> ;
 111
 112 .B <numattrsets>
 113 attribute sets SHOULD be defined by using the directive
 114 .BR proxyattrset ;
 115
 116 all attribute sets SHOULD be referenced by (at least) one
 117 .B proxytemplate
 118 directive;
 119
 120 .LP
 121 The following adds a template with filter string \fB(&(sn=)(givenName=))\fP
 122 and attributes mail, postaladdress, telephonenumber and a TTL of 1 hour.
 123 .LP
 124 .RS
 125 .nf
 126 proxyattrset \fB0 mail postaladdress telephonenumber\fP
 127 proxytemplate \fB(&(sn=)(givenName=)) 0 3600\fP
 128 .fi
 129 .RE
 130
 131 .LP
 132 Directives for configuring the underlying database must also be given, as
 133 shown here:
 134 .LP
 135 .RS
 136 .nf
 137 directory /var/tmp/cache
 138 cachesize 100
 139 .fi
 140 .RE
 141 .LP
 142 Any valid directives for the chosen database type may be used.
 143 .SH CAVEATS
 144 Caching data is prone to inconsistencies because updates on the remote server
 145 will not be reflected in the response of the cache at least (and at most)
 146 for the duration of the
 147 .B proxytemplate
 148 .BR TTL .
 149
 150 The remote server should expose the
 151 .B objectClass
 152 attribute because the underlying database that actually caches the entries
 153 may need it for optimal local processing of the queries.
 154
 155 Another potential (and subtle) inconsistency may occur when data is retrieved
 156 with different identities and specific per-identity access control
 157 is enforced by the remote server.
 158 If data was retrieved with an identity that collected only partial results
 159 because of access rules enforcement on the remote server, other users
 160 with different access privileges on the remote server will get different
 161 results from the remote server and from the cache.
 162 If those users have higher access privileges on the remote server, they will
 163 get from the cache only a subset of the results they would get directly
 164 from the remote server; but if they have lower access privileges, they will
 165 get from the cache a superset of the results they would get directly
 166 from the remote server.
 167 Either occurrence may or may not be acceptable, based on the security policy
 168 of the cache and of the remote server.
 169 It is important to note that in this case the proxy is violating the security
 170 of the remote server by disclosing to an identity data that was collected
 171 by another identity.
 172 For this reason, it is suggested that, when using
 173 .BR back-ldap ,
 174 proxy caching be used in conjunction with the
 175 .I identity assertion
 176 feature of
 177 .BR slapd-ldap (5)
 178 (see the
 179 .B idassert-bind
 180 and the
 181 .B idassert-authz
 182 statements), so that remote server interrogation occurs with a vanilla identity
 183 that has some relatively high
 184 .B search
 185 and
 186 .B read
 187 access privileges, and the "real" access control is delegated to the proxy's ACLs.
 188 Beware that since only the cached fraction of the real datum is available
 189 to the cache, it may not be possible to enforce the same access rules that
 190 are defined on the remote server.
 191 When security is a concern, cached proxy access must be carefully tailored.
 192 .SH FILES
 193
 194 .TP
 195 ETCDIR/slapd.conf
 196 default slapd configuration file
 197 .SH SEE ALSO
 198 .BR slapd.conf (5),
 199 .BR slapd\-ldap (5),
 200 .BR slapd\-meta (5),
 201 .BR slapd\-sql (5),
 202 .BR slapd (8).
 203 .SH AUTHOR
 204 Originally implemented by Apurva Kumar as an extension to back-meta;
 205 turned into an overlay by Howard Chu.