2 This file is part of GNUnet.
3 (C) 2001-2014 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.
22 * @file peerinfo-tool/gnunet-peerinfo.c
23 * @brief Print information about other known peers.
24 * @author Christian Grothoff
25 * @author Matthias Wachs
28 #include "gnunet_util_lib.h"
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_transport_service.h"
31 #include "gnunet_peerinfo_service.h"
32 #include "gnunet-peerinfo_plugins.h"
35 * How long until we time out during peerinfo iterations?
37 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
40 * Structure we use to collect printable address information.
45 * Record we keep for each printable address.
50 * Current address-to-string context (if active, otherwise NULL).
52 struct GNUNET_TRANSPORT_AddressToStringContext *atsc;
55 * Address expiration time
57 struct GNUNET_TIME_Absolute expiration;
65 * Print context this address record belongs to.
67 struct PrintContext *pc;
72 * Structure we use to collect printable address information.
80 struct PrintContext *next;
85 struct PrintContext *prev;
88 * Identity of the peer.
90 struct GNUNET_PeerIdentity peer;
93 * List of printable addresses.
95 struct AddressRecord *address_list;
98 * Number of completed addresses in @e address_list.
100 unsigned int num_addresses;
103 * Number of addresses allocated in @e address_list.
105 unsigned int address_list_size;
108 * Current offset in @e address_list (counted down).
113 * Hello was friend only, #GNUNET_YES or #GNUNET_NO
123 static int no_resolve;
133 static int include_friend_only;
148 static int default_operation;
158 static char *put_uri;
163 static char *dump_hello;
166 * Handle to peerinfo service.
168 static struct GNUNET_PEERINFO_Handle *peerinfo;
171 * Configuration handle.
173 static const struct GNUNET_CONFIGURATION_Handle *cfg;
176 * Main state machine task (if active).
178 static GNUNET_SCHEDULER_TaskIdentifier tt;
181 * Current iterator context (if active, otherwise NULL).
183 static struct GNUNET_PEERINFO_IteratorContext *pic;
188 static struct GNUNET_PeerIdentity my_peer_identity;
191 * Head of list of print contexts.
193 static struct PrintContext *pc_head;
196 * Tail of list of print contexts.
198 static struct PrintContext *pc_tail;
201 * Handle to current #GNUNET_PEERINFO_add_peer() operation.
203 static struct GNUNET_PEERINFO_AddContext *ac;
207 * Main state machine that goes over all options and
208 * runs the next requested function.
214 state_machine (void *cls,
215 const struct GNUNET_SCHEDULER_TaskContext *tc);
218 /* ********************* 'get_info' ******************* */
221 * Print the collected address information to the console and free @a pc.
223 * @param pc printing context
226 dump_pc (struct PrintContext *pc)
230 printf (_("%sPeer `%s'\n"),
231 (GNUNET_YES == pc->friend_only) ? "F2F: " : "",
232 GNUNET_i2s_full (&pc->peer));
233 for (i = 0; i < pc->num_addresses; i++)
235 if (NULL != pc->address_list[i].result)
237 printf (_("\tExpires: %s \t %s\n"),
238 GNUNET_STRINGS_absolute_time_to_string (pc->address_list[i].expiration),
239 pc->address_list[i].result);
240 GNUNET_free (pc->address_list[i].result);
244 GNUNET_free_non_null (pc->address_list);
245 GNUNET_CONTAINER_DLL_remove (pc_head,
249 if ( (NULL == pc_head) &&
251 tt = GNUNET_SCHEDULER_add_now (&state_machine,
256 /* ************************* list all known addresses **************** */
260 * Function to call with a human-readable format of an address
263 * @param address NULL on error, otherwise 0-terminated printable UTF-8 string
264 * @param res result of the address to string conversion:
265 * if #GNUNET_OK: address was valid (conversion to
266 * string might still have failed)
267 * if #GNUNET_SYSERR: address is invalid
270 process_resolved_address (void *cls,
274 struct AddressRecord *ar = cls;
275 struct PrintContext *pc = ar->pc;
279 if (NULL == ar->result)
280 ar->result = GNUNET_strdup (address);
284 if (GNUNET_SYSERR == res)
285 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
286 _("Failure: Cannot convert address to string for peer `%s'\n"),
287 GNUNET_i2s (&ar->pc->peer));
289 if (pc->num_addresses == pc->address_list_size)
295 * Iterator callback to go over all addresses and count them.
297 * @param cls `struct PrintContext *` with `off` to increment
298 * @param address the address
299 * @param expiration expiration time
300 * @return #GNUNET_OK to keep the address and continue
303 count_address (void *cls,
304 const struct GNUNET_HELLO_Address *address,
305 struct GNUNET_TIME_Absolute expiration)
307 struct PrintContext *pc = cls;
315 * Iterator callback to go over all addresses.
318 * @param address the address
319 * @param expiration expiration time
320 * @return #GNUNET_OK to keep the address and continue
323 print_address (void *cls,
324 const struct GNUNET_HELLO_Address *address,
325 struct GNUNET_TIME_Absolute expiration)
327 struct PrintContext *pc = cls;
328 struct AddressRecord *ar;
330 GNUNET_assert (0 < pc->off);
331 ar = &pc->address_list[--pc->off];
333 ar->expiration = expiration;
334 ar->atsc = GNUNET_TRANSPORT_address_to_string (cfg,
337 GNUNET_TIME_relative_multiply
338 (GNUNET_TIME_UNIT_SECONDS, 10),
339 &process_resolved_address, ar);
345 * Print information about the peer. Currently prints the `struct
346 * GNUNET_PeerIdentity` and the transport address.
348 * @param cls the `struct PrintContext *`
349 * @param peer identity of the peer
350 * @param hello addresses of the peer
351 * @param err_msg error message
354 print_peer_info (void *cls,
355 const struct GNUNET_PeerIdentity *peer,
356 const struct GNUNET_HELLO_Message *hello,
359 struct PrintContext *pc;
364 pic = NULL; /* end of iteration */
368 _("Error in communication with PEERINFO service: %s\n"),
372 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
375 friend_only = GNUNET_NO;
377 friend_only = GNUNET_HELLO_is_friend_only (hello);
378 if ( (GNUNET_YES == be_quiet) ||
382 (GNUNET_YES == friend_only) ? "F2F: " : "",
383 GNUNET_i2s_full (peer));
386 pc = GNUNET_new (struct PrintContext);
387 GNUNET_CONTAINER_DLL_insert (pc_head,
391 pc->friend_only = friend_only;
392 GNUNET_HELLO_iterate_addresses (hello,
401 pc->address_list_size = pc->off;
402 pc->address_list = GNUNET_malloc (sizeof (struct AddressRecord) * pc->off);
403 GNUNET_HELLO_iterate_addresses (hello,
409 /* ************************* DUMP Hello ************************** */
412 * Count the number of addresses in the HELLO.
414 * @param cls pointer to an `int *` used for the counter
415 * @param address an address to count
416 * @param expiration (unused)
420 count_addr (void *cls,
421 const struct GNUNET_HELLO_Address *address,
422 struct GNUNET_TIME_Absolute expiration)
432 * Write HELLO of my peer to a file.
434 * @param cls the `struct GetUriContext *`
435 * @param peer identity of the peer (unused)
436 * @param hello addresses of the peer
437 * @param err_msg error message
440 dump_my_hello (void *cls,
441 const struct GNUNET_PeerIdentity *peer,
442 const struct GNUNET_HELLO_Message *hello,
453 _("Error in communication with PEERINFO service: %s\n"),
455 tt = GNUNET_SCHEDULER_add_now (&state_machine,
463 _("Failure: Did not receive %s\n"),
468 size = GNUNET_HELLO_size (hello);
472 _("Failure: Received invalid %s\n"),
477 GNUNET_DISK_fn_write (dump_hello, hello, size,
478 GNUNET_DISK_PERM_USER_READ |
479 GNUNET_DISK_PERM_USER_WRITE |
480 GNUNET_DISK_PERM_GROUP_READ |
481 GNUNET_DISK_PERM_OTHER_READ))
484 _("Failed to write HELLO with %u bytes to file `%s'\n"),
487 if (0 != UNLINK (dump_hello))
488 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
489 GNUNET_ERROR_TYPE_BULK,
495 GNUNET_HELLO_iterate_addresses (hello,
503 _("Wrote %s HELLO containing %u addresses with %u bytes to file `%s'\n"),
504 (GNUNET_YES == GNUNET_HELLO_is_friend_only(hello)) ? "friend-only": "public",
509 GNUNET_free (dump_hello);
514 /* ************************* GET URI ************************** */
518 * Print URI of the peer.
520 * @param cls the `struct GetUriContext *`
521 * @param peer identity of the peer (unused)
522 * @param hello addresses of the peer
523 * @param err_msg error message
526 print_my_uri (void *cls,
527 const struct GNUNET_PeerIdentity *peer,
528 const struct GNUNET_HELLO_Message *hello,
536 _("Error in communication with PEERINFO service: %s\n"),
538 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
544 char *uri = GNUNET_HELLO_compose_uri (hello,
555 /* ************************* import HELLO by URI ********************* */
559 * Continuation called from #GNUNET_PEERINFO_add_peer()
561 * @param cls closure, NULL
562 * @param emsg error message, NULL on success
565 add_continuation (void *cls,
571 _("Failure adding HELLO: %s\n"),
573 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
578 * Parse the PUT URI given at the command line and add it to our peerinfo
581 * @param put_uri URI string to parse
582 * @return #GNUNET_OK on success,
583 * #GNUNET_SYSERR if the URI was invalid,
584 * #GNUNET_NO on other errors
587 parse_hello_uri (const char *put_uri)
589 struct GNUNET_HELLO_Message *hello = NULL;
591 int ret = GNUNET_HELLO_parse_uri(put_uri,
592 &my_peer_identity.public_key,
598 /* WARNING: this adds the address from URI WITHOUT verification! */
599 if (GNUNET_OK == ret)
600 ac = GNUNET_PEERINFO_add_peer (peerinfo, hello,
604 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
608 /* wait 1s to give peerinfo operation a chance to succeed */
609 /* FIXME: current peerinfo API sucks to require this; not to mention
610 that we get no feedback to determine if the operation actually succeeded */
615 /* ************************ Main state machine ********************* */
619 * Main state machine that goes over all options and
620 * runs the next requested function.
623 * @param tc scheduler context
626 shutdown_task (void *cls,
627 const struct GNUNET_SCHEDULER_TaskContext *tc)
629 struct PrintContext *pc;
630 struct AddressRecord *ar;
635 GNUNET_PEERINFO_add_peer_cancel (ac);
638 if (GNUNET_SCHEDULER_NO_TASK != tt)
640 GNUNET_SCHEDULER_cancel (tt);
641 tt = GNUNET_SCHEDULER_NO_TASK;
645 GNUNET_PEERINFO_iterate_cancel (pic);
648 while (NULL != (pc = pc_head))
650 GNUNET_CONTAINER_DLL_remove (pc_head,
653 for (i=0;i<pc->address_list_size;i++)
655 ar = &pc->address_list[i];
656 GNUNET_free_non_null (ar->result);
657 if (NULL != ar->atsc)
659 GNUNET_TRANSPORT_address_to_string_cancel (ar->atsc);
663 GNUNET_free_non_null (pc->address_list);
666 GPI_plugins_unload ();
667 if (NULL != peerinfo)
669 GNUNET_PEERINFO_disconnect (peerinfo);
676 * Function called with the result of the check if the PEERINFO
677 * service is running.
679 * @param cls closure with our configuration
680 * @param result #GNUNET_YES if PEERINFO is running
683 testservice_task (void *cls,
686 struct GNUNET_CRYPTO_EddsaPrivateKey *priv;
689 if (GNUNET_YES != result)
692 _("Service `%s' is not running, please start GNUnet\n"),
697 if (NULL == (peerinfo = GNUNET_PEERINFO_connect (cfg)))
701 _("Could not access PEERINFO service. Exiting.\n"));
704 if ( (GNUNET_YES == get_self) ||
705 (GNUNET_YES == get_uri) ||
706 (NULL != dump_hello) )
708 /* load private key */
710 GNUNET_CONFIGURATION_get_value_filename (cfg,
715 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
720 if (NULL == (priv = GNUNET_CRYPTO_eddsa_key_create_from_file (fn)))
723 _("Loading hostkey from `%s' failed.\n"),
729 GNUNET_CRYPTO_eddsa_key_get_public (priv,
730 &my_peer_identity.public_key);
734 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
735 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
742 * Main function that will be run by the scheduler.
745 * @param args remaining command-line arguments
746 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
747 * @param c configuration
753 const struct GNUNET_CONFIGURATION_Handle *c)
756 if ( (NULL != args[0]) &&
758 (args[0] == strcasestr (args[0], "gnunet://hello/")) )
760 put_uri = GNUNET_strdup (args[0]);
766 _("Invalid command line argument `%s'\n"),
771 GNUNET_CLIENT_service_test ("peerinfo",
773 GNUNET_TIME_UNIT_SECONDS,
774 &testservice_task, (void *) cfg);
779 * Main state machine that goes over all options and
780 * runs the next requested function.
783 * @param tc scheduler context
786 state_machine (void *cls,
787 const struct GNUNET_SCHEDULER_TaskContext *tc)
789 tt = GNUNET_SCHEDULER_NO_TASK;
793 GPI_plugins_load (cfg);
794 if (GNUNET_SYSERR == parse_hello_uri (put_uri))
797 _("Invalid URI `%s'\n"),
799 GNUNET_SCHEDULER_shutdown ();
801 GNUNET_free (put_uri);
804 else if (GNUNET_YES == get_info)
806 get_info = GNUNET_NO;
807 GPI_plugins_load (cfg);
808 pic = GNUNET_PEERINFO_iterate (peerinfo,
812 &print_peer_info, NULL);
814 else if (GNUNET_YES == get_self)
816 get_self = GNUNET_NO;
819 GNUNET_i2s_full (&my_peer_identity));
821 printf (_("I am peer `%s'.\n"),
822 GNUNET_i2s_full (&my_peer_identity));
823 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
825 else if (GNUNET_YES == get_uri)
827 GPI_plugins_load (cfg);
828 pic = GNUNET_PEERINFO_iterate (peerinfo,
832 &print_my_uri, NULL);
835 else if (NULL != dump_hello)
837 pic = GNUNET_PEERINFO_iterate (peerinfo,
841 &dump_my_hello, NULL);
843 else if (GNUNET_YES == default_operation)
845 /* default operation list all */
846 default_operation = GNUNET_NO;
847 get_info = GNUNET_YES;
848 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
852 GNUNET_SCHEDULER_shutdown ();
854 default_operation = GNUNET_NO;
859 * The main function to obtain peer information.
861 * @param argc number of arguments from the command line
862 * @param argv command line arguments
863 * @return 0 ok, 1 on error
866 main (int argc, char *const *argv)
868 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
869 {'n', "numeric", NULL,
870 gettext_noop ("don't resolve host names"),
871 0, &GNUNET_GETOPT_set_one, &no_resolve},
873 gettext_noop ("output only the identity strings"),
874 0, &GNUNET_GETOPT_set_one, &be_quiet},
875 {'f', "friends", NULL,
876 gettext_noop ("include friend-only information"),
877 0, &GNUNET_GETOPT_set_one, &include_friend_only},
879 gettext_noop ("output our own identity only"),
880 0, &GNUNET_GETOPT_set_one, &get_self},
882 gettext_noop ("list all known peers"),
883 0, &GNUNET_GETOPT_set_one, &get_info},
884 {'d', "dump-hello", NULL,
885 gettext_noop ("dump hello to file"),
886 1, &GNUNET_GETOPT_set_string, &dump_hello},
887 {'g', "get-hello", NULL,
888 gettext_noop ("also output HELLO uri(s)"),
889 0, &GNUNET_GETOPT_set_one, &get_uri},
890 {'p', "put-hello", "HELLO",
891 gettext_noop ("add given HELLO uri to the database"),
892 1, &GNUNET_GETOPT_set_string, &put_uri},
893 GNUNET_GETOPT_OPTION_END
897 default_operation = GNUNET_YES;
898 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc,
904 GNUNET_PROGRAM_run (argc, argv, "gnunet-peerinfo",
905 gettext_noop ("Print information about peers."),
906 options, &run, NULL)) ? 0 : 1;
907 GNUNET_free ((void*) argv);
911 /* end of gnunet-peerinfo.c */