librpc: Shorten dcerpc_binding_handle_call a bit
[Samba/gebeck_regimport.git] / source4 / libcli / smb2 / transport.c
blobbdab523f4fbe031f547ff5af51cdc4037ef88c8e
1 /*
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/>.
22 #include "includes.h"
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/util/dlinklist.h"
31 #include "../libcli/smb/smbXcli_base.h"
32 #include "librpc/ndr/libndr.h"
35 destroy a transport
37 static int transport_destructor(struct smb2_transport *transport)
39 smb2_transport_dead(transport, NT_STATUS_LOCAL_DISCONNECT);
40 return 0;
44 create a transport structure based on an established socket
46 struct smb2_transport *smb2_transport_init(struct smbcli_socket *sock,
47 TALLOC_CTX *parent_ctx,
48 struct smbcli_options *options)
50 struct smb2_transport *transport;
51 struct GUID client_guid;
52 uint32_t smb2_capabilities = 0;
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 /* TODO: hand this in via the options? */
66 smb2_capabilities = SMB2_CAP_ALL;
68 transport->conn = smbXcli_conn_create(transport,
69 sock->sock->fd,
70 sock->hostname,
71 options->signing,
72 0, /* smb1_capabilities */
73 &client_guid,
74 smb2_capabilities);
75 if (transport->conn == NULL) {
76 talloc_free(transport);
77 return NULL;
79 sock->sock->fd = -1;
80 TALLOC_FREE(sock);
82 talloc_set_destructor(transport, transport_destructor);
84 return transport;
88 mark the transport as dead
90 void smb2_transport_dead(struct smb2_transport *transport, NTSTATUS status)
92 if (NT_STATUS_EQUAL(NT_STATUS_UNSUCCESSFUL, status)) {
93 status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
95 if (NT_STATUS_IS_OK(status)) {
96 status = NT_STATUS_LOCAL_DISCONNECT;
99 smbXcli_conn_disconnect(transport->conn, status);
102 static void smb2_request_done(struct tevent_req *subreq);
103 static void smb2_transport_break_handler(struct tevent_req *subreq);
106 put a request into the send queue
108 void smb2_transport_send(struct smb2_request *req)
110 NTSTATUS status;
111 struct smb2_transport *transport = req->transport;
112 struct tevent_req **reqs = transport->compound.reqs;
113 size_t num_reqs = talloc_array_length(reqs);
114 size_t i;
115 uint16_t cmd = SVAL(req->out.hdr, SMB2_HDR_OPCODE);
116 uint32_t additional_flags = IVAL(req->out.hdr, SMB2_HDR_FLAGS);
117 uint32_t clear_flags = 0;
118 struct smbXcli_tcon *tcon = NULL;
119 struct smbXcli_session *session = NULL;
120 bool need_pending_break = false;
121 size_t hdr_ofs;
122 size_t pdu_len;
123 DATA_BLOB body = data_blob_null;
124 DATA_BLOB dyn = data_blob_null;
125 uint32_t timeout_msec = transport->options.request_timeout * 1000;
127 if (transport->oplock.handler) {
128 need_pending_break = true;
131 if (transport->lease.handler) {
132 need_pending_break = true;
135 if (transport->break_subreq) {
136 need_pending_break = false;
139 if (need_pending_break) {
140 struct tevent_req *subreq;
142 subreq = smb2cli_req_create(transport,
143 transport->ev,
144 transport->conn,
145 SMB2_OP_BREAK,
146 0, /* additional_flags */
147 0, /*clear_flags */
148 0, /* timeout_msec */
149 NULL, /* tcon */
150 NULL, /* session */
151 NULL, /* body */
152 0, /* body_fixed */
153 NULL, /* dyn */
154 0); /* dyn_len */
155 if (subreq != NULL) {
156 smbXcli_req_set_pending(subreq);
157 tevent_req_set_callback(subreq,
158 smb2_transport_break_handler,
159 transport);
160 transport->break_subreq = subreq;
164 if (req->session) {
165 session = req->session->smbXcli;
168 if (req->tree) {
169 tcon = req->tree->smbXcli;
172 if (transport->compound.related) {
173 additional_flags |= SMB2_HDR_FLAG_CHAINED;
176 hdr_ofs = PTR_DIFF(req->out.hdr, req->out.buffer);
177 pdu_len = req->out.size - hdr_ofs;
178 body.data = req->out.body;
179 body.length = req->out.body_fixed;
180 dyn.data = req->out.body + req->out.body_fixed;
181 dyn.length = pdu_len - (SMB2_HDR_BODY + req->out.body_fixed);
183 req->subreq = smb2cli_req_create(req,
184 transport->ev,
185 transport->conn,
186 cmd,
187 additional_flags,
188 clear_flags,
189 timeout_msec,
190 tcon,
191 session,
192 body.data, body.length,
193 dyn.data, dyn.length);
194 if (req->subreq == NULL) {
195 req->state = SMB2_REQUEST_ERROR;
196 req->status = NT_STATUS_NO_MEMORY;
197 return;
200 if (!tevent_req_is_in_progress(req->subreq)) {
201 req->state = SMB2_REQUEST_ERROR;
202 req->status = NT_STATUS_INTERNAL_ERROR;/* TODO */
203 return;
206 tevent_req_set_callback(req->subreq, smb2_request_done, req);
208 smb2cli_req_set_notify_async(req->subreq);
209 if (req->credit_charge) {
210 smb2cli_req_set_credit_charge(req->subreq, req->credit_charge);
213 ZERO_STRUCT(req->out);
214 req->state = SMB2_REQUEST_RECV;
216 if (num_reqs > 0) {
217 for (i=0; i < num_reqs; i++) {
218 if (reqs[i] != NULL) {
219 continue;
222 reqs[i] = req->subreq;
223 i++;
224 break;
227 if (i < num_reqs) {
228 return;
230 } else {
231 reqs = &req->subreq;
232 num_reqs = 1;
234 status = smb2cli_req_compound_submit(reqs, num_reqs);
236 TALLOC_FREE(transport->compound.reqs);
237 transport->compound.related = false;
239 if (!NT_STATUS_IS_OK(status)) {
240 req->status = status;
241 req->state = SMB2_REQUEST_ERROR;
242 smbXcli_conn_disconnect(transport->conn, status);
246 static void smb2_request_done(struct tevent_req *subreq)
248 struct smb2_request *req =
249 tevent_req_callback_data(subreq,
250 struct smb2_request);
251 ssize_t len;
252 size_t i;
254 req->recv_iov = NULL;
256 req->status = smb2cli_req_recv(req->subreq, req, &req->recv_iov, NULL, 0);
257 if (NT_STATUS_EQUAL(req->status, STATUS_PENDING)) {
258 req->cancel.can_cancel = true;
259 return;
261 TALLOC_FREE(req->subreq);
262 if (!NT_STATUS_IS_OK(req->status)) {
263 if (req->recv_iov == NULL) {
264 req->state = SMB2_REQUEST_ERROR;
265 if (req->async.fn) {
266 req->async.fn(req);
268 return;
272 len = req->recv_iov[0].iov_len;
273 for (i=1; i < 3; i++) {
274 uint8_t *p = req->recv_iov[i-1].iov_base;
275 uint8_t *c1 = req->recv_iov[i].iov_base;
276 uint8_t *c2 = p + req->recv_iov[i-1].iov_len;
278 len += req->recv_iov[i].iov_len;
280 if (req->recv_iov[i].iov_len == 0) {
281 continue;
284 if (c1 != c2) {
285 req->status = NT_STATUS_INTERNAL_ERROR;
286 req->state = SMB2_REQUEST_ERROR;
287 if (req->async.fn) {
288 req->async.fn(req);
290 return;
294 req->in.buffer = req->recv_iov[0].iov_base;
295 req->in.size = len;
296 req->in.allocated = req->in.size;
298 req->in.hdr = req->recv_iov[0].iov_base;
299 req->in.body = req->recv_iov[1].iov_base;
300 req->in.dynamic = req->recv_iov[2].iov_base;
301 req->in.body_fixed = req->recv_iov[1].iov_len;
302 req->in.body_size = req->in.body_fixed;
303 req->in.body_size += req->recv_iov[2].iov_len;
305 smb2_setup_bufinfo(req);
307 req->state = SMB2_REQUEST_DONE;
308 if (req->async.fn) {
309 req->async.fn(req);
313 static void smb2_transport_break_handler(struct tevent_req *subreq)
315 struct smb2_transport *transport =
316 tevent_req_callback_data(subreq,
317 struct smb2_transport);
318 NTSTATUS status;
319 uint8_t *body;
320 uint16_t len = 0;
321 bool lease;
322 struct iovec *recv_iov = NULL;
324 transport->break_subreq = NULL;
326 status = smb2cli_req_recv(subreq, transport, &recv_iov, NULL, 0);
327 TALLOC_FREE(subreq);
328 if (!NT_STATUS_IS_OK(status)) {
329 TALLOC_FREE(recv_iov);
330 smb2_transport_dead(transport, status);
331 return;
335 * Setup the subreq to handle the
336 * next incoming SMB2 Break.
338 subreq = smb2cli_req_create(transport,
339 transport->ev,
340 transport->conn,
341 SMB2_OP_BREAK,
342 0, /* additional_flags */
343 0, /*clear_flags */
344 0, /* timeout_msec */
345 NULL, /* tcon */
346 NULL, /* session */
347 NULL, /* body */
348 0, /* body_fixed */
349 NULL, /* dyn */
350 0); /* dyn_len */
351 if (subreq != NULL) {
352 smbXcli_req_set_pending(subreq);
353 tevent_req_set_callback(subreq,
354 smb2_transport_break_handler,
355 transport);
356 transport->break_subreq = subreq;
359 body = recv_iov[1].iov_base;
361 len = recv_iov[1].iov_len;
362 if (recv_iov[1].iov_len >= 2) {
363 len = CVAL(body, 0x00);
364 if (len != recv_iov[1].iov_len) {
365 len = recv_iov[1].iov_len;
369 if (len == 24) {
370 lease = false;
371 } else if (len == 44) {
372 lease = true;
373 } else {
374 DEBUG(1,("Discarding smb2 oplock reply of invalid size %u\n",
375 (unsigned)len));
376 TALLOC_FREE(recv_iov);
377 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
378 smb2_transport_dead(transport, status);
379 return;
382 if (!lease && transport->oplock.handler) {
383 struct smb2_handle h;
384 uint8_t level;
386 level = CVAL(body, 0x02);
387 smb2_pull_handle(body+0x08, &h);
389 TALLOC_FREE(recv_iov);
391 transport->oplock.handler(transport, &h, level,
392 transport->oplock.private_data);
393 } else if (lease && transport->lease.handler) {
394 struct smb2_lease_break lb;
396 ZERO_STRUCT(lb);
397 lb.break_flags = SVAL(body, 0x4);
398 memcpy(&lb.current_lease.lease_key, body+0x8,
399 sizeof(struct smb2_lease_key));
400 lb.current_lease.lease_state = SVAL(body, 0x18);
401 lb.new_lease_state = SVAL(body, 0x1C);
402 lb.break_reason = SVAL(body, 0x20);
403 lb.access_mask_hint = SVAL(body, 0x24);
404 lb.share_mask_hint = SVAL(body, 0x28);
406 TALLOC_FREE(recv_iov);
408 transport->lease.handler(transport, &lb,
409 transport->lease.private_data);
410 } else {
411 DEBUG(5,("Got SMB2 %s break with no handler\n",
412 lease ? "lease" : "oplock"));
414 TALLOC_FREE(recv_iov);
417 NTSTATUS smb2_transport_compound_start(struct smb2_transport *transport,
418 uint32_t num)
420 TALLOC_FREE(transport->compound.reqs);
421 ZERO_STRUCT(transport->compound);
423 transport->compound.reqs = talloc_zero_array(transport,
424 struct tevent_req *,
425 num);
426 if (transport->compound.reqs == NULL) {
427 return NT_STATUS_NO_MEMORY;
430 return NT_STATUS_OK;
433 void smb2_transport_compound_set_related(struct smb2_transport *transport,
434 bool related)
436 transport->compound.related = related;
439 void smb2_transport_credits_ask_num(struct smb2_transport *transport,
440 uint16_t ask_num)
442 smb2cli_conn_set_max_credits(transport->conn, ask_num);
445 static void idle_handler(struct tevent_context *ev,
446 struct tevent_timer *te, struct timeval t, void *private_data)
448 struct smb2_transport *transport = talloc_get_type(private_data,
449 struct smb2_transport);
450 struct timeval next;
452 transport->idle.func(transport, transport->idle.private_data);
454 next = timeval_current_ofs_usec(transport->idle.period);
455 transport->idle.te = tevent_add_timer(transport->ev,
456 transport,
457 next,
458 idle_handler,
459 transport);
463 setup the idle handler for a transport
464 the period is in microseconds
466 void smb2_transport_idle_handler(struct smb2_transport *transport,
467 void (*idle_func)(struct smb2_transport *, void *),
468 uint64_t period,
469 void *private_data)
471 TALLOC_FREE(transport->idle.te);
473 transport->idle.func = idle_func;
474 transport->idle.private_data = private_data;
475 transport->idle.period = period;
477 transport->idle.te = tevent_add_timer(transport->ev,
478 transport,
479 timeval_current_ofs_usec(period),
480 idle_handler,
481 transport);