slapo-rwm

title: slapo-rwm(5)

summary: rewrite/remap overlay to slapd

text:
# slapo-rwm(5)

## NAME
slapo-rwm - rewrite/remap overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The rwm overlay to slapd(8) performs basic DN/data rewrite and objectClass/attributeType mapping. Its usage is mostly intended to provide virtual views of existing data either remotely, in conjunction with the proxy backend described in slapd-ldap(5), or locally, in conjunction with the relay backend described in slapd-relay(5).

This overlay is experimental.

## MAPPING
An important feature of the rwm overlay is the capability to map objectClasses and attributeTypes from the local set (or a subset of it) to a foreign set, and vice versa. This is accomplished by means of the rwm-map directive.

rwm-map {attribute | objectclass} [<local name> | *] {<foreign name> | *}

Map attributeTypes and objectClasses from the foreign server to different values on the local slapd. The reason is that some attributes might not be part of the local slapd's schema, some attribute names might be different but serve the same purpose, etc. If local or foreign name is `*', the name is preserved. If local name is omitted, the foreign name is removed. Unmapped names are preserved if both local and foreign name are `*', and removed if local name is omitted and foreign name is `*'.

The local objectClasses and attributeTypes must be defined in the local schema; the foreign ones do not have to, but users are encouraged to explicitly define the remote attributeTypes and the objectClasses they intend to map. All in all, when remapping a remote server via back-ldap (slapd-ldap(5)) or back-meta (slapd-meta(5)) their definition can be easily obtained by querying the subschemaSubentry of the remote server; the problem should not exist when remapping a local database. Note, however, that the decision whether to rewrite or not attributeTypes with distinguishedName syntax, requires the knowledge of the attributeType syntax. See the REWRITING section for details.

Note that when mapping DN-valued attributes from local to remote, first the DN is rewritten, and then the attributeType is mapped; while mapping from remote to local, first the attributeType is mapped, and then the DN is rewritten. As such, it is important that the local attributeType is appropriately defined as using the distinguishedName syntax. Also, note that there are DN-related syntaxes (i.e. compound types with a portion that is DN-valued), like nameAndOptionalUID, whose values are currently not rewritten.

If the foreign type of an attribute mapping is not defined on the local server, it might be desirable to have the attribute values normalized after the mapping process. Not normalizing the values can lead to wrong results, when the rwm overlay is used together with e.g. the pcache overlay. This normalization can be enabled by means of the rwm-normalize-mapped-attrs directive.

rwm-normalize-mapped-attrs {yes|no}

Set this to "yes", if the rwm overlay should try to normalize the values of attributes that are mapped from an attribute type that is unknown to the local server. The default value of this setting is "no".

rwm-drop-unrequested-attrs {yes|no}

Set this to "yes", if the rwm overlay should drop attributes that are not explicitly requested by a search operation. When this is set to "no", the rwm overlay will leave all attributes in place, so that subsequent modules can further manipulate them. In any case, unrequested attributes will be omitted from search results by the frontend, when the search entry response package is encoded. The default value of this setting is "yes".

## SUFFIX MASSAGING
A basic feature of the rwm overlay is the capability to perform suffix massaging between a virtual and a real naming context by means of the rwm-suffixmassage directive. This, in conjunction with proxy backends, slapd-ldap(5) and slapd-meta(5), or with the relay backend, slapd-relay(5), allows one to create virtual views of databases. A distinguishing feature of this overlay is that, when instantiated before any database, it can modify the DN of requests before database selection. For this reason, rules that rewrite the empty DN ("") or the subschemaSubentry DN (usually "cn=subschema"), would prevent clients from reading the root DSE or the DSA's schema.

rwm-suffixmassage [<virtual naming context>] <real naming context>

Shortcut to implement naming context rewriting; the trailing part of the DN is rewritten from the virtual to the real naming context in the bindDN, searchDN, searchFilterAttrDN, compareDN, compareAttrDN, addDN, addAttrDN, modifyDN, modifyAttrDN, modrDN, newSuperiorDN, deleteDN, exopPasswdDN, and from the real to the virtual naming context in the searchEntryDN, searchAttrDN and matchedDN rewrite contexts. By default no rewriting occurs for the searchFilter and for the referralAttrDN and referralDN rewrite contexts. If no <virtual naming context> is given, the first suffix of the database is used; this requires the rwm-suffixmassage directive be defined after the database suffix directive. The rwm-suffixmassage directive automatically sets the rwm-rewriteEngine to ON.

See the REWRITING section for details.

## REWRITING
A string is rewritten according to a set of rules, called a `rewrite context'. The rules are based on POSIX (''extended'') regular expressions with substring matching; basic variable substitution and map resolution of substrings is allowed by specific mechanisms detailed in the following. The behavior of pattern matching/substitution can be altered by a set of flags.

```
<rewrite context> ::= <rewrite rule> [...]
<rewrite rule> ::= <pattern> <action> [<flags>]
```

The underlying concept is to build a lightweight rewrite module for the slapd server (initially dedicated to the LDAP backend):

## Passes
An incoming string is matched against a set of rewriteRules. Rules are made of a regex match pattern, a substitution pattern and a set of actions, described by a set of optional flags. In case of match, string rewriting is performed according to the substitution pattern that allows one to refer to substrings matched in the incoming string. The actions, if any, are finally performed. Each rule is executed recursively, unless altered by specific action flags; see "Action Flags" for details. A default limit on the recursion level is set, and can be altered by the rwm-rewriteMaxPasses directive, as detailed in the "Additional Configuration Syntax" section. The substitution pattern allows map resolution of substrings. A map is a generic object that maps a substitution pattern to a value. The flags are divided in "Pattern Matching Flags" and "Action Flags"; the former alter the regex match pattern behavior, while the latter alter the actions that are taken after substitution.

## Pattern Matching Flags
`C'

