RECLAIM/OIDC: code cleanup
[oweals/gnunet.git] / src / nat / gnunet-helper-nat-server.c
index 684fa970664722c6fef550f717f4d4efa124ab89..78b9260378846c847168a834f49df68dd277a272 100644 (file)
@@ -1,21 +1,21 @@
 /*
      This file is part of GNUnet.
-     (C) 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010 GNUnet e.V.
 
-     GNUnet 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 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
@@ -40,6 +40,7 @@
  * - Christian Grothoff
  * - Nathan Evans
  * - Benjamin Kuperman (22 Aug 2010)
+ * - Jacob Appelbaum (19 Dec 2011)
  */
 #if HAVE_CONFIG_H
 /* Just needed for HAVE_SOCKADDR_IN_SIN_LEN test macro! */
 #include <netinet/ip_icmp.h>
 #include <netinet/in.h>
 
+/* The following constant is missing from FreeBSD 9.2 */
+#ifndef ICMP_TIME_EXCEEDED
+#define ICMP_TIME_EXCEEDED 11
+#endif
+
+/**
+ * Call memcpy() but check for @a n being 0 first. In the latter
+ * case, it is now safe to pass NULL for @a src or @a dst.
+ * Unlike traditional memcpy(), returns nothing.
+ *
+ * @param dst destination of the copy, may be NULL if @a n is zero
+ * @param src source of the copy, may be NULL if @a n is zero
+ * @param n number of bytes to copy
+ */
+#define GNUNET_memcpy(dst,src,n) do { if (0 != n) { (void) memcpy (dst,src,n); } } while (0)
+
 /**
  * Should we print some debug output?
  */
 #define VERBOSE 0
 
+/**
+ * Must match packet ID used by gnunet-helper-nat-client.c
+ */
+#define PACKET_ID 256
+
 /**
  * Must match IP given in the client.
  */
@@ -245,7 +267,7 @@ send_icmp_echo (const struct in_addr *my_ip)
   ip_pkt.vers_ihl = 0x45;
   ip_pkt.tos = 0;
   ip_pkt.pkt_len = htons (sizeof (packet));
-  ip_pkt.id = htons (256);
+  ip_pkt.id = htons (PACKET_ID);
   ip_pkt.flags_frag_offset = 0;
   ip_pkt.ttl = IPDEFTTL;
   ip_pkt.proto = IPPROTO_ICMP;
@@ -253,8 +275,11 @@ send_icmp_echo (const struct in_addr *my_ip)
   ip_pkt.src_ip = my_ip->s_addr;
   ip_pkt.dst_ip = dummy.s_addr;
   ip_pkt.checksum =
-      htons (calc_checksum ((uint16_t *) & ip_pkt, sizeof (struct ip_header)));
-  memcpy (&packet[off], &ip_pkt, sizeof (struct ip_header));
+      htons (calc_checksum ((uint16_t *) & ip_pkt,
+                           sizeof (struct ip_header)));
+  GNUNET_memcpy (&packet[off],
+                 &ip_pkt,
+                 sizeof (struct ip_header));
   off += sizeof (struct ip_header);
 
   icmp_echo.type = ICMP_ECHO;
@@ -262,9 +287,12 @@ send_icmp_echo (const struct in_addr *my_ip)
   icmp_echo.checksum = 0;
   icmp_echo.reserved = 0;
   icmp_echo.checksum =
-      htons (calc_checksum
-             ((uint16_t *) & icmp_echo, sizeof (struct icmp_echo_header)));
-  memcpy (&packet[off], &icmp_echo, sizeof (struct icmp_echo_header));
+    htons (calc_checksum
+          ((uint16_t *) & icmp_echo,
+           sizeof (struct icmp_echo_header)));
+  GNUNET_memcpy (&packet[off],
+                 &icmp_echo,
+                 sizeof (struct icmp_echo_header));
   off += sizeof (struct icmp_echo_header);
 
   memset (&dst, 0, sizeof (dst));
@@ -273,17 +301,24 @@ send_icmp_echo (const struct in_addr *my_ip)
   dst.sin_len = sizeof (struct sockaddr_in);
 #endif
   dst.sin_addr = dummy;
