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
,
205 struct smbXcli_session
*session
,
206 const uint8_t *fixed
,
210 void smb2cli_req_set_notify_async(struct tevent_req
*req
);
211 NTSTATUS
smb2cli_req_compound_submit(struct tevent_req
**reqs
,
213 void smb2cli_req_set_credit_charge(struct tevent_req
*req
, uint16_t charge
);
215 struct smb2cli_req_expected_response
{
220 struct tevent_req
*smb2cli_req_send(TALLOC_CTX
*mem_ctx
,
221 struct tevent_context
*ev
,
222 struct smbXcli_conn
*conn
,
224 uint32_t additional_flags
,
225 uint32_t clear_flags
,
226 uint32_t timeout_msec
,
229 struct smbXcli_session
*session
,
230 const uint8_t *fixed
,
234 NTSTATUS
smb2cli_req_recv(struct tevent_req
*req
, TALLOC_CTX
*mem_ctx
,
236 const struct smb2cli_req_expected_response
*expected
,
237 size_t num_expected
);
239 struct tevent_req
*smbXcli_negprot_send(TALLOC_CTX
*mem_ctx
,
240 struct tevent_context
*ev
,
241 struct smbXcli_conn
*conn
,
242 uint32_t timeout_msec
,
243 enum protocol_types min_protocol
,
244 enum protocol_types max_protocol
);
245 NTSTATUS
smbXcli_negprot_recv(struct tevent_req
*req
);
246 NTSTATUS
smbXcli_negprot(struct smbXcli_conn
*conn
,
247 uint32_t timeout_msec
,
248 enum protocol_types min_protocol
,
249 enum protocol_types max_protocol
);
251 struct smbXcli_session
*smbXcli_session_create(TALLOC_CTX
*mem_ctx
,
252 struct smbXcli_conn
*conn
);
253 uint16_t smb1cli_session_current_id(struct smbXcli_session
* session
);
254 void smb1cli_session_set_id(struct smbXcli_session
* session
,
255 uint16_t session_id
);
256 uint8_t smb2cli_session_security_mode(struct smbXcli_session
*session
);
257 uint64_t smb2cli_session_current_id(struct smbXcli_session
*session
);
258 uint16_t smb2cli_session_get_flags(struct smbXcli_session
*session
);
259 NTSTATUS
smb2cli_session_application_key(struct smbXcli_session
*session
,
262 void smb2cli_session_set_id_and_flags(struct smbXcli_session
*session
,
264 uint16_t session_flags
);
265 NTSTATUS
smb2cli_session_set_session_key(struct smbXcli_session
*session
,
266 const DATA_BLOB session_key
,
267 const struct iovec
*recv_iov
);
268 NTSTATUS
smb2cli_session_create_channel(TALLOC_CTX
*mem_ctx
,
269 struct smbXcli_session
*session1
,
270 struct smbXcli_conn
*conn
,
271 struct smbXcli_session
**_session2
);
272 NTSTATUS
smb2cli_session_set_channel_key(struct smbXcli_session
*session
,
273 const DATA_BLOB channel_key
,
274 const struct iovec
*recv_iov
);
276 struct smbXcli_tcon
*smbXcli_tcon_create(TALLOC_CTX
*mem_ctx
);
277 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon
*tcon
);
278 void smb1cli_tcon_set_id(struct smbXcli_tcon
*tcon
, uint16_t tcon_id
);
279 bool smb1cli_tcon_set_values(struct smbXcli_tcon
*tcon
,
281 uint16_t optional_support
,
282 uint32_t maximal_access
,
283 uint32_t guest_maximal_access
,
285 const char *fs_type
);
286 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon
*tcon
);
287 void smb2cli_tcon_set_values(struct smbXcli_tcon
*tcon
,
291 uint32_t capabilities
,
292 uint32_t maximal_access
);
294 struct tevent_req
*smb2cli_session_setup_send(TALLOC_CTX
*mem_ctx
,
295 struct tevent_context
*ev
,
296 struct smbXcli_conn
*conn
,
297 uint32_t timeout_msec
,
298 struct smbXcli_session
*session
,
300 uint32_t in_capabilities
,
302 uint64_t in_previous_session_id
,
303 const DATA_BLOB
*in_security_buffer
);
304 NTSTATUS
smb2cli_session_setup_recv(struct tevent_req
*req
,
306 struct iovec
**recv_iov
,
307 DATA_BLOB
*out_security_buffer
);
309 struct tevent_req
*smb2cli_logoff_send(TALLOC_CTX
*mem_ctx
,
310 struct tevent_context
*ev
,
311 struct smbXcli_conn
*conn
,
312 uint32_t timeout_msec
,
313 struct smbXcli_session
*session
);
314 NTSTATUS
smb2cli_logoff_recv(struct tevent_req
*req
);
315 NTSTATUS
smb2cli_logoff(struct smbXcli_conn
*conn
,
316 uint32_t timeout_msec
,
317 struct smbXcli_session
*session
);
319 struct tevent_req
*smb2cli_create_send(
321 struct tevent_context
*ev
,
322 struct smbXcli_conn
*conn
,
323 uint32_t timeout_msec
,
324 struct smbXcli_session
*session
,
325 struct smbXcli_tcon
*tcon
,
326 const char *filename
,
327 uint8_t oplock_level
, /* SMB2_OPLOCK_LEVEL_* */
328 uint32_t impersonation_level
, /* SMB2_IMPERSONATION_* */
329 uint32_t desired_access
,
330 uint32_t file_attributes
,
331 uint32_t share_access
,
332 uint32_t create_disposition
,
333 uint32_t create_options
,
334 struct smb2_create_blobs
*blobs
);
335 NTSTATUS
smb2cli_create_recv(struct tevent_req
*req
,
336 uint64_t *fid_persistent
,
337 uint64_t *fid_volatile
);
338 NTSTATUS
smb2cli_create(struct smbXcli_conn
*conn
,
339 uint32_t timeout_msec
,
340 struct smbXcli_session
*session
,
341 struct smbXcli_tcon
*tcon
,
342 const char *filename
,
343 uint8_t oplock_level
, /* SMB2_OPLOCK_LEVEL_* */
344 uint32_t impersonation_level
, /* SMB2_IMPERSONATION_* */
345 uint32_t desired_access
,
346 uint32_t file_attributes
,
347 uint32_t share_access
,
348 uint32_t create_disposition
,
349 uint32_t create_options
,
350 struct smb2_create_blobs
*blobs
,
351 uint64_t *fid_persistent
,
352 uint64_t *fid_volatile
);
354 struct tevent_req
*smb2cli_close_send(TALLOC_CTX
*mem_ctx
,
355 struct tevent_context
*ev
,
356 struct smbXcli_conn
*conn
,
357 uint32_t timeout_msec
,
358 struct smbXcli_session
*session
,
361 uint64_t fid_persistent
,
362 uint64_t fid_volatile
);
363 NTSTATUS
smb2cli_close_recv(struct tevent_req
*req
);
364 NTSTATUS
smb2cli_close(struct smbXcli_conn
*conn
,
365 uint32_t timeout_msec
,
366 struct smbXcli_session
*session
,
369 uint64_t fid_persistent
,
370 uint64_t fid_volatile
);
372 struct tevent_req
*smb2cli_read_send(TALLOC_CTX
*mem_ctx
,
373 struct tevent_context
*ev
,
374 struct smbXcli_conn
*conn
,
375 uint32_t timeout_msec
,
376 struct smbXcli_session
*session
,
380 uint64_t fid_persistent
,
381 uint64_t fid_volatile
,
382 uint64_t minimum_count
,
383 uint64_t remaining_bytes
);
384 NTSTATUS
smb2cli_read_recv(struct tevent_req
*req
, TALLOC_CTX
*mem_ctx
,
385 uint8_t **data
, uint32_t *data_length
);
386 NTSTATUS
smb2cli_read(struct smbXcli_conn
*conn
,
387 uint32_t timeout_msec
,
388 struct smbXcli_session
*session
,
392 uint64_t fid_persistent
,
393 uint64_t fid_volatile
,
394 uint64_t minimum_count
,
395 uint64_t remaining_bytes
,
398 uint32_t *data_length
);
400 struct tevent_req
*smb2cli_write_send(TALLOC_CTX
*mem_ctx
,
401 struct tevent_context
*ev
,
402 struct smbXcli_conn
*conn
,
403 uint32_t timeout_msec
,
404 struct smbXcli_session
*session
,
408 uint64_t fid_persistent
,
409 uint64_t fid_volatile
,
410 uint32_t remaining_bytes
,
412 const uint8_t *data
);
413 NTSTATUS
smb2cli_write_recv(struct tevent_req
*req
);
414 NTSTATUS
smb2cli_write(struct smbXcli_conn
*conn
,
415 uint32_t timeout_msec
,
416 struct smbXcli_session
*session
,
420 uint64_t fid_persistent
,
421 uint64_t fid_volatile
,
422 uint32_t remaining_bytes
,
424 const uint8_t *data
);
426 struct tevent_req
*smb2cli_flush_send(TALLOC_CTX
*mem_ctx
,
427 struct tevent_context
*ev
,
428 struct smbXcli_conn
*conn
,
429 uint32_t timeout_msec
,
430 struct smbXcli_session
*session
,
432 uint64_t fid_persistent
,
433 uint64_t fid_volatile
);
434 NTSTATUS
smb2cli_flush_recv(struct tevent_req
*req
);
435 NTSTATUS
smb2cli_flush(struct smbXcli_conn
*conn
,
436 uint32_t timeout_msec
,
437 struct smbXcli_session
*session
,
439 uint64_t fid_persistent
,
440 uint64_t fid_volatile
);
442 struct tevent_req
*smb2cli_set_info_send(TALLOC_CTX
*mem_ctx
,
443 struct tevent_context
*ev
,
444 struct smbXcli_conn
*conn
,
445 uint32_t timeout_msec
,
446 struct smbXcli_session
*session
,
448 uint8_t in_info_type
,
449 uint8_t in_file_info_class
,
450 const DATA_BLOB
*in_input_buffer
,
451 uint32_t in_additional_info
,
452 uint64_t in_fid_persistent
,
453 uint64_t in_fid_volatile
);
454 NTSTATUS
smb2cli_set_info_recv(struct tevent_req
*req
);
455 NTSTATUS
smb2cli_set_info(struct smbXcli_conn
*conn
,
456 uint32_t timeout_msec
,
457 struct smbXcli_session
*session
,
459 uint8_t in_info_type
,
460 uint8_t in_file_info_class
,
461 const DATA_BLOB
*in_input_buffer
,
462 uint32_t in_additional_info
,
463 uint64_t in_fid_persistent
,
464 uint64_t in_fid_volatile
);
466 struct tevent_req
*smb2cli_query_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
,
472 uint8_t in_info_type
,
473 uint8_t in_file_info_class
,
474 uint32_t in_max_output_length
,
475 const DATA_BLOB
*in_input_buffer
,
476 uint32_t in_additional_info
,
478 uint64_t in_fid_persistent
,
479 uint64_t in_fid_volatile
);
480 NTSTATUS
smb2cli_query_info_recv(struct tevent_req
*req
,
482 DATA_BLOB
*out_output_buffer
);
483 NTSTATUS
smb2cli_query_info(struct smbXcli_conn
*conn
,
484 uint32_t timeout_msec
,
485 struct smbXcli_session
*session
,
487 uint8_t in_info_type
,
488 uint8_t in_file_info_class
,
489 uint32_t in_max_output_length
,
490 const DATA_BLOB
*in_input_buffer
,
491 uint32_t in_additional_info
,
493 uint64_t in_fid_persistent
,
494 uint64_t in_fid_volatile
,
496 DATA_BLOB
*out_output_buffer
);
498 struct tevent_req
*smb2cli_query_directory_send(TALLOC_CTX
*mem_ctx
,
499 struct tevent_context
*ev
,
500 struct smbXcli_conn
*conn
,
501 uint32_t timeout_msec
,
502 struct smbXcli_session
*session
,
507 uint64_t fid_persistent
,
508 uint64_t fid_volatile
,
510 uint32_t outbuf_len
);
511 NTSTATUS
smb2cli_query_directory_recv(struct tevent_req
*req
,
514 uint32_t *data_length
);
515 NTSTATUS
smb2cli_query_directory(struct smbXcli_conn
*conn
,
516 uint32_t timeout_msec
,
517 struct smbXcli_session
*session
,
522 uint64_t fid_persistent
,
523 uint64_t fid_volatile
,
528 uint32_t *data_length
);
530 struct tevent_req
*smb2cli_ioctl_send(TALLOC_CTX
*mem_ctx
,
531 struct tevent_context
*ev
,
532 struct smbXcli_conn
*conn
,
533 uint32_t timeout_msec
,
534 struct smbXcli_session
*session
,
536 uint64_t in_fid_persistent
,
537 uint64_t in_fid_volatile
,
538 uint32_t in_ctl_code
,
539 uint32_t in_max_input_length
,
540 const DATA_BLOB
*in_input_buffer
,
541 uint32_t in_max_output_length
,
542 const DATA_BLOB
*in_output_buffer
,
544 NTSTATUS
smb2cli_ioctl_recv(struct tevent_req
*req
,
546 DATA_BLOB
*out_input_buffer
,
547 DATA_BLOB
*out_output_buffer
);
548 NTSTATUS
smb2cli_ioctl(struct smbXcli_conn
*conn
,
549 uint32_t timeout_msec
,
550 struct smbXcli_session
*session
,
552 uint64_t in_fid_persistent
,
553 uint64_t in_fid_volatile
,
554 uint32_t in_ctl_code
,
555 uint32_t in_max_input_length
,
556 const DATA_BLOB
*in_input_buffer
,
557 uint32_t in_max_output_length
,
558 const DATA_BLOB
*in_output_buffer
,
561 DATA_BLOB
*out_input_buffer
,
562 DATA_BLOB
*out_output_buffer
);
564 #endif /* _SMBXCLI_BASE_H_ */