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