-  err =
-      sendto (rawsock, packet, off, 0, (struct sockaddr *) &dst, sizeof (dst));
+  err = sendto (rawsock,
+               packet,
+               off,
+               0,
+               (struct sockaddr *) &dst,
+               sizeof (dst));
   if (err < 0)
   {
 #if VERBOSE
-    fprintf (stderr, "sendto failed: %s\n", strerror (errno));
+    fprintf (stderr,
+            "sendto failed: %s\n",
+            strerror (errno));
 #endif
   }
   else if (sizeof (packet) != err)
   {
-    fprintf (stderr, "Error: partial send of ICMP message\n");
+    fprintf (stderr,
+            "Error: partial send of ICMP message\n");
   }
 }
 
@@ -304,16 +339,24 @@ send_udp ()
 #endif
   dst.sin_addr = dummy;
   dst.sin_port = htons (NAT_TRAV_PORT);
-  err = sendto (udpsock, NULL, 0, 0, (struct sockaddr *) &dst, sizeof (dst));
+  err = sendto (udpsock,
+               NULL,
+               0,
+               0,
+               (struct sockaddr *) &dst,
+               sizeof (dst));
   if (err < 0)
   {
 #if VERBOSE
-    fprintf (stderr, "sendto failed: %s\n", strerror (errno));
+    fprintf (stderr,
+            "sendto failed: %s\n",
+            strerror (errno));
 #endif
   }
   else if (0 != err)
   {
-    fprintf (stderr, "Error: partial send of ICMP message\n");
+    fprintf (stderr,
+            "Error: partial send of ICMP message\n");
   }
 }
 
@@ -337,11 +380,15 @@ process_icmp_response ()
   have = read (icmpsock, buf, sizeof (buf));
   if (-1 == have)
   {
-    fprintf (stderr, "Error reading raw socket: %s\n", strerror (errno));
+    fprintf (stderr,
+            "Error reading raw socket: %s\n",
+            strerror (errno));
     return;
   }
 #if VERBOSE
-  fprintf (stderr, "Received message of %u bytes\n", (unsigned int) have);
+  fprintf (stderr,
+          "Received message of %u bytes\n",
+          (unsigned int) have);
 #endif
   if (have <
       (ssize_t) (sizeof (struct ip_header) +
@@ -352,18 +399,26 @@ process_icmp_response ()
     return;
   }
   off = 0;
-  memcpy (&ip_pkt, &buf[off], sizeof (struct ip_header));
+  GNUNET_memcpy (&ip_pkt,
+                 &buf[off],
+                 sizeof (struct ip_header));
   off += sizeof (struct ip_header);
-  memcpy (&source_ip, &ip_pkt.src_ip, sizeof (source_ip));
-  memcpy (&icmp_ttl, &buf[off], sizeof (struct icmp_ttl_exceeded_header));
+  GNUNET_memcpy (&icmp_ttl,
+                 &buf[off],
+                 sizeof (struct icmp_ttl_exceeded_header));
   off += sizeof (struct icmp_ttl_exceeded_header);
   if ((ICMP_TIME_EXCEEDED != icmp_ttl.type) || (0 != icmp_ttl.code))
   {
     /* different type than what we want */
     return;
   }
+  /* grab source IP of 1st IP header */
+  source_ip.s_addr = ip_pkt.src_ip;
+
   /* skip 2nd IP header */
-  memcpy (&ip_pkt, &buf[off], sizeof (struct ip_header));
+  GNUNET_memcpy (&ip_pkt,
+                 &buf[off],
+                 sizeof (struct ip_header));
   off += sizeof (struct ip_header);
 
   switch (ip_pkt.proto)
@@ -378,7 +433,9 @@ process_icmp_response ()
       return;
     }
     /* grab ICMP ECHO content */
-    memcpy (&icmp_echo, &buf[off], sizeof (struct icmp_echo_header));
+    GNUNET_memcpy (&icmp_echo,
+                   &buf[off],
+                   sizeof (struct icmp_echo_header));
     port = (uint16_t) ntohl (icmp_echo.reserved);
     break;
   case IPPROTO_UDP:
@@ -390,7 +447,9 @@ process_icmp_response ()
       return;
     }
     /* grab UDP content */
-    memcpy (&udp_pkt, &buf[off], sizeof (struct udp_header));
+    GNUNET_memcpy (&udp_pkt,
+                   &buf[off],
+                   sizeof (struct udp_header));
     port = ntohs (udp_pkt.length);
     break;
   default:
