r26654: libcli/smb_composite: Rather than specifying each of the gazillion options...
[jelmer/samba4-debian.git] / source / libcli / raw / clitransport.c
index 1904618be93da8e28ae7c754485356a019db0b7c..62c32d305845908c9780278bd6845b322bad8131 100644 (file)
@@ -7,7 +7,7 @@
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
 #include "libcli/raw/libcliraw.h"
-#include "system/time.h"
-#include "dlinklist.h"
-#include "events.h"
+#include "lib/socket/socket.h"
+#include "lib/util/dlinklist.h"
+#include "lib/events/events.h"
+#include "lib/stream/packet.h"
+#include "librpc/gen_ndr/ndr_nbt.h"
+#include "param/param.h"
 
 
-static void smbcli_transport_process_recv(struct smbcli_transport *transport);
-static void smbcli_transport_process_send(struct smbcli_transport *transport);
-
 /*
   an event has happened on the socket
 */
-static void smbcli_transport_event_handler(struct event_context *ev, struct fd_event *fde, 
-                                          struct timeval t, uint16_t flags)
+static void smbcli_transport_event_handler(struct event_context *ev, 
+                                          struct fd_event *fde, 
+                                          uint16_t flags, void *private)
 {
-       struct smbcli_transport *transport = fde->private;
-
+       struct smbcli_transport *transport = talloc_get_type(private,
+                                                            struct smbcli_transport);
        if (flags & EVENT_FD_READ) {
-               smbcli_transport_process_recv(transport);
+               packet_recv(transport->packet);
                return;
        }
        if (flags & EVENT_FD_WRITE) {
-               smbcli_transport_process_send(transport);
+               packet_queue_run(transport->packet);
        }
 }
 
 /*
   destroy a transport
  */
-static int transport_destructor(void *ptr)
+static int transport_destructor(struct smbcli_transport *transport)
 {
-       struct smbcli_transport *transport = ptr;
-
-       smbcli_transport_dead(transport);
+       smbcli_transport_dead(transport, NT_STATUS_LOCAL_DISCONNECT);
        return 0;
 }
 
