net: Split makesock(), part 1: Introduce lookup_address().
[paraslash.git] / net.c
diff --git a/net.c b/net.c
index 64602a4bf60e7ce934f230cb0ae9d63f5ec404f5..ccb9632de9a30f566450cea2e4a62e29bd0c530f 100644 (file)
--- a/net.c
+++ b/net.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 #define AI_ADDRCONFIG 0
 #endif
 
-#include <dirent.h>
 #include <regex.h>
-#include <openssl/rc4.h>
 
 #include "para.h"
 #include "error.h"
-#include "crypt.h"
 #include "net.h"
 #include "string.h"
 #include "list.h"
@@ -145,9 +142,9 @@ static bool host_string_ok(const char *host)
  * \param hostlen The maximum length of \a host.
  * \param port   To return the port number (if any) of \a url.
  *
- * \return Pointer to \a host, or NULL if failed.
- * If NULL is returned, \a host and \a portnum are undefined. If no
- * port number was present in \a url, \a portnum is set to -1.
+ * \return Pointer to \a host, or \p NULL if failed.  If \p NULL is returned,
+ * \a host and \a port are undefined. If no port number was present in \a url,
+ * \a port is set to -1.
  *
  * \sa RFC 3986, 3.2.2/3.2.3
  */
@@ -171,16 +168,16 @@ char *parse_url(const char *url,
                if (*o++ != ']' || (*o != '\0' && *o != ':'))
                        goto failed;
        } else {
-               for (; (*c = *o == ':'? '\0' : *o); c++, o++)
-                       if (c == end)
+               for (; (*c = *o == ':'? '\0' : *o); c++, o++) {
+                       if (c == end && o[1])
                                goto failed;
+               }
        }
 
        if (*o == ':')
                if (para_atoi32(++o, port) < 0 ||
                    *port < 0 || *port > 0xffff)
                        goto failed;
-
        if (host_string_ok(host))
                return host;
 failed:
@@ -267,6 +264,12 @@ struct flowopts {
        struct list_head sockopts;
 };
 
