123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2011, 2016 GNUnet e.V.
- 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
- 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/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file nat/nat_auto_api_test.c
- * @brief functions to test if the NAT configuration is successful at achieving NAT traversal (with the help of a gnunet-nat-server)
- * @author Christian Grothoff
- */
- #include "platform.h"
- #include "gnunet_util_lib.h"
- #include "gnunet_nat_service.h"
- #include "gnunet_nat_auto_service.h"
- #include "nat-auto.h"
- #define LOG(kind,...) GNUNET_log_from (kind, "nat-auto", __VA_ARGS__)
- #define NAT_SERVER_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
- /**
- * Entry we keep for each incoming connection.
- */
- struct NatActivity
- {
- /**
- * This is a doubly-linked list.
- */
- struct NatActivity *next;
- /**
- * This is a doubly-linked list.
- */
- struct NatActivity *prev;
- /**
- * Socket of the incoming connection.
- */
- struct GNUNET_NETWORK_Handle *sock;
- /**
- * Handle of the master context.
- */
- struct GNUNET_NAT_AUTO_Test *h;
- /**
- * Task reading from the incoming connection.
- */
- struct GNUNET_SCHEDULER_Task *rtask;
- };
- /**
- * Entry we keep for each connection to the gnunet-nat-service.
- */
- struct ClientActivity
- {
- /**
- * This is a doubly-linked list.
- */
- struct ClientActivity *next;
- /**
- * This is a doubly-linked list.
- */
- struct ClientActivity *prev;
- /**
- * Socket of the incoming connection.
- */
- struct GNUNET_MQ_Handle *mq;
- /**
- * Handle to overall NAT test.
- */
- struct GNUNET_NAT_AUTO_Test *h;
- };
- /**
- * Handle to a NAT test.
- */
- struct GNUNET_NAT_AUTO_Test
- {
- /**
- * Configuration used
- */
- const struct GNUNET_CONFIGURATION_Handle *cfg;
- /**
- * Function to call with success report
- */
- GNUNET_NAT_TestCallback report;
- /**
- * Closure for @e report.
- */
- void *report_cls;
- /**
- * Handle to NAT traversal in use
- */
- struct GNUNET_NAT_Handle *nat;
- /**
- * Handle to listen socket, or NULL
- */
- struct GNUNET_NETWORK_Handle *lsock;
- /**
- * Head of list of nat activities.
- */
- struct NatActivity *na_head;
- /**
- * Tail of list of nat activities.
- */
- struct NatActivity *na_tail;
- /**
- * Head of list of client activities.
- */
- struct ClientActivity *ca_head;
- /**
- * Tail of list of client activities.
- */
- struct ClientActivity *ca_tail;
- /**
- * Identity of task for the listen socket (if any)
- */
- struct GNUNET_SCHEDULER_Task *ltask;
- /**
- * Task identifier for the timeout (if any)
- */
- struct GNUNET_SCHEDULER_Task *ttask;
- /**
- * Section name of plugin to test.
- */
- char *section_name;
- /**
- * IPPROTO_TCP or IPPROTO_UDP.
- */
- int proto;
- /**
- * Data that should be transmitted or source-port.
- */
- uint16_t data;
- /**
- * Status code to be reported to the timeout/status call
- */
- enum GNUNET_NAT_StatusCode status;
- };
- /**
- * Function called from #GNUNET_NAT_register whenever someone asks us
- * to do connection reversal.
- *
- * @param cls closure, our `struct GNUNET_NAT_Handle`
- * @param addr public IP address of the other peer
- * @param addrlen actual lenght of the @a addr
- */
- static void
- reversal_cb (void *cls,
- const struct sockaddr *addr,
- socklen_t addrlen)
- {
- struct GNUNET_NAT_AUTO_Test *h = cls;
- const struct sockaddr_in *sa;
- if (sizeof (struct sockaddr_in) != addrlen)
- return;
- sa = (const struct sockaddr_in *) addr;
- if (h->data != sa->sin_port)
- {
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Received connection reversal request for wrong port\n");
- return; /* wrong port */
- }
- /* report success */
- h->report (h->report_cls,
- GNUNET_NAT_ERROR_SUCCESS);
- }
- /**
- * Activity on our incoming socket. Read data from the
- * incoming connection.
- *
- * @param cls the `struct GNUNET_NAT_AUTO_Test`
- */
- static void
- do_udp_read (void *cls)
- {
- struct GNUNET_NAT_AUTO_Test *tst = cls;
- uint16_t data;
- const struct GNUNET_SCHEDULER_TaskContext *tc;
- tc = GNUNET_SCHEDULER_get_task_context ();
- tst->ltask =
- GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- tst->lsock,
- &do_udp_read,
- tst);
- if ((NULL != tc->write_ready) &&
- (GNUNET_NETWORK_fdset_isset (tc->read_ready,
- tst->lsock)) &&
- (sizeof (data) ==
- GNUNET_NETWORK_socket_recv (tst->lsock,
- &data,
- sizeof (data))))
- {
- if (data == tst->data)
- tst->report (tst->report_cls,
- GNUNET_NAT_ERROR_SUCCESS);
- else
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Received data mismatches expected value\n");
- }
- else
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Failed to receive data from inbound connection\n");
- }
- /**
- * Activity on our incoming socket. Read data from the
- * incoming connection.
- *
- * @param cls the `struct NatActivity`
- */
- static void
- do_read (void *cls)
- {
- struct NatActivity *na = cls;
- struct GNUNET_NAT_AUTO_Test *tst;
- uint16_t data;
- const struct GNUNET_SCHEDULER_TaskContext *tc;
- tc = GNUNET_SCHEDULER_get_task_context ();
- na->rtask = NULL;
- tst = na->h;
- GNUNET_CONTAINER_DLL_remove (tst->na_head,
- tst->na_tail,
- na);
- if ((NULL != tc->write_ready) &&
- (GNUNET_NETWORK_fdset_isset (tc->read_ready,
- na->sock)) &&
- (sizeof (data) ==
- GNUNET_NETWORK_socket_recv (na->sock,
- &data,
- sizeof (data))))
- {
- if (data == tst->data)
- tst->report (tst->report_cls,
- GNUNET_NAT_ERROR_SUCCESS);
- else
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Received data does not match expected value\n");
- }
- else
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Failed to receive data from inbound connection\n");
- GNUNET_NETWORK_socket_close (na->sock);
- GNUNET_free (na);
- }
- /**
- * Activity on our listen socket. Accept the
- * incoming connection.
- *
- * @param cls the `struct GNUNET_NAT_AUTO_Test`
- */
- static void
- do_accept (void *cls)
- {
- struct GNUNET_NAT_AUTO_Test *tst = cls;
- struct GNUNET_NETWORK_Handle *s;
- struct NatActivity *wl;
- tst->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- tst->lsock,
- &do_accept,
- tst);
- s = GNUNET_NETWORK_socket_accept (tst->lsock,
- NULL,
- NULL);
- if (NULL == s)
- {
- GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO,
- "accept");
- return; /* odd error */
- }
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Got an inbound connection, waiting for data\n");
- wl = GNUNET_new (struct NatActivity);
- wl->sock = s;
- wl->h = tst;
- wl->rtask =
- GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- wl->sock,
- &do_read,
- wl);
- GNUNET_CONTAINER_DLL_insert (tst->na_head,
- tst->na_tail,
- wl);
- }
- /**
- * We got disconnected from the NAT server. Stop
- * waiting for a reply.
- *
- * @param cls the `struct ClientActivity`
- * @param error error code
- */
- static void
- mq_error_handler (void *cls,
- enum GNUNET_MQ_Error error)
- {
- struct ClientActivity *ca = cls;
- struct GNUNET_NAT_AUTO_Test *tst = ca->h;
- GNUNET_CONTAINER_DLL_remove (tst->ca_head,
- tst->ca_tail,
- ca);
- GNUNET_MQ_destroy (ca->mq);
- GNUNET_free (ca);
- }
- /**
- * Address-callback, used to send message to gnunet-nat-server.
- *
- * @param cls closure
- * @param app_ctx[in,out] location where the app can store stuff
- * on add and retrieve it on remove
- * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
- * the previous (now invalid) one
- * @param ac address class the address belongs to
- * @param addr either the previous or the new public IP address
- * @param addrlen actual length of the @a addr
- */
- static void
- addr_cb (void *cls,
- void **app_ctx,
- int add_remove,
- enum GNUNET_NAT_AddressClass ac,
- const struct sockaddr *addr,
- socklen_t addrlen)
- {
- struct GNUNET_NAT_AUTO_Test *h = cls;
- struct ClientActivity *ca;
- struct GNUNET_MQ_Envelope *env;
- struct GNUNET_NAT_AUTO_TestMessage *msg;
- const struct sockaddr_in *sa;
- (void) app_ctx;
- if (GNUNET_YES != add_remove)
- return;
- if (addrlen != sizeof (struct sockaddr_in))
- {
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "NAT test ignores IPv6 address `%s' returned from NAT library\n",
- GNUNET_a2s (addr,
- addrlen));
- return; /* ignore IPv6 here */
- }
- LOG (GNUNET_ERROR_TYPE_INFO,
- "Asking gnunet-nat-server to connect to `%s'\n",
- GNUNET_a2s (addr,
- addrlen));
- ca = GNUNET_new (struct ClientActivity);
- ca->h = h;
- ca->mq = GNUNET_CLIENT_connect (h->cfg,
- "gnunet-nat-server",
- NULL,
- &mq_error_handler,
- ca);
- if (NULL == ca->mq)
- {
- GNUNET_free (ca);
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _("Failed to connect to `gnunet-nat-server'\n"));
- return;
- }
- GNUNET_CONTAINER_DLL_insert (h->ca_head,
- h->ca_tail,
- ca);
- sa = (const struct sockaddr_in *) addr;
- env = GNUNET_MQ_msg (msg,
- GNUNET_MESSAGE_TYPE_NAT_TEST);
- msg->dst_ipv4 = sa->sin_addr.s_addr;
- msg->dport = sa->sin_port;
- msg->data = h->data;
- msg->is_tcp = htonl ((uint32_t) (h->proto == IPPROTO_TCP));
- GNUNET_MQ_send (ca->mq,
- env);
- }
- /**
- * Calls the report-callback reporting failure.
- *
- * Destroys the nat handle after the callback has been processed.
- *
- * @param cls handle to the timed out NAT test
- */
- static void
- do_fail (void *cls)
- {
- struct GNUNET_NAT_AUTO_Test *nh = cls;
- nh->ttask = NULL;
- nh->report (nh->report_cls,
- nh->status);
- }
- /**
- * Start testing if NAT traversal works using the given configuration.
- * The transport adapters should be down while using this function.
- *
- * @param cfg configuration for the NAT traversal
- * @param proto protocol to test, i.e. IPPROTO_TCP or IPPROTO_UDP
- * @param section_name configuration section to use for configuration
- * @param report function to call with the result of the test
- * @param report_cls closure for @a report
- * @return handle to cancel NAT test
- */
- struct GNUNET_NAT_AUTO_Test *
- GNUNET_NAT_AUTO_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
- uint8_t proto,
- const char *section_name,
- GNUNET_NAT_TestCallback report,
- void *report_cls)
- {
- struct GNUNET_NAT_AUTO_Test *nh;
- unsigned long long bnd_port;
- struct sockaddr_in sa;
- const struct sockaddr *addrs[] = {
- (const struct sockaddr *) &sa
- };
- const socklen_t addrlens[] = {
- sizeof (sa)
- };
- if ( (GNUNET_OK !=
- GNUNET_CONFIGURATION_get_value_number (cfg,
- section_name,
- "PORT",
- &bnd_port)) ||
- (bnd_port > 65535) )
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _("Failed to find valid PORT in section `%s'\n"),
- section_name);
- return NULL;
- }
- memset (&sa, 0, sizeof (sa));
- sa.sin_family = AF_INET;
- sa.sin_port = htons ((uint16_t) bnd_port);
- #if HAVE_SOCKADDR_IN_SIN_LEN
- sa.sin_len = sizeof (sa);
- #endif
- nh = GNUNET_new (struct GNUNET_NAT_AUTO_Test);
- nh->cfg = cfg;
- nh->proto = proto;
- nh->section_name = GNUNET_strdup (section_name);
- nh->report = report;
- nh->report_cls = report_cls;
- nh->status = GNUNET_NAT_ERROR_SUCCESS;
- if (0 == bnd_port)
- {
- nh->nat
- = GNUNET_NAT_register (cfg,
- section_name,
- proto,
- 0, NULL, NULL,
- &addr_cb,
- &reversal_cb,
- nh);
- }
- else
- {
- nh->lsock
- = GNUNET_NETWORK_socket_create (AF_INET,
- (IPPROTO_UDP == proto)
- ? SOCK_DGRAM
- : SOCK_STREAM,
- proto);
- if ( (NULL == nh->lsock) ||
- (GNUNET_OK !=
- GNUNET_NETWORK_socket_bind (nh->lsock,
- (const struct sockaddr *) &sa,
- sizeof (sa))))
- {
- LOG (GNUNET_ERROR_TYPE_ERROR,
- _("Failed to create socket bound to `%s' for NAT test: %s\n"),
- GNUNET_a2s ((const struct sockaddr *) &sa,
- sizeof (sa)),
- STRERROR (errno));
- if (NULL != nh->lsock)
- {
- GNUNET_NETWORK_socket_close (nh->lsock);
- nh->lsock = NULL;
- }
- nh->status = GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR;
- nh->ttask = GNUNET_SCHEDULER_add_now (&do_fail,
- nh);
- return nh;
- }
- if (IPPROTO_TCP == proto)
- {
- GNUNET_break (GNUNET_OK ==
- GNUNET_NETWORK_socket_listen (nh->lsock,
- 5));
- nh->ltask =
- GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- nh->lsock,
- &do_accept,
- nh);
- }
- else
- {
- nh->ltask =
- GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- nh->lsock,
- &do_udp_read,
- nh);
- }
- LOG (GNUNET_ERROR_TYPE_INFO,
- "NAT test listens on port %llu (%s)\n",
- bnd_port,
- (IPPROTO_TCP == proto) ? "tcp" : "udp");
- nh->nat = GNUNET_NAT_register (cfg,
- section_name,
- proto,
- 1,
- addrs,
- addrlens,
- &addr_cb,
- NULL,
- nh);
- if (NULL == nh->nat)
- {
- LOG (GNUNET_ERROR_TYPE_INFO,
- _("NAT test failed to start NAT library\n"));
- if (NULL != nh->ltask)
- {
- GNUNET_SCHEDULER_cancel (nh->ltask);
- nh->ltask = NULL;
- }
- if (NULL != nh->lsock)
- {
- GNUNET_NETWORK_socket_close (nh->lsock);
- nh->lsock = NULL;
- }
- nh->status = GNUNET_NAT_ERROR_NAT_REGISTER_FAILED;
- nh->ttask = GNUNET_SCHEDULER_add_now (&do_fail,
- nh);
- return nh;
- }
- }
- return nh;
- }
- /**
- * Stop an active NAT test.
- *
- * @param tst test to stop.
- */
- void
- GNUNET_NAT_AUTO_test_stop (struct GNUNET_NAT_AUTO_Test *tst)
- {
- struct NatActivity *pos;
- struct ClientActivity *cpos;
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Stopping NAT test\n");
- while (NULL != (cpos = tst->ca_head))
- {
- GNUNET_CONTAINER_DLL_remove (tst->ca_head,
- tst->ca_tail,
- cpos);
- GNUNET_MQ_destroy (cpos->mq);
- GNUNET_free (cpos);
- }
- while (NULL != (pos = tst->na_head))
- {
- GNUNET_CONTAINER_DLL_remove (tst->na_head,
- tst->na_tail,
- pos);
- GNUNET_SCHEDULER_cancel (pos->rtask);
- GNUNET_NETWORK_socket_close (pos->sock);
- GNUNET_free (pos);
- }
- if (NULL != tst->ttask)
- {
- GNUNET_SCHEDULER_cancel (tst->ttask);
- tst->ttask = NULL;
- }
- if (NULL != tst->ltask)
- {
- GNUNET_SCHEDULER_cancel (tst->ltask);
- tst->ltask = NULL;
- }
- if (NULL != tst->lsock)
- {
- GNUNET_NETWORK_socket_close (tst->lsock);
- tst->lsock = NULL;
- }
- if (NULL != tst->nat)
- {
- GNUNET_NAT_unregister (tst->nat);
- tst->nat = NULL;
- }
- GNUNET_free (tst->section_name);
- GNUNET_free (tst);
- }
- /* end of nat_auto_api_test.c */
|