@@ -410,69 +469,45 @@ process_icmp_response ()
 
 
 /**
- * Create an ICMP raw socket for reading.
- *
- * @return -1 on error
- */
-static int
-make_icmp_socket ()
-{
-  int ret;
-
-  ret = socket (AF_INET, SOCK_RAW, IPPROTO_ICMP);
-  if (-1 == ret)
-  {
-    fprintf (stderr, "Error opening RAW socket: %s\n", strerror (errno));
-    return -1;
-  }
-  if (ret >= FD_SETSIZE)
-  {
-    fprintf (stderr, "Socket number too large (%d > %u)\n", ret,
-             (unsigned int) FD_SETSIZE);
-    close (ret);
-    return -1;
-  }
-  return ret;
-}
-
-
-/**
- * Create an ICMP raw socket for writing.
+ * Fully initialize the raw socket.
  *
- * @return -1 on error
+ * @return -1 on error, 0 on success
  */
 static int
-make_raw_socket ()
+setup_raw_socket ()
 {
   const int one = 1;
-  int ret;
 
-  ret = socket (AF_INET, SOCK_RAW, IPPROTO_RAW);
-  if (-1 == ret)
-  {
-    fprintf (stderr, "Error opening RAW socket: %s\n", strerror (errno));
-    return -1;
-  }
   if (-1 ==
-      setsockopt (ret, SOL_SOCKET, SO_BROADCAST, (char *) &one, sizeof (one)))
+      setsockopt (rawsock,
+                 SOL_SOCKET,
+                 SO_BROADCAST,
+                 (char *) &one,
+                 sizeof (one)))
   {
-    fprintf (stderr, "setsockopt failed: %s\n", strerror (errno));
-    close (ret);
+    fprintf (stderr,
+            "setsockopt failed: %s\n",
+            strerror (errno));
     return -1;
   }
   if (-1 ==
-      setsockopt (ret, IPPROTO_IP, IP_HDRINCL, (char *) &one, sizeof (one)))
+      setsockopt (rawsock,
+                 IPPROTO_IP,
+                 IP_HDRINCL,
+                 (char *) &one,
+                 sizeof (one)))
   {
-    fprintf (stderr, "setsockopt failed: %s\n", strerror (errno));
-    close (ret);
+    fprintf (stderr,
+            "setsockopt failed: %s\n",
+            strerror (errno));
     return -1;
   }
-  return ret;
+  return 0;
 }
 
 
 /**
- * Create a UDP socket for writinging.
+ * Create a UDP socket for writing.
  *
  * @param my_ip source address (our ip address)
  * @return -1 on error
@@ -486,7 +521,9 @@ make_udp_socket (const struct in_addr *my_ip)
   ret = socket (AF_INET, SOCK_DGRAM, 0);
   if (-1 == ret)
   {
-    fprintf (stderr, "Error opening UDP socket: %s\n", strerror (errno));
+    fprintf (stderr,
+             "Error opening UDP socket: %s\n",
+             strerror (errno));
     return -1;
   }
   memset (&addr, 0, sizeof (addr));
@@ -497,62 +534,138 @@ make_udp_socket (const struct in_addr *my_ip)
   addr.sin_addr = *my_ip;
   addr.sin_port = htons (NAT_TRAV_PORT);
 
-  if (0 != bind (ret, &addr, sizeof (addr)))
+  if (0 != bind (ret,
+                 (struct sockaddr *) &addr,
+                 sizeof (addr)))
   {
-    fprintf (stderr, "Error binding UDP socket to port %u: %s\n", NAT_TRAV_PORT,
+    fprintf (stderr,
+             "Error binding UDP socket to port %u: %s\n",
+             NAT_TRAV_PORT,
              strerror (errno));
-    /* likely problematic, but not certain, try to continue */
+    (void) close (ret);
+    return -1;
   }
   return ret;
 }
 
 
 int
