summaryrefslogtreecommitdiffstats
path: root/doc/man/man5/slapo-deref.5
blob: abd2dfe6112e96bac58b76d2b976975533e7484f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.TH SLAPO-DEREF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
.\" Copyright 2008-2022 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
slapo\-deref \- Dereference Control overlay to slapd
.SH SYNOPSIS
ETCDIR/slapd.conf
.TP
ETCDIR/slapd.d
.SH DESCRIPTION
This overlay implements the draft Dereference control. The overlay can be
used with any backend or globally for all backends.

.SH EXAMPLES
.nf
  database mdb
  ...
  overlay deref
.fi

Given these entries:
.nf
  dn: cn=Howard Chu,ou=people,dc=example,dc=org
  objectClass: inetOrgPerson
  cn: Howard Chu
  sn: Chu
  uid: hyc

  dn: cn=Pierangelo Masarati,ou=people,dc=example,dc=org
  objectClass: inetOrgPerson
  cn: Pierangelo Masarati
  sn: Masarati
  uid: ando

  dn: cn=Test Group,ou=groups,dc=example,dc=org
  objectClass: groupOfNames
  cn: Test Group
  member: cn=Howard Chu,ou=people,dc=example,dc=org
  member: cn=Pierangelo Masarati,ou=people,dc=example,dc=org
.fi

A search could be performed with a Dereference request control value
specified as

.nf
  { member, uid }
.fi

I.e.,
.nf
  ldapsearch -x -b dc=example,dc=org -E 'deref=member:uid'
.fi

and the "cn=Test Group" entry would be returned with the response
control value
.nf
  { { member, cn=Howard Chu,ou=people,dc=example,dc=org,
      { { uid, [hyc] } } },
    { member, cn=Pierangelo Masarati,ou=people,dc=example,dc=org,
      { { uid, [ando] } } } }
.fi

.SH FILES
.TP
ETCDIR/slapd.conf
default slapd configuration file
.TP
ETCDIR/slapd.d
default slapd configuration directory
.SH SEE ALSO
.BR slapd.conf (5),
.BR slapd\-config (5).
.LP
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
.LP
IETF LDAP Dereference Control proposal by P. Masarati, H. Chu,
in IETF document "draft-masarati-ldap-deref-00.txt".
.SH AUTHOR
Pierangelo Masarati