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;
26 struct smb_trans_enc_state;
29 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
31 const char *remote_name,
32 enum smb_signing_setting signing_state,
33 uint32_t smb1_capabilities,
34 struct GUID *client_guid);
36 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
37 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
39 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
41 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
42 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
44 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
45 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
46 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
47 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
49 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
50 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
51 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
52 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
54 void smbXcli_req_unset_pending(struct tevent_req *req);
55 bool smbXcli_req_set_pending(struct tevent_req *req);
57 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
58 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
59 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
60 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
61 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
62 bool smb1cli_conn_server_readbraw(struct smbXcli_conn *conn);
63 bool smb1cli_conn_server_writebraw(struct smbXcli_conn *conn);
64 bool smb1cli_conn_server_lockread(struct smbXcli_conn *conn);
65 bool smb1cli_conn_server_writeunlock(struct smbXcli_conn *conn);
66 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
68 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
69 const DATA_BLOB user_session_key,
70 const DATA_BLOB response);
71 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
72 const uint8_t *buf, uint32_t seqnum);
73 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
75 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
76 struct smb_trans_enc_state *es);
77 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
79 bool smb1cli_is_andx_req(uint8_t cmd);
80 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
82 uint16_t smb1cli_req_mid(struct tevent_req *req);
83 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
85 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
86 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
88 struct smb1cli_req_expected_response {
93 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
94 struct tevent_context *ev,
95 struct smbXcli_conn *conn,
97 uint8_t additional_flags,
99 uint16_t additional_flags2,
100 uint16_t clear_flags2,
101 uint32_t timeout_msec,
105 uint8_t wct, uint16_t *vwv,
107 struct iovec *bytes_iov);
108 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
110 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
111 struct tevent_context *ev,
112 struct smbXcli_conn *conn,
114 uint8_t additional_flags,
116 uint16_t additional_flags2,
117 uint16_t clear_flags2,
118 uint32_t timeout_msec,
122 uint8_t wct, uint16_t *vwv,
124 const uint8_t *bytes);
125 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
131 uint32_t *pvwv_offset,
132 uint32_t *pnum_bytes,
134 uint32_t *pbytes_offset,
136 const struct smb1cli_req_expected_response *expected,
137 size_t num_expected);
139 struct tevent_req *smb1cli_trans_send(
140 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
141 struct smbXcli_conn *conn, uint8_t cmd,
142 uint8_t additional_flags, uint8_t clear_flags,
143 uint16_t additional_flags2, uint16_t clear_flags2,
144 uint32_t timeout_msec,
145 uint32_t pid, uint16_t tid, uint16_t uid,
146 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
147 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
148 uint8_t *param, uint32_t num_param, uint32_t max_param,
149 uint8_t *data, uint32_t num_data, uint32_t max_data);
150 NTSTATUS smb1cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
151 uint16_t *recv_flags2,
152 uint16_t **setup, uint8_t min_setup,
154 uint8_t **param, uint32_t min_param,
156 uint8_t **data, uint32_t min_data,
158 NTSTATUS smb1cli_trans(TALLOC_CTX *mem_ctx, struct smbXcli_conn *conn,
160 uint8_t additional_flags, uint8_t clear_flags,
161 uint16_t additional_flags2, uint16_t clear_flags2,
162 uint32_t timeout_msec,
163 uint32_t pid, uint16_t tid, uint16_t uid,
164 const char *pipe_name, uint16_t fid, uint16_t function,
166 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
167 uint8_t *param, uint32_t num_param, uint32_t max_param,
168 uint8_t *data, uint32_t num_data, uint32_t max_data,
169 uint16_t *recv_flags2,
170 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
171 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
172 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata);
174 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
175 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
176 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
177 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
178 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
179 void smb2cli_conn_set_max_credits(struct smbXcli_conn *conn,
180 uint16_t max_credits);
182 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
183 struct tevent_context *ev,
184 struct smbXcli_conn *conn,
186 uint32_t additional_flags,
187 uint32_t clear_flags,
188 uint32_t timeout_msec,
191 struct smbXcli_session *session,
192 const uint8_t *fixed,
196 void smb2cli_req_set_notify_async(struct tevent_req *req);
197 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
199 void smb2cli_req_set_credit_charge(struct tevent_req *req, uint16_t charge);
201 struct smb2cli_req_expected_response {
206 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
207 struct tevent_context *ev,
208 struct smbXcli_conn *conn,
210 uint32_t additional_flags,
211 uint32_t clear_flags,
212 uint32_t timeout_msec,
215 struct smbXcli_session *session,
216 const uint8_t *fixed,
220 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
222 const struct smb2cli_req_expected_response *expected,
223 size_t num_expected);
225 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
226 struct tevent_context *ev,
227 struct smbXcli_conn *conn,
228 uint32_t timeout_msec,
229 enum protocol_types min_protocol,
230 enum protocol_types max_protocol);
231 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
232 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
233 uint32_t timeout_msec,
234 enum protocol_types min_protocol,
235 enum protocol_types max_protocol);
237 struct smbXcli_session *smbXcli_session_create(TALLOC_CTX *mem_ctx,
238 struct smbXcli_conn *conn);
239 uint8_t smb2cli_session_security_mode(struct smbXcli_session *session);
240 uint64_t smb2cli_session_current_id(struct smbXcli_session *session);
241 void smb2cli_session_set_id_and_flags(struct smbXcli_session *session,
243 uint16_t session_flags);
244 NTSTATUS smb2cli_session_update_session_key(struct smbXcli_session *session,
245 const DATA_BLOB session_key,
246 const struct iovec *recv_iov);
247 NTSTATUS smb2cli_session_create_channel(TALLOC_CTX *mem_ctx,
248 struct smbXcli_session *session1,
249 struct smbXcli_conn *conn,
250 struct smbXcli_session **_session2);
252 #endif /* _SMBXCLI_BASE_H_ */