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
266 process_resolved_address (void *cls,
270 struct AddressRecord * ar = cls;
271 struct PrintContext *pc = ar->pc;
275 if (NULL == ar->result)
276 ar->result = GNUNET_strdup (address);
281 if (GNUNET_SYSERR == res)
284 _("Failure: Cannot convert address to string for peer `%s'\n"),
285 GNUNET_i2s (&ar->pc->peer));
291 if (pc->num_addresses == pc->address_list_size)
297 * Iterator callback to go over all addresses and count them.
299 * @param cls `struct PrintContext *` with `off` to increment
300 * @param address the address
301 * @param expiration expiration time
302 * @return #GNUNET_OK to keep the address and continue
305 count_address (void *cls,
306 const struct GNUNET_HELLO_Address *address,
307 struct GNUNET_TIME_Absolute expiration)
309 struct PrintContext *pc = cls;
317 * Iterator callback to go over all addresses.
320 * @param address the address
321 * @param expiration expiration time
322 * @return #GNUNET_OK to keep the address and continue
325 print_address (void *cls,
326 const struct GNUNET_HELLO_Address *address,
327 struct GNUNET_TIME_Absolute expiration)
329 struct PrintContext *pc = cls;
330 struct AddressRecord *ar;
331 GNUNET_assert (0 < pc->off);
332 ar = &pc->address_list[--pc->off];
334 ar->expiration = expiration;
335 ar->atsc = GNUNET_TRANSPORT_address_to_string (cfg,
338 GNUNET_TIME_relative_multiply
339 (GNUNET_TIME_UNIT_SECONDS, 10),
340 &process_resolved_address, ar);
346 * Print information about the peer. Currently prints the `struct
347 * GNUNET_PeerIdentity` and the transport address.
349 * @param cls the `struct PrintContext *`
350 * @param peer identity of the peer
351 * @param hello addresses of the peer
352 * @param err_msg error message
355 print_peer_info (void *cls,
356 const struct GNUNET_PeerIdentity *peer,
357 const struct GNUNET_HELLO_Message *hello,
360 struct PrintContext *pc;
365 pic = NULL; /* end of iteration */
369 _("Error in communication with PEERINFO service: %s\n"),
373 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
376 friend_only = GNUNET_NO;
378 friend_only = GNUNET_HELLO_is_friend_only (hello);
379 if ((GNUNET_YES == be_quiet) || (NULL == hello))
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, GNUNET_NO,
407 /* ************************* DUMP Hello ************************** */
410 * Count the number of addresses in the HELLO.
412 * @param cls pointer to an `int *` used for the counter
413 * @param address an address to count
414 * @param expiration (unused)
418 count_addr (void *cls,
419 const struct GNUNET_HELLO_Address *address,
420 struct GNUNET_TIME_Absolute expiration)
430 * Write Hello of my peer to a file.
432 * @param cls the `struct GetUriContext *`
433 * @param peer identity of the peer (unused)
434 * @param hello addresses of the peer
435 * @param err_msg error message
438 dump_my_hello (void *cls,
439 const struct GNUNET_PeerIdentity *peer,
440 const struct GNUNET_HELLO_Message *hello,
451 _("Error in communication with PEERINFO service: %s\n"),
453 tt = GNUNET_SCHEDULER_add_now (&state_machine,
461 _("Failure: Did not receive %s\n"),
466 size = GNUNET_HELLO_size (hello);
470 _("Failure: Received invalid %s\n"),
475 GNUNET_DISK_fn_write (dump_hello, hello, size,
476 GNUNET_DISK_PERM_USER_READ |
477 GNUNET_DISK_PERM_USER_WRITE |
478 GNUNET_DISK_PERM_GROUP_READ |
479 GNUNET_DISK_PERM_OTHER_READ))
482 _("Failed to write HELLO with %u bytes to file `%s'\n"),
485 if (0 != UNLINK (dump_hello))
486 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
487 GNUNET_ERROR_TYPE_BULK,
493 GNUNET_HELLO_iterate_addresses (hello,
501 _("Wrote %s HELLO containing %u addresses with %u bytes to file `%s'\n"),
502 (GNUNET_YES == GNUNET_HELLO_is_friend_only(hello)) ? "friend-only": "public",
507 GNUNET_free (dump_hello);
512 /* ************************* GET URI ************************** */
516 * Print URI of the peer.
518 * @param cls the `struct GetUriContext *`
519 * @param peer identity of the peer (unused)
520 * @param hello addresses of the peer
521 * @param err_msg error message
524 print_my_uri (void *cls,
525 const struct GNUNET_PeerIdentity *peer,
526 const struct GNUNET_HELLO_Message *hello,
534 _("Error in communication with PEERINFO service: %s\n"),
536 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
542 char *uri = GNUNET_HELLO_compose_uri (hello,
553 /* ************************* import HELLO by URI ********************* */
557 * Continuation called from #GNUNET_PEERINFO_add_peer()
559 * @param cls closure, NULL
560 * @param emsg error message, NULL on success
563 add_continuation (void *cls,
569 _("Failure adding HELLO: %s\n"),
571 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
576 * Parse the PUT URI given at the command line and add it to our peerinfo
579 * @param put_uri URI string to parse
580 * @return #GNUNET_OK on success,
581 * #GNUNET_SYSERR if the URI was invalid,
582 * #GNUNET_NO on other errors
585 parse_hello_uri (const char *put_uri)
587 struct GNUNET_HELLO_Message *hello = NULL;
589 int ret = GNUNET_HELLO_parse_uri(put_uri,
590 &my_peer_identity.public_key,
596 /* WARNING: this adds the address from URI WITHOUT verification! */
597 if (GNUNET_OK == ret)
598 ac = GNUNET_PEERINFO_add_peer (peerinfo, hello,
602 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
606 /* wait 1s to give peerinfo operation a chance to succeed */
607 /* FIXME: current peerinfo API sucks to require this; not to mention
608 that we get no feedback to determine if the operation actually succeeded */
613 /* ************************ Main state machine ********************* */
617 * Main state machine that goes over all options and
618 * runs the next requested function.
621 * @param tc scheduler context
624 shutdown_task (void *cls,
625 const struct GNUNET_SCHEDULER_TaskContext *tc)
627 struct PrintContext *pc;
628 struct AddressRecord *ar;
633 GNUNET_PEERINFO_add_peer_cancel (ac);
636 if (GNUNET_SCHEDULER_NO_TASK != tt)
638 GNUNET_SCHEDULER_cancel (tt);
639 tt = GNUNET_SCHEDULER_NO_TASK;
643 GNUNET_PEERINFO_iterate_cancel (pic);
646 while (NULL != (pc = pc_head))
648 GNUNET_CONTAINER_DLL_remove (pc_head,
651 for (i=0;i<pc->address_list_size;i++)
653 ar = &pc->address_list[i];
654 GNUNET_free_non_null (ar->result);
655 if (NULL != ar->atsc)
657 GNUNET_TRANSPORT_address_to_string_cancel (ar->atsc);
661 GNUNET_free_non_null (pc->address_list);
664 GPI_plugins_unload ();
665 if (NULL != peerinfo)
667 GNUNET_PEERINFO_disconnect (peerinfo);
674 * Function called with the result of the check if the PEERINFO
675 * service is running.
677 * @param cls closure with our configuration
678 * @param result #GNUNET_YES if PEERINFO is running
681 testservice_task (void *cls,
684 struct GNUNET_CRYPTO_EddsaPrivateKey *priv;
687 if (GNUNET_YES != result)
690 _("Service `%s' is not running, please start GNUnet\n"),
695 if (NULL == (peerinfo = GNUNET_PEERINFO_connect (cfg)))
699 _("Could not access PEERINFO service. Exiting.\n"));
702 if ( (GNUNET_YES == get_self) ||
703 (GNUNET_YES == get_uri) ||
704 (NULL != dump_hello) )
706 /* load private key */
708 GNUNET_CONFIGURATION_get_value_filename (cfg,
713 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
718 if (NULL == (priv = GNUNET_CRYPTO_eddsa_key_create_from_file (fn)))
721 _("Loading hostkey from `%s' failed.\n"),
727 GNUNET_CRYPTO_eddsa_key_get_public (priv,
728 &my_peer_identity.public_key);
732 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
733 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
740 * Main function that will be run by the scheduler.
743 * @param args remaining command-line arguments
744 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
745 * @param c configuration
751 const struct GNUNET_CONFIGURATION_Handle *c)
754 if ( (NULL != args[0]) &&
756 (args[0] == strcasestr (args[0], "gnunet://hello/")) )
758 put_uri = GNUNET_strdup (args[0]);
764 _("Invalid command line argument `%s'\n"),
769 GNUNET_CLIENT_service_test ("peerinfo",
771 GNUNET_TIME_UNIT_SECONDS,
772 &testservice_task, (void *) cfg);
777 * Main state machine that goes over all options and
778 * runs the next requested function.
781 * @param tc scheduler context
784 state_machine (void *cls,
785 const struct GNUNET_SCHEDULER_TaskContext *tc)
787 tt = GNUNET_SCHEDULER_NO_TASK;
791 GPI_plugins_load (cfg);
792 if (GNUNET_SYSERR == parse_hello_uri (put_uri))
795 _("Invalid URI `%s'\n"),
797 GNUNET_SCHEDULER_shutdown ();
799 GNUNET_free (put_uri);
802 else if (GNUNET_YES == get_info)
804 get_info = GNUNET_NO;
805 GPI_plugins_load (cfg);
806 pic = GNUNET_PEERINFO_iterate (peerinfo,
810 &print_peer_info, NULL);
812 else if (GNUNET_YES == get_self)
814 get_self = GNUNET_NO;
817 GNUNET_i2s_full (&my_peer_identity));
819 printf (_("I am peer `%s'.\n"),
820 GNUNET_i2s_full (&my_peer_identity));
821 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
823 else if (GNUNET_YES == get_uri)
825 GPI_plugins_load (cfg);
826 pic = GNUNET_PEERINFO_iterate (peerinfo,
830 &print_my_uri, NULL);
833 else if (NULL != dump_hello)
835 pic = GNUNET_PEERINFO_iterate (peerinfo,
839 &dump_my_hello, NULL);
841 else if (GNUNET_YES == default_operation)
843 /* default operation list all */
844 default_operation = GNUNET_NO;
845 get_info = GNUNET_YES;
846 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
850 GNUNET_SCHEDULER_shutdown ();
852 default_operation = GNUNET_NO;
857 * The main function to obtain peer information.
859 * @param argc number of arguments from the command line
860 * @param argv command line arguments
861 * @return 0 ok, 1 on error
864 main (int argc, char *const *argv)
866 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
867 {'n', "numeric", NULL,
868 gettext_noop ("don't resolve host names"),
869 0, &GNUNET_GETOPT_set_one, &no_resolve},
871 gettext_noop ("output only the identity strings"),
872 0, &GNUNET_GETOPT_set_one, &be_quiet},
873 {'f', "friends", NULL,
874 gettext_noop ("include friend-only information"),
875 0, &GNUNET_GETOPT_set_one, &include_friend_only},
877 gettext_noop ("output our own identity only"),
878 0, &GNUNET_GETOPT_set_one, &get_self},
880 gettext_noop ("list all known peers"),
881 0, &GNUNET_GETOPT_set_one, &get_info},
882 {'d', "dump-hello", NULL,
883 gettext_noop ("dump hello to file"),
884 1, &GNUNET_GETOPT_set_string, &dump_hello},
885 {'g', "get-hello", NULL,
886 gettext_noop ("also output HELLO uri(s)"),
887 0, &GNUNET_GETOPT_set_one, &get_uri},
888 {'p', "put-hello", "HELLO",
889 gettext_noop ("add given HELLO uri to the database"),
890 1, &GNUNET_GETOPT_set_string, &put_uri},
891 GNUNET_GETOPT_OPTION_END
895 default_operation = GNUNET_YES;
896 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc,
902 GNUNET_PROGRAM_run (argc, argv, "gnunet-peerinfo",
903 gettext_noop ("Print information about peers."),
904 options, &run, NULL)) ? 0 : 1;
905 GNUNET_free ((void*) argv);
909 /* end of gnunet-peerinfo.c */