2 This file is part of GNUnet.
3 (C) 2001-2012 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
27 #include "gnunet_crypto_lib.h"
28 #include "gnunet_configuration_lib.h"
29 #include "gnunet_getopt_lib.h"
30 #include "gnunet_peerinfo_service.h"
31 #include "gnunet_transport_service.h"
32 #include "gnunet_program_lib.h"
33 #include "gnunet_transport_plugin.h"
34 #include "gnunet-peerinfo_plugins.h"
37 * Prefix that every HELLO URI must start with.
39 #define HELLO_URI_PREFIX "gnunet://hello/"
42 * How long until we time out during peerinfo iterations?
44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
47 * Structure we use to collect printable address information.
52 * Record we keep for each printable address.
57 * Current address-to-string context (if active, otherwise NULL).
59 struct GNUNET_TRANSPORT_AddressToStringContext *atsc;
67 * Print context this address record belongs to.
69 struct PrintContext *pc;
74 * Structure we use to collect printable address information.
82 struct PrintContext *next;
87 struct PrintContext *prev;
90 * Identity of the peer.
92 struct GNUNET_PeerIdentity peer;
95 * List of printable addresses.
97 struct AddressRecord *address_list;
100 * Number of completed addresses in 'address_list'.
102 unsigned int num_addresses;
105 * Number of addresses allocated in 'address_list'.
107 unsigned int address_list_size;
110 * Current offset in 'address_list' (counted down).
118 * Context used for building our own URI.
131 * Context for 'add_address_to_hello'.
133 struct GNUNET_PEERINFO_HelloAddressParsingContext
136 * Position in the URI with the next address to parse.
141 * Set to GNUNET_SYSERR to indicate parse errors.
151 static int no_resolve;
176 static char *put_uri;
179 * Handle to peerinfo service.
181 static struct GNUNET_PEERINFO_Handle *peerinfo;
184 * Configuration handle.
186 static const struct GNUNET_CONFIGURATION_Handle *cfg;
189 * Main state machine task (if active).
191 static GNUNET_SCHEDULER_TaskIdentifier tt;
194 * Current iterator context (if active, otherwise NULL).
196 static struct GNUNET_PEERINFO_IteratorContext *pic;
201 static struct GNUNET_PeerIdentity my_peer_identity;
206 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
209 * Head of list of print contexts.
211 static struct PrintContext *pc_head;
214 * Tail of list of print contexts.
216 static struct PrintContext *pc_tail;
220 * Main state machine that goes over all options and
221 * runs the next requested function.
227 state_machine (void *cls,
228 const struct GNUNET_SCHEDULER_TaskContext *tc);
231 /* ********************* 'get_info' ******************* */
234 * Print the collected address information to the console and free 'pc'.
236 * @param pc printing context
239 dump_pc (struct PrintContext *pc)
241 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
244 GNUNET_CRYPTO_hash_to_enc (&pc->peer.hashPubKey, &enc);
245 printf (_("Peer `%s'\n"),
246 (const char *) &enc);
247 for (i = 0; i < pc->num_addresses; i++)
249 if (NULL != pc->address_list[i].result)
251 printf ("\t%s\n", pc->address_list[i].result);
252 GNUNET_free (pc->address_list[i].result);
256 GNUNET_free_non_null (pc->address_list);
257 GNUNET_CONTAINER_DLL_remove (pc_head,
261 if ( (NULL == pc_head) &&
263 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
267 /* ************************* list all known addresses **************** */
271 * Function to call with a human-readable format of an address
274 * @param address NULL on error, otherwise 0-terminated printable UTF-8 string
277 process_resolved_address (void *cls, const char *address)
279 struct AddressRecord * ar = cls;
280 struct PrintContext *pc = ar->pc;
284 if (NULL == ar->result)
285 ar->result = GNUNET_strdup (address);
290 if (pc->num_addresses == pc->address_list_size)
296 * Iterator callback to go over all addresses and count them.
298 * @param cls 'struct PrintContext' with 'off' to increment
299 * @param address the address
300 * @param expiration expiration time
301 * @return GNUNET_OK to keep the address and continue
304 count_address (void *cls, 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, const struct GNUNET_HELLO_Address *address,
324 struct GNUNET_TIME_Absolute expiration)
326 struct PrintContext *pc = cls;
327 struct AddressRecord *ar;
329 GNUNET_assert (0 < pc->off);
330 ar = &pc->address_list[--pc->off];
332 ar->atsc = GNUNET_TRANSPORT_address_to_string (cfg, address, no_resolve,
333 GNUNET_TIME_relative_multiply
334 (GNUNET_TIME_UNIT_SECONDS, 10),
335 &process_resolved_address, ar);
341 * Print information about the peer.
342 * Currently prints the GNUNET_PeerIdentity and the transport address.
344 * @param cls the 'struct PrintContext'
345 * @param peer identity of the peer
346 * @param hello addresses of the peer
347 * @param err_msg error message
350 print_peer_info (void *cls, const struct GNUNET_PeerIdentity *peer,
351 const struct GNUNET_HELLO_Message *hello, const char *err_msg)
353 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
354 struct PrintContext *pc;
358 pic = NULL; /* end of iteration */
362 _("Error in communication with PEERINFO service: %s\n"),
366 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
369 if ((GNUNET_YES == be_quiet) || (NULL == hello))
371 GNUNET_CRYPTO_hash_to_enc (&peer->hashPubKey, &enc);
372 printf ("%s\n", (const char *) &enc);
375 pc = GNUNET_malloc (sizeof (struct PrintContext));
376 GNUNET_CONTAINER_DLL_insert (pc_head,
380 GNUNET_HELLO_iterate_addresses (hello,
389 pc->address_list_size = pc->off;
390 pc->address_list = GNUNET_malloc (sizeof (struct AddressRecord) * pc->off);
391 GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO,
396 /* ************************* GET URI ************************** */
400 * Function that is called on each address of this peer.
401 * Expands the corresponding URI string.
403 * @param cls the 'GetUriContext'
404 * @param address address to add
405 * @param expiration expiration time for the address
406 * @return GNUNET_OK (continue iteration).
409 compose_uri (void *cls, const struct GNUNET_HELLO_Address *address,
410 struct GNUNET_TIME_Absolute expiration)
412 struct GetUriContext *guc = cls;
413 struct GNUNET_TRANSPORT_PluginFunctions *papi;
420 papi = GPI_plugins_find (address->transport_name);
423 /* Not an error - we might just not have the right plugin. */
426 if (NULL == papi->address_to_string)
428 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
429 "URI conversion not implemented for plugin `%s'\n",
430 address->transport_name);
433 addr = papi->address_to_string (papi->cls, address->address, address->address_length);
434 if ( (addr == NULL) || (strlen(addr) == 0) )
436 seconds = expiration.abs_value / 1000;
437 t = gmtime (&seconds);
438 GNUNET_assert (0 != strftime (tbuf, sizeof (tbuf),
441 GNUNET_asprintf (&ret,
445 address->transport_name,
447 GNUNET_free (guc->uri);
454 * Print URI of the peer.
456 * @param cls the 'struct GetUriContext'
457 * @param peer identity of the peer (unused)
458 * @param hello addresses of the peer
459 * @param err_msg error message
462 print_my_uri (void *cls, const struct GNUNET_PeerIdentity *peer,
463 const struct GNUNET_HELLO_Message *hello,
466 struct GetUriContext *guc = cls;
473 _("Error in communication with PEERINFO service: %s\n"),
475 GNUNET_free_non_null (guc->uri);
477 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
481 GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &compose_uri, guc);
482 printf ("%s\n", (const char *) guc->uri);
486 /* ************************* import HELLO by URI ********************* */
490 * We're building a HELLO. Parse the next address from the
491 * parsing context and append it.
493 * @param cls the 'struct GNUNET_PEERINFO_HelloAddressParsingContext'
494 * @param max number of bytes available for HELLO construction
495 * @param buffer where to copy the next address (in binary format)
496 * @return number of bytes added to buffer
499 add_address_to_hello (void *cls, size_t max, void *buffer)
501 struct GNUNET_PEERINFO_HelloAddressParsingContext *ctx = cls;
506 struct tm expiration_time;
507 time_t expiration_seconds;
508 struct GNUNET_TIME_Absolute expire;
509 struct GNUNET_TRANSPORT_PluginFunctions *papi;
512 struct GNUNET_HELLO_Address haddr;
514 if (NULL == ctx->pos)
516 if ('!' != ctx->pos[0])
518 ctx->ret = GNUNET_SYSERR;
523 memset (&expiration_time, 0, sizeof (expiration_time));
524 tname = strptime (ctx->pos,
530 ctx->ret = GNUNET_SYSERR;
534 expiration_seconds = mktime (&expiration_time);
535 if (expiration_seconds == (time_t) -1)
537 ctx->ret = GNUNET_SYSERR;
541 expire.abs_value = expiration_seconds * 1000;
544 ctx->ret = GNUNET_SYSERR;
549 address = strchr (tname, (int) '!');
552 ctx->ret = GNUNET_SYSERR;
557 end = strchr (address, (int) '!');
561 end = address + strlen (address);
567 plugin_name = GNUNET_strndup (tname, address - (tname+1));
568 papi = GPI_plugins_find (plugin_name);
571 /* Not an error - we might just not have the right plugin.
572 * Skip this part, advance to the next one and recurse.
573 * But only if this is not the end of string.
575 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
576 _("Plugin `%s' not found\n"),
578 GNUNET_free (plugin_name);
583 if (NULL == papi->string_to_address)
585 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
586 _("Plugin `%s' does not support URIs yet\n"),
588 GNUNET_free (plugin_name);
593 papi->string_to_address (papi->cls,
599 GNUNET_free (plugin_name);
602 /* address.peer is unset - not used by add_address() */
603 haddr.address_length = addr_len;
604 haddr.address = addr;
605 haddr.transport_name = plugin_name;
606 ret = GNUNET_HELLO_add_address (&haddr, expire, buffer, max);
608 GNUNET_free (plugin_name);
614 * Parse the PUT URI given at the command line and add it to our peerinfo
617 * @param put_uri URI string to parse
618 * @return GNUNET_OK on success, GNUNET_SYSERR if the URI was invalid, GNUNET_NO on other errors
621 parse_hello_uri (const char *put_uri)
625 struct GNUNET_HELLO_Message *hello;
626 struct GNUNET_PEERINFO_HelloAddressParsingContext ctx;
628 if (0 != strncmp (put_uri,
630 strlen (HELLO_URI_PREFIX)))
631 return GNUNET_SYSERR;
632 pks = &put_uri[strlen (HELLO_URI_PREFIX)];
633 exc = strstr (pks, "!");
635 if (GNUNET_OK != GNUNET_STRINGS_string_to_data (pks,
636 (NULL == exc) ? strlen (pks) : (exc - pks),
637 (unsigned char *) &my_public_key,
638 sizeof (my_public_key)))
639 return GNUNET_SYSERR;
642 hello = GNUNET_HELLO_create (&my_public_key, &add_address_to_hello, &ctx);
646 /* WARNING: this adds the address from URI WITHOUT verification! */
647 if (GNUNET_OK == ctx.ret)
648 GNUNET_PEERINFO_add_peer (peerinfo, hello);
652 /* wait 1s to give peerinfo operation a chance to succeed */
653 /* FIXME: current peerinfo API sucks to require this; not to mention
654 that we get no feedback to determine if the operation actually succeeded */
655 tt = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
656 &state_machine, NULL);
661 /* ************************ Main state machine ********************* */
665 * Main state machine that goes over all options and
666 * runs the next requested function.
669 * @param tc scheduler context
672 shutdown_task (void *cls,
673 const struct GNUNET_SCHEDULER_TaskContext *tc)
675 struct PrintContext *pc;
676 struct AddressRecord *ar;
679 if (GNUNET_SCHEDULER_NO_TASK != tt)
681 GNUNET_SCHEDULER_cancel (tt);
682 tt = GNUNET_SCHEDULER_NO_TASK;
686 GNUNET_PEERINFO_iterate_cancel (pic);
689 while (NULL != (pc = pc_head))
691 GNUNET_CONTAINER_DLL_remove (pc_head,
694 for (i=0;i<pc->address_list_size;i++)
696 ar = &pc->address_list[i];
697 GNUNET_free_non_null (ar->result);
698 if (NULL != ar->atsc)
700 GNUNET_TRANSPORT_address_to_string_cancel (ar->atsc);
704 GNUNET_free_non_null (pc->address_list);
707 GPI_plugins_unload ();
708 if (NULL != peerinfo)
710 GNUNET_PEERINFO_disconnect (peerinfo);
717 * Main function that will be run by the scheduler.
720 * @param args remaining command-line arguments
721 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
722 * @param c configuration
725 run (void *cls, char *const *args, const char *cfgfile,
726 const struct GNUNET_CONFIGURATION_Handle *c)
728 struct GNUNET_CRYPTO_RsaPrivateKey *priv;
734 FPRINTF (stderr, _("Invalid command line argument `%s'\n"), args[0]);
737 peerinfo = GNUNET_PEERINFO_connect (cfg);
738 if (peerinfo == NULL)
740 FPRINTF (stderr, "%s", _("Could not access PEERINFO service. Exiting.\n"));
743 if ( (GNUNET_YES == get_self) || (GNUNET_YES == get_uri) )
745 /* load private key */
747 GNUNET_CONFIGURATION_get_value_filename (cfg, "GNUNETD", "HOSTKEY",
750 FPRINTF (stderr, _("Could not find option `%s:%s' in configuration.\n"),
751 "GNUNETD", "HOSTKEYFILE");
755 if (NULL == (priv = GNUNET_CRYPTO_rsa_key_create_from_file (fn)))
757 FPRINTF (stderr, _("Loading hostkey from `%s' failed.\n"), fn);
762 GNUNET_CRYPTO_rsa_key_get_public (priv, &my_public_key);
763 GNUNET_CRYPTO_rsa_key_free (priv);
764 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key), &my_peer_identity.hashPubKey);
767 tt = GNUNET_SCHEDULER_add_now (&state_machine, NULL);
768 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
775 * Main state machine that goes over all options and
776 * runs the next requested function.
779 * @param tc scheduler context
782 state_machine (void *cls,
783 const struct GNUNET_SCHEDULER_TaskContext *tc)
785 tt = GNUNET_SCHEDULER_NO_TASK;
789 GPI_plugins_load (cfg);
790 if (GNUNET_SYSERR == parse_hello_uri (put_uri))
792 _("Invalid URI `%s'\n"),
794 GNUNET_free (put_uri);
798 if (GNUNET_YES == get_info)
800 get_info = GNUNET_NO;
801 GPI_plugins_load (cfg);
802 pic = GNUNET_PEERINFO_iterate (peerinfo, NULL,
804 &print_peer_info, NULL);
807 if (GNUNET_YES == get_self)
809 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
811 get_self = GNUNET_NO;
812 GNUNET_CRYPTO_hash_to_enc (&my_peer_identity.hashPubKey, &enc);
814 printf ("%s\n", (char *) &enc);
816 printf (_("I am peer `%s'.\n"), (const char *) &enc);
818 if (GNUNET_YES == get_uri)
820 struct GetUriContext *guc;
823 guc = GNUNET_malloc (sizeof (struct GetUriContext));
824 pkey = GNUNET_CRYPTO_rsa_public_key_to_string (&my_public_key);
825 GNUNET_asprintf (&guc->uri,
830 GPI_plugins_load (cfg);
831 pic = GNUNET_PEERINFO_iterate (peerinfo, &my_peer_identity,
837 GNUNET_SCHEDULER_shutdown ();
842 * The main function to obtain peer information.
844 * @param argc number of arguments from the command line
845 * @param argv command line arguments
846 * @return 0 ok, 1 on error
849 main (int argc, char *const *argv)
851 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
852 {'n', "numeric", NULL,
853 gettext_noop ("don't resolve host names"),
854 0, &GNUNET_GETOPT_set_one, &no_resolve},
856 gettext_noop ("output only the identity strings"),
857 0, &GNUNET_GETOPT_set_one, &be_quiet},
859 gettext_noop ("output our own identity only"),
860 0, &GNUNET_GETOPT_set_one, &get_self},
862 gettext_noop ("list all known peers"),
863 0, &GNUNET_GETOPT_set_one, &get_info},
864 {'g', "get-hello", NULL,
865 gettext_noop ("also output HELLO uri(s)"),
866 0, &GNUNET_GETOPT_set_one, &get_uri},
867 {'p', "put-hello", "HELLO",
868 gettext_noop ("add given HELLO uri to the database"),
869 1, &GNUNET_GETOPT_set_string, &put_uri},
870 GNUNET_GETOPT_OPTION_END
873 GNUNET_PROGRAM_run (argc, argv, "gnunet-peerinfo",
874 gettext_noop ("Print information about peers."),
875 options, &run, NULL)) ? 0 : 1;
878 /* end of gnunet-peerinfo.c */