Introduced wrapper macros snew(), snewn() and sresize() for the
[u/mdw/putty] / winnet.c
index 1a80a80..6bb135c 100644 (file)
--- a/winnet.c
+++ b/winnet.c
 #include "network.h"
 #include "tree234.h"
 
+#define ipv4_is_loopback(addr) \
+       ((ntohl(addr.s_addr) & 0xFF000000L) == 0x7F000000L)
+
 struct Socket_tag {
-    struct socket_function_table *fn;
+    const struct socket_function_table *fn;
     /* the above variable absolutely *must* be the first in this structure */
     char *error;
     SOCKET s;
     Plug plug;
     void *private_ptr;
     bufchain output_data;
+    int connected;
     int writable;
     int frozen; /* this causes readability notifications to be ignored */
     int frozen_readable; /* this means we missed at least one readability
                          * notification while we were frozen */
+    int localhost_only;                       /* for listening sockets */
     char oobdata[1];
     int sending_oob;
     int oobinline;
+    int pending_error;                /* in case send() returns error */
 };
 
 /*
@@ -84,12 +90,18 @@ typedef struct Socket_tag *Actual_Socket;
 
 struct SockAddr_tag {
     char *error;
-    /* address family this belongs to, AF_INET for IPv4, AF_INET6 for IPv6. */
+    /* 
+     * Which address family this address belongs to. AF_INET for
+     * IPv4; AF_INET6 for IPv6; AF_UNSPEC indicates that name
+     * resolution has not been done and a simple host name is held
+     * in this SockAddr structure.
+     */
     int family;
     unsigned long address;            /* Address IPv4 style. */
 #ifdef IPV6
     struct addrinfo *ai;              /* Address IPv6 style. */
 #endif
+    char hostname[512];                       /* Store an unresolved host name. */
 };
 
 static tree234 *sktree;
@@ -121,6 +133,18 @@ void sk_init(void)
     sktree = newtree234(cmpfortree);
 }
 
+void sk_cleanup(void)
+{
+    Actual_Socket s;
+    int i;
+
+    if (sktree) {
+       for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
+           closesocket(s->s);
+       }
+    }
+}
+
 char *winsock_error_string(int error)
 {
     switch (error) {
@@ -200,9 +224,9 @@ char *winsock_error_string(int error)
     }
 }
 
-SockAddr sk_namelookup(char *host, char **canonicalname)
+SockAddr sk_namelookup(const char *host, char **canonicalname)
 {
-    SockAddr ret = smalloc(sizeof(struct SockAddr_tag));
+    SockAddr ret = snew(struct SockAddr_tag);
     unsigned long a;
     struct hostent *h = NULL;
     char realhost[8192];
@@ -333,11 +357,86 @@ SockAddr sk_namelookup(char *host, char **canonicalname)
     }
     ret->address = ntohl(a);
     realhost[lenof(realhost)-1] = '\0';
-    *canonicalname = smalloc(1+strlen(realhost));
+    *canonicalname = snewn(1+strlen(realhost), char);
     strcpy(*canonicalname, realhost);
     return ret;
 }
 
