]> git.sur5r.net Git - openldap/blob - contrib/slapd-modules/adremap/slapo-adremap.5
New ADremap overlay
[openldap] / contrib / slapd-modules / adremap / slapo-adremap.5
1 .TH SLAPO-ADREMAP 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2015 Howard Chu, All Rights Reserved.
3 .\" $OpenLDAP$
4 .SH NAME
5 slapo-adremap \- AD Remap overlay to slapd
6 .SH SYNOPSIS
7 ETCDIR/slapd.conf
8 .SH DESCRIPTION
9 The
10 .B adremap
11 overlay to
12 .BR slapd (8)
13 remaps some attribute values for compatibility between Microsoft AD
14 and older POSIX systems' PAM/NSS clients. It can be configured to
15 convert values of given attributes to lower case, and it can be
16 configured to generate RFC2307-compliant group memberships based
17 on RFC2307bis groups. All mapping is only performed on entries
18 returned as search responses.
19
20 .SH CONFIGURATION
21 The config directives that are specific to the
22 .B adremap
23 overlay must be prefixed by
24 .BR adremap\- ,
25 to avoid potential conflicts with directives specific to the underlying 
26 database or to other stacked overlays.
27
28 .TP
29 .B overlay adremap
30 This directive adds the
31 .B adremap
32 overlay to the current database, see
33 .BR slapd.conf (5)
34 for details.
35
36 .LP
37 These
38 .B slapd.conf
39 configuration options are defined for the adremap overlay. They must
40 appear after the
41 .B overlay
42 directive. They can each be specified multiple times:
43 .TP
44 .B adremap-downcase <attr>
45 Specify an attributeType whose values will all be mapped to lowercase
46 when returned in search responses.
47 .TP
48 .B adremap-dnmap <dnattr> <derefattr> <newattr>
49 Specify a DN-valued attributeType whose values will be dereferenced. The
50 .B <derefattr>
51 of the target entry will be retrieved and its value will be added to the
52 .B <newattr>
53 in the entry.
54
55 .SH EXAMPLE
56 This example configures the
57 .B adremap
58 overlay to map all
59 .B uid
60 attributes to lowercase, and create
61 .B memberUid
62 values for group entries.
63 Add the following to
64 .BR slapd.conf (5):
65
66 .LP
67 .nf
68     database <database>
69     # ...
70
71     overlay adremap
72     adremap-downcase uid
73         adremap-dnmap member uid memberUid
74 .fi
75 .LP
76 .B slapd
77 must also load
78 .B adremap.la,
79 if compiled as a run-time module;
80
81 .SH FILES
82 .TP
83 ETCDIR/slapd.conf
84 default slapd configuration file
85 .SH SEE ALSO
86 .BR slapd.conf (5),
87 .BR slapd (8).
88 The
89 .BR slapo-adremap (5)
90 overlay supports dynamic configuration via
91 .BR back-config.
92 .SH ACKNOWLEDGEMENTS
93 .P
94 This module was written in 2015 by Howard Chu.