honors case in matching (default is case insensitive)

`R'

use POSIX ''basic'' regular expressions (default is ''extended'')

`M{n}'

allow no more than n recursive passes for a specific rule; does not alter the max total count of passes, so it can only enforce a stricter limit for a specific rule.

## Action Flags
`:'

apply the rule once only (default is recursive)

`@'

stop applying rules in case of match; the current rule is still applied recursively; combine with `:' to apply the current rule only once and then stop.

`#'

stop current operation if the rule matches, and issue an `unwilling to perform' error.

`G{n}'

jump n rules back and forth (watch for loops!). Note that `G{1}' is implicit in every rule.

`I'

ignores errors in rule; this means, in case of error, e.g. issued by a map, the error is treated as a missed match. The `unwilling to perform' is not overridden.

`U{n}'

uses n as return code if the rule matches; the flag does not alter the recursive behavior of the rule, so, to have it performed only once, it must be used in combination with `:', e.g. `:U{32}' returns the value `32' (indicating noSuchObject) after exactly one execution of the rule, if the pattern matches. As a consequence, its behavior is equivalent to `@', with the return code set to n; or, in other words, `@' is equivalent to `U{0}'. Positive errors are allowed, indicating the related LDAP error codes as specified in draft-ietf-ldapbis-protocol.

The ordering of the flags can be significant. For instance: `IG{2}' means ignore errors and jump two lines ahead both in case of match and in case of error, while `G{2}I' means ignore errors, but jump two lines ahead only in case of match.

More flags (mainly Action Flags) will be added as needed.

## Pattern Matching
See regex(7) and/or re_format(7).

## Substitution Pattern Syntax
Everything starting with `$' requires substitution;

the only obvious exception is `$$', which is turned into a single `$';

the basic substitution is `$<d>', where `<d>' is a digit; 0 means the whole string, while 1-9 is a submatch, as discussed in regex(7) and/or re_format(7).