+/**
+ * Allocate and initialize a flowopt queue.
+ *
+ * \return A new structure to be passed to \ref flowopt_add(). It is
+ * automatically deallocated in \ref makesock().
+ */
 struct flowopts *flowopt_new(void)
 {
        struct flowopts *new = para_malloc(sizeof(*new));
@@ -288,7 +291,7 @@ struct flowopts *flowopt_new(void)
  *  \sa setsockopt(2)
  */
 void flowopt_add(struct flowopts *fo, int lev, int opt,
-                char *name, const void *val, int len)
+               const char *name, const void *val, int len)
 {
        struct pre_conn_opt *new = para_malloc(sizeof(*new));
 
@@ -308,14 +311,6 @@ void flowopt_add(struct flowopts *fo, int lev, int opt,
        list_add_tail(&new->node, &fo->sockopts);
 }
 
-void flowopt_add_bool(struct flowopts *fo, int lev, int opt,
-                     char *optname, bool on_or_off)
-{
-       int on = on_or_off;     /* kernel takes 'int' */
-
-       flowopt_add(fo, lev, opt, optname, &on, sizeof(on));
-}
-
 /** Set the entire bunch of pre-connection options at once. */
 static void flowopt_setopts(int sockfd, struct flowopts *fo)
 {
@@ -348,75 +343,91 @@ static void flowopt_cleanup(struct flowopts *fo)
        free(fo);
 }
 
-/**
- * Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
+/*
+ * Resolve an IPv4/IPv6 address.
  *
  * \param l4type The layer-4 type (\p IPPROTO_xxx).
- * \param passive Whether this is a passive (1) or active (0) socket.
+ * \param passive Whether \p AI_PASSIVE should be included as hint.
  * \param host Remote or local hostname or IPv/6 address string.
- * \param port_number Decimal port number.
- * \param fo Socket options to be set before making the connection.
+ * \param port_number Used to set the port in each returned address structure.
+ * \param result addrinfo structures are returned here.
  *
- * This creates a ready-made IPv4/v6 socket structure after looking up the
- * necessary parameters. The interpretation of \a host depends on the value of
- * \a passive:
- *     - on a passive socket host is interpreted as an interface IPv4/6 address
- *       (can be left NULL);
- *     - on an active socket, \a host is the peer DNS name or IPv4/6 address
- *       to connect to;
- *     - \a port_number is in either case the numeric port number (not service
- *       string).
- *
- * Furthermore, bind(2) is called on passive sockets, and connect(2) on active
- * sockets. The algorithm tries all possible address combinations until it
- * succeeds. If \a fo is supplied, options are set and cleanup is performed.
- *
- * \return This function returns 1 on success and \a -E_ADDRESS_LOOKUP when no
- * matching connection could be set up (with details in the error log).
- *
- *  \sa ipv6(7), getaddrinfo(3), bind(2), connect(2).
+ * The interpretation of \a host depends on the value of \a passive. On a
+ * passive socket host is interpreted as an interface IPv4/6 address (can be
+ * left NULL). On an active socket, \a host is the peer DNS name or IPv4/6
+ * address to connect to.
+ *
+ * \return Standard.
+ *
+ * \sa getaddrinfo(3).
  */
-int makesock(unsigned l4type, bool passive,
-            const char *host, uint16_t port_number,
-            struct flowopts *fo)
+static int lookup_address(unsigned l4type, bool passive, const char *host,
+               int port_number, struct addrinfo **result)
 {
-       struct addrinfo *local = NULL, *src,
-                       *remote = NULL, *dst, hints;
-       unsigned int    l3type = AF_UNSPEC;
-       int             rc, on = 1, sockfd = -1,
-                       socktype = sock_type(l4type);
+       int ret;
        char port[6]; /* port number has at most 5 digits */
+       struct addrinfo *addr = NULL, hints;
 
-       sprintf(port, "%u", port_number);
+       *result = NULL;
+       sprintf(port, "%u", port_number & 0xffff);
        /* Set up address hint structure */
        memset(&hints, 0, sizeof(hints));
-       hints.ai_family = l3type;
-       hints.ai_socktype = socktype;
-       /* 
+       hints.ai_family = AF_UNSPEC;
+       hints.ai_socktype = sock_type(l4type);
+       /*
         * getaddrinfo does not support SOCK_DCCP, so for the sake of lookup
         * (and only then) pretend to be UDP.
         */
        if (l4type == IPPROTO_DCCP)
                hints.ai_socktype = SOCK_DGRAM;
-
        /* only use addresses available on the host */
        hints.ai_flags = AI_ADDRCONFIG;
-       if (l3type == AF_INET6)
-               /* use v4-mapped-v6 if no v6 addresses found */
-               hints.ai_flags |= AI_V4MAPPED | AI_ALL;
-
        if (passive && host == NULL)
                hints.ai_flags |= AI_PASSIVE;
-
        /* Obtain local/remote address information */
-       if ((rc = getaddrinfo(host, port, &hints, passive ? &local : &remote))) {
-               PARA_ERROR_LOG("can not resolve %s address %s#%s: %s.\n",
-                               layer4_name(l4type),
-                               host? host : (passive? "[loopback]" : "[localhost]"),
-                               port, gai_strerror(rc));
+       ret = getaddrinfo(host, port, &hints, &addr);
+       if (ret != 0) {
+               PARA_ERROR_LOG("can not resolve %s address %s#%s: %s\n",
+                       layer4_name(l4type),
+                       host? host : (passive? "[loopback]" : "[localhost]"),
+                       port, gai_strerror(ret));
                return -E_ADDRESS_LOOKUP;
        }
+       *result = addr;
+       return 1;
+}
 
+/**
+ * Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
+ *
+ * \param l4type The layer-4 type (\p IPPROTO_xxx).
+ * \param passive Whether this is a passive or active socket.
+ * \param host Passed to \ref \a lookup_address().
+ * \param port_number Passed to \ref \a lookup_address().
+ * \param fo Socket options to be set before making the connection.
+ *
+ * This creates a ready-made IPv4/v6 socket structure after looking up the
+ * necessary parameters.
+ *
+ * bind(2) is called on passive sockets, and connect(2) on active sockets. The
+ * algorithm tries all possible address combinations until it succeeds. If \a
+ * fo is supplied, options are set and cleanup is performed.
+ *
+ * \return Standard.
+ *
+ *  \sa \ref lookup_address(), ipv6(7), getaddrinfo(3), bind(2), connect(2).
+ */
+int makesock(unsigned l4type, bool passive,
+            const char *host, uint16_t port_number,
+            struct flowopts *fo)
+{
+       struct addrinfo *local = NULL, *src = NULL, *remote = NULL, *dst = NULL;
+       int rc, on = 1, sockfd = -1;
+
+       rc = lookup_address(l4type, passive, host, port_number, passive?
+               &local : &remote);
+       if (rc < 0)
+               goto out;
        /* Iterate over all src/dst combination, exhausting dst first */
        for (src = local, dst = remote; src != NULL || dst != NULL; /* no op */ ) {
                if (src && dst && src->ai_family == AF_INET
@@ -424,7 +435,7 @@ int makesock(unsigned l4type, bool passive,
                        goto get_next_dst; /* v4 -> v6 is not possible */
 
                sockfd = socket(src ? src->ai_family : dst->ai_family,
-                       socktype, l4type);
+                       sock_type(l4type), l4type);
                if (sockfd < 0)
                        goto get_next_dst;
 
@@ -439,7 +450,8 @@ int makesock(unsigned l4type, bool passive,
                        close(sockfd);
                        PARA_ERROR_LOG("can not set SO_REUSEADDR: %s\n",
                                       strerror(rc));
-                       return -ERRNO_TO_PARA_ERROR(rc);
+                       rc = -ERRNO_TO_PARA_ERROR(rc);
+                       break;
                }
                flowopt_setopts(sockfd, fo);
 
@@ -462,6 +474,7 @@ get_next_src:
                if (src && (src = src->ai_next)) /* restart inner loop */
                        dst = remote;
        }
+out:
        if (local)
                freeaddrinfo(local);
        if (remote)
@@ -469,11 +482,12 @@ get_next_src:
        flowopt_cleanup(fo);
 
        if (src == NULL && dst == NULL) {
-               rc = errno;
-               PARA_ERROR_LOG("can not create %s socket %s#%s.\n",
+               if (rc >= 0)
+                       rc = -E_MAKESOCK;
+               PARA_ERROR_LOG("can not create %s socket %s#%d.\n",
                        layer4_name(l4type), host? host : (passive?
-                       "[loopback]" : "[localhost]"), port);
-               return -ERRNO_TO_PARA_ERROR(rc);
+                       "[loopback]" : "[localhost]"), port_number);
+               return rc;
        }
        return sockfd;
 }
@@ -575,8 +589,14 @@ static inline int estimated_header_overhead(const int af_type)
 }
 
 /**
- * Maximum transport-layer message size (MMS_S) as per RFC 1122, 3.3.3
- * Socket must be connected.
+ * Get the maximum transport-layer message size (MMS_S).
+ *
+ * \param sockfd The socket file descriptor.
+ *
+ * The socket must be connected. See RFC 1122, 3.3.3. If the protocol familiy
+ * could not be determined, \p AF_INET is assumed.
+ *
+ * \return The maximum message size of the address family type.
  */
 int generic_max_transport_msg_size(int sockfd)
 {
@@ -593,37 +613,6 @@ int generic_max_transport_msg_size(int sockfd)
        return generic_mtu(af_type) - estimated_header_overhead(af_type);
 }
 
-/**
- * Print numeric host and port number (beware - uses static char).
- *
- * \param sa The IPv4/IPv6 socket address to use.
- *
- * \return Host string in numeric host:port format, \sa parse_url().
- * \sa getnameinfo(3), services(5), nsswitch.conf(5)
- */
-static char *host_and_port(const struct sockaddr_storage *ss)
-{
-       const struct sockaddr *sa = normalize_ip_address(ss);
-       char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
-       static char output[sizeof(hbuf) + sizeof(sbuf) + 4];
-       int ret;
-
-       ret = getnameinfo(sa, salen(sa),
-                         hbuf, sizeof(hbuf),
-                         sbuf, sizeof(sbuf),
-                         NI_NUMERICHOST | NI_NUMERICSERV);
-       if (ret) {
-               snprintf(output, sizeof(output), "(unknown)");
-               PARA_WARNING_LOG("hostname lookup error (%s).\n",
-                                gai_strerror(ret));
-       } else if (sa->sa_family == AF_INET6) {
-               snprintf(output, sizeof(output), "[%s]:%s", hbuf, sbuf);
-       } else {
-               snprintf(output, sizeof(output), "%s:%s", hbuf, sbuf);
-       }
-       return output;
-}
-
 /**
  * Look up the local or remote side of a connected socket structure.
  *
@@ -632,23 +621,38 @@ static char *host_and_port(const struct sockaddr_storage *ss)
  * remote side.
  *
  * \return A static character string identifying hostname and port of the
- * chosen side.
+ * chosen side in numeric host:port format.
  *
- * \sa getsockname(2), getpeername(2).
+ * \sa getsockname(2), getpeername(2), parse_url(), getnameinfo(3),
+ * services(5), nsswitch.conf(5).
  */
-static char *__get_sock_name(int fd, int (*getname)(int, struct sockaddr*,
-               socklen_t *))
+static char *__get_sock_name(int fd, typeof(getsockname) getname)
 {
        struct sockaddr_storage ss;
+       const struct sockaddr *sa;
        socklen_t sslen = sizeof(ss);
+       char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
+       static char output[sizeof(hbuf) + sizeof(sbuf) + 4];
+       int ret;
 
        if (getname(fd, (struct sockaddr *)&ss, &sslen) < 0) {
-               static char *dont_know = "(don't know)";
                PARA_ERROR_LOG("can not determine address from fd %d: %s\n",
                        fd, strerror(errno));
-               return dont_know;
+               snprintf(output, sizeof(output), "(unknown)");
+               return output;
        }
-       return host_and_port(&ss);
+       sa = normalize_ip_address(&ss);
+       ret = getnameinfo(sa, salen(sa), hbuf, sizeof(hbuf), sbuf,
+               sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV);
+       if (ret) {
+               PARA_WARNING_LOG("hostname lookup error (%s).\n",
+                       gai_strerror(ret));
+               snprintf(output, sizeof(output), "(lookup error)");
+       } else if (sa->sa_family == AF_INET6)
+               snprintf(output, sizeof(output), "[%s]:%s", hbuf, sbuf);
+       else
+               snprintf(output, sizeof(output), "%s:%s", hbuf, sbuf);
+       return output;
 }
 
 /**
@@ -683,72 +687,19 @@ char *remote_name(int sockfd)
 
 /**
  * Extract IPv4 or IPv6-mapped-IPv4 address from sockaddr_storage.
- * \param ss Container of IPv4/6 address
- * \return Extracted IPv4 address (different from 0) or 0 if unsuccessful.
  *
- * \sa RFC 3493
+ * \param ss Container of IPv4/6 address.
+ * \param ia Extracted IPv4 address (different from 0) or 0 if unsuccessful.
+ *
+ * \sa RFC 3493.
  */
-struct in_addr extract_v4_addr(const struct sockaddr_storage *ss)
+void extract_v4_addr(const struct sockaddr_storage *ss, struct in_addr *ia)
 {
-       struct in_addr ia = {.s_addr = 0};
        const struct sockaddr *sa = normalize_ip_address(ss);
 
+       memset(ia, 0, sizeof(*ia));
        if (sa->sa_family == AF_INET)
-               ia = ((struct sockaddr_in *)sa)->sin_addr;
-       return ia;
-}
-
-/**
- * Send a binary buffer.
- *
- * \param fd The file descriptor.
- * \param buf The buffer to be sent.
- * \param len The length of \a buf.
- *
- * Send out the buffer and try to resend the remaining part in case of short
- * writes.
- *
- * \return Standard.
- */
-int send_bin_buffer(int fd, const char *buf, size_t len)
-{
-       if (!len)
-               PARA_CRIT_LOG("len == 0\n");
-       return write_all(fd, buf, &len);
-}
-
-/**
- * Send a \p NULL-terminated buffer.
- *
- * \param fd The file descriptor.
- * \param buf The null-terminated buffer to be send.
- *
- * This is equivalent to send_bin_buffer(fd, buf, strlen(buf)).
- *
- * \return Standard.
- */
-int send_buffer(int fd, const char *buf)
-{
-       return send_bin_buffer(fd, buf, strlen(buf));
-}
-
-/**
- * Send a buffer given by a format string.
- *
- * \param fd The file descriptor.
- * \param fmt A format string.
- *
- * \return Standard.
- */
-__printf_2_3 int send_va_buffer(int fd, const char *fmt, ...)
-{
-       char *msg;
-       int ret;
-
-       PARA_VSPRINTF(fmt, msg);
-       ret = send_buffer(fd, msg);
-       free(msg);
-       return ret;
+               *ia = ((struct sockaddr_in *)sa)->sin_addr;
 }
 
 /**
@@ -971,7 +922,7 @@ err:
 #ifndef HAVE_UCRED
 ssize_t send_cred_buffer(int sock, char *buf)
 {
-       return send_buffer(sock, buf);
+       return write_buffer(sock, buf);
 }
 int recv_cred_buffer(int fd, char *buf, size_t size)
 {