+SockAddr sk_nonamelookup(const char *host)
+{
+    SockAddr ret = snew(struct SockAddr_tag);
+    ret->error = NULL;
+    ret->family = AF_UNSPEC;
+    strncpy(ret->hostname, host, lenof(ret->hostname));
+    ret->hostname[lenof(ret->hostname)-1] = '\0';
+    return ret;
+}
+
+void sk_getaddr(SockAddr addr, char *buf, int buflen)
+{
+#ifdef IPV6
+    if (addr->family == AF_INET6) {
+       FIXME; /* I don't know how to get a text form of an IPv6 address. */
+    } else
+#endif
+    if (addr->family == AF_INET) {
+       struct in_addr a;
+       a.s_addr = htonl(addr->address);
+       strncpy(buf, inet_ntoa(a), buflen);
+       buf[buflen-1] = '\0';
+    } else {
+       assert(addr->family == AF_UNSPEC);
+       strncpy(buf, addr->hostname, buflen);
+       buf[buflen-1] = '\0';
+    }
+}
+
+int sk_hostname_is_local(char *name)
+{
+    return !strcmp(name, "localhost");
+}
+
+int sk_address_is_local(SockAddr addr)
+{
+#ifdef IPV6
+    if (addr->family == AF_INET6) {
+       FIXME;  /* someone who can compile for IPV6 had better do this bit */
+    } else
+#endif
+    if (addr->family == AF_INET) {
+       struct in_addr a;
+       a.s_addr = htonl(addr->address);
+       return ipv4_is_loopback(a);
+    } else {
+       assert(addr->family == AF_UNSPEC);
+       return 0;                      /* we don't know; assume not */
+    }
+}
+
+int sk_addrtype(SockAddr addr)
+{
+    return (addr->family == AF_INET ? ADDRTYPE_IPV4 :
+#ifdef IPV6
+           addr->family == AF_INET6 ? ADDRTYPE_IPV6 :
+#endif
+           ADDRTYPE_NAME);
+}
+
+void sk_addrcopy(SockAddr addr, char *buf)
+{
+    assert(addr->family != AF_UNSPEC);
+#ifdef IPV6
+    if (addr->family == AF_INET6) {
+       memcpy(buf, (char*) addr->ai, 16);
+    } else
+#endif
+    if (addr->family == AF_INET) {
+       struct in_addr a;
+       a.s_addr = htonl(addr->address);
+       memcpy(buf, (char*) &a.s_addr, 4);
+    }
+}
+
 void sk_addr_free(SockAddr addr)
 {
     sfree(addr);
@@ -361,20 +460,26 @@ static void sk_tcp_flush(Socket s)
 }
 
 static void sk_tcp_close(Socket s);
-static int sk_tcp_write(Socket s, char *data, int len);
-static int sk_tcp_write_oob(Socket s, char *data, int len);
+static int sk_tcp_write(Socket s, const char *data, int len);
+static int sk_tcp_write_oob(Socket s, const char *data, int len);
+static void sk_tcp_set_private_ptr(Socket s, void *ptr);
+static void *sk_tcp_get_private_ptr(Socket s);
+static void sk_tcp_set_frozen(Socket s, int is_frozen);
 static char *sk_tcp_socket_error(Socket s);
 
 extern char *do_select(SOCKET skt, int startup);
 
 Socket sk_register(void *sock, Plug plug)
 {
-    static struct socket_function_table fn_table = {
+    static const struct socket_function_table fn_table = {
        sk_tcp_plug,
        sk_tcp_close,
        sk_tcp_write,
        sk_tcp_write_oob,
        sk_tcp_flush,
+       sk_tcp_set_private_ptr,
+       sk_tcp_get_private_ptr,
+       sk_tcp_set_frozen,
        sk_tcp_socket_error
     };
 
@@ -385,7 +490,7 @@ Socket sk_register(void *sock, Plug plug)
     /*
      * Create Socket structure.
      */
-    ret = smalloc(sizeof(struct Socket_tag));
+    ret = snew(struct Socket_tag);
     ret->fn = &fn_table;
     ret->error = NULL;
     ret->plug = plug;
@@ -394,6 +499,8 @@ Socket sk_register(void *sock, Plug plug)
     ret->sending_oob = 0;
     ret->frozen = 1;
     ret->frozen_readable = 0;
+    ret->localhost_only = 0;          /* unused, but best init anyway */
+    ret->pending_error = 0;
 
     ret->s = (SOCKET)sock;
 
@@ -419,14 +526,17 @@ Socket sk_register(void *sock, Plug plug)
 }
 
 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
-             Plug plug)
+             int nodelay, Plug plug)
 {
-    static struct socket_function_table fn_table = {
+    static const struct socket_function_table fn_table = {
        sk_tcp_plug,
        sk_tcp_close,
        sk_tcp_write,
        sk_tcp_write_oob,
        sk_tcp_flush,
+       sk_tcp_set_private_ptr,
+       sk_tcp_get_private_ptr,
+       sk_tcp_set_frozen,
        sk_tcp_socket_error
     };
 
@@ -443,19 +553,23 @@ Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
     /*
      * Create Socket structure.
      */
-    ret = smalloc(sizeof(struct Socket_tag));
+    ret = snew(struct Socket_tag);
     ret->fn = &fn_table;
     ret->error = NULL;
     ret->plug = plug;
     bufchain_init(&ret->output_data);
-    ret->writable = 1;                /* to start with */
+    ret->connected = 0;                       /* to start with */
+    ret->writable = 0;                /* to start with */
     ret->sending_oob = 0;
     ret->frozen = 0;
     ret->frozen_readable = 0;
+    ret->localhost_only = 0;          /* unused, but best init anyway */
+    ret->pending_error = 0;
 
     /*
      * Open socket.
      */
+    assert(addr->family != AF_UNSPEC);
     s = socket(addr->family, SOCK_STREAM, 0);
     ret->s = s;
 
@@ -471,6 +585,11 @@ Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
        setsockopt(s, SOL_SOCKET, SO_OOBINLINE, (void *) &b, sizeof(b));
     }
 
+    if (nodelay) {
+       BOOL b = TRUE;
+       setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (void *) &b, sizeof(b));
+    }
+
     /*
      * Bind to local address.
      */
