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 smb_trans_enc_state;
27 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
29 const char *remote_name,
30 enum smb_signing_setting signing_state,
31 uint32_t smb1_capabilities);
33 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
34 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
36 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
38 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
39 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
41 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
42 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
43 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
44 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
46 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
47 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
48 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
49 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
51 void smbXcli_req_unset_pending(struct tevent_req *req);
52 bool smbXcli_req_set_pending(struct tevent_req *req);
54 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
55 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
56 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
57 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
58 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
59 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
61 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
62 const DATA_BLOB user_session_key,
63 const DATA_BLOB response);
64 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
65 const uint8_t *buf, uint32_t seqnum);
66 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
68 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
69 struct smb_trans_enc_state *es);
70 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
72 bool smb1cli_is_andx_req(uint8_t cmd);
73 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
75 uint16_t smb1cli_req_mid(struct tevent_req *req);
76 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
78 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
79 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
81 struct smb1cli_req_expected_response {
86 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
87 struct tevent_context *ev,
88 struct smbXcli_conn *conn,
90 uint8_t additional_flags,
92 uint16_t additional_flags2,
93 uint16_t clear_flags2,
94 uint32_t timeout_msec,
98 uint8_t wct, uint16_t *vwv,
100 struct iovec *bytes_iov);
101 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
103 struct tevent_req *smb1cli_req_send(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,
115 uint8_t wct, uint16_t *vwv,
117 const uint8_t *bytes);
118 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
124 uint32_t *pvwv_offset,
125 uint32_t *pnum_bytes,
127 uint32_t *pbytes_offset,
129 const struct smb1cli_req_expected_response *expected,
130 size_t num_expected);
132 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
133 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
134 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
135 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
136 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
138 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
139 struct tevent_context *ev,
140 struct smbXcli_conn *conn,
142 uint32_t additional_flags,
143 uint32_t clear_flags,
144 uint32_t timeout_msec,
148 const uint8_t *fixed,
152 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
155 struct smb2cli_req_expected_response {
160 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
161 struct tevent_context *ev,
162 struct smbXcli_conn *conn,
164 uint32_t additional_flags,
165 uint32_t clear_flags,
166 uint32_t timeout_msec,
170 const uint8_t *fixed,
174 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
176 const struct smb2cli_req_expected_response *expected,
177 size_t num_expected);
179 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
180 struct tevent_context *ev,
181 struct smbXcli_conn *conn,
182 uint32_t timeout_msec,
183 enum protocol_types min_protocol,
184 enum protocol_types max_protocol);
185 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
186 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
187 uint32_t timeout_msec,
188 enum protocol_types min_protocol,
189 enum protocol_types max_protocol);
191 #endif /* _SMBXCLI_BASE_H_ */