]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd.conf.5
d42cdfff1d4f278fefb91cbb1db1b468508be0f7
[openldap] / doc / man / man5 / slapd.conf.5
1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4 .\" $OpenLDAP$
5 .SH NAME
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
7 .SH SYNOPSIS
8 ETCDIR/slapd.conf
9 .SH DESCRIPTION
10 The file
11 .B ETCDIR/slapd.conf
12 contains configuration information for the
13 .BR slapd (8)
14 daemon.  This configuration file is also used by the
15 .BR slurpd (8)
16 replication daemon and by the SLAPD tools
17 .BR slapadd (8),
18 .BR slapcat (8),
19 and
20 .BR slapindex (8).
21 .LP
22 The
23 .B slapd.conf
24 file consists of a series of global configuration options that apply to
25 .B slapd
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
28 instance.
29 .LP
30 The general format of
31 .B slapd.conf
32 is as follows:
33 .LP
34 .nf
35     # comment - these options apply to every database
36     <global configuration options>
37     # first database definition & configuration options
38     database    <backend 1 type>
39     <configuration options specific to backend 1>
40     # subsequent database definitions & configuration options
41     ...
42 .fi
43 .LP
44 As many backend-specific sections as desired may be included.  Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
47 .B slapd.conf
48 file is used).  Blank lines and comment lines beginning with a `#'
49 character are ignored. If a line begins with white space, it is
50 considered a continuation of the previous line.
51 .LP
52 Arguments on configuration lines are separated by white space. If an
53 argument contains white space, the argument should be enclosed in
54 double quotes.  If an argument contains a double quote (`"') or a
55 backslash character (`\\'), the character should be preceded by a
56 backslash character.
57 .LP
58 The specific configuration options available are discussed below in the
59 Global Configuration Options, General Backend Options, and General Database
60 Options.  Backend-specific options are discussed in the
61 .B slapd-<backend>(5)
62 manual pages.  Refer to the "OpenLDAP Administrator's Guide" for more
63 details on the slapd configuration file.
64 .SH GLOBAL CONFIGURATION OPTIONS
65 Options described in this section apply to all backends, unless specifically 
66 overridden in a backend definition. Arguments that should be replaced by 
67 actual text are shown in brackets <>.
68 .TP
69 .B access to <what> "[ by <who> <access> <control> ]+"
70 Grant access (specified by <access>) to a set of entries and/or
71 attributes (specified by <what>) by one or more requestors (specified
72 by <who>).
73 See
74 .BR slapd.access (5)
75 and the "OpenLDAP's Administrator's Guide" for details.
76 .TP
77 .B allow <features>
78 Specify a set of features (separated by white space) to
79 allow (default none).
80 .B bind_v2
81 allows acceptance of LDAPv2 bind requests.  Note that
82 .BR slapd (8)
83 does not truely implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
84 .B bind_anon_cred
85 allows anonymous bind when credentials are not empty (e.g.
86 when DN is empty).
87 .B bind_anon_dn
88 allows unauthenticated (anonymous) bind when DN is not empty.
89 .B update_anon
90 allow unauthenticated (anonymous) update operations to be processed
91 (subject to access controls and other administrative limits).
92 .TP
93 .B argsfile <filename>
94 The ( absolute ) name of a file that will hold the 
95 .B slapd
96 server's command line options
97 if started without the debugging command line option.
98 .TP
99 .B attributeoptions [option-name]...
100 Define tagging attribute options or option tag/range prefixes.
101 Options must not end with `-', prefixes must end with `-'.
102 The `lang-' prefix is predefined.
103 If you use the
104 .B attributeoptions
105 directive, `lang-' will no longer be defined and you must specify it
106 explicitly if you want it defined.
107
108 An attribute description with a tagging option is a subtype of that
109 attribute description without the option.
110 Except for that, options defined this way have no special semantics.
111 Prefixes defined this way work like the `lang-' options:
112 They define a prefix for tagging options starting with the prefix.
113 That is, if you define the prefix `x-foo-', you can use the option
114 `x-foo-bar'.
115 Furthermore, in a search or compare, a prefix or range name (with
116 a trailing `-') matches all options starting with that name, as well
117 as the option with the range name sans the trailing `-'.
118 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
119
120 RFC 2251 reserves options beginning with `x-' for private experiments.
121 Other options should be registered with IANA, see RFC 3383 section 3.4.
122 OpenLDAP also has the `binary' option built in, but this is a transfer
123 option, not a tagging option.
124 .HP
125 .hy 0
126 .B attributetype "(\ <oid> [NAME\ <name>] [OBSOLETE]\
127  [DESC\ <description>]\
128  [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
129  [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
130  [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )"
131 .RS
132 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
133 The slapd parser extends the RFC 2252 definition by allowing string
134 forms as well as numeric OIDs to be used for the attribute OID and
135 attribute syntax OID.
136 (See the
137 .B objectidentifier
138 description.) 
139 .RE
140 .TP
141 .B concurrency <integer>
142 Specify a desired level of concurrency.  Provided to the underlying
143 thread system as a hint.  The default is not to provide any hint.
144 .TP
145 .B conn_max_pending <integer>
146 Specify the maximum number of pending requests for an anonymous session.
147 If requests are submitted faster than the server can process them, they
148 will be queued up to this limit. If the limit is exceeded, the session
149 is closed. The default is 100.
150 .TP
151 .B conn_max_pending_auth <integer>
152 Specify the maximum number of pending requests for an authenticated session.
153 The default is 1000.
154 .\".TP
155 .\".B debug <subsys> <level>
156 .\"Specify a logging level for a particular subsystem.  The subsystems include
157 .\".B global
158 .\"a global level for all subsystems,
159 .\".B acl
160 .\"the ACL engine,
161 .\".B backend
162 .\"the backend databases,
163 .\".B cache
164 .\"the entry cache manager,
165 .\".B config
166 .\"the config file reader,
167 .\".B connection
168 .\"the connection manager,
169 .\".B cyrus
170 .\"the Cyrus SASL library interface,
171 .\".B filter
172 .\"the search filter processor,
173 .\".B getdn
174 .\"the DN normalization library,
175 .\".B index
176 .\"the database indexer,
177 .\".B liblber
178 .\"the ASN.1 BER library,
179 .\".B module
180 .\"the dynamic module loader,
181 .\".B operation
182 .\"the LDAP operation processors,
183 .\".B sasl
184 .\"the SASL authentication subsystem,
185 .\".B schema
186 .\"the schema processor, and
187 .\".B tls
188 .\"the TLS library interface. This is not an exhaustive list; there are many
189 .\"other subsystems and more are added over time.
190 .\"
191 .\"The levels are, in order of decreasing priority:
192 .\".B emergency, alert, critical, error, warning, notice, information, entry,
193 .\".B args, results, detail1, detail2
194 .\"An integer may be used instead, with 0 corresponding to
195 .\".B emergency
196 .\"up to 11 for
197 .\".BR detail2 .
198 .\"The
199 .\".B entry
200 .\"level logs function entry points,
201 .\".B args
202 .\"adds function call parameters, and
203 .\".B results
204 .\"adds the function results to the logs.
205 .\"The
206 .\".B detail1
207 .\"and
208 .\".B detail2
209 .\"levels add even more low level detail from individual functions.
210 .TP
211 .B defaultsearchbase <dn>
212 Specify a default search base to use when client submits a
213 non-base search request with an empty base DN.
214 .TP
215 .B disallow <features>
216 Specify a set of features (separated by white space) to
217 disallow (default none).
218 .B bind_anon
219 disables acceptance of anonymous bind requests.
220 .B bind_simple
221 disables simple (bind) authentication.
222 .B bind_krbv4
223 disables Kerberos V4 (bind) authentication.
224 .B tls_2_anon
225 disables Start TLS from forcing session to anonymous status (see also
226 .BR tls_authc ).
227 .B tls_authc
228 disables StartTLS if authenticated (see also
229 .BR tls_2_anon ).
230 .TP
231 .B gentlehup { on | off }
232 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
233 .B Slapd
234 will stop listening for new connections, but will not close the
235 connections to the current clients.  Future write operations return
236 unwilling-to-perform, though.  Slapd terminates when all clients
237 have closed their connections (if they ever do), or \- as before \-
238 if it receives a SIGTERM signal.  This can be useful if you wish to
239 terminate the server and start a new
240 .B slapd
241 server
242 .B with another database,
243 without disrupting the currently active clients.
244 The default is off.  You may wish to use
245 .B idletimeout
246 along with this option.
247 .TP
248 .B idletimeout <integer>
249 Specify the number of seconds to wait before forcibly closing
250 an idle client connection.  A idletimeout of 0 disables this
251 feature.  The default is 0.
252 .TP
253 .B include <filename>
254 Read additional configuration information from the given file before
255 continuing with the next line of the current file.
256 .TP
257 .B limits <who> <limit> [<limit> [...]]
258 Specify time and size limits based on who initiated an operation.
259 The argument
260 .B who
261 can be any of
262 .RS
263 .RS
264 .TP
265 anonymous | users | [dn[.<style>]=]<pattern>
266
267 .RE
268 with
269 .RS
270 .TP
271 <style> ::= exact | base | one | subtree | children | regex | anonymous
272
273 .RE
274 .B Anonymous
275 is hit when a search is performed without prior binding;
276 .B users
277 is hit when a search is performed by a successfully bound user;
278 otherwise a
279 .B regex
280 dn pattern is assumed unless otherwise specified by qualifying 
281 the (optional) key string
282 .B dn
283 with 
284 .B exact
285 or
286 .B base
287 (which are synonims), to require an exact match; with
288 .BR one, 
289 to require exactly one level of depth match; with
290 .BR subtree,
291 to allow any level of depth match, including the exact match; with
292 .BR children,
293 to allow any level of depth match, not including the exact match;
294 .BR regex
295 explicitly requires the (default) match based on regular expression
296 pattern, as detailed in
297 .BR regex (7).
298 Finally,
299 .B anonymous
300 matches unbound operations; the 
301 .B pattern
302 field is ignored.
303 The same behavior is obtained by using the 
304 .B anonymous
305 form of the
306 .B who
307 clause.
308
309 The currently supported limits are 
310 .B size
311 and 
312 .BR time.
313
314 The syntax for time limits is 
315 .BR time[.{soft|hard}]=<integer> ,
316 where 
317 .BR integer
318 is the number of seconds slapd will spend answering a search request.
319 If no time limit is explicitly requested by the client, the 
320 .BR soft
321 limit is used; if the requested time limit exceedes the
322 .BR hard
323 limit, an "Administrative limit exceeded" is returned.
324 If the
325 .BR hard
326 limit is set to 0 or to the keyword "soft", the soft limit is used 
327 in either case; if it is set to -1 or to the keyword "none", 
328 no hard limit is enforced.
329 Explicit requests for time limits smaller or equal to the
330 .BR hard 
331 limit are honored.
332 If no flag is set, the value is assigned to the 
333 .BR soft 
334 limit, and the
335 .BR hard
336 limit is set to zero, to preserve the original behavior.
337
338 The syntax for size limits is
339 .BR size[.{soft|hard|unchecked}]=<integer> ,
340 where
341 .BR integer
342 is the maximum number of entries slapd will return answering a search 
343 request.
344 If no size limit is explicitly requested by the client, the
345 .BR soft
346 limit is used; if the requested size limit exceedes the
347 .BR hard
348 limit, an "Administrative limit exceeded" is returned.
349 If the 
350 .BR hard
351 limit is set to 0 or to the keyword "soft", the soft limit is used 
352 in either case; if it is set to -1 or to the keyword "none", 
353 no hard limit is enforced.
354 Explicit requests for size limits smaller or equal to the
355 .BR hard
356 limit are honored.
357 The
358 .BR unchecked
359 flag sets a limit on the number of candidates a search request is allowed
360 to examine.
361 If the selected candidates exceed the 
362 .BR unchecked
363 limit, the search will abort with "Unwilling to perform".
364 If it is set to -1 or to the keyword "none", no limit is applied (the default).
365 If no flag is set, the value is assigned to the
366 .BR soft 
367 limit, and the
368 .BR hard
369 limit is set to zero, to preserve the original behavior.
370
371 In case of no match, the global limits are used.
372 The default values are the same of
373 .BR sizelimit
374 and
375 .BR timelimit ;
376 no limit is set on 
377 .BR unchecked .
378 .RE
379 .\".TP
380 .\".B logfile <filename>
381 .\"Specify a file for recording debug log messages. By default these messages
382 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
383 .\"copies messages to both stderr and the logfile.
384 .TP
385 .B loglevel <integer>
386 Specify the level at which debugging statements and operation 
387 statistics should be syslogged (currently logged to the
388 .BR syslogd (8) 
389 LOG_LOCAL4 facility).  Log levels are additive, and available levels
390 are:
391 .RS
392 .RS
393 .PD 0
394 .TP
395 .B 1
396 trace function calls
397 .TP
398 .B 2
399 debug packet handling
400 .TP
401 .B 4
402 heavy trace debugging
403 .TP
404 .B 8
405 connection management
406 .TP
407 .B 16
408 print out packets sent and received
409 .TP
410 .B 32
411 search filter processing
412 .TP
413 .B 64
414 configuration file processing
415 .TP
416 .B 128
417 access control list processing
418 .TP
419 .B 256
420 stats log connections/operations/results
421 .TP
422 .B 512
423 stats log entries sent
424 .TP
425 .B 1024
426 print communication with shell backends
427 .TP
428 .B 2048
429 entry parsing
430 .PD
431 .RE
432 .RE
433 .TP
434 .B moduleload <filename>
435 Specify the name of a dynamically loadable module to load. The filename
436 may be an absolute path name or a simple filename. Non-absolute names
437 are searched for in the directories specified by the
438 .B modulepath
439 option. This option and the
440 .B modulepath
441 option are only usable if slapd was compiled with --enable-modules.
442 .TP
443 .B modulepath <pathspec>
444 Specify a list of directories to search for loadable modules. Typically
445 the path is colon-separated but this depends on the operating system.
446 .HP
447 .B objectclass "( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
448  [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
449  [MAY <oids>] )"
450 .RS
451 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
452 The slapd parser extends the RFC 2252 definition by allowing string
453 forms as well as numeric OIDs to be used for the object class OID.
454 (See the
455 .B
456 objectidentifier
457 description.)  Object classes are "STRUCTURAL" by default.
458 .RE
459 .TP
460 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
461 Define a string name that equates to the given OID. The string can be used
462 in place of the numeric OID in objectclass and attribute definitions. The
463 name can also be used with a suffix of the form ":xx" in which case the
464 value "oid.xx" will be used.
465 .TP
466 .B password-hash <hash>
467 This option sets the hash to be used in generation of user
468 passwords, stored in userPassword, during processing of
469 LDAP Password Modify Extended Operations (RFC 3062).
470 The <hash> must be one of
471 .BR {SSHA} ,
472 .BR {SHA} ,
473 .BR {SMD5} ,
474 .BR {MD5} ,
475 .BR {CRYPT} ,
476 and
477 .BR {CLEARTEXT} .
478 The default is
479 .BR {SSHA} .
480
481 .B {SHA}
482 and
483 .B {SSHA}
484 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
485
486 .B {MD5}
487 and
488 .B {SMD5}
489 use the MD5 algorithm (RFC 1321), the latter with a seed.
490
491 .B {CRYPT}
492 uses the
493 .BR crypt (3).
494
495 .B {CLEARTEXT}
496 indicates that the new password should be
497 added to userPassword as clear text.
498
499 Note that this option does not alter the normal user applications
500 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
501 .TP
502 .B password\-crypt\-salt\-format <format>
503 Specify the format of the salt passed to
504 .BR crypt (3)
505 when generating {CRYPT} passwords (see
506 .BR password\-hash )
507 during processing of LDAP Password Modify Extended Operations (RFC 3062).
508
509 This string needs to be in
510 .BR sprintf (3)
511 format and may include one (and only one) %s conversion.
512 This conversion will be substituted with a string random
513 characters from [A\-Za\-z0\-9./].  For example, "%.2s"
514 provides a two character salt and "$1$%.8s" tells some
515 versions of crypt(3) to use an MD5 algorithm and provides
516 8 random characters of salt.  The default is "%s", which
517 provides 31 characters of salt.
518 .TP
519 .B pidfile <filename>
520 The ( absolute ) name of a file that will hold the 
521 .B slapd
522 server's process ID ( see
523 .BR getpid (2)
524 ) if started without the debugging command line option.
525 .TP
526 .B referral <url>
527 Specify the referral to pass back when
528 .BR slapd (8)
529 cannot find a local database to handle a request.
530 If specified multiple times, each url is provided.
531 .TP
532 .B replica-argsfile
533 The ( absolute ) name of a file that will hold the 
534 .B slurpd
535 server's command line options
536 if started without the debugging command line option.
537 .TP
538 .B replica-pidfile
539 The ( absolute ) name of a file that will hold the 
540 .B slurpd
541 server's process ID ( see
542 .BR getpid (2)
543 ) if started without the debugging command line option.
544 .TP
545 .B require <conditions>
546 Specify a set of conditions (separated by white space) to
547 require (default none).
548 The directive may be specified globally and/or per-database.
549 .B bind
550 requires bind operation prior to directory operations.
551 .B LDAPv3
552 requires session to be using LDAP version 3.
553 .B authc
554 requires authentication prior to directory operations.
555 .B SASL
556 requires SASL authentication prior to directory operations.
557 .B strong
558 requires strong authentication prior to directory operations.
559 The strong keyword allows protected "simple" authentication
560 as well as SASL authentication.
561 .B none
562 may be used to require no conditions (useful for clearly globally
563 set conditions within a particular database).
564 .TP
565 .B reverse-lookup on | off
566 Enable/disable client name unverified reverse lookup (default is 
567 .BR off 
568 if compiled with --enable-rlookups).
569 .TP
570 .B rootDSE <file>
571 Specify the name of an LDIF(5) file containing user defined attributes
572 for the root DSE.  These attributes are returned in addition to the
573 attributes normally produced by slapd.
574 .TP
575 .B sasl-authz-policy <policy>
576 Used to specify which rules to use for SASL Proxy Authorization. Proxy
577 authorization allows a client to authenticate to the server using one
578 user's credentials, but specify a different identity to use for authorization
579 and access control purposes. It essentially allows user A to login as user
580 B, using user A's password.
581 The
582 .B none
583 flag disables proxy authorization. This is the default setting.
584 The
585 .B from
586 flag will use rules in the
587 .I saslAuthzFrom
588 attribute of the authorization DN.
589 The
590 .B to
591 flag will use rules in the
592 .I saslAuthzTo
593 attribute of the authentication DN.
594 The
595 .B both
596 flag will allow both of the above. The rules are simply regular expressions
597 specifying which DNs are allowed to perform proxy authorization. The
598 .I saslAuthzFrom
599 attribute in an entry specifies which other users
600 are allowed to proxy login to this entry. The
601 .I saslAuthzTo
602 attribute in
603 an entry specifies which other users this user can authorize as.  Use of
604 .I saslAuthzTo
605 rules can be easily
606 abused if users are allowed to write arbitrary values to this attribute.
607 In general the
608 .I saslAuthzTo
609 attribute must be protected with ACLs such that
610 only privileged users can modify it.
611 .TP
612 .B sasl-host <fqdn>
613 Used to specify the fully qualified domain name used for SASL processing.
614 .TP
615 .B sasl-realm <realm>
616 Specify SASL realm.  Default is empty.
617 .TP
618 .B sasl-regexp <match> <replace>
619 Used by the SASL authorization mechanism to convert a SASL authenticated 
620 username to an LDAP DN. When an authorization request is received, the SASL 
621 .B USERNAME, REALM, 
622 and
623 .B MECHANISM
624 are taken, when available, and combined into a SASL name of the 
625 form
626 .RS
627 .RS
628 .TP
629 .B uid=<username>[,cn=<realm>],cn=<mechanism>,cn=auth
630
631 .RE
632 This SASL name is then compared against the
633 .B match
634 regular expression, and if the match is successful, the SASL name is
635 replaced with the
636 .B replace
637 string. If there are wildcard strings in the 
638 .B match
639 regular expression that are enclosed in parenthesis, e.g. 
640 .RS
641 .RS
642 .TP
643 .B uid=(.*),cn=.*
644
645 .RE
646 .RE
647 then the portion of the SASL name that matched the wildcard will be stored
648 in the numbered placeholder variable $1. If there are other wildcard strings
649 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The 
650 placeholders can then be used in the 
651 .B replace
652 string, e.g. 
653 .RS
654 .RS
655 .TP
656 .B cn=$1,ou=Accounts,dc=$2,dc=$4. 
657
658 .RE
659 .RE
660 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
661 server will use the URI to search its own database, and if the search returns 
662 exactly one entry, the SASL name is replaced by the DN of that entry.
663 Multiple 
664 .B sasl-regexp 
665 options can be given in the configuration file to allow for multiple matching 
666 and replacement patterns. The matching patterns are checked in the order they 
667 appear in the file, stopping at the first successful match.
668
669 .\".B Caution:
670 .\"Because the plus sign + is a character recognized by the regular expression engine,
671 .\"and it will appear in SASL names that include a REALM, be careful to escape the
672 .\"plus sign with a backslash \\+ to remove the character's special meaning.
673 .RE
674 .TP
675 .B sasl-secprops <properties>
676 Used to specify Cyrus SASL security properties.
677 The
678 .B none
679 flag (without any other properities) causes the flag properites
680 default, "noanonymous,noplain", to be cleared.
681 The
682 .B noplain
683 flag disables mechanisms susceptible to simple passive attacks.
684 The
685 .B noactive
686 flag disables mechanisms susceptible to active attacks.
687 The
688 .B nodict
689 flag disables mechanisms susceptible to passive dictionary attacks.
690 The
691 .B noanonymous
692 flag disables mechanisms which support anonymous login.
693 The
694 .B forwardsec
695 flag require forward secrecy between sessions.
696 The
697 .B passcred
698 require mechanisms which pass client credentials (and allow
699 mechanisms which can pass credentials to do so).
700 The
701 .B minssf=<factor> 
702 property specifies the minimum acceptable
703 .I security strength factor
704 as an integer approximate to effective key length used for
705 encryption.  0 (zero) implies no protection, 1 implies integrity
706 protection only, 56 allows DES or other weak ciphers, 112
707 allows triple DES and other strong ciphers, 128 allows RC4,
708 Blowfish and other modern strong ciphers.  The default is 0.
709 The
710 .B maxssf=<factor> 
711 property specifies the maximum acceptable
712 .I security strength factor
713 as an integer (see minssf description).  The default is INT_MAX.
714 The
715 .B maxbufsize=<size> 
716 property specifies the maximum security layer receive buffer
717 size allowed.  0 disables security layers.  The default is 65536.
718 .TP
719 .B schemadn <dn>
720 Specify the distinguished name for the subschema subentry that
721 controls the entries on this server.  The default is "cn=Subschema".
722 .TP
723 .B security <factors>
724 Specify a set of factors (separated by white space) to require.
725 An integer value is associated with each factor and is roughly
726 equivalent of the encryption key length to require.  A value
727 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
728 The directive may be specified globally and/or per-database.
729 .B ssf=<n>
730 specifies the overall security strength factor.
731 .B transport=<n>
732 specifies the transport security strength factor.
733 .B tls=<n>
734 specifies the TLS security strength factor.
735 .B sasl=<n>
736 specifies the SASL security strength factor.
737 .B update_ssf=<n>
738 specifies the overall security strength factor to require for
739 directory updates.
740 .B update_transport=<n>
741 specifies the transport security strength factor to require for
742 directory updates.
743 .B update_tls=<n>
744 specifies the TLS security strength factor to require for
745 directory updates.
746 .B update_sasl=<n>
747 specifies the SASL security strength factor to require for
748 directory updates.
749 .B simple_bind=<n>
750 specifies the security strength factor required for
751 .I simple
752 username/password authentication.
753 Note that the
754 .B transport
755 factor is measure of security provided by the underlying transport,
756 e.g. ldapi:// (and eventually IPSEC).  It is not normally used.
757 .TP
758 .B sizelimit {<integer>|unlimited}
759 .TP
760 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
761 Specify the maximum number of entries to return from a search operation.
762 The default size limit is 500.
763 Use
764 .B -1
765 or 
766 .B unlimited
767 to specify no limits.
768 The second format allows a fine grain setting of the size limits.
769 Extra args can be added on the same line.
770 See
771 .BR limits
772 for an explanation of the different flags.
773 .TP
774 .B sockbuf_max_incoming <integer>
775 Specify the maximum incoming LDAP PDU size for anonymous sessions.
776 The default is 262143.
777 .TP
778 .B sockbuf_max_incoming_auth <integer>
779 Specify the maximum incoming LDAP PDU size for authenticated sessions.
780 The default is 4194303.
781 .TP
782 .B srvtab <filename>
783 Specify the srvtab file in which the kerberos keys necessary for
784 authenticating clients using kerberos can be found. This option is only
785 meaningful if you are using Kerberos authentication.
786 .TP
787 .B threads <integer>
788 Specify the maximum size of the primary thread pool.
789 The default is 16.
790 .TP
791 .B timelimit {<integer>|unlimited}
792 .TP
793 .B timelimit time[.{soft|hard}]=<integer> [...]
794 Specify the maximum number of seconds (in real time)
795 .B slapd
796 will spend answering a search request.  The default time limit is 3600.
797 Use
798 .B -1
799 or 
800 .B unlimited
801 to specify no limits.
802 The second format allows a fine grain setting of the time limits.
803 Extra args can be added on the same line.
804 See
805 .BR limits
806 for an explanation of the different flags.
807 .TP
808 .B ucdata-path <path>
809 Specify the path to the directory containing the Unicode character
810 tables. The default path is LOCALSTATEDIR/ucdata.
811 .SH TLS OPTIONS
812 If
813 .B slapd
814 is built with support for Transport Layer Security, there are more options
815 you can specify.
816 .TP
817 .B TLSCipherSuite <cipher-suite-spec>
818 Permits configuring what ciphers will be accepted and the preference order.
819 <cipher-suite-spec> should be a cipher specification for OpenSSL.  Example:
820
821 TLSCipherSuite HIGH:MEDIUM:+SSLv2
822
823 To check what ciphers a given spec selects, use:
824
825 openssl ciphers -v <cipher-suite-spec>
826 .TP
827 .B TLSCACertificateFile <filename>
828 Specifies the file that contains certificates for all of the Certificate
829 Authorities that
830 .B slapd
831 will recognize.
832 .TP
833 .B TLSCACertificatePath <path>
834 Specifies the path of a directory that contains Certificate Authority
835 certificates in separate individual files. Usually only one of this
836 or the TLSCACertificateFile is used.
837 .TP
838 .B TLSCertificateFile <filename>
839 Specifies the file that contains the
840 .B slapd
841 server certificate.
842 .TP
843 .B TLSCertificateKeyFile <filename>
844 Specifies the file that contains the
845 .B slapd
846 server private key that matches the certificate stored in the
847 .B TLSCertificateFile
848 file.  Currently, the private key must not be protected with a password, so
849 it is of critical importance that it is protected carefully. 
850 .TP
851 .B TLSRandFile <filename>
852 Specifies the file to obtain random bits from when /dev/[u]random
853 is not available.  Generally set to the name of the EGD/PRNGD socket.
854 The environment variable RANDFILE can also be used to specify the filename.
855 .TP
856 .B TLSVerifyClient <level>
857 Specifies what checks to perform on client certificates in an
858 incoming TLS session, if any.
859 The
860 .B <level>
861 can be specified as one of the following keywords:
862 .RS
863 .TP
864 .B never
865 This is the default.
866 .B slapd
867 will not ask the client for a certificate.
868 .TP
869 .B allow
870 The client certificate is requested.  If no certificate is provided,
871 the session proceeds normally.  If a bad certificate is provided,
872 it will be ignored and the session proceeds normally.
873 .TP
874 .B try
875 The client certificate is requested.  If no certificate is provided,
876 the session proceeds normally.  If a bad certificate is provided,
877 the session is immediately terminated.
878 .TP
879 .B demand | hard | true
880 These keywords are all equivalent, for compatibility reasons.
881 The client certificate is requested.  If no certificate is provided,
882 or a bad certificate is provided, the session is immediately terminated.
883
884 Note that a valid client certificate is required in order to use the
885 SASL EXTERNAL authentication mechanism with a TLS session.  As such,
886 a non-default
887 .B TLSVerifyClient
888 setting must be chosen to enable SASL EXTERNAL authentication.
889 .RE
890 .SH GENERAL BACKEND OPTIONS
891 Options in this section only apply to the configuration file section
892 for the specified backend.  They are supported by every
893 type of backend.
894 .TP
895 .B backend <databasetype>
896 Mark the beginning of a backend definition. <databasetype>
897 should be one of
898 .B bdb,
899 .B dnssrv,
900 .B ldap,
901 .B ldbm,
902 .B meta,
903 .B monitor,
904 .B null,
905 .B passwd,
906 .B perl,
907 .B shell,
908 .B sql,
909 or
910 .B tcl,
911 depending on which backend will serve the database.
912
913 .SH GENERAL DATABASE OPTIONS
914 Options in this section only apply to the configuration file section
915 for the database in which they are defined.  They are supported by every
916 type of backend.  Note that the
917 .B database
918 and at least one
919 .B suffix
920 option are mandatory for each database.
921 .TP
922 .B database <databasetype>
923 Mark the beginning of a new database instance definition. <databasetype>
924 should be one of
925 .B bdb,
926 .B dnssrv,
927 .B ldap,
928 .B ldbm,
929 .B meta,
930 .B monitor,
931 .B null,
932 .B passwd,
933 .B perl,
934 .B shell,
935 .B sql,
936 or
937 .B tcl,
938 depending on which backend will serve the database.
939 .TP
940 .B lastmod on | off
941 Controls whether
942 .B slapd
943 will automatically maintain the 
944 modifiersName, modifyTimestamp, creatorsName, and 
945 createTimestamp attributes for entries.  By default, lastmod is on.
946 .TP
947 .B maxderefdepth <depth>
948 Specifies the maximum number of aliases to dereference when trying to
949 resolve an entry, used to avoid inifinite alias loops. The default is 1.
950 .TP
951 .B readonly on | off
952 This option puts the database into "read-only" mode.  Any attempts to 
953 modify the database will return an "unwilling to perform" error.  By
954 default, readonly is off.
955 .HP
956 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
957 .B [tls=yes|critical]
958 .B [suffix=<suffix> [...]]
959 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
960 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
961 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
962 .B [attr[!]=<attr list>]
963 .RS
964 Specify a replication site for this database.  Refer to the "OpenLDAP 
965 Administrator's Guide" for detailed information on setting up a replicated
966 .B slapd
967 directory service. Zero or more
968 .B suffix
969 instances can be used to select the subtrees that will be replicated
970 (defaults to all the database). 
971 .B host
972 is deprecated in favor of the
973 .B uri
974 option.
975 .B uri
976 allows the replica LDAP server to be specified as an LDAP URI. 
977 A
978 .B bindmethod
979 of
980 .B simple
981 requires the options
982 .B binddn 
983 and
984 .B credentials  
985 and should only be used when adequate security services 
986 (e.g TLS or IPSEC) are in place. A
987 .B bindmethod 
988 of
989 .B sasl 
990 requires the option
991 .B saslmech. 
992 Specific security properties (as with the
993 .B sasl-secprops
994 keyword above) for a SASL bind can be set with the
995 .B secprops
996 option. A non-default SASL realm can be set with the
997 .B realm
998 option.
999 If the 
1000 .B mechanism
1001 will use Kerberos, a kerberos instance should be given in 
1002 .B authcId.
1003 An
1004 .B attr list
1005 can be given after the 
1006 .B attr
1007 keyword to allow the selective replication of the listed attributes only;
1008 if the optional 
1009 .B !
1010 mark is used, the list is considered exclusive, i.e. the listed attributes
1011 are not replicated.
1012 If an objectClass is listed, all the related attributes
1013 are (are not) replicated.
1014 .RE
1015 .TP
1016 .B replogfile <filename>
1017 Specify the name of the replication log file to log changes to.  
1018 The replication log is typically written by
1019 .BR slapd (8)
1020 and read by
1021 .BR slurpd (8).
1022 See
1023 .BR slapd.replog (5)
1024 for more information.  The specified file should be located
1025 in a directory with limited read/write/execute access as the replication
1026 logs may contain sensitive information.
1027 .TP
1028 .B rootdn <dn>
1029 Specify the distinguished name that is not subject to access control 
1030 or administrative limit restrictions for operations on this database.
1031 This DN may or may not be associated with an entry.  An empty root
1032 DN (the default) specifies no root access is to be granted.  It is
1033 recommended that the rootdn only be specified when needed (such as
1034 when initially populating a database).  If the rootdn is within
1035 a namingContext (suffix) of the database, a simple bind password
1036 may also be provided using the
1037 .B rootpw
1038 directive.
1039 .TP
1040 .B rootpw <password>
1041 Specify a password (or hash of the password) for the rootdn.  The
1042 password can only be set if the rootdn is within the namingContext
1043 (suffix) of the database.
1044 This option accepts all RFC 2307 userPassword formats known to
1045 the server (see 
1046 .B password-hash
1047 desription) as well as cleartext.
1048 .BR slappasswd (8) 
1049 may be used to generate a hash of a password.  Cleartext
1050 and \fB{CRYPT}\fP passwords are not recommended.  If empty
1051 (the default), authentication of the root DN is by other means
1052 (e.g. SASL).  Use of SASL is encouraged.
1053 .TP
1054 .B suffix <dn suffix>
1055 Specify the DN suffix of queries that will be passed to this 
1056 backend database.  Multiple suffix lines can be given and at least one is 
1057 required for each database definition.
1058 If the suffix of one database is "inside" that of another, the database
1059 with the inner suffix must come first in the configuration file.
1060 .TP
1061 .B subordinate
1062 Specify that the current backend database is a subordinate of another
1063 backend database. A subordinate database may have only one suffix. This
1064 option may be used to glue multiple databases into a single namingContext.
1065 If the suffix of the current database is within the namingContext of a
1066 superior database, searches against the superior database will be
1067 propagated to the subordinate as well. All of the databases
1068 associated with a single namingContext should have identical rootdns.
1069 Behavior of other LDAP operations is unaffected by this setting. In
1070 particular, it is not possible to use moddn to move an entry from
1071 one subordinate to another subordinate within the namingContext.
1072 .TP
1073 .B updatedn <dn>
1074 This option is only applicable in a slave
1075 .B slapd.
1076 It specifies the DN allowed to make changes to the replica (typically,
1077 this is the DN
1078 .BR slurpd (8)
1079 binds as when making changes to the replica).
1080 .TP
1081 .B updateref <url>
1082 Specify the referral to pass back when
1083 .BR slapd (8)
1084 is asked to modify a replicated local database.
1085 If specified multiple times, each url is provided.
1086 .SH DATABASE-SPECIFIC OPTIONS
1087 Each database may allow specific configuration options; they are
1088 documented separately in the
1089 .BR slapd-<backend> (5)
1090 manual pages.
1091 .SH EXAMPLES
1092 .LP
1093 Here is a short example of a configuration file:
1094 .LP
1095 .RS
1096 .nf
1097 include   SYSCONFDIR/schema/core.schema
1098 pidfile   LOCALSTATEDIR/slapd.pid
1099
1100 # Subtypes of "name" (e.g. "cn" and "ou") with the
1101 # option ";x-hidden" can be searched for/compared,
1102 # but are not shown.  See \fBslapd.access\fP(5).
1103 attributeoptions x-hidden lang-
1104 access to attr=name;x-hidden by * =cs
1105
1106 database  bdb
1107 suffix    "dc=our-domain,dc=com"
1108 # The database directory MUST exist prior to
1109 # running slapd AND should only be accessible
1110 # by the slapd/tools. Mode 700 recommended.
1111 directory LOCALSTATEDIR/openldap-data
1112 # Indices to maintain
1113 index     objectClass  eq
1114 index     cn,sn,mail   pres,eq,approx,sub
1115
1116 # We serve small clients that do not handle referrals,
1117 # so handle remote lookups on their behalf.
1118 database  ldap
1119 suffix    ""
1120 uri       ldap://ldap.some-server.com/
1121 lastmod   off
1122 .fi
1123 .RE
1124 .LP
1125 "OpenLDAP Administrator's Guide" contains a longer annotated
1126 example of a configuration file.
1127 The original ETCDIR/slapd.conf is another example.
1128 .SH FILES
1129 .TP
1130 ETCDIR/slapd.conf
1131 default slapd configuration file
1132 .SH SEE ALSO
1133 .BR ldap (3),
1134 .BR slapd-bdb (5),
1135 .BR slapd-dnssrv (5),
1136 .BR slapd-ldap (5),
1137 .BR slapd-ldbm (5),
1138 .BR slapd-meta (5),
1139 .BR slapd-null (5),
1140 .BR slapd-passwd (5),
1141 .BR slapd-perl (5),
1142 .BR slapd-shell (5),
1143 .BR slapd-sql (5),
1144 .BR slapd-tcl (5),
1145 .BR slapd.replog (5),
1146 .BR slapd.access (5),
1147 .BR locale (5),
1148 .BR slapd (8),
1149 .BR slapadd (8),
1150 .BR slapcat (8),
1151 .BR slapindex (8),
1152 .BR slappassword (8),
1153 .BR slurpd (8),
1154 .LP
1155 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1156 .SH ACKNOWLEDGEMENTS
1157 .B      OpenLDAP
1158 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1159 .B      OpenLDAP
1160 is derived from University of Michigan LDAP 3.3 Release.