a `$' followed by a `{' invokes an advanced substitution. The pattern is:

`$' `{' [ <operator> ] <name> `(' <substitution> `)' `}'

where <name> must be a legal name for the map, i.e.

```
<name> ::= [a-z][a-z0-9]* (case insensitive)
<operator> ::= `>' `|' `&' `&&' `*' `**' `$'
```

and <substitution> must be a legal substitution pattern, with no limits on the nesting level.

The operators are:

>

sub-context invocation; <name> must be a legal, already defined rewrite context name

|

external command invocation; <name> must refer to a legal, already defined command name (NOT IMPLEMENTED YET)

&

variable assignment; <name> defines a variable in the running operation structure which can be dereferenced later; operator & assigns a variable in the rewrite context scope; operator && assigns a variable that scopes the entire session, e.g. its value can be dereferenced later by other rewrite contexts

*

variable dereferencing; <name> must refer to a variable that is defined and assigned for the running operation; operator * dereferences a variable scoping the rewrite context; operator ** dereferences a variable scoping the whole session, e.g. the value is passed across rewrite contexts

$

parameter dereferencing; <name> must refer to an existing parameter; the idea is to make some run-time parameters set by the system available to the rewrite engine, as the client host name, the bind DN if any, constant parameters initialized at config time, and so on; no parameter is currently set by either back-ldap or back-meta, but constant parameters can be defined in the configuration file by using the rewriteParam directive.

Substitution escaping has been delegated to the `$' symbol, which is used instead of `\' in string substitution patterns because `\' is already escaped by slapd's low level parsing routines; as a consequence, regex escaping requires two `\' symbols, e.g. `.*\.foo\.bar' must be written as `.*\\.foo\\.bar'.

## Rewrite Context
A rewrite context is a set of rules which are applied in sequence. The basic idea is to have an application initialize a rewrite engine (think of Apache's mod_rewrite ...) with a set of rewrite contexts; when string rewriting is required, one invokes the appropriate rewrite context with the input string and obtains the newly rewritten one if no errors occur.

Each basic server operation is associated to a rewrite context; they are divided in two main groups: client -> server and server -> client rewriting.

client -> server:

```
(default)            if defined and no specific context

                     is available
bindDN               bind
searchDN             search
searchFilter         search
searchFilterAttrDN   search
compareDN            compare
compareAttrDN        compare AVA
addDN                add
addAttrDN            add AVA (DN portion of "ref" excluded)
modifyDN             modify
modifyAttrDN         modify AVA (DN portion of "ref" excluded)
referralAttrDN       add/modify DN portion of referrals

                     (default to none)
renameDN             modrdn (the old DN)
newSuperiorDN        modrdn (the new parent DN, if any)
newRDN               modrdn (the new relative DN)
deleteDN             delete
exopPasswdDN         password modify extended operation DN
```

server -> client:

```
searchEntryDN        search (only if defined; no default;

                     acts on DN of search entries)
searchAttrDN         search AVA (only if defined; defaults

                     to searchEntryDN; acts on DN-syntax

                     attributes of search results)
matchedDN            all ops (only if applicable; defaults

                     to searchEntryDN)
referralDN           all ops (only if applicable; defaults

                     to none)
```

## Basic Configuration Syntax
All rewrite/remap directives start with the prefix rwm-; for backwards compatibility with the historical slapd-ldap(5) and slapd-meta(5) builtin rewrite/remap capabilities, the prefix may be omitted, but this practice is strongly discouraged.

rwm-rewriteEngine { on | off }

If `on', the requested rewriting is performed; if `off', no rewriting takes place (an easy way to stop rewriting without altering too much the configuration file).

rwm-rewriteContext <context name> [ alias <aliased context name> ]

<Context name> is the name that identifies the context, i.e. the name used by the application to refer to the set of rules it contains. It is used also to reference sub contexts in string rewriting. A context may alias another one. In this case the alias context contains no rule, and any reference to it will result in accessing the aliased one.

rwm-rewriteRule <regex match pattern> <substitution pattern> [ <flags> ]

Determines how a string can be rewritten if a pattern is matched. Examples are reported below.

## Additional Configuration Syntax
rwm-rewriteMap <map type> <map name> [ <map attrs> ]

Allows one to define a map that transforms substring rewriting into something else. The map is referenced inside the substitution pattern of a rule.

rwm-rewriteParam <param name> <param value>

Sets a value with global scope, that can be dereferenced by the command `${$paramName}'.

rwm-rewriteMaxPasses <number of passes> [<number of passes per rule>]

Sets the maximum number of total rewriting passes that can be performed in a single rewrite operation (to avoid loops). A safe default is set to 100; note that reaching this limit is still treated as a success; recursive invocation of rules is simply interrupted. The count applies to the rewriting operation as a whole, not to any single rule; an optional per-rule limit can be set. This limit is overridden by setting specific per-rule limits with the `M{n}' flag.

## MAPS
Currently, few maps are builtin but additional map types may be registered at runtime.

Supported maps are:

LDAP <URI> [bindwhen=<when>] [version=<version>] [binddn=<DN>] [credentials=<cred>]

The LDAP map expands a value by performing a simple LDAP search. Its configuration is based on a mandatory URI, whose attrs portion must contain exactly one attribute (use entryDN to fetch the DN of an entry). If a multi-valued attribute is used, only the first value is considered. The parameter bindwhen determines when the connection is established. It can take the values now, later, and everytime, respectively indicating that the connection should be created at startup, when required, or any time it is used. In the former two cases, the connection is cached, while in the latter a fresh new one is used all times. This is the default.

The parameters binddn and credentials represent the DN and the password that is used to perform an authenticated simple bind before performing the search operation; if not given, an anonymous connection is used.

The parameter version can be 2 or 3 to indicate the protocol version that must be used. The default is 3.

slapd <URI>

The slapd map expands a value by performing an internal LDAP search. Its configuration is based on a mandatory URI, which must begin with ldap:/// (i.e., it must be an LDAP URI and it must not specify a host). As with the LDAP map, the attrs portion must contain exactly one attribute, and if a multi-valued attribute is used, only the first value is considered.

## REWRITE CONFIGURATION EXAMPLES

```
# set to `off' to disable rewriting
rwm-rewriteEngine on
# the rules the "suffixmassage" directive implies
rwm-rewriteEngine on
# all dataflow from client to server referring to DNs
rwm-rewriteContext default
rwm-rewriteRule "(.+,)?<virtualnamingcontext>$" "$1<realnamingcontext>" ":"
# empty filter rule
rwm-rewriteContext searchFilter
# all dataflow from server to client
rwm-rewriteContext searchEntryDN
rwm-rewriteRule "(.+,)?<realnamingcontext>$" "$1<virtualnamingcontext>" ":"
rwm-rewriteContext searchAttrDN alias searchEntryDN
rwm-rewriteContext matchedDN alias searchEntryDN
# misc empty rules
rwm-rewriteContext referralAttrDN
rwm-rewriteContext referralDN
# Everything defined here goes into the `default' context.
# This rule changes the naming context of anything sent
# to `dc=home,dc=net' to `dc=OpenLDAP, dc=org'
rwm-rewriteRule "(.+,)?dc=home,[ ]?dc=net$"

            "$1dc=OpenLDAP, dc=org"  ":"
# since a pretty/normalized DN does not include spaces
# after rdn separators, e.g. `,', this rule suffices:
rwm-rewriteRule "(.+,)?dc=home,dc=net$"

            "$1dc=OpenLDAP,dc=org"  ":"
# Start a new context (ends input of the previous one).
# This rule adds blanks between DN parts if not present.
rwm-rewriteContext  addBlanks
rwm-rewriteRule     "(.*),([^ ].*)" "$1, $2"
# This one eats blanks
rwm-rewriteContext  eatBlanks
rwm-rewriteRule     "(.*), (.*)" "$1,$2"
# Here control goes back to the default rewrite
# context; rules are appended to the existing ones.
# anything that gets here is piped into rule `addBlanks'
rwm-rewriteContext  default
rwm-rewriteRule     ".*" "${>addBlanks($0)}" ":"
# Rewrite the search base according to `default' rules.
rwm-rewriteContext  searchDN alias default
# Search results with OpenLDAP DN are rewritten back with
# `dc=home,dc=net' naming context, with spaces eaten.
rwm-rewriteContext  searchEntryDN
rwm-rewriteRule     "(.*[^ ],)?[ ]?dc=OpenLDAP,[ ]?dc=org$"

                "${>eatBlanks($1)}dc=home,dc=net"    ":"
# Bind with email instead of full DN: we first need
# an ldap map that turns attributes into a DN (the
# argument used when invoking the map is appended to
# the URI and acts as the filter portion)
rwm-rewriteMap ldap attr2dn "ldap://host/dc=my,dc=org?dn?sub"
# Then we need to detect DN made up of a single email,
# e.g. `mail=someone@example.com'; note that the rule
# in case of match stops rewriting; in case of error,
# it is ignored.  In case we are mapping virtual
# to real naming contexts, we also need to rewrite
# regular DNs, because the definition of a bindDN
# rewrite context overrides the default definition.
rwm-rewriteContext bindDN
rwm-rewriteRule "^mail=[^,]+@[^,]+$" "${attr2dn($0)}" ":@I"
# This is a rather sophisticated example. It massages a
# search filter in case who performs the search has
# administrative privileges.  First we need to keep
# track of the bind DN of the incoming request, which is
# stored in a variable called `binddn' with session scope,
# and left in place to allow regular binding:
rwm-rewriteContext  bindDN
rwm-rewriteRule     ".+" "${&&binddn($0)}$0" ":"
# A search filter containing `uid=' is rewritten only
# if an appropriate DN is bound.
# To do this, in the first rule the bound DN is
# dereferenced, while the filter is decomposed in a
# prefix, in the value of the `uid=<arg>' AVA, and
# in a suffix. A tag `<>' is appended to the DN.
# If the DN refers to an entry in the `ou=admin' subtree,
# the filter is rewritten OR-ing the `uid=<arg>' with
# `cn=<arg>'; otherwise it is left as is. This could be
# useful, for instance, to allow apache's auth_ldap-1.4
# module to authenticate users with both `uid' and
# `cn', but only if the request comes from a possible
# `cn=Web auth,ou=admin,dc=home,dc=net' user.
rwm-rewriteContext searchFilter
rwm-rewriteRule "(.*\\()uid=([a-z0-9_]+)(\\).*)"

  "${**binddn}<>${&prefix($1)}${&arg($2)}${&suffix($3)}"

  ":I"
rwm-rewriteRule "^[^,]+,ou=admin,dc=home,dc=net$"

  "${*prefix}|(uid=${*arg})(cn=${*arg})${*suffix}" ":@I"
rwm-rewriteRule ".*<>$" "${*prefix}uid=${*arg}${*suffix}" ":"
# This example shows how to strip unwanted DN-valued
# attribute values from a search result; the first rule
# matches DN values below "ou=People,dc=example,dc=com";
# in case of match the rewriting exits successfully.
# The second rule matches everything else and causes
# the value to be rejected.
rwm-rewriteContext searchEntryDN
rwm-rewriteRule ".+,ou=People,dc=example,dc=com$" "$0" ":@"
rwm-rewriteRule ".*" "" "#"
```

## MAPPING EXAMPLES
The following directives map the object class `groupOfNames' to the object class `groupOfUniqueNames' and the attribute type `member' to the attribute type `uniqueMember':

```
map objectclass groupOfNames groupOfUniqueNames
map attribute uniqueMember member
```

This presents a limited attribute set from the foreign server:

```
map attribute cn *
map attribute sn *
map attribute manager *
map attribute description *
map attribute *
```

These lines map cn, sn, manager, and description to themselves, and any other attribute gets "removed" from the object before it is sent to the client (or sent up to the LDAP server). This is obviously a simplistic example, but you get the point.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5), slapd-ldap(5), slapd-meta(5), slapd-relay(5), slapd(8), regex(7), re_format(7).

## AUTHOR
Pierangelo Masarati; based on back-ldap rewrite/remap features by Howard Chu, Pierangelo Masarati.


slapo-sssvlv

package: openldap-servers

title: slapo-sssvlv(5)

text:
# slapo-sssvlv(5)

## NAME
slapo-sssvlv - Server Side Sorting and Virtual List View overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
This overlay implements the LDAP Server Side Sorting (RFC2891) control as well as the Virtual List View control. It also replaces the default implementation of the LDAP PagedResults (RFC2696) control, to ensure that it works with Sorting. The overlay can be used with any backend or globally for all backends.

Since a complete result set must be generated in memory before sorting can be performed, processing sort requests can have a large impact on the server's memory use. As such, any connection is limited to having only a limited number of sort requests active at a time. Additional limits may be configured as described below.

## CONFIGURATION
These slapd.conf options apply to the SSSVLV overlay. They should appear after the overlay directive.

sssvlv-max <num>

Set the maximum number of concurrent sort requests allowed across all connections. The default is one half of the number of server threads.

sssvlv-maxkeys <num>

Set the maximum number of keys allowed in a sort request. The default is 5.

sssvlv-maxperconn <num>

Set the maximum number of concurrent paged search requests per connection. The default is 5. The number of concurrent requests remains limited by sssvlv-max.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

/etc/openldap/slapd.d

default slapd configuration directory

## SEE ALSO
slapd.conf(5), slapd-config(5).

"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)

IETF LDAP Virtual List View proposal by D. Boreham, J. Sermersheim, and A. Kashi in IETF document "draft-ietf-ldapext-ldapv3-vlv-09.txt".

## AUTHOR
Howard Chu


slapo-syncprov

title: slapo-syncprov(5)

summary: Sync Provider overlay to slapd

text:
# slapo-syncprov(5)

## NAME
slapo-syncprov - Sync Provider overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The Sync Provider overlay implements the provider-side support for the LDAP Content Synchronization (RFC4533) as well as syncrepl replication support. The overlay can be used with any backend that maintains entryCSN and entryUUID attributes for its entries. It also creates a contextCSN attribute in the root entry of the database.

The contextCSN is updated for every write operation performed against the database. To reduce database contention, the contextCSN is only updated in memory. The value is written to the database on server shutdown and read into memory on startup, and maintained in memory thereafter. Checkpoints may be configured to write the contextCSN into the underlying database to minimize recovery time after an unclean shutdown.

On databases that support inequality indexing, it is mandatory to set an eq index on the entryCSN attribute when using this overlay.

## CONFIGURATION
These slapd.conf options apply to the Sync Provider overlay. They should appear after the overlay directive.

syncprov-checkpoint <ops> <minutes>

After a write operation has succeeded, write the contextCSN to the underlying database if <ops> write operations or more than <minutes> time have passed since the last checkpoint. Checkpointing is disabled by default.

syncprov-sessionlog <ops>

Configures an in-memory session log for recording information about write operations made on the database. The <ops> specifies the number of operations that are recorded in the log. All write operations (except Adds) are recorded in the log. When using the session log, it is helpful to set an eq index on the entryUUID attribute in the underlying database.

syncprov-nopresent TRUE | FALSE

Specify that the Present phase of refreshing should be skipped. This value should only be set TRUE for a syncprov instance on top of a log database (such as one managed by the accesslog overlay). The default is FALSE.

syncprov-reloadhint TRUE | FALSE

Specify that the overlay should honor the reloadHint flag in the Sync Control. It must be set TRUE when using the accesslog overlay for delta-based syncrepl replication support. The default is FALSE.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5), slapo-accesslog(5). OpenLDAP Administrator's Guide.

## ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from the University of Michigan LDAP 3.3 Release.


slapo-translucent

title: slapo-translucent(5)

summary: Translucent Proxy overlay to slapd

text:
# slapo-translucent(5)

## NAME
slapo-translucent - Translucent Proxy overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The Translucent Proxy overlay can be used with a backend database such as slapd-bdb(5) to create a "translucent proxy". Entries retrieved from a remote LDAP server may have some or all attributes overridden, or new attributes added, by entries in the local database before being presented to the client.

A search operation is first populated with entries from the remote LDAP server, the attributes of which are then overridden with any attributes defined in the local database. Local overrides may be populated with the add, modify , and modrdn operations, the use of which is restricted to the root user.

A compare operation will perform a comparison with attributes defined in the local database record (if any) before any comparison is made with data in the remote database.

## CONFIGURATION
The Translucent Proxy overlay uses a proxied database, typically a (set of) remote LDAP server(s), which is configured with the options shown in slapd-ldap(5), slapd-meta(5) or similar. These slapd.conf options are specific to the Translucent Proxy overlay; they must appear after the overlay directive that instantiates the translucent overlay.

translucent_strict

By default, attempts to delete attributes in either the local or remote databases will be silently ignored. The translucent_strict directive causes these modifications to fail with a Constraint Violation.

