| blob | 4412e1de5c42fbbe3703d3c52600c8b14625775b |
1 .TH LDAPCOMPARE 1 "2008/07/16" "OpenLDAP 2.4.11"
2 .\" $OpenLDAP: pkg/ldap/doc/man/man1/ldapcompare.1,v 1.12.2.4 2008/02/11 23:26:39 kurt Exp $
3 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
5 .SH NAME
6 ldapcompare \- LDAP compare tool
7 .SH SYNOPSIS
8 .B ldapcompare
9 [\c
10 .BR \-n ]
11 [\c
12 .BR \-v ]
13 [\c
14 .BR \-z ]
15 [\c
16 .BR \-M[M] ]
17 [\c
18 .BI \-d \ debuglevel\fR]
19 [\c
20 .BI \-D \ binddn\fR]
21 [\c
22 .BR \-W ]
23 [\c
24 .BI \-w \ passwd\fR]
25 [\c
26 .BI \-y \ passwdfile\fR]
27 [\c
28 .BI \-H \ ldapuri\fR]
29 [\c
30 .BI \-h \ ldaphost\fR]
31 [\c
32 .BI \-p \ ldapport\fR]
33 [\c
34 .BI \-P \ 2\fR\||\|\fI3\fR]
35 [\c
36 .BR \-O \ security-properties ]
37 [\c
38 .BR \-I ]
39 [\c
40 .BR \-Q ]
41 [\c
42 .BI \-U \ authcid\fR]
43 [\c
44 .BI \-R \ realm\fR]
45 [\c
46 .BR \-x ]
47 [\c
48 .BI \-X \ authzid\fR]
49 [\c
50 .BI \-Y \ mech\fR]
51 [\c
52 .BR \-Z[Z] ]
53 .IR DN \ <
54 .BR attr:value \ |
55 .BR attr::b64value \ >
56 .SH DESCRIPTION
57 .I ldapcompare
58 is a shell-accessible interface to the
59 .BR ldap_compare_ext (3)
60 library call.
61 .LP
62 .B ldapcompare
63 opens a connection to an LDAP server, binds, and performs a compare
64 using specified parameters. The \fIDN\fP should be a distinguished
65 name in the directory. \fIAttr\fP should be a known attribute. If
66 followed by one colon, the assertion \fIvalue\fP should be provided
67 as a string. If followed by two colons, the base64 encoding of the
68 value is provided. The result code of the compare is provided as
69 the exit code and, unless ran with -z, the program prints
70 TRUE, FALSE, or UNDEFINED on standard output.
71 .LP
72 .SH OPTIONS
73 .TP
74 .B \-n
75 Show what would be done, but don't actually perform the compare. Useful for
76 debugging in conjunction with -v.
77 .TP
78 .B \-v
79 Run in verbose mode, with many diagnostics written to standard output.
80 .TP
81 .B \-z
82 Run in quiet mode, no output is written. You must check the return
83 status. Useful in shell scripts.
84 .TP
85 .B \-M[M]
86 Enable manage DSA IT control.
87 .B \-MM
88 makes control critical.
89 .TP
90 .BI \-d \ debuglevel
91 Set the LDAP debugging level to \fIdebuglevel\fP.
92 .B ldapcompare
93 must be compiled with LDAP_DEBUG defined for this option to have any effect.
94 .TP
95 .B \-x
96 Use simple authentication instead of SASL.
97 .TP
98 .BI \-D \ binddn
99 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
100 .TP
101 .B \-W
102 Prompt for simple authentication.
103 This is used instead of specifying the password on the command line.
104 .TP
105 .BI \-w \ passwd
106 Use \fIpasswd\fP as the password for simple authentication.
107 .TP
108 .BI \-y \ passwdfile
109 Use complete contents of \fIpasswdfile\fP as the password for
110 simple authentication.
111 Note that \fIcomplete\fP means that any leading or trailing whitespaces,
112 including newlines, will be considered part of the password and,
113 unlike other software, they will not be stripped.
114 As a consequence, passwords stored in files by commands like
115 .BR echo (1)
116 will not behave as expected, since
117 .BR echo (1)
118 by default appends a trailing newline to the echoed string.
119 The recommended portable way to store a cleartext password in a file
120 for use with this option is to use
121 .BR slappasswd (8)
122 with \fI{CLEARTEXT}\fP as hash and the option \fI\-n\fP.
123 .TP
124 .BI \-H \ ldapuri
125 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
126 fields are allowed; a list of URI, separated by whitespace or commas
127 is expected.
128 .TP
129 .BI \-h \ ldaphost
130 Specify an alternate host on which the ldap server is running.
131 Deprecated in favor of -H.
132 .TP
133 .BI \-p \ ldapport
134 Specify an alternate TCP port where the ldap server is listening.
135 Deprecated in favor of -H.
136 .TP
137 .BI \-P \ 2\fR\||\|\fI3
138 Specify the LDAP protocol version to use.
139 .TP
140 .BI \-O \ security-properties
141 Specify SASL security properties.
142 .TP
143 .B \-I
144 Enable SASL Interactive mode. Always prompt. Default is to prompt
145 only as needed.
146 .TP
147 .B \-Q
148 Enable SASL Quiet mode. Never prompt.
149 .TP
150 .BI \-U \ authcid
151 Specify the authentication ID for SASL bind. The form of the ID
152 depends on the actual SASL mechanism used.
153 .TP
154 .BI \-R \ realm
155 Specify the realm of authentication ID for SASL bind. The form of the realm
156 depends on the actual SASL mechanism used.
157 .TP
158 .BI \-X \ authzid
159 Specify the requested authorization ID for SASL bind.
160 .I authzid
161 must be one of the following formats:
162 .B dn:\c
163 .I <distinguished name>
164 or
165 .B u:\c
166 .I <username>
167 .TP
168 .BI \-Y \ mech
169 Specify the SASL mechanism to be used for authentication. If it's not
170 specified, the program will choose the best mechanism the server knows.
171 .TP
172 .B \-Z[Z]
173 Issue StartTLS (Transport Layer Security) extended operation. If you use
174 .B \-ZZ\c
175 , the command will require the operation to be successful.
176 .SH EXAMPLES
177 .nf
178 ldapcompare "uid=babs,dc=example,dc=com" sn:Jensen
179 ldapcompare "uid=babs,dc=example,dc=com" sn::SmVuc2Vu
180 .fi
181 are all equivalent.
182 .SH LIMITATIONS
183 Requiring the value be passed on the command line is limiting
184 and introduces some security concerns. The command should support
185 a mechanism to specify the location (file name or URL) to read
186 the value from.
187 .SH "SEE ALSO"
188 .BR ldap.conf (5),
189 .BR ldif (5),
190 .BR ldap (3),
191 .BR ldap_compare_ext (3)
192 .SH AUTHOR
193 The OpenLDAP Project <http://www.openldap.org/>
194 .SH ACKNOWLEDGEMENTS
195 .\" Shared Project Acknowledgement Text
196 .B "OpenLDAP Software"
197 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
198 .B "OpenLDAP Software"
199 is derived from University of Michigan LDAP 3.3 Release.