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 "libcli/raw/libcliraw.h"
24 #include "libcli/smb2/smb2.h"
25 #include "libcli/smb2/smb2_calls.h"
26 #include "lib/socket/socket.h"
27 #include "lib/events/events.h"
28 #include "lib/stream/packet.h"
29 #include "lib/util/dlinklist.h"
33 an event has happened on the socket
35 static void smb2_transport_event_handler(struct event_context *ev,
37 uint16_t flags, void *private)
39 struct smb2_transport *transport = talloc_get_type(private,
40 struct smb2_transport);
41 if (flags & EVENT_FD_READ) {
42 packet_recv(transport->packet);
45 if (flags & EVENT_FD_WRITE) {
46 packet_queue_run(transport->packet);
53 static int transport_destructor(struct smb2_transport *transport)
55 smb2_transport_dead(transport, NT_STATUS_LOCAL_DISCONNECT);
63 static void smb2_transport_error(void *private, NTSTATUS status)
65 struct smb2_transport *transport = talloc_get_type(private,
66 struct smb2_transport);
67 smb2_transport_dead(transport, status);
70 static NTSTATUS smb2_transport_finish_recv(void *private, DATA_BLOB blob);
73 create a transport structure based on an established socket
75 struct smb2_transport *smb2_transport_init(struct smbcli_socket *sock,
76 TALLOC_CTX *parent_ctx)
78 struct smb2_transport *transport;
80 transport = talloc_zero(parent_ctx, struct smb2_transport);
81 if (!transport) return NULL;
83 transport->socket = talloc_steal(transport, sock);
85 /* setup the stream -> packet parser */
86 transport->packet = packet_init(transport);
87 if (transport->packet == NULL) {
88 talloc_free(transport);
91 packet_set_private(transport->packet, transport);
92 packet_set_socket(transport->packet, transport->socket->sock);
93 packet_set_callback(transport->packet, smb2_transport_finish_recv);
94 packet_set_full_request(transport->packet, packet_full_request_nbt);
95 packet_set_error_handler(transport->packet, smb2_transport_error);
96 packet_set_event_context(transport->packet, transport->socket->event.ctx);
97 packet_set_nofree(transport->packet);
99 /* take over event handling from the socket layer - it only
100 handles events up until we are connected */
101 talloc_free(transport->socket->event.fde);
102 transport->socket->event.fde = event_add_fd(transport->socket->event.ctx,
104 socket_get_fd(transport->socket->sock),
106 smb2_transport_event_handler,
109 packet_set_fde(transport->packet, transport->socket->event.fde);
110 packet_set_serialise(transport->packet);
112 talloc_set_destructor(transport, transport_destructor);
114 transport->options.timeout = 30;
120 mark the transport as dead
122 void smb2_transport_dead(struct smb2_transport *transport, NTSTATUS status)
124 smbcli_sock_dead(transport->socket);
126 if (NT_STATUS_EQUAL(NT_STATUS_UNSUCCESSFUL, status)) {
127 status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
130 /* kill all pending receives */
131 while (transport->pending_recv) {
132 struct smb2_request *req = transport->pending_recv;
133 req->state = SMB2_REQUEST_ERROR;
134 req->status = status;
135 DLIST_REMOVE(transport->pending_recv, req);
143 we have a full request in our receive buffer - match it to a pending request
146 static NTSTATUS smb2_transport_finish_recv(void *private, DATA_BLOB blob)
148 struct smb2_transport *transport = talloc_get_type(private,
149 struct smb2_transport);
150 uint8_t *buffer, *hdr;
152 struct smb2_request *req = NULL;
155 uint16_t buffer_code;
156 uint32_t dynamic_size;
162 hdr = buffer+NBT_HDR_SIZE;
164 if (len < SMB2_MIN_SIZE) {
165 DEBUG(1,("Discarding smb2 reply of size %d\n", len));
169 flags = IVAL(hdr, SMB2_HDR_FLAGS);
170 seqnum = BVAL(hdr, SMB2_HDR_MESSAGE_ID);
172 /* match the incoming request against the list of pending requests */
173 for (req=transport->pending_recv; req; req=req->next) {
174 if (req->seqnum == seqnum) break;
178 DEBUG(1,("Discarding unmatched reply with seqnum 0x%llx op %d\n",
179 (long long)seqnum, SVAL(hdr, SMB2_HDR_OPCODE)));
183 /* fill in the 'in' portion of the matching request */
184 req->in.buffer = buffer;
185 talloc_steal(req, buffer);
187 req->in.allocated = req->in.size;
190 req->in.body = hdr+SMB2_HDR_BODY;
191 req->in.body_size = req->in.size - (SMB2_HDR_BODY+NBT_HDR_SIZE);
192 req->status = NT_STATUS(IVAL(hdr, SMB2_HDR_STATUS));
194 if (NT_STATUS_EQUAL(req->status, STATUS_PENDING)) {
195 if (flags & 0x00000002) {
196 req->cancel.can_cancel = true;
197 req->cancel.pending_id = IVAL(hdr, SMB2_HDR_PID);
198 for (i=0; i< req->cancel.do_cancel; i++) {
206 buffer_code = SVAL(req->in.body, 0);
207 req->in.body_fixed = (buffer_code & ~1);
208 req->in.dynamic = NULL;
209 dynamic_size = req->in.body_size - req->in.body_fixed;
210 if (dynamic_size != 0 && (buffer_code & 1)) {
211 req->in.dynamic = req->in.body + req->in.body_fixed;
212 if (smb2_oob(&req->in, req->in.dynamic, dynamic_size)) {
213 DEBUG(1,("SMB2 request invalid dynamic size 0x%x\n",
219 smb2_setup_bufinfo(req);
221 DEBUG(2, ("SMB2 RECV seqnum=0x%llx\n", (long long)req->seqnum));
222 dump_data(5, req->in.body, req->in.body_size);
224 /* if this request has an async handler then call that to
225 notify that the reply has been received. This might destroy
226 the request so it must happen last */
227 DLIST_REMOVE(transport->pending_recv, req);
228 req->state = SMB2_REQUEST_DONE;
235 dump_data(5, buffer, len);
237 DLIST_REMOVE(transport->pending_recv, req);
238 req->state = SMB2_REQUEST_ERROR;
245 return NT_STATUS_UNSUCCESSFUL;
249 handle timeouts of individual smb requests
251 static void smb2_timeout_handler(struct event_context *ev, struct timed_event *te,
252 struct timeval t, void *private)
254 struct smb2_request *req = talloc_get_type(private, struct smb2_request);
256 if (req->state == SMB2_REQUEST_RECV) {
257 DLIST_REMOVE(req->transport->pending_recv, req);
259 req->status = NT_STATUS_IO_TIMEOUT;
260 req->state = SMB2_REQUEST_ERROR;
270 static int smb2_request_destructor(struct smb2_request *req)
272 if (req->state == SMB2_REQUEST_RECV) {
273 DLIST_REMOVE(req->transport->pending_recv, req);
280 put a request into the send queue
282 void smb2_transport_send(struct smb2_request *req)
287 _smb2_setlen(req->out.buffer, req->out.size - NBT_HDR_SIZE);
289 DEBUG(2, ("SMB2 send seqnum=0x%llx\n", (long long)req->seqnum));
290 dump_data(5, req->out.body, req->out.body_size);
292 /* check if the transport is dead */
293 if (req->transport->socket->sock == NULL) {
294 req->state = SMB2_REQUEST_ERROR;
295 req->status = NT_STATUS_NET_WRITE_FAULT;
299 blob = data_blob_const(req->out.buffer, req->out.size);
300 status = packet_send(req->transport->packet, blob);
301 if (!NT_STATUS_IS_OK(status)) {
302 req->state = SMB2_REQUEST_ERROR;
303 req->status = status;
307 req->state = SMB2_REQUEST_RECV;
308 DLIST_ADD(req->transport->pending_recv, req);
311 if (req->transport->options.timeout) {
312 event_add_timed(req->transport->socket->event.ctx, req,
313 timeval_current_ofs(req->transport->options.timeout, 0),
314 smb2_timeout_handler, req);
317 talloc_set_destructor(req, smb2_request_destructor);
320 static void idle_handler(struct event_context *ev,
321 struct timed_event *te, struct timeval t, void *private)
323 struct smb2_transport *transport = talloc_get_type(private,
324 struct smb2_transport);
325 struct timeval next = timeval_add(&t, 0, transport->idle.period);
326 transport->socket->event.te = event_add_timed(transport->socket->event.ctx,
329 idle_handler, transport);
330 transport->idle.func(transport, transport->idle.private);
334 setup the idle handler for a transport
335 the period is in microseconds
337 void smb2_transport_idle_handler(struct smb2_transport *transport,
338 void (*idle_func)(struct smb2_transport *, void *),
342 transport->idle.func = idle_func;
343 transport->idle.private = private;
344 transport->idle.period = period;
346 if (transport->socket->event.te != NULL) {
347 talloc_free(transport->socket->event.te);
350 transport->socket->event.te = event_add_timed(transport->socket->event.ctx,
352 timeval_current_ofs(0, period),
353 idle_handler, transport);