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_large_files(struct smbXcli_conn *conn);
49 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
51 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
52 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
53 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
54 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
56 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
57 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
58 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
59 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
61 struct tevent_req *smbXcli_conn_samba_suicide_send(TALLOC_CTX *mem_ctx,
62 struct tevent_context *ev,
63 struct smbXcli_conn *conn,
65 NTSTATUS smbXcli_conn_samba_suicide_recv(struct tevent_req *req);
66 NTSTATUS smbXcli_conn_samba_suicide(struct smbXcli_conn *conn,
69 void smbXcli_req_unset_pending(struct tevent_req *req);
70 bool smbXcli_req_set_pending(struct tevent_req *req);
72 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
73 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
74 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
75 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
76 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
77 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
78 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
79 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
80 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
81 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
83 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
84 const DATA_BLOB user_session_key,
85 const DATA_BLOB response);
86 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
87 const uint8_t *buf, uint32_t seqnum);
88 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
90 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
91 struct smb_trans_enc_state *es);
92 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
94 bool smb1cli_is_andx_req(uint8_t cmd);
95 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
97 uint16_t smb1cli_req_mid(struct tevent_req *req);
98 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
100 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
101 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
103 struct smb1cli_req_expected_response {
108 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
109 struct tevent_context *ev,
110 struct smbXcli_conn *conn,
112 uint8_t additional_flags,
114 uint16_t additional_flags2,
115 uint16_t clear_flags2,
116 uint32_t timeout_msec,
118 struct smbXcli_tcon *tcon,
119 struct smbXcli_session *session,
120 uint8_t wct, uint16_t *vwv,
122 struct iovec *bytes_iov);
123 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
125 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
126 struct tevent_context *ev,
127 struct smbXcli_conn *conn,
129 uint8_t additional_flags,
131 uint16_t additional_flags2,
132 uint16_t clear_flags2,
133 uint32_t timeout_msec,
135 struct smbXcli_tcon *tcon,
136 struct smbXcli_session *session,
137 uint8_t wct, uint16_t *vwv,
139 const uint8_t *bytes);
140 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
146 uint32_t *pvwv_offset,
147 uint32_t *pnum_bytes,
149 uint32_t *pbytes_offset,
151 const struct smb1cli_req_expected_response *expected,
152 size_t num_expected);
154 struct tevent_req *smb1cli_trans_send(
155 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
156 struct smbXcli_conn *conn, uint8_t cmd,
157 uint8_t additional_flags, uint8_t clear_flags,
158 uint16_t additional_flags2, uint16_t clear_flags2,
159 uint32_t timeout_msec,
161 struct smbXcli_tcon *tcon,
162 struct smbXcli_session *session,
163 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
164 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
165 uint8_t *param, uint32_t num_param, uint32_t max_param,
166 uint8_t *data, uint32_t num_data, uint32_t max_data);
167 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
168 uint16_t *recv_flags2,
169 uint16_t **setup, uint8_t min_setup,
171 uint8_t **param, uint32_t min_param,
173 uint8_t **data, uint32_t min_data,
175 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
177 uint8_t additional_flags, uint8_t clear_flags,
178 uint16_t additional_flags2, uint16_t clear_flags2,
179 uint32_t timeout_msec,
181 struct smbXcli_tcon *tcon,
182 struct smbXcli_session *session,
183 const char *pipe_name, uint16_t fid, uint16_t function,
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 uint16_t *recv_flags2,
189 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
190 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
191 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
193 struct tevent_req *smb1cli_echo_send(TALLOC_CTX *mem_ctx,
194 struct tevent_context *ev,
195 struct smbXcli_conn *conn,
196 uint32_t timeout_msec,
199 NTSTATUS smb1cli_echo_recv(struct tevent_req *req);
200 NTSTATUS smb1cli_echo(struct smbXcli_conn *conn, uint32_t timeout_msec,
201 uint16_t num_echos, DATA_BLOB data);
203 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
204 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
205 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
206 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
207 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
208 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
209 uint16_t max_credits);
211 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
212 struct tevent_context *ev,
213 struct smbXcli_conn *conn,
215 uint32_t additional_flags,
216 uint32_t clear_flags,
217 uint32_t timeout_msec,
218 struct smbXcli_tcon *tcon,
219 struct smbXcli_session *session,
220 const uint8_t *fixed,
224 void smb2cli_req_set_notify_async(struct tevent_req *req);
225 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
227 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
229 struct smb2cli_req_expected_response {
234 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
235 struct tevent_context *ev,
236 struct smbXcli_conn *conn,
238 uint32_t additional_flags,
239 uint32_t clear_flags,
240 uint32_t timeout_msec,
241 struct smbXcli_tcon *tcon,
242 struct smbXcli_session *session,
243 const uint8_t *fixed,
247 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
249 const struct smb2cli_req_expected_response *expected,
250 size_t num_expected);
252 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
253 struct tevent_context *ev,
254 struct smbXcli_conn *conn,
255 uint32_t timeout_msec,
256 enum protocol_types min_protocol,
257 enum protocol_types max_protocol);
258 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
259 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
260 uint32_t timeout_msec,
261 enum protocol_types min_protocol,
262 enum protocol_types max_protocol);
264 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
265 struct smbXcli_conn *conn);
266 struct smbXcli_session *smbXcli_session_copy(TALLOC_CTX *mem_ctx,
267 struct smbXcli_session *src);
268 NTSTATUS smbXcli_session_application_key(struct smbXcli_session *session,
271 void smbXcli_session_set_disconnect_expired(struct smbXcli_session *session);
272 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
273 void smb1cli_session_set_id(struct smbXcli_session* session,
274 uint16_t session_id);
275 NTSTATUS smb1cli_session_set_session_key(struct smbXcli_session *session,
276 const DATA_BLOB _session_key);
277 NTSTATUS smb1cli_session_protect_session_key(struct smbXcli_session *session);
278 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
279 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
280 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
281 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
283 uint16_t session_flags);
284 void smb2cli_session_increment_channel_sequence(struct smbXcli_session *session);
285 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
286 const DATA_BLOB session_key,
287 const struct iovec *recv_iov);
288 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
289 struct smbXcli_session *session1,
290 struct smbXcli_conn *conn,
291 struct smbXcli_session **_session2);
292 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
293 const DATA_BLOB channel_key,
294 const struct iovec *recv_iov);
296 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
297 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
298 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
299 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
301 uint16_t optional_support,
302 uint32_t maximal_access,
303 uint32_t guest_maximal_access,
305 const char *fs_type);
306 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
307 uint32_t smb2cli_tcon_capabilities(struct smbXcli_tcon *tcon);
308 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
309 struct smbXcli_session *session,
313 uint32_t capabilities,
314 uint32_t maximal_access);
316 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
317 struct tevent_context *ev,
318 struct smbXcli_conn *conn,
319 uint32_t timeout_msec,
320 struct smbXcli_session *session,
322 uint32_t in_capabilities,
324 uint64_t in_previous_session_id,
325 const DATA_BLOB *in_security_buffer);
326 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
328 struct iovec **recv_iov,
329 DATA_BLOB *out_security_buffer);
331 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
332 struct tevent_context *ev,
333 struct smbXcli_conn *conn,
334 uint32_t timeout_msec,
335 struct smbXcli_session *session);
336 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
337 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
338 uint32_t timeout_msec,
339 struct smbXcli_session *session);
341 struct tevent_req *smb2cli_create_send(
343 struct tevent_context *ev,
344 struct smbXcli_conn *conn,
345 uint32_t timeout_msec,
346 struct smbXcli_session *session,
347 struct smbXcli_tcon *tcon,
348 const char *filename,
349 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
350 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
351 uint32_t desired_access,
352 uint32_t file_attributes,
353 uint32_t share_access,
354 uint32_t create_disposition,
355 uint32_t create_options,
356 struct smb2_create_blobs *blobs);
357 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
358 uint64_t *fid_persistent,
359 uint64_t *fid_volatile);
360 NTSTATUS smb2cli_create(struct smbXcli_conn *conn,
361 uint32_t timeout_msec,
362 struct smbXcli_session *session,
363 struct smbXcli_tcon *tcon,
364 const char *filename,
365 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
366 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
367 uint32_t desired_access,
368 uint32_t file_attributes,
369 uint32_t share_access,
370 uint32_t create_disposition,
371 uint32_t create_options,
372 struct smb2_create_blobs *blobs,
373 uint64_t *fid_persistent,
374 uint64_t *fid_volatile);
376 struct tevent_req *smb2cli_close_send(TALLOC_CTX *mem_ctx,
377 struct tevent_context *ev,
378 struct smbXcli_conn *conn,
379 uint32_t timeout_msec,
380 struct smbXcli_session *session,
381 struct smbXcli_tcon *tcon,
383 uint64_t fid_persistent,
384 uint64_t fid_volatile);
385 NTSTATUS smb2cli_close_recv(struct tevent_req *req);
386 NTSTATUS smb2cli_close(struct smbXcli_conn *conn,
387 uint32_t timeout_msec,
388 struct smbXcli_session *session,
389 struct smbXcli_tcon *tcon,
391 uint64_t fid_persistent,
392 uint64_t fid_volatile);
394 struct tevent_req *smb2cli_read_send(TALLOC_CTX *mem_ctx,
395 struct tevent_context *ev,
396 struct smbXcli_conn *conn,
397 uint32_t timeout_msec,
398 struct smbXcli_session *session,
399 struct smbXcli_tcon *tcon,
402 uint64_t fid_persistent,
403 uint64_t fid_volatile,
404 uint64_t minimum_count,
405 uint64_t remaining_bytes);
406 NTSTATUS smb2cli_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
407 uint8_t **data, uint32_t *data_length);
408 NTSTATUS smb2cli_read(struct smbXcli_conn *conn,
409 uint32_t timeout_msec,
410 struct smbXcli_session *session,
411 struct smbXcli_tcon *tcon,
414 uint64_t fid_persistent,
415 uint64_t fid_volatile,
416 uint64_t minimum_count,
417 uint64_t remaining_bytes,
420 uint32_t *data_length);
422 struct tevent_req *smb2cli_write_send(TALLOC_CTX *mem_ctx,
423 struct tevent_context *ev,
424 struct smbXcli_conn *conn,
425 uint32_t timeout_msec,
426 struct smbXcli_session *session,
427 struct smbXcli_tcon *tcon,
430 uint64_t fid_persistent,
431 uint64_t fid_volatile,
432 uint32_t remaining_bytes,
434 const uint8_t *data);
435 NTSTATUS smb2cli_write_recv(struct tevent_req *req);
436 NTSTATUS smb2cli_write(struct smbXcli_conn *conn,
437 uint32_t timeout_msec,
438 struct smbXcli_session *session,
439 struct smbXcli_tcon *tcon,
442 uint64_t fid_persistent,
443 uint64_t fid_volatile,
444 uint32_t remaining_bytes,
446 const uint8_t *data);
448 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
449 struct tevent_context *ev,
450 struct smbXcli_conn *conn,
451 uint32_t timeout_msec,
452 struct smbXcli_session *session,
453 struct smbXcli_tcon *tcon,
454 uint64_t fid_persistent,
455 uint64_t fid_volatile);
456 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
457 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
458 uint32_t timeout_msec,
459 struct smbXcli_session *session,
460 struct smbXcli_tcon *tcon,
461 uint64_t fid_persistent,
462 uint64_t fid_volatile);
464 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
465 struct tevent_context *ev,
466 struct smbXcli_conn *conn,
467 uint32_t timeout_msec,
468 struct smbXcli_session *session,
469 struct smbXcli_tcon *tcon,
470 uint8_t in_info_type,
471 uint8_t in_file_info_class,
472 const DATA_BLOB *in_input_buffer,
473 uint32_t in_additional_info,
474 uint64_t in_fid_persistent,
475 uint64_t in_fid_volatile);
476 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
477 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
478 uint32_t timeout_msec,
479 struct smbXcli_session *session,
480 struct smbXcli_tcon *tcon,
481 uint8_t in_info_type,
482 uint8_t in_file_info_class,
483 const DATA_BLOB *in_input_buffer,
484 uint32_t in_additional_info,
485 uint64_t in_fid_persistent,
486 uint64_t in_fid_volatile);
488 struct tevent_req *smb2cli_query_info_send(TALLOC_CTX *mem_ctx,
489 struct tevent_context *ev,
490 struct smbXcli_conn *conn,
491 uint32_t timeout_msec,
492 struct smbXcli_session *session,
493 struct smbXcli_tcon *tcon,
494 uint8_t in_info_type,
495 uint8_t in_file_info_class,
496 uint32_t in_max_output_length,
497 const DATA_BLOB *in_input_buffer,
498 uint32_t in_additional_info,
500 uint64_t in_fid_persistent,
501 uint64_t in_fid_volatile);
502 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
504 DATA_BLOB *out_output_buffer);
505 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
506 uint32_t timeout_msec,
507 struct smbXcli_session *session,
508 struct smbXcli_tcon *tcon,
509 uint8_t in_info_type,
510 uint8_t in_file_info_class,
511 uint32_t in_max_output_length,
512 const DATA_BLOB *in_input_buffer,
513 uint32_t in_additional_info,
515 uint64_t in_fid_persistent,
516 uint64_t in_fid_volatile,
518 DATA_BLOB *out_output_buffer);
520 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
521 struct tevent_context *ev,
522 struct smbXcli_conn *conn,
523 uint32_t timeout_msec,
524 struct smbXcli_session *session,
525 struct smbXcli_tcon *tcon,
529 uint64_t fid_persistent,
530 uint64_t fid_volatile,
532 uint32_t outbuf_len);
533 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
536 uint32_t *data_length);
537 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
538 uint32_t timeout_msec,
539 struct smbXcli_session *session,
540 struct smbXcli_tcon *tcon,
544 uint64_t fid_persistent,
545 uint64_t fid_volatile,
550 uint32_t *data_length);
552 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
553 struct tevent_context *ev,
554 struct smbXcli_conn *conn,
555 uint32_t timeout_msec,
556 struct smbXcli_session *session,
557 struct smbXcli_tcon *tcon,
558 uint64_t in_fid_persistent,
559 uint64_t in_fid_volatile,
560 uint32_t in_ctl_code,
561 uint32_t in_max_input_length,
562 const DATA_BLOB *in_input_buffer,
563 uint32_t in_max_output_length,
564 const DATA_BLOB *in_output_buffer,
566 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
568 DATA_BLOB *out_input_buffer,
569 DATA_BLOB *out_output_buffer);
570 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
571 uint32_t timeout_msec,
572 struct smbXcli_session *session,
573 struct smbXcli_tcon *tcon,
574 uint64_t in_fid_persistent,
575 uint64_t in_fid_volatile,
576 uint32_t in_ctl_code,
577 uint32_t in_max_input_length,
578 const DATA_BLOB *in_input_buffer,
579 uint32_t in_max_output_length,
580 const DATA_BLOB *in_output_buffer,
583 DATA_BLOB *out_input_buffer,
584 DATA_BLOB *out_output_buffer);
586 struct tevent_req *smb2cli_echo_send(TALLOC_CTX *mem_ctx,
587 struct tevent_context *ev,
588 struct smbXcli_conn *conn,
589 uint32_t timeout_msec);
590 NTSTATUS smb2cli_echo_recv(struct tevent_req *req);
591 NTSTATUS smb2cli_echo(struct smbXcli_conn *conn,
592 uint32_t timeout_msec);
594 #endif /* _SMBXCLI_BASE_H_ */