@@ -543,6 +662,15 @@ Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
        a.sin_addr.s_addr = htonl(addr->address);
        a.sin_port = htons((short) port);
     }
+
+    /* Set up a select mechanism. This could be an AsyncSelect on a
+     * window, or an EventSelect on an event object. */
+    errstr = do_select(s, 1);
+    if (errstr) {
+       ret->error = errstr;
+       return (Socket) ret;
+    }
+
     if ((
 #ifdef IPV6
            connect(s, ((addr->family == AF_INET6) ?
@@ -553,16 +681,22 @@ Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 #endif
        ) == SOCKET_ERROR) {
        err = WSAGetLastError();
-       ret->error = winsock_error_string(err);
-       return (Socket) ret;
-    }
-
-    /* Set up a select mechanism. This could be an AsyncSelect on a
-     * window, or an EventSelect on an event object. */
-    errstr = do_select(s, 1);
-    if (errstr) {
-       ret->error = errstr;
-       return (Socket) ret;
+       /*
+        * We expect a potential EWOULDBLOCK here, because the
+        * chances are the front end has done a select for
+        * FD_CONNECT, so that connect() will complete
+        * asynchronously.
+        */
+       if ( err != WSAEWOULDBLOCK ) {
+           ret->error = winsock_error_string(err);
+           return (Socket) ret;
+       }
+    } else {
+       /*
+        * If we _don't_ get EWOULDBLOCK, the connect has completed
+        * and we should set the socket as writable.
+        */
+       ret->writable = 1;
     }
 
     add234(sktree, ret);
@@ -570,14 +704,17 @@ Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
     return (Socket) ret;
 }
 
-Socket sk_newlistener(int port, Plug plug, int local_host_only)
+Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only)
 {
-    static struct socket_function_table fn_table = {
+    static const struct socket_function_table fn_table = {
        sk_tcp_plug,
        sk_tcp_close,
        sk_tcp_write,
        sk_tcp_write_oob,
        sk_tcp_flush,
+       sk_tcp_set_private_ptr,
+       sk_tcp_get_private_ptr,
+       sk_tcp_set_frozen,
        sk_tcp_socket_error
     };
 
@@ -595,7 +732,7 @@ Socket sk_newlistener(int port, Plug plug, int local_host_only)
     /*
      * Create Socket structure.
      */
-    ret = smalloc(sizeof(struct Socket_tag));
+    ret = snew(struct Socket_tag);
     ret->fn = &fn_table;
     ret->error = NULL;
     ret->plug = plug;
@@ -604,6 +741,8 @@ Socket sk_newlistener(int port, Plug plug, int local_host_only)
     ret->sending_oob = 0;
     ret->frozen = 0;
     ret->frozen_readable = 0;
+    ret->localhost_only = local_host_only;
+    ret->pending_error = 0;
 
     /*
      * Open socket.
@@ -619,14 +758,14 @@ Socket sk_newlistener(int port, Plug plug, int local_host_only)
 
     ret->oobinline = 0;
 
-
     setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char *)&on, sizeof(on));
 
-
 #ifdef IPV6
        if (addr->family == AF_INET6) {
            memset(&a6, 0, sizeof(a6));
            a6.sin6_family = AF_INET6;
+           /* FIXME: srcaddr is ignored for IPv6, because I (SGT) don't
+            * know how to do it. :-) */
            if (local_host_only)
                a6.sin6_addr = in6addr_loopback;
            else
@@ -635,11 +774,32 @@ Socket sk_newlistener(int port, Plug plug, int local_host_only)
        } else
 #endif
        {
+           int got_addr = 0;
            a.sin_family = AF_INET;
-           if (local_host_only)
-               a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
-           else
-               a.sin_addr.s_addr = htonl(INADDR_ANY);
+
+           /*
+            * Bind to source address. First try an explicitly
+            * specified one...
+            */
+           if (srcaddr) {
+               a.sin_addr.s_addr = inet_addr(srcaddr);
+               if (a.sin_addr.s_addr != INADDR_NONE) {
+                   /* Override localhost_only with specified listen addr. */
+                   ret->localhost_only = ipv4_is_loopback(a.sin_addr);
+                   got_addr = 1;
+               }
+           }
+
+           /*
+            * ... and failing that, go with one of the standard ones.
+            */
+           if (!got_addr) {
+               if (local_host_only)
+                   a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
+               else
+                   a.sin_addr.s_addr = htonl(INADDR_ANY);
+           }
+
            a.sin_port = htons((short)port);
        }
 #ifdef IPV6
@@ -713,7 +873,6 @@ void try_send(Actual_Socket s)
            urgentflag = 0;
            bufchain_prefix(&s->output_data, &data, &len);
        }
