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_unicode(struct smbXcli_conn *conn);
50 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
51 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
52 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
53 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
55 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
56 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
57 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
58 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
60 struct tevent_req *smbXcli_conn_samba_suicide_send(TALLOC_CTX *mem_ctx,
61 struct tevent_context *ev,
62 struct smbXcli_conn *conn,
64 NTSTATUS smbXcli_conn_samba_suicide_recv(struct tevent_req *req);
65 NTSTATUS smbXcli_conn_samba_suicide(struct smbXcli_conn *conn,
68 void smbXcli_req_unset_pending(struct tevent_req *req);
69 bool smbXcli_req_set_pending(struct tevent_req *req);
71 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
72 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
73 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
74 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
75 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
76 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
77 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
78 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
79 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
80 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
82 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
83 const DATA_BLOB user_session_key,
84 const DATA_BLOB response);
85 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
86 const uint8_t *buf, uint32_t seqnum);
87 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
89 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
90 struct smb_trans_enc_state *es);
91 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
93 bool smb1cli_is_andx_req(uint8_t cmd);
94 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
96 uint16_t smb1cli_req_mid(struct tevent_req *req);
97 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
99 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
100 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
102 struct smb1cli_req_expected_response {
107 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
108 struct tevent_context *ev,
109 struct smbXcli_conn *conn,
111 uint8_t additional_flags,
113 uint16_t additional_flags2,
114 uint16_t clear_flags2,
115 uint32_t timeout_msec,
117 struct smbXcli_tcon *tcon,
118 struct smbXcli_session *session,
119 uint8_t wct, uint16_t *vwv,
121 struct iovec *bytes_iov);
122 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
124 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
125 struct tevent_context *ev,
126 struct smbXcli_conn *conn,
128 uint8_t additional_flags,
130 uint16_t additional_flags2,
131 uint16_t clear_flags2,
132 uint32_t timeout_msec,
134 struct smbXcli_tcon *tcon,
135 struct smbXcli_session *session,
136 uint8_t wct, uint16_t *vwv,
138 const uint8_t *bytes);
139 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
145 uint32_t *pvwv_offset,
146 uint32_t *pnum_bytes,
148 uint32_t *pbytes_offset,
150 const struct smb1cli_req_expected_response *expected,
151 size_t num_expected);
153 struct tevent_req *smb1cli_trans_send(
154 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
155 struct smbXcli_conn *conn, uint8_t cmd,
156 uint8_t additional_flags, uint8_t clear_flags,
157 uint16_t additional_flags2, uint16_t clear_flags2,
158 uint32_t timeout_msec,
160 struct smbXcli_tcon *tcon,
161 struct smbXcli_session *session,
162 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
163 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
164 uint8_t *param, uint32_t num_param, uint32_t max_param,
165 uint8_t *data, uint32_t num_data, uint32_t max_data);
166 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
167 uint16_t *recv_flags2,
168 uint16_t **setup, uint8_t min_setup,
170 uint8_t **param, uint32_t min_param,
172 uint8_t **data, uint32_t min_data,
174 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
176 uint8_t additional_flags, uint8_t clear_flags,
177 uint16_t additional_flags2, uint16_t clear_flags2,
178 uint32_t timeout_msec,
180 struct smbXcli_tcon *tcon,
181 struct smbXcli_session *session,
182 const char *pipe_name, uint16_t fid, uint16_t function,
184 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
185 uint8_t *param, uint32_t num_param, uint32_t max_param,
186 uint8_t *data, uint32_t num_data, uint32_t max_data,
187 uint16_t *recv_flags2,
188 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
189 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
190 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
192 struct tevent_req *smb1cli_echo_send(TALLOC_CTX *mem_ctx,
193 struct tevent_context *ev,
194 struct smbXcli_conn *conn,
195 uint32_t timeout_msec,
198 NTSTATUS smb1cli_echo_recv(struct tevent_req *req);
199 NTSTATUS smb1cli_echo(struct smbXcli_conn *conn, uint32_t timeout_msec,
200 uint16_t num_echos, DATA_BLOB data);
202 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
203 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
204 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
205 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
206 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
207 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
208 uint16_t max_credits);
210 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
211 struct tevent_context *ev,
212 struct smbXcli_conn *conn,
214 uint32_t additional_flags,
215 uint32_t clear_flags,
216 uint32_t timeout_msec,
217 struct smbXcli_tcon *tcon,
218 struct smbXcli_session *session,
219 const uint8_t *fixed,
223 void smb2cli_req_set_notify_async(struct tevent_req *req);
224 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
226 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
228 struct smb2cli_req_expected_response {
233 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
234 struct tevent_context *ev,
235 struct smbXcli_conn *conn,
237 uint32_t additional_flags,
238 uint32_t clear_flags,
239 uint32_t timeout_msec,
240 struct smbXcli_tcon *tcon,
241 struct smbXcli_session *session,
242 const uint8_t *fixed,
246 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
248 const struct smb2cli_req_expected_response *expected,
249 size_t num_expected);
251 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
252 struct tevent_context *ev,
253 struct smbXcli_conn *conn,
254 uint32_t timeout_msec,
255 enum protocol_types min_protocol,
256 enum protocol_types max_protocol);
257 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
258 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
259 uint32_t timeout_msec,
260 enum protocol_types min_protocol,
261 enum protocol_types max_protocol);
263 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
264 struct smbXcli_conn *conn);
265 struct smbXcli_session *smbXcli_session_copy(TALLOC_CTX *mem_ctx,
266 struct smbXcli_session *src);
267 NTSTATUS smbXcli_session_application_key(struct smbXcli_session *session,
270 void smbXcli_session_set_disconnect_expired(struct smbXcli_session *session);
271 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
272 void smb1cli_session_set_id(struct smbXcli_session* session,
273 uint16_t session_id);
274 NTSTATUS smb1cli_session_set_session_key(struct smbXcli_session *session,
275 const DATA_BLOB _session_key);
276 NTSTATUS smb1cli_session_protect_session_key(struct smbXcli_session *session);
277 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
278 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
279 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
280 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
282 uint16_t session_flags);
283 void smb2cli_session_increment_channel_sequence(struct smbXcli_session *session);
284 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
285 const DATA_BLOB session_key,
286 const struct iovec *recv_iov);
287 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
288 struct smbXcli_session *session1,
289 struct smbXcli_conn *conn,
290 struct smbXcli_session **_session2);
291 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
292 const DATA_BLOB channel_key,
293 const struct iovec *recv_iov);
295 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
296 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
297 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
298 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
300 uint16_t optional_support,
301 uint32_t maximal_access,
302 uint32_t guest_maximal_access,
304 const char *fs_type);
305 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
306 uint32_t smb2cli_tcon_capabilities(struct smbXcli_tcon *tcon);
307 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
308 struct smbXcli_session *session,
312 uint32_t capabilities,
313 uint32_t maximal_access);
315 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
316 struct tevent_context *ev,
317 struct smbXcli_conn *conn,
318 uint32_t timeout_msec,
319 struct smbXcli_session *session,
321 uint32_t in_capabilities,
323 uint64_t in_previous_session_id,
324 const DATA_BLOB *in_security_buffer);
325 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
327 struct iovec **recv_iov,
328 DATA_BLOB *out_security_buffer);
330 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
331 struct tevent_context *ev,
332 struct smbXcli_conn *conn,
333 uint32_t timeout_msec,
334 struct smbXcli_session *session);
335 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
336 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
337 uint32_t timeout_msec,
338 struct smbXcli_session *session);
340 struct tevent_req *smb2cli_create_send(
342 struct tevent_context *ev,
343 struct smbXcli_conn *conn,
344 uint32_t timeout_msec,
345 struct smbXcli_session *session,
346 struct smbXcli_tcon *tcon,
347 const char *filename,
348 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
349 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
350 uint32_t desired_access,
351 uint32_t file_attributes,
352 uint32_t share_access,
353 uint32_t create_disposition,
354 uint32_t create_options,
355 struct smb2_create_blobs *blobs);
356 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
357 uint64_t *fid_persistent,
358 uint64_t *fid_volatile);
359 NTSTATUS smb2cli_create(struct smbXcli_conn *conn,
360 uint32_t timeout_msec,
361 struct smbXcli_session *session,
362 struct smbXcli_tcon *tcon,
363 const char *filename,
364 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
365 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
366 uint32_t desired_access,
367 uint32_t file_attributes,
368 uint32_t share_access,
369 uint32_t create_disposition,
370 uint32_t create_options,
371 struct smb2_create_blobs *blobs,
372 uint64_t *fid_persistent,
373 uint64_t *fid_volatile);
375 struct tevent_req *smb2cli_close_send(TALLOC_CTX *mem_ctx,
376 struct tevent_context *ev,
377 struct smbXcli_conn *conn,
378 uint32_t timeout_msec,
379 struct smbXcli_session *session,
380 struct smbXcli_tcon *tcon,
382 uint64_t fid_persistent,
383 uint64_t fid_volatile);
384 NTSTATUS smb2cli_close_recv(struct tevent_req *req);
385 NTSTATUS smb2cli_close(struct smbXcli_conn *conn,
386 uint32_t timeout_msec,
387 struct smbXcli_session *session,
388 struct smbXcli_tcon *tcon,
390 uint64_t fid_persistent,
391 uint64_t fid_volatile);
393 struct tevent_req *smb2cli_read_send(TALLOC_CTX *mem_ctx,
394 struct tevent_context *ev,
395 struct smbXcli_conn *conn,
396 uint32_t timeout_msec,
397 struct smbXcli_session *session,
398 struct smbXcli_tcon *tcon,
401 uint64_t fid_persistent,
402 uint64_t fid_volatile,
403 uint64_t minimum_count,
404 uint64_t remaining_bytes);
405 NTSTATUS smb2cli_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
406 uint8_t **data, uint32_t *data_length);
407 NTSTATUS smb2cli_read(struct smbXcli_conn *conn,
408 uint32_t timeout_msec,
409 struct smbXcli_session *session,
410 struct smbXcli_tcon *tcon,
413 uint64_t fid_persistent,
414 uint64_t fid_volatile,
415 uint64_t minimum_count,
416 uint64_t remaining_bytes,
419 uint32_t *data_length);
421 struct tevent_req *smb2cli_write_send(TALLOC_CTX *mem_ctx,
422 struct tevent_context *ev,
423 struct smbXcli_conn *conn,
424 uint32_t timeout_msec,
425 struct smbXcli_session *session,
426 struct smbXcli_tcon *tcon,
429 uint64_t fid_persistent,
430 uint64_t fid_volatile,
431 uint32_t remaining_bytes,
433 const uint8_t *data);
434 NTSTATUS smb2cli_write_recv(struct tevent_req *req);
435 NTSTATUS smb2cli_write(struct smbXcli_conn *conn,
436 uint32_t timeout_msec,
437 struct smbXcli_session *session,
438 struct smbXcli_tcon *tcon,
441 uint64_t fid_persistent,
442 uint64_t fid_volatile,
443 uint32_t remaining_bytes,
445 const uint8_t *data);
447 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
448 struct tevent_context *ev,
449 struct smbXcli_conn *conn,
450 uint32_t timeout_msec,
451 struct smbXcli_session *session,
452 struct smbXcli_tcon *tcon,
453 uint64_t fid_persistent,
454 uint64_t fid_volatile);
455 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
456 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
457 uint32_t timeout_msec,
458 struct smbXcli_session *session,
459 struct smbXcli_tcon *tcon,
460 uint64_t fid_persistent,
461 uint64_t fid_volatile);
463 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
464 struct tevent_context *ev,
465 struct smbXcli_conn *conn,
466 uint32_t timeout_msec,
467 struct smbXcli_session *session,
468 struct smbXcli_tcon *tcon,
469 uint8_t in_info_type,
470 uint8_t in_file_info_class,
471 const DATA_BLOB *in_input_buffer,
472 uint32_t in_additional_info,
473 uint64_t in_fid_persistent,
474 uint64_t in_fid_volatile);
475 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
476 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
477 uint32_t timeout_msec,
478 struct smbXcli_session *session,
479 struct smbXcli_tcon *tcon,
480 uint8_t in_info_type,
481 uint8_t in_file_info_class,
482 const DATA_BLOB *in_input_buffer,
483 uint32_t in_additional_info,
484 uint64_t in_fid_persistent,
485 uint64_t in_fid_volatile);
487 struct tevent_req *smb2cli_query_info_send(TALLOC_CTX *mem_ctx,
488 struct tevent_context *ev,
489 struct smbXcli_conn *conn,
490 uint32_t timeout_msec,
491 struct smbXcli_session *session,
492 struct smbXcli_tcon *tcon,
493 uint8_t in_info_type,
494 uint8_t in_file_info_class,
495 uint32_t in_max_output_length,
496 const DATA_BLOB *in_input_buffer,
497 uint32_t in_additional_info,
499 uint64_t in_fid_persistent,
500 uint64_t in_fid_volatile);
501 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
503 DATA_BLOB *out_output_buffer);
504 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
505 uint32_t timeout_msec,
506 struct smbXcli_session *session,
507 struct smbXcli_tcon *tcon,
508 uint8_t in_info_type,
509 uint8_t in_file_info_class,
510 uint32_t in_max_output_length,
511 const DATA_BLOB *in_input_buffer,
512 uint32_t in_additional_info,
514 uint64_t in_fid_persistent,
515 uint64_t in_fid_volatile,
517 DATA_BLOB *out_output_buffer);
519 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
520 struct tevent_context *ev,
521 struct smbXcli_conn *conn,
522 uint32_t timeout_msec,
523 struct smbXcli_session *session,
524 struct smbXcli_tcon *tcon,
528 uint64_t fid_persistent,
529 uint64_t fid_volatile,
531 uint32_t outbuf_len);
532 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
535 uint32_t *data_length);
536 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
537 uint32_t timeout_msec,
538 struct smbXcli_session *session,
539 struct smbXcli_tcon *tcon,
543 uint64_t fid_persistent,
544 uint64_t fid_volatile,
549 uint32_t *data_length);
551 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
552 struct tevent_context *ev,
553 struct smbXcli_conn *conn,
554 uint32_t timeout_msec,
555 struct smbXcli_session *session,
556 struct smbXcli_tcon *tcon,
557 uint64_t in_fid_persistent,
558 uint64_t in_fid_volatile,
559 uint32_t in_ctl_code,
560 uint32_t in_max_input_length,
561 const DATA_BLOB *in_input_buffer,
562 uint32_t in_max_output_length,
563 const DATA_BLOB *in_output_buffer,
565 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
567 DATA_BLOB *out_input_buffer,
568 DATA_BLOB *out_output_buffer);
569 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
570 uint32_t timeout_msec,
571 struct smbXcli_session *session,
572 struct smbXcli_tcon *tcon,
573 uint64_t in_fid_persistent,
574 uint64_t in_fid_volatile,
575 uint32_t in_ctl_code,
576 uint32_t in_max_input_length,
577 const DATA_BLOB *in_input_buffer,
578 uint32_t in_max_output_length,
579 const DATA_BLOB *in_output_buffer,
582 DATA_BLOB *out_input_buffer,
583 DATA_BLOB *out_output_buffer);
585 struct tevent_req *smb2cli_echo_send(TALLOC_CTX *mem_ctx,
586 struct tevent_context *ev,
587 struct smbXcli_conn *conn,
588 uint32_t timeout_msec);
589 NTSTATUS smb2cli_echo_recv(struct tevent_req *req);
590 NTSTATUS smb2cli_echo(struct smbXcli_conn *conn,
591 uint32_t timeout_msec);
593 #endif /* _SMBXCLI_BASE_H_ */