vfs_gpfs: Move vfs_gpfs_lstat to nfs4_acls.c and rename function
[Samba.git] / libcli / smb / smbXcli_base.h
blob25ccd84b33609f4bd05623553b0208713304071c
1 /*
2 Unix SMB/CIFS implementation.
3 Infrastructure for async SMB client requests
4 Copyright (C) Volker Lendecke 2008
5 Copyright (C) Stefan Metzmacher 2011
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef _SMBXCLI_BASE_H_
22 #define _SMBXCLI_BASE_H_
24 #define SMB_SUICIDE_PACKET 0x74697865
26 #include "replace.h"
27 #include <tevent.h>
28 #include "libcli/smb/smb_constants.h"
29 #include "libcli/util/ntstatus.h"
30 #include "lib/util/time.h"
31 #include "lib/util/data_blob.h"
33 struct smbXcli_conn;
34 struct smbXcli_session;
35 struct smbXcli_tcon;
36 struct smb_trans_enc_state;
37 struct GUID;
38 struct iovec;
39 struct smb2_create_blobs;
40 struct smb_create_returns;
41 struct smb311_capabilities;
43 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
44 int fd,
45 const char *remote_name,
46 enum smb_signing_setting signing_state,
47 uint32_t smb1_capabilities,
48 struct GUID *client_guid,
49 uint32_t smb2_capabilities,
50 const struct smb311_capabilities *smb3_capabilities);
52 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
53 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
55 struct tevent_queue *smbXcli_conn_send_queue(struct smbXcli_conn *conn);
56 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
58 bool smbXcli_conn_dfs_supported(struct smbXcli_conn *conn);
60 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
61 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
62 bool smbXcli_conn_signing_mandatory(struct smbXcli_conn *conn);
63 bool smbXcli_conn_have_posix(struct smbXcli_conn *conn);
64 bool smbXcli_conn_support_passthrough(struct smbXcli_conn *conn);
66 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
67 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
68 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
69 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
71 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
72 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
73 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
74 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
75 bool smbXcli_conn_get_force_channel_sequence(struct smbXcli_conn *conn);
76 void smbXcli_conn_set_force_channel_sequence(struct smbXcli_conn *conn,
77 bool v);
80 struct tevent_req *smbXcli_conn_samba_suicide_send(TALLOC_CTX *mem_ctx,
81 struct tevent_context *ev,
82 struct smbXcli_conn *conn,
83 uint8_t exitcode);
84 NTSTATUS smbXcli_conn_samba_suicide_recv(struct tevent_req *req);
85 NTSTATUS smbXcli_conn_samba_suicide(struct smbXcli_conn *conn,
86 uint8_t exitcode);
88 void smbXcli_req_unset_pending(struct tevent_req *req);
89 bool smbXcli_req_set_pending(struct tevent_req *req);
90 struct timeval smbXcli_req_endtime(struct tevent_req *req);
92 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
93 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
94 bool smb1cli_conn_req_possible(struct smbXcli_conn *conn);
95 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
96 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
97 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
98 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
99 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
100 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
101 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
102 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
104 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
105 const DATA_BLOB user_session_key,
106 const DATA_BLOB response);
107 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
108 const uint8_t *buf, uint32_t seqnum);
109 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
111 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
112 struct smb_trans_enc_state *es);
113 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
115 bool smb1cli_is_andx_req(uint8_t cmd);
116 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
118 uint16_t smb1cli_req_mid(struct tevent_req *req);
119 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
121 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
122 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
124 struct smb1cli_req_expected_response {
125 NTSTATUS status;
126 uint8_t wct;
129 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
130 struct tevent_context *ev,
131 struct smbXcli_conn *conn,
132 uint8_t smb_command,
133 uint8_t additional_flags,
134 uint8_t clear_flags,
135 uint16_t additional_flags2,
136 uint16_t clear_flags2,
137 uint32_t timeout_msec,
138 uint32_t pid,
139 struct smbXcli_tcon *tcon,
140 struct smbXcli_session *session,
141 uint8_t wct, uint16_t *vwv,
142 int iov_count,
143 struct iovec *bytes_iov);
144 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
146 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
147 struct tevent_context *ev,
148 struct smbXcli_conn *conn,
149 uint8_t smb_command,
150 uint8_t additional_flags,
151 uint8_t clear_flags,
152 uint16_t additional_flags2,
153 uint16_t clear_flags2,
154 uint32_t timeout_msec,
155 uint32_t pid,
156 struct smbXcli_tcon *tcon,
157 struct smbXcli_session *session,
158 uint8_t wct, uint16_t *vwv,
159 uint32_t num_bytes,
160 const uint8_t *bytes);
161 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
162 TALLOC_CTX *mem_ctx,
163 struct iovec **piov,
164 uint8_t **phdr,
165 uint8_t *pwct,
166 uint16_t **pvwv,
167 uint32_t *pvwv_offset,
168 uint32_t *pnum_bytes,
169 uint8_t **pbytes,
170 uint32_t *pbytes_offset,
171 uint8_t **pinbuf,
172 const struct smb1cli_req_expected_response *expected,
173 size_t num_expected);
175 struct tevent_req *smb1cli_trans_send(
176 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
177 struct smbXcli_conn *conn, uint8_t cmd,
178 uint8_t additional_flags, uint8_t clear_flags,
179 uint16_t additional_flags2, uint16_t clear_flags2,
180 uint32_t timeout_msec,
181 uint32_t pid,
182 struct smbXcli_tcon *tcon,
183 struct smbXcli_session *session,
184 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
185 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
186 uint8_t *param, uint32_t num_param, uint32_t max_param,
187 uint8_t *data, uint32_t num_data, uint32_t max_data);
188 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
189 uint16_t *recv_flags2,
190 uint16_t **setup, uint8_t min_setup,
191 uint8_t *num_setup,
192 uint8_t **param, uint32_t min_param,
193 uint32_t *num_param,
194 uint8_t **data, uint32_t min_data,
195 uint32_t *num_data);
196 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
197 uint8_t trans_cmd,
198 uint8_t additional_flags, uint8_t clear_flags,
199 uint16_t additional_flags2, uint16_t clear_flags2,
200 uint32_t timeout_msec,
201 uint32_t pid,
202 struct smbXcli_tcon *tcon,
203 struct smbXcli_session *session,
204 const char *pipe_name, uint16_t fid, uint16_t function,
205 int flags,
206 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
207 uint8_t *param, uint32_t num_param, uint32_t max_param,
208 uint8_t *data, uint32_t num_data, uint32_t max_data,
209 uint16_t *recv_flags2,
210 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
211 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
212 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
214 struct tevent_req *smb1cli_echo_send(TALLOC_CTX *mem_ctx,
215 struct tevent_context *ev,
216 struct smbXcli_conn *conn,
217 uint32_t timeout_msec,
218 uint16_t num_echos,
219 DATA_BLOB data);
220 NTSTATUS smb1cli_echo_recv(struct tevent_req *req);
221 NTSTATUS smb1cli_echo(struct smbXcli_conn *conn, uint32_t timeout_msec,
222 uint16_t num_echos, DATA_BLOB data);
224 struct tevent_req *smb1cli_session_setup_lm21_send(TALLOC_CTX *mem_ctx,
225 struct tevent_context *ev,
226 struct smbXcli_conn *conn,
227 uint32_t timeout_msec,
228 uint32_t pid,
229 struct smbXcli_session *session,
230 uint16_t in_buf_size,
231 uint16_t in_mpx_max,
232 uint16_t in_vc_num,
233 uint32_t in_sess_key,
234 const char *in_user,
235 const char *in_domain,
236 const DATA_BLOB in_password,
237 const char *in_native_os,
238 const char *in_native_lm);
239 NTSTATUS smb1cli_session_setup_lm21_recv(struct tevent_req *req,
240 TALLOC_CTX *mem_ctx,
241 char **out_native_os,
242 char **out_native_lm);
243 struct tevent_req *smb1cli_session_setup_nt1_send(TALLOC_CTX *mem_ctx,
244 struct tevent_context *ev,
245 struct smbXcli_conn *conn,
246 uint32_t timeout_msec,
247 uint32_t pid,
248 struct smbXcli_session *session,
249 uint16_t in_buf_size,
250 uint16_t in_mpx_max,
251 uint16_t in_vc_num,
252 uint32_t in_sess_key,
253 const char *in_user,
254 const char *in_domain,
255 const DATA_BLOB in_apassword,
256 const DATA_BLOB in_upassword,
257 uint32_t in_capabilities,
258 const char *in_native_os,
259 const char *in_native_lm);
260 NTSTATUS smb1cli_session_setup_nt1_recv(struct tevent_req *req,
261 TALLOC_CTX *mem_ctx,
262 struct iovec **precv_iov,
263 const uint8_t **precv_inbuf,
264 char **out_native_os,
265 char **out_native_lm,
266 char **out_primary_domain);
267 struct tevent_req *smb1cli_session_setup_ext_send(TALLOC_CTX *mem_ctx,
268 struct tevent_context *ev,
269 struct smbXcli_conn *conn,
270 uint32_t timeout_msec,
271 uint32_t pid,
272 struct smbXcli_session *session,
273 uint16_t in_buf_size,
274 uint16_t in_mpx_max,
275 uint16_t in_vc_num,
276 uint32_t in_sess_key,
277 const DATA_BLOB in_security_blob,
278 uint32_t in_capabilities,
279 const char *in_native_os,
280 const char *in_native_lm);
281 NTSTATUS smb1cli_session_setup_ext_recv(struct tevent_req *req,
282 TALLOC_CTX *mem_ctx,
283 struct iovec **precv_iov,
284 const uint8_t **precv_inbuf,
285 DATA_BLOB *out_security_blob,
286 char **out_native_os,
287 char **out_native_lm);
289 struct tevent_req *smb1cli_ntcreatex_send(TALLOC_CTX *mem_ctx,
290 struct tevent_context *ev,
291 struct smbXcli_conn *conn,
292 uint32_t timeout_msec,
293 uint32_t pid,
294 struct smbXcli_tcon *tcon,
295 struct smbXcli_session *session,
296 const char *fname,
297 uint32_t CreatFlags,
298 uint32_t RootDirectoryFid,
299 uint32_t DesiredAccess,
300 uint64_t AllocationSize,
301 uint32_t FileAttributes,
302 uint32_t ShareAccess,
303 uint32_t CreateDisposition,
304 uint32_t CreateOptions,
305 uint32_t ImpersonationLevel,
306 uint8_t SecurityFlags);
307 NTSTATUS smb1cli_ntcreatex_recv(struct tevent_req *req, uint16_t *pfnum);
308 NTSTATUS smb1cli_ntcreatex(struct smbXcli_conn *conn,
309 uint32_t timeout_msec,
310 uint32_t pid,
311 struct smbXcli_tcon *tcon,
312 struct smbXcli_session *session,
313 const char *fname,
314 uint32_t CreatFlags,
315 uint32_t RootDirectoryFid,
316 uint32_t DesiredAccess,
317 uint64_t AllocationSize,
318 uint32_t FileAttributes,
319 uint32_t ShareAccess,
320 uint32_t CreateDisposition,
321 uint32_t CreateOptions,
322 uint32_t ImpersonationLevel,
323 uint8_t SecurityFlags,
324 uint16_t *pfnum);
325 struct tevent_req *smb1cli_close_send(TALLOC_CTX *mem_ctx,
326 struct tevent_context *ev,
327 struct smbXcli_conn *conn,
328 uint32_t timeout_msec,
329 uint32_t pid,
330 struct smbXcli_tcon *tcon,
331 struct smbXcli_session *session,
332 uint16_t fnum,
333 uint32_t last_modified);
334 NTSTATUS smb1cli_close_recv(struct tevent_req *req);
335 NTSTATUS smb1cli_close(struct smbXcli_conn *conn,
336 uint32_t timeout_msec,
337 uint32_t pid,
338 struct smbXcli_tcon *tcon,
339 struct smbXcli_session *session,
340 uint16_t fnum,
341 uint32_t last_modified);
342 struct tevent_req *smb1cli_writex_send(TALLOC_CTX *mem_ctx,
343 struct tevent_context *ev,
344 struct smbXcli_conn *conn,
345 uint32_t timeout_msec,
346 uint32_t pid,
347 struct smbXcli_tcon *tcon,
348 struct smbXcli_session *session,
349 uint16_t fnum,
350 uint16_t mode,
351 const uint8_t *buf,
352 uint64_t offset,
353 uint32_t size);
354 NTSTATUS smb1cli_writex_recv(struct tevent_req *req,
355 uint32_t *pwritten,
356 uint16_t *pavailable);
357 NTSTATUS smb1cli_writex(struct smbXcli_conn *conn,
358 uint32_t timeout_msec,
359 uint32_t pid,
360 struct smbXcli_tcon *tcon,
361 struct smbXcli_session *session,
362 uint16_t fnum,
363 uint16_t mode,
364 const uint8_t *buf,
365 uint64_t offset,
366 uint32_t size,
367 uint32_t *pwritten,
368 uint16_t *pavailable);
369 struct tevent_req *smb1cli_readx_send(TALLOC_CTX *mem_ctx,
370 struct tevent_context *ev,
371 struct smbXcli_conn *conn,
372 uint32_t timeout_msec,
373 uint32_t pid,
374 struct smbXcli_tcon *tcon,
375 struct smbXcli_session *session,
376 uint16_t fnum,
377 uint64_t offset,
378 uint32_t size);
379 NTSTATUS smb1cli_readx_recv(struct tevent_req *req,
380 uint32_t *received,
381 uint8_t **rcvbuf);
383 bool smb2cli_conn_req_possible(struct smbXcli_conn *conn, uint32_t *max_dyn_len);
384 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
385 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
386 uint16_t smb2cli_conn_server_signing_algo(struct smbXcli_conn *conn);
387 uint16_t smb2cli_conn_server_encryption_algo(struct smbXcli_conn *conn);
388 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
389 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
390 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
391 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
392 uint16_t max_credits);
393 uint16_t smb2cli_conn_get_cur_credits(struct smbXcli_conn *conn);
394 uint8_t smb2cli_conn_get_io_priority(struct smbXcli_conn *conn);
395 void smb2cli_conn_set_io_priority(struct smbXcli_conn *conn,
396 uint8_t io_priority);
397 uint32_t smb2cli_conn_cc_chunk_len(struct smbXcli_conn *conn);
398 void smb2cli_conn_set_cc_chunk_len(struct smbXcli_conn *conn,
399 uint32_t chunk_len);
400 uint32_t smb2cli_conn_cc_max_chunks(struct smbXcli_conn *conn);
401 void smb2cli_conn_set_cc_max_chunks(struct smbXcli_conn *conn,
402 uint32_t max_chunks);
403 void smb2cli_conn_set_mid(struct smbXcli_conn *conn, uint64_t mid);
404 uint64_t smb2cli_conn_get_mid(struct smbXcli_conn *conn);
406 NTSTATUS smb2cli_parse_dyn_buffer(uint32_t dyn_offset,
407 const DATA_BLOB dyn_buffer,
408 uint32_t min_offset,
409 uint32_t buffer_offset,
410 uint32_t buffer_length,
411 uint32_t max_length,
412 uint32_t *next_offset,
413 DATA_BLOB *buffer);
415 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
416 struct tevent_context *ev,
417 struct smbXcli_conn *conn,
418 uint16_t cmd,
419 uint32_t additional_flags,
420 uint32_t clear_flags,
421 uint32_t timeout_msec,
422 struct smbXcli_tcon *tcon,
423 struct smbXcli_session *session,
424 const uint8_t *fixed,
425 uint16_t fixed_len,
426 const uint8_t *dyn,
427 uint32_t dyn_len,
428 uint32_t max_dyn_len);
429 void smb2cli_req_set_notify_async(struct tevent_req *req);
430 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
431 int num_reqs);
432 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
434 struct smb2cli_req_expected_response {
435 NTSTATUS status;
436 uint16_t body_size;
439 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
440 struct tevent_context *ev,
441 struct smbXcli_conn *conn,
442 uint16_t cmd,
443 uint32_t additional_flags,
444 uint32_t clear_flags,
445 uint32_t timeout_msec,
446 struct smbXcli_tcon *tcon,
447 struct smbXcli_session *session,
448 const uint8_t *fixed,
449 uint16_t fixed_len,
450 const uint8_t *dyn,
451 uint32_t dyn_len,
452 uint32_t max_dyn_len);
453 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
454 struct iovec **piov,
455 const struct smb2cli_req_expected_response *expected,
456 size_t num_expected);
459 * This expects an iov[3] array, that is filled with references to
460 * the buffers used for the sending the requests into the socket.
462 * This can only be called after smb2cli_req_recv(subreq) before
463 * the TALLOC_FREE(subreq).
465 NTSTATUS smb2cli_req_get_sent_iov(struct tevent_req *req,
466 struct iovec *sent_iov);
468 struct smb2_negotiate_contexts;
469 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
470 struct tevent_context *ev,
471 struct smbXcli_conn *conn,
472 uint32_t timeout_msec,
473 enum protocol_types min_protocol,
474 enum protocol_types max_protocol,
475 uint16_t max_credits,
476 struct smb2_negotiate_contexts *in_ctx);
477 NTSTATUS smbXcli_negprot_recv(
478 struct tevent_req *req,
479 TALLOC_CTX *mem_ctx,
480 struct smb2_negotiate_contexts **out_ctx);
481 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
482 uint32_t timeout_msec,
483 enum protocol_types min_protocol,
484 enum protocol_types max_protocol,
485 struct smb2_negotiate_contexts *in_ctx,
486 TALLOC_CTX *mem_ctx,
487 struct smb2_negotiate_contexts **out_ctx);
489 struct tevent_req *smb2cli_validate_negotiate_info_send(TALLOC_CTX *mem_ctx,
490 struct tevent_context *ev,
491 struct smbXcli_conn *conn,
492 uint32_t timeout_msec,
493 struct smbXcli_session *session,
494 struct smbXcli_tcon *tcon);
495 NTSTATUS smb2cli_validate_negotiate_info_recv(struct tevent_req *req);
497 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
498 struct smbXcli_conn *conn);
499 struct smbXcli_session *smbXcli_session_shallow_copy(TALLOC_CTX *mem_ctx,
500 struct smbXcli_session *src);
501 bool smbXcli_session_is_guest(struct smbXcli_session *session);
502 bool smbXcli_session_is_authenticated(struct smbXcli_session *session);
503 NTSTATUS smb2cli_session_signing_key(struct smbXcli_session *session,
504 TALLOC_CTX *mem_ctx,
505 DATA_BLOB *key);
506 NTSTATUS smb2cli_session_encryption_key(struct smbXcli_session *session,
507 TALLOC_CTX *mem_ctx,
508 DATA_BLOB *key);
509 NTSTATUS smb2cli_session_decryption_key(struct smbXcli_session *session,
510 TALLOC_CTX *mem_ctx,
511 DATA_BLOB *key);
512 NTSTATUS smbXcli_session_application_key(struct smbXcli_session *session,
513 TALLOC_CTX *mem_ctx,
514 DATA_BLOB *key);
515 void smbXcli_session_set_disconnect_expired(struct smbXcli_session *session);
516 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
517 void smb1cli_session_set_id(struct smbXcli_session* session,
518 uint16_t session_id);
519 void smb1cli_session_set_action(struct smbXcli_session *session,
520 uint16_t action);
521 NTSTATUS smb1cli_session_set_session_key(struct smbXcli_session *session,
522 const DATA_BLOB _session_key);
523 NTSTATUS smb1cli_session_protect_session_key(struct smbXcli_session *session);
524 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
525 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
526 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
527 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
528 uint64_t session_id,
529 uint16_t session_flags);
530 void smb2cli_session_increment_channel_sequence(struct smbXcli_session *session);
531 uint16_t smb2cli_session_reset_channel_sequence(struct smbXcli_session *session,
532 uint16_t channel_sequence);
533 uint16_t smb2cli_session_current_channel_sequence(struct smbXcli_session *session);
534 void smb2cli_session_start_replay(struct smbXcli_session *session);
535 void smb2cli_session_stop_replay(struct smbXcli_session *session);
536 void smb2cli_session_require_signed_response(struct smbXcli_session *session,
537 bool require_signed_response);
538 NTSTATUS smb2cli_session_update_preauth(struct smbXcli_session *session,
539 const struct iovec *iov);
540 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
541 const DATA_BLOB session_key,
542 const struct iovec *recv_iov);
543 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
544 struct smbXcli_session *session1,
545 struct smbXcli_conn *conn,
546 struct smbXcli_session **_session2);
547 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
548 const DATA_BLOB channel_key,
549 const struct iovec *recv_iov);
550 NTSTATUS smb2cli_session_encryption_on(struct smbXcli_session *session);
551 uint16_t smb2cli_session_get_encryption_cipher(struct smbXcli_session *session);
553 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
554 struct smbXcli_tcon *smbXcli_tcon_copy(TALLOC_CTX *mem_ctx,
555 const struct smbXcli_tcon *tcon_in);
556 void smbXcli_tcon_set_fs_attributes(struct smbXcli_tcon *tcon,
557 uint32_t fs_attributes);
558 uint32_t smbXcli_tcon_get_fs_attributes(struct smbXcli_tcon *tcon);
559 bool smbXcli_tcon_is_dfs_share(struct smbXcli_tcon *tcon);
560 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
561 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
562 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
563 uint16_t tcon_id,
564 uint16_t optional_support,
565 uint32_t maximal_access,
566 uint32_t guest_maximal_access,
567 const char *service,
568 const char *fs_type);
569 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
570 void smb2cli_tcon_set_id(struct smbXcli_tcon *tcon, uint32_t tcon_id);
571 uint32_t smb2cli_tcon_capabilities(struct smbXcli_tcon *tcon);
572 uint32_t smb2cli_tcon_flags(struct smbXcli_tcon *tcon);
573 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
574 struct smbXcli_session *session,
575 uint32_t tcon_id,
576 uint8_t type,
577 uint32_t flags,
578 uint32_t capabilities,
579 uint32_t maximal_access);
580 void smb2cli_tcon_should_sign(struct smbXcli_tcon *tcon,
581 bool should_sign);
582 bool smb2cli_tcon_is_signing_on(struct smbXcli_tcon *tcon);
583 void smb2cli_tcon_should_encrypt(struct smbXcli_tcon *tcon,
584 bool should_encrypt);
585 bool smb2cli_tcon_is_encryption_on(struct smbXcli_tcon *tcon);
587 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
588 struct tevent_context *ev,
589 struct smbXcli_conn *conn,
590 uint32_t timeout_msec,
591 struct smbXcli_session *session,
592 uint8_t in_flags,
593 uint32_t in_capabilities,
594 uint32_t in_channel,
595 uint64_t in_previous_session_id,
596 const DATA_BLOB *in_security_buffer);
597 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
598 TALLOC_CTX *mem_ctx,
599 struct iovec **recv_iov,
600 DATA_BLOB *out_security_buffer);
602 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
603 struct tevent_context *ev,
604 struct smbXcli_conn *conn,
605 uint32_t timeout_msec,
606 struct smbXcli_session *session);
607 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
608 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
609 uint32_t timeout_msec,
610 struct smbXcli_session *session);
612 /* smb2cli_raw_tcon* should only be used in tests! */
613 struct tevent_req *smb2cli_raw_tcon_send(TALLOC_CTX *mem_ctx,
614 struct tevent_context *ev,
615 struct smbXcli_conn *conn,
616 uint32_t additional_flags,
617 uint32_t clear_flags,
618 uint32_t timeout_msec,
619 struct smbXcli_session *session,
620 struct smbXcli_tcon *tcon,
621 uint16_t tcon_flags,
622 const char *unc);
623 NTSTATUS smb2cli_raw_tcon_recv(struct tevent_req *req);
624 NTSTATUS smb2cli_raw_tcon(struct smbXcli_conn *conn,
625 uint32_t additional_flags,
626 uint32_t clear_flags,
627 uint32_t timeout_msec,
628 struct smbXcli_session *session,
629 struct smbXcli_tcon *tcon,
630 uint16_t tcon_flags,
631 const char *unc);
632 struct tevent_req *smb2cli_tcon_send(TALLOC_CTX *mem_ctx,
633 struct tevent_context *ev,
634 struct smbXcli_conn *conn,
635 uint32_t timeout_msec,
636 struct smbXcli_session *session,
637 struct smbXcli_tcon *tcon,
638 uint16_t flags,
639 const char *unc);
640 NTSTATUS smb2cli_tcon_recv(struct tevent_req *req);
641 NTSTATUS smb2cli_tcon(struct smbXcli_conn *conn,
642 uint32_t timeout_msec,
643 struct smbXcli_session *session,
644 struct smbXcli_tcon *tcon,
645 uint16_t flags,
646 const char *unc);
648 struct tevent_req *smb2cli_tdis_send(TALLOC_CTX *mem_ctx,
649 struct tevent_context *ev,
650 struct smbXcli_conn *conn,
651 uint32_t timeout_msec,
652 struct smbXcli_session *session,
653 struct smbXcli_tcon *tcon);
654 NTSTATUS smb2cli_tdis_recv(struct tevent_req *req);
655 NTSTATUS smb2cli_tdis(struct smbXcli_conn *conn,
656 uint32_t timeout_msec,
657 struct smbXcli_session *session,
658 struct smbXcli_tcon *tcon);
660 struct symlink_reparse_struct;
662 struct tevent_req *smb2cli_create_send(
663 TALLOC_CTX *mem_ctx,
664 struct tevent_context *ev,
665 struct smbXcli_conn *conn,
666 uint32_t timeout_msec,
667 struct smbXcli_session *session,
668 struct smbXcli_tcon *tcon,
669 const char *filename,
670 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
671 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
672 uint32_t desired_access,
673 uint32_t file_attributes,
674 uint32_t share_access,
675 uint32_t create_disposition,
676 uint32_t create_options,
677 struct smb2_create_blobs *blobs);
678 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
679 uint64_t *fid_persistent,
680 uint64_t *fid_volatile,
681 struct smb_create_returns *cr,
682 TALLOC_CTX *mem_ctx,
683 struct smb2_create_blobs *blobs,
684 struct symlink_reparse_struct **psymlink);
685 NTSTATUS smb2cli_create(struct smbXcli_conn *conn,
686 uint32_t timeout_msec,
687 struct smbXcli_session *session,
688 struct smbXcli_tcon *tcon,
689 const char *filename,
690 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
691 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
692 uint32_t desired_access,
693 uint32_t file_attributes,
694 uint32_t share_access,
695 uint32_t create_disposition,
696 uint32_t create_options,
697 struct smb2_create_blobs *blobs,
698 uint64_t *fid_persistent,
699 uint64_t *fid_volatile,
700 struct smb_create_returns *cr,
701 TALLOC_CTX *mem_ctx,
702 struct smb2_create_blobs *ret_blobs,
703 struct symlink_reparse_struct **psymlink);
705 struct tevent_req *smb2cli_close_send(TALLOC_CTX *mem_ctx,
706 struct tevent_context *ev,
707 struct smbXcli_conn *conn,
708 uint32_t timeout_msec,
709 struct smbXcli_session *session,
710 struct smbXcli_tcon *tcon,
711 uint16_t flags,
712 uint64_t fid_persistent,
713 uint64_t fid_volatile);
714 NTSTATUS smb2cli_close_recv(struct tevent_req *req);
715 NTSTATUS smb2cli_close(struct smbXcli_conn *conn,
716 uint32_t timeout_msec,
717 struct smbXcli_session *session,
718 struct smbXcli_tcon *tcon,
719 uint16_t flags,
720 uint64_t fid_persistent,
721 uint64_t fid_volatile);
723 struct tevent_req *smb2cli_read_send(TALLOC_CTX *mem_ctx,
724 struct tevent_context *ev,
725 struct smbXcli_conn *conn,
726 uint32_t timeout_msec,
727 struct smbXcli_session *session,
728 struct smbXcli_tcon *tcon,
729 uint32_t length,
730 uint64_t offset,
731 uint64_t fid_persistent,
732 uint64_t fid_volatile,
733 uint64_t minimum_count,
734 uint64_t remaining_bytes);
735 NTSTATUS smb2cli_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
736 uint8_t **data, uint32_t *data_length);
737 NTSTATUS smb2cli_read(struct smbXcli_conn *conn,
738 uint32_t timeout_msec,
739 struct smbXcli_session *session,
740 struct smbXcli_tcon *tcon,
741 uint32_t length,
742 uint64_t offset,
743 uint64_t fid_persistent,
744 uint64_t fid_volatile,
745 uint64_t minimum_count,
746 uint64_t remaining_bytes,
747 TALLOC_CTX *mem_ctx,
748 uint8_t **data,
749 uint32_t *data_length);
751 struct tevent_req *smb2cli_write_send(TALLOC_CTX *mem_ctx,
752 struct tevent_context *ev,
753 struct smbXcli_conn *conn,
754 uint32_t timeout_msec,
755 struct smbXcli_session *session,
756 struct smbXcli_tcon *tcon,
757 uint32_t length,
758 uint64_t offset,
759 uint64_t fid_persistent,
760 uint64_t fid_volatile,
761 uint32_t remaining_bytes,
762 uint32_t flags,
763 const uint8_t *data);
764 NTSTATUS smb2cli_write_recv(struct tevent_req *req,
765 uint32_t *written);
766 NTSTATUS smb2cli_write(struct smbXcli_conn *conn,
767 uint32_t timeout_msec,
768 struct smbXcli_session *session,
769 struct smbXcli_tcon *tcon,
770 uint32_t length,
771 uint64_t offset,
772 uint64_t fid_persistent,
773 uint64_t fid_volatile,
774 uint32_t remaining_bytes,
775 uint32_t flags,
776 const uint8_t *data,
777 uint32_t *written);
779 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
780 struct tevent_context *ev,
781 struct smbXcli_conn *conn,
782 uint32_t timeout_msec,
783 struct smbXcli_session *session,
784 struct smbXcli_tcon *tcon,
785 uint64_t fid_persistent,
786 uint64_t fid_volatile);
787 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
788 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
789 uint32_t timeout_msec,
790 struct smbXcli_session *session,
791 struct smbXcli_tcon *tcon,
792 uint64_t fid_persistent,
793 uint64_t fid_volatile);
795 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
796 struct tevent_context *ev,
797 struct smbXcli_conn *conn,
798 uint32_t timeout_msec,
799 struct smbXcli_session *session,
800 struct smbXcli_tcon *tcon,
801 uint8_t in_info_type,
802 uint8_t in_file_info_class,
803 const DATA_BLOB *in_input_buffer,
804 uint32_t in_additional_info,
805 uint64_t in_fid_persistent,
806 uint64_t in_fid_volatile);
807 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
808 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
809 uint32_t timeout_msec,
810 struct smbXcli_session *session,
811 struct smbXcli_tcon *tcon,
812 uint8_t in_info_type,
813 uint8_t in_file_info_class,
814 const DATA_BLOB *in_input_buffer,
815 uint32_t in_additional_info,
816 uint64_t in_fid_persistent,
817 uint64_t in_fid_volatile);
819 struct tevent_req *smb2cli_query_info_send(TALLOC_CTX *mem_ctx,
820 struct tevent_context *ev,
821 struct smbXcli_conn *conn,
822 uint32_t timeout_msec,
823 struct smbXcli_session *session,
824 struct smbXcli_tcon *tcon,
825 uint8_t in_info_type,
826 uint8_t in_file_info_class,
827 uint32_t in_max_output_length,
828 const DATA_BLOB *in_input_buffer,
829 uint32_t in_additional_info,
830 uint32_t in_flags,
831 uint64_t in_fid_persistent,
832 uint64_t in_fid_volatile);
833 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
834 TALLOC_CTX *mem_ctx,
835 DATA_BLOB *out_output_buffer);
836 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
837 uint32_t timeout_msec,
838 struct smbXcli_session *session,
839 struct smbXcli_tcon *tcon,
840 uint8_t in_info_type,
841 uint8_t in_file_info_class,
842 uint32_t in_max_output_length,
843 const DATA_BLOB *in_input_buffer,
844 uint32_t in_additional_info,
845 uint32_t in_flags,
846 uint64_t in_fid_persistent,
847 uint64_t in_fid_volatile,
848 TALLOC_CTX *mem_ctx,
849 DATA_BLOB *out_output_buffer);
851 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
852 struct tevent_context *ev,
853 struct smbXcli_conn *conn,
854 uint32_t timeout_msec,
855 struct smbXcli_session *session,
856 struct smbXcli_tcon *tcon,
857 uint8_t level,
858 uint8_t flags,
859 uint32_t file_index,
860 uint64_t fid_persistent,
861 uint64_t fid_volatile,
862 const char *mask,
863 uint32_t outbuf_len);
864 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
865 TALLOC_CTX *mem_ctx,
866 uint8_t **data,
867 uint32_t *data_length);
868 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
869 uint32_t timeout_msec,
870 struct smbXcli_session *session,
871 struct smbXcli_tcon *tcon,
872 uint8_t level,
873 uint8_t flags,
874 uint32_t file_index,
875 uint64_t fid_persistent,
876 uint64_t fid_volatile,
877 const char *mask,
878 uint32_t outbuf_len,
879 TALLOC_CTX *mem_ctx,
880 uint8_t **data,
881 uint32_t *data_length);
883 struct tevent_req *smb2cli_notify_send(TALLOC_CTX *mem_ctx,
884 struct tevent_context *ev,
885 struct smbXcli_conn *conn,
886 uint32_t timeout_msec,
887 struct smbXcli_session *session,
888 struct smbXcli_tcon *tcon,
889 uint32_t output_buffer_length,
890 uint64_t fid_persistent,
891 uint64_t fid_volatile,
892 uint32_t completion_filter,
893 bool recursive);
894 NTSTATUS smb2cli_notify_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
895 uint8_t **data, uint32_t *data_length);
896 NTSTATUS smb2cli_notify(struct smbXcli_conn *conn,
897 uint32_t timeout_msec,
898 struct smbXcli_session *session,
899 struct smbXcli_tcon *tcon,
900 uint32_t output_buffer_length,
901 uint64_t fid_persistent,
902 uint64_t fid_volatile,
903 uint32_t completion_filter,
904 bool recursive,
905 TALLOC_CTX *mem_ctx,
906 uint8_t **data,
907 uint32_t *data_length);
909 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
910 struct tevent_context *ev,
911 struct smbXcli_conn *conn,
912 uint32_t timeout_msec,
913 struct smbXcli_session *session,
914 struct smbXcli_tcon *tcon,
915 uint64_t in_fid_persistent,
916 uint64_t in_fid_volatile,
917 uint32_t in_ctl_code,
918 uint32_t in_max_input_length,
919 const DATA_BLOB *in_input_buffer,
920 uint32_t in_max_output_length,
921 const DATA_BLOB *in_output_buffer,
922 uint32_t in_flags);
923 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
924 TALLOC_CTX *mem_ctx,
925 DATA_BLOB *out_input_buffer,
926 DATA_BLOB *out_output_buffer);
927 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
928 uint32_t timeout_msec,
929 struct smbXcli_session *session,
930 struct smbXcli_tcon *tcon,
931 uint64_t in_fid_persistent,
932 uint64_t in_fid_volatile,
933 uint32_t in_ctl_code,
934 uint32_t in_max_input_length,
935 const DATA_BLOB *in_input_buffer,
936 uint32_t in_max_output_length,
937 const DATA_BLOB *in_output_buffer,
938 uint32_t in_flags,
939 TALLOC_CTX *mem_ctx,
940 DATA_BLOB *out_input_buffer,
941 DATA_BLOB *out_output_buffer);
943 struct tevent_req *smb2cli_echo_send(TALLOC_CTX *mem_ctx,
944 struct tevent_context *ev,
945 struct smbXcli_conn *conn,
946 uint32_t timeout_msec);
947 NTSTATUS smb2cli_echo_recv(struct tevent_req *req);
948 NTSTATUS smb2cli_echo(struct smbXcli_conn *conn,
949 uint32_t timeout_msec);
951 struct tevent_req *smb2cli_ioctl_pipe_wait_send(TALLOC_CTX *mem_ctx,
952 struct tevent_context *ev,
953 struct smbXcli_conn *conn,
954 uint32_t timeout_msec,
955 struct smbXcli_session *session,
956 struct smbXcli_tcon *tcon,
957 const char *pipe_name,
958 uint64_t pipe_wait_timeout);
960 NTSTATUS smb2cli_ioctl_pipe_wait_recv(struct tevent_req *req);
962 NTSTATUS smb2cli_ioctl_pipe_wait(struct smbXcli_conn *conn,
963 uint32_t timeout_msec,
964 struct smbXcli_session *session,
965 struct smbXcli_tcon *tcon,
966 const char *pipe_name,
967 uint64_t pipe_wait_timeout);
969 #endif /* _SMBXCLI_BASE_H_ */