translucent_no_glue

This configuration option disables the automatic creation of "glue" records for an add or modrdn operation, such that all parents of an entry added to the local database must be created by hand. Glue records are always created for a modify operation.

translucent_local <attr[,attr...]>

Specify a list of attributes that should be searched for in the local database when used in a search filter. By default, search filters are only handled by the remote database. With this directive, search filters will be split into a local and remote portion, and local attributes will be searched locally.

translucent_remote <attr[,attr...]>

Specify a list of attributes that should be searched for in the remote database when used in a search filter. This directive complements the translucent_local directive. Attributes may be specified as both local and remote if desired.

If neither translucent_local nor translucent_remote are specified, the default behavior is to search the remote database with the complete search filter. If only translucent_local is specified, searches will only be run on the local database. Likewise, if only translucent_remote is specified, searches will only be run on the remote database. In any case, both the local and remote entries corresponding to a search result will be merged before being returned to the client.

translucent_bind_local

Enable looking for locally stored credentials for simple bind when binding to the remote database fails. Disabled by default.

translucent_pwmod_local

Enable RFC 3062 Password Modification extended operation on locally stored credentials. The operation only applies to entries that exist in the remote database. Disabled by default.

## ACCESS CONTROL
Access control is delegated to either the remote DSA(s) or to the local database backend for auth and write operations. It is delegated to the remote DSA(s) and to the frontend for read operations. Local access rules involving data returned by the remote DSA(s) should be designed with care. In fact, entries are returned by the remote DSA(s) only based on the remote fraction of the data, based on the identity the operation is performed as. As a consequence, local rules might only be allowed to see a portion of the remote data.

## CAVEATS
The Translucent Proxy overlay will disable schema checking in the local database, so that an entry consisting of overlay attributes need not adhere to the complete schema.

Because the translucent overlay does not perform any DN rewrites, the local and remote database instances must have the same suffix. Other configurations will probably fail with No Such Object and other errors.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5), slapd-ldap(5).


slapo-unique

title: slapo-unique(5)

summary: Attribute Uniqueness overlay to slapd

text:
# slapo-unique(5)

## NAME
slapo-unique - Attribute Uniqueness overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The Attribute Uniqueness overlay can be used with a backend database such as slapd-mdb(5) to enforce the uniqueness of some or all attributes within a scope. This subtree defaults to all objects within the subtree of the database for which the Uniqueness overlay is configured.

