File Formats

certmap.conf(4)

NAME | Synopsis | Description | Examples | Attributes | See Also

NAME

certmap.conf – Map certificates to directory entries

Synopsis

Location: instance-path/alias/certmap.conf

# This is a comment.
certmap default default
[default:property1 [value1]]
[default:property2 [value2]]
[…]

[certmap name issuerDN
[name:property1 [value1]]
[name:property2 [value2]]
…
]

Description

The certmap.conf file defines how Directory Server maps certificates to directory entries.

Comment lines are those starting with #.

CERTIFICATE MAPPINGS

The certmap.conf file consists of a series of certificate maps. It begins with a default certificate map, starting with the line:

certmap default default

Each subsequent certificate map starts with a line identifying the name of the map and the certificate authority issuer DN of the certificates to which the map applies.

The issuerDN string specified in the certificate map must correspond exactly to the issuer DN shown in the certificates. In particular, whitespace in the issuer DN is significant.

PROPERTIES AND VALUES

A certificate map also optionally specifies values for the following properties.

DNComps

Specifies a comma separated list of relative distinguished name components of the base DN for an LDAP search to find the user entry matching the certificate. The components are taken from the subject DN of the certificate.

When the value of this property value is left empty, the base DN is the null suffix. In this particular case, searching against the null suffix in Directory Server searches every suffix in the directory. Thus leaving DNComps empty can have negative impact on performance.

The default behavior, when this property is commented out or not specified, is to take as the base DN the subject DN of the certificate.

FilterComps

Specifies a comma separated list of LDAP attributes to form a filter for an LDAP search to find the user entry matching the certificate. The values for the filter are taken from the certificate, which can hold the following attributes.

c

Country

cn

Common name

e
mail

Email address

l

Location

o

Organization

ou

Organizational unit

st

State

uid

UNIX user ID

For example, consider a certificate map named example containing the following FilterComps specification.

example:FilterComps e,uid

Then searches for the user entry matching the certificate use the filter "(&(mail=email-addr-from-cert)(uid-from-cert))".

The default behavior, when this property is commented out or not specified, is to use the filter "(objectclass=*)".

verifycert

Specifies whether the client application certificate is checked to make sure it is valid and not revoked.

This property can be usefully set to on if the directory stores client application certificates.

The default behavior is the same as off, meaning client certificates are not checked to be valid and not revoked.

CmapLdapAttr

Specifies the name of the LDAP attribute in the directory containing the subject DN of the certificate.

The implied default value is certSubjectDN, not a standard LDAP attribute.

---

Note –

If the LDAP attribute used is not of syntax DN, its value must match the subject DN provided exactly as the LDAP server does normalize DN values that are not stored in attributes with DN syntax.

---

library

Specifies a shared plug-in library or DLL containing custom certificate mapping code.

There is no default.

InitFn

Specifies the initialization function for the custom certificate mapping code in the library referenced by the value of the library property.

There is no default.

Examples

The following certmap.conf file specifies both a default certificate map, and an additional certificate map for certificates from the US subsidiary of Example.com.

# Example certmap.conf
certmap default default

certmap examplecerts ou=Example.com, o=examplecerts, c=US
examplecerts:DNComps ou,o,c
examplecerts:FilterComps e
examplecerts:verifycert on

When the server gets a certificate issued by any certificate authority other than the US subsidiary of Example.com, it uses the default mapping. If the certificate however has been issued by the US subsidiary of Example.com, the server looks for entries under the branch for the organizational unit and searches for entries using the client email address. It also verifies that such certificates are valid and that they are not revoked.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWldap-directory
Stability Level	Evolving

See Also

dsadm(1M)

DS 6.2  Last Revised May 19, 2006

NAME | Synopsis | Description | Examples | Attributes | See Also

dse.ldif(4)

NAME | Synopsis | Description | Extended Description | CONFIGURATION ATTRIBUTES | Attributes | Attributes

NAME

dse.ldif – Directory Server configuration file

Synopsis

Location: instance-path/config/dse.ldif

Location: instance-path/conf_bk/dse.ldif

Description

Directory Server stores its configuration as directory entries under cn=config. You can therefore change the server configuration by modifying configuration entries over LDAP, rather than by editing configuration files. Configuring Directory Server in this way allows you to reconfigure a remote server while it continues to serve other directory clients.

The dse.ldif file defines the configuration for a Directory Server instance. The dse.ldif file includes a set of entries under cn=config. These entries make up the modular parts of the Directory Server instance configuration.

Directory Server stores its schema under cn=schema, not as part of the rest of the server configuration. For an introduction to the schema available under cn=schema, see Intro(5DSSD).

---

Note –

Neither the dse.ldif file nor the cn=config suffix constitute a public interface for configuring a Directory Server instance. Use dsconf(1M) instead.

---

The dse.ldif file has the following characteristics.

• The dse.ldif file is read only once at startup. Thereafter, the server configuration is based on the in-memory LDAP image of the configuration entries. Modifications to the dse.ldif file while the server is running are erased.

• Modification of the configuration with Directory Service Control Center or from the command line changes the LDAP image of the configuration. Some directory features read the current configuration when invoked and do not require the server to be restarted.

