/*
This file is part of GNUnet.
- (C) 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2011 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
#include "gnunet_nat_lib.h"
#include "nat.h"
+#define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
+
+#define NAT_SERVER_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
/**
* Entry we keep for each incoming connection.
/**
* Task reading from the incoming connection.
*/
- GNUNET_SCHEDULER_TaskIdentifier rtask;
+ struct GNUNET_SCHEDULER_Task * rtask;
};
GNUNET_NAT_TestCallback report;
/**
- * Closure for 'report'.
+ * Closure for @e report.
*/
void *report_cls;
/**
* Identity of task for the listen socket (if any)
*/
- GNUNET_SCHEDULER_TaskIdentifier ltask;
+ struct GNUNET_SCHEDULER_Task * ltask;
+
+ /**
+ * Task identifier for the timeout (if any)
+ */
+ struct GNUNET_SCHEDULER_Task * ttask;
/**
* GNUNET_YES if we're testing TCP
*/
uint16_t adv_port;
+ /**
+ * 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
+ * Function called from #GNUNET_NAT_register whenever someone asks us
* to do connection reversal.
*
- * @param cls closure, our 'struct GNUNET_NAT_Handle'
+ * @param cls closure, our `struct GNUNET_NAT_Handle`
* @param addr public IP address of the other peer
* @param addrlen actual lenght of the address
*/
static void
-reversal_cb (void *cls, const struct sockaddr *addr, socklen_t addrlen)
+reversal_cb (void *cls,
+ const struct sockaddr *addr,
+ socklen_t addrlen)
{
struct GNUNET_NAT_Test *h = cls;
const struct sockaddr_in *sa;
- if (addrlen != sizeof (struct sockaddr_in))
+ if (sizeof (struct sockaddr_in) != addrlen)
return;
sa = (const struct sockaddr_in *) addr;
if (h->data != sa->sin_port)
{
-#if DEBUG_NAT
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "nat",
- "Received connection reversal request for wrong port\n");
-#endif
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Received connection reversal request for wrong port\n");
return; /* wrong port */
}
/* report success */
- h->report (h->report_cls, GNUNET_OK);
+ h->report (h->report_cls, GNUNET_NAT_ERROR_SUCCESS);
}
* Activity on our incoming socket. Read data from the
* incoming connection.
*
- * @param cls the 'struct NatActivity'
- * @param tc scheduler context
+ * @param cls the `struct GNUNET_NAT_Test`
*/
static void
-do_udp_read (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+do_udp_read (void *cls)
{
struct GNUNET_NAT_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,
+ 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)) &&
GNUNET_NETWORK_socket_recv (tst->lsock, &data, sizeof (data))))
{
if (data == tst->data)
- tst->report (tst->report_cls, GNUNET_OK);
-#if DEBUG_NAT
+ tst->report (tst->report_cls, GNUNET_NAT_ERROR_SUCCESS);
else
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "nat",
- "Received data mismatches expected value\n");
-#endif
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Received data mismatches expected value\n");
}
-#if DEBUG_NAT
else
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "nat",
- "Failed to receive data from inbound connection\n");
-#endif
+ 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'
- * @param tc scheduler context
+ * @param cls the `struct NatActivity`
*/
static void
-do_read (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+do_read (void *cls)
{
struct NatActivity *na = cls;
struct GNUNET_NAT_Test *tst;
uint16_t data;
+ const struct GNUNET_SCHEDULER_TaskContext *tc;
- na->rtask = GNUNET_SCHEDULER_NO_TASK;
+ tc = GNUNET_SCHEDULER_get_task_context ();
+ na->rtask = NULL;
tst = na->h;
- GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, na);
+ 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_OK);
-#if DEBUG_NAT
+ tst->report (tst->report_cls, GNUNET_NAT_ERROR_SUCCESS);
else
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
- "nat" "Received data mismatches expected value\n");
-#endif
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Received data does not match expected value\n");
}
-#if DEBUG_NAT
else
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "nat",
- "Failed to receive data from inbound connection\n");
-#endif
+ 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_Test'
- * @param tc scheduler context
+ * @param cls the `struct GNUNET_NAT_Test`
*/
static void
-do_accept (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+do_accept (void *cls)
{
struct GNUNET_NAT_Test *tst = cls;
struct GNUNET_NETWORK_Handle *s;
struct NatActivity *wl;
- tst->ltask = GNUNET_SCHEDULER_NO_TASK;
- if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
- return;
tst->ltask =
- GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL, tst->lsock,
+ 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 */
}
-#if DEBUG_NAT
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "nat",
- "Got an inbound connection, waiting for data\n");
-#endif
- wl = GNUNET_malloc (sizeof (struct NatActivity));
+ 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);
+ 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);
}
* Address-callback, used to send message to gnunet-nat-server.
*
* @param cls closure
- * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
+ * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
* the previous (now invalid) one
* @param addr either the previous or the new public IP address
- * @param addrlen actual lenght of the address
+ * @param addrlen actual length of the @a addr
*/
static void
-addr_cb (void *cls, int add_remove, const struct sockaddr *addr,
+addr_cb (void *cls,
+ int add_remove,
+ const struct sockaddr *addr,
socklen_t addrlen)
{
struct GNUNET_NAT_Test *h = cls;
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 */
-#if DEBUG_NAT
- GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "nat",
- "Asking gnunet-nat-server to connect to `%s'\n",
- GNUNET_a2s (addr, addrlen));
-#endif
+ }
+ LOG (GNUNET_ERROR_TYPE_INFO,
+ "Asking gnunet-nat-server to connect to `%s'\n",
+ GNUNET_a2s (addr, addrlen));
sa = (const struct sockaddr_in *) addr;
msg.header.size = htons (sizeof (struct GNUNET_NAT_TestMessage));
msg.header.type = htons (GNUNET_MESSAGE_TYPE_NAT_TEST);
_("Failed to connect to `gnunet-nat-server'\n"));
return;
}
- ca = GNUNET_malloc (sizeof (struct ClientActivity));
+ ca = GNUNET_new (struct ClientActivity);
ca->client = client;
GNUNET_CONTAINER_DLL_insert (h->ca_head, h->ca_tail, ca);
GNUNET_break (GNUNET_OK ==
GNUNET_CLIENT_transmit_and_get_response (client, &msg.header,
- GNUNET_TIME_UNIT_SECONDS,
+ NAT_SERVER_TIMEOUT,
GNUNET_YES, NULL,
NULL));
}
+/**
+ * Timeout task for a nat test.
+ * Calls the report-callback with a timeout return value
+ *
+ * Destroys the nat handle after the callback has been processed.
+ *
+ * @param cls handle to the timed out NAT test
+ */
+static void
+do_timeout (void *cls)
+{
+ struct GNUNET_NAT_Test *nh = cls;
+
+ nh->ttask = NULL;
+ nh->report (nh->report_cls,
+ (GNUNET_NAT_ERROR_SUCCESS == nh->status)
+ ? GNUNET_NAT_ERROR_TIMEOUT
+ : nh->status);
+}
+
+
/**
* Start testing if NAT traversal works using the
* given configuration (IPv4-only).
*
+ * ALL failures are reported directly to the report callback
+ *
* @param cfg configuration for the NAT traversal
- * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
+ * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
* @param bnd_port port to bind to, 0 for connection reversal
* @param adv_port externally advertised port to use
+ * @param timeout delay after which the test should be aborted
* @param report function to call with the result of the test
- * @param report_cls closure for report
- * @return handle to cancel NAT test
+ * @param report_cls closure for @a report
+ * @return handle to cancel NAT test or NULL. The error is always indicated via the report callback
*/
struct GNUNET_NAT_Test *
GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
- int is_tcp, uint16_t bnd_port, uint16_t adv_port,
- GNUNET_NAT_TestCallback report, void *report_cls)
+ int is_tcp,
+ uint16_t bnd_port,
+ uint16_t adv_port,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_NAT_TestCallback report,
+ void *report_cls)
{
- struct GNUNET_NAT_Test *ret;
+ struct GNUNET_NAT_Test *nh;
struct sockaddr_in sa;
const struct sockaddr *addrs[] = { (const struct sockaddr *) &sa };
const socklen_t addrlens[] = { sizeof (sa) };
sa.sin_len = sizeof (sa);
#endif
- ret = GNUNET_malloc (sizeof (struct GNUNET_NAT_Test));
- ret->cfg = cfg;
- ret->is_tcp = is_tcp;
- ret->data = bnd_port;
- ret->adv_port = adv_port;
- ret->report = report;
- ret->report_cls = report_cls;
- if (bnd_port == 0)
+ nh = GNUNET_new (struct GNUNET_NAT_Test);
+ nh->cfg = cfg;
+ nh->is_tcp = is_tcp;
+ nh->data = bnd_port;
+ nh->adv_port = adv_port;
+ nh->report = report;
+ nh->report_cls = report_cls;
+ nh->status = GNUNET_NAT_ERROR_SUCCESS;
+ if (0 == bnd_port)
{
- ret->nat =
- GNUNET_NAT_register (cfg, is_tcp, 0, 0, NULL, NULL, &addr_cb,
- &reversal_cb, ret);
+ nh->nat
+ = GNUNET_NAT_register (cfg, is_tcp, 0, 0,
+ NULL, NULL,
+ &addr_cb,
+ &reversal_cb, nh, NULL);
}
else
{
- ret->lsock =
+ nh->lsock =
GNUNET_NETWORK_socket_create (AF_INET,
(is_tcp ==
GNUNET_YES) ? SOCK_STREAM : SOCK_DGRAM,
0);
- if ((ret->lsock == NULL) ||
+ if ((nh->lsock == NULL) ||
(GNUNET_OK !=
- GNUNET_NETWORK_socket_bind (ret->lsock, (const struct sockaddr *) &sa,
+ GNUNET_NETWORK_socket_bind (nh->lsock, (const struct sockaddr *) &sa,
sizeof (sa))))
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _
- ("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
+ _("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
GNUNET_a2s ((const struct sockaddr *) &sa, sizeof (sa)),
STRERROR (errno));
- if (NULL != ret->lsock)
- GNUNET_NETWORK_socket_close (ret->lsock);
- GNUNET_free (ret);
- return NULL;
+ 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_timeout, nh);
+ return nh;
}
if (GNUNET_YES == is_tcp)
{
- GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (ret->lsock, 5));
- ret->ltask =
+ GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (nh->lsock, 5));
+ nh->ltask =
GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- ret->lsock, &do_accept, ret);
+ nh->lsock,
+ &do_accept, nh);
}
else
{
- ret->ltask =
+ nh->ltask =
GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
- ret->lsock, &do_udp_read, ret);
+ nh->lsock,
+ &do_udp_read, nh);
+ }
+ LOG (GNUNET_ERROR_TYPE_INFO,
+ "NAT test listens on port %u (%s)\n",
+ bnd_port,
+ (GNUNET_YES == is_tcp) ? "tcp" : "udp");
+ nh->nat = GNUNET_NAT_register (cfg, is_tcp, adv_port, 1,
+ addrs, addrlens,
+ &addr_cb, NULL, nh, NULL);
+ 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_timeout, nh);
+ return nh;
}
- ret->nat =
- GNUNET_NAT_register (cfg, is_tcp, adv_port, 1, addrs, addrlens,
- &addr_cb, NULL, ret);
}
- return ret;
+ nh->ttask = GNUNET_SCHEDULER_add_delayed (timeout,
+ &do_timeout,
+ nh);
+ return nh;
}
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_CLIENT_disconnect (cpos->client, GNUNET_NO);
+ GNUNET_CONTAINER_DLL_remove (tst->ca_head,
+ tst->ca_tail,
+ cpos);
+ GNUNET_CLIENT_disconnect (cpos->client);
GNUNET_free (cpos);
}
while (NULL != (pos = tst->na_head))
{
- GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, pos);
+ 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 (GNUNET_SCHEDULER_NO_TASK != tst->ltask)
+ if (NULL != tst->ttask)
+ GNUNET_SCHEDULER_cancel (tst->ttask);
+ if (NULL != tst->ltask)
GNUNET_SCHEDULER_cancel (tst->ltask);
if (NULL != tst->lsock)
GNUNET_NETWORK_socket_close (tst->lsock);
- GNUNET_NAT_unregister (tst->nat);
+ if (NULL != tst->nat)
+ GNUNET_NAT_unregister (tst->nat);
GNUNET_free (tst);
}
projects / oweals / gnunet.git / blobdiff