Uniqueness is enforced by searching the subtree to ensure that the values of all attributes presented with an add, modify or modrdn operation are unique within the scope. For example, if uniqueness were enforced for the uid attribute, the subtree would be searched for any other records which also have a uid attribute containing the same value. If any are found, the request is rejected.

The search is performed using the rootdn of the database, to avoid issues with ACLs preventing the overlay from seeing all of the relevant data. As such, the database must have a rootdn configured.

## CONFIGURATION
These slapd.conf options apply to the Attribute Uniqueness overlay. They should appear after the overlay directive.

unique_uri <[strict ][ignore ]URI[URI...]...>

Configure the base, attributes, scope, and filter for uniqueness checking. Multiple URIs may be specified within a domain, allowing complex selections of objects. Multiple unique_uri statements or olcUniqueURI attributes will create independent domains, each with their own independent lists of URIs and ignore/strict settings. Keywords strict and ignore have to be enclosed in quotes (") together with the URI.

The LDAP URI syntax is a subset of RFC-4516, and takes the form:

ldap:///[base dn]?[attributes...]?scope[?filter]

The base dn defaults to that of the back-end database. Specified base dns must be within the subtree of the back-end database.

If no attributes are specified, the URI applies to all non-operational attributes.

The scope component is effectively mandatory, because LDAP URIs default to base scope, which is not valid for uniqueness, because groups of one object are always unique. Scopes of sub (for subtree) and one for one-level are valid.

The filter component causes the domain to apply uniqueness constraints only to matching objects. e.g. ldap:///?cn?sub?(sn=e*) would require unique cn attributes for all objects in the subtree of the back-end database whose sn starts with an e.

It is possible to assert uniqueness upon all non-operational attributes except those listed by prepending the keyword ignore If not configured, all non-operational (e.g., system) attributes must be unique. Note that the attributes list of an ignore URI should generally contain the objectClass, dc, ou and o attributes, as these will generally not be unique, nor are they operational attributes.

It is possible to set strict checking for the uniqueness domain by prepending the keyword strict. By default, uniqueness is not enforced for null values. Enabling strict mode extends the concept of uniqueness to include null values, such that only one attribute within a subtree will be allowed to have a null value. Strictness applies to all URIs within a uniqueness domain, but some domains may be strict while others are not.

It is not possible to set both URIs and legacy slapo-unique configuration parameters simultaneously. In general, the legacy configuration options control pieces of a single unfiltered subtree domain.

unique_base <basedn>

This legacy configuration parameter should be converted to the base dn component of the above unique_uri style of parameter.

unique_ignore <attribute...>

This legacy configuration parameter should be converted to a unique_uri parameter with ignore keyword as described above.

unique_attributes <attribute...>

This legacy configuration parameter should be converted to a unique_uri parameter, as described above.

unique_strict <attribute...>

This legacy configuration parameter should be converted to a strict keyword prepended to a unique_uri parameter, as described above.

## CAVEATS
unique_uri cannot be used with the old-style of configuration, and vice versa. unique_uri can implement everything the older system can do, however.

Typical attributes for the ignore ldap:///... URIs are intentionally not hardcoded into the overlay to allow for maximum flexibility in meeting site-specific requirements.

Replication and operations with manageDsaIt control are allowed to bypass this enforcement. It is therefore important that all servers accepting writes have this overlay configured in order to maintain uniqueness in a replicated DIT.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5).


slapo-valsort

title: slapo-valsort(5)

summary: Value Sorting overlay to slapd

text:
# slapo-valsort(5)

## NAME
slapo-valsort - Value Sorting overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The Value Sorting overlay can be used with a backend database to sort the values of specific multi-valued attributes within a subtree. The sorting occurs whenever the attributes are returned in a search response.

Sorting can be specified in ascending or descending order, using either numeric or alphanumeric sort methods. Additionally, a "weighted" sort can be specified, which uses a numeric weight prepended to the attribute values. The weighted sort is always performed in ascending order, but may be combined with the other methods for values that all have equal weights. The weight is specified by prepending an integer weight {<weight>} in front of each value of the attribute for which weighted sorting is desired. This weighting factor is stripped off and not returned in search results unless the valsort control is specified (1.3.6.1.4.1.4203.666.5.14).

The valsort control requires a value consisting of a Sequence that contains a boolean flag. The weighting factor is only returned if the boolean value is TRUE. In lber-encode(3) format, the required value must conform to "{b}" syntax.

## CONFIGURATION
These slapd.conf options apply to the Value Sorting overlay. They should appear after the overlay directive.

valsort-attr <attribute> <baseDN> (<sort-method> | weighted [<sort-method>])

Configure a sorting method for the specified attribute in the subtree rooted at baseDN. The sort-method may be one of alpha-ascend, alpha-descend, numeric-ascend, or numeric-descend. If the special weighted method is specified, a secondary sort-method may also be specified. It is an error to specify an alphanumeric sort-method for an attribute with Integer or NumericString syntax, and it is an error to specify a numeric sort-method for an attribute with a syntax other than Integer or NumericString.

## EXAMPLES

```
	database bdb
	suffix dc=example,dc=com
	...
	overlay valsort
	valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
```

To invoke ldapsearch(1) with the valsort control, the control value must be set appropriately. The following octets represent the desired "{b}" encoding:

```
	0x30 0x03 0x01 0x01 0xff
```

The control can be sent from the command-line using the base64 encoding of the value:

```
	ldapsearch -E 1.3.6.1.4.1.4203.666.5.14=::MAMBAf8=
```

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5).

