git.sur5r.net Git - openldap/blob - doc/man/man1/ldapcompare.1

   1 .TH LDAPCOMPARE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   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 For SASL Binds, the server is expected to ignore this value.
 101 .TP
 102 .B \-W
 103 Prompt for simple authentication.
 104 This is used instead of specifying the password on the command line.
 105 .TP
 106 .BI \-w \ passwd
 107 Use \fIpasswd\fP as the password for simple authentication.
 108 .TP
 109 .BI \-y \ passwdfile
 110 Use complete contents of \fIpasswdfile\fP as the password for
 111 simple authentication.
 112 Note that \fIcomplete\fP means that any leading or trailing whitespaces,
 113 including newlines, will be considered part of the password and,
 114 unlike other software, they will not be stripped.
 115 As a consequence, passwords stored in files by commands like
 116 .BR echo (1)
 117 will not behave as expected, since
 118 .BR echo (1)
 119 by default appends a trailing newline to the echoed string.
 120 The recommended portable way to store a cleartext password in a file
 121 for use with this option is to use
 122 .BR slappasswd (8)
 123 with \fI{CLEARTEXT}\fP as hash and the option \fI\-n\fP.
 124 .TP
 125 .BI \-H \ ldapuri
 126 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 127 fields are allowed; a list of URI, separated by whitespace or commas
 128 is expected.
 129 .TP
 130 .BI \-h \ ldaphost
 131 Specify an alternate host on which the ldap server is running.
 132 Deprecated in favor of -H.
 133 .TP
 134 .BI \-p \ ldapport
 135 Specify an alternate TCP port where the ldap server is listening.
 136 Deprecated in favor of -H.
 137 .TP
 138 .BI \-P \ 2\fR\||\|\fI3
 139 Specify the LDAP protocol version to use.
 140 .TP
 141 .BI \-O \ security-properties
 142 Specify SASL security properties.
 143 .TP
 144 .B \-I
 145 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 146 only as needed.
 147 .TP
 148 .B \-Q
 149 Enable SASL Quiet mode.  Never prompt.
 150 .TP
 151 .BI \-U \ authcid
 152 Specify the authentication ID for SASL bind. The form of the ID
 153 depends on the actual SASL mechanism used.
 154 .TP
 155 .BI \-R \ realm
 156 Specify the realm of authentication ID for SASL bind. The form of the realm
 157 depends on the actual SASL mechanism used.
 158 .TP
 159 .BI \-X \ authzid
 160 Specify the requested authorization ID for SASL bind.
 161 .I authzid
 162 must be one of the following formats:
 163 .B dn:\c
 164 .I <distinguished name>
 165 or
 166 .B u:\c
 167 .I <username>
 168 .TP
 169 .BI \-Y \ mech
 170 Specify the SASL mechanism to be used for authentication. If it's not
 171 specified, the program will choose the best mechanism the server knows.
 172 .TP
 173 .B \-Z[Z]
 174 Issue StartTLS (Transport Layer Security) extended operation. If you use
 175 .B \-ZZ\c
 176 , the command will require the operation to be successful.
 177 .SH EXAMPLES
 178 .nf
 179     ldapcompare "uid=babs,dc=example,dc=com"  sn:Jensen
 180     ldapcompare "uid=babs,dc=example,dc=com"  sn::SmVuc2Vu
 181 .fi
 182 are all equivalent.
 183 .SH LIMITATIONS
 184 Requiring the value be passed on the command line is limiting
 185 and introduces some security concerns.  The command should support
 186 a mechanism to specify the location (file name or URL) to read
 187 the value from.
 188 .SH "SEE ALSO"
 189 .BR ldap.conf (5),
 190 .BR ldif (5),
 191 .BR ldap (3),
 192 .BR ldap_compare_ext (3)
 193 .SH AUTHOR
 194 The OpenLDAP Project <http://www.openldap.org/>
 195 .SH ACKNOWLEDGEMENTS
 196 .so ../Project