2 This file is part of GNUnet
3 Copyright (C) 2007, 2009, 2011, 2012, 2015, 2017 Christian Grothoff
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
22 * @file test_gns_vpn.c
23 * @brief testcase for accessing VPN services via GNS
24 * @author Martin Schanzenbach
25 * @author Christian Grothoff
27 * This test requires libcurl/libgnurl *with* support for C-ARES.
28 * This is NOT the default on most platforms, which means the test
29 * will be skipped in many cases. Compile libcurl/libgnurl with
30 * "--enable-ares" to get this test to pass.
32 * Furthermore, the test relies on gnunet-dns2gns being able to bind
33 * to port 53. This means that 'setcap' has to have worked during
34 * 'make install'. If this failed, but everything else is OK, the
35 * test may FAIL hard even though it is just an installation issue (we
36 * cannot conveniently test for the setcap to have worked). However,
37 * you should get a warning that gnunet-dns2gns failed to 'bind'.
40 /* Just included for the right curl.h */
41 #include "gnunet_curl_lib.h"
42 #include <microhttpd.h>
43 #include "gnunet_identity_service.h"
44 #include "gnunet_namestore_service.h"
45 #include "gnunet_gnsrecord_lib.h"
46 #include "gnunet_gns_service.h"
47 #include "gnunet_testing_lib.h"
50 #define TEST_DOMAIN "www.gnu"
52 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
55 * Return value for #main().
57 static int global_ret;
59 static struct GNUNET_NAMESTORE_Handle *namestore;
61 static struct MHD_Daemon *mhd;
63 static struct GNUNET_SCHEDULER_Task *mhd_task_id;
65 static struct GNUNET_SCHEDULER_Task *curl_task_id;
67 static struct GNUNET_SCHEDULER_Task *timeout_task;
69 static struct GNUNET_IDENTITY_Handle *identity;
71 static struct GNUNET_NAMESTORE_QueueEntry *qe;
79 static struct GNUNET_PeerIdentity id;
82 * IP address of the ultimate destination.
84 static const char *dest_ip;
87 * Address family of the dest_ip.
92 * Address family to use by the curl client.
105 static struct CBC cbc;
109 copy_buffer (void *ptr,
114 struct CBC *cbc = ctx;
116 if (cbc->pos + size * nmemb > sizeof(cbc->buf))
117 return 0; /* overflow */
118 GNUNET_memcpy (&cbc->buf[cbc->pos], ptr, size * nmemb);
119 cbc->pos += size * nmemb;
126 struct MHD_Connection *connection,
130 const char *upload_data, size_t *upload_data_size,
134 struct MHD_Response *response;
137 if (0 != strcmp ("GET", method))
138 return MHD_NO; /* unexpected method */
145 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
146 "MHD sends respose for request to URL `%s'\n", url);
147 response = MHD_create_response_from_buffer (strlen (url),
149 MHD_RESPMEM_MUST_COPY);
150 ret = MHD_queue_response (connection, MHD_HTTP_OK, response);
151 MHD_destroy_response (response);
159 do_shutdown (void *cls)
161 if (NULL != mhd_task_id)
163 GNUNET_SCHEDULER_cancel (mhd_task_id);
166 if (NULL != curl_task_id)
168 GNUNET_SCHEDULER_cancel (curl_task_id);
171 if (NULL != timeout_task)
173 GNUNET_SCHEDULER_cancel (timeout_task);
178 MHD_stop_daemon (mhd);
181 if (NULL != identity)
183 GNUNET_IDENTITY_disconnect (identity);
188 GNUNET_NAMESTORE_cancel (qe);
191 if (NULL != namestore)
193 GNUNET_NAMESTORE_disconnect (namestore);
196 GNUNET_free_non_null (url);
202 do_timeout (void *cls)
205 GNUNET_SCHEDULER_shutdown ();
210 * Function to run the HTTP client.
217 curl_task (void *cls)
231 struct GNUNET_NETWORK_FDSet nrs;
232 struct GNUNET_NETWORK_FDSet nws;
233 struct GNUNET_TIME_Relative delay;
242 curl_multi_perform (multi, &running);
245 GNUNET_assert (NULL != (msg = curl_multi_info_read (multi, &running)));
246 if (msg->msg == CURLMSG_DONE)
248 if (msg->data.result != CURLE_OK)
251 "%s failed at %s:%d: `%s'\n",
252 "curl_multi_perform",
254 __LINE__, curl_easy_strerror (msg->data.result));
258 curl_multi_remove_handle (multi, curl);
259 curl_multi_cleanup (multi);
260 curl_easy_cleanup (curl);
263 if (cbc.pos != strlen ("/hello_world"))
268 if (0 != strncmp ("/hello_world", cbc.buf, strlen ("/hello_world")))
273 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
274 "Download complete, shutting down!\n");
275 GNUNET_SCHEDULER_shutdown ();
278 GNUNET_assert (CURLM_OK == curl_multi_fdset (multi, &rs, &ws, &es, &max));
279 if ((CURLM_OK != curl_multi_timeout (multi, &timeout)) ||
281 delay = GNUNET_TIME_UNIT_SECONDS;
283 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
284 (unsigned int) timeout);
285 GNUNET_NETWORK_fdset_copy_native (&nrs,
288 GNUNET_NETWORK_fdset_copy_native (&nws,
291 curl_task_id = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
301 start_curl (void *cls)
306 GNUNET_asprintf (&url,
307 "http://%s/hello_world",
309 curl = curl_easy_init ();
310 curl_easy_setopt (curl, CURLOPT_URL, url);
311 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, ©_buffer);
312 curl_easy_setopt (curl, CURLOPT_WRITEDATA, &cbc);
313 curl_easy_setopt (curl, CURLOPT_FAILONERROR, 1);
314 curl_easy_setopt (curl, CURLOPT_TIMEOUT, 150L);
315 curl_easy_setopt (curl, CURLOPT_CONNECTTIMEOUT, 150L);
316 curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1);
318 (ec = curl_easy_setopt (curl,
322 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
323 "curl build without support for CURLOPT_DNS_SERVERS (%s), cannot run test\n",
324 curl_easy_strerror (ec));
326 GNUNET_SCHEDULER_shutdown ();
329 multi = curl_multi_init ();
330 GNUNET_assert (multi != NULL);
331 GNUNET_assert (CURLM_OK == curl_multi_add_handle (multi, curl));
332 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
333 "Beginning HTTP download from `%s'\n",
340 * Callback invoked from the namestore service once record is
344 * @param af address family, AF_INET or AF_INET6; AF_UNSPEC on error;
345 * will match 'result_af' from the request
346 * @param address IP address (struct in_addr or struct in_addr6, depending on 'af')
347 * that the VPN allocated for the redirection;
348 * traffic to this IP will now be redirected to the
349 * specified target peer; NULL on error
352 commence_testing (void *cls,
357 if ((NULL != emsg) &&
358 (GNUNET_YES != success))
361 "NS failed to create record %s\n",
363 GNUNET_SCHEDULER_shutdown ();
367 /* wait a little bit before downloading, as we just created the record */
368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
369 "Launching cURL request\n");
371 = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
378 * Function to keep the HTTP server running.
396 struct GNUNET_NETWORK_FDSet nrs;
397 struct GNUNET_NETWORK_FDSet nws;
402 unsigned MHD_LONG_LONG timeout;
403 struct GNUNET_TIME_Relative delay;
405 GNUNET_assert (NULL == mhd_task_id);
410 GNUNET_assert (MHD_YES ==
411 MHD_get_fdset (mhd, &rs, &ws, &es, &max_fd));
412 if (MHD_YES == MHD_get_timeout (mhd, &timeout))
413 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
414 (unsigned int) timeout);
416 delay = GNUNET_TIME_UNIT_FOREVER_REL;
417 GNUNET_NETWORK_fdset_copy_native (&nrs,
420 GNUNET_NETWORK_fdset_copy_native (&nws,
423 mhd_task_id = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
433 * Open '/dev/null' and make the result the given
436 * @param target_fd desired FD to point to /dev/null
437 * @param flags open flags (O_RDONLY, O_WRONLY)
440 open_dev_null (int target_fd,
445 fd = open ("/dev/null", flags);
450 if (-1 == dup2 (fd, target_fd))
460 * Run the given command and wait for it to complete.
462 * @param file name of the binary to run
463 * @param cmd command line arguments (as given to 'execv')
464 * @return 0 on success, 1 on any error
467 fork_and_exec (const char *file,
477 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
483 /* we are the child process */
484 /* close stdin/stdout to not cause interference
485 with the helper's main protocol! */
487 open_dev_null (0, O_RDONLY);
489 open_dev_null (1, O_WRONLY);
490 (void) execv (file, cmd);
491 /* can only get here on error */
492 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
497 /* keep running waitpid as long as the only error we get is 'EINTR' */
498 while ((-1 == (ret = waitpid (pid, &status, 0))) &&
503 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
507 if (! (WIFEXITED (status) &&
508 (0 == WEXITSTATUS (status))))
510 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
511 "Process `%s` returned status code %d/%d.\n",
514 WEXITSTATUS (status));
517 /* child process completed and returned success, we're happy */
523 * Method called to inform about the egos of this peer.
525 * When used with #GNUNET_IDENTITY_connect, this function is
526 * initially called for all egos and then again whenever a
527 * ego's name changes or if it is deleted. At the end of
528 * the initial pass over all egos, the function is once called
529 * with 'NULL' for @a ego. That does NOT mean that the callback won't
530 * be invoked in the future or that there was an error.
532 * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get,
533 * this function is only called ONCE, and 'NULL' being passed in
534 * @a ego does indicate an error (i.e. name is taken or no default
535 * value is known). If @a ego is non-NULL and if '*ctx'
536 * is set in those callbacks, the value WILL be passed to a subsequent
537 * call to the identity callback of #GNUNET_IDENTITY_connect (if
538 * that one was not NULL).
540 * When an identity is renamed, this function is called with the
541 * (known) @a ego but the NEW @a name.
543 * When an identity is deleted, this function is called with the
544 * (known) ego and "NULL" for the @a name. In this case,
545 * the @a ego is henceforth invalid (and the @a ctx should also be
549 * @param ego ego handle
550 * @param ctx context for application to store data for this ego
551 * (during the lifetime of this process, initially NULL)
552 * @param name name assigned by the user for this ego,
553 * NULL if the user just deleted the ego and it
554 * must thus no longer be used
557 identity_cb (void *cls,
558 struct GNUNET_IDENTITY_Ego *ego,
562 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key;
563 struct GNUNET_GNSRECORD_Data rd;
574 "Failed to find master-zone ego\n");
575 GNUNET_SCHEDULER_shutdown ();
578 GNUNET_IDENTITY_disconnect (identity);
582 GNUNET_assert (NULL != name);
583 if (0 != strcmp (name,
587 "Unexpected name %s\n",
591 zone_key = GNUNET_IDENTITY_ego_get_private_key (ego);
592 rd.expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
593 peername = GNUNET_strdup (GNUNET_i2s_full (&id));
594 GNUNET_asprintf (&rd_string,
598 GNUNET_free (peername);
599 GNUNET_assert (GNUNET_OK ==
600 GNUNET_GNSRECORD_string_to_value (GNUNET_GNSRECORD_TYPE_VPN,
604 rd.record_type = GNUNET_GNSRECORD_TYPE_VPN;
606 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
607 "Creating `www` record\n");
608 qe = GNUNET_NAMESTORE_records_store (namestore,
614 GNUNET_free ((void **) rd.data);
615 GNUNET_free (rd_string);
621 const struct GNUNET_CONFIGURATION_Handle *cfg,
622 struct GNUNET_TESTING_Peer *peer)
632 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
633 "Test logic starting...\n");
635 GNUNET_CONFIGURATION_get_value_string (cfg,
640 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
641 "Failed to locate configuration file. Skipping test.\n");
642 GNUNET_SCHEDULER_shutdown ();
646 char *const identity_args[] = {
652 char *const identity2_args[] = {
659 char *const identity3_args[] = {
666 char *const arm_args[] = {
672 char *const gns_args[] = {
679 GNUNET_TESTING_peer_get_identity (peer,
681 GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
683 timeout_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
686 bin = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_BINDIR);
687 GNUNET_asprintf (&bin_identity,
691 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
692 "Creating `master-zone` ego\n");
693 if (0 != fork_and_exec (bin_identity, identity_args))
695 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
696 "Failed to run `gnunet-identity -C`. Skipping test.\n");
697 GNUNET_SCHEDULER_shutdown ();
698 GNUNET_free (bin_identity);
699 GNUNET_free (config);
703 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
704 "Setting `master-zone` ego as default for `gns-master` and `dns2gns`\n");
705 if (0 != fork_and_exec (bin_identity, identity2_args))
707 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
708 "Failed to run `gnunet-identity -e`. Skipping test.\n");
709 GNUNET_SCHEDULER_shutdown ();
710 GNUNET_free (bin_identity);
711 GNUNET_free (config);
715 if (0 != fork_and_exec (bin_identity, identity3_args))
717 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
718 "Failed to run `gnunet-identity -e`. Skipping test.\n");
719 GNUNET_SCHEDULER_shutdown ();
720 GNUNET_free (bin_identity);
721 GNUNET_free (config);
725 GNUNET_free (bin_identity);
727 /* do lookup just to launch GNS service */
728 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
729 "Resolving `www.gnu` zone entry to launch GNS (will yield no answer yet)\n");
730 GNUNET_asprintf (&bin_gns,
734 if (0 != fork_and_exec (bin_gns,
737 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
738 "Failed to run `gnunet-gns -u. Skipping test.\n");
739 GNUNET_SCHEDULER_shutdown ();
740 GNUNET_free (bin_gns);
741 GNUNET_free (config);
745 GNUNET_free (bin_gns);
747 GNUNET_asprintf (&bin_arm,
751 if (0 != fork_and_exec (bin_arm,
754 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
755 "Failed to run `gnunet-arm -i dns2gns. Skipping test.\n");
756 GNUNET_SCHEDULER_shutdown ();
757 GNUNET_free (bin_arm);
758 GNUNET_free (config);
762 GNUNET_free (bin_arm);
764 GNUNET_free (config);
766 sleep (1); /* give dns2gns chance to really run */
768 namestore = GNUNET_NAMESTORE_connect (cfg);
769 GNUNET_assert (NULL != namestore);
770 flags = MHD_USE_DEBUG;
771 if (GNUNET_YES == use_v6)
772 flags |= MHD_USE_DUAL_STACK;
773 mhd = MHD_start_daemon (flags,
778 GNUNET_assert (NULL != mhd);
781 identity = GNUNET_IDENTITY_connect (cfg,
794 GNUNET_log_setup ("test-gns-vpn",
797 if (0 != access ("/dev/net/tun", R_OK))
799 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
803 "WARNING: System unable to run test, skipping.\n");
807 bin_vpn = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-vpn");
808 bin_exit = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-exit");
809 if ((0 != geteuid ()) &&
811 GNUNET_OS_check_helper_binary (bin_vpn,
813 "-d gnunet-vpn - - 169.1.3.3.7 255.255.255.0"))
814 || // ipv4 only please!
816 GNUNET_OS_check_helper_binary (bin_exit,
818 "-d gnunet-vpn - - - 169.1.3.3.7 255.255.255.0")))) // no nat, ipv4 only
821 "WARNING: gnunet-helper-{exit,vpn} binaries in $PATH are not SUID, refusing to run test (as it would have to fail).\n");
823 "Change $PATH ('.' in $PATH before $GNUNET_PREFIX/bin is problematic) or permissions (run 'make install' as root) to fix this!\n");
824 GNUNET_free (bin_vpn);
825 GNUNET_free (bin_exit);
828 GNUNET_free (bin_vpn);
829 GNUNET_free (bin_exit);
831 dest_ip = "169.254.86.1";
835 if (GNUNET_OK == GNUNET_NETWORK_test_pf (PF_INET6))
840 if ((GNUNET_OK != GNUNET_NETWORK_test_pf (src_af)) ||
841 (GNUNET_OK != GNUNET_NETWORK_test_pf (dest_af)))
844 "Required address families not supported by this system, skipping test.\n");
847 if (0 != curl_global_init (CURL_GLOBAL_WIN32))
849 fprintf (stderr, "failed to initialize curl\n");
855 GNUNET_TESTING_peer_run ("test_gns_vpn",
860 GNUNET_DISK_directory_remove ("/tmp/gnunet-test-vpn");
865 /* end of test_gns_vpn.c */