git.sur5r.net Git - openldap/blob - 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> <targetattr> <newattr> <remoteOC> <localOC> <targetOC> <baseDN>
  49 Specify a DN-valued attributeType whose values will be dereferenced. The
  50 .B <targetattr>
  51 of the target entry will be retrieved and its value will be added to the
  52 .B <newattr>
  53 in the entry. In addition, searches using a filter of the form
  54 .B (&(objectClass=<localOC>)(<newattr>=xxx))
  55 will be rewritten into the form
  56 .BR (&(objectClass=<remoteOC>)(<dnattr>=xxx-DN)) .
  57 This rewrite will accomplished by performing an additional internal search,
  58 with subtree scope, using the specified baseDN and a filter of the form
  59 .BR (&(objectClass=<targetOC>)(<targetattr>=xxx)) .
  60
  61
  62 .SH EXAMPLE
  63 This example configures the
  64 .B adremap
  65 overlay to map all
  66 .B uid
  67 attributes to lowercase, and create
  68 .B memberUid
  69 values for group entries. The mapping will turn requests for posixGroup
  70 entries into requests for groupOfNames entries, and the internal search
  71 will use inetOrgPerson entries under the ou=People,dc=example,dc=com subtree.
  72
  73 Add the following to
  74 .BR slapd.conf (5):
  75
  76 .LP
  77 .nf
  78     database <database>
  79     # ...
  80
  81     overlay adremap
  82     adremap-downcase uid
  83     adremap-dnmap member uid memberUid groupOfNames posixGroup inetOrgPerson ou=people,dc=example,dc=com
  84 .fi
  85 .LP
  86 .B slapd
  87 must also load
  88 .B adremap.la,
  89 if compiled as a run-time module;
  90
  91 .SH FILES
  92 .TP
  93 ETCDIR/slapd.conf
  94 default slapd configuration file
  95 .SH SEE ALSO
  96 .BR slapd.conf (5),
  97 .BR slapd (8).
  98 The
  99 .BR slapo-adremap (5)
 100 overlay supports dynamic configuration via
 101 .BR back-config.
 102 .SH ACKNOWLEDGEMENTS
 103 .P
 104 This module was written in 2015 by Howard Chu.