• Directory Server writes the dse.ldif file whenever the LDAP image of the configuration is changed. Some directory features read their configuration only when the server starts. Writing the file ensures the change is present.

  The existing dse.ldif file is copied to dse.ldif.bak, and the existing dse.ldif.bak is overwritten. Therefore, any manual changes to the dse.ldif file are lost if the configuration is changed through LDAP before the server is restarted.

• After every successful startup of the directory, the dse.ldif file is copied to dse.ldif.startOK in the same location. If your server cannot start because of a faulty configuration, restore the dse.ldif file from the dse.ldif.startOK file.

• The following restrictions apply to modifications to the server configuration.

  • Rather than delete configuration entries and add them again, you modify their attributes.

  • Some modifications only take effect after the server is restarted. See ATTRIBUTES REQUIRING RESTART in the manual page for details.

  • The cn=monitor entry cannot be modified.

  • The server ignores invalid attribute values.

Extended Description

Directory Server has a modular configuration, with a number of distinct branches under the cn=config Directory Information Tree. The primary branches are below the following DNs.

cn=encryption,cn=config

Configuration attributes related to encryption

cn=features,cn=config

Access control for many server features, also configuration for internationalized matching and searching

cn=mapping tree,cn=config

Configuration for suffixes and replica

cn=Password Policy,cn=config

Default password policy configuration

cn=plugins,cn=config

Plug-in configuration entries for plug-in based server functionality, databases, indexes

cn=replication,cn=config

Default replication bind information for cn=Replication Manager, also formerly used for replication configuration

cn=suffixName,cn=config

Suffix configuration attributes

cn=tasks,cn=config

Used by the server to manage online import, backup, and so forth

cn=uniqueid generator,cn=config

Configuration attributes for providing unique IDs

About Configuration Attributes

The dse.ldif file contains all configuration information including directory specific entries created by Directory Server at startup, and directory specific entries related to the database, also created by Directory Server at startup. The file includes the Root DSE, named by "", and the entire contents of cn=config. When the server generates the dse.ldif file, it lists the entries in hierarchical order. It does so in the order that the entries appear in the directory under cn=config.

Within a configuration entry, each attribute is represented as an attribute name. The value of the attribute corresponds to the attribute’s configuration.

The following example shows part of the dse.ldif file for a Directory Server instance. The example indicates, among other things, that schema checking has been turned on. This is represented by the attribute nsslapd-schemacheck, which takes the value on.

dn: cn=config
objectclass: top
objectclass: extensibleObject
objectclass: nsslapdConfig
nsslapd-accesslog-logging-enabled: on
nsslapd-enquote-sup-oc: on
nsslapd-localhost: myServer.example.com
nsslapd-errorlog: /local/ds/logs/errors
nsslapd-schemacheck: on
nsslapd-port: 389
nsslapd-localuser: nobody
…

See CONFIGURATION ATTRIBUTES in this manual page for a list of configuration attribute manual pages.

Access Control For Configuration Entries

When Directory Server is installed, a default set of Access Control Instructions, ACIs, is implemented for all entries under cn=config. The following extract from the dse.ldif file shows an example of these default ACIs.

aci: (targetattr != "aci") (targetscope = "base") (version 3.0;
 aci "Enable read access to rootdse for anonymous users"; 
 allow(read,search,compare) userdn="ldap:///anyone"; )
