Merge branch 'refs/heads/t/openssl-header-check'
[paraslash.git] / net.c
diff --git a/net.c b/net.c
index 1369498905faa4ab729bac8209a6a03e8b920063..91200fc040bcfebafccf9e737fb65514af9ff8f2 100644 (file)
--- a/net.c
+++ b/net.c
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file net.c Networking-related helper functions. */
 
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <netdb.h>
-
-/* At least NetBSD needs these. */
-#ifndef AI_V4MAPPED
-#define AI_V4MAPPED 0
-#endif
-#ifndef AI_ALL
-#define AI_ALL 0
-#endif
-#ifndef AI_ADDRCONFIG
-#define AI_ADDRCONFIG 0
-#endif
-
 #include <regex.h>
 
 #include "error.h"
@@ -44,7 +28,7 @@
  *               default of 32 if not specified.
  *
  * \return Pointer to \a addr if successful, NULL on error.
- * \sa RFC 4632
+ * \sa RFC 4632.
  */
 char *parse_cidr(const char *cidr,
                 char    *addr, ssize_t addrlen,
@@ -104,7 +88,7 @@ static bool is_v4_dot_quad(const char *address)
  * \param host The host string to check.
  * \return True if \a host passes the syntax checks.
  *
- * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5
+ * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5.
  */
 static bool host_string_ok(const char *host)
 {
@@ -146,7 +130,7 @@ static bool host_string_ok(const char *host)
  * \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
+ * \sa RFC 3986, 3.2.2/3.2.3.
  */
 char *parse_url(const char *url,
                char    *host, ssize_t hostlen,
@@ -184,6 +168,36 @@ failed:
        return NULL;
 }
 
+/**
+ * Pretty-print a host/port pair.
+ *
+ * \param url NULL, or any string accepted by \ref parse_url().
+ * \param default_port Applies if url has no port.
+ *
+ * If the url argument is NULL, the function returns the string
+ * 0.0.0.0:default_port. Otherwise it calls \ref parse_url() to check the
+ * syntax of the input string given by url. On errors the string "?" is
+ * returned. Otherwise, if url contains a port, a copy of url is returned. If
+ * no port was supplied, a colon and the default port are appended to url.
+ *
+ * \return In all cases the returned string is a allocated with malloc(3) and
+ * has to be freed by the caller.
+ */
+char *format_url(const char *url, int default_port)
+{
+       char host[MAX_HOSTLEN];
+       int url_port;
+
+       if (!url)
+               return make_message("0.0.0.0:%d", default_port);
+       if (!parse_url(url, host, sizeof(host), &url_port))
+               return make_message("?");
+       if (url_port < 0)
+               return make_message("%s:%d", url, default_port);
+       else
+               return para_strdup(url);
+}
+
 /**
  * Stringify port number, resolve into service name where defined.
  *
@@ -191,7 +205,7 @@ failed:
  * \param transport Transport protocol name (e.g. "udp", "tcp"), or NULL.
  * \return Pointer to static result buffer.
  *
- * \sa getservent(3), services(5), nsswitch.conf(5)
+ * \sa getservent(3), services(5), nsswitch.conf(5).
  */
 const char *stringify_port(int port, const char *transport)
 {
@@ -215,7 +229,7 @@ const char *stringify_port(int port, const char *transport)
  *
  * \param l4type The symbolic name of the transport-layer protocol.
  *
- * \sa ip(7), socket(2)
+ * \sa ip(7), socket(2).
  */
 static inline int sock_type(const unsigned l4type)
 {
@@ -247,7 +261,7 @@ static const char *layer4_name(const unsigned l4type)
  * directly after makesock(). The 'pre_conn_opt' structure is for internal use
  * only and should not be visible elsewhere.
  *
- * \sa setsockopt(2), makesock()
+ * \sa setsockopt(2), \ref makesock().
  */
 struct pre_conn_opt {
        int             sock_level;     /**< Second argument to setsockopt() */
@@ -288,7 +302,7 @@ struct flowopts *flowopt_new(void)
  * \param val  The value to set \a opt to.
  * \param len  Length of \a val.
  *
- *  \sa setsockopt(2)
+ *  \sa setsockopt(2).
  */
 void flowopt_add(struct flowopts *fo, int lev, int opt,
                const char *name, const void *val, int len)
@@ -376,7 +390,7 @@ int lookup_address(unsigned l4type, bool passive, const char *host,
        struct addrinfo *addr = NULL, hints;
 
        *result = NULL;
-       sprintf(port, "%u", port_number & 0xffff);
+       sprintf(port, "%d", port_number & 0xffff);
        /* Set up address hint structure */
        memset(&hints, 0, sizeof(hints));
        hints.ai_family = AF_UNSPEC;
@@ -429,15 +443,20 @@ int makesock_addrinfo(unsigned l4type, bool passive, struct addrinfo *ai,
        for (; ai; ai = ai->ai_next) {
                int fd;
                ret = socket(ai->ai_family, sock_type(l4type), l4type);
-               if (ret < 0)
+               if (ret < 0) {
+                       PARA_NOTICE_LOG("socket(): %s\n", strerror(errno));
                        continue;
+               }
                fd = ret;
                flowopt_setopts(fd, fo);
                if (!passive) {
-                       if (connect(fd, ai->ai_addr, ai->ai_addrlen) == 0)
-                               return fd;
-                       close(fd);
-                       continue;
+                       if (connect(fd, ai->ai_addr, ai->ai_addrlen) < 0) {
+                               PARA_NOTICE_LOG("connect(): %s\n",
+                                       strerror(errno));
+                               close(fd);
+                               continue;
+                       }
+                       return fd;
                }
                /*
                 * Reuse the address on passive sockets to avoid failure on
@@ -446,10 +465,12 @@ int makesock_addrinfo(unsigned l4type, bool passive, struct addrinfo *ai,
                 */
                if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &on,
                                sizeof(on)) == -1) {
+                       PARA_NOTICE_LOG("setsockopt(): %s\n", strerror(errno));
                        close(fd);
                        continue;
                }
                if (bind(fd, ai->ai_addr, ai->ai_addrlen) < 0) {
+                       PARA_NOTICE_LOG("bind(): %s\n", strerror(errno));
                        close(fd);
                        continue;
                }
@@ -499,18 +520,28 @@ int makesock(unsigned l4type, bool passive, const char *host, uint16_t port_numb
  * Create a passive / listening socket.
  *
  * \param l4type The transport-layer type (\p IPPROTO_xxx).
- * \param port The decimal port number to listen on.
- * \param fo Flowopts (if any) to set before starting to listen.
+ * \param addr Passed to \ref parse_url() if not NULL.
+ * \param port Ignored if addr contains a port number.
  *
  * \return Positive integer (socket descriptor) on success, negative value
  * otherwise.
  *
- * \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
+ * \sa \ref makesock(), ip(7), ipv6(7), bind(2), listen(2).
  */
-int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
+int para_listen(unsigned l4type, const char *addr, uint16_t port)
 {
-       int ret, fd = makesock(l4type, 1, NULL, port, fo);
-
+       char host[MAX_HOSTLEN];
+       int ret, fd, addr_port;
+
+       if (addr) {
+               if (!parse_url(addr, host, sizeof(host), &addr_port))
+                       return -ERRNO_TO_PARA_ERROR(EINVAL);
+               if (addr_port > 0)
+                       port = addr_port;
+               addr = host;
+       }
+       fd = makesock(l4type, true /* passive */, addr, port,
+               NULL /* no flowopts */);
        if (fd > 0) {
                ret = listen(fd, BACKLOG);
                if (ret < 0) {
@@ -524,6 +555,22 @@ int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
        return fd;
 }
 
+/**
+ * Create a socket which listens on all network addresses.
+ *
+ * \param l4type See \ref para_listen().
+ * \param port See \ref para_listen().
+ *
+ * This is a simple wrapper for \ref para_listen() which passes a NULL pointer
+ * as the address information.
+ *
+ * \return See \ref para_listen().
+ */
+int para_listen_simple(unsigned l4type, uint16_t port)
+{
+       return para_listen(l4type, NULL, port);
+}
+
 /**
  * Determine IPv4/v6 socket address length.
  * \param sa Container of IPv4 or IPv6 address.
@@ -551,7 +598,7 @@ static bool SS_IS_ADDR_V4MAPPED(const struct sockaddr_storage *ss)
  * \param ss Container of IPv4/6 address.
  * \return Pointer to normalized address (may be static storage).
  *
- * \sa RFC 3493
+ * \sa RFC 3493.
  */
 static const struct sockaddr *
 normalize_ip_address(const struct sockaddr_storage *ss)
@@ -603,7 +650,7 @@ static inline int estimated_header_overhead(const int af_type)
  */
 int generic_max_transport_msg_size(int sockfd)
 {
-       struct sockaddr_storage ss;
+       struct sockaddr_storage ss = {.ss_family = 0};
        socklen_t sslen = sizeof(ss);
        int af_type = AF_INET;
 
@@ -624,12 +671,12 @@ int generic_max_transport_msg_size(int sockfd)
  * \return A static character string identifying hostname and port of the
  * chosen side in numeric host:port format.
  *
- * \sa getsockname(2), getpeername(2), parse_url(), getnameinfo(3),
+ * \sa getsockname(2), getpeername(2), \ref parse_url(), getnameinfo(3),
  * services(5), nsswitch.conf(5).
  */
 char *remote_name(int fd)
 {
-       struct sockaddr_storage ss;
+       struct sockaddr_storage ss = {.ss_family = 0};
        const struct sockaddr *sa;
        socklen_t sslen = sizeof(ss);
        char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
@@ -735,7 +782,7 @@ __must_check int recv_bin_buffer(int fd, char *buf, size_t size)
  *
  * \return The return value of the underlying call to \a recv_bin_buffer().
  *
- * \sa recv_bin_buffer()
+ * \sa \ref recv_bin_buffer()
  */
 int recv_buffer(int fd, char *buf, size_t size)
 {
@@ -818,25 +865,40 @@ int dccp_available_ccids(uint8_t **ccid_array)
        return nccids;
 }
 
-/**
- * Prepare a structure for \p AF_UNIX socket addresses.
- *
- * \param u Pointer to the struct to be prepared.
- * \param name The socket pathname.
+/*
+ * Prepare a structure for AF_UNIX socket addresses.
  *
- * This just copies \a name to the sun_path component of \a u.
+ * This just copies name to the sun_path component of u, prepending a zero byte
+ * if abstract sockets are supported.
  *
- * \return Positive on success, \p -E_NAME_TOO_LONG if \a name is longer
- * than \p UNIX_PATH_MAX.
+ * The first call to this function tries to bind a socket to the abstract name
+ * space. The result of this test is stored in a static variable. Subsequent
+ * calls read this variable and create abstract sockets on systems that support
+ * them. If a NULL pointer is passed as the name, the function only
+ * initializes the static variable.
  */
-static int init_unix_addr(struct sockaddr_un *u, const char *name,
-               bool abstract)
+static int init_unix_addr(struct sockaddr_un *u, const char *name)
 {
-       if (strlen(name) + abstract >= UNIX_PATH_MAX)
-               return -E_NAME_TOO_LONG;
+       static int use_abstract;
+
        memset(u->sun_path, 0, UNIX_PATH_MAX);
        u->sun_family = PF_UNIX;
-       strcpy(u->sun_path + abstract, name);
+       if (use_abstract == 0) { /* executed only once */
+               int fd = socket(PF_UNIX, SOCK_STREAM, 0);
+               memcpy(u->sun_path, "\0x\0", 3);
+               if (bind(fd, (struct sockaddr *)u, sizeof(*u)) == 0)
+                       use_abstract = 1; /* yes */
+               else
+                       use_abstract = -1; /* no */
+               close(fd);
+               PARA_NOTICE_LOG("%susing abstract socket namespace\n",
+                       use_abstract == 1? "" : "not ");
+       }
+       if (!name)
+               return 0;
+       if (strlen(name) + 1 >= UNIX_PATH_MAX)
+               return -E_NAME_TOO_LONG;
+       strcpy(u->sun_path + (use_abstract == 1? 1 : 0), name);
        return 1;
 }
 
@@ -844,29 +906,23 @@ static int init_unix_addr(struct sockaddr_un *u, const char *name,
  * Create a socket for local communication and listen on it.
  *
  * \param name The socket pathname.
- * \param mode The desired permissions of the socket.
  *
  * This function creates a passive local socket for sequenced, reliable,
  * two-way, connection-based byte streams. The socket file descriptor is set to
  * nonblocking mode and listen(2) is called to prepare the socket for
  * accepting incoming connection requests.
  *
- * If mode is zero, an abstract socket (a non-portable Linux extension) is
- * created. In this case the socket name has no connection with filesystem
- * pathnames.
- *
  * \return The file descriptor on success, negative error code on failure.
  *
  * \sa socket(2), \sa bind(2), \sa chmod(2), listen(2), unix(7).
  */
-int create_local_socket(const char *name, mode_t mode)
+int create_local_socket(const char *name)
 {
        struct sockaddr_un unix_addr;
        int fd, ret;
-       bool abstract = mode == 0;
 
-       ret = init_unix_addr(&unix_addr, name, abstract);
-       if (ret < 0)
+       ret = init_unix_addr(&unix_addr, name);
+       if (ret <= 0) /* error, or name was NULL */
                return ret;
        ret = socket(PF_UNIX, SOCK_STREAM, 0);
        if (ret < 0)
@@ -880,7 +936,9 @@ int create_local_socket(const char *name, mode_t mode)
                ret = -ERRNO_TO_PARA_ERROR(errno);
                goto err;
        }
-       if (!abstract) {
+       if (unix_addr.sun_path[0] != 0) { /* pathname socket */
+               mode_t mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP
+                       | S_IROTH | S_IWOTH;
                ret = -E_CHMOD;
                if (chmod(name, mode) < 0)
                        goto err;
@@ -906,7 +964,7 @@ err:
  * \return The file descriptor of the connected socket on success, negative on
  * errors.
  *
- * \sa create_local_socket(), unix(7), connect(2).
+ * \sa \ref create_local_socket(), unix(7), connect(2).
  */
 int connect_local_socket(const char *name)
 {
@@ -917,14 +975,7 @@ int connect_local_socket(const char *name)
        fd = socket(PF_UNIX, SOCK_STREAM, 0);
        if (fd < 0)
                return -ERRNO_TO_PARA_ERROR(errno);
-       /* first try (linux-only) abstract socket */
-       ret = init_unix_addr(&unix_addr, name, true);
-       if (ret < 0)
-               goto err;
-       if (connect(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) != -1)
-               return fd;
-       /* next try pathname socket */
-       ret = init_unix_addr(&unix_addr, name, false);
+       ret = init_unix_addr(&unix_addr, name);
        if (ret < 0)
                goto err;
        if (connect(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) != -1)
@@ -955,8 +1006,7 @@ int recv_cred_buffer(int fd, char *buf, size_t size)
  * \return On success, this call returns the number of bytes sent. On errors,
  * \p -E_SENDMSG is returned.
  *
- * \sa \ref recv_cred_buffer, sendmsg(2), socket(7), unix(7), okir's Black Hats
- * Manual.
+ * \sa \ref recv_cred_buffer, sendmsg(2), socket(7), unix(7).
  */
 ssize_t send_cred_buffer(int sock, char *buf)
 {