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
21 * @file nat/nat_auto_api_test.c
22 * @brief functions to test if the NAT configuration is successful at achieving NAT traversal (with the help of a gnunet-nat-server)
23 * @author Christian Grothoff
26 #include "gnunet_util_lib.h"
27 #include "gnunet_nat_service.h"
28 #include "gnunet_nat_auto_service.h"
31 #define LOG(kind, ...) GNUNET_log_from (kind, "nat-auto", __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_AUTO_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_AUTO_Test *h;
96 * Handle to a NAT test.
98 struct GNUNET_NAT_AUTO_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 * Section name of plugin to test.
161 * IPPROTO_TCP or IPPROTO_UDP.
166 * Data that should be transmitted or source-port.
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_AUTO_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_AUTO_Test`
212 do_udp_read (void *cls)
214 struct GNUNET_NAT_AUTO_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_AUTO_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_AUTO_Test`
284 do_accept (void *cls)
286 struct GNUNET_NAT_AUTO_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_AUTO_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 app_ctx[in,out] location where the app can store stuff
337 * on add and retrieve it on remove
338 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
339 * the previous (now invalid) one
340 * @param ac address class the address belongs to
341 * @param addr either the previous or the new public IP address
342 * @param addrlen actual length of the @a addr
348 enum GNUNET_NAT_AddressClass ac,
349 const struct sockaddr *addr,
352 struct GNUNET_NAT_AUTO_Test *h = cls;
353 struct ClientActivity *ca;
354 struct GNUNET_MQ_Envelope *env;
355 struct GNUNET_NAT_AUTO_TestMessage *msg;
356 const struct sockaddr_in *sa;
359 if (GNUNET_YES != add_remove)
361 if (addrlen != sizeof(struct sockaddr_in))
363 LOG (GNUNET_ERROR_TYPE_DEBUG,
364 "NAT test ignores IPv6 address `%s' returned from NAT library\n",
365 GNUNET_a2s (addr, addrlen));
366 return; /* ignore IPv6 here */
368 LOG (GNUNET_ERROR_TYPE_INFO,
369 "Asking gnunet-nat-server to connect to `%s'\n",
370 GNUNET_a2s (addr, addrlen));
372 ca = GNUNET_new (struct ClientActivity);
374 ca->mq = GNUNET_CLIENT_connect (h->cfg,
382 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
383 _ ("Failed to connect to `gnunet-nat-server'\n"));
386 GNUNET_CONTAINER_DLL_insert (h->ca_head, h->ca_tail, ca);
387 sa = (const struct sockaddr_in *) addr;
388 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_NAT_TEST);
389 msg->dst_ipv4 = sa->sin_addr.s_addr;
390 msg->dport = sa->sin_port;
392 msg->is_tcp = htonl ((uint32_t) (h->proto == IPPROTO_TCP));
393 GNUNET_MQ_send (ca->mq, env);
398 * Calls the report-callback reporting failure.
400 * Destroys the nat handle after the callback has been processed.
402 * @param cls handle to the timed out NAT test
407 struct GNUNET_NAT_AUTO_Test *nh = cls;
410 nh->report (nh->report_cls, nh->status);
415 * Start testing if NAT traversal works using the given configuration.
416 * The transport adapters should be down while using this function.
418 * @param cfg configuration for the NAT traversal
419 * @param proto protocol to test, i.e. IPPROTO_TCP or IPPROTO_UDP
420 * @param section_name configuration section to use for configuration
421 * @param report function to call with the result of the test
422 * @param report_cls closure for @a report
423 * @return handle to cancel NAT test
425 struct GNUNET_NAT_AUTO_Test *
426 GNUNET_NAT_AUTO_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
428 const char *section_name,
429 GNUNET_NAT_TestCallback report,
432 struct GNUNET_NAT_AUTO_Test *nh;
433 unsigned long long bnd_port;
434 struct sockaddr_in sa;
435 const struct sockaddr *addrs[] = { (const struct sockaddr *) &sa };
436 const socklen_t addrlens[] = { sizeof(sa) };
438 if ((GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
444 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
445 _ ("Failed to find valid PORT in section `%s'\n"),
450 memset (&sa, 0, sizeof(sa));
451 sa.sin_family = AF_INET;
452 sa.sin_port = htons ((uint16_t) bnd_port);
453 #if HAVE_SOCKADDR_IN_SIN_LEN
454 sa.sin_len = sizeof(sa);
457 nh = GNUNET_new (struct GNUNET_NAT_AUTO_Test);
460 nh->section_name = GNUNET_strdup (section_name);
462 nh->report_cls = report_cls;
463 nh->status = GNUNET_NAT_ERROR_SUCCESS;
466 nh->nat = GNUNET_NAT_register (cfg,
479 GNUNET_NETWORK_socket_create (AF_INET,
480 (IPPROTO_UDP == proto) ? SOCK_DGRAM
483 if ((NULL == nh->lsock) ||
484 (GNUNET_OK != GNUNET_NETWORK_socket_bind (nh->lsock,
485 (const struct sockaddr *) &sa,
488 LOG (GNUNET_ERROR_TYPE_ERROR,
489 _ ("Failed to create socket bound to `%s' for NAT test: %s\n"),
490 GNUNET_a2s ((const struct sockaddr *) &sa, sizeof(sa)),
492 if (NULL != nh->lsock)
494 GNUNET_NETWORK_socket_close (nh->lsock);
497 nh->status = GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR;
498 nh->ttask = GNUNET_SCHEDULER_add_now (&do_fail, nh);
501 if (IPPROTO_TCP == proto)
503 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (nh->lsock, 5));
504 nh->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
511 nh->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
516 LOG (GNUNET_ERROR_TYPE_INFO,
517 "NAT test listens on port %llu (%s)\n",
519 (IPPROTO_TCP == proto) ? "tcp" : "udp");
520 nh->nat = GNUNET_NAT_register (cfg,
531 LOG (GNUNET_ERROR_TYPE_INFO,
532 _ ("NAT test failed to start NAT library\n"));
533 if (NULL != nh->ltask)
535 GNUNET_SCHEDULER_cancel (nh->ltask);
538 if (NULL != nh->lsock)
540 GNUNET_NETWORK_socket_close (nh->lsock);
543 nh->status = GNUNET_NAT_ERROR_NAT_REGISTER_FAILED;
544 nh->ttask = GNUNET_SCHEDULER_add_now (&do_fail, nh);
553 * Stop an active NAT test.
555 * @param tst test to stop.
558 GNUNET_NAT_AUTO_test_stop (struct GNUNET_NAT_AUTO_Test *tst)
560 struct NatActivity *pos;
561 struct ClientActivity *cpos;
563 LOG (GNUNET_ERROR_TYPE_DEBUG, "Stopping NAT test\n");
564 while (NULL != (cpos = tst->ca_head))
566 GNUNET_CONTAINER_DLL_remove (tst->ca_head, tst->ca_tail, cpos);
567 GNUNET_MQ_destroy (cpos->mq);
570 while (NULL != (pos = tst->na_head))
572 GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, pos);
573 GNUNET_SCHEDULER_cancel (pos->rtask);
574 GNUNET_NETWORK_socket_close (pos->sock);
577 if (NULL != tst->ttask)
579 GNUNET_SCHEDULER_cancel (tst->ttask);
582 if (NULL != tst->ltask)
584 GNUNET_SCHEDULER_cancel (tst->ltask);
587 if (NULL != tst->lsock)
589 GNUNET_NETWORK_socket_close (tst->lsock);
592 if (NULL != tst->nat)
594 GNUNET_NAT_unregister (tst->nat);
597 GNUNET_free (tst->section_name);
602 /* end of nat_auto_api_test.c */