-main (int argc, char *const *argv)
+main (int argc,
+      char *const *argv)
 {
   struct in_addr external;
   fd_set rs;
   struct timeval tv;
   uid_t uid;
   unsigned int alt;
+  int icmp_eno;
+  int raw_eno;
+  int global_ret;
+
+  /* Create an ICMP raw socket for reading (we'll check errors later) */
+  icmpsock = socket (AF_INET,
+                    SOCK_RAW,
+                    IPPROTO_ICMP);
+  icmp_eno = errno;
+
+  /* Create an (ICMP) raw socket for writing (we'll check errors later) */
+  rawsock = socket (AF_INET,
+                   SOCK_RAW,
+                   IPPROTO_RAW);
+  raw_eno = errno;
+  udpsock = -1;
+
+  /* drop root rights */
+  uid = getuid ();
+#ifdef HAVE_SETRESUID
+  if (0 != setresuid (uid, uid, uid))
+  {
+    fprintf (stderr,
+            "Failed to setresuid: %s\n",
+            strerror (errno));
+    global_ret = 1;
+    goto error_exit;
+  }
+#else
+  if (0 != (setuid (uid) | seteuid (uid)))
+  {
+    fprintf (stderr,
+            "Failed to setuid: %s\n",
+            strerror (errno));
+    global_ret = 2;
+    goto error_exit;
+  }
+#endif
 
+  /* Now that we run without root rights, we can do error checking... */
   if (2 != argc)
   {
     fprintf (stderr,
              "This program must be started with our (internal NAT) IP as the only argument.\n");
-    return 1;
+    global_ret = 3;
+    goto error_exit;
   }
   if (1 != inet_pton (AF_INET, argv[1], &external))
   {
-    fprintf (stderr, "Error parsing IPv4 address: %s\n", strerror (errno));
-    return 1;
+    fprintf (stderr,
+            "Error parsing IPv4 address: %s\n",
+            strerror (errno));
+    global_ret = 4;
+    goto error_exit;
   }
   if (1 != inet_pton (AF_INET, DUMMY_IP, &dummy))
   {
-    fprintf (stderr, "Internal error converting dummy IP to binary.\n");
-    return 2;
+    fprintf (stderr,
+            "Internal error converting dummy IP to binary.\n");
+    global_ret = 5;
+    goto error_exit;
   }
-  if (-1 == (icmpsock = make_icmp_socket ()))
+
+  /* error checking icmpsock */
+  if (-1 == icmpsock)
   {
-    return 3;
+    fprintf (stderr,
+            "Error opening RAW socket: %s\n",
+            strerror (icmp_eno));
+    global_ret = 6;
+    goto error_exit;
   }
-  if (-1 == (rawsock = make_raw_socket ()))
+  if (icmpsock >= FD_SETSIZE)
   {
-    close (icmpsock);
-    return 3;
+    /* this could happen if we were started with a large number of already-open
+       file descriptors... */
+    fprintf (stderr,
+            "Socket number too large (%d > %u)\n",
+            icmpsock,
+             (unsigned int) FD_SETSIZE);
+    global_ret = 7;
+    goto error_exit;
   }
-  uid = getuid ();
-  if (0 != setresuid (uid, uid, uid))
+
+  /* error checking rawsock */
+  if (-1 == rawsock)
   {
-    fprintf (stderr, "Failed to setresuid: %s\n", strerror (errno));
-    /* not critical, continue anyway */
+    fprintf (stderr,
+            "Error opening RAW socket: %s\n",
+            strerror (raw_eno));
+    global_ret = 8;
+    goto error_exit;
   }
+  /* no need to check 'rawsock' against FD_SETSIZE as it is never used
+     with 'select' */
+
+  if (0 != setup_raw_socket ())
+  {
+    global_ret = 9;
+    goto error_exit;
+  }
+
   if (-1 == (udpsock = make_udp_socket (&external)))
   {
-    close (icmpsock);
-    close (rawsock);
-    return 3;
+    global_ret = 10;
+    goto error_exit;
   }
+
   alt = 0;
   while (1)
   {
@@ -564,23 +677,34 @@ main (int argc, char *const *argv)
     {
       if (errno == EINTR)
         continue;
-      fprintf (stderr, "select failed: %s\n", strerror (errno));
+      fprintf (stderr,
+              "select failed: %s\n",
+              strerror (errno));
       break;
     }
     if (1 == getppid ())        /* Check the parent process id, if 1 the parent has died, so we should die too */
       break;
     if (FD_ISSET (icmpsock, &rs))
+    {
       process_icmp_response ();
+      continue;
+    }
     if (0 == (++alt % 2))
       send_icmp_echo (&external);
     else
       send_udp ();
   }
+
   /* select failed (internal error or OS out of resources) */
-  close (icmpsock);
-  close (rawsock);
-  close (udpsock);
-  return 4;
+  global_ret = 11;
+error_exit:
+  if (-1 != icmpsock)
+    (void) close (icmpsock);
+  if (-1 != rawsock)
+    (void) close (rawsock);
+  if (-1 != udpsock)
+    (void) close (udpsock);
+  return global_ret;
 }