-
        nsent = send(s->s, data, len, urgentflag);
        noise_ultralight(nsent);
        if (nsent <= 0) {
@@ -733,19 +892,22 @@ void try_send(Actual_Socket s)
            } else if (nsent == 0 ||
                       err == WSAECONNABORTED || err == WSAECONNRESET) {
                /*
-                * FIXME. This will have to be done better when we
-                * start managing multiple sockets (e.g. SSH port
-                * forwarding), because if we get CONNRESET while
-                * trying to write a particular forwarded socket
-                * then it isn't necessarily the end of the world.
-                * Ideally I'd like to pass the error code back to
-                * somewhere the next select_result() will see it,
-                * but that might be hard. Perhaps I should pass it
-                * back to be queued in the Windows front end bit.
+                * If send() returns CONNABORTED or CONNRESET, we
+                * unfortunately can't just call plug_closing(),
+                * because it's quite likely that we're currently
+                * _in_ a call from the code we'd be calling back
+                * to, so we'd have to make half the SSH code
+                * reentrant. Instead we flag a pending error on
+                * the socket, to be dealt with (by calling
+                * plug_closing()) at some suitable future moment.
                 */
-               fatalbox(winsock_error_string(err));
+               s->pending_error = err;
+               return;
            } else {
-               fatalbox(winsock_error_string(err));
+               /* We're inside the Windows frontend here, so we know
+                * that the frontend handle is unnecessary. */
+               logevent(NULL, winsock_error_string(err));
+               fatalbox("%s", winsock_error_string(err));
            }
        } else {
            if (s->sending_oob) {
@@ -762,7 +924,7 @@ void try_send(Actual_Socket s)
     }
 }
 
-static int sk_tcp_write(Socket sock, char *buf, int len)
+static int sk_tcp_write(Socket sock, const char *buf, int len)
 {
     Actual_Socket s = (Actual_Socket) sock;
 
@@ -780,7 +942,7 @@ static int sk_tcp_write(Socket sock, char *buf, int len)
     return bufchain_size(&s->output_data);
 }
 
