slapacl.8 3.67 KB
Newer Older
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1
.TH SLAPACL 8C "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" Copyright 2004-2005 The OpenLDAP Foundation All Rights Reserved.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
3
4
5
6
7
8
9
10
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.SH NAME
slapacl \- Check access to a list of attributes.
.SH SYNOPSIS
.B SBINDIR/slapacl
.B [\-v]
.B [\-d level]
.B [\-f slapd.conf]
11
.B [\-F confdir]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
12
13
.B [\-D authcDN | \-U authcID]
.B \-b DN
Pierangelo Masarati's avatar
Pierangelo Masarati committed
14
.B [\-u]
15
.B [\-X authzID | \-o authzDN=DN]
16
.B [attr[/access][:value]] [...]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
.LP
.SH DESCRIPTION
.LP
.B Slapacl
is used to check the behavior of the slapd in verifying access to data
according to ACLs, as specified in 
.BR slapd.access (5).
It opens the
.BR slapd.conf (5)
configuration file, reads in the 
.B access
and
.B defaultaccess
directives, and then parses the 
.B attr
32
33
34
list given on the command-line; if none is given, access to the
.B entry
pseudo-attribute is tested.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.LP
.SH OPTIONS
.TP
.B \-v
enable verbose mode.
.TP
.BI \-d " level"
enable debugging messages as defined by the specified
.IR level .
.TP
.BI \-f " slapd.conf"
specify an alternative
.BR slapd.conf (5)
file.
.TP
50
51
52
53
54
55
56
57
58
.BI \-F " confdir"
specify a config directory.
If both
.B -f
and
.B -F
are specified, the config file will be read and converted to
config directory format and written to the specified directory.
If neither option is specified, an attempt to read the
Howard Chu's avatar
Howard Chu committed
59
default config directory will be made before trying to use the default
60
61
62
config file. If a valid config directory exists then the
default config file is ignored.
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.BI \-D " authcDN"
specify a DN to be used as identity through the test session
when selecting appropriate
.B <by> 
clauses in access lists.
.TP
.BI \-U " authcID"
specify an ID to be mapped to a 
.B DN 
as by means of 
.B authz-regexp
or
.B authz-rewrite
rules (see 
.BR slapd.conf (5)
for details); mutually exclusive with
.BR \-D .
.TP
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
.BI \-X " authzID"
specify an authorization ID to be mapped to a
.B DN
as by means of
.B authz-regexp
or
.B authz-rewrite
rules (see
.BR slapd.conf (5)
for details); mutually exclusive with \fB\-o\fP \fIauthzDN=DN\fP.
.TP
.BI \-o " option[=value]"
Specify an
.BR option
with a(n optional)
.BR value .
Possible options/values are:
.LP
.nf
              sockurl
              domain
              peername
              sockname
              ssf
              transport_ssf
              tls_ssf
              sasl_ssf
              authzDN
.fi
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
111
112
113
.BI \-b " DN"
specify the 
.B DN 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
which access is requested to; the corresponding entry is fetched 
from the database, and thus it must exist.
The DN is also used to determine what rules apply; thus, it must be
in the naming context of a configured database.  See also
.BR \-u .
.TP
.BI \-u
do not fetch the entry from the database.
In this case, if the entry does not exist, a fake entry with the DN
given with the
.B \-b
option is used, with no attributes.
As a consequence, those rules that depend on the contents 
of the target object will not behave as with the real object.
The DN given with the
.B \-b
option is still used to select what rules apply; thus, it must be
in the naming context of a configured database.
See also
.BR \-b .
Pierangelo Masarati's avatar
Pierangelo Masarati committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
.SH EXAMPLES
The command
.LP
.nf
.ft tt
	SBINDIR/slapacl -f /ETCDIR/slapd.conf -v \\
            -U bjorn -b "o=University of Michigan,c=US" \\
	    "o/read:University of Michigan"

.ft
.fi
tests whether the user
.I bjorn
can access the attribute 
.I o
of the entry
.I o=University of Michigan,c=US
at
.I read
level.
.SH "SEE ALSO"
.BR ldap (3),
.BR slapd (8)
.BR slaptest (8)
.BR slapauth (8)
.LP
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
.SH ACKNOWLEDGEMENTS
.B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
.B OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.