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