Skip to content
Snippets Groups Projects
slapd.conf.5 54 KiB
Newer Older
  • Learn to ignore specific revisions
  • .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
    
    .\" $OpenLDAP$
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .SH NAME
    slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
    .SH SYNOPSIS
    ETCDIR/slapd.conf
    .SH DESCRIPTION
    The file
    .B ETCDIR/slapd.conf
    contains configuration information for the
    .BR slapd (8)
    daemon.  This configuration file is also used by the
    .BR slurpd (8)
    
    replication daemon and by the SLAPD tools
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .BR slapacl (8),
    
    .BR slapadd (8),
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .BR slapauth (8),
    
    .BR slapcat (8),
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .BR slapdn (8),
    .BR slapindex (8),
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    and
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .BR slaptest (8).
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .LP
    The
    .B slapd.conf
    file consists of a series of global configuration options that apply to
    .B slapd
    as a whole (including all backends), followed by zero or more database
    backend definitions that contain information specific to a backend
    instance.
    
    The configuration options are case-insensitive;
    their value, on a case by case basis, may be case-sensitive.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .LP
    The general format of
    .B slapd.conf
    is as follows:
    .LP
    .nf
        # comment - these options apply to every database
        <global configuration options>
        # first database definition & configuration options
    
        database <backend 1 type>
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
        <configuration options specific to backend 1>
        # subsequent database definitions & configuration options
        ...
    .fi
    .LP
    As many backend-specific sections as desired may be included.  Global
    options can be overridden in a backend (for options that appear more
    than once, the last appearance in the
    .B slapd.conf
    
    file is used).
    .LP
    If a line begins with white space, it is considered a continuation
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    of the previous line.  No physical line should be over 2000 bytes
    long.
    .LP
    Blank lines and comment lines beginning with
    
    a `#' character are ignored.  Note: continuation lines are unwrapped
    before comment processing is applied.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .LP
    Arguments on configuration lines are separated by white space. If an
    argument contains white space, the argument should be enclosed in
    double quotes.  If an argument contains a double quote (`"') or a
    backslash character (`\\'), the character should be preceded by a
    backslash character.
    .LP
    The specific configuration options available are discussed below in the
    
    Global Configuration Options, General Backend Options, and General Database
    Options.  Backend-specific options are discussed in the
    .B slapd-<backend>(5)
    manual pages.  Refer to the "OpenLDAP Administrator's Guide" for more
    details on the slapd configuration file.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .SH GLOBAL CONFIGURATION OPTIONS
    Options described in this section apply to all backends, unless specifically 
    overridden in a backend definition. Arguments that should be replaced by 
    actual text are shown in brackets <>.
    .TP
    
    .B access to <what> "[ by <who> <access> <control> ]+"
    
    Grant access (specified by <access>) to a set of entries and/or
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    attributes (specified by <what>) by one or more requestors (specified
    
    If no access controls are present, the default policy
    allows anyone and everyone to read anything but restricts
    updates to rootdn.  (e.g., "access to * by * read").
    The rootdn can always read and write EVERYTHING!
    
    See
    .BR slapd.access (5)
    and the "OpenLDAP's Administrator's Guide" for details.
    
    Specify a set of features (separated by white space) to
    allow (default none).
    
    .B bind_v2
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    allows acceptance of LDAPv2 bind requests.  Note that
    .BR slapd (8)
    
    does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
    
    .B bind_anon_cred
    
    Howard Chu's avatar
    Howard Chu committed
    allows anonymous bind when credentials are not empty (e.g.
    
    when DN is empty).
    .B bind_anon_dn
    allows unauthenticated (anonymous) bind when DN is not empty.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B update_anon
    
    allows unauthenticated (anonymous) update operations to be processed
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    (subject to access controls and other administrative limits).
    
    .B proxy_authz_anon
    allows unauthenticated (anonymous) proxy authorization control to be processed
    (subject to access controls, authorization and other administrative limits).
    
    .B argsfile <filename>
    The ( absolute ) name of a file that will hold the 
    .B slapd
    server's command line options
    if started without the debugging command line option.
    
    .TP
    .B attributeoptions [option-name]...
    Define tagging attribute options or option tag/range prefixes.
    Options must not end with `-', prefixes must end with `-'.
    The `lang-' prefix is predefined.
    If you use the
    .B attributeoptions
    directive, `lang-' will no longer be defined and you must specify it
    explicitly if you want it defined.
    
    An attribute description with a tagging option is a subtype of that
    attribute description without the option.
    Except for that, options defined this way have no special semantics.
    Prefixes defined this way work like the `lang-' options:
    They define a prefix for tagging options starting with the prefix.
    That is, if you define the prefix `x-foo-', you can use the option
    `x-foo-bar'.
    Furthermore, in a search or compare, a prefix or range name (with
    a trailing `-') matches all options starting with that name, as well
    as the option with the range name sans the trailing `-'.
    That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
    
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    RFC 4520 reserves options beginning with `x-' for private experiments.
    Other options should be registered with IANA, see RFC 4520 section 3.5.
    
    OpenLDAP also has the `binary' option built in, but this is a transfer
    option, not a tagging option.
    
    .B attributetype "(\ <oid>\
     [NAME\ <name>]\
    
     [DESC\ <description>]\
    
     [OBSOLETE]\
     [SUP\ <oid>]\
     [EQUALITY\ <oid>]\
     [ORDERING\ <oid>]\
     [SUBSTR\ <oid>]\
     [SYNTAX\ <oidlen>]\
     [SINGLE\-VALUE]\
     [COLLECTIVE]\
     [NO\-USER\-MODIFICATION]\
     [USAGE\ <attributeUsage>]\ )"
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
    The slapd parser extends the RFC 4512 definition by allowing string
    
    forms as well as numeric OIDs to be used for the attribute OID and
    attribute syntax OID.
    
    .B objectidentifier
    
    .B authz-policy <policy>
    Used to specify which rules to use for Proxy Authorization.  Proxy
    authorization allows a client to authenticate to the server using one
    user's credentials, but specify a different identity to use for authorization
    and access control purposes. It essentially allows user A to login as user
    B, using user A's password.
    The
    .B none
    flag disables proxy authorization. This is the default setting.
    The
    .B from
    flag will use rules in the
    .I authzFrom
    attribute of the authorization DN.
    The
    .B to
    flag will use rules in the
    .I authzTo
    attribute of the authentication DN.
    The
    .B any
    flag, an alias for the deprecated value of
    .BR both ,
    will allow any of the above, whatever succeeds first (checked in
    .BR to ,
    .B from
    sequence.
    The
    .B all
    flag requires both authorizations to succeed.
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .LP
    .RS
    The rules are mechanisms to specify which identities are allowed 
    
    to perform proxy authorization.
    The
    .I authzFrom
    attribute in an entry specifies which other users
    are allowed to proxy login to this entry. The
    .I authzTo
    attribute in
    an entry specifies which other users this user can authorize as.  Use of
    .I authzTo
    rules can be easily
    abused if users are allowed to write arbitrary values to this attribute.
    In general the
    .I authzTo
    attribute must be protected with ACLs such that
    only privileged users can modify it.
    The value of
    .I authzFrom
    and
    .I authzTo
    describes an 
    .B identity 
    
    Quanah Gibson-Mount's avatar
    Quanah Gibson-Mount committed
    or a set of identities; it can take five forms:
    
    .RS
    .TP
    .B ldap:///<base>??[<scope>]?<filter>
    .RE
    .RS
    .B dn[.<dnstyle>]:<pattern>
    .RE
    .RS
    .B u[<mech>[<realm>]]:<pattern>
    .RE
    .RS
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .B group[/objectClass[/attributeType]]:<pattern>
    .RE
    .RS
    
    .B <pattern>
    .RE
    .RS
    
    .B <dnstyle>:={exact|onelevel|children|subtree|regex}
    
    .RE
    The first form is a valid LDAP
    .B URI
    where the 
    .IR <host>:<port> ,
    the
    .I <attrs>
    and the
    .I <extensions>
    portions must be absent, so that the search occurs locally on either
    .I authzFrom
    or 
    .IR authzTo .
    The second form is a 
    .BR DN ,
    with the optional style modifiers
    .IR exact ,
    .IR onelevel ,
    .IR children ,
    and
    .I subtree
    for exact, onelevel, children and subtree matches, which cause 
    .I <pattern>
    to be normalized according to the DN normalization rules, or the special
    .I regex
    
    style, which causes the
    
    to be treated as a POSIX (''extended'') regular expression, as
    discussed in
    .BR regex (7)
    and/or
    .BR re_format (7).
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    A pattern of
    .I *
    means any non-anonymous DN.
    
    The third form is a SASL
    .BR id ,
    with the optional fields
    .I <mech>
    and
    .I <realm>
    that allow to specify a SASL
    .BR mechanism ,
    and eventually a SASL
    .BR realm ,
    for those mechanisms that support one.
    The need to allow the specification of a mechanism is still debated, 
    and users are strongly discouraged to rely on this possibility.
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    The fourth form is a group specification, consisting of the keyword
    .BR group ,
    optionally followed by the specification of the group
    .B objectClass
    and member
    .BR attributeType .
    The group with DN
    .B <pattern>
    is searched with base scope, and in case of match, the values of the
    member
    .B attributeType
    are searched for the asserted DN.
    
    For backwards compatibility, if no identity type is provided, i.e. only
    .B <pattern>
    is present, an
    .I exact DN
    is assumed; as a consequence, 
    .B <pattern>
    is subjected to DN normalization.
    Since the interpretation of
    .I authzFrom
    and
    .I authzTo
    can impact security, users are strongly encouraged 
    to explicitly set the type of identity specification that is being used.
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    A subset of these rules can be used as third arg in the 
    .B authz-regexp
    statement (see below); significantly, the 
    .I URI
    and the
    .I dn.exact:<dn> 
    forms.
    
    .RE
    .TP
    .B authz-regexp <match> <replace>
    Used by the authentication framework to convert simple user names,
    such as provided by SASL subsystem, to an LDAP DN used for
    authorization purposes.  Note that the resultant DN need not refer
    to an existing entry to be considered valid.  When an authorization
    request is received from the SASL subsystem, the SASL 
    .BR USERNAME ,
    .BR REALM , 
    and
    .B MECHANISM
    are taken, when available, and combined into a name of the form
    .RS
    .RS
    .TP
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
    
    
    .RE
    This name is then compared against the
    .B match
    
    POSIX (''extended'') regular expression, and if the match is successful,
    the name is replaced with the
    
    .B replace
    string.  If there are wildcard strings in the 
    .B match
    regular expression that are enclosed in parenthesis, e.g. 
    .RS
    .TP
    .B UID=([^,]*),CN=.*
    
    .RE
    then the portion of the name that matched the wildcard will be stored
    in the numbered placeholder variable $1. If there are other wildcard strings
    in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The 
    placeholders can then be used in the 
    .B replace
    string, e.g. 
    .RS
    .TP
    .B UID=$1,OU=Accounts,DC=example,DC=com 
    
    .RE
    
    The replaced name can be either a DN, i.e. a string prefixed by "dn:",
    or an LDAP URI.
    If the latter, the server will use the URI to search its own database(s)
    
    and, if the search returns exactly one entry, the name is
    replaced by the DN of that entry.   The LDAP URI must have no
    
    hostport, attrs, or extensions components, but the filter is mandatory,
    e.g.
    
    .RS
    .TP
    .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
    
    .RE
    
    The protocol portion of the URI must be strictly
    .BR ldap .
    
    Note that this search is subject to access controls.  Specifically,
    the authentication identity must have "auth" access in the subject.
    
    Multiple 
    .B authz-regexp 
    options can be given in the configuration file to allow for multiple matching 
    and replacement patterns. The matching patterns are checked in the order they 
    appear in the file, stopping at the first successful match.
    
    .\".B Caution:
    .\"Because the plus sign + is a character recognized by the regular expression engine,
    .\"and it will appear in names that include a REALM, be careful to escape the
    .\"plus sign with a backslash \\+ to remove the character's special meaning.
    .RE
    .TP
    
    .B concurrency <integer>
    Specify a desired level of concurrency.  Provided to the underlying
    
    thread system as a hint.  The default is not to provide any hint.
    
    .TP
    .B conn_max_pending <integer>
    Specify the maximum number of pending requests for an anonymous session.
    If requests are submitted faster than the server can process them, they
    will be queued up to this limit. If the limit is exceeded, the session
    is closed. The default is 100.
    .TP
    .B conn_max_pending_auth <integer>
    Specify the maximum number of pending requests for an authenticated session.
    The default is 1000.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    
    .B defaultsearchbase <dn>
    Specify a default search base to use when client submits a
    non-base search request with an empty base DN.
    
    Base scoped search requests with an empty base DN are not affected.
    
    Specify a set of features (separated by white space) to
    disallow (default none).
    
    disables acceptance of anonymous bind requests.  Note that this setting
    does not prohibit anonymous directory access (See "require authc").
    
    .B bind_simple
    disables simple (bind) authentication.
    
    .B tls_2_anon
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    disables forcing session to anonymous status (see also
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    .BR tls_authc )
    upon StartTLS operation receipt.
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    disallows the StartTLS operation if authenticated (see also
    
    .HP
    .hy 0
    .B ditcontentrule "(\ <oid>\
     [NAME\ <name>]\
     [DESC\ <description>]\
     [OBSOLETE]\
     [AUX\ <oids>]\
     [MUST\ <oids>]\
     [MAY\ <oids>]\
     [NOT\ <oids>]\ )"
    .RS
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
    The slapd parser extends the RFC 4512 definition by allowing string
    
    forms as well as numeric OIDs to be used for the attribute OID and
    attribute syntax OID.
    (See the
    .B objectidentifier
    description.) 
    .RE
    
    .B gentlehup { on | off }
    A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
    .B Slapd
    will stop listening for new connections, but will not close the
    
    connections to the current clients.  Future write operations return
    unwilling-to-perform, though.  Slapd terminates when all clients
    
    have closed their connections (if they ever do), or \- as before \-
    if it receives a SIGTERM signal.  This can be useful if you wish to
    terminate the server and start a new
    .B slapd
    server
    .B with another database,
    without disrupting the currently active clients.
    The default is off.  You may wish to use
    .B idletimeout
    along with this option.
    .TP
    
    .B idletimeout <integer>
    Specify the number of seconds to wait before forcibly closing
    
    an idle client connection.  A idletimeout of 0 disables this
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B include <filename>
    Read additional configuration information from the given file before
    continuing with the next line of the current file.
    
    Howard Chu's avatar
    Howard Chu committed
    .TP
    .B index_substr_if_minlen <integer>
    Specify the minimum length for subinitial and subfinal indices. An
    attribute value must have at least this many characters in order to be
    processed by the indexing functions. The default is 2.
    .TP
    .B index_substr_if_maxlen <integer>
    Specify the maximum length for subinitial and subfinal indices. Only
    this many characters of an attribute value will be processed by the
    indexing functions; any excess characters are ignored. The default is 4.
    .TP
    .B index_substr_any_len <integer>
    Specify the length used for subany indices. An attribute value must have
    at least this many characters in order to be processed. Attribute values
    longer than this length will be processed in segments of this length. The
    default is 4. The subany index will also be used in subinitial and
    subfinal index lookups when the filter string is longer than the
    .I index_substr_if_maxlen
    value.
    .TP
    .B index_substr_any_step <integer>
    Specify the steps used in subany index lookups. This value sets the offset
    for the segments of a filter string that are processed for a subany index
    lookup. The default is 2. For example, with the default values, a search
    using this filter "cn=*abcdefgh*" would generate index lookups for
    "abcd", "cdef", and "efgh".
    
    
    .\".TP
    .\".B logfile <filename>
    .\"Specify a file for recording debug log messages. By default these messages
    .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
    .\"copies messages to both stderr and the logfile.
    
    .B localSSF <SSF>
    Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
    such as those to the ldapi:// listener.  For a description of SSF values,
    see 
    .BR sasl-secprops 's
    .B minssf
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    option description.  The default is 71.
    
    .B loglevel <integer> [...]
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify the level at which debugging statements and operation 
    statistics should be syslogged (currently logged to the
    .BR syslogd (8) 
    
    LOG_LOCAL4 facility).
    They must be considered subsystems rather than increasingly verbose 
    log levels.
    Some messages with higher priority are logged regardless 
    of the configured loglevel as soon as some logging is configured,
    otherwise anything is logged at all.
    Log levels are additive, and available levels are:
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .RS
    .RS
    .PD 0
    .TP
    .B 1
    
    .B (0x1 trace)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    trace function calls
    .TP
    .B 2
    
    .B (0x2 packets)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    debug packet handling
    .TP
    .B 4
    
    .B (0x4 args)
    heavy trace debugging (function args)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    .B 8
    
    .B (0x8 conns)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    connection management
    .TP
    .B 16
    
    .B (0x10 BER)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    print out packets sent and received
    .TP
    .B 32
    
    .B (0x20 filter)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    search filter processing
    .TP
    .B 64
    
    .B (0x40 config)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    configuration file processing
    .TP
    .B 128
    
    .B (0x80 ACL)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    access control list processing
    .TP
    .B 256
    
    .B (0x100 stats)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    stats log connections/operations/results
    .TP
    .B 512
    
    .B (0x200 stats2)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    stats log entries sent
    .TP
    .B 1024
    
    .B (0x400 shell)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    print communication with shell backends
    .TP
    .B 2048
    
    .B (0x800 parse)
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    entry parsing
    
    \".TP
    \".B 4096
    \".B (0x1000 cache)
    \"caching (unused)
    \".TP
    \".B 8192
    \".B (0x2000 index)
    \"data indexing (unused)
    
    .TP
    .B 16384
    .B (0x4000 sync)
    LDAPSync replication
    .TP
    .B 32768
    
    only messages that get logged whatever log level is set
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .PD
    .RE
    
    The desired log level can be input as a single integer that combines 
    
    the (ORed) desired levels, both in decimal or in hexadecimal notation,
    as a list of integers (that are ORed internally),
    
    or as a list of the names that are shown between brackets, such that
    .LP
    .nf
        loglevel 129
    
        loglevel 0x81
    
        loglevel 128 1
    
        loglevel 0x80 0x1
    
        loglevel acl trace
    .fi
    .LP
    are equivalent.
    The keyword 
    .B any
    can be used as a shortcut to enable logging at all levels (equivalent to -1).
    
    The keyword
    .BR none ,
    or the equivalent integer representation, causes those messages
    that are logged regardless of the configured loglevel to be logged.
    In fact, if no loglevel (or a 0 level) is defined, no logging occurs, 
    so at least the 
    .B none
    level is required to have high priority messages logged.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .RE
    
    .TP
    .B moduleload <filename>
    Specify the name of a dynamically loadable module to load. The filename
    may be an absolute path name or a simple filename. Non-absolute names
    are searched for in the directories specified by the
    .B modulepath
    option. This option and the
    .B modulepath
    option are only usable if slapd was compiled with --enable-modules.
    .TP
    .B modulepath <pathspec>
    Specify a list of directories to search for loadable modules. Typically
    the path is colon-separated but this depends on the operating system.
    
    .hy 0
    .B objectclass "(\ <oid>\
     [NAME\ <name>]\
    
     [DESC\ <description>]\
    
     [OBSOLETE]\
     [SUP\ <oids>]\
     [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
     [MUST\ <oids>] [MAY\ <oids>] )"
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
    The slapd parser extends the RFC 4512 definition by allowing string
    
    forms as well as numeric OIDs to be used for the object class OID.
    (See the
    
    description.)  Object classes are "STRUCTURAL" by default.
    
    .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
    
    Define a string name that equates to the given OID. The string can be used
    in place of the numeric OID in objectclass and attribute definitions. The
    name can also be used with a suffix of the form ":xx" in which case the
    value "oid.xx" will be used.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    
    .B password-hash <hash> [<hash>...]
    This option configures one or more hashes to be used in generation of user
    passwords stored in the userPassword attribute during processing of
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    LDAP Password Modify Extended Operations (RFC 3062).
    
    The <hash> must be one of
    
    .BR {SSHA} ,
    .BR {SHA} ,
    .BR {SMD5} ,
    .BR {MD5} ,
    
    .BR {CLEARTEXT} .
    
    The default is
    .BR {SSHA} .
    
    .B {SHA}
    and
    .B {SSHA}
    use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
    
    .B {MD5}
    and
    .B {SMD5}
    use the MD5 algorithm (RFC 1321), the latter with a seed.
    
    .B {CRYPT}
    uses the
    .BR crypt (3).
    
    .B {CLEARTEXT}
    indicates that the new password should be
    added to userPassword as clear text.
    
    Note that this option does not alter the normal user applications
    
    handling of userPassword during LDAP Add, Modify, or other LDAP operations.
    
    .B password\-crypt\-salt\-format <format>
    
    Specify the format of the salt passed to
    .BR crypt (3)
    
    when generating {CRYPT} passwords (see
    .BR password\-hash )
    during processing of LDAP Password Modify Extended Operations (RFC 3062).
    
    
    This string needs to be in
    .BR sprintf (3)
    format and may include one (and only one) %s conversion.
    
    This conversion will be substituted with a string of random
    
    characters from [A\-Za\-z0\-9./].  For example, "%.2s"
    provides a two character salt and "$1$%.8s" tells some
    versions of crypt(3) to use an MD5 algorithm and provides
    8 random characters of salt.  The default is "%s", which
    provides 31 characters of salt.
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B pidfile <filename>
    The ( absolute ) name of a file that will hold the 
    .B slapd
    server's process ID ( see
    .BR getpid (2)
    ) if started without the debugging command line option.
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B referral <url>
    Specify the referral to pass back when
    .BR slapd (8)
    cannot find a local database to handle a request.
    
    If specified multiple times, each url is provided.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    
    .B replica-argsfile
    The ( absolute ) name of a file that will hold the 
    .B slurpd
    server's command line options
    if started without the debugging command line option.
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    If it appears after a
    .B replogfile
    directive, the args file is specific to the 
    .BR slurpd (8)
    instance that handles that replication log.
    
    .TP
    .B replica-pidfile
    The ( absolute ) name of a file that will hold the 
    .B slurpd
    server's process ID ( see
    .BR getpid (2)
    ) if started without the debugging command line option.
    
    Pierangelo Masarati's avatar
    Pierangelo Masarati committed
    If it appears after a
    .B replogfile
    directive, the pid file is specific to the 
    .BR slurpd (8)
    instance that handles that replication log.
    
    .B replicationinterval
    The number of seconds 
    .B slurpd 
    waits before checking the replogfile for changes.
    
    If it appears after a
    .B replogfile
    directive, the replication interval is specific to the 
    .BR slurpd (8)
    instance that handles that replication log.
    
    Specify a set of conditions (separated by white space) to
    require (default none).
    
    The directive may be specified globally and/or per-database;
    databases inherit global conditions, so per-database specifications
    are additive.
    
    .B bind
    requires bind operation prior to directory operations.
    .B LDAPv3
    requires session to be using LDAP version 3.
    .B authc
    requires authentication prior to directory operations.
    .B SASL
    requires SASL authentication prior to directory operations.
    .B strong
    requires strong authentication prior to directory operations.
    
    The strong keyword allows protected "simple" authentication
    as well as SASL authentication.
    
    may be used to require no conditions (useful to clear out globally
    set conditions within a particular database); it must occur first
    in the list of conditions.
    
    Enable/disable client name unverified reverse lookup (default is 
    .BR off 
    
    if compiled with --enable-rlookups).
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B rootDSE <file>
    
    Specify the name of an LDIF(5) file containing user defined attributes
    for the root DSE.  These attributes are returned in addition to the
    attributes normally produced by slapd.
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B sasl-host <fqdn>
    Used to specify the fully qualified domain name used for SASL processing.
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B sasl-realm <realm>
    Specify SASL realm.  Default is empty.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B sasl-secprops <properties>
    Used to specify Cyrus SASL security properties.
    The
    .B none
    
    flag (without any other properties) causes the flag properties
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    default, "noanonymous,noplain", to be cleared.
    The
    .B noplain
    flag disables mechanisms susceptible to simple passive attacks.
    The
    .B noactive
    flag disables mechanisms susceptible to active attacks.
    The
    .B nodict
    flag disables mechanisms susceptible to passive dictionary attacks.
    The
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B noanonymous
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    flag disables mechanisms which support anonymous login.
    The
    .B forwardsec
    flag require forward secrecy between sessions.
    The
    .B passcred
    require mechanisms which pass client credentials (and allow
    mechanisms which can pass credentials to do so).
    The
    .B minssf=<factor> 
    property specifies the minimum acceptable
    .I security strength factor
    as an integer approximate to effective key length used for
    encryption.  0 (zero) implies no protection, 1 implies integrity
    protection only, 56 allows DES or other weak ciphers, 112
    allows triple DES and other strong ciphers, 128 allows RC4,
    Blowfish and other modern strong ciphers.  The default is 0.
    The
    .B maxssf=<factor> 
    property specifies the maximum acceptable
    .I security strength factor
    as an integer (see minssf description).  The default is INT_MAX.
    The
    
    .B maxbufsize=<size> 
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    property specifies the maximum security layer receive buffer
    size allowed.  0 disables security layers.  The default is 65536.
    .TP
    
    .B schemadn <dn>
    Specify the distinguished name for the subschema subentry that
    controls the entries on this server.  The default is "cn=Subschema".
    .TP
    
    .B security <factors>
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify a set of security strength factors (separated by white space)
    to require (see
    .BR sasl-secprops 's
    .B minssf
    option for a description of security strength factors).
    
    The directive may be specified globally and/or per-database.
    .B ssf=<n>
    specifies the overall security strength factor.
    .B transport=<n>
    specifies the transport security strength factor.
    .B tls=<n>
    specifies the TLS security strength factor.
    .B sasl=<n>
    specifies the SASL security strength factor.
    .B update_ssf=<n>
    specifies the overall security strength factor to require for
    directory updates.
    .B update_transport=<n>
    specifies the transport security strength factor to require for
    directory updates.
    .B update_tls=<n>
    specifies the TLS security strength factor to require for
    directory updates.
    .B update_sasl=<n>
    specifies the SASL security strength factor to require for
    directory updates.
    
    .B simple_bind=<n>
    specifies the security strength factor required for
    .I simple
    username/password authentication.
    
    Note that the
    .B transport
    factor is measure of security provided by the underlying transport,
    e.g. ldapi:// (and eventually IPSEC).  It is not normally used.
    .TP
    
    Howard Chu's avatar
    Howard Chu committed
    .B serverID <integer> [<URL>]
    Specify an integer ID from 0 to 4095 for this server. These IDs are
    required when using multimaster replication and each master must have a
    unique ID. If the URL is provided, this directive may be specified
    multiple times, providing a complete list of participating servers
    and their IDs. The fully qualified hostname of each server should be
    used in the supplied URLs. The IDs are used in the "replica id" field
    of all CSNs generated by the specified server. The default value is zero.
    Example:
    .LP
    .nf
    	serverID 1
    .fi
    .TP
    
    .B sizelimit {<integer>|unlimited}
    
    .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify the maximum number of entries to return from a search operation.
    The default size limit is 500.
    
    Use
    .B unlimited
    to specify no limits.
    
    The second format allows a fine grain setting of the size limits.
    
    Extra args can be added on the same line.
    
    See
    .BR limits
    for an explanation of the different flags.
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    
    .B sockbuf_max_incoming <integer>
    
    Specify the maximum incoming LDAP PDU size for anonymous sessions.
    The default is 262143.
    .TP
    .B sockbuf_max_incoming_auth <integer>
    Specify the maximum incoming LDAP PDU size for authenticated sessions.
    The default is 4194303.
    
    .B threads <integer>
    Specify the maximum size of the primary thread pool.
    
    The default is 16; the minimum value is 2.
    
    .B timelimit {<integer>|unlimited}
    
    .B timelimit time[.{soft|hard}]=<integer> [...]
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    Specify the maximum number of seconds (in real time)
    .B slapd
    will spend answering a search request.  The default time limit is 3600.
    
    Use
    .B unlimited
    to specify no limits.
    
    The second format allows a fine grain setting of the time limits.
    
    Extra args can be added on the same line.
    
    See
    .BR limits
    for an explanation of the different flags.
    
    .B tool-threads <integer>
    Specify the maximum number of threads to use in tool mode.
    This should not be greater than the number of CPUs in the system.
    The default is 1.
    
    .\"ucdata-path is obsolete / ignored...
    .\".TP
    .\".B ucdata-path <path>
    .\"Specify the path to the directory containing the Unicode character
    .\"tables. The default path is DATADIR/ucdata.
    
    is built with support for Transport Layer Security, there are more options
    
    you can specify.
    .TP
    .B TLSCipherSuite <cipher-suite-spec>
    Permits configuring what ciphers will be accepted and the preference order.
    <cipher-suite-spec> should be a cipher specification for OpenSSL.  Example:
    
    TLSCipherSuite HIGH:MEDIUM:+SSLv2
    
    To check what ciphers a given spec selects, use:
    
    openssl ciphers -v <cipher-suite-spec>
    .TP
    
    .B TLSCACertificateFile <filename>
    Specifies the file that contains certificates for all of the Certificate
    Authorities that
    .B slapd
    will recognize.
    .TP
    
    .B TLSCACertificatePath <path>
    Specifies the path of a directory that contains Certificate Authority
    certificates in separate individual files. Usually only one of this
    or the TLSCACertificateFile is used.
    .TP
    
    .B TLSCertificateFile <filename>
    Specifies the file that contains the
    .B slapd
    server certificate.
    .TP
    .B TLSCertificateKeyFile <filename>
    Specifies the file that contains the
    .B slapd
    server private key that matches the certificate stored in the
    .B TLSCertificateFile
    file.  Currently, the private key must not be protected with a password, so
    it is of critical importance that it is protected carefully. 
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .TP
    
    Howard Chu's avatar
    Howard Chu committed
    .B TLSDHParamFile <filename>
    This directive specifies the file that contains parameters for Diffie-Hellman
    ephemeral key exchange.  This is required in order to use a DSA certificate on
    the server. If multiple sets of parameters are present in the file, all of
    
    them will be processed.  Note that setting this option may also enable
    Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
    You should append "!ADH" to your cipher suites if you have changed them
    from the default, otherwise no certificate exchanges or verification will
    be done.
    
    Howard Chu's avatar
    Howard Chu committed
    .TP
    
    Kurt Zeilenga's avatar
    Kurt Zeilenga committed
    .B TLSRandFile <filename>
    Specifies the file to obtain random bits from when /dev/[u]random
    is not available.  Generally set to the name of the EGD/PRNGD socket.
    The environment variable RANDFILE can also be used to specify the filename.