aci: (targetattr = "*") (version 3.0;  acl "Enable full access
 for Administrators group";  allow (all)(groupdn = "
 ldap:///cn=Administrators,cn=config"); )
aci: (targetattr = "userPassword") ( version 3.0;
 acl "allow userpassword self  modification";
 allow (write) userdn = "ldap:///self";)

By default, both the cn=Directory Manager user and the cn=admin,cn=Administrators,cn=config user have access to modify configuration entries. ACI syntax is covered elsewhere in the Directory Server Enterprise Edition documentation.

CONFIGURATION ATTRIBUTES

This section lists configuration attributes by their location in the configuration Directory Information Tree.

Attributes of cn=config

General configuration entries are stored under the cn=config entry. The cn=config entry is an instance of the nsslapdConfig object class, which inherits from the extensibleObject object class. For attributes to be taken into account by the server, the entry must contain the nsslapdConfig object class, the extensibleObject object class and the top object class.

See the following manual pages.

• nsslapd-accesslog-level(5dsconf)

• nsslapd-allidsthreshold(5dsconf)

• nsslapd-attribute-name-exceptions(5dsconf)

• nsslapd-berbufsize(5dsconf)

• nsslapd-certmap-basedn(5dsconf)

• nsslapd-config(5dsconf)

• nsslapd-ds4-compatible-schema(5dsconf)

• nsslapd-enquote-sup-oc(5dsconf)

• nsslapd-groupevalnestlevel(5dsconf)

• nsslapd-idletimeout(5dsconf)

• nsslapd-instancedir(5dsconf)

• nsslapd-ioblocktimeout(5dsconf)

• nsslapd-lastmod(5dsconf)

• nsslapd-listenBacklog(5dsconf)

• nsslapd-listenhost(5dsconf)

• nsslapd-localhost(5dsconf)

• nsslapd-localuser(5dsconf)

• nsslapd-maxbersize(5dsconf)

• nsslapd-maxconnections(5dsconf)

• nsslapd-maxdescriptors(5dsconf)

• nsslapd-maxpsearch(5dsconf)

• nsslapd-maxthreadsperconn(5dsconf)

• nsslapd-nagle(5dsconf)

• nsslapd-port(5dsconf)

• nsslapd-privatenamespaces(5dsconf)

• nsslapd-readonly(5dsconf)

• nsslapd-referral(5dsconf)

• nsslapd-referralmode(5dsconf)

• nsslapd-reservedescriptors(5dsconf)

• nsslapd-return-exact-case(5dsconf)

• nsslapd-rootdn(5dsconf)

• nsslapd-rootpw(5dsconf)

• nsslapd-rootpwstoragescheme(5dsconf)

• nsslapd-schema-repl-useronly(5dsconf)

• nsslapd-schemacheck(5dsconf)

• nsslapd-securePort(5dsconf)

• nsslapd-securelistenhost(5dsconf)

• nsslapd-security(5dsconf)

• nsslapd-sizelimit(5dsconf)

• nsslapd-threadnumber(5dsconf)

• nsslapd-timelimit(5dsconf)

• nsslapd-versionstring(5dsconf)

• useAuthzIdForAuditAttrs(5dsconf)

Attributes of cn=encryption,cn=config

Encryption related attributes are stored under the cn=encryption,cn=config entry. This entry is an instance of the nsEncryptionConfig object class. For encryption related attributes to be taken into account by the server, this object class, in addition to the top object class, must be present in the entry.

See the following manual pages.

• nsSSL2(5dsconf)

• nsSSL3(5dsconf)

• nsSSL3ciphers(5dsconf)

• nsSSLClientAuth(5dsconf)

• nsSSLServerAuth(5dsconf)

• nsSSLSessionTimeout(5dsconf)

Attributes of cn=mapping tree,cn=config

Configuration attributes for suffixes and replication are stored under the branch cn=mapping tree,cn=config.

Configuration attributes related to suffixes are found under the suffix subentry, which has a DN of the following form.

cn="suffixName",cn=mapping tree,cn=config

Suffix configuration entries therefore have CNs such as cn="dc=example,dc=com". Suffix configuration entries are instances of the nsMappingTree object class, which inherits from the extensibleObject object class. For suffix configuration attributes to be taken into account by the server, these object classes, in addition to the top object class, must be present in the entry. See the following man pages about suffix configuration entry attributes.

• nsslapd-backend(5dsconf)

• nsslapd-distribution-plugin(5dsconf)

• nsslapd-distribution-funct(5dsconf)

• nsslapd-referral(5dsconf)

• nsslapd-state(5dsconf)

Replication configuration attributes are stored under an entry with a DN of the following form.

cn=replica,cn="suffixName",cn=mapping tree,cn=config

Replication agreement attributes are stored under an entry with a DN of the following form.

cn=replicationAgreementName,cn=replica,cn="suffixName",
 cn=mapping tree,cn=config

See replication(5dsconf) for details.

Attributes of cn=Password Policy

The default password policy entry for a Directory Server instance has DN cn=Password Policy,cn=config. For help configuring password policy, see the Directory Server Administration Guide.

For details concerning password policy entries, see pwpolicy(5dssd). Entries having the object classes described in pwdPolicy(5dsoc), and in sunPwdPolicy(5dsoc) are used to configure password policy.

For instructions concerning legacy password policy functionality, see the Directory Server Migration Guide. Legacy password policy functionality is configured using entries of the object class described in passwordPolicy(5dsoc).

Plug-In Configuration Under cn=plugins

Many of the features of Directory Server are designed as discrete modules that plug into the core server. The configuration for each part of Directory Server plug-in functionality has its own separate entry and set of attributes under the subtree cn=plugins,cn=config. The following example shows the configuration entry for the Telephone Syntax plug-in.

dn: cn=Telephone Syntax,cn=plugins,cn=config
objectclass: top
objectclass: nsSlapdPlugin
objectclass: ds-signedPlugin
objectclass: extensibleObject
cn: Telephone Syntax
nsslapd-pluginPath: /opt/SUNWdsee/ds6/lib/syntax-plugin.so
nsslapd-pluginInitfunc: tel_init
nsslapd-pluginType: syntax
nsslapd-pluginEnabled: on
…

Some of these attributes are common to all plug-ins and some may be particular to a specific plug-in.

Chained Suffix Plug-In Configuration

All plug-in configuration information used by the chained suffix instances is stored under the cn=chaining database,cn=plugins,cn=config entry.

The following global chained suffix configuration attributes common to all instances are stored under cn=config,cn=chaining database,cn=plugins,cn=config.

• nsActiveChainingComponents(5dsconf)

• nsMaxResponseDelay(5dsconf)

• nsMaxTestResponseDelay(5dsconf)

• nsTransmittedControls(5dsconf)

Default instance chained suffix attributes are stored under cn=default instance config,cn=chaining database,cn=plugins,cn=config.

• nsAbandonedSearchCheckInterval(5dsconf)

• nsBindConnectionsLimit(5dsconf)

• nsBindRetryLimit(5dsconf)

• nsBindTimeout(5dsconf)

• nsCheckLocalACI(5dsconf)

• nsConcurrentBindLimit(5dsconf)

• nsConcurrentOperationsLimit(5dsconf)

• nsConnectionLife(5dsconf)

• nsOperationConnectionsLimit(5dsconf)

• nsProxiedAuthorization(5dsconf)

• nsReferralOnScopedSearch(5dsconf)

• nsslapd-sizelimit(5dsconf)

• nsslapd-timelimit(5dsconf)

Instance-specific chained suffix attributes are stored under cn=chainedSuffix,cn=chaining database,cn=plugins,cn=config.

• nsFarmServerURL(5dsconf)

• nshoplimit(5dsconf)

• nsMultiplexorBindDN(5dsconf)

• nsMultiplexorCredentials(5dsconf)

The following list shows the chained suffix attributes used for monitoring activity on instances. These attributes are stored under cn=monitor,cn=dbName, cn=chaining database,cn=plugins,cn=config.

nsAddCount

Number of add operations received.

nsDeleteCount

Number of delete operations received.

nsModifyCount

Number of modify operations received.

nsRenameCount

Number of rename operations received.

nsSearchBaseCount

Number of base level searches received.

nsSearchOneLevelCount

Number of one-level searches received.

nsSearchSubtreeCount

Number of subtree searches received.

nsAbandonCount

Number of abandon operations received.

nsBindCount

Number of bind requests received.

nsUnbindCount

Number of unbinds received.

nsCompareCount

Number of compare operations received.

nsOperationConnectionCount

Number of open connections for normal operations.

nsBindConnectionCount

Number of open connections for bind operations.

Database Plug-In Configuration

Database plug-in configuration entries are stored under cn=ldbm database,cn=plugins,cn=config. That entry is a server plug-in configuration entry for databases, and therefore takes the same attributes as other plug-in entries.

Key entries beneath the plug-in configuration entry are listed as follows.

cn=attr,cn=default indexes,cn=config,cn=ldbm database, cn=plugins,cn=config

Configuration entries for default indexes. Notice that each individual attribute type indexed has its own entry, and that the attribute type is identified by common name, CN. See the following man pages concerning attributes for such entries.

• cn(5dsat)

• description(5dsat)

• nsIndexType(5dsconf)

• nsMatchingRule(5dsconf)

• nsSystemIndex(5dsconf)

cn=attr,cn=index,cn=dbName,cn=ldbm database, cn=plugins,cn=config

Configuration entries for indexing for attributes of the suffix whose backend database has CN dbName. Such entries take the same configuration attributes as configuration entries for default indexes.

All indexes, except system-essential ones, can be removed, but care should be taken not to cause unnecessary disruptions.

cn=config,cn=ldbm database,cn=plugins,cn=config

Global configuration information for all databases. See the following man pages concerning attributes for such entries.

• nsLookthroughLimit(5dsconf)

• nsslapd-db-checkpoint-interval(5dsconf)

• nsslapd-db-circular-logging(5dsconf)

• nsslapd-db-durable-transactions(5dsconf)

• nsslapd-db-home-directory(5dsconf)

• nsslapd-db-idl-divisor(5dsconf)

• nsslapd-db-locks(5dsconf)

• nsslapd-db-logbuf-size(5dsconf)

• nsslapd-db-logdirectory(5dsconf)

• nsslapd-db-logfile-size(5dsconf)

• nsslapd-db-page-size(5dsconf)

• nsslapd-db-transaction-batch-val(5dsconf)

• nsslapd-db-tx-max(5dsconf)

• nsslapd-dbcachesize(5dsconf)

• nsslapd-dbncache(5dsconf)

• nsslapd-disk-full-threshold(5dsconf)

• nsslapd-disk-low-threshold(5dsconf)

• nsslapd-exclude-from-export(5dsconf)

• nsslapd-import-cachesize(5dsconf)

• nsslapd-mode(5dsconf)

cn=database,cn=monitor,cn=ldbm database, cn=plugins,cn=config

Entry for read-only database performance monitoring attributes. All of the values for these attributes are 32-bit integers.

nsslapd-db-abort-rate

Number of transactions that have been aborted.

nsslapd-db-active-txns

Number of transactions that are currently active (used by the database.)

nsslapd-db-cache-hit

Requested pages found in the cache.

nsslapd-db-cache-region-wait-rate

Number of times that a thread of control was forced to wait before obtaining the region lock.

nsslapd-db-cache-size-bytes

Total cache size in bytes.

nsslapd-db-cache-try

Total cache lookups.

nsslapd-db-clean-pages

Clean pages currently in the cache.

nsslapd-db-commit-rate

Number of transactions that have been committed.

nsslapd-db-configured-locks

Configured number of locks.

nsslapd-db-configured-txns

Configured number of transactions.

nsslapd-db-current-locks

Number of locks currently used by the database.

nsslapd-db-deadlock-rate

Number of deadlocks detected.

nsslapd-db-dirty-pages

Dirty pages currently in the cache.

nsslapd-db-hash-buckets

Number of hash buckets in buffer hash table.

nsslapd-db-hash-elements-examine-rate

Total number of hash elements traversed during hash table lookups.

nsslapd-db-hash-search-rate

Total number of buffer hash table lookups.

nsslapd-db-lock-conflicts

Total number of locks not immediately available due to conflicts.

nsslapd-db-lockers

Number of current lockers.

nsslapd-db-lock-region-wait-rate

Number of times that a thread of control was forced to wait before obtaining the region lock.

nsslapd-db-lock-request-rate

Total number of locks requested.

nsslapd-db-log-bytes-since-checkpoint

Number of bytes written to this log since the last checkpoint.

nsslapd-db-log-flush-commit

The number of log flushes that contained a transaction commit record.

nsslapd-db-log-flush-count

The number of times the log has been flushed to disk.

nsslapd-db-log-max-commit-per-flush

The maximum number of commits contained in a single log flush.

nsslapd-db-log-min-commit-per-flush

The minimum number of commits contained in a single log flush that contained a commit.

nsslapd-db-log-region-wait-rate

Number of times that a thread of control was forced to wait before obtaining the region lock.

nsslapd-db-log-write-count

The number of times the log has been written to disk.

nsslapd-db-log-write-count-fill

The number of times the log has been written to disk because the in-memory log record cache filled up.

nsslapd-db-log-write-rate

Number of bytes written to the log since the last checkpoint.

nsslapd-db-longest-chain-length

Longest chain ever encountered in buffer hash table lookups.

nsslapd-db-max-locks

Maximum number of locks used by the database since the last startup.

nsslapd-db-max-txns

Maximum number of transactions used since the last startup.

nsslapd-db-page-create-rate

Pages created in the cache.

nsslapd-db-page-read-rate

Pages read into the cache.

nsslapd-db-page-ro-evict-rate

Clean pages forced from the cache.

nsslapd-db-page-rw-evict-rate

Dirty pages forced from the cache.

nsslapd-db-pages-in-use

All pages, clean or dirty, currently in use.

nsslapd-db-page-trickle-rate

Dirty pages written using the memp_trickle interface.

nsslapd-db-page-write-rate

Pages read into the cache.

nsslapd-db-txn-region-wait-rate

Number of times that a thread of control was force to wait before obtaining the region lock.

cn=dbName,cn=ldbm database,cn=plugins,cn=config

Configuration information for databases backing suffixes you define. The dbName is by default a contraction of the common name for the suffix. For example, if the suffix has CN cd=example,dc=com, the dbName might be example. See the following man pages concerning attributes for such entries.

• nsslapd-cachesize(5dsconf)

• nsslapd-cachememsize(5dsconf)

• nsslapd-directory(5dsconf)

• nsslapd-readonly(5dsconf)

• nsslapd-require-index(5dsconf)

• nsslapd-suffix(5dsconf)

Virtual list view, VLV, index entries are found beneath this entry.

A VLV index provides fast searches against a known result set and sort ordering. To do this, the object class vlvSearch is needed to define the VLV search, and the object class vlvIndex is needed to order the search. See the following manual pages for details on the VLV configuration entry object classes and attributes.

• vlvBase(5dsat)

• vlvEnabled(5dsat)

• vlvFilter(5dsat)

• vlvScope(5dsat)

• vlvSort(5dsat)

• vlvUses(5dsat)

• vlvIndex(5dsoc)

• vlvSearch(5dsoc)

cn=default indexes,cn=config,cn=ldbm database, cn=plugins,cn=config

Configuration entry for default indexing for all suffixes. Default indexes are configured per backend in order to optimize Directory Server functionality for the majority of deployments.

cn=monitor,cn=dbName,cn=ldbm database, cn=plugins,cn=config

Entry for database monitoring attributes, listing database statistics for monitoring activity on the dbNamedatabase. These attributes are provided for each file that makes up your database.

dbentrycount

Total number of entries in the database, including entries created by replication.

dbfilename-number

This attribute indicates the name of the file and provides a sequential integer identifier, starting at 0, for the file. All associated statistics for the file are given the same numerical identifier.

dbfilecachehit

Number of times that a search requiring data from this file was performed and data successfully obtained from the cache.

dbfilecachemiss

Number of times that a search requiring data from this file was performed and that the data could not be obtained from the cache.

dbfilepagein

Number of pages brought to the cache from this file.

dbfilepageout

Number of pages for this file written from cache to disk.

entrycachehitratio

Ratio that indicates the number of entry cache tries to successful entry cache lookups.

entrycachehits

Total number of successful entry cache lookups.

ldapentrycount

Number of user entries in the database.

maxentrycachecount

Maximum number of directory entries that are allowed to be maintained in the entry cache.

maxentrycachesize

Maximum memory size allowed for entry cache, in bytes.

cn=monitor,cn=ldbm database,cn=plugins,cn=config

Entry for database monitoring attributes, listing database statistics for monitoring activity on databases.

dbcachehits

Requested pages found in the database.

dbcachetries

Total requested pages found in the database cache.

dbcachehitratio

Percentage of requested pages found in the database cache, hits/tries.

dbcachepagein

Pages read into the database cache.

dbcachepageout

Pages written from the database cache to the backing file.

dbcacheroevict

Clean pages forced from the cache.

dbcacherwevict

Dirty pages forced from the cache.

DSML Front End Plug-In Configuration Attributes

The front end plug-in enables you to access directory data by methods other than LDAP. Directory Server provides a DSML front end plug-in that enables access using DSMLv2 over HTTP/SOAP. Attributes for the DSML front end plug-in are stored under cn=DSMLv2-SOAP-HTTP,cn=frontends,cn=plugins,cn=config. See the following manual pages for details.

• ds-hdsml-clientauthmethod(5dsconf)

• ds-hdsml-dsmlschemalocation(5dsconf)

• ds-hdsml-iobuffersize(5dsconf)

• ds-hdsml-poolmaxsize(5dsconf)

• ds-hdsml-poolsize(5dsconf)

• ds-hdsml-port(5dsconf)

• ds-hdsml-requestmaxsize(5dsconf)

• ds-hdsml-responsemsgsize(5dsconf)

• ds-hdsml-rooturl(5dsconf)

• ds-hdsml-secureport(5dsconf)

• ds-hdsml-soapschemalocation(5dsconf)

Retro Changelog Plug-In Configuration

The following manual pages describe attributes used when configuring the retro changelog plug-in.

• nsslapd-changelogdir(5dsconf)

• nsslapd-changelogmaxage(5dsconf)

• nsslapd-changelogmaxentries(5dsconf)

Server Plug-In Configuration Entries

All plug-ins are instances of the nsSlapdPlugin object class, which in turn inherits from the extensibleObject object class. For plug-in configuration attributes to be taken into account by the server, both of these object classes, in addition to the top object class, must be present in the entry.

See nsslapd-plugin(5dsconf) for an overview of the plug-ins provided with Directory Server, including configurable options, configurable arguments, default setting, dependencies, general performance related information, and further reading.

Attributes of cn=uniqueid generator,cn=config

Unique ID generator configuration attributes are stored under the entry with DN cn=uniqueid generator,cn=config. The cn=uniqueid generator,cn=config entry is an instance of the extensibleObject object class. For unique ID generator configuration attributes to be taken into account by the server, this object class, in addition to the top object class, must be present in the entry.

The principal unique ID generator attribute is nsState(5dsconf).

Attributes

This section lists configuration elements whose modifications cannot take effect dynamically, while the server is still running. After modifying these parameters, you must restart the server. The following list shoiws the configuration attributes concerned, with their full DNs, and provides a brief description of their functions.

Any plug-in configuration attribute

Changing plug-in settings.

cn=config:nsslapd-port

Changing the port number.

cn=config:nsslapd-secureport

Changing the secure port number.

cn=config:nsslapd-security

Enabling or disabling use of SSL, TLS, and attribute encryption.

cn=config:nsslapd-changelogdir

Modifying the change log database path.

cn=config:nsslapd-changelogsuffix

Modifying the change log suffix.

cn=config:nsslapd-return-exact-case

Modifying whether the server returns exact case matches for attribute names.

cn=config,cn=ldbm database,cn=plugins,cn=config:nsslapd-allidsthreshold

Changing the all IDs threshold value.

cn=config,cn=ldbm database,cn=plugins,cn=config:nsslapd-dbcachesize

Modifying the size of the database cache.

cn=config,cn=ldbm database,cn=plugins,cn=config:nsslapd-dbncache

Modifying whether the database cache memory is split into equally sized pieces.

cn=config,cn=ldbm database,cn=plugins,cn=config:nsslapd-directory

Changing the path to the database instance.

cn=config,cn=ldbm database,cn=plugins,cn=config:nsslapd-db-locks

Changing the number of locks available in the database.

cn=encryption,cn=config:nssslsessiontimeout

Changing the lifetime of an SSL session.

cn=encryption,cn=config:nssslclientauth

Enabling or disabling client authentication.

cn=encryption,cn=config:nssslserverauth

Enabling or disabling server authentication.

cn=encryption,cn=config:nsssl2

Enabling or disabling SSL Version 2 for Directory Server.

cn=encryption,cn=config:nsssl3

Enabling or disabling SSL Version 3 for Directory Server.

cn=RSA,cn=encryption,cn=config:nsssltoken

Changing the SSL token.

cn=RSA,cn=encryption,cn=config:nssslpersonalityssl

Changing the SSL personality.

cn=RSA,cn=encryption,cn=config:nssslactivation

Enabling or disabling the SSL encryption module.

cn=suffixName,cn=ldbm database,cn=plugins,cn=config:nsslapd-cachesize

Modifying the number of entries held in the entry cache.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWldap-directory
Stability Level	Obsolete: Scheduled for removal as a supported interface after this release

DS 6.2  Last Revised October 10, 2006

NAME | Synopsis | Description | Extended Description | CONFIGURATION ATTRIBUTES | Attributes | Attributes

hosts_access(4)

NAME | Synopsis | Description | Examples | Diagnostics | Files | See Also | Bugs | AUTHOR | Attributes

NAME

hosts_access – Format of host access control files for Directory Server Enterprise Edition

Synopsis

instance-path/config/hosts.allow
instance-path/config/hosts.deny

Description

This manual page describes a simple access control language that is based on client (host name/address, user name), and server (process name, host name/address) patterns. Examples are given at the end. The impatient reader is encouraged to skip to the EXAMPLES section for a quick introduction.

In the following text, daemon is the the process name of a network daemon process, and client is the name and/or address of a host requesting service.

Note that the version of hosts_access supplied with Directory Server Enterprise Edition is different from the version delivered with Solaris. The Directory Server Enterprise Edition version of hosts_access has the following characteristics:

• Shell commands are not available on Microsoft Windows.

• hosts_options are not available on any OS.

• IPv6 is supported on all platforms except Windows.

• PARANOID mode is not available.

• You cannot replace the lib with your own lib, as it is statically linked to the server.

• There is no support of NIS Netgroups. Any '@' symbols in rules are ignored.

• The daemon_list process name is the port number of the server. For example, 3389:eng.example.com or 636:192.168.11.254. Port numbers are server properties: ldap-port, ldap-secure-port, dsml-port, dsml-secure-port. Use the dsconf command to view and modify these properties.

• Server instances can share files by pointing the instance name at the same file (instance-path/config/hosts.allow). Use the dsconf command to view and modify the server property host-access-dir-path. For example, to have all server instances pointing to /etc/hosts.{deny,allow}, run the following command on all servers: $ dsconf set-server-prop —h host —p port host-access-dir-path: /etc

• You can make changes to the hosts_access or hosts_deny files without needing to restart the server. You can safely ignore the dsconf server restart message.

• Two conditions must be met in order for acess to be allowed. Firstly, the permissions of the file(s) must be owned by nsslapd-localuser or root and secondly write permission must be allowed for the owner, but not for group or other. Ensure that you use correct permissions, as incorrect permissons on shared files can cause problems. Note that these conditions are not checked on Windows platforms.

ACCESS CONTROL FILES

The access control software consults two files. The search stops at the first match:

• Access will be granted when a (daemon,client) pair matches an entry in the instance-path/config/hosts.allow file.

• Otherwise, access will be denied when a (daemon,client) pair matches an entry in the instance-path/config/hosts.deny file.

• Otherwise, access will be granted.

A non-existing access control file is treated as if it were an empty file. Thus, access control can be turned off by providing no access control files.

ACCESS CONTROL RULES

Each access control file consists of zero or more lines of text. These lines are processed in order of appearance. The search terminates when a match is found.

• A newline character is ignored when it is preceded by a backslash character. This permits you to break up long lines so that they are easier to edit.

• Blank lines or lines that begin with a `#' character are ignored. This permits you to insert comments and whitespace so that the tables are easier to read.

• All other lines should satisfy the following format:

  Hosts are identified by server port numbers. If there is no port number match or wildcard, the access control check skips that line of the file.

  List elements should be separated by blanks and/or commas.

  All access control checks are case insensitive.

PATTERNS

The access control language implements the following patterns:

• A string that begins with a `.' character. A host name is matched if the last components of its name match the specified pattern. For example, the pattern `.tue.nl' matches the host name `wzv.win.tue.nl'.

• A string that ends with a `.' character. A host address is matched if its first numeric fields match the given string. For example, the pattern `131.155.' matches the address of (almost) every host on the Eindhoven University network (131.155.x.x).

• An expression of the form `n.n.n.n/m.m.m.m' is interpreted as a `net/mask' pair. A host address is matched if `net' is equal to the bitwise AND of the address and the `mask'. For example, the net/mask pattern `131.155.72.0/255.255.254.0' matches every address in the range `131.155.72.0' through `131.155.73.255'.

• When using IPv6 for matching, be aware that an expression of the form [n:n:n:n:n:n:n:n]/m is interpreted as a [net]/prefixlen pair. An IPv6 host address is matched if prefixlen bits of net is equal to the prefixlen bits of the address. For example, the [net]/prefixlen pattern [3ffe:505:2:1::]/64 matches every address in the range 3ffe:505:2:1:: through 3ffe:505:2:1:ffff:ffff:ffff:ffff.

WILDCARDS

Wildcards `*' and `?' can be used to match hostnames or IP addresses. However, this method of matching cannot be used in conjunction with the following: net/mask matching, hostname matching beginning with `.' , IP address matching ending with `.' or a IPv6 rule (begins with '[').

The access control language supports explicit wildcards:

ALL

The universal wildcard, always matches.

LOCAL

Matches any host whose name does not contain a dot character.

UNKNOWN

Matches any user whose name is unknown, and matches any host whose name or address are unknown. This pattern should be used with care: host names may be unavailable due to temporary name server problems. A network address will be unavailable when the software cannot figure out what type of network it is talking to.

Sun does not recommend that you use the UNKNOWN wildcard. Directory Server always fills in both host and address, so there is never a case when the host name is unknown. The user is unavailable because of no NIS netgroups support.

KNOWN

Matches any user whose name is known, and matches any host whose name and address are known. This pattern should be used with care: host names may be unavailable due to temporary name server problems. A network address will be unavailable when the software cannot figure out what type of network it is talking to.

In Directory Server the user is always marked as unknown and is unavailable because of the NIS Netgroup restriction.

OPERATORS

EXCEPT

Intended use is of the form: `list_1 EXCEPT list_2'; this construct matches anything that matches list_1 unless it matches list_2. The EXCEPT operator can be used in daemon_lists and in client_lists. The EXCEPT operator can be nested: if the control language would permit the use of parentheses, `a EXCEPT b EXCEPT c' would parse as `(a EXCEPT (b EXCEPT c))'.

SHELL COMMANDS

Note that shell commands are not available on Microsoft Windows.

• If the first-matched access control rule contains a shell command, that command is subjected to %letter substitutions (see next section). The result is executed by a /bin/sh child process with standard input, output and error connected to /dev/null. Specify an `&' at the end of the command if you do not want to wait until it has completed.

• Shell commands should not rely on the PATH setting of the inetd. Instead, they should use absolute path names, or they should begin with an explicit PATH=whatever statement.

% EXPANSIONS

The following expansions are available within shell commands:

%a (%A)

The client (server) host address.

%c

Client information: user@host, user@address, a host name, or just an address, depending on how much information is available.

%d

The daemon process name (argv[0] value).

%h (%H)

The client (server) host name or address, if the host name is unavailable.

%n (%N)

The client (server) host name (or "unknown").

%p

The daemon process id.

%s

Server information: daemon@host, daemon@address, or just a daemon name, depending on how much information is available.

%u

The client user name (or "unknown").

%%

Expands to a single `%' character.

Characters in % expansions that may confuse the shell are replaced by underscores.

Examples

The language is flexible enough that different types of access control policy can be expressed with a minimum of fuss. Although the language uses two access control tables, the most common policies can be implemented with one of the tables being trivial or even empty.

When reading the examples below it is important to realize that the allow table is scanned before the deny table, that the search terminates when a match is found, and that access is granted when no match is found at all.

The examples use host and domain names. They can be improved by including address and/or network/netmask information, to reduce the impact of temporary name server lookup failures.

MOSTLY CLOSED

In this case, access is denied by default. Only explicitly authorized hosts are permitted access.

The default policy (no access) is implemented with a trivial deny file:

instance-path/config/hosts.deny: ALL: ALL

This denies all service to all hosts, unless they are permitted access by entries in the allow file.

The explicitly authorized hosts are listed in the allow file. For example:

instance-path/config/hosts.allow: ALL: LOCAL ALL: .foobar.edu EXCEPT terminalserver.foobar.edu

The first rule permits access from hosts in the local domain (no `.' in the host name). The second rule permits access from all hosts in the .foobar.edu domain (notice the leading period), with the exception of terminalserver.foobar.edu.

MOSTLY OPEN

Here, access is granted by default; only explicitly specified hosts are refused service.

The default policy (access granted) makes the allow file redundant so that it can be omitted. The explicitly non-authorized hosts are listed in the deny file. For example:

instance-path/config/hosts.deny: ALL: some.host.name, .some.domain ALL EXCEPT 1389: other.host.name, .other.domain

The first rule denies some hosts and domains all services; the second rule still permits connections to directory port 1389 from other hosts and domains.

BOOBY TRAPS

The next example permits requests to Directory Server port 1389 from hosts in the local domain (notice the leading dot). Requests from any other hosts are denied. Instead of the requested file, a finger probe is sent to the offending host. The result is mailed to the superuser.

instance-path/config/hosts.allow: 1389: LOCAL, .my.domain

instance-path/config/hosts.deny: ALL: (/usr/sfw/sbin/safe_finger -l @%h | \ /usr/ucb/mail -s %d-%h root) &

The above example assumes that the safe_finger command is installed in /usr/sfw/sbin. For Solaris, the safe_finger command is in the SUNWtcpd package. The default location for the safe_finger command in the SUNWtcpd package is "/usr/sfw/sbin". For other operating systems the safe_finger command should be installed in a suitable place. The safe_finger command limits possible damage from data sent by the remote finger server, and gives better protection than the standard finger command. Shell commands for Windows is not supported, so Windows users should not use this rule.

The expansion of the %h (client host) and %d (service name) sequences is described in the section on shell commands.

Warning: do not booby-trap your finger daemon, unless you are prepared for infinite finger loops.

On network firewall systems this trick can be carried even further. The typical network firewall only provides a limited set of services to the outer world. All other services can be "bugged" just like the above tftp example. The result is an excellent early-warning system.

Diagnostics

An error is reported when a syntax error is found in a host access control rule; when the length of an access control rule exceeds the capacity of an internal buffer (2048); when an access control rule is not terminated by a newline character; when the result of %letter expansion would overflow an internal buffer; when a system call fails that should not. All problems are written to the Directory Server instance access log.

Files

instance-path/config/hosts.allow, (daemon,client) pairs are granted access. instance-path/config/hosts.deny, (daemon,client) pairs are denied access.

See Also

tcpd(1M) tcp/ip daemon wrapper program. tcpdchk(1M), tcpdmatch(1M), test programs.

Bugs

If a name server lookup times out, the host name will not be available to the access control software, even though the host is registered.

AUTHOR

Wietse Venema (wietse@wzv.win.tue.nl)

Department of Mathematics and Computing Science

Eindhoven University of Technology

Den Dolech 2, P.O. Box 513,

5600 MB Eindhoven, The Netherlands

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWldap-directory
Stability Level	External

DS 6.2  Last Revised October 26, 2006

NAME | Synopsis | Description | Examples | Diagnostics | Files | See Also | Bugs | AUTHOR | Attributes