]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd.conf.5
s/tls/starttls/
[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 RFC2251 reserves options beginning with `x-' for private experiments.
121 Other options should be registered with IANA, see RFC3383 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 The term
275 .B anonymous
276 matches all unauthenticated clients.
277 the term
278 .B users
279 matches all authenticated clients;
280 otherwise a
281 .B regex
282 dn pattern is assumed unless otherwise specified by qualifying 
283 the (optional) key string
284 .B dn
285 with 
286 .B exact
287 or
288 .B base
289 (which are synonims), to require an exact match; with
290 .BR one, 
291 to require exactly one level of depth match; with
292 .BR subtree,
293 to allow any level of depth match, including the exact match; with
294 .BR children,
295 to allow any level of depth match, not including the exact match;
296 .BR regex
297 explicitly requires the (default) match based on regular expression
298 pattern, as detailed in
299 .BR regex (7).
300 Finally,
301 .B anonymous
302 matches unbound operations; the 
303 .B pattern
304 field is ignored.
305 The same behavior is obtained by using the 
306 .B anonymous
307 form of the
308 .B who
309 clause.
310
311 The currently supported limits are 
312 .B size
313 and 
314 .BR time.
315
316 The syntax for time limits is 
317 .BR time[.{soft|hard}]=<integer> ,
318 where 
319 .BR integer
320 is the number of seconds slapd will spend answering a search request.
321 If no time limit is explicitly requested by the client, the 
322 .BR soft
323 limit is used; if the requested time limit exceedes the
324 .BR hard
325 limit, an "Administrative limit exceeded" is returned.
326 If the
327 .BR hard
328 limit is set to 0 or to the keyword "soft", the soft limit is used 
329 in either case; if it is set to -1 or to the keyword "none", 
330 no hard limit is enforced.
331 Explicit requests for time limits smaller or equal to the
332 .BR hard 
333 limit are honored.
334 If no flag is set, the value is assigned to the 
335 .BR soft 
336 limit, and the
337 .BR hard
338 limit is set to zero, to preserve the original behavior.
339
340 The syntax for size limits is
341 .BR size[.{soft|hard|unchecked}]=<integer> ,
342 where
343 .BR integer
344 is the maximum number of entries slapd will return answering a search 
345 request.
346 If no size limit is explicitly requested by the client, the
347 .BR soft
348 limit is used; if the requested size limit exceedes the
349 .BR hard
350 limit, an "Administrative limit exceeded" is returned.
351 If the 
352 .BR hard
353 limit is set to 0 or to the keyword "soft", the soft limit is used 
354 in either case; if it is set to -1 or to the keyword "none", 
355 no hard limit is enforced.
356 Explicit requests for size limits smaller or equal to the
357 .BR hard
358 limit are honored.
359 The
360 .BR unchecked
361 flag sets a limit on the number of candidates a search request is allowed
362 to examine.
363 If the selected candidates exceed the 
364 .BR unchecked
365 limit, the search will abort with "Unwilling to perform".
366 If it is set to -1 or to the keyword "none", no limit is applied (the default).
367 If no flag is set, the value is assigned to the
368 .BR soft 
369 limit, and the
370 .BR hard
371 limit is set to zero, to preserve the original behavior.
372
373 In case of no match, the global limits are used.
374 The default values are the same of
375 .BR sizelimit
376 and
377 .BR timelimit ;
378 no limit is set on 
379 .BR unchecked .
380
381 If 
382 .B pagedResults
383 control is defined, additional size limits may be enforced; the syntax is
384 .BR size.pr={<integer>|noEstimate} ,
385 where
386 .BR integer
387 is the max page size if no explicit limit is set; the keyword
388 .BR noEstimate
389 inhibits the server to return an estimate of the total number
390 of entries that will be returned.
391 .RE
392 .\".TP
393 .\".B logfile <filename>
394 .\"Specify a file for recording debug log messages. By default these messages
395 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
396 .\"copies messages to both stderr and the logfile.
397 .TP
398 .B loglevel <integer>
399 Specify the level at which debugging statements and operation 
400 statistics should be syslogged (currently logged to the
401 .BR syslogd (8) 
402 LOG_LOCAL4 facility).  Log levels are additive, and available levels
403 are:
404 .RS
405 .RS
406 .PD 0
407 .TP
408 .B 1
409 trace function calls
410 .TP
411 .B 2
412 debug packet handling
413 .TP
414 .B 4
415 heavy trace debugging
416 .TP
417 .B 8
418 connection management
419 .TP
420 .B 16
421 print out packets sent and received
422 .TP
423 .B 32
424 search filter processing
425 .TP
426 .B 64
427 configuration file processing
428 .TP
429 .B 128
430 access control list processing
431 .TP
432 .B 256
433 stats log connections/operations/results
434 .TP
435 .B 512
436 stats log entries sent
437 .TP
438 .B 1024
439 print communication with shell backends
440 .TP
441 .B 2048
442 entry parsing
443 .PD
444 .RE
445 .RE
446 .TP
447 .B moduleload <filename>
448 Specify the name of a dynamically loadable module to load. The filename
449 may be an absolute path name or a simple filename. Non-absolute names
450 are searched for in the directories specified by the
451 .B modulepath
452 option. This option and the
453 .B modulepath
454 option are only usable if slapd was compiled with --enable-modules.
455 .TP
456 .B modulepath <pathspec>
457 Specify a list of directories to search for loadable modules. Typically
458 the path is colon-separated but this depends on the operating system.
459 .HP
460 .B objectclass "( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
461  [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
462  [MAY <oids>] )"
463 .RS
464 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
465 The slapd parser extends the RFC 2252 definition by allowing string
466 forms as well as numeric OIDs to be used for the object class OID.
467 (See the
468 .B
469 objectidentifier
470 description.)  Object classes are "STRUCTURAL" by default.
471 .RE
472 .TP
473 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
474 Define a string name that equates to the given OID. The string can be used
475 in place of the numeric OID in objectclass and attribute definitions. The
476 name can also be used with a suffix of the form ":xx" in which case the
477 value "oid.xx" will be used.
478 .TP
479 .B password-hash <hash>
480 This option sets the hash to be used in generation of user
481 passwords, stored in userPassword, during processing of
482 LDAP Password Modify Extended Operations (RFC 3052).
483 The <hash> must be one of
484 .BR {SSHA} ,
485 .BR {SHA} ,
486 .BR {SMD5} ,
487 .BR {MD5} ,
488 .BR {CRYPT} ,
489 and
490 .BR {CLEARTEXT} .
491 The default is
492 .BR {SSHA} .
493
494 .B {SHA}
495 and
496 .B {SSHA}
497 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
498
499 .B {MD5}
500 and
501 .B {SMD5}
502 use the MD5 algorithm (RFC 1321), the latter with a seed.
503
504 .B {CRYPT}
505 uses the
506 .BR crypt (3).
507
508 .B {CLEARTEXT}
509 indicates that the new password should be
510 added to userPassword as clear text.
511
512 Note that this option does not alter the normal user applications
513 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
514 .TP
515 .B password\-crypt\-salt\-format <format>
516 Specify the format of the salt passed to
517 .BR crypt (3)
518 when generating {CRYPT} passwords (see
519 .BR password\-hash )
520 during processing of LDAP Password Modify Extended Operations (RFC 3062).
521
522 This string needs to be in
523 .BR sprintf (3)
524 format and may include one (and only one) %s conversion.
525 This conversion will be substituted with a string random
526 characters from [A\-Za\-z0\-9./].  For example, "%.2s"
527 provides a two character salt and "$1$%.8s" tells some
528 versions of crypt(3) to use an MD5 algorithm and provides
529 8 random characters of salt.  The default is "%s", which
530 provides 31 characters of salt.
531 .TP
532 .B pidfile <filename>
533 The ( absolute ) name of a file that will hold the 
534 .B slapd
535 server's process ID ( see
536 .BR getpid (2)
537 ) if started without the debugging command line option.
538 .TP
539 .B referral <url>
540 Specify the referral to pass back when
541 .BR slapd (8)
542 cannot find a local database to handle a request.
543 If specified multiple times, each url is provided.
544 .TP
545 .B replica-argsfile
546 The ( absolute ) name of a file that will hold the 
547 .B slurpd
548 server's command line options
549 if started without the debugging command line option.
550 .TP
551 .B replica-pidfile
552 The ( absolute ) name of a file that will hold the 
553 .B slurpd
554 server's process ID ( see
555 .BR getpid (2)
556 ) if started without the debugging command line option.
557 .TP
558 .B require <conditions>
559 Specify a set of conditions (separated by white space) to
560 require (default none).
561 The directive may be specified globally and/or per-database.
562 .B bind
563 requires bind operation prior to directory operations.
564 .B LDAPv3
565 requires session to be using LDAP version 3.
566 .B authc
567 requires authentication prior to directory operations.
568 .B SASL
569 requires SASL authentication prior to directory operations.
570 .B strong
571 requires strong authentication prior to directory operations.
572 The strong keyword allows protected "simple" authentication
573 as well as SASL authentication.
574 .B none
575 may be used to require no conditions (useful for clearly globally
576 set conditions within a particular database).
577 .TP
578 .B reverse-lookup on | off
579 Enable/disable client name unverified reverse lookup (default is 
580 .BR off 
581 if compiled with --enable-rlookups).
582 .TP
583 .B rootDSE <file>
584 Specify the name of an LDIF(5) file containing user defined attributes
585 for the root DSE.  These attributes are returned in addition to the
586 attributes normally produced by slapd.
587 .TP
588 .B sasl-authz-policy <policy>
589 Used to specify which rules to use for SASL Proxy Authorization. Proxy
590 authorization allows a client to authenticate to the server using one
591 user's credentials, but specify a different identity to use for authorization
592 and access control purposes. It essentially allows user A to login as user
593 B, using user A's password.
594 The
595 .B none
596 flag disables proxy authorization. This is the default setting.
597 The
598 .B from
599 flag will use rules in the
600 .I saslAuthzFrom
601 attribute of the authorization DN.
602 The
603 .B to
604 flag will use rules in the
605 .I saslAuthzTo
606 attribute of the authentication DN.
607 The
608 .B both
609 flag will allow both of the above. The rules are simply regular expressions
610 specifying which DNs are allowed to perform proxy authorization. The
611 .I saslAuthzFrom
612 attribute in an entry specifies which other users
613 are allowed to proxy login to this entry. The
614 .I saslAuthzTo
615 attribute in
616 an entry specifies which other users this user can authorize as.  Use of
617 .I saslAuthzTo
618 rules can be easily
619 abused if users are allowed to write arbitrary values to this attribute.
620 In general the
621 .I saslAuthzTo
622 attribute must be protected with ACLs such that
623 only privileged users can modify it.
624 .TP
625 .B sasl-host <fqdn>
626 Used to specify the fully qualified domain name used for SASL processing.
627 .TP
628 .B sasl-realm <realm>
629 Specify SASL realm.  Default is empty.
630 .TP
631 .B sasl-regexp <match> <replace>
632 Used by the SASL authorization mechanism to convert a SASL authenticated 
633 username to an LDAP DN. When an authorization request is received, the SASL 
634 .B USERNAME, REALM, 
635 and
636 .B MECHANISM
637 are taken, when available, and combined into a SASL name of the 
638 form
639 .RS
640 .RS
641 .TP
642 .B uid=<username>[,cn=<realm>],cn=<mechanism>,cn=auth
643
644 .RE
645 This SASL name is then compared against the
646 .B match
647 regular expression, and if the match is successful, the SASL name is
648 replaced with the
649 .B replace
650 string. If there are wildcard strings in the 
651 .B match
652 regular expression that are enclosed in parenthesis, e.g. 
653 .RS
654 .RS
655 .TP
656 .B uid=(.*),cn=.*
657
658 .RE
659 .RE
660 then the portion of the SASL name that matched the wildcard will be stored
661 in the numbered placeholder variable $1. If there are other wildcard strings
662 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The 
663 placeholders can then be used in the 
664 .B replace
665 string, e.g. 
666 .RS
667 .RS
668 .TP
669 .B cn=$1,ou=Accounts,dc=$2,dc=$4. 
670
671 .RE
672 .RE
673 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
674 server will use the URI to search its own database, and if the search returns 
675 exactly one entry, the SASL name is replaced by the DN of that entry.
676 Multiple 
677 .B sasl-regexp 
678 options can be given in the configuration file to allow for multiple matching 
679 and replacement patterns. The matching patterns are checked in the order they 
680 appear in the file, stopping at the first successful match.
681
682 .\".B Caution:
683 .\"Because the plus sign + is a character recognized by the regular expression engine,
684 .\"and it will appear in SASL names that include a REALM, be careful to escape the
685 .\"plus sign with a backslash \\+ to remove the character's special meaning.
686 .RE
687 .TP
688 .B sasl-secprops <properties>
689 Used to specify Cyrus SASL security properties.
690 The
691 .B none
692 flag (without any other properities) causes the flag properites
693 default, "noanonymous,noplain", to be cleared.
694 The
695 .B noplain
696 flag disables mechanisms susceptible to simple passive attacks.
697 The
698 .B noactive
699 flag disables mechanisms susceptible to active attacks.
700 The
701 .B nodict
702 flag disables mechanisms susceptible to passive dictionary attacks.
703 The
704 .B noanonymous
705 flag disables mechanisms which support anonymous login.
706 The
707 .B forwardsec
708 flag require forward secrecy between sessions.
709 The
710 .B passcred
711 require mechanisms which pass client credentials (and allow
712 mechanisms which can pass credentials to do so).
713 The
714 .B minssf=<factor> 
715 property specifies the minimum acceptable
716 .I security strength factor
717 as an integer approximate to effective key length used for
718 encryption.  0 (zero) implies no protection, 1 implies integrity
719 protection only, 56 allows DES or other weak ciphers, 112
720 allows triple DES and other strong ciphers, 128 allows RC4,
721 Blowfish and other modern strong ciphers.  The default is 0.
722 The
723 .B maxssf=<factor> 
724 property specifies the maximum acceptable
725 .I security strength factor
726 as an integer (see minssf description).  The default is INT_MAX.
727 The
728 .B maxbufsize=<size> 
729 property specifies the maximum security layer receive buffer
730 size allowed.  0 disables security layers.  The default is 65536.
731 .TP
732 .B schemadn <dn>
733 Specify the distinguished name for the subschema subentry that
734 controls the entries on this server.  The default is "cn=Subschema".
735 .TP
736 .B security <factors>
737 Specify a set of factors (separated by white space) to require.
738 An integer value is associated with each factor and is roughly
739 equivalent of the encryption key length to require.  A value
740 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
741 The directive may be specified globally and/or per-database.
742 .B ssf=<n>
743 specifies the overall security strength factor.
744 .B transport=<n>
745 specifies the transport security strength factor.
746 .B tls=<n>
747 specifies the TLS security strength factor.
748 .B sasl=<n>
749 specifies the SASL security strength factor.
750 .B update_ssf=<n>
751 specifies the overall security strength factor to require for
752 directory updates.
753 .B update_transport=<n>
754 specifies the transport security strength factor to require for
755 directory updates.
756 .B update_tls=<n>
757 specifies the TLS security strength factor to require for
758 directory updates.
759 .B update_sasl=<n>
760 specifies the SASL security strength factor to require for
761 directory updates.
762 .B simple_bind=<n>
763 specifies the security strength factor required for
764 .I simple
765 username/password authentication.
766 Note that the
767 .B transport
768 factor is measure of security provided by the underlying transport,
769 e.g. ldapi:// (and eventually IPSEC).  It is not normally used.
770 .TP
771 .B sizelimit {<integer>|unlimited}
772 .TP
773 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
774 Specify the maximum number of entries to return from a search operation.
775 The default size limit is 500.
776 Use
777 .B -1
778 or 
779 .B unlimited
780 to specify no limits.
781 The second format allows a fine grain setting of the size limits.
782 Extra args can be added on the same line.
783 See
784 .BR limits
785 for an explanation of the different flags.
786 .TP
787 .B sockbuf_max_incoming <integer>
788 Specify the maximum incoming LDAP PDU size for anonymous sessions.
789 The default is 262143.
790 .TP
791 .B sockbuf_max_incoming_auth <integer>
792 Specify the maximum incoming LDAP PDU size for authenticated sessions.
793 The default is 4194303.
794 .TP
795 .B srvtab <filename>
796 Specify the srvtab file in which the kerberos keys necessary for
797 authenticating clients using kerberos can be found. This option is only
798 meaningful if you are using Kerberos authentication.
799 .TP
800 .B threads <integer>
801 Specify the maximum size of the primary thread pool.
802 The default is 16.
803 .TP
804 .B timelimit {<integer>|unlimited}
805 .TP
806 .B timelimit time[.{soft|hard}]=<integer> [...]
807 Specify the maximum number of seconds (in real time)
808 .B slapd
809 will spend answering a search request.  The default time limit is 3600.
810 Use
811 .B -1
812 or 
813 .B unlimited
814 to specify no limits.
815 The second format allows a fine grain setting of the time limits.
816 Extra args can be added on the same line.
817 See
818 .BR limits
819 for an explanation of the different flags.
820 .TP
821 .B ucdata-path <path>
822 Specify the path to the directory containing the Unicode character
823 tables. The default path is LOCALSTATEDIR/ucdata.
824 .SH TLS OPTIONS
825 If
826 .B slapd
827 is built with support for Transport Layer Security, there are more options
828 you can specify.
829 .TP
830 .B TLSCipherSuite <cipher-suite-spec>
831 Permits configuring what ciphers will be accepted and the preference order.
832 <cipher-suite-spec> should be a cipher specification for OpenSSL.  Example:
833
834 TLSCipherSuite HIGH:MEDIUM:+SSLv2
835
836 To check what ciphers a given spec selects, use:
837
838 openssl ciphers -v <cipher-suite-spec>
839 .TP
840 .B TLSCACertificateFile <filename>
841 Specifies the file that contains certificates for all of the Certificate
842 Authorities that
843 .B slapd
844 will recognize.
845 .TP
846 .B TLSCACertificatePath <path>
847 Specifies the path of a directory that contains Certificate Authority
848 certificates in separate individual files. Usually only one of this
849 or the TLSCACertificateFile is used.
850 .TP
851 .B TLSCertificateFile <filename>
852 Specifies the file that contains the
853 .B slapd
854 server certificate.
855 .TP
856 .B TLSCertificateKeyFile <filename>
857 Specifies the file that contains the
858 .B slapd
859 server private key that matches the certificate stored in the
860 .B TLSCertificateFile
861 file.  Currently, the private key must not be protected with a password, so
862 it is of critical importance that it is protected carefully. 
863 .TP
864 .B TLSRandFile <filename>
865 Specifies the file to obtain random bits from when /dev/[u]random
866 is not available.  Generally set to the name of the EGD/PRNGD socket.
867 The environment variable RANDFILE can also be used to specify the filename.
868 .TP
869 .B TLSVerifyClient <level>
870 Specifies what checks to perform on client certificates in an
871 incoming TLS session, if any.
872 The
873 .B <level>
874 can be specified as one of the following keywords:
875 .RS
876 .TP
877 .B never
878 This is the default.
879 .B slapd
880 will not ask the client for a certificate.
881 .TP
882 .B allow
883 The client certificate is requested.  If no certificate is provided,
884 the session proceeds normally.  If a bad certificate is provided,
885 it will be ignored and the session proceeds normally.
886 .TP
887 .B try
888 The client certificate is requested.  If no certificate is provided,
889 the session proceeds normally.  If a bad certificate is provided,
890 the session is immediately terminated.
891 .TP
892 .B demand | hard | true
893 These keywords are all equivalent, for compatibility reasons.
894 The client certificate is requested.  If no certificate is provided,
895 or a bad certificate is provided, the session is immediately terminated.
896
897 Note that a valid client certificate is required in order to use the
898 SASL EXTERNAL authentication mechanism with a TLS session.  As such,
899 a non-default
900 .B TLSVerifyClient
901 setting must be chosen to enable SASL EXTERNAL authentication.
902 .RE
903 .SH GENERAL BACKEND OPTIONS
904 Options in this section only apply to the configuration file section
905 for the specified backend.  They are supported by every
906 type of backend.
907 .TP
908 .B backend <databasetype>
909 Mark the beginning of a backend definition. <databasetype>
910 should be one of
911 .B bdb,
912 .B dnssrv,
913 .B ldap,
914 .B ldbm,
915 .B meta,
916 .B monitor,
917 .B null,
918 .B passwd,
919 .B perl,
920 .B shell,
921 .B sql,
922 or
923 .B tcl,
924 depending on which backend will serve the database.
925
926 .SH GENERAL DATABASE OPTIONS
927 Options in this section only apply to the configuration file section
928 for the database in which they are defined.  They are supported by every
929 type of backend.  Note that the
930 .B database
931 and at least one
932 .B suffix
933 option are mandatory for each database.
934 .TP
935 .B database <databasetype>
936 Mark the beginning of a new database instance definition. <databasetype>
937 should be one of
938 .B bdb,
939 .B dnssrv,
940 .B ldap,
941 .B ldbm,
942 .B meta,
943 .B monitor,
944 .B null,
945 .B passwd,
946 .B perl,
947 .B shell,
948 .B sql,
949 or
950 .B tcl,
951 depending on which backend will serve the database.
952 .TP
953 .B lastmod on | off
954 Controls whether
955 .B slapd
956 will automatically maintain the 
957 modifiersName, modifyTimestamp, creatorsName, and 
958 createTimestamp attributes for entries.  By default, lastmod is on.
959 .TP
960 .B maxderefdepth <depth>
961 Specifies the maximum number of aliases to dereference when trying to
962 resolve an entry, used to avoid inifinite alias loops. The default is 1.
963 .TP
964 .B readonly on | off
965 This option puts the database into "read-only" mode.  Any attempts to 
966 modify the database will return an "unwilling to perform" error.  By
967 default, readonly is off.
968 .HP
969 .B replica host=<hostname>[:port] [starttls=yes|critical]
970 .B [suffix=<suffix> [...]]
971 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
972 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
973 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
974 .B [attr[!]=<attr list>]
975 .RS
976 Specify a replication site for this database.  Refer to the "OpenLDAP 
977 Administrator's Guide" for detailed information on setting up a replicated
978 .B slapd
979 directory service. Zero or more
980 .B suffix
981 instances can be used to select the subtrees that will be replicated
982 (defaults to all the database). A
983 .B bindmethod
984 of
985 .B simple
986 requires the options
987 .B binddn 
988 and
989 .B credentials  
990 and should only be used when adequate security services 
991 (e.g TLS or IPSEC) are in place. A
992 .B bindmethod 
993 of
994 .B sasl 
995 requires the option
996 .B saslmech. 
997 Specific security properties (as with the
998 .B sasl-secprops
999 keyword above) for a SASL bind can be set with the
1000 .B secprops
1001 option. A non-default SASL realm can be set with the
1002 .B realm
1003 option.
1004 If the 
1005 .B mechanism
1006 will use Kerberos, a kerberos instance should be given in 
1007 .B authcId.
1008 An
1009 .B attr list
1010 can be given after the 
1011 .B attr
1012 keyword to allow the selective replication of the listed attributes only;
1013 if the optional 
1014 .B !
1015 mark is used, the list is considered exclusive, i.e. the listed attributes
1016 are not replicated.
1017 If an objectClass is listed, all the related attributes
1018 are (are not) replicated.
1019 .RE
1020 .TP
1021 .B replogfile <filename>
1022 Specify the name of the replication log file to log changes to.  
1023 The replication log is typically written by
1024 .BR slapd (8)
1025 and read by
1026 .BR slurpd (8).
1027 See
1028 .BR slapd.replog (5)
1029 for more information.  The specified file should be located
1030 in a directory with limited read/write/execute access as the replication
1031 logs may contain sensitive information.
1032 .TP
1033 .B rootdn <dn>
1034 Specify the distinguished name that is not subject to access control 
1035 or administrative limit restrictions for operations on this database.
1036 This DN may or may not be associated with an entry.  An empty root
1037 DN (the default) specifies no root access is to be granted.  It is
1038 recommended that the rootdn only be specified when needed (such as
1039 when initially populating a database).  If the rootdn is within
1040 a namingContext (suffix) of the database, a simple bind password
1041 may also be provided using the
1042 .B rootpw
1043 directive.
1044 .TP
1045 .B rootpw <password>
1046 Specify a password (or hash of the password) for the rootdn.  The
1047 password can only be set if the rootdn is within the namingContext
1048 (suffix) of the database.
1049 This option accepts all RFC 2307 userPassword formats known to
1050 the server (see 
1051 .B password-hash
1052 desription) as well as cleartext.
1053 .BR slappasswd (8) 
1054 may be used to generate a hash of a password.  Cleartext
1055 and \fB{CRYPT}\fP passwords are not recommended.  If empty
1056 (the default), authentication of the root DN is by other means
1057 (e.g. SASL).  Use of SASL is encouraged.
1058 .TP
1059 .B suffix <dn suffix>
1060 Specify the DN suffix of queries that will be passed to this 
1061 backend database.  Multiple suffix lines can be given and at least one is 
1062 required for each database definition.
1063 If the suffix of one database is "inside" that of another, the database
1064 with the inner suffix must come first in the configuration file.
1065 .TP
1066 .B subordinate
1067 Specify that the current backend database is a subordinate of another
1068 backend database. A subordinate database may have only one suffix. This
1069 option may be used to glue multiple databases into a single namingContext.
1070 If the suffix of the current database is within the namingContext of a
1071 superior database, searches against the superior database will be
1072 propagated to the subordinate as well. All of the databases
1073 associated with a single namingContext should have identical rootdns.
1074 Behavior of other LDAP operations is unaffected by this setting. In
1075 particular, it is not possible to use moddn to move an entry from
1076 one subordinate to another subordinate within the namingContext.
1077 .TP
1078 .B updatedn <dn>
1079 This option is only applicable in a slave
1080 .B slapd. 
1081 It specifies the DN permitted to update (subject to access controls)
1082 the replica (typically, this is the DN
1083 .BR slurpd (8)
1084 binds to update the replica).
1085 .TP
1086 .B updateref <url>
1087 Specify the referral to pass back when
1088 .BR slapd (8)
1089 is asked to modify a replicated local database.
1090 If specified multiple times, each url is provided.
1091 .SH DATABASE-SPECIFIC OPTIONS
1092 Each database may allow specific configuration options; they are
1093 documented separately in the
1094 .BR slapd-<backend> (5)
1095 manual pages.
1096 .SH EXAMPLES
1097 .LP
1098 Here is a short example of a configuration file:
1099 .LP
1100 .RS
1101 .nf
1102 include   SYSCONFDIR/schema/core.schema
1103 pidfile   LOCALSTATEDIR/slapd.pid
1104
1105 # Subtypes of "name" (e.g. "cn" and "ou") with the
1106 # option ";x-hidden" can be searched for/compared,
1107 # but are not shown.  See \fBslapd.access\fP(5).
1108 attributeoptions x-hidden lang-
1109 access to attr=name;x-hidden by * =cs
1110
1111 database  bdb
1112 suffix    "dc=our-domain,dc=com"
1113 # The database directory MUST exist prior to
1114 # running slapd AND should only be accessible
1115 # by the slapd/tools. Mode 700 recommended.
1116 directory LOCALSTATEDIR/openldap-data
1117 # Indices to maintain
1118 index     objectClass  eq
1119 index     cn,sn,mail   pres,eq,approx,sub
1120
1121 # We serve small clients that do not handle referrals,
1122 # so handle remote lookups on their behalf.
1123 database  ldap
1124 suffix    ""
1125 uri       ldap://ldap.some-server.com/
1126 lastmod   off
1127 .fi
1128 .RE
1129 .LP
1130 "OpenLDAP Administrator's Guide" contains a longer annotated
1131 example of a configuration file.
1132 The original ETCDIR/slapd.conf is another example.
1133 .SH FILES
1134 .TP
1135 ETCDIR/slapd.conf
1136 default slapd configuration file
1137 .SH SEE ALSO
1138 .BR ldap (3),
1139 .BR slapd-bdb (5),
1140 .BR slapd-dnssrv (5),
1141 .BR slapd-ldap (5),
1142 .BR slapd-ldbm (5),
1143 .BR slapd-meta (5),
1144 .BR slapd-null (5),
1145 .BR slapd-passwd (5),
1146 .BR slapd-perl (5),
1147 .BR slapd-shell (5),
1148 .BR slapd-sql (5),
1149 .BR slapd-tcl (5),
1150 .BR slapd.replog (5),
1151 .BR slapd.access (5),
1152 .BR locale (5),
1153 .BR slapd (8),
1154 .BR slapadd (8),
1155 .BR slapcat (8),
1156 .BR slapindex (8),
1157 .BR slappasswd (8),
1158 .BR slurpd (8),
1159 .LP
1160 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1161 .SH ACKNOWLEDGEMENTS
1162 .B      OpenLDAP
1163 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1164 .B      OpenLDAP
1165 is derived from University of Michigan LDAP 3.3 Release.