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 (NULL != p->arm_proc)
127 if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
128 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
129 GNUNET_OS_process_wait (p->arm_proc);
130 GNUNET_OS_process_close (p->arm_proc);
134 GNUNET_CONFIGURATION_destroy (p->cfg);
141 exchange_hello_last (void *cls,
142 const struct GNUNET_MessageHeader *message)
144 struct PeerContext *me = cls;
146 GNUNET_assert (message != NULL);
147 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
148 "Exchanging HELLO of size %d with peer (%s)!\n",
149 (int) GNUNET_HELLO_size((const struct GNUNET_HELLO_Message *)message),
150 GNUNET_i2s (&me->id));
151 GNUNET_assert (GNUNET_OK ==
152 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
154 GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
159 exchange_hello (void *cls,
160 const struct GNUNET_MessageHeader *message)
162 struct PeerContext *me = cls;
164 GNUNET_assert (message != NULL);
165 GNUNET_assert (GNUNET_OK ==
166 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
168 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
169 "Exchanging HELLO of size %d from peer %s!\n",
170 (int) GNUNET_HELLO_size((const struct GNUNET_HELLO_Message *)message),
171 GNUNET_i2s (&me->id));
172 GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
179 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from transports!\n");
184 GNUNET_TRANSPORT_notify_transmit_ready_cancel(th);
189 GNUNET_TRANSPORT_get_hello_cancel (p2.th, &exchange_hello_last, &p2);
190 GNUNET_TRANSPORT_get_hello_cancel (p1.th, &exchange_hello, &p1);
193 GNUNET_TRANSPORT_disconnect (p1.th);
194 GNUNET_TRANSPORT_disconnect (p2.th);
195 if (GNUNET_SCHEDULER_NO_TASK != tct)
197 GNUNET_SCHEDULER_cancel (tct);
198 tct = GNUNET_SCHEDULER_NO_TASK;
205 notify_receive (void *cls,
206 const struct GNUNET_PeerIdentity *peer,
207 const struct GNUNET_MessageHeader *message,
208 const struct GNUNET_TRANSPORT_ATS_Information *ats,
211 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
212 "Received message of type %d from peer %s!\n",
213 ntohs(message->type),
215 GNUNET_assert (ok == 5);
217 GNUNET_assert (MTYPE == ntohs (message->type));
218 GNUNET_assert (sizeof (struct GNUNET_MessageHeader) ==
219 ntohs (message->size));
225 notify_ready (void *cls, size_t size, void *buf)
227 struct PeerContext *p = cls;
228 struct GNUNET_MessageHeader *hdr;
232 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
233 "Transmitting message with %u bytes to peer %s\n",
234 sizeof (struct GNUNET_MessageHeader),
235 GNUNET_i2s (&p->id));
236 GNUNET_assert (size >= 256);
237 GNUNET_assert (ok == 4);
242 hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
243 hdr->type = htons (MTYPE);
245 return sizeof (struct GNUNET_MessageHeader);
250 notify_connect (void *cls,
251 const struct GNUNET_PeerIdentity *peer,
252 const struct GNUNET_TRANSPORT_ATS_Information *ats,
255 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
256 "Peer `%4s' connected to us (%p)!\n",
261 GNUNET_assert (ok >= 2);
264 if (GNUNET_SCHEDULER_NO_TASK != die_task)
265 GNUNET_SCHEDULER_cancel (die_task);
266 if (GNUNET_SCHEDULER_NO_TASK != tct)
267 GNUNET_SCHEDULER_cancel (tct);
268 tct = GNUNET_SCHEDULER_NO_TASK;
269 GNUNET_TRANSPORT_get_hello_cancel (p2.th, &exchange_hello_last, &p2);
270 GNUNET_TRANSPORT_get_hello_cancel (p1.th, &exchange_hello, &p1);
271 die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT_TRANSMIT,
273 th = GNUNET_TRANSPORT_notify_transmit_ready (p1.th,
275 256, 0, TIMEOUT, ¬ify_ready,
282 notify_disconnect (void *cls,
283 const struct GNUNET_PeerIdentity *peer)
285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
286 "Peer `%4s' disconnected (%p)!\n",
287 GNUNET_i2s (peer), cls);
292 setup_peer (struct PeerContext *p,
295 p->cfg = GNUNET_CONFIGURATION_create ();
297 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
298 if (GNUNET_CONFIGURATION_have_value (p->cfg,"PATHS", "SERVICEHOME"))
299 GNUNET_CONFIGURATION_get_value_string (p->cfg, "PATHS", "SERVICEHOME", &p->servicehome);
300 if (NULL != p->servicehome)
301 GNUNET_DISK_directory_remove (p->servicehome);
304 p->arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
305 "gnunet-service-arm",
309 "-c", cfgname, NULL);
319 if (GNUNET_CONFIGURATION_have_value (p->cfg,
320 "transport-https", "KEY_FILE"))
321 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "KEY_FILE", &key_file_p1);
322 if (key_file_p1==NULL)
323 GNUNET_asprintf(&key_file_p1,"https.key");
324 if (0 == stat (key_file_p1, &sbuf ))
326 if (0 == remove(key_file_p1))
327 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
328 "Successfully removed existing private key file `%s'\n",key_file_p1);
330 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
331 "Failed to remove private key file `%s'\n",key_file_p1);
333 if (GNUNET_CONFIGURATION_have_value (p->cfg,"transport-https", "CERT_FILE"))
334 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "CERT_FILE", &cert_file_p1);
335 if (cert_file_p1==NULL)
336 GNUNET_asprintf(&cert_file_p1,"https.cert");
337 if (0 == stat (cert_file_p1, &sbuf ))
339 if (0 == remove(cert_file_p1))
340 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
341 "Successfully removed existing certificate file `%s'\n",
344 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
345 "Failed to remove existing certificate file `%s'\n",
351 if (GNUNET_CONFIGURATION_have_value (p->cfg,
352 "transport-https", "KEY_FILE"))
353 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "KEY_FILE", &key_file_p2);
354 if (key_file_p2==NULL)
355 GNUNET_asprintf(&key_file_p2,"https.key");
356 if (0 == stat (key_file_p2, &sbuf ))
358 if (0 == remove(key_file_p2))
359 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
360 "Successfully removed existing private key file `%s'\n",
363 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
364 "Failed to remove private key file `%s'\n",
367 if (GNUNET_CONFIGURATION_have_value (p->cfg,"transport-https", "CERT_FILE"))
368 GNUNET_CONFIGURATION_get_value_string (p->cfg, "transport-https", "CERT_FILE", &cert_file_p2);
369 if (cert_file_p2==NULL)
370 GNUNET_asprintf(&cert_file_p2,"https.cert");
371 if (0 == stat (cert_file_p2, &sbuf ))
373 if (0 == remove(cert_file_p2))
374 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
375 "Successfully removed existing certificate file `%s'\n",cert_file_p2);
377 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
378 "Failed to remove existing certificate file `%s'\n",cert_file_p2);
383 p->th = GNUNET_TRANSPORT_connect (p->cfg,
386 ¬ify_connect, ¬ify_disconnect);
387 GNUNET_assert (p->th != NULL);
392 try_connect (void *cls,
393 const struct GNUNET_SCHEDULER_TaskContext *tc)
395 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
396 "Asking peers to connect...\n");
397 /* FIXME: 'pX.id' may still be all-zeros here... */
398 GNUNET_TRANSPORT_try_connect (p2.th,
400 GNUNET_TRANSPORT_try_connect (p1.th,
402 tct = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
411 const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
413 GNUNET_assert (ok == 1);
415 die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
420 setup_peer (&p1, "test_transport_api_udp_peer1.conf");
421 setup_peer (&p2, "test_transport_api_udp_peer2.conf");
425 setup_peer (&p1, "test_transport_api_unix_peer1.conf");
426 setup_peer (&p2, "test_transport_api_unix_peer2.conf");
428 if (is_multi_protocol)
430 setup_peer (&p1, "test_transport_api_multi_peer1.conf");
431 setup_peer (&p2, "test_transport_api_multi_peer2.conf");
435 setup_peer (&p1, "test_transport_api_tcp_peer1.conf");
436 setup_peer (&p2, "test_transport_api_tcp_peer2.conf");
440 setup_peer (&p1, "test_transport_api_tcp_nat_peer1.conf");
441 setup_peer (&p2, "test_transport_api_tcp_nat_peer2.conf");
445 setup_peer (&p1, "test_transport_api_udp_nat_peer1.conf");
446 setup_peer (&p2, "test_transport_api_udp_nat_peer2.conf");
450 setup_peer (&p1, "test_transport_api_http_peer1.conf");
451 setup_peer (&p2, "test_transport_api_http_peer2.conf");
455 setup_peer (&p1, "test_transport_api_https_peer1.conf");
456 setup_peer (&p2, "test_transport_api_https_peer2.conf");
460 setup_peer (&p1, "test_transport_api_wlan_peer1.conf");
461 setup_peer (&p2, "test_transport_api_wlan_peer2.conf");
463 GNUNET_assert(p1.th != NULL);
464 GNUNET_assert(p2.th != NULL);
466 GNUNET_TRANSPORT_get_hello (p1.th, &exchange_hello, &p1);
467 GNUNET_TRANSPORT_get_hello (p2.th, &exchange_hello_last, &p2);
468 tct = GNUNET_SCHEDULER_add_now (&try_connect, NULL);
474 static char *const argv[] = { "test-transport-api",
476 "test_transport_api_data.conf",
482 static struct GNUNET_GETOPT_CommandLineOption options[] = {
483 GNUNET_GETOPT_OPTION_END
487 setTransportOptions("test_transport_api_data.conf");
490 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
491 argv, "test-transport-api", "nohelp",
499 if (0 == stat (cert_file_p1, &sbuf ))
501 if (0 == remove(cert_file_p1))
502 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
503 "Successfully removed existing certificate file `%s'\n",cert_file_p1);
505 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
506 "Failed to remove certfile `%s'\n",cert_file_p1);
509 if (0 == stat (key_file_p1, &sbuf ))
511 if (0 == remove(key_file_p1))
512 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
513 "Successfully removed private key file `%s'\n",key_file_p1);
515 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
516 "Failed to private key file `%s'\n",key_file_p1);
519 if (0 == stat (cert_file_p2, &sbuf ))
521 if (0 == remove(cert_file_p2))
522 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
523 "Successfully removed existing certificate file `%s'\n",cert_file_p2);
525 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
526 "Failed to remove certfile `%s'\n",cert_file_p2);
529 if (0 == stat (key_file_p2, &sbuf ))
531 if (0 == remove(key_file_p2))
532 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
533 "Successfully removed private key file `%s'\n",key_file_p2);
535 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
536 "Failed to private key file `%s'\n",key_file_p2);
538 GNUNET_free(key_file_p1);
539 GNUNET_free(key_file_p2);
540 GNUNET_free(cert_file_p1);
541 GNUNET_free(cert_file_p2);
544 if (p1.servicehome != NULL)
546 GNUNET_DISK_directory_remove (p1.servicehome);
547 GNUNET_free(p1.servicehome);
549 if (p2.servicehome != NULL)
551 GNUNET_DISK_directory_remove (p2.servicehome);
552 GNUNET_free(p2.servicehome);
558 * Return the actual path to a file found in the current
559 * PATH environment variable.
561 * @param binary the name of the file to find
564 get_path_from_PATH (char *binary)
575 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
576 _("PATH environment variable is unset.\n"));
579 path = GNUNET_strdup (p); /* because we write on it */
580 buf = GNUNET_malloc (strlen (path) + 20);
583 while (NULL != (end = strchr (pos, PATH_SEPARATOR)))
586 sprintf (buf, "%s/%s", pos, binary);
587 if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
594 sprintf (buf, "%s/%s", pos, binary);
595 if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
606 * Check whether the suid bit is set on a file.
607 * Attempts to find the file using the current
608 * PATH environment variable as a search path.
610 * @param binary the name of the file to check
612 * @return GNUNET_YES if the binary is found and
613 * can be run properly, GNUNET_NO otherwise
616 check_gnunet_nat_binary(char *binary)
626 GNUNET_asprintf (&binaryexe, "%s.exe", binary);
627 p = get_path_from_PATH (binaryexe);
630 p = get_path_from_PATH (binary);
634 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
635 _("Could not find binary `%s' in PATH!\n"),
639 if (0 != STAT (p, &statbuf))
641 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
642 _("stat (%s) failed: %s\n"),
646 return GNUNET_SYSERR;
650 if ( (0 != (statbuf.st_mode & S_ISUID)) &&
651 (statbuf.st_uid == 0) )
655 rawsock = socket (AF_INET, SOCK_RAW, IPPROTO_ICMP);
656 if (INVALID_SOCKET == rawsock)
658 DWORD err = GetLastError ();
659 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
660 "socket (AF_INET, SOCK_RAW, IPPROTO_ICMP) have failed! GLE = %d\n", err);
661 return GNUNET_NO; /* not running as administrator */
663 closesocket (rawsock);
669 main (int argc, char *argv[])
673 GNUNET_log_setup ("test-transport-api",
681 if (strstr(argv[0], "tcp_nat") != NULL)
683 is_tcp_nat = GNUNET_YES;
684 if (GNUNET_YES != check_gnunet_nat_binary("gnunet-nat-server"))
686 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
687 "`%s' not properly installed, cannot run NAT test!\n",
688 "gnunet-nat-server");
692 else if (strstr(argv[0], "tcp") != NULL)
696 else if (strstr(argv[0], "udp_nat") != NULL)
698 is_udp_nat = GNUNET_YES;
699 if (GNUNET_YES != check_gnunet_nat_binary("gnunet-nat-server"))
701 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
702 "`%s' not properly installed, cannot run NAT test!\n",
703 "gnunet-nat-server");
707 else if (strstr(argv[0], "udp") != NULL)
711 else if (strstr(argv[0], "unix") != NULL)
713 is_unix = GNUNET_YES;
715 else if (strstr(argv[0], "https") != NULL)
717 is_https = GNUNET_YES;
719 else if (strstr(argv[0], "http") != NULL)
721 is_http = GNUNET_YES;
723 else if (strstr(argv[0], "wlan") != NULL)
725 is_wlan = GNUNET_YES;
727 else if (strstr(argv[0], "multi") != NULL)
729 is_multi_protocol = GNUNET_YES;
737 /* end of test_transport_api.c */