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
25 .BI \-d \ debuglevel\fR]
41 .BI \-y \ passwdfile\fR]
45 .BI \-h \ ldaphost\fR]
47 .BI \-p \ ldapport\fR]
49 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
51 .BI \-o \ opt \fR[= optparam \fR]]
53 .BI \-O \ security-properties\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>
126 If\fB\-VV\fP is given, only the version information is printed.
129 Set the LDAP debugging level to \fIdebuglevel\fP.
132 Show what would be done but don't actually do it.
133 Useful for debugging in conjunction with \fB\-v\fP.
136 Run in verbose mode, with many diagnostics written to standard output.
139 Read operations from \fIfile\fP.
142 Use simple authentication instead of SASL.
145 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
148 Prompt for simple authentication.
149 This is used instead of specifying the password on the command line.
152 Use \fIpasswd\fP as the password for simple authentication.
155 Use complete contents of \fIpasswdfile\fP as the password for
156 simple authentication.
159 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
160 fields are allowed; a list of URI, separated by whitespace or commas
164 Specify the host on which the ldap server is running.
165 Deprecated in favor of \fB\-H\fP.
168 Specify the TCP port where the ldap server is listening.
169 Deprecated in favor of \fB\-H\fP.
171 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
172 Specify general extensions. \'!\' indicates criticality.
174 [!]assert=<filter> (an RFC 4515 Filter)
175 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
176 [!]bauthzid (RFC 3829 authzid control)
177 [!]chaining[=<resolve>[/<cont>]]
181 [!]postread[=<attrs>] (a comma-separated attribute list)
182 [!]preread[=<attrs>] (a comma-separated attribute list)
184 sessiontracking[=<username>]
185 abandon,cancel,ignore (SIGINT sends abandon/cancel,
186 or ignores response; if critical, doesn't wait for SIGINT.
190 .BI \-o \ opt \fR[= optparam \fR]
192 Specify general options.
196 nettimeout=<timeout> (in seconds, or "none" or "max")
197 ldif-wrap=<width> (in columns, or "no" for no wrapping)
200 .BI \-O \ security-properties
201 Specify SASL security properties.
204 Enable SASL Interactive mode. Always prompt. Default is to prompt
208 Enable SASL Quiet mode. Never prompt.
211 Do not use reverse DNS to canonicalize SASL host name.
214 Specify the authentication ID for SASL bind. The form of the ID
215 depends on the actual SASL mechanism used.
218 Specify the realm of authentication ID for SASL bind. The form of the realm
219 depends on the actual SASL mechanism used.
222 Specify the requested authorization ID for SASL bind.
224 must be one of the following formats:
225 .BI dn: "<distinguished name>"
230 Specify the SASL mechanism to be used for authentication.
231 Without this option, the program will choose the best mechanism the server knows.
234 Issue StartTLS (Transport Layer Security) extended operation.
235 Giving it twice (\fB\-ZZ\fP) will require the operation to be successful.
238 Exit status is zero if no errors occur.
239 Errors result in a non-zero exit status and
240 a diagnostic message being written to standard error.
243 .BR ldap_extended_operation_s (3)
246 This manual page was written by Peter Marschall
247 based on \fBldapexop\fP's usage message and a few tests
249 Do not expect it to be complete or absolutely correct.