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

   1 .\" $OpenLDAP$
   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.
   6 .\"
   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.
  10 .\"
  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.
  14
  15 .TH LDAPEXOP 1
  16
  17 .SH NAME
  18 ldapexop \- issue LDAP extended operations
  19
  20 .SH SYNOPSIS
  21 ldapexop
  22 [\c
  23 .BI \-d \ level\fR]
  24 [\c
  25 .BI \-D \ binddn\fR]
  26 [\c
  27 .BI \-e \ [!]ext[=extparam]\fR]
  28 [\c
  29 .BI \-f \ file\fR]
  30 [\c
  31 .BI \-h \ host\fR]
  32 [\c
  33 .BI \-H \ URI\fR]
  34 [\c
  35 .BR \-I ]
  36 [\c
  37 .BR \-n ]
  38 [\c
  39 .BR \-N ]
  40 [\c
  41 .BI \-O \ security-properties\fR]
  42 [\c
  43 .BI \-o \ [!]ext[=extparam]\fR]
  44 [\c
  45 .BI \-p \ port\fR]
  46 [\c
  47 .BR \-Q ]
  48 [\c
  49 .BI \-R \ realm\fR]
  50 [\c
  51 .BI \-U \ authcid\fR]
  52 [\c
  53 .BR \-v ]
  54 [\c
  55 .BR \-V ]
  56 [\c
  57 .BI \-w \ passwd\fR]
  58 [\c
  59 .BR \-W ]
  60 [\c
  61 .BR \-x ]
  62 [\c
  63 .BI \-X \ authzid\fR]
  64 [\c
  65 .BI \-y \ file\fR]
  66 [\c
  67 .BI \-Y \ mech\fR]
  68 [\c
  69 .BR \-Z[Z] ]
  70 \ {
  71 .I oid
  72 |
  73 .BI oid: data
  74 |
  75 .BI oid:: b64data
  76 |
  77 .B whoami
  78 |
  79 .BI cancel \ cancel-id
  80 |
  81 .BI refresh \ DN \ \fR[\fIttl\fR]
  82 }
  83
  84 .SH DESCRIPTION
  85 ldapexop issues the LDAP extended operation specified by \fBoid\fP
  86 or one of the special keywords \fBwhoami\fP, \fBcancel\fP, or \fBrefresh\fP.
  87
  88 Additional data for the extended operation can be passed to the server using
  89 \fIdata\fP or base-64 encoded as \fIb64data\fP in the case of \fBoid\fP,
  90 or using the additional parameters in the case of the specially named extended
  91 operations above.
  92
  93 Please note that ldapexop behaves differently for the same extended operation
  94 when it was given as an OID or as a specialliy named operation:
  95
  96 Calling ldapexop with the OID of the \fBwhoami\fP (RFC 4532) extended operation
  97 .nf
  98
  99   ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3
 100
 101 .fi
 102 yields
 103 .nf
 104
 105   # extended operation response
 106   data:: <base64 encoded response data>
 107
 108 .fi
 109 while calling it with the keyword \fBwhoami\fP
 110 .nf
 111
 112   ldapexop [<options>] whoami
 113
 114 .fi
 115 results in
 116 .nf
 117
 118   dn:<client's identity>
 119
 120 .fi
 121
 122
 123 .SH OPTIONS
 124 .TP
 125 .BI \-d \ level
 126 Set the LDAP debugging level to \fIlevel\fP.
 127 .TP
 128 .BI \-D \ binddn
 129 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 130 .TP
 131 .BI \-e \ [!]ext[=extparam]
 132 Specify general extensions.  \'!\' indicates criticality.
 133 .nf
 134   [!]assert=<filter>     (RFC 4528; a RFC 4515 Filter string)
 135   [!]authzid=<authzid>   (RFC 4370; "dn:<dn>" or "u:<user>")
 136   [!]chaining[=<resolveBehavior>[/<continuationBehavior>]]
 137      one of "chainingPreferred", "chainingRequired",
 138      "referralsPreferred", "referralsRequired"
 139   [!]manageDSAit         (RFC 3296)
 140   [!]noop
 141   ppolicy
 142   [!]postread[=<attrs>]  (RFC 4527; comma-separated attr list)
 143   [!]preread[=<attrs>]   (RFC 4527; comma-separated attr list)
 144   [!]relax
 145   abandon, cancel, ignore (SIGINT sends abandon/cancel,
 146   or ignores response; if critical, doesn't wait for SIGINT.
 147   not really controls)
 148 .fi
 149 .TP
 150 .BI \-f \ file
 151 Read operations from \fIfile\fP.
 152 .TP
 153 .BI \-h \ host
 154 Specify the host on which the ldap server is running.
 155 Deprecated in favor of \fB-H\fP.
 156 .TP
 157 .BI \-H \ URI
 158 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 159 fields are allowed; a list of URI, separated by whitespace or commas
 160 is expected.
 161 .TP
 162 .BI \-I
 163 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 164 only as needed.
 165 .TP
 166 .BI \-n
 167 Show what would be done but don't actually do it.
 168 Useful for debugging in conjunction with \fB-v\fP.
 169 .TP
 170 .BI \-N
 171 Do not use reverse DNS to canonicalize SASL host name.
 172 .TP
 173 .BI \-O \ security-properties
 174 Specify SASL security properties.
 175 .TP
 176 .BI \-o \ opt[=optparam]
 177 Specify general options:
 178 .nf
 179   nettimeout=<timeout> (in seconds, or "none" or "max")
 180 .fi
 181 .TP
 182 .BI \-p \ port
 183 Specify the TCP port where the ldap server is listening.
 184 Deprecated in favor of \fB-H\fP.
 185 .TP
 186 .BI \-Q
 187 Enable SASL Quiet mode.  Never prompt.
 188 .TP
 189 .BI \-R \ realm
 190 Specify the realm of authentication ID for SASL bind. The form of the realm
 191 depends on the actual SASL mechanism used.
 192 .TP
 193 .BI \-U \ authcid
 194 Specify the authentication ID for SASL bind. The form of the ID
 195 depends on the actual SASL mechanism used.
 196 .TP
 197 .BI \-v
 198 Run in verbose mode, with many diagnostics written to standard output.
 199 .TP
 200 .BI \-V
 201 Print version info and usage message.
 202 If\fB-VV\fP is given, only the version information is printed.
 203 .TP
 204 .BI \-w \ passwd
 205 Use \fIpasswd\fP as the password for simple authentication.
 206 .TP
 207 .BI \-W
 208 Prompt for simple authentication.
 209 This is used instead of specifying the password on the command line.
 210 .TP
 211 .BI \-x
 212 Use simple authentication instead of SASL.
 213 .TP
 214 .BI \-X \ authzid
 215 Specify the requested authorization ID for SASL bind.
 216 .I authzid
 217 must be one of the following formats:
 218 .B dn:\c
 219 .I <distinguished name>
 220 or
 221 .B u:\c
 222 .I <username>
 223 .TP
 224 .BI \-y \ file
 225 Use complete contents of \fIfile\fP as the password for
 226 simple authentication.
 227 .TP
 228 .BI \-Y \ mech
 229 Specify the SASL mechanism to be used for authentication.
 230 Without this option, the program will choose the best mechanism the server knows.
 231 .TP
 232 .B \-Z[Z]
 233 Issue StartTLS (Transport Layer Security) extended operation.
 234 Giving it twice (\fB-ZZ\fP) will require the operation to be successful.
 235
 236 .SH DIAGNOSTICS
 237 Exit status is zero if no errors occur.
 238 Errors result in a non-zero exit status and
 239 a diagnostic message being written to standard error.
 240
 241 .SH "SEE ALSO"
 242 .BR ldap_extended_operation_s (3)
 243
 244 .SH AUTHOR
 245 This manual page was written by Peter Marschall
 246 based on \fBldapexop\fP's usage message and a few tests
 247 with \fBldapexop\fP.
 248 Do not expect it to be complete or absolutely correct.
 249
 250 .SH ACKNOWLEDGEMENTS
 251 The OpenLDAP Project <http://www.openldap.org/>
 252