+
+/*
+  handle receive errors
+*/
+static void smbcli_transport_error(void *private, NTSTATUS status)
+{
+       struct smbcli_transport *transport = talloc_get_type(private, struct smbcli_transport);
+       smbcli_transport_dead(transport, status);
+}
+
+static NTSTATUS smbcli_transport_finish_recv(void *private, DATA_BLOB blob);
+
 /*
   create a transport structure based on an established socket
 */
 struct smbcli_transport *smbcli_transport_init(struct smbcli_socket *sock,
-                                              TALLOC_CTX *parent_ctx, BOOL primary)
+                                              TALLOC_CTX *parent_ctx, 
+                                              bool primary, 
+                                              struct smbcli_options *options)
 {
        struct smbcli_transport *transport;
 
@@ -75,22 +87,39 @@ struct smbcli_transport *smbcli_transport_init(struct smbcli_socket *sock,
                transport->socket = talloc_reference(transport, sock);
        }
        transport->negotiate.protocol = PROTOCOL_NT1;
-       transport->options.use_spnego = lp_use_spnego();
-       transport->options.max_xmit = lp_max_xmit();
-       transport->options.max_mux = lp_maxmux();
-
+       transport->options = *options;
        transport->negotiate.max_xmit = transport->options.max_xmit;
-       
+
+       /* setup the stream -> packet parser */
+       transport->packet = packet_init(transport);
+       if (transport->packet == NULL) {
+               talloc_free(transport);
+               return NULL;
+       }
+       packet_set_private(transport->packet, transport);
+       packet_set_socket(transport->packet, transport->socket->sock);
+       packet_set_callback(transport->packet, smbcli_transport_finish_recv);
+       packet_set_full_request(transport->packet, packet_full_request_nbt);
+       packet_set_error_handler(transport->packet, smbcli_transport_error);
+       packet_set_event_context(transport->packet, transport->socket->event.ctx);
+       packet_set_nofree(transport->packet);
+
        smbcli_init_signing(transport);
 
        ZERO_STRUCT(transport->called);
 
        /* take over event handling from the socket layer - it only
           handles events up until we are connected */
-       transport->socket->event.fde->handler = smbcli_transport_event_handler;
-       transport->socket->event.fde->private = transport;
-       transport->socket->event.fde->flags = EVENT_FD_READ;
-
+       talloc_free(transport->socket->event.fde);
+       transport->socket->event.fde = event_add_fd(transport->socket->event.ctx,
+                                                   transport->socket->sock,
+                                                   socket_get_fd(transport->socket->sock),
+                                                   EVENT_FD_READ,
+                                                   smbcli_transport_event_handler,
+                                                   transport);
+
+       packet_set_fde(transport->packet, transport->socket->event.fde);
+       packet_set_serialise(transport->packet);
        talloc_set_destructor(transport, transport_destructor);
 
        return transport;
@@ -99,26 +128,22 @@ struct smbcli_transport *smbcli_transport_init(struct smbcli_socket *sock,
 /*
   mark the transport as dead
 */
-void smbcli_transport_dead(struct smbcli_transport *transport)
+void smbcli_transport_dead(struct smbcli_transport *transport, NTSTATUS status)
 {
        smbcli_sock_dead(transport->socket);
 
-       /* all pending sends become errors */
-       while (transport->pending_send) {
-               struct smbcli_request *req = transport->pending_send;
-               req->state = SMBCLI_REQUEST_ERROR;
-               req->status = NT_STATUS_NET_WRITE_FAULT;
-               DLIST_REMOVE(transport->pending_send, req);
-               if (req->async.fn) {
-                       req->async.fn(req);
-               }
+       if (NT_STATUS_EQUAL(NT_STATUS_UNSUCCESSFUL, status)) {
+               status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
        }
 
-       /* as do all pending receives */
-       while (transport->pending_recv) {
+       /* kill only the first pending receive - this is so that if
+        that async function frees the connection we don't die trying
+        to use old memory. The caller has to cope with only one
+        network error */
+       if (transport->pending_recv) {
                struct smbcli_request *req = transport->pending_recv;
                req->state = SMBCLI_REQUEST_ERROR;
-               req->status = NT_STATUS_NET_WRITE_FAULT;
+               req->status = status;
                DLIST_REMOVE(transport->pending_recv, req);
                if (req->async.fn) {
                        req->async.fn(req);
@@ -127,22 +152,6 @@ void smbcli_transport_dead(struct smbcli_transport *transport)
 }
 
 
-/*
-  enable select for write on a transport
-*/
-static void smbcli_transport_write_enable(struct smbcli_transport *transport)
-{
-       transport->socket->event.fde->flags |= EVENT_FD_WRITE;
-}
-
-/*
-  disable select for write on a transport
-*/
-static void smbcli_transport_write_disable(struct smbcli_transport *transport)
-{
-       transport->socket->event.fde->flags &= ~EVENT_FD_WRITE;
-}
-
 /*
   send a session request
 */
@@ -179,7 +188,7 @@ struct smbcli_request *smbcli_transport_connect_send(struct smbcli_transport *tr
        memcpy(p, calling_blob.data, calling_blob.length);
        p += calling_blob.length;
 
-       _smb_setlen(req->out.buffer, PTR_DIFF(p, req->out.buffer)-4);
+       _smb_setlen(req->out.buffer, PTR_DIFF(p, req->out.buffer) - NBT_HDR_SIZE);
        SCVAL(req->out.buffer,0,0x81);
 
        if (!smbcli_request_send(req)) {
@@ -249,7 +258,7 @@ NTSTATUS smbcli_transport_connect_recv(struct smbcli_request *req)
 /*
   send a session request (if needed)
 */
-BOOL smbcli_transport_connect(struct smbcli_transport *transport,
+bool smbcli_transport_connect(struct smbcli_transport *transport,
                              struct nbt_name *calling, 
                              struct nbt_name *called)
 {
@@ -257,7 +266,7 @@ BOOL smbcli_transport_connect(struct smbcli_transport *transport,
        NTSTATUS status;
 
        if (transport->socket->port == 445) {
-               return True;
+               return true;
        }
 
        req = smbcli_transport_connect_send(transport, 
@@ -296,10 +305,15 @@ again:
 }
 
 static void idle_handler(struct event_context *ev, 
-                        struct timed_event *te, struct timeval t)
+                        struct timed_event *te, struct timeval t, void *private)
 {
-       struct smbcli_transport *transport = te->private;
-       te->next_event = timeval_add(&te->next_event, 0, transport->idle.period);
+       struct smbcli_transport *transport = talloc_get_type(private,
+                                                            struct smbcli_transport);
+       struct timeval next = timeval_add(&t, 0, transport->idle.period);
+       transport->socket->event.te = event_add_timed(transport->socket->event.ctx, 
+                                                     transport,
+                                                     next,
+                                                     idle_handler, transport);
        transport->idle.func(transport, transport->idle.private);
 }
 
@@ -312,7 +326,6 @@ void smbcli_transport_idle_handler(struct smbcli_transport *transport,
                                   uint64_t period,
                                   void *private)
 {
-       struct timed_event te;
        transport->idle.func = idle_func;
        transport->idle.private = private;
        transport->idle.period = period;
@@ -321,71 +334,35 @@ void smbcli_transport_idle_handler(struct smbcli_transport *transport,
                talloc_free(transport->socket->event.te);
        }
 
-       te.next_event = timeval_current_ofs(0, period);
-       te.handler = idle_handler;
-       te.private = transport;
        transport->socket->event.te = event_add_timed(transport->socket->event.ctx, 
-                                                     &te, transport);
-}
-
-/*
-  process some pending sends
-*/
-static void smbcli_transport_process_send(struct smbcli_transport *transport)
-{
-       while (transport->pending_send) {
-               struct smbcli_request *req = transport->pending_send;
-               ssize_t ret;
-               ret = smbcli_sock_write(transport->socket, req->out.buffer, req->out.size);
-               if (ret == -1) {
-                       if (errno == EAGAIN || errno == EINTR) {
-                               return;
-                       }
-                       smbcli_transport_dead(transport);
-                       return;
-               }
-               req->out.buffer += ret;
-               req->out.size -= ret;
-               if (req->out.size == 0) {
-                       DLIST_REMOVE(transport->pending_send, req);
-                       if (req->one_way_request) {
-                               req->state = SMBCLI_REQUEST_DONE;
-                               smbcli_request_destroy(req);
-                       } else {
-                               req->state = SMBCLI_REQUEST_RECV;
-                               DLIST_ADD(transport->pending_recv, req);
-                       }
-               }
-       }
-
-       /* we're out of requests to send, so don't wait for write
-          events any more */
-       smbcli_transport_write_disable(transport);
+                                                     transport,
+                                                     timeval_current_ofs(0, period),
+                                                     idle_handler, transport);
 }
 
 /*
   we have a full request in our receive buffer - match it to a pending request
   and process
  */
-static void smbcli_transport_finish_recv(struct smbcli_transport *transport)
+static NTSTATUS smbcli_transport_finish_recv(void *private, DATA_BLOB blob)
 {
+       struct smbcli_transport *transport = talloc_get_type(private, 
+                                                            struct smbcli_transport);
        uint8_t *buffer, *hdr, *vwv;
        int len;
-       uint16_t wct=0, mid = 0;
-       struct smbcli_request *req;
+       uint16_t wct=0, mid = 0, op = 0;
+       struct smbcli_request *req = NULL;
 
-       buffer = transport->recv_buffer.buffer;
-       len = transport->recv_buffer.req_size;
-
-       ZERO_STRUCT(transport->recv_buffer);
+       buffer = blob.data;
+       len = blob.length;
 
        hdr = buffer+NBT_HDR_SIZE;
        vwv = hdr + HDR_VWV;
 
        /* see if it could be an oplock break request */
-       if (handle_oplock_break(transport, len, hdr, vwv)) {
+       if (smbcli_handle_oplock_break(transport, len, hdr, vwv)) {
                talloc_free(buffer);
-               return;
+               return NT_STATUS_OK;
        }
 
        /* at this point we need to check for a readbraw reply, as
@@ -410,6 +387,7 @@ static void smbcli_transport_finish_recv(struct smbcli_transport *transport)
                /* extract the mid for matching to pending requests */
                mid = SVAL(hdr, HDR_MID);
                wct = CVAL(hdr, HDR_WCT);
+               op  = CVAL(hdr, HDR_COM);
        }
 
        /* match the incoming request against the list of pending requests */
@@ -417,9 +395,11 @@ static void smbcli_transport_finish_recv(struct smbcli_transport *transport)
                if (req->mid == mid) break;
        }
 
+       /* see if it's a ntcancel reply for the current MID */
+       req = smbcli_handle_ntcancel_reply(req, len, hdr);
+
        if (!req) {
-               DEBUG(1,("Discarding unmatched reply with mid %d op %d\n", 
-                        mid, CVAL(hdr, HDR_COM)));
+               DEBUG(1,("Discarding unmatched reply with mid %d op %d\n", mid, op));
                goto error;
        }
 
@@ -465,15 +445,22 @@ static void smbcli_transport_finish_recv(struct smbcli_transport *transport)
        req->flags2 = SVAL(req->in.hdr, HDR_FLG2);
 
        if (!(req->flags2 & FLAGS2_32_BIT_ERROR_CODES)) {
-               transport->error.etype = ETYPE_DOS;
-               transport->error.e.dos.eclass = CVAL(req->in.hdr,HDR_RCLS);
-               transport->error.e.dos.ecode = SVAL(req->in.hdr,HDR_ERR);
-               req->status = dos_to_ntstatus(transport->error.e.dos.eclass, 
-                                             transport->error.e.dos.ecode);
+               int class = CVAL(req->in.hdr,HDR_RCLS);
+               int code = SVAL(req->in.hdr,HDR_ERR);
+               if (class == 0 && code == 0) {
+                       transport->error.e.nt_status = NT_STATUS_OK;
+               } else {
+                       transport->error.e.nt_status = NT_STATUS_DOS(class, code);
+               }
        } else {
-               transport->error.etype = ETYPE_NT;
                transport->error.e.nt_status = NT_STATUS(IVAL(req->in.hdr, HDR_RCLS));
-               req->status = transport->error.e.nt_status;
+       }
+
+       req->status = transport->error.e.nt_status;
+       if (NT_STATUS_IS_OK(req->status)) {
+               transport->error.etype = ETYPE_NONE;
+       } else {
+               transport->error.etype = ETYPE_SMB;
        }
 
        if (!smbcli_request_check_sign_mac(req)) {
@@ -493,90 +480,84 @@ async:
        if (req->async.fn) {
                req->async.fn(req);
        }
-       return;
+       return NT_STATUS_OK;
 
 error:
        if (req) {
                DLIST_REMOVE(transport->pending_recv, req);
                req->state = SMBCLI_REQUEST_ERROR;
+               if (req->async.fn) {
+                       req->async.fn(req);
+               }
+       } else {
+               talloc_free(buffer);
        }
+       return NT_STATUS_OK;
 }
 
 /*
-  process some pending receives
+  process some read/write requests that are pending
+  return false if the socket is dead
 */
-static void smbcli_transport_process_recv(struct smbcli_transport *transport)
+bool smbcli_transport_process(struct smbcli_transport *transport)
 {
-       /* a incoming packet goes through 2 stages - first we read the
-          4 byte header, which tells us how much more is coming. Then
-          we read the rest */
-       if (transport->recv_buffer.received < NBT_HDR_SIZE) {
-               ssize_t ret;
-               ret = smbcli_sock_read(transport->socket, 
-                                   transport->recv_buffer.header + 
-                                   transport->recv_buffer.received,
-                                   NBT_HDR_SIZE - transport->recv_buffer.received);
-               if (ret == -1) {
-                       smbcli_transport_dead(transport);
-                       return;
-               }
+       NTSTATUS status;
+       size_t npending;
 
-               transport->recv_buffer.received += ret;
-
-               if (transport->recv_buffer.received == NBT_HDR_SIZE) {
-                       /* we've got a full header */
-                       transport->recv_buffer.req_size = smb_len(transport->recv_buffer.header) + NBT_HDR_SIZE;
-                       transport->recv_buffer.buffer = talloc_size(transport,
-                                                                   NBT_HDR_SIZE+transport->recv_buffer.req_size);
-                       if (transport->recv_buffer.buffer == NULL) {
-                               smbcli_transport_dead(transport);
-                               return;
-                       }
-                       memcpy(transport->recv_buffer.buffer, transport->recv_buffer.header, NBT_HDR_SIZE);
-               }
+       packet_queue_run(transport->packet);
+       if (transport->socket->sock == NULL) {
+               return false;
        }
 
-       if (transport->recv_buffer.received < transport->recv_buffer.req_size) {
-               ssize_t ret;
-               ret = smbcli_sock_read(transport->socket, 
-                                   transport->recv_buffer.buffer + 
-                                   transport->recv_buffer.received,
-                                   transport->recv_buffer.req_size - 
-                                   transport->recv_buffer.received);
-               if (ret == -1) {
-                       smbcli_transport_dead(transport);
-                       return;
-               }
-               transport->recv_buffer.received += ret;
+       status = socket_pending(transport->socket->sock, &npending);
+       if (NT_STATUS_IS_OK(status) && npending > 0) {
+               packet_recv(transport->packet);
        }
-
-       if (transport->recv_buffer.received != 0 &&
-           transport->recv_buffer.received == transport->recv_buffer.req_size) {
-               smbcli_transport_finish_recv(transport);
+       if (transport->socket->sock == NULL) {
+               return false;
        }
+       return true;
 }
 
 /*
-  process some read/write requests that are pending
-  return False if the socket is dead
+  handle timeouts of individual smb requests
 */
-BOOL smbcli_transport_process(struct smbcli_transport *transport)
+static void smbcli_timeout_handler(struct event_context *ev, struct timed_event *te, 
+                                  struct timeval t, void *private)
 {
-       smbcli_transport_process_send(transport);
-       smbcli_transport_process_recv(transport);
-       if (transport->socket->sock == NULL) {
-               return False;
+       struct smbcli_request *req = talloc_get_type(private, struct smbcli_request);
+
+       if (req->state == SMBCLI_REQUEST_RECV) {
+               DLIST_REMOVE(req->transport->pending_recv, req);
+       }
+       req->status = NT_STATUS_IO_TIMEOUT;
+       req->state = SMBCLI_REQUEST_ERROR;
+       if (req->async.fn) {
+               req->async.fn(req);
        }
-       return True;
 }
 
 
+/*
+  destroy a request
+*/
+static int smbcli_request_destructor(struct smbcli_request *req)
+{
+       if (req->state == SMBCLI_REQUEST_RECV) {
+               DLIST_REMOVE(req->transport->pending_recv, req);
+       }
+       return 0;
+}
+
 
 /*
   put a request into the send queue
 */
 void smbcli_transport_send(struct smbcli_request *req)
 {
+       DATA_BLOB blob;
+       NTSTATUS status;
+
        /* check if the transport is dead */
        if (req->transport->socket->sock == NULL) {
                req->state = SMBCLI_REQUEST_ERROR;
@@ -584,10 +565,97 @@ void smbcli_transport_send(struct smbcli_request *req)
                return;
        }
 
-       /* put it on the outgoing socket queue */
-       req->state = SMBCLI_REQUEST_SEND;
-       DLIST_ADD_END(req->transport->pending_send, req, struct smbcli_request *);
+       blob = data_blob_const(req->out.buffer, req->out.size);
+       status = packet_send(req->transport->packet, blob);
+       if (!NT_STATUS_IS_OK(status)) {
+               req->state = SMBCLI_REQUEST_ERROR;
+               req->status = status;
+               return;
+       }
+
+       if (req->one_way_request) {
+               req->state = SMBCLI_REQUEST_DONE;
+               smbcli_request_destroy(req);
+               return;
+       }
+
+       req->state = SMBCLI_REQUEST_RECV;
+       DLIST_ADD(req->transport->pending_recv, req);
 
-       /* make sure we look for write events */
-       smbcli_transport_write_enable(req->transport);
+       /* add a timeout */
+       if (req->transport->options.request_timeout) {
+               event_add_timed(req->transport->socket->event.ctx, req, 
+                               timeval_current_ofs(req->transport->options.request_timeout, 0), 
+                               smbcli_timeout_handler, req);
+       }
+
+       talloc_set_destructor(req, smbcli_request_destructor);
+}
+
+
+/****************************************************************************
+ Send an SMBecho (async send)
+*****************************************************************************/
+struct smbcli_request *smb_raw_echo_send(struct smbcli_transport *transport,
+                                        struct smb_echo *p)
+{
+       struct smbcli_request *req;
+
+       req = smbcli_request_setup_transport(transport, SMBecho, 1, p->in.size);
+       if (!req) return NULL;
+
+       SSVAL(req->out.vwv, VWV(0), p->in.repeat_count);
+
+       memcpy(req->out.data, p->in.data, p->in.size);
+
+       ZERO_STRUCT(p->out);
+
+       if (!smbcli_request_send(req)) {
+               smbcli_request_destroy(req);
+               return NULL;
+       }
+
+       return req;
+}
+
+/****************************************************************************
+ raw echo interface (async recv)
+****************************************************************************/
+NTSTATUS smb_raw_echo_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx,
+                          struct smb_echo *p)
+{
+       if (!smbcli_request_receive(req) ||
+           smbcli_request_is_error(req)) {
+               goto failed;
+       }
+
+       SMBCLI_CHECK_WCT(req, 1);
+       p->out.count++;
+       p->out.sequence_number = SVAL(req->in.vwv, VWV(0));
+       p->out.size = req->in.data_size;
+       talloc_free(p->out.data);
+       p->out.data = talloc_array(mem_ctx, uint8_t, p->out.size);
+       NT_STATUS_HAVE_NO_MEMORY(p->out.data);
+
+       if (!smbcli_raw_pull_data(req, req->in.data, p->out.size, p->out.data)) {
+               req->status = NT_STATUS_BUFFER_TOO_SMALL;
+       }
+
+       if (p->out.count == p->in.repeat_count) {
+               return smbcli_request_destroy(req);
+       }
+
+       return NT_STATUS_OK;
+
+failed:
+       return smbcli_request_destroy(req);
+}
+
+/****************************************************************************
+ Send a echo (sync interface)
+*****************************************************************************/
+NTSTATUS smb_raw_echo(struct smbcli_transport *transport, struct smb_echo *p)
+{
+       struct smbcli_request *req = smb_raw_echo_send(transport, p);
+       return smbcli_request_simple_recv(req);
 }