slapacl.8 3.97 KB
Newer Older
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1
.TH SLAPACL 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2
.\" Copyright 2004-2009 The OpenLDAP Foundation All Rights Reserved.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
3
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
4
.\" $OpenLDAP$
Pierangelo Masarati's avatar
Pierangelo Masarati committed
5
6
7
8
.SH NAME
slapacl \- Check access to a list of attributes.
.SH SYNOPSIS
.B SBINDIR/slapacl
Pierangelo Masarati's avatar
Pierangelo Masarati committed
9
.B \-b DN
Pierangelo Masarati's avatar
Pierangelo Masarati committed
10
.B [\-d level]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
11
.B [\-D authcDN | \-U authcID]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
12
.B [\-f slapd.conf]
13
.B [\-F confdir]
14
.B [\-o name[=value]]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
15
.B [\-u]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
16
.B [\-v]
17
.B [\-X authzID | \-o authzDN=DN]
18
.B [attr[/access][:value]] [...]
Pierangelo Masarati's avatar
Pierangelo Masarati committed
19
20
21
.LP
.SH DESCRIPTION
.LP
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
22
23
24
25
26
27
.B slapacl
is used to check the behavior of 
.BR slapd (8) 
by verifying access to directory data according to the access control list
directives defined in its configuration.
.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
28
29
It opens the
.BR slapd.conf (5)
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
30
31
32
33
configuration file or the 
.BR slapd-config (5) 
backend, reads in the  
.B access/olcAccess
Pierangelo Masarati's avatar
Pierangelo Masarati committed
34
35
directives, and then parses the 
.B attr
36
37
38
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
39
40
41
.LP
.SH OPTIONS
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
42
43
44
45
46
47
48
49
.BI \-b " DN"
specify the 
.B DN 
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 .
Pierangelo Masarati's avatar
Pierangelo Masarati committed
50
51
52
.TP
.BI \-d " level"
enable debugging messages as defined by the specified
53
54
55
56
.IR level ;
see
.BR slapd (8)
for details.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
57
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
58
59
60
61
62
63
.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
Pierangelo Masarati's avatar
Pierangelo Masarati committed
64
65
66
67
68
.BI \-f " slapd.conf"
specify an alternative
.BR slapd.conf (5)
file.
.TP
69
70
71
72
73
74
75
76
77
.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
78
default config directory will be made before trying to use the default
79
80
81
config file. If a valid config directory exists then the
default config file is ignored.
.TP
82
83
84
85
86
.BI \-o " option[=value]"
Specify an
.BR option
with a(n optional)
.BR value .
Pierangelo Masarati's avatar
Pierangelo Masarati committed
87
Possible generic options/values are:
88
89
.LP
.nf
Pierangelo Masarati's avatar
Pierangelo Masarati committed
90
91
92
93
94
95
96
97
98
99
100
101
102
              syslog=<subsystems>  (see `\-s' in slapd(8))
              syslog-level=<level> (see `\-S' in slapd(8))
              syslog-user=<user>   (see `\-l' in slapd(8))

.fi
.RS
Possible options/values specific to
.B slapacl
are:
.RE
.nf

              authzDN
103
104
              domain
              peername
Pierangelo Masarati's avatar
Pierangelo Masarati committed
105
              sasl_ssf
106
              sockname
Pierangelo Masarati's avatar
Pierangelo Masarati committed
107
              sockurl
108
109
              ssf
              tls_ssf
Pierangelo Masarati's avatar
Pierangelo Masarati committed
110
111
              transport_ssf

112
.fi
Pierangelo Masarati's avatar
Pierangelo Masarati committed
113
114
115
116
117
.RS
See the related fields in
.BR slapd.access (5)
for details.
.RE
Pierangelo Masarati's avatar
Pierangelo Masarati committed
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
.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
133
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
.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
.B \-v
enable verbose mode.
.TP
.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.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
159
160
161
162
163
.SH EXAMPLES
The command
.LP
.nf
.ft tt
164
	SBINDIR/slapacl -f ETCDIR/slapd.conf -v \\
Pierangelo Masarati's avatar
Pierangelo Masarati committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
            -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
187
.so ../Project