ldapexop — issue LDAP extended operations
whoami ldapexop [
−d level ] [ −D binddn ] [ −e [!]ext[=extparam] ] [ −f file ] [ −h host ] [ −H URI ] [−I] [−n] [−N] [ −O security−properties ] [
−o [!]ext[=extparam] ] [
−p port ] [−Q] [ −R realm ] [ −U authcid ] [−v] [−V] [ −w passwd ] [−W] [−x] [ −X authzid ] [ −y file ] [ −Y mech ] [−Z[Z]] oid | oid: data | oid::
b64data | cancel cancel−id | refresh DN [ttl]
ldapexop issues the LDAP extended operation specified by
oid or one of the
special keywords whoami, cancel, or refresh.
Additional data for the extended operation can be passed
to the server using data or base-64 encoded as
b64data in the case
of oid, or using the
additional parameters in the case of the specially named
extended operations above.
Please note that ldapexop behaves differently for the same extended operation when it was given as an OID or as a specialliy named operation:
Calling ldapexop with the OID of the whoami (RFC 4532) extended
operation
ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3
yields
# extended operation response data:: <base64 encoded response data>
while calling it with the keyword whoami
ldapexop [<options>] whoami
results in
dn:<client's identity>
−d
levelSet the LDAP debugging level to level.
−D
binddnUse the Distinguished Name binddn to bind to the
LDAP directory.
−e
[!]ext[=extparam]Specify general extensions. '!' indicates criticality.
[!]assert=<filter> (RFC 4528; a RFC 4515 Filter string)
[!]authzid=<authzid> (RFC 4370; "dn:<dn>" or "u:<user>")
[!]chaining[=<resolveBehavior>[/<continuationBehavior>]]
one of "chainingPreferred", "chainingRequired",
"referralsPreferred", "referralsRequired"
[!]manageDSAit (RFC 3296)
[!]noop
ppolicy
[!]postread[=<attrs>] (RFC 4527; comma-separated attr list)
[!]preread[=<attrs>] (RFC 4527; comma-separated attr list)
[!]relax
abandon, cancel, ignore (SIGINT sends abandon/cancel,
or ignores response; if critical, doesn't wait for SIGINT.
not really controls)
−f
fileRead operations from file.
−h
hostSpecify the host on which the ldap server is
running. Deprecated in favor of −H.
−H
URISpecify URI(s) referring to the ldap server(s); only the protocol/host/port fields are allowed; a list of URI, separated by whitespace or commas is expected.
−IEnable SASL Interactive mode. Always prompt. Default is to prompt only as needed.
−nShow what would be done but don't actually do it.
Useful for debugging in conjunction with −v.
−NDo not use reverse DNS to canonicalize SASL host name.
−O
security−propertiesSpecify SASL security properties.
−o
opt[=optparam]Specify general options:
nettimeout=<timeout> (in seconds, or "none" or "max")
−p
portSpecify the TCP port where the ldap server is
listening. Deprecated in favor of −H.
−QEnable SASL Quiet mode. Never prompt.
−R
realmSpecify the realm of authentication ID for SASL bind. The form of the realm depends on the actual SASL mechanism used.
−U
authcidSpecify the authentication ID for SASL bind. The form of the ID depends on the actual SASL mechanism used.
−vRun in verbose mode, with many diagnostics written to standard output.
−VPrint version info and usage message. If−VV is given, only the version
information is printed.
−w
passwdUse passwd
as the password for simple authentication.
−WPrompt for simple authentication. This is used instead of specifying the password on the command line.
−xUse simple authentication instead of SASL.
−X
authzidSpecify the requested authorization ID for SASL
bind. authzid
must be one of the following formats: dn: <distinguished name>
or u:
<username>
−y
fileUse complete contents of file as the password for
simple authentication.
−Y
mechSpecify the SASL mechanism to be used for authentication. Without this option, the program will choose the best mechanism the server knows.
−Z[Z]Issue StartTLS (Transport Layer Security) extended
operation. Giving it twice (−ZZ) will require the operation
to be successful.
Exit status is zero if no errors occur. Errors result in a non-zero exit status and a diagnostic message being written to standard error.
This manual page was written by Peter Marschall based on
ldapexop's usage
message and a few tests with ldapexop. Do not expect it to
be complete or absolutely correct.