2 Unix SMB/CIFS implementation.
4 SMB2 client transport context management functions
6 Copyright (C) Andrew Tridgell 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "system/network.h"
24 #include "libcli/raw/libcliraw.h"
25 #include "libcli/raw/raw_proto.h"
26 #include "libcli/smb2/smb2.h"
27 #include "libcli/smb2/smb2_calls.h"
28 #include "lib/socket/socket.h"
29 #include "lib/events/events.h"
30 #include "lib/stream/packet.h"
31 #include "../lib/util/dlinklist.h"
32 #include "../libcli/smb/smbXcli_base.h"
33 #include "librpc/ndr/libndr.h"
38 static int transport_destructor(struct smb2_transport *transport)
40 smb2_transport_dead(transport, NT_STATUS_LOCAL_DISCONNECT);
45 create a transport structure based on an established socket
47 struct smb2_transport *smb2_transport_init(struct smbcli_socket *sock,
48 TALLOC_CTX *parent_ctx,
49 struct smbcli_options *options)
51 struct smb2_transport *transport;
52 struct GUID client_guid;
54 transport = talloc_zero(parent_ctx, struct smb2_transport);
55 if (!transport) return NULL;
57 transport->ev = sock->event.ctx;
58 transport->options = *options;
60 TALLOC_FREE(sock->event.fde);
61 TALLOC_FREE(sock->event.te);
63 client_guid = GUID_random();
65 transport->conn = smbXcli_conn_create(transport,
69 0, /* smb1_capabilities */
71 if (transport->conn == NULL) {
72 talloc_free(transport);
78 talloc_set_destructor(transport, transport_destructor);
84 mark the transport as dead
86 void smb2_transport_dead(struct smb2_transport *transport, NTSTATUS status)
88 if (NT_STATUS_EQUAL(NT_STATUS_UNSUCCESSFUL, status)) {
89 status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
91 if (NT_STATUS_IS_OK(status)) {
92 status = NT_STATUS_LOCAL_DISCONNECT;
95 smbXcli_conn_disconnect(transport->conn, status);
98 static void smb2_request_done(struct tevent_req *subreq);
99 static void smb2_transport_break_handler(struct tevent_req *subreq);
102 put a request into the send queue
104 void smb2_transport_send(struct smb2_request *req)
107 struct smb2_transport *transport = req->transport;
108 struct tevent_req **reqs = transport->compound.reqs;
109 size_t num_reqs = talloc_array_length(reqs);
111 uint16_t cmd = SVAL(req->out.hdr, SMB2_HDR_OPCODE);
112 uint32_t additional_flags = IVAL(req->out.hdr, SMB2_HDR_FLAGS);
113 uint32_t clear_flags = 0;
114 uint32_t pid = IVAL(req->out.hdr, SMB2_HDR_PID);
115 uint32_t tid = IVAL(req->out.hdr, SMB2_HDR_TID);
116 struct smbXcli_session *session = NULL;
117 bool need_pending_break = false;
120 DATA_BLOB body = data_blob_null;
121 DATA_BLOB dyn = data_blob_null;
122 uint32_t timeout_msec = transport->options.request_timeout * 1000;
124 if (transport->oplock.handler) {
125 need_pending_break = true;
128 if (transport->lease.handler) {
129 need_pending_break = true;
132 if (transport->break_subreq) {
133 need_pending_break = false;
136 if (need_pending_break) {
137 struct tevent_req *subreq;
139 subreq = smb2cli_req_create(transport,
143 0, /* additional_flags */
145 0, /* timeout_msec */
153 if (subreq != NULL) {
154 smbXcli_req_set_pending(subreq);
155 tevent_req_set_callback(subreq,
156 smb2_transport_break_handler,
158 transport->break_subreq = subreq;
163 session = req->session->smbXcli;
166 if (transport->compound.related) {
167 additional_flags |= SMB2_HDR_FLAG_CHAINED;
170 hdr_ofs = PTR_DIFF(req->out.hdr, req->out.buffer);
171 pdu_len = req->out.size - hdr_ofs;
172 body.data = req->out.body;
173 body.length = req->out.body_fixed;
174 dyn.data = req->out.body + req->out.body_fixed;
175 dyn.length = pdu_len - (SMB2_HDR_BODY + req->out.body_fixed);
177 req->subreq = smb2cli_req_create(req,
187 body.data, body.length,
188 dyn.data, dyn.length);
189 if (req->subreq == NULL) {
190 req->state = SMB2_REQUEST_ERROR;
191 req->status = NT_STATUS_NO_MEMORY;
195 if (!tevent_req_is_in_progress(req->subreq)) {
196 req->state = SMB2_REQUEST_ERROR;
197 req->status = NT_STATUS_INTERNAL_ERROR;/* TODO */
201 tevent_req_set_callback(req->subreq, smb2_request_done, req);
203 smb2cli_req_set_notify_async(req->subreq);
204 if (req->credit_charge) {
205 smb2cli_req_set_credit_charge(req->subreq, req->credit_charge);
208 ZERO_STRUCT(req->out);
209 req->state = SMB2_REQUEST_RECV;
212 for (i=0; i < num_reqs; i++) {
213 if (reqs[i] != NULL) {
217 reqs[i] = req->subreq;
229 status = smb2cli_req_compound_submit(reqs, num_reqs);
231 TALLOC_FREE(transport->compound.reqs);
233 if (!NT_STATUS_IS_OK(status)) {
234 req->status = status;
235 req->state = SMB2_REQUEST_ERROR;
236 smbXcli_conn_disconnect(transport->conn, status);
240 static void smb2_request_done(struct tevent_req *subreq)
242 struct smb2_request *req =
243 tevent_req_callback_data(subreq,
244 struct smb2_request);
248 req->recv_iov = NULL;
250 req->status = smb2cli_req_recv(req->subreq, req, &req->recv_iov, NULL, 0);
251 if (NT_STATUS_EQUAL(req->status, STATUS_PENDING)) {
252 req->cancel.can_cancel = true;
255 TALLOC_FREE(req->subreq);
256 if (!NT_STATUS_IS_OK(req->status)) {
257 if (req->recv_iov == NULL) {
258 req->state = SMB2_REQUEST_ERROR;
266 len = req->recv_iov[0].iov_len;
267 for (i=1; i < 3; i++) {
268 uint8_t *p = req->recv_iov[i-1].iov_base;
269 uint8_t *c1 = req->recv_iov[i].iov_base;
270 uint8_t *c2 = p + req->recv_iov[i-1].iov_len;
272 len += req->recv_iov[i].iov_len;
274 if (req->recv_iov[i].iov_len == 0) {
279 req->status = NT_STATUS_INTERNAL_ERROR;
280 req->state = SMB2_REQUEST_ERROR;
288 req->in.buffer = req->recv_iov[0].iov_base;
290 req->in.allocated = req->in.size;
292 req->in.hdr = req->recv_iov[0].iov_base;
293 req->in.body = req->recv_iov[1].iov_base;
294 req->in.dynamic = req->recv_iov[2].iov_base;
295 req->in.body_fixed = req->recv_iov[1].iov_len;
296 req->in.body_size = req->in.body_fixed;
297 req->in.body_size += req->recv_iov[2].iov_len;
299 smb2_setup_bufinfo(req);
301 req->state = SMB2_REQUEST_DONE;
307 static void smb2_transport_break_handler(struct tevent_req *subreq)
309 struct smb2_transport *transport =
310 tevent_req_callback_data(subreq,
311 struct smb2_transport);
317 struct iovec *recv_iov = NULL;
319 transport->break_subreq = NULL;
321 status = smb2cli_req_recv(subreq, transport, &recv_iov, NULL, 0);
323 if (!NT_STATUS_IS_OK(status)) {
324 TALLOC_FREE(recv_iov);
325 smb2_transport_dead(transport, status);
330 * Setup the subreq to handle the
331 * next incoming SMB2 Break.
333 subreq = smb2cli_req_create(transport,
337 0, /* additional_flags */
339 0, /* timeout_msec */
347 if (subreq != NULL) {
348 smbXcli_req_set_pending(subreq);
349 tevent_req_set_callback(subreq,
350 smb2_transport_break_handler,
352 transport->break_subreq = subreq;
355 hdr = recv_iov[0].iov_base;
356 body = recv_iov[1].iov_base;
358 len = recv_iov[1].iov_len;
359 if (recv_iov[1].iov_len >= 2) {
360 len = CVAL(body, 0x00);
361 if (len != recv_iov[1].iov_len) {
362 len = recv_iov[1].iov_len;
368 } else if (len == 44) {
371 DEBUG(1,("Discarding smb2 oplock reply of invalid size %u\n",
373 TALLOC_FREE(recv_iov);
374 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
375 smb2_transport_dead(transport, status);
379 if (!lease && transport->oplock.handler) {
380 struct smb2_handle h;
383 level = CVAL(body, 0x02);
384 smb2_pull_handle(body+0x08, &h);
386 TALLOC_FREE(recv_iov);
388 transport->oplock.handler(transport, &h, level,
389 transport->oplock.private_data);
390 } else if (lease && transport->lease.handler) {
391 struct smb2_lease_break lb;
394 lb.break_flags = SVAL(body, 0x4);
395 memcpy(&lb.current_lease.lease_key, body+0x8,
396 sizeof(struct smb2_lease_key));
397 lb.current_lease.lease_state = SVAL(body, 0x18);
398 lb.new_lease_state = SVAL(body, 0x1C);
399 lb.break_reason = SVAL(body, 0x20);
400 lb.access_mask_hint = SVAL(body, 0x24);
401 lb.share_mask_hint = SVAL(body, 0x28);
403 TALLOC_FREE(recv_iov);
405 transport->lease.handler(transport, &lb,
406 transport->lease.private_data);
408 DEBUG(5,("Got SMB2 %s break with no handler\n",
409 lease ? "lease" : "oplock"));
411 TALLOC_FREE(recv_iov);
414 NTSTATUS smb2_transport_compound_start(struct smb2_transport *transport,
417 TALLOC_FREE(transport->compound.reqs);
418 ZERO_STRUCT(transport->compound);
420 transport->compound.reqs = talloc_zero_array(transport,
423 if (transport->compound.reqs == NULL) {
424 return NT_STATUS_NO_MEMORY;
430 void smb2_transport_compound_set_related(struct smb2_transport *transport,
433 transport->compound.related = related;
436 void smb2_transport_credits_ask_num(struct smb2_transport *transport,
439 smb2cli_conn_set_max_credits(transport->conn, ask_num);
442 static void idle_handler(struct tevent_context *ev,
443 struct tevent_timer *te, struct timeval t, void *private_data)
445 struct smb2_transport *transport = talloc_get_type(private_data,
446 struct smb2_transport);
449 transport->idle.func(transport, transport->idle.private_data);
451 next = timeval_current_ofs_usec(transport->idle.period);
452 transport->idle.te = tevent_add_timer(transport->ev,
460 setup the idle handler for a transport
461 the period is in microseconds
463 void smb2_transport_idle_handler(struct smb2_transport *transport,
464 void (*idle_func)(struct smb2_transport *, void *),
468 TALLOC_FREE(transport->idle.te);
470 transport->idle.func = idle_func;
471 transport->idle.private_data = private_data;
472 transport->idle.period = period;
474 transport->idle.te = tevent_add_timer(transport->ev,
476 timeval_current_ofs_usec(period),