SUID comments, review
[oweals/gnunet.git] / src / transport / gnunet-nat-server.c
1 /*
2      This file is part of GNUnet.
3      (C) 2010 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file src/transport/gnunet-nat-server.c
23  * @brief Tool to help bypass NATs using ICMP method; must run as root (SUID will do)
24  *        This code will work under GNU/Linux only (or maybe BSDs, but never W32)
25  * @author Christian Grothoff
26  *
27  * This program will send ONE ICMP message every 500 ms RAW sockets
28  * to a DUMMY IP address and also listens for ICMP replies.  Since
29  * it uses RAW sockets, it must be installed SUID or run as 'root'.
30  * In order to keep the security risk of the resulting SUID binary
31  * minimal, the program ONLY opens the two RAW sockets with root
32  * priviledges, then drops them and only then starts to process
33  * command line arguments.  The code also does not link against
34  * any shared libraries (except libc) and is strictly minimal
35  * (except for checking for errors).  The following list of people
36  * have reviewed this code and considered it safe since the last
37  * modification (if you reviewed it, please have your name added
38  * to the list):
39  *
40  * - Christian Grothoff
41  */
42 #define _GNU_SOURCE
43 #include <sys/types.h> 
44 #include <sys/socket.h>
45 #include <arpa/inet.h>
46 #include <sys/select.h>
47 #include <sys/time.h>
48 #include <sys/types.h>
49 #include <unistd.h>
50 #include <stdio.h>
51 #include <string.h>
52 #include <errno.h>
53 #include <stdlib.h>
54 #include <stdint.h>
55 #include <time.h>
56 #include <netinet/ip.h>
57 #include <netinet/ip_icmp.h>
58 #include <netinet/in.h> 
59
60 /**
61  * Must match IP given in the client.
62  */
63 #define DUMMY_IP "1.2.3.4"
64
65 /**
66  * How often do we send our ICMP messages to receive replies?
67  */
68 #define ICMP_SEND_FREQUENCY_MS 500
69
70 struct ip_packet 
71 {
72   uint8_t vers_ihl;
73   uint8_t tos;
74   uint16_t pkt_len;
75   uint16_t id;
76   uint16_t flags_frag_offset;
77   uint8_t ttl;
78   uint8_t proto;
79   uint16_t checksum;
80   uint32_t src_ip;
81   uint32_t dst_ip;
82 };
83
84 struct icmp_packet 
85 {
86   uint8_t type;
87   uint8_t code;
88   uint16_t checksum;
89   uint32_t reserved;
90 };
91
92
93 static int icmpsock;
94
95 static int rawsock;
96
97 static struct in_addr dummy;
98
99 static uint16_t 
100 calc_checksum(const uint16_t *data, 
101               unsigned int bytes)
102 {
103   uint32_t sum;
104   unsigned int i;
105
106   sum = 0;
107   for (i=0;i<bytes/2;i++) 
108     sum += data[i];        
109   sum = (sum & 0xffff) + (sum >> 16);
110   sum = htons(0xffff - sum);
111   return sum;
112 }
113
114
115 static void
116 make_echo (const struct in_addr *src_ip,
117            struct icmp_packet *echo)
118 {
119   memset(echo, 0, sizeof(struct icmp_packet));
120   echo->type = ICMP_ECHO;
121   echo->code = 0;
122   echo->reserved = 0;
123   echo->checksum = 0;
124   echo->checksum = htons(calc_checksum((uint16_t*)echo, sizeof (struct icmp_packet)));
125 }
126
127
128 /**
129  * Send an ICMP message to the dummy IP.
130  *
131  * @param my_ip source address (our ip address)
132  */
133 static void
134 send_icmp_echo (const struct in_addr *my_ip)
135 {
136   struct icmp_packet icmp_echo;
137   struct sockaddr_in dst;
138   size_t off;
139   int err;
140   struct ip_packet ip_pkt;
141   struct icmp_packet icmp_pkt;
142   char packet[sizeof (ip_pkt) + sizeof (icmp_pkt)];
143
144   off = 0;
145   memset(&ip_pkt, 0, sizeof(ip_pkt));
146   ip_pkt.vers_ihl = 0x45;
147   ip_pkt.tos = 0;
148   ip_pkt.pkt_len = sizeof (packet);
149   ip_pkt.id = 1;
150   ip_pkt.flags_frag_offset = 0;
151   ip_pkt.ttl = IPDEFTTL;
152   ip_pkt.proto = IPPROTO_ICMP;
153   ip_pkt.checksum = 0; 
154   ip_pkt.src_ip = my_ip->s_addr;
155   ip_pkt.dst_ip = dummy.s_addr;
156   ip_pkt.checksum = htons(calc_checksum((uint16_t*)&ip_pkt, sizeof (ip_pkt)));
157   memcpy (packet, &ip_pkt, sizeof (ip_pkt));
158   off += sizeof (ip_pkt);
159   make_echo (my_ip, &icmp_echo);
160   memcpy (&packet[off], &icmp_echo, sizeof (icmp_echo));
161   off += sizeof (icmp_echo);
162  
163   memset (&dst, 0, sizeof (dst));
164   dst.sin_family = AF_INET;
165   dst.sin_addr = dummy;
166   err = sendto(rawsock, 
167                packet, off, 0, 
168                (struct sockaddr*)&dst, 
169                sizeof(dst));
170   if (err < 0) 
171     {
172       fprintf(stderr,
173               "sendto failed: %s\n", strerror(errno));
174     }
175   else if (err != off) 
176     {
177       fprintf(stderr,
178               "Error: partial send of ICMP message\n");
179     }
180 }
181
182
183 static void
184 process_icmp_response ()
185 {
186   char buf[65536];
187   ssize_t have;
188   struct in_addr sip;
189   struct ip_packet ip_pkt;
190   struct icmp_packet icmp_pkt;
191   size_t off;
192   
193   have = read (icmpsock, buf, sizeof (buf));
194   if (have == -1)
195     {
196       fprintf (stderr,
197                "Error reading raw socket: %s\n",
198                strerror (errno));
199       return; 
200     }
201   if (have != sizeof (struct ip_packet) *2 + sizeof (struct icmp_packet) * 2)
202     {
203       fprintf (stderr,
204                "Received ICMP message of unexpected size: %u bytes\n",
205                (unsigned int) have);
206       return;
207     }
208   off = 0;
209   memcpy (&ip_pkt, &buf[off], sizeof (ip_pkt));
210   off += sizeof (ip_pkt);
211   memcpy (&icmp_pkt, &buf[off], sizeof (icmp_pkt));
212   off += sizeof (icmp_pkt);
213   if ( (ip_pkt.proto != IPPROTO_ICMP) ||
214        (icmp_pkt.type != ICMP_TIME_EXCEEDED) || 
215        (icmp_pkt.code != 0) )
216     {
217       /* maybe we got an actual reply back... */
218       return;    
219     }
220   memcpy(&sip, 
221          &ip_pkt.src_ip, 
222          sizeof (sip));
223   fprintf (stdout,
224            "%s\n",
225            inet_ntop (AF_INET,
226                       &sip,
227                       buf,
228                       sizeof (buf)));
229 }
230
231
232 static int
233 make_icmp_socket ()
234 {
235   int ret;
236
237   ret = socket (AF_INET, SOCK_RAW, IPPROTO_ICMP);
238   if (-1 == ret)
239     {
240       fprintf (stderr,
241                "Error opening RAW socket: %s\n",
242                strerror (errno));
243       return -1;
244     }  
245   if (ret >= FD_SETSIZE) 
246     {
247       fprintf (stderr,
248                "Socket number too large (%d > %u)\n",
249                ret,
250                (unsigned int) FD_SETSIZE);
251       close (ret);
252       return -1;
253     }
254   return ret;
255 }
256
257
258 static int
259 make_raw_socket ()
260 {
261   const int one = 1;
262   int ret;
263
264   ret = socket (AF_INET, SOCK_RAW, IPPROTO_RAW);
265   if (-1 == ret)
266     {
267       fprintf (stderr,
268                "Error opening RAW socket: %s\n",
269                strerror (errno));
270       return -1;
271     }  
272   if (setsockopt(ret, SOL_SOCKET, SO_BROADCAST,
273                  (char *)&one, sizeof(one)) == -1)
274     fprintf(stderr,
275             "setsockopt failed: %s\n",
276             strerror (errno));
277   if (setsockopt(ret, IPPROTO_IP, IP_HDRINCL,
278                  (char *)&one, sizeof(one)) == -1)
279     fprintf(stderr,
280             "setsockopt failed: %s\n",
281             strerror (errno));
282   return ret;
283 }
284
285
286 int
287 main (int argc, char *const *argv)
288 {
289   struct in_addr external;
290   fd_set rs;
291   struct timeval tv;
292   uid_t uid;
293
294   if (-1 == (icmpsock = make_icmp_socket()))
295     return 1; 
296   if (-1 == (rawsock = make_raw_socket()))
297     {
298       close (icmpsock);
299       return 1; 
300     }
301   uid = getuid ();
302   if (0 != setresuid (uid, uid, uid))
303     fprintf (stderr,
304              "Failed to setresuid: %s\n",
305              strerror (errno));    
306   if (argc != 2)
307     {
308       fprintf (stderr,
309                "This program must be started with our external IP as the only argument.\n");
310       return 1;
311     }
312   if (1 != inet_pton (AF_INET, argv[1], &external))
313     {
314       fprintf (stderr,
315                "Error parsing IPv4 address: %s\n",
316                strerror (errno));
317       return 1;
318     }
319   inet_pton (AF_INET, DUMMY_IP, &dummy);
320   while (1)
321     {
322       FD_ZERO (&rs);
323       FD_SET (icmpsock, &rs);
324       tv.tv_sec = 0;
325       tv.tv_usec = ICMP_SEND_FREQUENCY_MS * 1000; 
326       select (icmpsock + 1, &rs, NULL, NULL, &tv);
327       if (FD_ISSET (icmpsock, &rs))
328         process_icmp_response ();
329       send_icmp_echo (&external);
330     }  
331   return 0;
332 }
333
334
335 /* end of gnunet-nat-server.c */