2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file nat/nat_test.c
23 * @brief functions to test if the NAT configuration is successful at achieving NAT traversal (with the help of a gnunet-nat-server)
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_nat_lib.h"
31 #define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
33 #define NAT_SERVER_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
36 * Entry we keep for each incoming connection.
41 * This is a doubly-linked list.
43 struct NatActivity *next;
46 * This is a doubly-linked list.
48 struct NatActivity *prev;
51 * Socket of the incoming connection.
53 struct GNUNET_NETWORK_Handle *sock;
56 * Handle of the master context.
58 struct GNUNET_NAT_Test *h;
61 * Task reading from the incoming connection.
63 GNUNET_SCHEDULER_TaskIdentifier rtask;
68 * Entry we keep for each connection to the gnunet-nat-service.
73 * This is a doubly-linked list.
75 struct ClientActivity *next;
78 * This is a doubly-linked list.
80 struct ClientActivity *prev;
83 * Socket of the incoming connection.
85 struct GNUNET_CLIENT_Connection *client;
91 * Handle to a NAT test.
93 struct GNUNET_NAT_Test
99 const struct GNUNET_CONFIGURATION_Handle *cfg;
102 * Function to call with success report
104 GNUNET_NAT_TestCallback report;
107 * Closure for @e report.
112 * Handle to NAT traversal in use
114 struct GNUNET_NAT_Handle *nat;
117 * Handle to listen socket, or NULL
119 struct GNUNET_NETWORK_Handle *lsock;
122 * Head of list of nat activities.
124 struct NatActivity *na_head;
127 * Tail of list of nat activities.
129 struct NatActivity *na_tail;
132 * Head of list of client activities.
134 struct ClientActivity *ca_head;
137 * Tail of list of client activities.
139 struct ClientActivity *ca_tail;
142 * Identity of task for the listen socket (if any)
144 GNUNET_SCHEDULER_TaskIdentifier ltask;
147 * GNUNET_YES if we're testing TCP
152 * Data that should be transmitted or source-port.
157 * Advertised port to the other peer.
165 * Function called from #GNUNET_NAT_register whenever someone asks us
166 * to do connection reversal.
168 * @param cls closure, our `struct GNUNET_NAT_Handle`
169 * @param addr public IP address of the other peer
170 * @param addrlen actual lenght of the address
173 reversal_cb (void *cls,
174 const struct sockaddr *addr,
177 struct GNUNET_NAT_Test *h = cls;
178 const struct sockaddr_in *sa;
180 if (sizeof (struct sockaddr_in) != addrlen)
182 sa = (const struct sockaddr_in *) addr;
183 if (h->data != sa->sin_port)
185 LOG (GNUNET_ERROR_TYPE_DEBUG,
186 "Received connection reversal request for wrong port\n");
187 return; /* wrong port */
190 h->report (h->report_cls, GNUNET_OK, NULL);
195 * Activity on our incoming socket. Read data from the
196 * incoming connection.
198 * @param cls the `struct GNUNET_NAT_Test`
199 * @param tc scheduler context
202 do_udp_read (void *cls,
203 const struct GNUNET_SCHEDULER_TaskContext *tc)
205 struct GNUNET_NAT_Test *tst = cls;
209 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
212 if ((NULL != tc->write_ready) &&
213 (GNUNET_NETWORK_fdset_isset (tc->read_ready, tst->lsock)) &&
215 GNUNET_NETWORK_socket_recv (tst->lsock, &data, sizeof (data))))
217 if (data == tst->data)
218 tst->report (tst->report_cls, GNUNET_OK, NULL);
220 LOG (GNUNET_ERROR_TYPE_DEBUG,
221 "Received data mismatches expected value\n");
224 LOG (GNUNET_ERROR_TYPE_DEBUG,
225 "Failed to receive data from inbound connection\n");
230 * Activity on our incoming socket. Read data from the
231 * incoming connection.
233 * @param cls the `struct NatActivity`
234 * @param tc scheduler context
238 const struct GNUNET_SCHEDULER_TaskContext *tc)
240 struct NatActivity *na = cls;
241 struct GNUNET_NAT_Test *tst;
244 na->rtask = GNUNET_SCHEDULER_NO_TASK;
246 GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, na);
247 if ((NULL != tc->write_ready) &&
248 (GNUNET_NETWORK_fdset_isset (tc->read_ready, na->sock)) &&
250 GNUNET_NETWORK_socket_recv (na->sock, &data, sizeof (data))))
252 if (data == tst->data)
253 tst->report (tst->report_cls, GNUNET_OK, NULL);
255 LOG (GNUNET_ERROR_TYPE_DEBUG,
256 "Received data does not match expected value\n");
259 LOG (GNUNET_ERROR_TYPE_DEBUG,
260 "Failed to receive data from inbound connection\n");
261 GNUNET_NETWORK_socket_close (na->sock);
267 * Activity on our listen socket. Accept the
268 * incoming connection.
270 * @param cls the `struct GNUNET_NAT_Test`
271 * @param tc scheduler context
274 do_accept (void *cls,
275 const struct GNUNET_SCHEDULER_TaskContext *tc)
277 struct GNUNET_NAT_Test *tst = cls;
278 struct GNUNET_NETWORK_Handle *s;
279 struct NatActivity *wl;
281 tst->ltask = GNUNET_SCHEDULER_NO_TASK;
282 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
285 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL, tst->lsock,
287 s = GNUNET_NETWORK_socket_accept (tst->lsock, NULL, NULL);
290 GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "accept");
291 return; /* odd error */
293 LOG (GNUNET_ERROR_TYPE_DEBUG,
294 "Got an inbound connection, waiting for data\n");
295 wl = GNUNET_new (struct NatActivity);
299 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
302 GNUNET_CONTAINER_DLL_insert (tst->na_head, tst->na_tail, wl);
307 * Address-callback, used to send message to gnunet-nat-server.
310 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
311 * the previous (now invalid) one
312 * @param addr either the previous or the new public IP address
313 * @param addrlen actual length of the @a addr
318 const struct sockaddr *addr,
321 struct GNUNET_NAT_Test *h = cls;
322 struct ClientActivity *ca;
323 struct GNUNET_CLIENT_Connection *client;
324 struct GNUNET_NAT_TestMessage msg;
325 const struct sockaddr_in *sa;
327 if (GNUNET_YES != add_remove)
329 if (addrlen != sizeof (struct sockaddr_in))
331 LOG (GNUNET_ERROR_TYPE_DEBUG,
332 "NAT test ignores IPv6 address `%s' returned from NAT library\n",
333 GNUNET_a2s (addr, addrlen));
334 return; /* ignore IPv6 here */
336 LOG (GNUNET_ERROR_TYPE_DEBUG,
337 "Asking gnunet-nat-server to connect to `%s'\n",
338 GNUNET_a2s (addr, addrlen));
339 sa = (const struct sockaddr_in *) addr;
340 msg.header.size = htons (sizeof (struct GNUNET_NAT_TestMessage));
341 msg.header.type = htons (GNUNET_MESSAGE_TYPE_NAT_TEST);
342 msg.dst_ipv4 = sa->sin_addr.s_addr;
343 msg.dport = sa->sin_port;
345 msg.is_tcp = htonl ((uint32_t) h->is_tcp);
347 client = GNUNET_CLIENT_connect ("gnunet-nat-server", h->cfg);
350 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
351 _("Failed to connect to `gnunet-nat-server'\n"));
354 ca = GNUNET_new (struct ClientActivity);
356 GNUNET_CONTAINER_DLL_insert (h->ca_head, h->ca_tail, ca);
357 GNUNET_break (GNUNET_OK ==
358 GNUNET_CLIENT_transmit_and_get_response (client, &msg.header,
366 * Start testing if NAT traversal works using the
367 * given configuration (IPv4-only).
369 * @param cfg configuration for the NAT traversal
370 * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
371 * @param bnd_port port to bind to, 0 for connection reversal
372 * @param adv_port externally advertised port to use
373 * @param report function to call with the result of the test
374 * @param report_cls closure for @a report
375 * @return handle to cancel NAT test
377 struct GNUNET_NAT_Test *
378 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
382 GNUNET_NAT_TestCallback report,
385 struct GNUNET_NAT_Test *ret;
386 struct sockaddr_in sa;
387 const struct sockaddr *addrs[] = { (const struct sockaddr *) &sa };
388 const socklen_t addrlens[] = { sizeof (sa) };
390 memset (&sa, 0, sizeof (sa));
391 sa.sin_family = AF_INET;
392 sa.sin_port = htons (bnd_port);
393 #if HAVE_SOCKADDR_IN_SIN_LEN
394 sa.sin_len = sizeof (sa);
397 ret = GNUNET_new (struct GNUNET_NAT_Test);
399 ret->is_tcp = is_tcp;
400 ret->data = bnd_port;
401 ret->adv_port = adv_port;
402 ret->report = report;
403 ret->report_cls = report_cls;
407 GNUNET_NAT_register (cfg, is_tcp, 0, 0, NULL, NULL, &addr_cb,
413 GNUNET_NETWORK_socket_create (AF_INET,
415 GNUNET_YES) ? SOCK_STREAM : SOCK_DGRAM,
417 if ((ret->lsock == NULL) ||
419 GNUNET_NETWORK_socket_bind (ret->lsock, (const struct sockaddr *) &sa,
422 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
423 _("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
424 GNUNET_a2s ((const struct sockaddr *) &sa, sizeof (sa)),
426 if (NULL != ret->lsock)
427 GNUNET_NETWORK_socket_close (ret->lsock);
431 if (GNUNET_YES == is_tcp)
433 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (ret->lsock, 5));
435 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
436 ret->lsock, &do_accept, ret);
441 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
442 ret->lsock, &do_udp_read, ret);
444 LOG (GNUNET_ERROR_TYPE_DEBUG,
445 "NAT test listens on port %u (%s)\n",
447 (GNUNET_YES == is_tcp) ? "tcp" : "udp");
449 GNUNET_NAT_register (cfg, is_tcp, adv_port, 1, addrs, addrlens,
450 &addr_cb, NULL, ret);
457 * Stop an active NAT test.
459 * @param tst test to stop.
462 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst)
464 struct NatActivity *pos;
465 struct ClientActivity *cpos;
467 LOG (GNUNET_ERROR_TYPE_DEBUG,
468 "Stopping NAT test\n");
469 while (NULL != (cpos = tst->ca_head))
471 GNUNET_CONTAINER_DLL_remove (tst->ca_head, tst->ca_tail, cpos);
472 GNUNET_CLIENT_disconnect (cpos->client);
475 while (NULL != (pos = tst->na_head))
477 GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, pos);
478 GNUNET_SCHEDULER_cancel (pos->rtask);
479 GNUNET_NETWORK_socket_close (pos->sock);
482 if (GNUNET_SCHEDULER_NO_TASK != tst->ltask)
483 GNUNET_SCHEDULER_cancel (tst->ltask);
484 if (NULL != tst->lsock)
485 GNUNET_NETWORK_socket_close (tst->lsock);
486 GNUNET_NAT_unregister (tst->nat);
490 /* end of nat_test.c */