-static int sk_tcp_write_oob(Socket sock, char *buf, int len)
+static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
 {
     Actual_Socket s = (Actual_Socket) sock;
 
@@ -810,6 +972,10 @@ int select_result(WPARAM wParam, LPARAM lParam)
     u_long atmark;
 
     /* wParam is the socket itself */
+
+    if (wParam == 0)
+       return 1;                      /* boggle */
+
     s = find234(sktree, (void *) wParam, cmpforsearch);
     if (!s)
        return 1;                      /* boggle */
@@ -825,6 +991,9 @@ int select_result(WPARAM wParam, LPARAM lParam)
     noise_ultralight(lParam);
 
     switch (WSAGETSELECTEVENT(lParam)) {
+      case FD_CONNECT:
+       s->connected = s->writable = 1;
+       break;
       case FD_READ:
        /* In the case the socket is still frozen, we don't even bother */
        if (s->frozen) {
@@ -878,8 +1047,12 @@ int select_result(WPARAM wParam, LPARAM lParam)
        ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
        noise_ultralight(ret);
        if (ret <= 0) {
-           fatalbox(ret == 0 ? "Internal networking trouble" :
-                    winsock_error_string(WSAGetLastError()));
+           char *str = (ret == 0 ? "Internal networking trouble" :
+                        winsock_error_string(WSAGetLastError()));
+           /* We're inside the Windows frontend here, so we know
+            * that the frontend handle is unnecessary. */
+           logevent(NULL, str);
+           fatalbox("%s", str);
        } else {
            return plug_receive(s->plug, 2, buf, ret);
        }
@@ -916,13 +1089,13 @@ int select_result(WPARAM wParam, LPARAM lParam)
        return open;
        case FD_ACCEPT:
        {
-           struct sockaddr isa;
-           int addrlen = sizeof(struct sockaddr);
+           struct sockaddr_in isa;
+           int addrlen = sizeof(struct sockaddr_in);
            SOCKET t;  /* socket of connection */
 
-           memset(&isa, 0, sizeof(struct sockaddr));
+           memset(&isa, 0, sizeof(struct sockaddr_in));
            err = 0;
-           t = accept(s->s,&isa,&addrlen);
+           t = accept(s->s,(struct sockaddr *)&isa,&addrlen);
            if (t == INVALID_SOCKET)
            {
                err = WSAGetLastError();
@@ -930,7 +1103,9 @@ int select_result(WPARAM wParam, LPARAM lParam)
                    break;
            }
 
-           if (plug_accepting(s->plug, (void*)t)) {
+           if (s->localhost_only && !ipv4_is_loopback(isa.sin_addr)) {
+               closesocket(t);        /* dodgy WinSock let nonlocal through */
+           } else if (plug_accepting(s->plug, (void*)t)) {
                closesocket(t);        /* denied or error */
            }
        }
@@ -940,16 +1115,54 @@ int select_result(WPARAM wParam, LPARAM lParam)
 }
 
 /*
+ * Deal with socket errors detected in try_send().
+ */
+void net_pending_errors(void)
+{
+    int i;
+    Actual_Socket s;
+
+    /*
+     * This might be a fiddly business, because it's just possible
+     * that handling a pending error on one socket might cause
+     * others to be closed. (I can't think of any reason this might
+     * happen in current SSH implementation, but to maintain
+     * generality of this network layer I'll assume the worst.)
+     * 
+     * So what we'll do is search the socket list for _one_ socket
+     * with a pending error, and then handle it, and then search
+     * the list again _from the beginning_. Repeat until we make a
+     * pass with no socket errors present. That way we are
+     * protected against the socket list changing under our feet.
+     */
+
+    do {
+       for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
+           if (s->pending_error) {
+               /*
+                * An error has occurred on this socket. Pass it to the
+                * plug.
+                */
+               plug_closing(s->plug,
+                            winsock_error_string(s->pending_error),
+                            s->pending_error, 0);
+               break;
+           }
+       }
+    } while (s);
+}
+
+/*
  * Each socket abstraction contains a `void *' private field in
  * which the client can keep state.
  */
-void sk_set_private_ptr(Socket sock, void *ptr)
+static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
 {
     Actual_Socket s = (Actual_Socket) sock;
     s->private_ptr = ptr;
 }
 
-void *sk_get_private_ptr(Socket sock)
+static void *sk_tcp_get_private_ptr(Socket sock)
 {
     Actual_Socket s = (Actual_Socket) sock;
     return s->private_ptr;
@@ -970,7 +1183,7 @@ static char *sk_tcp_socket_error(Socket sock)
     return s->error;
 }
 
-void sk_set_frozen(Socket sock, int is_frozen)
+static void sk_tcp_set_frozen(Socket sock, int is_frozen)
 {
     Actual_Socket s = (Actual_Socket) sock;
     if (s->frozen == is_frozen)
@@ -999,3 +1212,13 @@ SOCKET next_socket(int *state)
     Actual_Socket s = index234(sktree, (*state)++);
     return s ? s->s : INVALID_SOCKET;
 }
+
+int net_service_lookup(char *service)
+{
+    struct servent *se;
+    se = getservbyname(service, NULL);
+    if (se != NULL)
+       return ntohs(se->s_port);
+    else
+       return 0;
+}