]> git.sur5r.net Git - openldap/blob - doc/man/man8/slapauth.8
ITS#4225 added proxyCacheQueries keyword
[openldap] / doc / man / man8 / slapauth.8
1 .TH SLAPAUTH 8C "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4 .SH NAME
5 slapauth \- Check a list of string-represented IDs for authc/authz.
6 .SH SYNOPSIS
7 .B SBINDIR/slapauth
8 .B [\-v]
9 .B [\-d level]
10 .B [\-f slapd.conf]
11 .B [\-F confdir]
12 .B [\-M mech]
13 .B [\-R realm]
14 .B [\-U authcID]
15 .B [\-X authzID]
16 .B ID [...]
17 .LP
18 .SH DESCRIPTION
19 .LP
20 .B Slapauth
21 is used to check the behavior of the slapd in mapping identities 
22 for authentication and authorization purposes, as specified in 
23 .BR slapd.conf (5).
24 It opens the
25 .BR slapd.conf (5)
26 configuration file, reads in the 
27 .B authz-policy
28 and
29 .B authz-regexp
30 directives, and then parses the 
31 .B ID
32 list given on the command-line.
33 .LP
34 .SH OPTIONS
35 .TP
36 .B \-v
37 enable verbose mode.
38 .TP
39 .BI \-d " level"
40 enable debugging messages as defined by the specified
41 .IR level .
42 .TP
43 .BI \-f " slapd.conf"
44 specify an alternative
45 .BR slapd.conf (5)
46 file.
47 .TP
48 .BI \-F " confdir"
49 specify a config directory.
50 If both
51 .B -f
52 and
53 .B -F
54 are specified, the config file will be read and converted to
55 config directory format and written to the specified directory.
56 If neither option is specified, an attempt to read the
57 default config directory will be made before trying to use the default
58 config file. If a valid config directory exists then the
59 default config file is ignored.
60 .TP
61 .BI \-M " mech"
62 specify a mechanism.
63 .TP
64 .BI \-R " realm"
65 specify a realm.
66 .TP
67 .BI \-U " authcID"
68 specify an ID to be used as 
69 .I authcID
70 throughout the test session.
71 If present, and if no
72 .B authzID
73 is given, the IDs in the ID list are treated as 
74 .BR authzID .
75 .TP
76 .BI \-X " authzID"
77 specify an ID to be used as 
78 .I authzID
79 throughout the test session.
80 If present, and if no
81 .B authcID
82 is given, the IDs in the ID list are treated as 
83 .BR authcID .
84 If both
85 .I authcID 
86 and
87 .I authzID
88 are given via command line switch, the ID list cannot be present.
89 .SH EXAMPLES
90 The command
91 .LP
92 .nf
93 .ft tt
94         SBINDIR/slapauth -f /ETCDIR/slapd.conf -v \\
95             -U bjorn -X u:bjensen
96
97 .ft
98 .fi
99 tests whether the user
100 .I bjorn
101 can assume the identity of the user 
102 .I bjensen
103 provided the directives
104 .LP
105 .nf
106 .ft tt
107         authz-policy from
108         authz-regexp "^uid=([^,]+).*,cn=auth$"
109                 "ldap:///dc=example,dc=net??sub?uid=$1"
110
111 .ft
112 .fi
113 are defined in
114 .BR slapd.conf (5).
115 .SH "SEE ALSO"
116 .BR ldap (3),
117 .BR slapd (8)
118 .BR slaptest (8)
119 .LP
120 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
121 .SH ACKNOWLEDGEMENTS
122 .B OpenLDAP
123 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
124 .B OpenLDAP
125 is derived from University of Michigan LDAP 3.3 Release.