2 Unix SMB/CIFS implementation.
3 SMB client transport context management functions
5 Copyright (C) Andrew Tridgell 1994-2005
6 Copyright (C) James Myers 2003 <myersjj@samba.org>
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 2 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, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "libcli/raw/libcliraw.h"
25 #include "lib/socket/socket.h"
26 #include "dlinklist.h"
27 #include "lib/events/events.h"
28 #include "lib/stream/packet.h"
32 an event has happened on the socket
34 static void smbcli_transport_event_handler(struct event_context *ev,
36 uint16_t flags, void *private)
38 struct smbcli_transport *transport = talloc_get_type(private,
39 struct smbcli_transport);
40 if (flags & EVENT_FD_READ) {
41 packet_recv(transport->packet);
44 if (flags & EVENT_FD_WRITE) {
45 packet_queue_run(transport->packet);
52 static int transport_destructor(void *ptr)
54 struct smbcli_transport *transport = ptr;
56 smbcli_transport_dead(transport);
64 static void smbcli_transport_error(void *private, NTSTATUS status)
66 struct smbcli_transport *transport = talloc_get_type(private, struct smbcli_transport);
67 smbcli_transport_dead(transport);
70 static NTSTATUS smbcli_transport_finish_recv(void *private, DATA_BLOB blob);
73 create a transport structure based on an established socket
75 struct smbcli_transport *smbcli_transport_init(struct smbcli_socket *sock,
76 TALLOC_CTX *parent_ctx, BOOL primary)
78 struct smbcli_transport *transport;
80 transport = talloc_zero(parent_ctx, struct smbcli_transport);
81 if (!transport) return NULL;
84 transport->socket = talloc_steal(transport, sock);
86 transport->socket = talloc_reference(transport, sock);
88 transport->negotiate.protocol = PROTOCOL_NT1;
89 transport->options.use_spnego = lp_use_spnego() && lp_nt_status_support();
90 transport->options.max_xmit = lp_max_xmit();
91 transport->options.max_mux = lp_maxmux();
92 transport->options.request_timeout = SMB_REQUEST_TIMEOUT;
94 transport->negotiate.max_xmit = transport->options.max_xmit;
96 /* setup the stream -> packet parser */
97 transport->packet = packet_init(transport);
98 if (transport->packet == NULL) {
99 talloc_free(transport);
102 packet_set_private(transport->packet, transport);
103 packet_set_socket(transport->packet, transport->socket->sock);
104 packet_set_callback(transport->packet, smbcli_transport_finish_recv);
105 packet_set_full_request(transport->packet, packet_full_request_nbt);
106 packet_set_error_handler(transport->packet, smbcli_transport_error);
107 packet_set_event_context(transport->packet, transport->socket->event.ctx);
108 packet_set_nofree(transport->packet);
110 smbcli_init_signing(transport);
112 ZERO_STRUCT(transport->called);
114 /* take over event handling from the socket layer - it only
115 handles events up until we are connected */
116 talloc_free(transport->socket->event.fde);
117 transport->socket->event.fde = event_add_fd(transport->socket->event.ctx,
119 socket_get_fd(transport->socket->sock),
121 smbcli_transport_event_handler,
124 packet_set_serialise(transport->packet, transport->socket->event.fde);
126 talloc_set_destructor(transport, transport_destructor);
132 mark the transport as dead
134 void smbcli_transport_dead(struct smbcli_transport *transport)
136 smbcli_sock_dead(transport->socket);
138 /* kill all pending receives */
139 while (transport->pending_recv) {
140 struct smbcli_request *req = transport->pending_recv;
141 req->state = SMBCLI_REQUEST_ERROR;
142 req->status = NT_STATUS_NET_WRITE_FAULT;
143 DLIST_REMOVE(transport->pending_recv, req);
152 send a session request
154 struct smbcli_request *smbcli_transport_connect_send(struct smbcli_transport *transport,
155 struct nbt_name *calling,
156 struct nbt_name *called)
159 struct smbcli_request *req;
160 DATA_BLOB calling_blob, called_blob;
161 TALLOC_CTX *tmp_ctx = talloc_new(transport);
164 status = nbt_name_dup(transport, called, &transport->called);
165 if (!NT_STATUS_IS_OK(status)) goto failed;
167 status = nbt_name_to_blob(tmp_ctx, &calling_blob, calling);
168 if (!NT_STATUS_IS_OK(status)) goto failed;
170 status = nbt_name_to_blob(tmp_ctx, &called_blob, called);
171 if (!NT_STATUS_IS_OK(status)) goto failed;
173 /* allocate output buffer */
174 req = smbcli_request_setup_nonsmb(transport,
176 calling_blob.length + called_blob.length);
177 if (req == NULL) goto failed;
179 /* put in the destination name */
180 p = req->out.buffer + NBT_HDR_SIZE;
181 memcpy(p, called_blob.data, called_blob.length);
182 p += called_blob.length;
184 memcpy(p, calling_blob.data, calling_blob.length);
185 p += calling_blob.length;
187 _smb_setlen(req->out.buffer, PTR_DIFF(p, req->out.buffer)-4);
188 SCVAL(req->out.buffer,0,0x81);
190 if (!smbcli_request_send(req)) {
191 smbcli_request_destroy(req);
195 talloc_free(tmp_ctx);
199 talloc_free(tmp_ctx);
204 map a session request error to a NTSTATUS
206 static NTSTATUS map_session_refused_error(uint8_t error)
211 return NT_STATUS_REMOTE_NOT_LISTENING;
213 return NT_STATUS_RESOURCE_NAME_NOT_FOUND;
215 return NT_STATUS_REMOTE_RESOURCES;
217 return NT_STATUS_UNEXPECTED_IO_ERROR;
222 finish a smbcli_transport_connect()
224 NTSTATUS smbcli_transport_connect_recv(struct smbcli_request *req)
228 if (!smbcli_request_receive(req)) {
229 smbcli_request_destroy(req);
230 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
233 switch (CVAL(req->in.buffer,0)) {
235 status = NT_STATUS_OK;
238 status = map_session_refused_error(CVAL(req->in.buffer,4));
241 DEBUG(1,("Warning: session retarget not supported\n"));
242 status = NT_STATUS_NOT_SUPPORTED;
245 status = NT_STATUS_UNEXPECTED_IO_ERROR;
249 smbcli_request_destroy(req);
255 send a session request (if needed)
257 BOOL smbcli_transport_connect(struct smbcli_transport *transport,
258 struct nbt_name *calling,
259 struct nbt_name *called)
261 struct smbcli_request *req;
264 if (transport->socket->port == 445) {
268 req = smbcli_transport_connect_send(transport,
270 status = smbcli_transport_connect_recv(req);
271 return NT_STATUS_IS_OK(status);
274 /****************************************************************************
275 get next mid in sequence
276 ****************************************************************************/
277 uint16_t smbcli_transport_next_mid(struct smbcli_transport *transport)
280 struct smbcli_request *req;
282 mid = transport->next_mid;
285 /* now check to see if this mid is being used by one of the
286 pending requests. This is quite efficient because the list is
287 usually very short */
289 /* the zero mid is reserved for requests that don't have a mid */
290 if (mid == 0) mid = 1;
292 for (req=transport->pending_recv; req; req=req->next) {
293 if (req->mid == mid) {
299 transport->next_mid = mid+1;
303 static void idle_handler(struct event_context *ev,
304 struct timed_event *te, struct timeval t, void *private)
306 struct smbcli_transport *transport = talloc_get_type(private,
307 struct smbcli_transport);
308 struct timeval next = timeval_add(&t, 0, transport->idle.period);
309 transport->socket->event.te = event_add_timed(transport->socket->event.ctx,
312 idle_handler, transport);
313 transport->idle.func(transport, transport->idle.private);
317 setup the idle handler for a transport
318 the period is in microseconds
320 void smbcli_transport_idle_handler(struct smbcli_transport *transport,
321 void (*idle_func)(struct smbcli_transport *, void *),
325 transport->idle.func = idle_func;
326 transport->idle.private = private;
327 transport->idle.period = period;
329 if (transport->socket->event.te != NULL) {
330 talloc_free(transport->socket->event.te);
333 transport->socket->event.te = event_add_timed(transport->socket->event.ctx,
335 timeval_current_ofs(0, period),
336 idle_handler, transport);
340 we have a full request in our receive buffer - match it to a pending request
343 static NTSTATUS smbcli_transport_finish_recv(void *private, DATA_BLOB blob)
345 struct smbcli_transport *transport = talloc_get_type(private,
346 struct smbcli_transport);
347 uint8_t *buffer, *hdr, *vwv;
349 uint16_t wct=0, mid = 0, op = 0;
350 struct smbcli_request *req;
355 hdr = buffer+NBT_HDR_SIZE;
358 /* see if it could be an oplock break request */
359 if (handle_oplock_break(transport, len, hdr, vwv)) {
364 /* at this point we need to check for a readbraw reply, as
365 these can be any length */
366 if (transport->readbraw_pending) {
367 transport->readbraw_pending = 0;
369 /* it must match the first entry in the pending queue
370 as the client is not allowed to have outstanding
372 req = transport->pending_recv;
373 if (!req) goto error;
375 req->in.buffer = buffer;
376 talloc_steal(req, buffer);
378 req->in.allocated = req->in.size;
382 if (len >= MIN_SMB_SIZE) {
383 /* extract the mid for matching to pending requests */
384 mid = SVAL(hdr, HDR_MID);
385 wct = CVAL(hdr, HDR_WCT);
386 op = CVAL(hdr, HDR_COM);
389 /* match the incoming request against the list of pending requests */
390 for (req=transport->pending_recv; req; req=req->next) {
391 if (req->mid == mid) break;
395 DEBUG(1,("Discarding unmatched reply with mid %d op %d\n", mid, op));
399 /* fill in the 'in' portion of the matching request */
400 req->in.buffer = buffer;
401 talloc_steal(req, buffer);
403 req->in.allocated = req->in.size;
405 /* handle NBT session replies */
406 if (req->in.size >= 4 && req->in.buffer[0] != 0) {
407 req->status = NT_STATUS_OK;
411 /* handle non-SMB replies */
412 if (req->in.size < NBT_HDR_SIZE + MIN_SMB_SIZE) {
413 req->state = SMBCLI_REQUEST_ERROR;
417 if (req->in.size < NBT_HDR_SIZE + MIN_SMB_SIZE + VWV(wct)) {
418 DEBUG(2,("bad reply size for mid %d\n", mid));
419 req->status = NT_STATUS_UNSUCCESSFUL;
420 req->state = SMBCLI_REQUEST_ERROR;
427 if (req->in.size >= NBT_HDR_SIZE + MIN_SMB_SIZE + VWV(wct)) {
428 req->in.data = req->in.vwv + VWV(wct) + 2;
429 req->in.data_size = SVAL(req->in.vwv, VWV(wct));
430 if (req->in.size < NBT_HDR_SIZE + MIN_SMB_SIZE + VWV(wct) + req->in.data_size) {
431 DEBUG(3,("bad data size for mid %d\n", mid));
432 /* blergh - w2k3 gives a bogus data size values in some
434 req->in.data_size = req->in.size - (NBT_HDR_SIZE + MIN_SMB_SIZE + VWV(wct));
437 req->in.ptr = req->in.data;
438 req->flags2 = SVAL(req->in.hdr, HDR_FLG2);
440 if (!(req->flags2 & FLAGS2_32_BIT_ERROR_CODES)) {
441 int class = CVAL(req->in.hdr,HDR_RCLS);
442 int code = SVAL(req->in.hdr,HDR_ERR);
443 if (class == 0 && code == 0) {
444 transport->error.e.nt_status = NT_STATUS_OK;
446 transport->error.e.nt_status = NT_STATUS_DOS(class, code);
449 transport->error.e.nt_status = NT_STATUS(IVAL(req->in.hdr, HDR_RCLS));
452 req->status = transport->error.e.nt_status;
453 if (NT_STATUS_IS_OK(req->status)) {
454 transport->error.etype = ETYPE_NONE;
456 transport->error.etype = ETYPE_SMB;
459 if (!smbcli_request_check_sign_mac(req)) {
460 transport->error.etype = ETYPE_SOCKET;
461 transport->error.e.socket_error = SOCKET_READ_BAD_SIG;
462 req->state = SMBCLI_REQUEST_ERROR;
463 req->status = NT_STATUS_ACCESS_DENIED;
468 /* if this request has an async handler then call that to
469 notify that the reply has been received. This might destroy
470 the request so it must happen last */
471 DLIST_REMOVE(transport->pending_recv, req);
472 req->state = SMBCLI_REQUEST_DONE;
480 DLIST_REMOVE(transport->pending_recv, req);
481 req->state = SMBCLI_REQUEST_ERROR;
487 process some read/write requests that are pending
488 return False if the socket is dead
490 BOOL smbcli_transport_process(struct smbcli_transport *transport)
495 packet_queue_run(transport->packet);
496 if (transport->socket->sock == NULL) {
500 status = socket_pending(transport->socket->sock, &npending);
501 if (NT_STATUS_IS_OK(status) && npending > 0) {
502 packet_recv(transport->packet);
504 if (transport->socket->sock == NULL) {
511 handle timeouts of individual smb requests
513 static void smbcli_timeout_handler(struct event_context *ev, struct timed_event *te,
514 struct timeval t, void *private)
516 struct smbcli_request *req = talloc_get_type(private, struct smbcli_request);
518 if (req->state == SMBCLI_REQUEST_SEND) {
519 DLIST_REMOVE(req->transport->pending_send, req);
521 if (req->state == SMBCLI_REQUEST_RECV) {
522 DLIST_REMOVE(req->transport->pending_recv, req);
524 req->status = NT_STATUS_IO_TIMEOUT;
525 req->state = SMBCLI_REQUEST_ERROR;
535 static int smbcli_request_destructor(void *ptr)
537 struct smbcli_request *req = talloc_get_type(ptr, struct smbcli_request);
538 if (req->state == SMBCLI_REQUEST_SEND) {
539 DLIST_REMOVE(req->transport->pending_send, req);
541 if (req->state == SMBCLI_REQUEST_RECV) {
542 DLIST_REMOVE(req->transport->pending_recv, req);
549 put a request into the send queue
551 void smbcli_transport_send(struct smbcli_request *req)
556 /* check if the transport is dead */
557 if (req->transport->socket->sock == NULL) {
558 req->state = SMBCLI_REQUEST_ERROR;
559 req->status = NT_STATUS_NET_WRITE_FAULT;
563 blob = data_blob_const(req->out.buffer, req->out.size);
564 status = packet_send(req->transport->packet, blob);
565 if (!NT_STATUS_IS_OK(status)) {
566 req->state = SMBCLI_REQUEST_ERROR;
567 req->status = status;
571 if (req->one_way_request) {
572 req->state = SMBCLI_REQUEST_DONE;
573 smbcli_request_destroy(req);
577 req->state = SMBCLI_REQUEST_RECV;
578 DLIST_ADD(req->transport->pending_recv, req);
581 if (req->transport->options.request_timeout) {
582 event_add_timed(req->transport->socket->event.ctx, req,
583 timeval_current_ofs(req->transport->options.request_timeout, 0),
584 smbcli_timeout_handler, req);
587 talloc_set_destructor(req, smbcli_request_destructor);