2 This file is part of GNUnet.
3 Copyright (C) 2011, 2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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 \
34 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
37 * Entry we keep for each incoming connection.
42 * This is a doubly-linked list.
44 struct NatActivity *next;
47 * This is a doubly-linked list.
49 struct NatActivity *prev;
52 * Socket of the incoming connection.
54 struct GNUNET_NETWORK_Handle *sock;
57 * Handle of the master context.
59 struct GNUNET_NAT_Test *h;
62 * Task reading from the incoming connection.
64 struct GNUNET_SCHEDULER_Task *rtask;
69 * Entry we keep for each connection to the gnunet-nat-service.
74 * This is a doubly-linked list.
76 struct ClientActivity *next;
79 * This is a doubly-linked list.
81 struct ClientActivity *prev;
84 * Socket of the incoming connection.
86 struct GNUNET_MQ_Handle *mq;
89 * Handle to overall NAT test.
91 struct GNUNET_NAT_Test *h;
96 * Handle to a NAT test.
98 struct GNUNET_NAT_Test
103 const struct GNUNET_CONFIGURATION_Handle *cfg;
106 * Function to call with success report
108 GNUNET_NAT_TestCallback report;
111 * Closure for @e report.
116 * Handle to NAT traversal in use
118 struct GNUNET_NAT_Handle *nat;
121 * Handle to listen socket, or NULL
123 struct GNUNET_NETWORK_Handle *lsock;
126 * Head of list of nat activities.
128 struct NatActivity *na_head;
131 * Tail of list of nat activities.
133 struct NatActivity *na_tail;
136 * Head of list of client activities.
138 struct ClientActivity *ca_head;
141 * Tail of list of client activities.
143 struct ClientActivity *ca_tail;
146 * Identity of task for the listen socket (if any)
148 struct GNUNET_SCHEDULER_Task *ltask;
151 * Task identifier for the timeout (if any)
153 struct GNUNET_SCHEDULER_Task *ttask;
156 * #GNUNET_YES if we're testing TCP
161 * Data that should be transmitted or source-port.
166 * Advertised port to the other peer.
171 * Status code to be reported to the timeout/status call
173 enum GNUNET_NAT_StatusCode status;
178 * Function called from #GNUNET_NAT_register whenever someone asks us
179 * to do connection reversal.
181 * @param cls closure, our `struct GNUNET_NAT_Handle`
182 * @param addr public IP address of the other peer
183 * @param addrlen actual lenght of the @a addr
186 reversal_cb (void *cls, const struct sockaddr *addr, socklen_t addrlen)
188 struct GNUNET_NAT_Test *h = cls;
189 const struct sockaddr_in *sa;
191 if (sizeof(struct sockaddr_in) != addrlen)
193 sa = (const struct sockaddr_in *) addr;
194 if (h->data != sa->sin_port)
196 LOG (GNUNET_ERROR_TYPE_DEBUG,
197 "Received connection reversal request for wrong port\n");
198 return; /* wrong port */
201 h->report (h->report_cls, GNUNET_NAT_ERROR_SUCCESS);
206 * Activity on our incoming socket. Read data from the
207 * incoming connection.
209 * @param cls the `struct GNUNET_NAT_Test`
212 do_udp_read (void *cls)
214 struct GNUNET_NAT_Test *tst = cls;
216 const struct GNUNET_SCHEDULER_TaskContext *tc;
218 tc = GNUNET_SCHEDULER_get_task_context ();
219 tst->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
223 if ((NULL != tc->write_ready) &&
224 (GNUNET_NETWORK_fdset_isset (tc->read_ready, tst->lsock)) &&
226 GNUNET_NETWORK_socket_recv (tst->lsock, &data, sizeof(data))))
228 if (data == tst->data)
229 tst->report (tst->report_cls, GNUNET_NAT_ERROR_SUCCESS);
231 LOG (GNUNET_ERROR_TYPE_DEBUG,
232 "Received data mismatches expected value\n");
235 LOG (GNUNET_ERROR_TYPE_DEBUG,
236 "Failed to receive data from inbound connection\n");
241 * Activity on our incoming socket. Read data from the
242 * incoming connection.
244 * @param cls the `struct NatActivity`
249 struct NatActivity *na = cls;
250 struct GNUNET_NAT_Test *tst;
252 const struct GNUNET_SCHEDULER_TaskContext *tc;
254 tc = GNUNET_SCHEDULER_get_task_context ();
257 GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, na);
258 if ((NULL != tc->write_ready) &&
259 (GNUNET_NETWORK_fdset_isset (tc->read_ready, na->sock)) &&
261 GNUNET_NETWORK_socket_recv (na->sock, &data, sizeof(data))))
263 if (data == tst->data)
264 tst->report (tst->report_cls, GNUNET_NAT_ERROR_SUCCESS);
266 LOG (GNUNET_ERROR_TYPE_DEBUG,
267 "Received data does not match expected value\n");
270 LOG (GNUNET_ERROR_TYPE_DEBUG,
271 "Failed to receive data from inbound connection\n");
272 GNUNET_NETWORK_socket_close (na->sock);
278 * Activity on our listen socket. Accept the
279 * incoming connection.
281 * @param cls the `struct GNUNET_NAT_Test`
284 do_accept (void *cls)
286 struct GNUNET_NAT_Test *tst = cls;
287 struct GNUNET_NETWORK_Handle *s;
288 struct NatActivity *wl;
290 tst->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
294 s = GNUNET_NETWORK_socket_accept (tst->lsock, NULL, NULL);
297 GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "accept");
298 return; /* odd error */
300 LOG (GNUNET_ERROR_TYPE_DEBUG,
301 "Got an inbound connection, waiting for data\n");
302 wl = GNUNET_new (struct NatActivity);
305 wl->rtask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
309 GNUNET_CONTAINER_DLL_insert (tst->na_head, tst->na_tail, wl);
314 * We got disconnected from the NAT server. Stop
315 * waiting for a reply.
317 * @param cls the `struct ClientActivity`
318 * @param error error code
321 mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
323 struct ClientActivity *ca = cls;
324 struct GNUNET_NAT_Test *tst = ca->h;
326 GNUNET_CONTAINER_DLL_remove (tst->ca_head, tst->ca_tail, ca);
327 GNUNET_MQ_destroy (ca->mq);
333 * Address-callback, used to send message to gnunet-nat-server.
336 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
337 * the previous (now invalid) one
338 * @param addr either the previous or the new public IP address
339 * @param addrlen actual length of the @a addr
344 const struct sockaddr *addr,
347 struct GNUNET_NAT_Test *h = cls;
348 struct ClientActivity *ca;
349 struct GNUNET_MQ_Envelope *env;
350 struct GNUNET_NAT_TestMessage *msg;
351 const struct sockaddr_in *sa;
353 if (GNUNET_YES != add_remove)
355 if (addrlen != sizeof(struct sockaddr_in))
357 LOG (GNUNET_ERROR_TYPE_DEBUG,
358 "NAT test ignores IPv6 address `%s' returned from NAT library\n",
359 GNUNET_a2s (addr, addrlen));
360 return; /* ignore IPv6 here */
362 LOG (GNUNET_ERROR_TYPE_INFO,
363 "Asking gnunet-nat-server to connect to `%s'\n",
364 GNUNET_a2s (addr, addrlen));
366 ca = GNUNET_new (struct ClientActivity);
368 ca->mq = GNUNET_CLIENT_connect (h->cfg,
376 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
377 _ ("Failed to connect to `gnunet-nat-server'\n"));
380 GNUNET_CONTAINER_DLL_insert (h->ca_head, h->ca_tail, ca);
381 sa = (const struct sockaddr_in *) addr;
382 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_NAT_TEST);
383 msg->dst_ipv4 = sa->sin_addr.s_addr;
384 msg->dport = sa->sin_port;
386 msg->is_tcp = htonl ((uint32_t) h->is_tcp);
387 GNUNET_MQ_send (ca->mq, env);
392 * Timeout task for a nat test.
393 * Calls the report-callback with a timeout return value
395 * Destroys the nat handle after the callback has been processed.
397 * @param cls handle to the timed out NAT test
400 do_timeout (void *cls)
402 struct GNUNET_NAT_Test *nh = cls;
405 nh->report (nh->report_cls,
406 (GNUNET_NAT_ERROR_SUCCESS == nh->status)
407 ? GNUNET_NAT_ERROR_TIMEOUT
413 * Start testing if NAT traversal works using the
414 * given configuration (IPv4-only).
416 * ALL failures are reported directly to the report callback
418 * @param cfg configuration for the NAT traversal
419 * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
420 * @param bnd_port port to bind to, 0 for connection reversal
421 * @param adv_port externally advertised port to use
422 * @param timeout delay after which the test should be aborted
423 * @param report function to call with the result of the test
424 * @param report_cls closure for @a report
425 * @return handle to cancel NAT test or NULL. The error is always indicated via the report callback
427 struct GNUNET_NAT_Test *
428 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
432 struct GNUNET_TIME_Relative timeout,
433 GNUNET_NAT_TestCallback report,
436 struct GNUNET_NAT_Test *nh;
437 struct sockaddr_in sa;
438 const struct sockaddr *addrs[] = { (const struct sockaddr *) &sa };
439 const socklen_t addrlens[] = { sizeof(sa) };
441 memset (&sa, 0, sizeof(sa));
442 sa.sin_family = AF_INET;
443 sa.sin_port = htons (bnd_port);
444 #if HAVE_SOCKADDR_IN_SIN_LEN
445 sa.sin_len = sizeof(sa);
448 nh = GNUNET_new (struct GNUNET_NAT_Test);
452 nh->adv_port = adv_port;
454 nh->report_cls = report_cls;
455 nh->status = GNUNET_NAT_ERROR_SUCCESS;
458 nh->nat = GNUNET_NAT_register (cfg,
472 GNUNET_NETWORK_socket_create (AF_INET,
473 (is_tcp == GNUNET_YES) ? SOCK_STREAM
476 if ((nh->lsock == NULL) ||
477 (GNUNET_OK != GNUNET_NETWORK_socket_bind (nh->lsock,
478 (const struct sockaddr *) &sa,
482 GNUNET_ERROR_TYPE_ERROR,
483 _ ("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
484 GNUNET_a2s ((const struct sockaddr *) &sa, sizeof(sa)),
486 if (NULL != nh->lsock)
488 GNUNET_NETWORK_socket_close (nh->lsock);
491 nh->status = GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR;
492 nh->ttask = GNUNET_SCHEDULER_add_now (&do_timeout, nh);
495 if (GNUNET_YES == is_tcp)
497 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (nh->lsock, 5));
498 nh->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
505 nh->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
510 LOG (GNUNET_ERROR_TYPE_INFO,
511 "NAT test listens on port %u (%s)\n",
513 (GNUNET_YES == is_tcp) ? "tcp" : "udp");
514 nh->nat = GNUNET_NAT_register (cfg,
526 LOG (GNUNET_ERROR_TYPE_INFO,
527 _ ("NAT test failed to start NAT library\n"));
528 if (NULL != nh->ltask)
530 GNUNET_SCHEDULER_cancel (nh->ltask);
533 if (NULL != nh->lsock)
535 GNUNET_NETWORK_socket_close (nh->lsock);
538 nh->status = GNUNET_NAT_ERROR_NAT_REGISTER_FAILED;
539 nh->ttask = GNUNET_SCHEDULER_add_now (&do_timeout, nh);
543 nh->ttask = GNUNET_SCHEDULER_add_delayed (timeout, &do_timeout, nh);
549 * Stop an active NAT test.
551 * @param tst test to stop.
554 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst)
556 struct NatActivity *pos;
557 struct ClientActivity *cpos;
559 LOG (GNUNET_ERROR_TYPE_DEBUG, "Stopping NAT test\n");
560 while (NULL != (cpos = tst->ca_head))
562 GNUNET_CONTAINER_DLL_remove (tst->ca_head, tst->ca_tail, cpos);
563 GNUNET_MQ_destroy (cpos->mq);
566 while (NULL != (pos = tst->na_head))
568 GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, pos);
569 GNUNET_SCHEDULER_cancel (pos->rtask);
570 GNUNET_NETWORK_socket_close (pos->sock);
573 if (NULL != tst->ttask)
575 GNUNET_SCHEDULER_cancel (tst->ttask);
578 if (NULL != tst->ltask)
580 GNUNET_SCHEDULER_cancel (tst->ltask);
583 if (NULL != tst->lsock)
585 GNUNET_NETWORK_socket_close (tst->lsock);
588 if (NULL != tst->nat)
590 GNUNET_NAT_unregister (tst->nat);
597 /* end of nat_test.c */