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 smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
32 const char *remote_name,
33 enum smb_signing_setting signing_state,
34 uint32_t smb1_capabilities,
35 struct GUID *client_guid,
36 uint32_t smb2_capabilities);
38 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
39 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
41 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
43 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
44 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
46 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
47 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
48 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
49 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
51 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
52 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
53 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
54 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
56 struct tevent_req *smbXcli_conn_samba_suicide_send(TALLOC_CTX *mem_ctx,
57 struct tevent_context *ev,
58 struct smbXcli_conn *conn,
60 NTSTATUS smbXcli_conn_samba_suicide_recv(struct tevent_req *req);
61 NTSTATUS smbXcli_conn_samba_suicide(struct smbXcli_conn *conn,
64 void smbXcli_req_unset_pending(struct tevent_req *req);
65 bool smbXcli_req_set_pending(struct tevent_req *req);
67 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
68 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
69 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
70 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
71 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
72 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
73 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
74 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
75 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
76 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
78 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
79 const DATA_BLOB user_session_key,
80 const DATA_BLOB response);
81 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
82 const uint8_t *buf, uint32_t seqnum);
83 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
85 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
86 struct smb_trans_enc_state *es);
87 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
89 bool smb1cli_is_andx_req(uint8_t cmd);
90 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
92 uint16_t smb1cli_req_mid(struct tevent_req *req);
93 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
95 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
96 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
98 struct smb1cli_req_expected_response {
103 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
104 struct tevent_context *ev,
105 struct smbXcli_conn *conn,
107 uint8_t additional_flags,
109 uint16_t additional_flags2,
110 uint16_t clear_flags2,
111 uint32_t timeout_msec,
113 struct smbXcli_tcon *tcon,
114 struct smbXcli_session *session,
115 uint8_t wct, uint16_t *vwv,
117 struct iovec *bytes_iov);
118 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
120 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
121 struct tevent_context *ev,
122 struct smbXcli_conn *conn,
124 uint8_t additional_flags,
126 uint16_t additional_flags2,
127 uint16_t clear_flags2,
128 uint32_t timeout_msec,
130 struct smbXcli_tcon *tcon,
131 struct smbXcli_session *session,
132 uint8_t wct, uint16_t *vwv,
134 const uint8_t *bytes);
135 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
141 uint32_t *pvwv_offset,
142 uint32_t *pnum_bytes,
144 uint32_t *pbytes_offset,
146 const struct smb1cli_req_expected_response *expected,
147 size_t num_expected);
149 struct tevent_req *smb1cli_trans_send(
150 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
151 struct smbXcli_conn *conn, uint8_t cmd,
152 uint8_t additional_flags, uint8_t clear_flags,
153 uint16_t additional_flags2, uint16_t clear_flags2,
154 uint32_t timeout_msec,
156 struct smbXcli_tcon *tcon,
157 struct smbXcli_session *session,
158 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
159 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
160 uint8_t *param, uint32_t num_param, uint32_t max_param,
161 uint8_t *data, uint32_t num_data, uint32_t max_data);
162 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
163 uint16_t *recv_flags2,
164 uint16_t **setup, uint8_t min_setup,
166 uint8_t **param, uint32_t min_param,
168 uint8_t **data, uint32_t min_data,
170 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
172 uint8_t additional_flags, uint8_t clear_flags,
173 uint16_t additional_flags2, uint16_t clear_flags2,
174 uint32_t timeout_msec,
176 struct smbXcli_tcon *tcon,
177 struct smbXcli_session *session,
178 const char *pipe_name, uint16_t fid, uint16_t function,
180 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
181 uint8_t *param, uint32_t num_param, uint32_t max_param,
182 uint8_t *data, uint32_t num_data, uint32_t max_data,
183 uint16_t *recv_flags2,
184 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
185 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
186 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
188 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
189 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
190 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
191 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
192 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
193 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
194 uint16_t max_credits);
196 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
197 struct tevent_context *ev,
198 struct smbXcli_conn *conn,
200 uint32_t additional_flags,
201 uint32_t clear_flags,
202 uint32_t timeout_msec,
203 struct smbXcli_tcon *tcon,
204 struct smbXcli_session *session,
205 const uint8_t *fixed,
209 void smb2cli_req_set_notify_async(struct tevent_req *req);
210 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
212 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
214 struct smb2cli_req_expected_response {
219 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
220 struct tevent_context *ev,
221 struct smbXcli_conn *conn,
223 uint32_t additional_flags,
224 uint32_t clear_flags,
225 uint32_t timeout_msec,
226 struct smbXcli_tcon *tcon,
227 struct smbXcli_session *session,
228 const uint8_t *fixed,
232 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
234 const struct smb2cli_req_expected_response *expected,
235 size_t num_expected);
237 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
238 struct tevent_context *ev,
239 struct smbXcli_conn *conn,
240 uint32_t timeout_msec,
241 enum protocol_types min_protocol,
242 enum protocol_types max_protocol);
243 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
244 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
245 uint32_t timeout_msec,
246 enum protocol_types min_protocol,
247 enum protocol_types max_protocol);
249 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
250 struct smbXcli_conn *conn);
251 NTSTATUS smbXcli_session_application_key(struct smbXcli_session *session,
254 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
255 void smb1cli_session_set_id(struct smbXcli_session* session,
256 uint16_t session_id);
257 NTSTATUS smb1cli_session_set_session_key(struct smbXcli_session *session,
258 const DATA_BLOB _session_key);
259 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
260 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
261 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
262 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
264 uint16_t session_flags);
265 void smb2cli_session_increment_channel_sequence(struct smbXcli_session *session);
266 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
267 const DATA_BLOB session_key,
268 const struct iovec *recv_iov);
269 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
270 struct smbXcli_session *session1,
271 struct smbXcli_conn *conn,
272 struct smbXcli_session **_session2);
273 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
274 const DATA_BLOB channel_key,
275 const struct iovec *recv_iov);
277 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
278 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
279 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
280 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
282 uint16_t optional_support,
283 uint32_t maximal_access,
284 uint32_t guest_maximal_access,
286 const char *fs_type);
287 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
288 uint32_t smb2cli_tcon_capabilities(struct smbXcli_tcon *tcon);
289 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
290 struct smbXcli_session *session,
294 uint32_t capabilities,
295 uint32_t maximal_access);
297 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
298 struct tevent_context *ev,
299 struct smbXcli_conn *conn,
300 uint32_t timeout_msec,
301 struct smbXcli_session *session,
303 uint32_t in_capabilities,
305 uint64_t in_previous_session_id,
306 const DATA_BLOB *in_security_buffer);
307 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
309 struct iovec **recv_iov,
310 DATA_BLOB *out_security_buffer);
312 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
313 struct tevent_context *ev,
314 struct smbXcli_conn *conn,
315 uint32_t timeout_msec,
316 struct smbXcli_session *session);
317 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
318 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
319 uint32_t timeout_msec,
320 struct smbXcli_session *session);
322 struct tevent_req *smb2cli_create_send(
324 struct tevent_context *ev,
325 struct smbXcli_conn *conn,
326 uint32_t timeout_msec,
327 struct smbXcli_session *session,
328 struct smbXcli_tcon *tcon,
329 const char *filename,
330 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
331 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
332 uint32_t desired_access,
333 uint32_t file_attributes,
334 uint32_t share_access,
335 uint32_t create_disposition,
336 uint32_t create_options,
337 struct smb2_create_blobs *blobs);
338 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
339 uint64_t *fid_persistent,
340 uint64_t *fid_volatile);
341 NTSTATUS smb2cli_create(struct smbXcli_conn *conn,
342 uint32_t timeout_msec,
343 struct smbXcli_session *session,
344 struct smbXcli_tcon *tcon,
345 const char *filename,
346 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
347 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
348 uint32_t desired_access,
349 uint32_t file_attributes,
350 uint32_t share_access,
351 uint32_t create_disposition,
352 uint32_t create_options,
353 struct smb2_create_blobs *blobs,
354 uint64_t *fid_persistent,
355 uint64_t *fid_volatile);
357 struct tevent_req *smb2cli_close_send(TALLOC_CTX *mem_ctx,
358 struct tevent_context *ev,
359 struct smbXcli_conn *conn,
360 uint32_t timeout_msec,
361 struct smbXcli_session *session,
362 struct smbXcli_tcon *tcon,
364 uint64_t fid_persistent,
365 uint64_t fid_volatile);
366 NTSTATUS smb2cli_close_recv(struct tevent_req *req);
367 NTSTATUS smb2cli_close(struct smbXcli_conn *conn,
368 uint32_t timeout_msec,
369 struct smbXcli_session *session,
370 struct smbXcli_tcon *tcon,
372 uint64_t fid_persistent,
373 uint64_t fid_volatile);
375 struct tevent_req *smb2cli_read_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,
383 uint64_t fid_persistent,
384 uint64_t fid_volatile,
385 uint64_t minimum_count,
386 uint64_t remaining_bytes);
387 NTSTATUS smb2cli_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
388 uint8_t **data, uint32_t *data_length);
389 NTSTATUS smb2cli_read(struct smbXcli_conn *conn,
390 uint32_t timeout_msec,
391 struct smbXcli_session *session,
392 struct smbXcli_tcon *tcon,
395 uint64_t fid_persistent,
396 uint64_t fid_volatile,
397 uint64_t minimum_count,
398 uint64_t remaining_bytes,
401 uint32_t *data_length);
403 struct tevent_req *smb2cli_write_send(TALLOC_CTX *mem_ctx,
404 struct tevent_context *ev,
405 struct smbXcli_conn *conn,
406 uint32_t timeout_msec,
407 struct smbXcli_session *session,
408 struct smbXcli_tcon *tcon,
411 uint64_t fid_persistent,
412 uint64_t fid_volatile,
413 uint32_t remaining_bytes,
415 const uint8_t *data);
416 NTSTATUS smb2cli_write_recv(struct tevent_req *req);
417 NTSTATUS smb2cli_write(struct smbXcli_conn *conn,
418 uint32_t timeout_msec,
419 struct smbXcli_session *session,
420 struct smbXcli_tcon *tcon,
423 uint64_t fid_persistent,
424 uint64_t fid_volatile,
425 uint32_t remaining_bytes,
427 const uint8_t *data);
429 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
430 struct tevent_context *ev,
431 struct smbXcli_conn *conn,
432 uint32_t timeout_msec,
433 struct smbXcli_session *session,
434 struct smbXcli_tcon *tcon,
435 uint64_t fid_persistent,
436 uint64_t fid_volatile);
437 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
438 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
439 uint32_t timeout_msec,
440 struct smbXcli_session *session,
441 struct smbXcli_tcon *tcon,
442 uint64_t fid_persistent,
443 uint64_t fid_volatile);
445 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
446 struct tevent_context *ev,
447 struct smbXcli_conn *conn,
448 uint32_t timeout_msec,
449 struct smbXcli_session *session,
450 struct smbXcli_tcon *tcon,
451 uint8_t in_info_type,
452 uint8_t in_file_info_class,
453 const DATA_BLOB *in_input_buffer,
454 uint32_t in_additional_info,
455 uint64_t in_fid_persistent,
456 uint64_t in_fid_volatile);
457 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
458 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
459 uint32_t timeout_msec,
460 struct smbXcli_session *session,
461 struct smbXcli_tcon *tcon,
462 uint8_t in_info_type,
463 uint8_t in_file_info_class,
464 const DATA_BLOB *in_input_buffer,
465 uint32_t in_additional_info,
466 uint64_t in_fid_persistent,
467 uint64_t in_fid_volatile);
469 struct tevent_req *smb2cli_query_info_send(TALLOC_CTX *mem_ctx,
470 struct tevent_context *ev,
471 struct smbXcli_conn *conn,
472 uint32_t timeout_msec,
473 struct smbXcli_session *session,
474 struct smbXcli_tcon *tcon,
475 uint8_t in_info_type,
476 uint8_t in_file_info_class,
477 uint32_t in_max_output_length,
478 const DATA_BLOB *in_input_buffer,
479 uint32_t in_additional_info,
481 uint64_t in_fid_persistent,
482 uint64_t in_fid_volatile);
483 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
485 DATA_BLOB *out_output_buffer);
486 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
487 uint32_t timeout_msec,
488 struct smbXcli_session *session,
489 struct smbXcli_tcon *tcon,
490 uint8_t in_info_type,
491 uint8_t in_file_info_class,
492 uint32_t in_max_output_length,
493 const DATA_BLOB *in_input_buffer,
494 uint32_t in_additional_info,
496 uint64_t in_fid_persistent,
497 uint64_t in_fid_volatile,
499 DATA_BLOB *out_output_buffer);
501 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
502 struct tevent_context *ev,
503 struct smbXcli_conn *conn,
504 uint32_t timeout_msec,
505 struct smbXcli_session *session,
506 struct smbXcli_tcon *tcon,
510 uint64_t fid_persistent,
511 uint64_t fid_volatile,
513 uint32_t outbuf_len);
514 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
517 uint32_t *data_length);
518 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
519 uint32_t timeout_msec,
520 struct smbXcli_session *session,
521 struct smbXcli_tcon *tcon,
525 uint64_t fid_persistent,
526 uint64_t fid_volatile,
531 uint32_t *data_length);
533 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
534 struct tevent_context *ev,
535 struct smbXcli_conn *conn,
536 uint32_t timeout_msec,
537 struct smbXcli_session *session,
538 struct smbXcli_tcon *tcon,
539 uint64_t in_fid_persistent,
540 uint64_t in_fid_volatile,
541 uint32_t in_ctl_code,
542 uint32_t in_max_input_length,
543 const DATA_BLOB *in_input_buffer,
544 uint32_t in_max_output_length,
545 const DATA_BLOB *in_output_buffer,
547 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
549 DATA_BLOB *out_input_buffer,
550 DATA_BLOB *out_output_buffer);
551 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
552 uint32_t timeout_msec,
553 struct smbXcli_session *session,
554 struct smbXcli_tcon *tcon,
555 uint64_t in_fid_persistent,
556 uint64_t in_fid_volatile,
557 uint32_t in_ctl_code,
558 uint32_t in_max_input_length,
559 const DATA_BLOB *in_input_buffer,
560 uint32_t in_max_output_length,
561 const DATA_BLOB *in_output_buffer,
564 DATA_BLOB *out_input_buffer,
565 DATA_BLOB *out_output_buffer);
567 #endif /* _SMBXCLI_BASE_H_ */