2 .\" This contribution is derived from OpenLDAP Software.
3 .\" All of the modifications to OpenLDAP Software represented in this
4 .\" contribution were developed by Peter Marschall <peter@adpm.de>.
5 .\" I have not assigned rights and/or interest in this work to any party.
7 .\" Copyright 2009 Peter Marschall
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted only as authorized by the OpenLDAP Public License.
11 .\" A copy of this license is available in file LICENSE in the
12 .\" top-level directory of the distribution or, alternatively, at
13 .\" http://www.OpenLDAP.org/license.html.
18 ldapexop \- issue LDAP extended operations
27 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
41 .BI \-O \ security-properties\fR]
43 .BI \-o \ opt\fR[\fP = optparam\fR]]
79 .BI cancel \ cancel-id
81 .BI refresh \ DN \ \fR[\fIttl\fR]}
84 ldapexop issues the LDAP extended operation specified by \fBoid\fP
85 or one of the special keywords \fBwhoami\fP, \fBcancel\fP, or \fBrefresh\fP.
87 Additional data for the extended operation can be passed to the server using
88 \fIdata\fP or base-64 encoded as \fIb64data\fP in the case of \fBoid\fP,
89 or using the additional parameters in the case of the specially named extended
92 Please note that ldapexop behaves differently for the same extended operation
93 when it was given as an OID or as a specialliy named operation:
95 Calling ldapexop with the OID of the \fBwhoami\fP (RFC 4532) extended operation
98 ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3
104 # extended operation response
105 data:: <base64 encoded response data>
108 while calling it with the keyword \fBwhoami\fP
111 ldapexop [<options>] whoami
117 dn:<client's identity>
125 Set the LDAP debugging level to \fIlevel\fP.
128 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
130 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
131 Specify general extensions. \'!\' indicates criticality.
133 [!]assert=<filter> (RFC 4528; a RFC 4515 Filter string)
134 [!]authzid=<authzid> (RFC 4370; "dn:<dn>" or "u:<user>")
135 [!]chaining[=<resolveBehavior>[/<continuationBehavior>]]
136 one of "chainingPreferred", "chainingRequired",
137 "referralsPreferred", "referralsRequired"
138 [!]manageDSAit (RFC 3296)
141 [!]postread[=<attrs>] (RFC 4527; comma-separated attr list)
142 [!]preread[=<attrs>] (RFC 4527; comma-separated attr list)
144 abandon, cancel, ignore (SIGINT sends abandon/cancel,
145 or ignores response; if critical, doesn't wait for SIGINT.
150 Read operations from \fIfile\fP.
153 Specify the host on which the ldap server is running.
154 Deprecated in favor of \fB\-H\fP.
157 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
158 fields are allowed; a list of URI, separated by whitespace or commas
162 Enable SASL Interactive mode. Always prompt. Default is to prompt
166 Show what would be done but don't actually do it.
167 Useful for debugging in conjunction with \fB\-v\fP.
170 Do not use reverse DNS to canonicalize SASL host name.
172 .BI \-O \ security-properties
173 Specify SASL security properties.
175 .BI \-o \ opt\fR[\fP = optparam\fR]
176 Specify general options:
178 nettimeout=<timeout> (in seconds, or "none" or "max")
182 Specify the TCP port where the ldap server is listening.
183 Deprecated in favor of \fB\-H\fP.
186 Enable SASL Quiet mode. Never prompt.
189 Specify the realm of authentication ID for SASL bind. The form of the realm
190 depends on the actual SASL mechanism used.
193 Specify the authentication ID for SASL bind. The form of the ID
194 depends on the actual SASL mechanism used.
197 Run in verbose mode, with many diagnostics written to standard output.
200 Print version info and usage message.
201 If\fB\-VV\fP is given, only the version information is printed.
204 Use \fIpasswd\fP as the password for simple authentication.
207 Prompt for simple authentication.
208 This is used instead of specifying the password on the command line.
211 Use simple authentication instead of SASL.
214 Specify the requested authorization ID for SASL bind.
216 must be one of the following formats:
217 .BI dn: "<distinguished name>"
222 Use complete contents of \fIfile\fP as the password for
223 simple authentication.
226 Specify the SASL mechanism to be used for authentication.
227 Without this option, the program will choose the best mechanism the server knows.
230 Issue StartTLS (Transport Layer Security) extended operation.
231 Giving it twice (\fB\-ZZ\fP) will require the operation to be successful.
234 Exit status is zero if no errors occur.
235 Errors result in a non-zero exit status and
236 a diagnostic message being written to standard error.
239 .BR ldap_extended_operation_s (3)
242 This manual page was written by Peter Marschall
243 based on \fBldapexop\fP's usage message and a few tests
245 Do not expect it to be complete or absolutely correct.