2 This file is part of GNUnet.
3 (C) 2009, 2010 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.
21 * @file transport/test_transport_api.c
22 * @brief base test case for transport implementations
24 * This test case serves as a base for tcp, udp, and udp-nat
25 * transport test cases. Based on the executable being run
26 * the correct test case will be performed. Conservation of
30 #include "gnunet_common.h"
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_getopt_lib.h"
33 #include "gnunet_os_lib.h"
34 #include "gnunet_program_lib.h"
35 #include "gnunet_scheduler_lib.h"
36 #include "gnunet_transport_service.h"
37 #include "transport.h"
38 #include "transport-testing.h"
40 #define VERBOSE GNUNET_NO
42 #define VERBOSE_ARM GNUNET_NO
44 #define START_ARM GNUNET_YES
47 * How long until we give up on transmitting the message?
49 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 300)
52 * How long until we give up on transmitting the message?
54 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
58 static struct PeerContext p1;
60 static struct PeerContext p2;
66 static int is_tcp_nat;
72 static int is_udp_nat;
78 static int is_multi_protocol;
82 static GNUNET_SCHEDULER_TaskIdentifier die_task;
84 static GNUNET_SCHEDULER_TaskIdentifier tct;
86 static char * key_file_p1;
87 static char * cert_file_p1;
89 static char * key_file_p2;
90 static char * cert_file_p2;
92 struct GNUNET_TRANSPORT_TransmitHandle * th;
95 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
97 #define OKPP do { ok++; } while (0)
104 GNUNET_assert (ok == 6);
105 if (GNUNET_SCHEDULER_NO_TASK != die_task)
106 GNUNET_SCHEDULER_cancel (die_task);
107 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
108 "Disconnecting from transports!\n");
110 GNUNET_TRANSPORT_notify_transmit_ready_cancel(th);
113 GNUNET_TRANSPORT_disconnect (p1.th);
114 GNUNET_TRANSPORT_disconnect (p2.th);
115 die_task = GNUNET_SCHEDULER_NO_TASK;
116 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
117 "Transports disconnected, returning success!\n");
122 stop_arm (struct PeerContext *p)
125 if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
126 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
127 GNUNET_OS_process_wait (p->arm_proc);
128 GNUNET_OS_process_close (p->arm_proc);
131 GNUNET_CONFIGURATION_destroy (p->cfg);
138 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from transports!\n");
142 GNUNET_TRANSPORT_notify_transmit_ready_cancel(th);
145 GNUNET_TRANSPORT_disconnect (p1.th);
146 GNUNET_TRANSPORT_disconnect (p2.th);
147 if (GNUNET_SCHEDULER_NO_TASK != tct)
149 GNUNET_SCHEDULER_cancel (tct);
150 tct = GNUNET_SCHEDULER_NO_TASK;
157 notify_receive (void *cls,
158 const struct GNUNET_PeerIdentity *peer,
159 const struct GNUNET_MessageHeader *message,
160 const struct GNUNET_TRANSPORT_ATS_Information *ats,
163 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
164 "Received message of type %d from peer %s!\n",
165 ntohs(message->type),
167 GNUNET_assert (ok == 5);
169 GNUNET_assert (MTYPE == ntohs (message->type));
170 GNUNET_assert (sizeof (struct GNUNET_MessageHeader) ==
171 ntohs (message->size));
177 notify_ready (void *cls, size_t size, void *buf)
179 struct PeerContext *p = cls;
180 struct GNUNET_MessageHeader *hdr;
184 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
185 "Transmitting message with %u bytes to peer %s\n",
186 sizeof (struct GNUNET_MessageHeader),
187 GNUNET_i2s (&p->id));
188 GNUNET_assert (size >= 256);
189 GNUNET_assert (ok == 4);
194 hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
195 hdr->type = htons (MTYPE);
197 return sizeof (struct GNUNET_MessageHeader);
202 exchange_hello_last (void *cls,
203 const struct GNUNET_MessageHeader *message)
205 struct PeerContext *me = cls;
207 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
208 "Exchanging HELLO of size %d with peer (%s)!\n",
209 (int) GNUNET_HELLO_size((const struct GNUNET_HELLO_Message *)message),
210 GNUNET_i2s (&me->id));
211 GNUNET_assert (message != NULL);
212 GNUNET_assert (GNUNET_OK ==
213 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
215 GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
221 exchange_hello (void *cls,
222 const struct GNUNET_MessageHeader *message)
224 struct PeerContext *me = cls;
226 GNUNET_assert (message != NULL);
227 GNUNET_assert (GNUNET_OK ==
228 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
230 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
231 "Exchanging HELLO of size %d from peer %s!\n",
232 (int) GNUNET_HELLO_size((const struct GNUNET_HELLO_Message *)message),
233 GNUNET_i2s (&me->id));
234 GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
240 notify_connect (void *cls,
241 const struct GNUNET_PeerIdentity *peer,
242 const struct GNUNET_TRANSPORT_ATS_Information *ats,
245 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
246 "Peer `%4s' connected to us (%p)!\n",
251 GNUNET_assert (ok >= 2);
254 if (GNUNET_SCHEDULER_NO_TASK != die_task)
255 GNUNET_SCHEDULER_cancel (die_task);
256 if (GNUNET_SCHEDULER_NO_TASK != tct)
257 GNUNET_SCHEDULER_cancel (tct);
258 tct = GNUNET_SCHEDULER_NO_TASK;
259 GNUNET_TRANSPORT_get_hello_cancel (p2.th, &exchange_hello_last, &p2);
260 GNUNET_TRANSPORT_get_hello_cancel (p1.th, &exchange_hello, &p1);
261 die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT_TRANSMIT,
263 th = GNUNET_TRANSPORT_notify_transmit_ready (p1.th,
265 256, 0, TIMEOUT, ¬ify_ready,
272 notify_disconnect (void *cls,
273 const struct GNUNET_PeerIdentity *peer)
275 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
276 "Peer `%4s' disconnected (%p)!\n",
277 GNUNET_i2s (peer), cls);
282 setup_peer (struct PeerContext *p,
285 p->cfg = GNUNET_CONFIGURATION_create ();
287 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
288 if (GNUNET_CONFIGURATION_have_value (p->cfg,"PATHS", "SERVICEHOME"))
289 GNUNET_CONFIGURATION_get_value_string (p->cfg, "PATHS", "SERVICEHOME", &p->servicehome);
290 GNUNET_DISK_directory_remove (p->servicehome);
293 p->arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
294 "gnunet-service-arm",
298 "-c", cfgname, NULL);
302 if (GNUNET_CONFIGURATION_have_value (p->cfg,"PATHS", "SERVICEHOME"))
303 GNUNET_CONFIGURATION_get_value_string (p->cfg, "PATHS", "SERVICEHOME", &p->servicehome);
310 if (GNUNET_CONFIGURATION_have_value (p->cfg,
311 "transport-https", "KEY_FILE"))
312 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "KEY_FILE", &key_file_p1);
313 if (key_file_p1==NULL)
314 GNUNET_asprintf(&key_file_p1,"https.key");
315 if (0 == stat (key_file_p1, &sbuf ))
317 if (0 == remove(key_file_p1))
318 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
319 "Successfully removed existing private key file `%s'\n",key_file_p1);
321 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
322 "Failed to remove private key file `%s'\n",key_file_p1);
324 if (GNUNET_CONFIGURATION_have_value (p->cfg,"transport-https", "CERT_FILE"))
325 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "CERT_FILE", &cert_file_p1);
326 if (cert_file_p1==NULL)
327 GNUNET_asprintf(&cert_file_p1,"https.cert");
328 if (0 == stat (cert_file_p1, &sbuf ))
330 if (0 == remove(cert_file_p1))
331 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
332 "Successfully removed existing certificate file `%s'\n",
335 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
336 "Failed to remove existing certificate file `%s'\n",
342 if (GNUNET_CONFIGURATION_have_value (p->cfg,
343 "transport-https", "KEY_FILE"))
344 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "KEY_FILE", &key_file_p2);
345 if (key_file_p2==NULL)
346 GNUNET_asprintf(&key_file_p2,"https.key");
347 if (0 == stat (key_file_p2, &sbuf ))
349 if (0 == remove(key_file_p2))
350 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
351 "Successfully removed existing private key file `%s'\n",
354 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
355 "Failed to remove private key file `%s'\n",
358 if (GNUNET_CONFIGURATION_have_value (p->cfg,"transport-https", "CERT_FILE"))
359 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "CERT_FILE", &cert_file_p2);
360 if (cert_file_p2==NULL)
361 GNUNET_asprintf(&cert_file_p2,"https.cert");
362 if (0 == stat (cert_file_p2, &sbuf ))
364 if (0 == remove(cert_file_p2))
365 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
366 "Successfully removed existing certificate file `%s'\n",cert_file_p2);
368 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
369 "Failed to remove existing certificate file `%s'\n",cert_file_p2);
374 p->th = GNUNET_TRANSPORT_connect (p->cfg,
377 ¬ify_connect, ¬ify_disconnect);
378 GNUNET_assert (p->th != NULL);
383 try_connect (void *cls,
384 const struct GNUNET_SCHEDULER_TaskContext *tc)
386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
387 "Asking peers to connect...\n");
388 GNUNET_TRANSPORT_try_connect (p2.th,
390 GNUNET_TRANSPORT_try_connect (p1.th,
392 tct = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
401 const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
403 GNUNET_assert (ok == 1);
405 die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
410 setup_peer (&p1, "test_transport_api_udp_peer1.conf");
411 setup_peer (&p2, "test_transport_api_udp_peer2.conf");
415 setup_peer (&p1, "test_transport_api_unix_peer1.conf");
416 setup_peer (&p2, "test_transport_api_unix_peer2.conf");
418 if (is_multi_protocol)
420 setup_peer (&p1, "test_transport_api_multi_peer1.conf");
421 setup_peer (&p2, "test_transport_api_multi_peer2.conf");
425 setup_peer (&p1, "test_transport_api_tcp_peer1.conf");
426 setup_peer (&p2, "test_transport_api_tcp_peer2.conf");
430 setup_peer (&p1, "test_transport_api_tcp_nat_peer1.conf");
431 setup_peer (&p2, "test_transport_api_tcp_nat_peer2.conf");
435 setup_peer (&p1, "test_transport_api_udp_nat_peer1.conf");
436 setup_peer (&p2, "test_transport_api_udp_nat_peer2.conf");
440 setup_peer (&p1, "test_transport_api_http_peer1.conf");
441 setup_peer (&p2, "test_transport_api_http_peer2.conf");
445 setup_peer (&p1, "test_transport_api_https_peer1.conf");
446 setup_peer (&p2, "test_transport_api_https_peer2.conf");
450 setup_peer (&p1, "test_transport_api_wlan_peer1.conf");
451 setup_peer (&p2, "test_transport_api_wlan_peer2.conf");
453 GNUNET_assert(p1.th != NULL);
454 GNUNET_assert(p2.th != NULL);
456 GNUNET_TRANSPORT_get_hello (p1.th, &exchange_hello, &p1);
457 GNUNET_TRANSPORT_get_hello (p2.th, &exchange_hello_last, &p2);
458 tct = GNUNET_SCHEDULER_add_now (&try_connect, NULL);
464 static char *const argv[] = { "test-transport-api",
466 "test_transport_api_data.conf",
472 static struct GNUNET_GETOPT_CommandLineOption options[] = {
473 GNUNET_GETOPT_OPTION_END
477 setTransportOptions("test_transport_api_data.conf");
480 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
481 argv, "test-transport-api", "nohelp",
489 if (0 == stat (cert_file_p1, &sbuf ))
491 if (0 == remove(cert_file_p1))
492 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
493 "Successfully removed existing certificate file `%s'\n",cert_file_p1);
495 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
496 "Failed to remove certfile `%s'\n",cert_file_p1);
499 if (0 == stat (key_file_p1, &sbuf ))
501 if (0 == remove(key_file_p1))
502 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
503 "Successfully removed private key file `%s'\n",key_file_p1);
505 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
506 "Failed to private key file `%s'\n",key_file_p1);
509 if (0 == stat (cert_file_p2, &sbuf ))
511 if (0 == remove(cert_file_p2))
512 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
513 "Successfully removed existing certificate file `%s'\n",cert_file_p2);
515 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
516 "Failed to remove certfile `%s'\n",cert_file_p2);
519 if (0 == stat (key_file_p2, &sbuf ))
521 if (0 == remove(key_file_p2))
522 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
523 "Successfully removed private key file `%s'\n",key_file_p2);
525 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
526 "Failed to private key file `%s'\n",key_file_p2);
528 GNUNET_free(key_file_p1);
529 GNUNET_free(key_file_p2);
530 GNUNET_free(cert_file_p1);
531 GNUNET_free(cert_file_p2);
534 if ((p1.servicehome != NULL) && (p2.servicehome != NULL))
536 GNUNET_DISK_directory_remove (p1.servicehome);
537 GNUNET_DISK_directory_remove (p2.servicehome);
538 GNUNET_free(p1.servicehome);
539 GNUNET_free(p2.servicehome);
545 * Return the actual path to a file found in the current
546 * PATH environment variable.
548 * @param binary the name of the file to find
551 get_path_from_PATH (char *binary)
562 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
563 _("PATH environment variable is unset.\n"));
566 path = GNUNET_strdup (p); /* because we write on it */
567 buf = GNUNET_malloc (strlen (path) + 20);
570 while (NULL != (end = strchr (pos, PATH_SEPARATOR)))
573 sprintf (buf, "%s/%s", pos, binary);
574 if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
581 sprintf (buf, "%s/%s", pos, binary);
582 if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
593 * Check whether the suid bit is set on a file.
594 * Attempts to find the file using the current
595 * PATH environment variable as a search path.
597 * @param binary the name of the file to check
599 * @return GNUNET_YES if the binary is found and
600 * can be run properly, GNUNET_NO otherwise
603 check_gnunet_nat_binary(char *binary)
613 GNUNET_asprintf (&binaryexe, "%s.exe", binary);
614 p = get_path_from_PATH (binaryexe);
617 p = get_path_from_PATH (binary);
621 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
622 _("Could not find binary `%s' in PATH!\n"),
626 if (0 != STAT (p, &statbuf))
628 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
629 _("stat (%s) failed: %s\n"),
633 return GNUNET_SYSERR;
637 if ( (0 != (statbuf.st_mode & S_ISUID)) &&
638 (statbuf.st_uid == 0) )
642 rawsock = socket (AF_INET, SOCK_RAW, IPPROTO_ICMP);
643 if (INVALID_SOCKET == rawsock)
645 DWORD err = GetLastError ();
646 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
647 "socket (AF_INET, SOCK_RAW, IPPROTO_ICMP) have failed! GLE = %d\n", err);
648 return GNUNET_NO; /* not running as administrator */
650 closesocket (rawsock);
656 main (int argc, char *argv[])
660 GNUNET_log_setup ("test-transport-api",
668 if (strstr(argv[0], "tcp_nat") != NULL)
670 is_tcp_nat = GNUNET_YES;
674 if (GNUNET_YES != check_gnunet_nat_binary("gnunet-nat-server"))
676 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
677 "`%s' not properly installed, cannot run NAT test!\n",
678 "gnunet-nat-server");
682 else if (strstr(argv[0], "tcp") != NULL)
686 else if (strstr(argv[0], "udp_nat") != NULL)
688 is_udp_nat = GNUNET_YES;
692 if (GNUNET_YES != check_gnunet_nat_binary("gnunet-nat-server"))
694 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
695 "`%s' not properly installed, cannot run NAT test!\n",
696 "gnunet-nat-server");
700 else if (strstr(argv[0], "udp") != NULL)
704 else if (strstr(argv[0], "unix") != NULL)
706 is_unix = GNUNET_YES;
708 else if (strstr(argv[0], "https") != NULL)
710 is_https = GNUNET_YES;
715 else if (strstr(argv[0], "http") != NULL)
717 is_http = GNUNET_YES;
719 else if (strstr(argv[0], "wlan") != NULL)
721 is_wlan = GNUNET_YES;
723 else if (strstr(argv[0], "multi") != NULL)
725 is_multi_protocol = GNUNET_YES;
733 /* end of test_transport_api.c */