## ACKNOWLEDGEMENTS
This module was written in 2005 by Howard Chu of Symas Corporation. The work was sponsored by Stanford University.


Traits

package: openmotif-clients

title: Traits(5)

text:
# Traits(5)

## NAME
Traits — Lists the traits used by the Motif Toolkit.

## DESCRIPTION
A trait is a characteristic of a widget. A widget holding a particular trait is announcing a particular ability to other widgets. The following table summarizes the standard Motif traits.

Purpose of Each Trait

Trait Name

A Widget Holding This Trait Can Do The Following:

XmQTaccessTextual

Display one primary text parcel.

XmQTactivatable

Become a command button in a dialog box.

XmQTcareParentVisual

Borrow its parent's visual information.

XmQTcontainer

Manage container item children.

XmQTcontainerItem

Become a child of a container widget.

XmQTdialogShellSavvy

Become a child of a DialogShell.

XmQTjoinSide

Attach itself to one side of a suitable parent.

XmQTmenuSavvy

Become a menu child.

XmQTmenuSystem

Manage a menu system.

XmQTnavigator

Act as a navigator to a scrollable widget.

XmQTscrollFrame

Handle one or more navigator widgets.

XmQTspecifyRenderTable

Supply the names of its default render tables.

XmQTtakesDefault

Change its appearance to show that it is the default button.

XmQTtransfer

Transfer data to other widgets and/or receive data from other widgets

Traits are not often used in Motif application programs. However, traits are very important to widget writers. For complete details on traits, see the Motif Widget Writer's Guide.

The following table lists the names of all widgets and gadgets in the standard Motif widget set that hold a particular trait. For example, the following table shows that the XmQTcontainerItem trait is held by the XmIconGadget. As the table suggests, some traits are held by many of the standard Motif widgets.

Trait Installation in Standard Widget Set

Trait Name

Is Installed on The Following Widgets:

XmQTaccessTextual

XmLabel and all its subclasses; XmLabelGadget and all its subclasses; XmText; XmTextField

XmQTactivatable

XmArrowButton; XmArrowButtonGadget; XmDrawnButton; XmPushButton; XmPushButtonGadget

XmQTcareParentVisual

All the subclasses of XmGadget (but not XmGadget itself); XmPrimitive and all its subclasses

XmQTcontainer

XmContainer

XmQTcontainerItem

XmIconGadget

XmQTdialogShellSavvy

XmBulletinBoard

XmQTjoinSide

No widgets install this trait

XmQTmenuSavvy

XmLabel; XmDrawnButton; XmCascadeButton; XmPushButton; XmToggleButton; XmLabelGadget; XmCascadeButtonGadget; XmPushButtonGadget; XmToggleButtonGadget

XmQTmenuSystem

XmRowColumn

XmQTnavigator

XmScrollBar; XmSpinBox

XmQTscrollFrame

XmNotebook; XmScrolledWindow

XmQTspecifyRenderTable

XmBulletinBoard and all its subclasses; XmMenuShell; XmVendorShell

XmQTtakesDefault

XmPushButton; XmPushButtonGadget

XmQTtransfer

XmContainer; XmLabel and all its subclasses; XmLabelGadget and all its subclasses; XmList; XmScale; XmText; XmTextField

The following table lists the traits installed on each widget. For example, the following table indicates that the XmArrowButton widget holds both the XmQTactivatable and XmQTcareParentVisual traits.

Trait Use by

Widget

Widget Name

Installs These Traits

=

XmArrowButton

XmQTactivatable, XmQTcareParentVisual

XmArrowButtonGadget

XmQTactivatable, XmQTcareParentVisual

XmBulletinBoard

XmQTdialogShellSavvy, XmQTspecifyRenderTable

XmCascadeButton

XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtransfer

XmCascadeButtonGadget

XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtransfer XmComboBox

XmCommand

XmQTspecifyRenderTable

XmContainer

XmQTcontainer, XmQTtransfer

XmDialogShell

None

XmDisplay

None

XmDragContext

None

XmDragIcon

None

XmDrawingArea

None

XmDrawnButton

XmQTaccessTextual, XmQTactivatable, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtransfer

XmDropTransfer

None

XmFileSelectionBox

XmQTspecifyRenderTable

XmForm

XmQTspecifyRenderTable

XmFrame

None

XmGadget

None

XmIconGadget

XmQTcareParentVisual, XmQTcontainerItem

XmLabel

XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtransfer

XmLabelGadget

XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtransfer

XmList

XmQTcareParentVisual, XmQTtransfer

XmMainWindow

XmManager

XmMenuShell

XmQTspecifyRenderTable

XmMessageBox

XmQTspecifyRenderTable

XmNotebook

XmQTscrollFrame

XmPanedWindow

XmPrimitive

XmQTcareParentVisual

XmPushButton

XmQTaccessTextual, XmQTactivatable, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtakesDefault, XmQTtransfer

XmPushButtonGadget

XmQTaccessTextual, XmQTactivatable, XmQTcareParentVisual, XmQTmenuSavvy, XmQTtakesDefault, XmQTtransfer

XmRowColumn

XmQTmenuSystem

XmScale

XmQTtransfer

XmScreen

XmScrollbar

XmQTcareParentVisual, XmQTnavigator

XmScrolledWindow

XmQTscrollFrame

XmSelectionBox

XmQTspecifyRenderTable

XmSeparator

XmQTcareParentVisual

XmSeparatorGadget

XmQTcareParentVisual

XmSpinBox

