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;
31 struct smb2_create_returns;
33 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
35 const char *remote_name,
36 enum smb_signing_setting signing_state,
37 uint32_t smb1_capabilities,
38 struct GUID *client_guid,
39 uint32_t smb2_capabilities);
41 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
42 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
44 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
46 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
47 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
49 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
50 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
51 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
52 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
54 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
55 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
56 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
57 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
59 struct tevent_req *smbXcli_conn_samba_suicide_send(TALLOC_CTX *mem_ctx,
60 struct tevent_context *ev,
61 struct smbXcli_conn *conn,
63 NTSTATUS smbXcli_conn_samba_suicide_recv(struct tevent_req *req);
64 NTSTATUS smbXcli_conn_samba_suicide(struct smbXcli_conn *conn,
67 void smbXcli_req_unset_pending(struct tevent_req *req);
68 bool smbXcli_req_set_pending(struct tevent_req *req);
70 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
71 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
72 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
73 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
74 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
75 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
76 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
77 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
78 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
79 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
81 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
82 const DATA_BLOB user_session_key,
83 const DATA_BLOB response);
84 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
85 const uint8_t *buf, uint32_t seqnum);
86 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
88 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
89 struct smb_trans_enc_state *es);
90 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
92 bool smb1cli_is_andx_req(uint8_t cmd);
93 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
95 uint16_t smb1cli_req_mid(struct tevent_req *req);
96 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
98 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
99 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
101 struct smb1cli_req_expected_response {
106 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
107 struct tevent_context *ev,
108 struct smbXcli_conn *conn,
110 uint8_t additional_flags,
112 uint16_t additional_flags2,
113 uint16_t clear_flags2,
114 uint32_t timeout_msec,
116 struct smbXcli_tcon *tcon,
117 struct smbXcli_session *session,
118 uint8_t wct, uint16_t *vwv,
120 struct iovec *bytes_iov);
121 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
123 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
124 struct tevent_context *ev,
125 struct smbXcli_conn *conn,
127 uint8_t additional_flags,
129 uint16_t additional_flags2,
130 uint16_t clear_flags2,
131 uint32_t timeout_msec,
133 struct smbXcli_tcon *tcon,
134 struct smbXcli_session *session,
135 uint8_t wct, uint16_t *vwv,
137 const uint8_t *bytes);
138 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
144 uint32_t *pvwv_offset,
145 uint32_t *pnum_bytes,
147 uint32_t *pbytes_offset,
149 const struct smb1cli_req_expected_response *expected,
150 size_t num_expected);
152 struct tevent_req *smb1cli_trans_send(
153 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
154 struct smbXcli_conn *conn, uint8_t cmd,
155 uint8_t additional_flags, uint8_t clear_flags,
156 uint16_t additional_flags2, uint16_t clear_flags2,
157 uint32_t timeout_msec,
159 struct smbXcli_tcon *tcon,
160 struct smbXcli_session *session,
161 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
162 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
163 uint8_t *param, uint32_t num_param, uint32_t max_param,
164 uint8_t *data, uint32_t num_data, uint32_t max_data);
165 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
166 uint16_t *recv_flags2,
167 uint16_t **setup, uint8_t min_setup,
169 uint8_t **param, uint32_t min_param,
171 uint8_t **data, uint32_t min_data,
173 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
175 uint8_t additional_flags, uint8_t clear_flags,
176 uint16_t additional_flags2, uint16_t clear_flags2,
177 uint32_t timeout_msec,
179 struct smbXcli_tcon *tcon,
180 struct smbXcli_session *session,
181 const char *pipe_name, uint16_t fid, uint16_t function,
183 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
184 uint8_t *param, uint32_t num_param, uint32_t max_param,
185 uint8_t *data, uint32_t num_data, uint32_t max_data,
186 uint16_t *recv_flags2,
187 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
188 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
189 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
191 struct tevent_req *smb1cli_echo_send(TALLOC_CTX *mem_ctx,
192 struct tevent_context *ev,
193 struct smbXcli_conn *conn,
194 uint32_t timeout_msec,
197 NTSTATUS smb1cli_echo_recv(struct tevent_req *req);
198 NTSTATUS smb1cli_echo(struct smbXcli_conn *conn, uint32_t timeout_msec,
199 uint16_t num_echos, DATA_BLOB data);
201 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
202 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
203 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
204 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
205 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
206 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
207 uint16_t max_credits);
209 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
210 struct tevent_context *ev,
211 struct smbXcli_conn *conn,
213 uint32_t additional_flags,
214 uint32_t clear_flags,
215 uint32_t timeout_msec,
216 struct smbXcli_tcon *tcon,
217 struct smbXcli_session *session,
218 const uint8_t *fixed,
222 void smb2cli_req_set_notify_async(struct tevent_req *req);
223 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
225 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
227 struct smb2cli_req_expected_response {
232 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
233 struct tevent_context *ev,
234 struct smbXcli_conn *conn,
236 uint32_t additional_flags,
237 uint32_t clear_flags,
238 uint32_t timeout_msec,
239 struct smbXcli_tcon *tcon,
240 struct smbXcli_session *session,
241 const uint8_t *fixed,
245 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
247 const struct smb2cli_req_expected_response *expected,
248 size_t num_expected);
250 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
251 struct tevent_context *ev,
252 struct smbXcli_conn *conn,
253 uint32_t timeout_msec,
254 enum protocol_types min_protocol,
255 enum protocol_types max_protocol);
256 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
257 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
258 uint32_t timeout_msec,
259 enum protocol_types min_protocol,
260 enum protocol_types max_protocol);
262 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
263 struct smbXcli_conn *conn);
264 struct smbXcli_session *smbXcli_session_copy(TALLOC_CTX *mem_ctx,
265 struct smbXcli_session *src);
266 NTSTATUS smbXcli_session_application_key(struct smbXcli_session *session,
269 void smbXcli_session_set_disconnect_expired(struct smbXcli_session *session);
270 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
271 void smb1cli_session_set_id(struct smbXcli_session* session,
272 uint16_t session_id);
273 NTSTATUS smb1cli_session_set_session_key(struct smbXcli_session *session,
274 const DATA_BLOB _session_key);
275 NTSTATUS smb1cli_session_protect_session_key(struct smbXcli_session *session);
276 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
277 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
278 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
279 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
281 uint16_t session_flags);
282 void smb2cli_session_increment_channel_sequence(struct smbXcli_session *session);
283 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
284 const DATA_BLOB session_key,
285 const struct iovec *recv_iov);
286 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
287 struct smbXcli_session *session1,
288 struct smbXcli_conn *conn,
289 struct smbXcli_session **_session2);
290 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
291 const DATA_BLOB channel_key,
292 const struct iovec *recv_iov);
294 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
295 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
296 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
297 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
299 uint16_t optional_support,
300 uint32_t maximal_access,
301 uint32_t guest_maximal_access,
303 const char *fs_type);
304 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
305 uint32_t smb2cli_tcon_capabilities(struct smbXcli_tcon *tcon);
306 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
307 struct smbXcli_session *session,
311 uint32_t capabilities,
312 uint32_t maximal_access);
314 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
315 struct tevent_context *ev,
316 struct smbXcli_conn *conn,
317 uint32_t timeout_msec,
318 struct smbXcli_session *session,
320 uint32_t in_capabilities,
322 uint64_t in_previous_session_id,
323 const DATA_BLOB *in_security_buffer);
324 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
326 struct iovec **recv_iov,
327 DATA_BLOB *out_security_buffer);
329 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
330 struct tevent_context *ev,
331 struct smbXcli_conn *conn,
332 uint32_t timeout_msec,
333 struct smbXcli_session *session);
334 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
335 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
336 uint32_t timeout_msec,
337 struct smbXcli_session *session);
339 struct tevent_req *smb2cli_create_send(
341 struct tevent_context *ev,
342 struct smbXcli_conn *conn,
343 uint32_t timeout_msec,
344 struct smbXcli_session *session,
345 struct smbXcli_tcon *tcon,
346 const char *filename,
347 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
348 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
349 uint32_t desired_access,
350 uint32_t file_attributes,
351 uint32_t share_access,
352 uint32_t create_disposition,
353 uint32_t create_options,
354 struct smb2_create_blobs *blobs);
355 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
356 uint64_t *fid_persistent,
357 uint64_t *fid_volatile,
358 struct smb2_create_returns *cr);
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,
374 struct smb2_create_returns *cr);
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,
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,
450 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
451 struct tevent_context *ev,
452 struct smbXcli_conn *conn,
453 uint32_t timeout_msec,
454 struct smbXcli_session *session,
455 struct smbXcli_tcon *tcon,
456 uint64_t fid_persistent,
457 uint64_t fid_volatile);
458 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
459 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
460 uint32_t timeout_msec,
461 struct smbXcli_session *session,
462 struct smbXcli_tcon *tcon,
463 uint64_t fid_persistent,
464 uint64_t fid_volatile);
466 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
467 struct tevent_context *ev,
468 struct smbXcli_conn *conn,
469 uint32_t timeout_msec,
470 struct smbXcli_session *session,
471 struct smbXcli_tcon *tcon,
472 uint8_t in_info_type,
473 uint8_t in_file_info_class,
474 const DATA_BLOB *in_input_buffer,
475 uint32_t in_additional_info,
476 uint64_t in_fid_persistent,
477 uint64_t in_fid_volatile);
478 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
479 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
480 uint32_t timeout_msec,
481 struct smbXcli_session *session,
482 struct smbXcli_tcon *tcon,
483 uint8_t in_info_type,
484 uint8_t in_file_info_class,
485 const DATA_BLOB *in_input_buffer,
486 uint32_t in_additional_info,
487 uint64_t in_fid_persistent,
488 uint64_t in_fid_volatile);
490 struct tevent_req *smb2cli_query_info_send(TALLOC_CTX *mem_ctx,
491 struct tevent_context *ev,
492 struct smbXcli_conn *conn,
493 uint32_t timeout_msec,
494 struct smbXcli_session *session,
495 struct smbXcli_tcon *tcon,
496 uint8_t in_info_type,
497 uint8_t in_file_info_class,
498 uint32_t in_max_output_length,
499 const DATA_BLOB *in_input_buffer,
500 uint32_t in_additional_info,
502 uint64_t in_fid_persistent,
503 uint64_t in_fid_volatile);
504 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
506 DATA_BLOB *out_output_buffer);
507 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
508 uint32_t timeout_msec,
509 struct smbXcli_session *session,
510 struct smbXcli_tcon *tcon,
511 uint8_t in_info_type,
512 uint8_t in_file_info_class,
513 uint32_t in_max_output_length,
514 const DATA_BLOB *in_input_buffer,
515 uint32_t in_additional_info,
517 uint64_t in_fid_persistent,
518 uint64_t in_fid_volatile,
520 DATA_BLOB *out_output_buffer);
522 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
523 struct tevent_context *ev,
524 struct smbXcli_conn *conn,
525 uint32_t timeout_msec,
526 struct smbXcli_session *session,
527 struct smbXcli_tcon *tcon,
531 uint64_t fid_persistent,
532 uint64_t fid_volatile,
534 uint32_t outbuf_len);
535 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
538 uint32_t *data_length);
539 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
540 uint32_t timeout_msec,
541 struct smbXcli_session *session,
542 struct smbXcli_tcon *tcon,
546 uint64_t fid_persistent,
547 uint64_t fid_volatile,
552 uint32_t *data_length);
554 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
555 struct tevent_context *ev,
556 struct smbXcli_conn *conn,
557 uint32_t timeout_msec,
558 struct smbXcli_session *session,
559 struct smbXcli_tcon *tcon,
560 uint64_t in_fid_persistent,
561 uint64_t in_fid_volatile,
562 uint32_t in_ctl_code,
563 uint32_t in_max_input_length,
564 const DATA_BLOB *in_input_buffer,
565 uint32_t in_max_output_length,
566 const DATA_BLOB *in_output_buffer,
568 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
570 DATA_BLOB *out_input_buffer,
571 DATA_BLOB *out_output_buffer);
572 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
573 uint32_t timeout_msec,
574 struct smbXcli_session *session,
575 struct smbXcli_tcon *tcon,
576 uint64_t in_fid_persistent,
577 uint64_t in_fid_volatile,
578 uint32_t in_ctl_code,
579 uint32_t in_max_input_length,
580 const DATA_BLOB *in_input_buffer,
581 uint32_t in_max_output_length,
582 const DATA_BLOB *in_output_buffer,
585 DATA_BLOB *out_input_buffer,
586 DATA_BLOB *out_output_buffer);
588 struct tevent_req *smb2cli_echo_send(TALLOC_CTX *mem_ctx,
589 struct tevent_context *ev,
590 struct smbXcli_conn *conn,
591 uint32_t timeout_msec);
592 NTSTATUS smb2cli_echo_recv(struct tevent_req *req);
593 NTSTATUS smb2cli_echo(struct smbXcli_conn *conn,
594 uint32_t timeout_msec);
596 #endif /* _SMBXCLI_BASE_H_ */