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