XmQTnavigator

XmText

XmQTaccessTextual, XmQTcareParentVisual, XmQTtransfer

XmTextField

XmQTaccessTextual, XmQTcareParentVisual, XmQTtransfer

XmToggleButton

XmQTaccessTextual, XmQTcareParentVisual, XmQTtransfer

XmToggleButtonGadget

XmQTaccessTextual, XmQTcareParentVisual, XmQTtransfer

VendorShell

XmQTspecifyRenderTable

The following table summarizes how the standard Motif widgets access traits. There are two general ways for a widget to access the traits of another widget.

One way is for a widget to ask another widget if it holds a particular trait. For example, XmBulletinBoard asks each of its children widgets if they hold the XmQTtakesDefault trait. XmBulletinBoard calls none of the trait methods of XmQTtakesDefault.

Another kind of access is when one widget calls another widget's trait method(s). For example, XmBulletinBoard calls the getRenderTable trait method of the XmQTspecifyRenderTable trait.

Trait Access By

Widget

Widget

Accesses These Traits:

Calls These Trait Methods:

XmArrowButton

None

None

XmArrowButtonGadget

None

None

XmBulletinBoard

XmQTtakesDefault

None

XmBulletinBoard

XmQTspecifyRenderTable

getRenderTable

XmCascadeButton

XmQTmenuSystem

Many

XmCascadeButton

XmQTspecifyRenderTable

getRenderTable

XmCascadeButtonGadget

XmQTmenuSystem

Many

XmCascadeButtonGadget

XmQTspecifyRenderTable

getRenderTable

XmComboBox

XmQTaccessTextual

getValue, setValue

XmCommand

None

None

XmContainer

XmQTcontainerItem

getValues, setValues

XmContainer

XmQTscrollFrame

getInfo

XmDialogShell

XmQTdialogShellSavvy

callMapUnmapCB

XmDisplay

None

None

XmDragContext

None

None

XmDragIcon

None

None

XmDrawingArea

None

None

XmDrawnButton

XmQTmenuSystem

Many

XmDrawnButton

XmQTspecifyRenderTable

getRenderTable

XmDropTransfer

None

None

XmFileSelectionBox

XmQTactivatable

None

XmForm

None

None

XmFrame

None

None

XmGadget

None

None

XmIconGadget

XmQTcontainer

getValues

XmIconGadget

XmQTspecifyRenderTable

getRenderTable

XmLabel

XmQTmenuSystem

various methods

XmLabel

XmQTspecifyRenderTable

getRenderTable

XmLabelGadget

XmQTmenuSystem

various methods

XmLabelGadget

XmQTspecifyRenderTable

getRenderTable

XmList

XmQTnavigator

getValues

XmList

XmQTscrollFrame

getInfo, init

XmList

XmQTspecifyRenderTable

getRenderTable

XmMainWindow

XmQTmenuSystem

various methods

XmManager

None

None

XmMenuShell

XmQTmenuSystem

various methods

XmMenuShell

XmQTspecifyRenderTable

getRenderTable

XmMessageBox

XmQTactivatable

None

XmNotebook

XmQTscrollFrame

init, addNavigator, removeNavigator

XmNotebook

XmQTnavigator

getValue

XmNotebook

XmQTactivatable

changeCB

XmNotebook

XmQTaccessTextual

None

XmPanedWindow

None

None

XmPrimitive

None

None

XmPushButton

XmQTmenuSystem

various methods

XmPushButton

XmQTspecifyRenderTable

getRenderTable

XmPushButtonGadget

XmQTmenuSystem

various methods

XmPushButtonGadget

XmQTspecifyRenderTable

getRenderTable

XmRowColumn

XmQTmenuSavvy

getAccelerator, getMnemonic, getActivateCBName

XmRowColumn

XmQTmenuSystem

various methods

XmScale

XmQTspecifyRenderTable

getRenderTable

XmScreen

None

None

XmScrollbar

None

None

XmScrolledWindow

XmQTnavigator

getValue

XmScrolledWindow

XmQTscrollFrame

init, addNavigator

XmSelectionBox

XmQTaccessTextual

setValue;

XmSelectionBox

XmQTactivatable

None

XmSeparator

None

None

XmSeparatorGadget

None

None

XmSpinBox

XmQTaccessTextual

setValue

XmText

XmQTaccessTextual

getValue, setValue

XmText

XmQTnavigator

getValue

XmText

XmQTscrollFrame

getInfo, init

XmText

XmQTspecifyRenderTable

getRenderTable

XmTextField

XmQTspecifyRenderTable

getRenderTable

XmToggleButton

XmQTmenuSystem

various methods

XmToggleButton

XmQTspecifyRenderTable

getRenderTable

XmToggleButtonGadget

XmQTmenuSystem

various methods

XmToggleButtonGadget

XmQTspecifyRenderTable

getRenderTable

VendorShell

XmQTspecifyRenderTable

getRenderTable

## RELATED
The following reference pages are documented in the Motif Widget Writer's Guide: XmeTraitSet(3), XmeTraitGet(3), XmQTaccessTextual(3), XmQTactivatable(3), XmQTcareParentVisual(3), XmQTcontainer(3), XmQTcontainerItem(3), XmQTdialogShellSavvy(3), XmQTjoinSide(3), XmQTmenuSavvy(3), XmQTmenuSystem(3), XmQTnavigator(3), XmQTscrollFrame(3), XmQTspecifyRenderTable(3), and XmQTtakesDefault(3).