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,
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,
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,
155 uint32_t pid, uint16_t tid,
156 struct smbXcli_session *session,
157 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
158 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
159 uint8_t *param, uint32_t num_param, uint32_t max_param,
160 uint8_t *data, uint32_t num_data, uint32_t max_data);
161 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
162 uint16_t *recv_flags2,
163 uint16_t **setup, uint8_t min_setup,
165 uint8_t **param, uint32_t min_param,
167 uint8_t **data, uint32_t min_data,
169 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
171 uint8_t additional_flags, uint8_t clear_flags,
172 uint16_t additional_flags2, uint16_t clear_flags2,
173 uint32_t timeout_msec,
174 uint32_t pid, uint16_t tid,
175 struct smbXcli_session *session,
176 const char *pipe_name, uint16_t fid, uint16_t function,
178 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
179 uint8_t *param, uint32_t num_param, uint32_t max_param,
180 uint8_t *data, uint32_t num_data, uint32_t max_data,
181 uint16_t *recv_flags2,
182 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
183 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
184 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
186 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
187 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
188 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
189 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
190 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
191 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
192 uint16_t max_credits);
194 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
195 struct tevent_context *ev,
196 struct smbXcli_conn *conn,
198 uint32_t additional_flags,
199 uint32_t clear_flags,
200 uint32_t timeout_msec,
203 struct smbXcli_session *session,
204 const uint8_t *fixed,
208 void smb2cli_req_set_notify_async(struct tevent_req *req);
209 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
211 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
213 struct smb2cli_req_expected_response {
218 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
219 struct tevent_context *ev,
220 struct smbXcli_conn *conn,
222 uint32_t additional_flags,
223 uint32_t clear_flags,
224 uint32_t timeout_msec,
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 uint16_t smb1cli_session_current_id(struct smbXcli_session* session);
252 void smb1cli_session_set_id(struct smbXcli_session* session,
253 uint16_t session_id);
254 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
255 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
256 uint16_t smb2cli_session_get_flags(struct smbXcli_session *session);
257 NTSTATUS smb2cli_session_application_key(struct smbXcli_session *session,
260 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
262 uint16_t session_flags);
263 NTSTATUS smb2cli_session_set_session_key(struct smbXcli_session *session,
264 const DATA_BLOB session_key,
265 const struct iovec *recv_iov);
266 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
267 struct smbXcli_session *session1,
268 struct smbXcli_conn *conn,
269 struct smbXcli_session **_session2);
270 NTSTATUS smb2cli_session_set_channel_key(struct smbXcli_session *session,
271 const DATA_BLOB channel_key,
272 const struct iovec *recv_iov);
274 struct smbXcli_tcon *smbXcli_tcon_create(TALLOC_CTX *mem_ctx);
275 uint16_t smb1cli_tcon_current_id(struct smbXcli_tcon *tcon);
276 void smb1cli_tcon_set_id(struct smbXcli_tcon *tcon, uint16_t tcon_id);
277 bool smb1cli_tcon_set_values(struct smbXcli_tcon *tcon,
279 uint16_t optional_support,
280 uint32_t maximal_access,
281 uint32_t guest_maximal_access,
283 const char *fs_type);
284 uint32_t smb2cli_tcon_current_id(struct smbXcli_tcon *tcon);
285 void smb2cli_tcon_set_values(struct smbXcli_tcon *tcon,
289 uint32_t capabilities,
290 uint32_t maximal_access);
292 struct tevent_req *smb2cli_session_setup_send(TALLOC_CTX *mem_ctx,
293 struct tevent_context *ev,
294 struct smbXcli_conn *conn,
295 uint32_t timeout_msec,
296 struct smbXcli_session *session,
298 uint32_t in_capabilities,
300 uint64_t in_previous_session_id,
301 const DATA_BLOB *in_security_buffer);
302 NTSTATUS smb2cli_session_setup_recv(struct tevent_req *req,
304 struct iovec **recv_iov,
305 DATA_BLOB *out_security_buffer);
307 struct tevent_req *smb2cli_logoff_send(TALLOC_CTX *mem_ctx,
308 struct tevent_context *ev,
309 struct smbXcli_conn *conn,
310 uint32_t timeout_msec,
311 struct smbXcli_session *session);
312 NTSTATUS smb2cli_logoff_recv(struct tevent_req *req);
313 NTSTATUS smb2cli_logoff(struct smbXcli_conn *conn,
314 uint32_t timeout_msec,
315 struct smbXcli_session *session);
317 struct tevent_req *smb2cli_create_send(
319 struct tevent_context *ev,
320 struct smbXcli_conn *conn,
321 uint32_t timeout_msec,
322 struct smbXcli_session *session,
324 const char *filename,
325 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
326 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
327 uint32_t desired_access,
328 uint32_t file_attributes,
329 uint32_t share_access,
330 uint32_t create_disposition,
331 uint32_t create_options,
332 struct smb2_create_blobs *blobs);
333 NTSTATUS smb2cli_create_recv(struct tevent_req *req,
334 uint64_t *fid_persistent,
335 uint64_t *fid_volatile);
336 NTSTATUS smb2cli_create(struct smbXcli_conn *conn,
337 uint32_t timeout_msec,
338 struct smbXcli_session *session,
340 const char *filename,
341 uint8_t oplock_level, /* SMB2_OPLOCK_LEVEL_* */
342 uint32_t impersonation_level, /* SMB2_IMPERSONATION_* */
343 uint32_t desired_access,
344 uint32_t file_attributes,
345 uint32_t share_access,
346 uint32_t create_disposition,
347 uint32_t create_options,
348 struct smb2_create_blobs *blobs,
349 uint64_t *fid_persistent,
350 uint64_t *fid_volatile);
352 struct tevent_req *smb2cli_close_send(TALLOC_CTX *mem_ctx,
353 struct tevent_context *ev,
354 struct smbXcli_conn *conn,
355 uint32_t timeout_msec,
356 struct smbXcli_session *session,
359 uint64_t fid_persistent,
360 uint64_t fid_volatile);
361 NTSTATUS smb2cli_close_recv(struct tevent_req *req);
362 NTSTATUS smb2cli_close(struct smbXcli_conn *conn,
363 uint32_t timeout_msec,
364 struct smbXcli_session *session,
367 uint64_t fid_persistent,
368 uint64_t fid_volatile);
370 struct tevent_req *smb2cli_read_send(TALLOC_CTX *mem_ctx,
371 struct tevent_context *ev,
372 struct smbXcli_conn *conn,
373 uint32_t timeout_msec,
374 struct smbXcli_session *session,
378 uint64_t fid_persistent,
379 uint64_t fid_volatile,
380 uint64_t minimum_count,
381 uint64_t remaining_bytes);
382 NTSTATUS smb2cli_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
383 uint8_t **data, uint32_t *data_length);
384 NTSTATUS smb2cli_read(struct smbXcli_conn *conn,
385 uint32_t timeout_msec,
386 struct smbXcli_session *session,
390 uint64_t fid_persistent,
391 uint64_t fid_volatile,
392 uint64_t minimum_count,
393 uint64_t remaining_bytes,
396 uint32_t *data_length);
398 struct tevent_req *smb2cli_write_send(TALLOC_CTX *mem_ctx,
399 struct tevent_context *ev,
400 struct smbXcli_conn *conn,
401 uint32_t timeout_msec,
402 struct smbXcli_session *session,
406 uint64_t fid_persistent,
407 uint64_t fid_volatile,
408 uint32_t remaining_bytes,
410 const uint8_t *data);
411 NTSTATUS smb2cli_write_recv(struct tevent_req *req);
412 NTSTATUS smb2cli_write(struct smbXcli_conn *conn,
413 uint32_t timeout_msec,
414 struct smbXcli_session *session,
418 uint64_t fid_persistent,
419 uint64_t fid_volatile,
420 uint32_t remaining_bytes,
422 const uint8_t *data);
424 struct tevent_req *smb2cli_flush_send(TALLOC_CTX *mem_ctx,
425 struct tevent_context *ev,
426 struct smbXcli_conn *conn,
427 uint32_t timeout_msec,
428 struct smbXcli_session *session,
430 uint64_t fid_persistent,
431 uint64_t fid_volatile);
432 NTSTATUS smb2cli_flush_recv(struct tevent_req *req);
433 NTSTATUS smb2cli_flush(struct smbXcli_conn *conn,
434 uint32_t timeout_msec,
435 struct smbXcli_session *session,
437 uint64_t fid_persistent,
438 uint64_t fid_volatile);
440 struct tevent_req *smb2cli_set_info_send(TALLOC_CTX *mem_ctx,
441 struct tevent_context *ev,
442 struct smbXcli_conn *conn,
443 uint32_t timeout_msec,
444 struct smbXcli_session *session,
446 uint8_t in_info_type,
447 uint8_t in_file_info_class,
448 const DATA_BLOB *in_input_buffer,
449 uint32_t in_additional_info,
450 uint64_t in_fid_persistent,
451 uint64_t in_fid_volatile);
452 NTSTATUS smb2cli_set_info_recv(struct tevent_req *req);
453 NTSTATUS smb2cli_set_info(struct smbXcli_conn *conn,
454 uint32_t timeout_msec,
455 struct smbXcli_session *session,
457 uint8_t in_info_type,
458 uint8_t in_file_info_class,
459 const DATA_BLOB *in_input_buffer,
460 uint32_t in_additional_info,
461 uint64_t in_fid_persistent,
462 uint64_t in_fid_volatile);
464 struct tevent_req *smb2cli_query_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,
470 uint8_t in_info_type,
471 uint8_t in_file_info_class,
472 uint32_t in_max_output_length,
473 const DATA_BLOB *in_input_buffer,
474 uint32_t in_additional_info,
476 uint64_t in_fid_persistent,
477 uint64_t in_fid_volatile);
478 NTSTATUS smb2cli_query_info_recv(struct tevent_req *req,
480 DATA_BLOB *out_output_buffer);
481 NTSTATUS smb2cli_query_info(struct smbXcli_conn *conn,
482 uint32_t timeout_msec,
483 struct smbXcli_session *session,
485 uint8_t in_info_type,
486 uint8_t in_file_info_class,
487 uint32_t in_max_output_length,
488 const DATA_BLOB *in_input_buffer,
489 uint32_t in_additional_info,
491 uint64_t in_fid_persistent,
492 uint64_t in_fid_volatile,
494 DATA_BLOB *out_output_buffer);
496 struct tevent_req *smb2cli_query_directory_send(TALLOC_CTX *mem_ctx,
497 struct tevent_context *ev,
498 struct smbXcli_conn *conn,
499 uint32_t timeout_msec,
500 struct smbXcli_session *session,
505 uint64_t fid_persistent,
506 uint64_t fid_volatile,
508 uint32_t outbuf_len);
509 NTSTATUS smb2cli_query_directory_recv(struct tevent_req *req,
512 uint32_t *data_length);
513 NTSTATUS smb2cli_query_directory(struct smbXcli_conn *conn,
514 uint32_t timeout_msec,
515 struct smbXcli_session *session,
520 uint64_t fid_persistent,
521 uint64_t fid_volatile,
526 uint32_t *data_length);
528 struct tevent_req *smb2cli_ioctl_send(TALLOC_CTX *mem_ctx,
529 struct tevent_context *ev,
530 struct smbXcli_conn *conn,
531 uint32_t timeout_msec,
532 struct smbXcli_session *session,
534 uint64_t in_fid_persistent,
535 uint64_t in_fid_volatile,
536 uint32_t in_ctl_code,
537 uint32_t in_max_input_length,
538 const DATA_BLOB *in_input_buffer,
539 uint32_t in_max_output_length,
540 const DATA_BLOB *in_output_buffer,
542 NTSTATUS smb2cli_ioctl_recv(struct tevent_req *req,
544 DATA_BLOB *out_input_buffer,
545 DATA_BLOB *out_output_buffer);
546 NTSTATUS smb2cli_ioctl(struct smbXcli_conn *conn,
547 uint32_t timeout_msec,
548 struct smbXcli_session *session,
550 uint64_t in_fid_persistent,
551 uint64_t in_fid_volatile,
552 uint32_t in_ctl_code,
553 uint32_t in_max_input_length,
554 const DATA_BLOB *in_input_buffer,
555 uint32_t in_max_output_length,
556 const DATA_BLOB *in_output_buffer,
559 DATA_BLOB *out_input_buffer,
560 DATA_BLOB *out_output_buffer);
562 #endif /* _SMBXCLI_BASE_H_ */