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 .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 \ opt\fR[\fP = optparam\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 {\c
  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 .SH DESCRIPTION
  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.
  86
  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
  90 operations above.
  91
  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:
  94
  95 Calling ldapexop with the OID of the \fBwhoami\fP (RFC 4532) extended operation
  96 .nf
  97
  98   ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3
  99
 100 .fi
 101 yields
 102 .nf
 103
 104   # extended operation response
 105   data:: <base64 encoded response data>
 106
 107 .fi
 108 while calling it with the keyword \fBwhoami\fP
 109 .nf
 110
 111   ldapexop [<options>] whoami
 112
 113 .fi
 114 results in
 115 .nf
 116
 117   dn:<client's identity>
 118
 119 .fi
 120
 121
 122 .SH OPTIONS
 123 .TP
 124 .BI \-d \ level
 125 Set the LDAP debugging level to \fIlevel\fP.
 126 .TP
 127 .BI \-D \ binddn
 128 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 129 .TP
 130 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 131 Specify general extensions.  \'!\' indicates criticality.
 132 .nf
 133   [!]assert=<filter>    (an RFC 4515 Filter)
 134   !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
 135   [!]bauthzid           (RFC 3829 authzid control)
 136   [!]chaining[=<resolve>[/<cont>]]
 137   [!]manageDSAit
 138   [!]noop
 139   ppolicy
 140   [!]postread[=<attrs>] (a comma-separated attribute list)
 141   [!]preread[=<attrs>]  (a comma-separated attribute list)
 142   [!]relax
 143   sessiontracking[=<username>]
 144   abandon,cancel,ignore (SIGINT sends abandon/cancel,
 145   or ignores response; if critical, doesn't wait for SIGINT.
 146   not really controls)
 147 .fi
 148 .TP
 149 .BI \-f \ file
 150 Read operations from \fIfile\fP.
 151 .TP
 152 .BI \-h \ host
 153 Specify the host on which the ldap server is running.
 154 Deprecated in favor of \fB\-H\fP.
 155 .TP
 156 .BI \-H \ URI
 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
 159 is expected.
 160 .TP
 161 .BI \-I
 162 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 163 only as needed.
 164 .TP
 165 .BI \-n
 166 Show what would be done but don't actually do it.
 167 Useful for debugging in conjunction with \fB\-v\fP.
 168 .TP
 169 .BI \-N
 170 Do not use reverse DNS to canonicalize SASL host name.
 171 .TP
 172 .BI \-O \ security-properties
 173 Specify SASL security properties.
 174 .TP
 175 .BI \-o \ opt\fR[\fP = optparam\fR]
 176 Specify general options:
 177 .nf
 178   nettimeout=<timeout> (in seconds, or "none" or "max")
 179 .fi
 180 .TP
 181 .BI \-p \ port
 182 Specify the TCP port where the ldap server is listening.
 183 Deprecated in favor of \fB\-H\fP.
 184 .TP
 185 .BI \-Q
 186 Enable SASL Quiet mode.  Never prompt.
 187 .TP
 188 .BI \-R \ realm
 189 Specify the realm of authentication ID for SASL bind. The form of the realm
 190 depends on the actual SASL mechanism used.
 191 .TP
 192 .BI \-U \ authcid
 193 Specify the authentication ID for SASL bind. The form of the ID
 194 depends on the actual SASL mechanism used.
 195 .TP
 196 .BI \-v
 197 Run in verbose mode, with many diagnostics written to standard output.
 198 .TP
 199 .BI \-V
 200 Print version info and usage message.
 201 If\fB\-VV\fP is given, only the version information is printed.
 202 .TP
 203 .BI \-w \ passwd
 204 Use \fIpasswd\fP as the password for simple authentication.
 205 .TP
 206 .BI \-W
 207 Prompt for simple authentication.
 208 This is used instead of specifying the password on the command line.
 209 .TP
 210 .BI \-x
 211 Use simple authentication instead of SASL.
 212 .TP
 213 .BI \-X \ authzid
 214 Specify the requested authorization ID for SASL bind.
 215 .I authzid
 216 must be one of the following formats:
 217 .BI dn: "<distinguished name>"
 218 or
 219 .BI u: <username>
 220 .TP
 221 .BI \-y \ file
 222 Use complete contents of \fIfile\fP as the password for
 223 simple authentication.
 224 .TP
 225 .BI \-Y \ mech
 226 Specify the SASL mechanism to be used for authentication.
 227 Without this option, the program will choose the best mechanism the server knows.
 228 .TP
 229 .BR \-Z [ Z ]
 230 Issue StartTLS (Transport Layer Security) extended operation.
 231 Giving it twice (\fB\-ZZ\fP) will require the operation to be successful.
 232
 233 .SH DIAGNOSTICS
 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.
 237
 238 .SH "SEE ALSO"
 239 .BR ldap_extended_operation_s (3)
 240
 241 .SH AUTHOR
 242 This manual page was written by Peter Marschall
 243 based on \fBldapexop\fP's usage message and a few tests
 244 with \fBldapexop\fP.
 245 Do not expect it to be complete or absolutely correct.
 246
 247 .SH ACKNOWLEDGEMENTS
 248 .so ../Project
 249