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_
25 struct smbXcli_session;
27 struct smb_trans_enc_state;
30 struct smb2_create_blobs;
32 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
34 const char *remote_name,
35 enum smb_signing_setting signing_state,
36 uint32_t smb1_capabilities,
37 struct GUID *client_guid,
38 uint32_t smb2_capabilities);
40 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
41 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
43 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
45 bool smbXcli_conn_dfs_supported(struct smbXcli_conn *conn);
47 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
48 bool smbXcli_conn_use_status32(struct smbXcli_conn *conn);
49 bool smbXcli_conn_use_large_files(struct smbXcli_conn *conn);
50 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
52 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
53 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
54 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
55 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
57 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
58 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
59 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
60 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
62 struct tevent_req *smbXcli_conn_samba_suicide_send(TALLOC_CTX *mem_ctx,
63 struct tevent_context *ev,
64 struct smbXcli_conn *conn,
66 NTSTATUS smbXcli_conn_samba_suicide_recv(struct tevent_req *req);
67 NTSTATUS smbXcli_conn_samba_suicide(struct smbXcli_conn *conn,
70 void smbXcli_req_unset_pending(struct tevent_req *req);
71 bool smbXcli_req_set_pending(struct tevent_req *req);
73 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
74 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
75 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
76 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
77 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
78 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
79 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
80 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
81 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
82 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
84 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
85 const DATA_BLOB user_session_key,
86 const DATA_BLOB response);
87 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
88 const uint8_t *buf, uint32_t seqnum);
89 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
91 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
92 struct smb_trans_enc_state *es);
93 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
95 bool smb1cli_is_andx_req(uint8_t cmd);
96 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
98 uint16_t smb1cli_req_mid(struct tevent_req *req);
99 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
101 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
102 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
104 struct smb1cli_req_expected_response {
109 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
110 struct tevent_context *ev,
111 struct smbXcli_conn *conn,
113 uint8_t additional_flags,
115 uint16_t additional_flags2,
116 uint16_t clear_flags2,
117 uint32_t timeout_msec,
119 struct smbXcli_tcon *tcon,
120 struct smbXcli_session *session,
121 uint8_t wct, uint16_t *vwv,
123 struct iovec *bytes_iov);
124 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
126 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
127 struct tevent_context *ev,
128 struct smbXcli_conn *conn,
130 uint8_t additional_flags,
132 uint16_t additional_flags2,
133 uint16_t clear_flags2,
134 uint32_t timeout_msec,
136 struct smbXcli_tcon *tcon,
137 struct smbXcli_session *session,
138 uint8_t wct, uint16_t *vwv,
140 const uint8_t *bytes);
141 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
147 uint32_t *pvwv_offset,
148 uint32_t *pnum_bytes,
150 uint32_t *pbytes_offset,
152 const struct smb1cli_req_expected_response *expected,
153 size_t num_expected);
155 struct tevent_req *smb1cli_trans_send(
156 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
157 struct smbXcli_conn *conn, uint8_t cmd,
158 uint8_t additional_flags, uint8_t clear_flags,
159 uint16_t additional_flags2, uint16_t clear_flags2,
160 uint32_t timeout_msec,
162 struct smbXcli_tcon *tcon,
163 struct smbXcli_session *session,
164 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
165 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
166 uint8_t *param, uint32_t num_param, uint32_t max_param,
167 uint8_t *data, uint32_t num_data, uint32_t max_data);
168 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
169 uint16_t *recv_flags2,
170 uint16_t **setup, uint8_t min_setup,
172 uint8_t **param, uint32_t min_param,
174 uint8_t **data, uint32_t min_data,
176 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
178 uint8_t additional_flags, uint8_t clear_flags,
179 uint16_t additional_flags2, uint16_t clear_flags2,
180 uint32_t timeout_msec,
182 struct smbXcli_tcon *tcon,
183 struct smbXcli_session *session,
184 const char *pipe_name, uint16_t fid, uint16_t function,
186 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
187 uint8_t *param, uint32_t num_param, uint32_t max_param,
188 uint8_t *data, uint32_t num_data, uint32_t max_data,
189 uint16_t *recv_flags2,
190 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
191 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
192 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
194 struct tevent_req *smb1cli_echo_send(TALLOC_CTX *mem_ctx,
195 struct tevent_context *ev,
196 struct smbXcli_conn *conn,
197 uint32_t timeout_msec,
200 NTSTATUS smb1cli_echo_recv(struct tevent_req *req);
201 NTSTATUS smb1cli_echo(struct smbXcli_conn *conn, uint32_t timeout_msec,
202 uint16_t num_echos, DATA_BLOB data);
204 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
205 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
206 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
207 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
208 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
209 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
210 uint16_t max_credits);
212 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
213 struct tevent_context *ev,
214 struct smbXcli_conn *conn,
216 uint32_t additional_flags,
217 uint32_t clear_flags,
218 uint32_t timeout_msec,
219 struct smbXcli_tcon *tcon,
220 struct smbXcli_session *session,
221 const uint8_t *fixed,
225 void smb2cli_req_set_notify_async(struct tevent_req *req);
226 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
228 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
230 struct smb2cli_req_expected_response {
235 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
236 struct tevent_context *ev,
237 struct smbXcli_conn *conn,
239 uint32_t additional_flags,
240 uint32_t clear_flags,
241 uint32_t timeout_msec,
242 struct smbXcli_tcon *tcon,
243 struct smbXcli_session *session,
244 const uint8_t *fixed,
248 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
250 const struct smb2cli_req_expected_response *expected,
251 size_t num_expected);
253 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
254 struct tevent_context *ev,
255 struct smbXcli_conn *conn,
256 uint32_t timeout_msec,
257 enum protocol_types min_protocol,
258 enum protocol_types max_protocol);
259 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
260 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
261 uint32_t timeout_msec,
262 enum protocol_types min_protocol,
263 enum protocol_types max_protocol);
265 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
266 struct smbXcli_conn *conn);
267 struct smbXcli_session *smbXcli_session_copy(TALLOC_CTX *mem_ctx,
268 struct smbXcli_session *src);
269 NTSTATUS smbXcli_session_application_key(struct smbXcli_session *session,
272 void smbXcli_session_set_disconnect_expired(struct smbXcli_session *session);
273 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
274 void smb1cli_session_set_id(struct smbXcli_session* session,
275 uint16_t session_id);
276 NTSTATUS smb1cli_session_set_session_key(struct smbXcli_session *session,
277 const DATA_BLOB _session_key);
278 NTSTATUS smb1cli_session_protect_session_key(struct smbXcli_session *session);
279 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
280 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
281 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
282 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
284 uint16_t session_flags);
285 void smb2cli_session_increment_channel_sequence(struct smbXcli_session *session);
286 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
287 const DATA_BLOB session_key,
288 const struct iovec *recv_iov);
289 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
290 struct smbXcli_session *session1,
291 struct smbXcli_conn *conn,
292 struct smbXcli_session **_session2);
293 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
294 const DATA_BLOB channel_key,
295 const struct iovec *recv_iov);
297 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
298 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
299 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
300 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
302 uint16_t optional_support,
303 uint32_t maximal_access,
304 uint32_t guest_maximal_access,
306 const char *fs_type);
307 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
308 uint32_t smb2cli_tcon_capabilities(struct smbXcli_tcon *tcon);
309 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
310 struct smbXcli_session *session,
314 uint32_t capabilities,
315 uint32_t maximal_access);
317 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
318 struct tevent_context *ev,
319 struct smbXcli_conn *conn,
320 uint32_t timeout_msec,
321 struct smbXcli_session *session,
323 uint32_t in_capabilities,
325 uint64_t in_previous_session_id,
326 const DATA_BLOB *in_security_buffer);
327 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
329 struct iovec **recv_iov,
330 DATA_BLOB *out_security_buffer);
332 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
333 struct tevent_context *ev,
334 struct smbXcli_conn *conn,
335 uint32_t timeout_msec,
336 struct smbXcli_session *session);
337 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
338 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
339 uint32_t timeout_msec,
340 struct smbXcli_session *session);
342 struct tevent_req *smb2cli_create_send(
344 struct tevent_context *ev,
345 struct smbXcli_conn *conn,
346 uint32_t timeout_msec,
347 struct smbXcli_session *session,
348 struct smbXcli_tcon *tcon,
349 const char *filename,
350 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
351 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
352 uint32_t desired_access,
353 uint32_t file_attributes,
354 uint32_t share_access,
355 uint32_t create_disposition,
356 uint32_t create_options,
357 struct smb2_create_blobs *blobs);
358 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
359 uint64_t *fid_persistent,
360 uint64_t *fid_volatile);
361 NTSTATUS smb2cli_create(struct smbXcli_conn *conn,
362 uint32_t timeout_msec,
363 struct smbXcli_session *session,
364 struct smbXcli_tcon *tcon,
365 const char *filename,
366 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
367 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
368 uint32_t desired_access,
369 uint32_t file_attributes,
370 uint32_t share_access,
371 uint32_t create_disposition,
372 uint32_t create_options,
373 struct smb2_create_blobs *blobs,
374 uint64_t *fid_persistent,
375 uint64_t *fid_volatile);
377 struct tevent_req *smb2cli_close_send(TALLOC_CTX *mem_ctx,
378 struct tevent_context *ev,
379 struct smbXcli_conn *conn,
380 uint32_t timeout_msec,
381 struct smbXcli_session *session,
382 struct smbXcli_tcon *tcon,
384 uint64_t fid_persistent,
385 uint64_t fid_volatile);
386 NTSTATUS smb2cli_close_recv(struct tevent_req *req);
387 NTSTATUS smb2cli_close(struct smbXcli_conn *conn,
388 uint32_t timeout_msec,
389 struct smbXcli_session *session,
390 struct smbXcli_tcon *tcon,
392 uint64_t fid_persistent,
393 uint64_t fid_volatile);
395 struct tevent_req *smb2cli_read_send(TALLOC_CTX *mem_ctx,
396 struct tevent_context *ev,
397 struct smbXcli_conn *conn,
398 uint32_t timeout_msec,
399 struct smbXcli_session *session,
400 struct smbXcli_tcon *tcon,
403 uint64_t fid_persistent,
404 uint64_t fid_volatile,
405 uint64_t minimum_count,
406 uint64_t remaining_bytes);
407 NTSTATUS smb2cli_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
408 uint8_t **data, uint32_t *data_length);
409 NTSTATUS smb2cli_read(struct smbXcli_conn *conn,
410 uint32_t timeout_msec,
411 struct smbXcli_session *session,
412 struct smbXcli_tcon *tcon,
415 uint64_t fid_persistent,
416 uint64_t fid_volatile,
417 uint64_t minimum_count,
418 uint64_t remaining_bytes,
421 uint32_t *data_length);
423 struct tevent_req *smb2cli_write_send(TALLOC_CTX *mem_ctx,
424 struct tevent_context *ev,
425 struct smbXcli_conn *conn,
426 uint32_t timeout_msec,
427 struct smbXcli_session *session,
428 struct smbXcli_tcon *tcon,
431 uint64_t fid_persistent,
432 uint64_t fid_volatile,
433 uint32_t remaining_bytes,
435 const uint8_t *data);
436 NTSTATUS smb2cli_write_recv(struct tevent_req *req);
437 NTSTATUS smb2cli_write(struct smbXcli_conn *conn,
438 uint32_t timeout_msec,
439 struct smbXcli_session *session,
440 struct smbXcli_tcon *tcon,
443 uint64_t fid_persistent,
444 uint64_t fid_volatile,
445 uint32_t remaining_bytes,
447 const uint8_t *data);
449 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
450 struct tevent_context *ev,
451 struct smbXcli_conn *conn,
452 uint32_t timeout_msec,
453 struct smbXcli_session *session,
454 struct smbXcli_tcon *tcon,
455 uint64_t fid_persistent,
456 uint64_t fid_volatile);
457 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
458 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
459 uint32_t timeout_msec,
460 struct smbXcli_session *session,
461 struct smbXcli_tcon *tcon,
462 uint64_t fid_persistent,
463 uint64_t fid_volatile);
465 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
466 struct tevent_context *ev,
467 struct smbXcli_conn *conn,
468 uint32_t timeout_msec,
469 struct smbXcli_session *session,
470 struct smbXcli_tcon *tcon,
471 uint8_t in_info_type,
472 uint8_t in_file_info_class,
473 const DATA_BLOB *in_input_buffer,
474 uint32_t in_additional_info,
475 uint64_t in_fid_persistent,
476 uint64_t in_fid_volatile);
477 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
478 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
479 uint32_t timeout_msec,
480 struct smbXcli_session *session,
481 struct smbXcli_tcon *tcon,
482 uint8_t in_info_type,
483 uint8_t in_file_info_class,
484 const DATA_BLOB *in_input_buffer,
485 uint32_t in_additional_info,
486 uint64_t in_fid_persistent,
487 uint64_t in_fid_volatile);
489 struct tevent_req *smb2cli_query_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 uint8_t in_info_type,
496 uint8_t in_file_info_class,
497 uint32_t in_max_output_length,
498 const DATA_BLOB *in_input_buffer,
499 uint32_t in_additional_info,
501 uint64_t in_fid_persistent,
502 uint64_t in_fid_volatile);
503 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
505 DATA_BLOB *out_output_buffer);
506 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
507 uint32_t timeout_msec,
508 struct smbXcli_session *session,
509 struct smbXcli_tcon *tcon,
510 uint8_t in_info_type,
511 uint8_t in_file_info_class,
512 uint32_t in_max_output_length,
513 const DATA_BLOB *in_input_buffer,
514 uint32_t in_additional_info,
516 uint64_t in_fid_persistent,
517 uint64_t in_fid_volatile,
519 DATA_BLOB *out_output_buffer);
521 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
522 struct tevent_context *ev,
523 struct smbXcli_conn *conn,
524 uint32_t timeout_msec,
525 struct smbXcli_session *session,
526 struct smbXcli_tcon *tcon,
530 uint64_t fid_persistent,
531 uint64_t fid_volatile,
533 uint32_t outbuf_len);
534 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
537 uint32_t *data_length);
538 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
539 uint32_t timeout_msec,
540 struct smbXcli_session *session,
541 struct smbXcli_tcon *tcon,
545 uint64_t fid_persistent,
546 uint64_t fid_volatile,
551 uint32_t *data_length);
553 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
554 struct tevent_context *ev,
555 struct smbXcli_conn *conn,
556 uint32_t timeout_msec,
557 struct smbXcli_session *session,
558 struct smbXcli_tcon *tcon,
559 uint64_t in_fid_persistent,
560 uint64_t in_fid_volatile,
561 uint32_t in_ctl_code,
562 uint32_t in_max_input_length,
563 const DATA_BLOB *in_input_buffer,
564 uint32_t in_max_output_length,
565 const DATA_BLOB *in_output_buffer,
567 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
569 DATA_BLOB *out_input_buffer,
570 DATA_BLOB *out_output_buffer);
571 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
572 uint32_t timeout_msec,
573 struct smbXcli_session *session,
574 struct smbXcli_tcon *tcon,
575 uint64_t in_fid_persistent,
576 uint64_t in_fid_volatile,
577 uint32_t in_ctl_code,
578 uint32_t in_max_input_length,
579 const DATA_BLOB *in_input_buffer,
580 uint32_t in_max_output_length,
581 const DATA_BLOB *in_output_buffer,
584 DATA_BLOB *out_input_buffer,
585 DATA_BLOB *out_output_buffer);
587 struct tevent_req *smb2cli_echo_send(TALLOC_CTX *mem_ctx,
588 struct tevent_context *ev,
589 struct smbXcli_conn *conn,
590 uint32_t timeout_msec);
591 NTSTATUS smb2cli_echo_recv(struct tevent_req *req);
592 NTSTATUS smb2cli_echo(struct smbXcli_conn *conn,
593 uint32_t timeout_msec);
595 #endif /* _SMBXCLI_BASE_H_ */