ldapexop.1 5.8 KB
Newer Older
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.\" $OpenLDAP$
.\" This contribution is derived from OpenLDAP Software.
.\" All of the modifications to OpenLDAP Software represented in this
.\" contribution were developed by Peter Marschall <peter@adpm.de>.
.\" I have not assigned rights and/or interest in this work to any party.
.\"
.\" Copyright 2009 Peter Marschall
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted only as authorized by the OpenLDAP Public License.
.\"
.\" A copy of this license is available in file LICENSE in the
.\" top-level directory of the distribution or, alternatively, at
.\" http://www.OpenLDAP.org/license.html.

.TH LDAPEXOP 1

.SH NAME
ldapexop \- issue LDAP extended operations

.SH SYNOPSIS
ldapexop
[\c
23
.BR \-V [ V ]]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
24
[\c
25
.BI \-d \ debuglevel\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
26
[\c
27
.BR \-n ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
28
[\c
29
.BR \-v ]
30
[\c
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
31
32
.BI \-f \ file\fR]
[\c
33
.BR \-x ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
34
[\c
35
.BI \-D \ binddn\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
36
[\c
37
.BR \-W ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
38
[\c
39
.BI \-w \ passwd\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
40
[\c
41
.BI \-y \ passwdfile\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
42
[\c
43
.BI \-H \ URI\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
44
[\c
45
.BI \-h \ ldaphost\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
46
[\c
47
.BI \-p \ ldapport\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
48
[\c
49
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
50
[\c
51
.BI \-o \ opt \fR[= optparam \fR]]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
52
[\c
53
.BI \-O \ security-properties\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
54
[\c
55
.BR \-I ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
56
[\c
57
.BR \-Q ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
58
[\c
59
.BR \-N ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
60
[\c
61
.BI \-U \ authcid\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
62
[\c
63
.BI \-R \ realm\fR]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
64
65
66
67
68
[\c
.BI \-X \ authzid\fR]
[\c
.BI \-Y \ mech\fR]
[\c
69
70
.BR \-Z [ Z ]]
{\c
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
71
72
73
74
75
76
77
78
79
80
.I oid
|
.BI oid: data
|
.BI oid:: b64data
|
.B whoami
|
.BI cancel \ cancel-id
|
81
.BI refresh \ DN \ \fR[\fIttl\fR]}
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

.SH DESCRIPTION
ldapexop issues the LDAP extended operation specified by \fBoid\fP
or one of the special keywords \fBwhoami\fP, \fBcancel\fP, or \fBrefresh\fP.

Additional data for the extended operation can be passed to the server using
\fIdata\fP or base-64 encoded as \fIb64data\fP in the case of \fBoid\fP,
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 \fBwhoami\fP (RFC 4532) extended operation
.nf

  ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3

.fi
yields
.nf

  # extended operation response
  data:: <base64 encoded response data>

.fi
while calling it with the keyword \fBwhoami\fP
.nf

  ldapexop [<options>] whoami

.fi
results in
.nf

  dn:<client's identity>

.fi


.SH OPTIONS
.TP
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
.BI \-V [ V ]
Print version info.
If\fB\-VV\fP is given, only the version information is printed.
.TP
.BI \-d \ debuglevel
Set the LDAP debugging level to \fIdebuglevel\fP.
.TP
.BI \-n
Show what would be done but don't actually do it.
Useful for debugging in conjunction with \fB\-v\fP.
.TP
.BI \-v
Run in verbose mode, with many diagnostics written to standard output.
.TP
.BI \-f \ file
Read operations from \fIfile\fP.
.TP
.BI \-x
Use simple authentication instead of SASL.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
143
144
145
146
.TP
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
.TP
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
.BI \-W
Prompt for simple authentication.
This is used instead of specifying the password on the command line.
.TP
.BI \-w \ passwd
Use \fIpasswd\fP as the password for simple authentication.
.TP
.BI \-y \ passwdfile
Use complete contents of \fIpasswdfile\fP as the password for
simple authentication.
.TP
.BI \-H \ URI
Specify 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.
.TP
.BI \-h \ ldaphost
Specify the host on which the ldap server is running.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-p \ ldapport
Specify the TCP port where the ldap server is listening.
Deprecated in favor of \fB\-H\fP.
.TP
171
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
172
173
Specify general extensions.  \'!\' indicates criticality.
.nf
Pierangelo Masarati's avatar
Pierangelo Masarati committed
174
175
176
177
178
  [!]assert=<filter>    (an RFC 4515 Filter)
  !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
  [!]bauthzid           (RFC 3829 authzid control)
  [!]chaining[=<resolve>[/<cont>]]
  [!]manageDSAit
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
179
180
  [!]noop
  ppolicy
Pierangelo Masarati's avatar
Pierangelo Masarati committed
181
182
  [!]postread[=<attrs>] (a comma-separated attribute list)
  [!]preread[=<attrs>]  (a comma-separated attribute list)
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
183
  [!]relax
Pierangelo Masarati's avatar
Pierangelo Masarati committed
184
185
  sessiontracking
  abandon,cancel,ignore (SIGINT sends abandon/cancel,
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
186
187
188
189
  or ignores response; if critical, doesn't wait for SIGINT.
  not really controls)
.fi
.TP
190
.BI \-o \ opt \fR[= optparam \fR]
191
192
193
194
195
196
197
198
199

Specify general options.

General options:
.nf
  nettimeout=<timeout>  (in seconds, or "none" or "max")
  ldif-wrap=<width>     (in columns, or "no" for no wrapping)
.fi
.TP
200
201
.BI \-O \ security-properties
Specify SASL security properties.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
202
203
204
205
206
207
208
209
.TP
.BI \-I
Enable SASL Interactive mode.  Always prompt.  Default is to prompt
only as needed.
.TP
.BI \-Q
Enable SASL Quiet mode.  Never prompt.
.TP
210
211
.B \-N
Do not use reverse DNS to canonicalize SASL host name.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
212
213
214
215
216
.TP
.BI \-U \ authcid
Specify the authentication ID for SASL bind. The form of the ID
depends on the actual SASL mechanism used.
.TP
217
218
219
.BI \-R \ realm
Specify the realm of authentication ID for SASL bind. The form of the realm
depends on the actual SASL mechanism used.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
220
221
222
223
224
.TP
.BI \-X \ authzid
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
225
.BI dn: "<distinguished name>"
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
226
or
227
.BI u: <username>
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
228
229
230
231
232
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication.
Without this option, the program will choose the best mechanism the server knows.
.TP
233
.BR \-Z [ Z ]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
234
Issue StartTLS (Transport Layer Security) extended operation.
235
Giving it twice (\fB\-ZZ\fP) will require the operation to be successful.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251

.SH DIAGNOSTICS
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.

.SH "SEE ALSO"
.BR ldap_extended_operation_s (3)

.SH AUTHOR
This manual page was written by Peter Marschall
based on \fBldapexop\fP's usage message and a few tests
with \fBldapexop\fP.
Do not expect it to be complete or absolutely correct.

.SH ACKNOWLEDGEMENTS
252
.so ../Project
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
253