libcli/smb: pass smbXcli_tcon to smb2cli_req_create/send()
[Samba/gebeck_regimport.git] / source4 / libcli / smb2 / transport.c
blob423b634765971e0ff05c48dbda35f4d1410bfee8
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 uint32_t pid = IVAL(req->out.hdr, SMB2_HDR_PID);
119 struct smbXcli_tcon *tcon = NULL;
120 struct smbXcli_session *session = NULL;
121 bool need_pending_break = false;
122 size_t hdr_ofs;
123 size_t pdu_len;
124 DATA_BLOB body = data_blob_null;
125 DATA_BLOB dyn = data_blob_null;
126 uint32_t timeout_msec = transport->options.request_timeout * 1000;
128 if (transport->oplock.handler) {
129 need_pending_break = true;
132 if (transport->lease.handler) {
133 need_pending_break = true;
136 if (transport->break_subreq) {
137 need_pending_break = false;
140 if (need_pending_break) {
141 struct tevent_req *subreq;
143 subreq = smb2cli_req_create(transport,
144 transport->ev,
145 transport->conn,
146 SMB2_OP_BREAK,
147 0, /* additional_flags */
148 0, /*clear_flags */
149 0, /* timeout_msec */
150 0, /* pid */
151 NULL, /* tcon */
152 NULL, /* session */
153 NULL, /* body */
154 0, /* body_fixed */
155 NULL, /* dyn */
156 0); /* dyn_len */
157 if (subreq != NULL) {
158 smbXcli_req_set_pending(subreq);
159 tevent_req_set_callback(subreq,
160 smb2_transport_break_handler,
161 transport);
162 transport->break_subreq = subreq;
166 if (req->session) {
167 session = req->session->smbXcli;
170 if (req->tree) {
171 tcon = req->tree->smbXcli;
174 if (transport->compound.related) {
175 additional_flags |= SMB2_HDR_FLAG_CHAINED;
178 hdr_ofs = PTR_DIFF(req->out.hdr, req->out.buffer);
179 pdu_len = req->out.size - hdr_ofs;
180 body.data = req->out.body;
181 body.length = req->out.body_fixed;
182 dyn.data = req->out.body + req->out.body_fixed;
183 dyn.length = pdu_len - (SMB2_HDR_BODY + req->out.body_fixed);
185 req->subreq = smb2cli_req_create(req,
186 transport->ev,
187 transport->conn,
188 cmd,
189 additional_flags,
190 clear_flags,
191 timeout_msec,
192 pid,
193 tcon,
194 session,
195 body.data, body.length,
196 dyn.data, dyn.length);
197 if (req->subreq == NULL) {
198 req->state = SMB2_REQUEST_ERROR;
199 req->status = NT_STATUS_NO_MEMORY;
200 return;
203 if (!tevent_req_is_in_progress(req->subreq)) {
204 req->state = SMB2_REQUEST_ERROR;
205 req->status = NT_STATUS_INTERNAL_ERROR;/* TODO */
206 return;
209 tevent_req_set_callback(req->subreq, smb2_request_done, req);
211 smb2cli_req_set_notify_async(req->subreq);
212 if (req->credit_charge) {
213 smb2cli_req_set_credit_charge(req->subreq, req->credit_charge);
216 ZERO_STRUCT(req->out);
217 req->state = SMB2_REQUEST_RECV;
219 if (num_reqs > 0) {
220 for (i=0; i < num_reqs; i++) {
221 if (reqs[i] != NULL) {
222 continue;
225 reqs[i] = req->subreq;
226 i++;
227 break;
230 if (i < num_reqs) {
231 return;
233 } else {
234 reqs = &req->subreq;
235 num_reqs = 1;
237 status = smb2cli_req_compound_submit(reqs, num_reqs);
239 TALLOC_FREE(transport->compound.reqs);
241 if (!NT_STATUS_IS_OK(status)) {
242 req->status = status;
243 req->state = SMB2_REQUEST_ERROR;
244 smbXcli_conn_disconnect(transport->conn, status);
248 static void smb2_request_done(struct tevent_req *subreq)
250 struct smb2_request *req =
251 tevent_req_callback_data(subreq,
252 struct smb2_request);
253 ssize_t len;
254 size_t i;
256 req->recv_iov = NULL;
258 req->status = smb2cli_req_recv(req->subreq, req, &req->recv_iov, NULL, 0);
259 if (NT_STATUS_EQUAL(req->status, STATUS_PENDING)) {
260 req->cancel.can_cancel = true;
261 return;
263 TALLOC_FREE(req->subreq);
264 if (!NT_STATUS_IS_OK(req->status)) {
265 if (req->recv_iov == NULL) {
266 req->state = SMB2_REQUEST_ERROR;
267 if (req->async.fn) {
268 req->async.fn(req);
270 return;
274 len = req->recv_iov[0].iov_len;
275 for (i=1; i < 3; i++) {
276 uint8_t *p = req->recv_iov[i-1].iov_base;
277 uint8_t *c1 = req->recv_iov[i].iov_base;
278 uint8_t *c2 = p + req->recv_iov[i-1].iov_len;
280 len += req->recv_iov[i].iov_len;
282 if (req->recv_iov[i].iov_len == 0) {
283 continue;
286 if (c1 != c2) {
287 req->status = NT_STATUS_INTERNAL_ERROR;
288 req->state = SMB2_REQUEST_ERROR;
289 if (req->async.fn) {
290 req->async.fn(req);
292 return;
296 req->in.buffer = req->recv_iov[0].iov_base;
297 req->in.size = len;
298 req->in.allocated = req->in.size;
300 req->in.hdr = req->recv_iov[0].iov_base;
301 req->in.body = req->recv_iov[1].iov_base;
302 req->in.dynamic = req->recv_iov[2].iov_base;
303 req->in.body_fixed = req->recv_iov[1].iov_len;
304 req->in.body_size = req->in.body_fixed;
305 req->in.body_size += req->recv_iov[2].iov_len;
307 smb2_setup_bufinfo(req);
309 req->state = SMB2_REQUEST_DONE;
310 if (req->async.fn) {
311 req->async.fn(req);
315 static void smb2_transport_break_handler(struct tevent_req *subreq)
317 struct smb2_transport *transport =
318 tevent_req_callback_data(subreq,
319 struct smb2_transport);
320 NTSTATUS status;
321 uint8_t *hdr;
322 uint8_t *body;
323 uint16_t len = 0;
324 bool lease;
325 struct iovec *recv_iov = NULL;
327 transport->break_subreq = NULL;
329 status = smb2cli_req_recv(subreq, transport, &recv_iov, NULL, 0);
330 TALLOC_FREE(subreq);
331 if (!NT_STATUS_IS_OK(status)) {
332 TALLOC_FREE(recv_iov);
333 smb2_transport_dead(transport, status);
334 return;
338 * Setup the subreq to handle the
339 * next incoming SMB2 Break.
341 subreq = smb2cli_req_create(transport,
342 transport->ev,
343 transport->conn,
344 SMB2_OP_BREAK,
345 0, /* additional_flags */
346 0, /*clear_flags */
347 0, /* timeout_msec */
348 0, /* pid */
349 NULL, /* tcon */
350 NULL, /* session */
351 NULL, /* body */
352 0, /* body_fixed */
353 NULL, /* dyn */
354 0); /* dyn_len */
355 if (subreq != NULL) {
356 smbXcli_req_set_pending(subreq);
357 tevent_req_set_callback(subreq,
358 smb2_transport_break_handler,
359 transport);
360 transport->break_subreq = subreq;
363 hdr = recv_iov[0].iov_base;
364 body = recv_iov[1].iov_base;
366 len = recv_iov[1].iov_len;
367 if (recv_iov[1].iov_len >= 2) {
368 len = CVAL(body, 0x00);
369 if (len != recv_iov[1].iov_len) {
370 len = recv_iov[1].iov_len;
374 if (len == 24) {
375 lease = false;
376 } else if (len == 44) {
377 lease = true;
378 } else {
379 DEBUG(1,("Discarding smb2 oplock reply of invalid size %u\n",
380 (unsigned)len));
381 TALLOC_FREE(recv_iov);
382 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
383 smb2_transport_dead(transport, status);
384 return;
387 if (!lease && transport->oplock.handler) {
388 struct smb2_handle h;
389 uint8_t level;
391 level = CVAL(body, 0x02);
392 smb2_pull_handle(body+0x08, &h);
394 TALLOC_FREE(recv_iov);
396 transport->oplock.handler(transport, &h, level,
397 transport->oplock.private_data);
398 } else if (lease && transport->lease.handler) {
399 struct smb2_lease_break lb;
401 ZERO_STRUCT(lb);
402 lb.break_flags = SVAL(body, 0x4);
403 memcpy(&lb.current_lease.lease_key, body+0x8,
404 sizeof(struct smb2_lease_key));
405 lb.current_lease.lease_state = SVAL(body, 0x18);
406 lb.new_lease_state = SVAL(body, 0x1C);
407 lb.break_reason = SVAL(body, 0x20);
408 lb.access_mask_hint = SVAL(body, 0x24);
409 lb.share_mask_hint = SVAL(body, 0x28);
411 TALLOC_FREE(recv_iov);
413 transport->lease.handler(transport, &lb,
414 transport->lease.private_data);
415 } else {
416 DEBUG(5,("Got SMB2 %s break with no handler\n",
417 lease ? "lease" : "oplock"));
419 TALLOC_FREE(recv_iov);
422 NTSTATUS smb2_transport_compound_start(struct smb2_transport *transport,
423 uint32_t num)
425 TALLOC_FREE(transport->compound.reqs);
426 ZERO_STRUCT(transport->compound);
428 transport->compound.reqs = talloc_zero_array(transport,
429 struct tevent_req *,
430 num);
431 if (transport->compound.reqs == NULL) {
432 return NT_STATUS_NO_MEMORY;
435 return NT_STATUS_OK;
438 void smb2_transport_compound_set_related(struct smb2_transport *transport,
439 bool related)
441 transport->compound.related = related;
444 void smb2_transport_credits_ask_num(struct smb2_transport *transport,
445 uint16_t ask_num)
447 smb2cli_conn_set_max_credits(transport->conn, ask_num);
450 static void idle_handler(struct tevent_context *ev,
451 struct tevent_timer *te, struct timeval t, void *private_data)
453 struct smb2_transport *transport = talloc_get_type(private_data,
454 struct smb2_transport);
455 struct timeval next;
457 transport->idle.func(transport, transport->idle.private_data);
459 next = timeval_current_ofs_usec(transport->idle.period);
460 transport->idle.te = tevent_add_timer(transport->ev,
461 transport,
462 next,
463 idle_handler,
464 transport);
468 setup the idle handler for a transport
469 the period is in microseconds
471 void smb2_transport_idle_handler(struct smb2_transport *transport,
472 void (*idle_func)(struct smb2_transport *, void *),
473 uint64_t period,
474 void *private_data)
476 TALLOC_FREE(transport->idle.te);
478 transport->idle.func = idle_func;
479 transport->idle.private_data = private_data;
480 transport->idle.period = period;
482 transport->idle.te = tevent_add_timer(transport->ev,
483 transport,
484 timeval_current_ofs_usec(period),
485 idle_handler,
486 transport);