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