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 .BR \-V [ V ]]
  24 [\c
  25 .BI \-d \ debuglevel\fR]
  26 [\c
  27 .BR \-n ]
  28 [\c
  29 .BR \-v ]
  30 [\c
  31 .BI \-f \ file\fR]
  32 [\c
  33 .BR \-x ]
  34 [\c
  35 .BI \-D \ binddn\fR]
  36 [\c
  37 .BR \-W ]
  38 [\c
  39 .BI \-w \ passwd\fR]
  40 [\c
  41 .BI \-y \ passwdfile\fR]
  42 [\c
  43 .BI \-H \ URI\fR]
  44 [\c
  45 .BI \-h \ ldaphost\fR]
  46 [\c
  47 .BI \-p \ ldapport\fR]
  48 [\c
  49 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  50 [\c
  51 .BI \-o \ opt \fR[= optparam \fR]]
  52 [\c
  53 .BI \-O \ security-properties\fR]
  54 [\c
  55 .BR \-I ]
  56 [\c
  57 .BR \-Q ]
  58 [\c
  59 .BR \-N ]
  60 [\c
  61 .BI \-U \ authcid\fR]
  62 [\c
  63 .BI \-R \ realm\fR]
  64 [\c
  65 .BI \-X \ authzid\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 \-V [ V ]
 125 Print version info.
 126 If\fB\-VV\fP is given, only the version information is printed.
 127 .TP
 128 .BI \-d \ debuglevel
 129 Set the LDAP debugging level to \fIdebuglevel\fP.
 130 .TP
 131 .BI \-n
 132 Show what would be done but don't actually do it.
 133 Useful for debugging in conjunction with \fB\-v\fP.
 134 .TP
 135 .BI \-v
 136 Run in verbose mode, with many diagnostics written to standard output.
 137 .TP
 138 .BI \-f \ file
 139 Read operations from \fIfile\fP.
 140 .TP
 141 .BI \-x
 142 Use simple authentication instead of SASL.
 143 .TP
 144 .BI \-D \ binddn
 145 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 146 .TP
 147 .BI \-W
 148 Prompt for simple authentication.
 149 This is used instead of specifying the password on the command line.
 150 .TP
 151 .BI \-w \ passwd
 152 Use \fIpasswd\fP as the password for simple authentication.
 153 .TP
 154 .BI \-y \ passwdfile
 155 Use complete contents of \fIpasswdfile\fP as the password for
 156 simple authentication.
 157 .TP
 158 .BI \-H \ URI
 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
 161 is expected.
 162 .TP
 163 .BI \-h \ ldaphost
 164 Specify the host on which the ldap server is running.
 165 Deprecated in favor of \fB\-H\fP.
 166 .TP
 167 .BI \-p \ ldapport
 168 Specify the TCP port where the ldap server is listening.
 169 Deprecated in favor of \fB\-H\fP.
 170 .TP
 171 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 172 Specify general extensions.  \'!\' indicates criticality.
 173 .nf
 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>]]
 178   [!]manageDSAit
 179   [!]noop
 180   ppolicy
 181   [!]postread[=<attrs>] (a comma-separated attribute list)
 182   [!]preread[=<attrs>]  (a comma-separated attribute list)
 183   [!]relax
 184   sessiontracking[=<username>]
 185   abandon,cancel,ignore (SIGINT sends abandon/cancel,
 186   or ignores response; if critical, doesn't wait for SIGINT.
 187   not really controls)
 188 .fi
 189 .TP
 190 .BI \-o \ opt \fR[= optparam \fR]
 191
 192 Specify general options.
 193
 194 General options:
 195 .nf
 196   nettimeout=<timeout>  (in seconds, or "none" or "max")
 197   ldif-wrap=<width>     (in columns, or "no" for no wrapping)
 198 .fi
 199 .TP
 200 .BI \-O \ security-properties
 201 Specify SASL security properties.
 202 .TP
 203 .BI \-I
 204 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 205 only as needed.
 206 .TP
 207 .BI \-Q
 208 Enable SASL Quiet mode.  Never prompt.
 209 .TP
 210 .B \-N
 211 Do not use reverse DNS to canonicalize SASL host name.
 212 .TP
 213 .BI \-U \ authcid
 214 Specify the authentication ID for SASL bind. The form of the ID
 215 depends on the actual SASL mechanism used.
 216 .TP
 217 .BI \-R \ realm
 218 Specify the realm of authentication ID for SASL bind. The form of the realm
 219 depends on the actual SASL mechanism used.
 220 .TP
 221 .BI \-X \ authzid
 222 Specify the requested authorization ID for SASL bind.
 223 .I authzid
 224 must be one of the following formats:
 225 .BI dn: "<distinguished name>"
 226 or
 227 .BI u: <username>
 228 .TP
 229 .BI \-Y \ mech
 230 Specify the SASL mechanism to be used for authentication.
 231 Without this option, the program will choose the best mechanism the server knows.
 232 .TP
 233 .BR \-Z [ Z ]
 234 Issue StartTLS (Transport Layer Security) extended operation.
 235 Giving it twice (\fB\-ZZ\fP) will require the operation to be successful.
 236
 237 .SH DIAGNOSTICS
 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.
 241
 242 .SH "SEE ALSO"
 243 .BR ldap_extended_operation_s (3)
 244
 245 .SH AUTHOR
 246 This manual page was written by Peter Marschall
 247 based on \fBldapexop\fP's usage message and a few tests
 248 with \fBldapexop\fP.
 249 Do not expect it to be complete or absolutely correct.
 250
 251 .SH ACKNOWLEDGEMENTS
 252 .so ../Project
 253