3 This file is part of GNUnet.
4 (C) 2012, 2013 Christian Grothoff (and other contributing authors)
6 GNUnet is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published
8 by the Free Software Foundation; either version 3, or (at your
9 option) any later version.
11 GNUnet is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNUnet; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
22 * @file gnunet-namestore.c
23 * @brief command line tool to manipulate the local zone
24 * @author Christian Grothoff
30 #include <gnunet_util_lib.h>
31 #include <gnunet_dnsparser_lib.h>
32 #include <gnunet_identity_service.h>
33 #include <gnunet_gnsrecord_lib.h>
34 #include <gnunet_gns_service.h>
35 #include <gnunet_namestore_service.h>
39 * Handle to the namestore.
41 static struct GNUNET_NAMESTORE_Handle *ns;
44 * Private key for the our zone.
46 static struct GNUNET_CRYPTO_EcdsaPrivateKey zone_pkey;
49 * Handle to identity lookup.
51 static struct GNUNET_IDENTITY_EgoLookup *el;
54 * Identity service handle
56 static struct GNUNET_IDENTITY_Handle *idh;
61 struct GNUNET_IDENTITY_Operation *get_default;
64 * Name of the ego controlling the zone.
66 static char *ego_name;
69 * Desired action is to add a record.
74 * Queue entry for the 'add-uri' operation.
76 static struct GNUNET_NAMESTORE_QueueEntry *add_qe_uri;
79 * Queue entry for the 'add' operation.
81 static struct GNUNET_NAMESTORE_QueueEntry *add_qe;
84 * Queue entry for the 'reverse lookup' operation (in combination with a name).
86 static struct GNUNET_NAMESTORE_QueueEntry *reverse_qe;
89 * Desired action is to list records.
94 * List iterator for the 'list' operation.
96 static struct GNUNET_NAMESTORE_ZoneIterator *list_it;
99 * Desired action is to remove a record.
104 * Is record public (opposite of #GNUNET_GNSRECORD_RF_PRIVATE)
109 * Is record a shadow record (#GNUNET_GNSRECORD_RF_SHADOW_RECORD)
114 * Queue entry for the 'del' operation.
116 static struct GNUNET_NAMESTORE_QueueEntry *del_qe;
119 * Name of the records to add/list/remove.
124 * Value of the record to add/remove.
134 * Reverse lookup to perform.
136 static char *reverse_pkey;
139 * Type of the record to add/remove, NULL to remove all.
141 static char *typestring;
144 * Desired expiration time.
146 static char *expirationstring;
151 static char *nickstring;
154 * Global return value
159 * Type string converted to DNS type value.
161 static uint32_t type;
164 * Value in binary format.
169 * Number of bytes in 'data'.
171 static size_t data_size;
174 * Expirationstring converted to relative time.
176 static struct GNUNET_TIME_Relative etime_rel;
179 * Expirationstring converted to absolute time.
181 static struct GNUNET_TIME_Absolute etime_abs;
184 * Is expiration time relative or absolute time?
186 static int etime_is_rel = GNUNET_SYSERR;
191 static struct GNUNET_NAMESTORE_ZoneMonitor *zm;
194 * Enables monitor mode.
200 * Task run on shutdown. Cleans up everything.
203 * @param tc scheduler context
206 do_shutdown (void *cls,
207 const struct GNUNET_SCHEDULER_TaskContext *tc)
209 if (NULL != get_default)
211 GNUNET_IDENTITY_cancel (get_default);
216 GNUNET_IDENTITY_disconnect (idh);
221 GNUNET_IDENTITY_ego_lookup_cancel (el);
226 GNUNET_NAMESTORE_zone_iteration_stop (list_it);
231 GNUNET_NAMESTORE_cancel (add_qe);
234 if (NULL != add_qe_uri)
236 GNUNET_NAMESTORE_cancel (add_qe_uri);
241 GNUNET_NAMESTORE_cancel (del_qe);
246 GNUNET_NAMESTORE_disconnect (ns);
249 memset (&zone_pkey, 0, sizeof (zone_pkey));
257 GNUNET_NAMESTORE_zone_monitor_stop (zm);
269 * Check if we are finished, and if so, perform shutdown.
274 if ( (NULL == add_qe) &&
275 (NULL == add_qe_uri) &&
277 (NULL == reverse_qe) &&
279 GNUNET_SCHEDULER_shutdown ();
284 * Continuation called to notify client about result of the
287 * @param cls closure, location of the QueueEntry pointer to NULL out
288 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
289 * #GNUNET_NO if content was already there
290 * #GNUNET_YES (or other positive value) on success
291 * @param emsg NULL on success, otherwise an error message
294 add_continuation (void *cls,
298 struct GNUNET_NAMESTORE_QueueEntry **qe = cls;
301 if (GNUNET_YES != success)
304 _("Adding record failed: %s\n"),
305 (GNUNET_NO == success) ? "record exists" : emsg);
306 if (GNUNET_NO != success)
315 * Continuation called to notify client about result of the
318 * @param cls closure, unused
319 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
320 * #GNUNET_NO if content was already there
321 * #GNUNET_YES (or other positive value) on success
322 * @param emsg NULL on success, otherwise an error message
325 del_continuation (void *cls,
330 if (GNUNET_NO == success)
333 _("Deleting record failed, record does not exist%s%s\n"),
334 (NULL != emsg) ? ": " : "",
335 (NULL != emsg) ? emsg : "");
337 if (GNUNET_SYSERR == success)
340 _("Deleting record failed%s%s\n"),
341 (NULL != emsg) ? ": " : "",
342 (NULL != emsg) ? emsg : "");
349 * Process a record that was stored in the namestore.
352 * @param zone_key private key of the zone
353 * @param rname name that is being mapped (at most 255 characters long)
354 * @param rd_len number of entries in @a rd array
355 * @param rd array of records with data to store
358 display_record (void *cls,
359 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
362 const struct GNUNET_GNSRECORD_Data *rd)
364 const char *typestring;
368 struct GNUNET_TIME_Absolute at;
369 struct GNUNET_TIME_Relative rt;
377 if ( (NULL != name) &&
378 (0 != strcmp (name, rname)) )
380 GNUNET_NAMESTORE_zone_iterator_next (list_it);
386 for (i=0;i<rd_len;i++)
388 typestring = GNUNET_GNSRECORD_number_to_typename (rd[i].record_type);
389 s = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
394 FPRINTF (stdout, _("\tCorrupt or unsupported record of type %u\n"),
395 (unsigned int) rd[i].record_type);
398 if (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION))
400 rt.rel_value_us = rd[i].expiration_time;
401 ets = GNUNET_STRINGS_relative_time_to_string (rt, GNUNET_YES);
405 at.abs_value_us = rd[i].expiration_time;
406 ets = GNUNET_STRINGS_absolute_time_to_string (at);
409 "\t%s: %s (%s)\t%s\t%s\t%s\n",
413 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PRIVATE)) ? "PRIVATE" : "PUBLIC",
414 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_SHADOW_RECORD)) ? "SHADOW" : "",
415 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PENDING)) ? "PENDING" : "");
418 FPRINTF (stdout, "%s", "\n");
419 GNUNET_NAMESTORE_zone_iterator_next (list_it);
424 * Function called once we are in sync in monitor mode.
431 FPRINTF (stdout, "%s", "Monitor is now in sync.\n");
436 * We're storing a record; this function is given the existing record
437 * so that we can merge the information.
439 * @param cls closure, unused
440 * @param zone_key private key of the zone
441 * @param rec_name name that is being mapped (at most 255 characters long)
442 * @param rd_count number of entries in @a rd array
443 * @param rd array of records with data to store
446 get_existing_record (void *cls,
447 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
448 const char *rec_name,
449 unsigned int rd_count,
450 const struct GNUNET_GNSRECORD_Data *rd)
452 struct GNUNET_GNSRECORD_Data rdn[rd_count + 1];
453 struct GNUNET_GNSRECORD_Data *rde;
456 if ( (NULL != zone_key) &&
457 (0 != strcmp (rec_name, name)) )
463 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received %u records for name `%s'\n",
466 memset (rdn, 0, sizeof (struct GNUNET_GNSRECORD_Data));
467 memcpy (&rdn[1], rd, rd_count * sizeof (struct GNUNET_GNSRECORD_Data));
468 /* FIXME: should add some logic to overwrite records if there
469 can only be one record of a particular type, and to check
470 if the combination of records is valid to begin with... */
473 rde->data_size = data_size;
474 rde->record_type = type;
476 rde->flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
478 rde->flags |= GNUNET_GNSRECORD_RF_PRIVATE;
479 if (GNUNET_YES == etime_is_rel)
481 rde->expiration_time = etime_rel.rel_value_us;
482 rde->flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
484 else if (GNUNET_NO == etime_is_rel)
485 rde->expiration_time = etime_abs.abs_value_us;
487 rde->expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
488 GNUNET_assert (NULL != name);
489 add_qe = GNUNET_NAMESTORE_records_store (ns,
500 * Function called with the result of our attempt to obtain a name for a given
504 * @param zone private key of the zone; NULL on disconnect
505 * @param label label of the records; NULL on disconnect
506 * @param rd_count number of entries in @a rd array, 0 if label was deleted
507 * @param rd array of records with data to store
510 handle_reverse_lookup (void *cls,
511 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
513 unsigned int rd_count,
514 const struct GNUNET_GNSRECORD_Data *rd)
530 * Function called with the result from the check if the namestore
531 * service is actually running. If it is, we start the actual
534 * @param cls closure with our configuration
535 * @param result #GNUNET_YES if the namestore service is running
538 testservice_task (void *cls,
541 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
542 struct GNUNET_CRYPTO_EcdsaPublicKey pub;
543 struct GNUNET_GNSRECORD_Data rd;
545 if (GNUNET_YES != result)
547 FPRINTF (stderr, _("Service `%s' is not running\n"),
551 if (! (add|del|list|(NULL != nickstring)|(NULL != uri)|(NULL != reverse_pkey)) )
553 /* nothing more to be done */
555 _("No options given\n"));
556 GNUNET_SCHEDULER_shutdown ();
559 GNUNET_CRYPTO_ecdsa_key_get_public (&zone_pkey,
562 ns = GNUNET_NAMESTORE_connect (cfg);
565 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
566 _("Failed to connect to namestore\n"));
574 _("Missing option `%s' for operation `%s'\n"),
576 GNUNET_SCHEDULER_shutdown ();
580 if (NULL == typestring)
583 _("Missing option `%s' for operation `%s'\n"),
585 GNUNET_SCHEDULER_shutdown ();
589 type = GNUNET_GNSRECORD_typename_to_number (typestring);
590 if (UINT32_MAX == type)
592 fprintf (stderr, _("Unsupported type `%s'\n"), typestring);
593 GNUNET_SCHEDULER_shutdown ();
600 _("Missing option `%s' for operation `%s'\n"),
603 GNUNET_SCHEDULER_shutdown ();
607 GNUNET_GNSRECORD_string_to_value (type,
612 fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"),
615 GNUNET_SCHEDULER_shutdown ();
619 if (NULL == expirationstring)
622 _("Missing option `%s' for operation `%s'\n"),
624 GNUNET_SCHEDULER_shutdown ();
628 if (0 == strcmp (expirationstring, "never"))
630 etime_abs = GNUNET_TIME_UNIT_FOREVER_ABS;
631 etime_is_rel = GNUNET_NO;
633 else if (GNUNET_OK ==
634 GNUNET_STRINGS_fancy_time_to_relative (expirationstring,
637 etime_is_rel = GNUNET_YES;
639 else if (GNUNET_OK ==
640 GNUNET_STRINGS_fancy_time_to_absolute (expirationstring,
643 etime_is_rel = GNUNET_NO;
648 _("Invalid time format `%s'\n"),
650 GNUNET_SCHEDULER_shutdown ();
654 add_qe = GNUNET_NAMESTORE_records_lookup (ns, &zone_pkey, name,
655 &get_existing_record, NULL );
662 _("Missing option `%s' for operation `%s'\n"),
664 GNUNET_SCHEDULER_shutdown ();
668 del_qe = GNUNET_NAMESTORE_records_store (ns,
677 list_it = GNUNET_NAMESTORE_zone_iteration_start (ns,
682 if (NULL != reverse_pkey)
684 struct GNUNET_CRYPTO_EcdsaPublicKey pubkey;
687 GNUNET_CRYPTO_ecdsa_public_key_from_string (reverse_pkey,
688 strlen (reverse_pkey),
692 _("Invalid public key for reverse lookup `%s'\n"),
694 GNUNET_SCHEDULER_shutdown ();
696 reverse_qe = GNUNET_NAMESTORE_zone_to_name (ns,
699 &handle_reverse_lookup,
706 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
708 if ( (2 != (sscanf (uri, "gnunet://gns/%52s/%63s", sh, sname)) ) ||
709 (GNUNET_OK != GNUNET_CRYPTO_ecdsa_public_key_from_string (sh, strlen (sh), &pkey)) )
712 _("Invalid URI `%s'\n"),
714 GNUNET_SCHEDULER_shutdown ();
718 memset (&rd, 0, sizeof (rd));
720 rd.data_size = sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey);
721 rd.record_type = GNUNET_GNSRECORD_TYPE_PKEY;
722 if (GNUNET_YES == etime_is_rel)
724 rd.expiration_time = etime_rel.rel_value_us;
725 rd.flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
727 else if (GNUNET_NO == etime_is_rel)
728 rd.expiration_time = etime_abs.abs_value_us;
730 rd.expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
733 rd.flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
734 add_qe_uri = GNUNET_NAMESTORE_records_store (ns,
742 if (NULL != nickstring)
744 if (0 == strlen(nickstring))
747 _("Invalid nick `%s'\n"),
749 GNUNET_SCHEDULER_shutdown ();
753 add_qe_uri = GNUNET_NAMESTORE_set_nick(ns, &zone_pkey, nickstring,
754 &add_continuation, &add_qe_uri);
758 zm = GNUNET_NAMESTORE_zone_monitor_start (cfg,
769 * Callback invoked from identity service with ego information.
770 * An @a ego of NULL means the ego was not found.
772 * @param cls closure with the configuration
773 * @param ego an ego known to identity service, or NULL
776 identity_cb (void *cls,
777 const struct GNUNET_IDENTITY_Ego *ego)
779 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
784 if (NULL != ego_name)
787 _("Ego `%s' not known to identity service\n"),
790 GNUNET_SCHEDULER_shutdown ();
794 zone_pkey = *GNUNET_IDENTITY_ego_get_private_key (ego);
795 GNUNET_free_non_null (ego_name);
797 GNUNET_CLIENT_service_test ("namestore", cfg,
798 GNUNET_TIME_UNIT_SECONDS,
805 default_ego_cb (void *cls,
806 struct GNUNET_IDENTITY_Ego *ego,
814 _("No default ego configured in identity service\n"));
815 GNUNET_SCHEDULER_shutdown ();
821 identity_cb (cls, ego);
826 id_connect_cb (void *cls,
827 struct GNUNET_IDENTITY_Ego *ego,
831 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
834 get_default = GNUNET_IDENTITY_get (idh, "namestore",
835 &default_ego_cb, (void *) cfg);
841 testservice_id_task (void *cls, int result)
843 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
844 if (result != GNUNET_YES)
847 _("Identity service is not running\n"));
848 GNUNET_SCHEDULER_shutdown ();
852 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
853 &do_shutdown, (void *) cfg);
855 if (NULL == ego_name)
857 idh = GNUNET_IDENTITY_connect (cfg, &id_connect_cb, (void *) cfg);
859 fprintf (stderr, _("Cannot connect to identity service\n"));
863 el = GNUNET_IDENTITY_ego_lookup (cfg,
871 * Main function that will be run.
874 * @param args remaining command-line arguments
875 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
876 * @param cfg configuration
879 run (void *cls, char *const *args, const char *cfgfile,
880 const struct GNUNET_CONFIGURATION_Handle *cfg)
882 if ( (NULL != args[0]) && (NULL == uri) )
883 uri = GNUNET_strdup (args[0]);
885 GNUNET_CLIENT_service_test ("identity", cfg,
886 GNUNET_TIME_UNIT_SECONDS,
887 &testservice_id_task,
893 * The main function for gnunet-namestore.
895 * @param argc number of arguments from the command line
896 * @param argv command line arguments
897 * @return 0 ok, 1 on error
900 main (int argc, char *const *argv)
905 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
907 gettext_noop ("add record"), 0,
908 &GNUNET_GETOPT_set_one, &add},
909 {'d', "delete", NULL,
910 gettext_noop ("delete record"), 0,
911 &GNUNET_GETOPT_set_one, &del},
912 {'D', "display", NULL,
913 gettext_noop ("display records"), 0,
914 &GNUNET_GETOPT_set_one, &list},
915 {'e', "expiration", "TIME",
916 gettext_noop ("expiration time for record to use (for adding only), \"never\" is possible"), 1,
917 &GNUNET_GETOPT_set_string, &expirationstring},
918 {'i', "nick", "NICKNAME",
919 gettext_noop ("set the desired nick name for the zone"), 1,
920 &GNUNET_GETOPT_set_string, &nickstring},
921 {'m', "monitor", NULL,
922 gettext_noop ("monitor changes in the namestore"), 0,
923 &GNUNET_GETOPT_set_one, &monitor},
924 {'n', "name", "NAME",
925 gettext_noop ("name of the record to add/delete/display"), 1,
926 &GNUNET_GETOPT_set_string, &name},
927 {'r', "reverse", "PKEY",
928 gettext_noop ("determine our name for the given PKEY"), 1,
929 &GNUNET_GETOPT_set_string, &reverse_pkey},
930 {'t', "type", "TYPE",
931 gettext_noop ("type of the record to add/delete/display"), 1,
932 &GNUNET_GETOPT_set_string, &typestring},
934 gettext_noop ("URI to import into our zone"), 1,
935 &GNUNET_GETOPT_set_string, &uri},
936 {'V', "value", "VALUE",
937 gettext_noop ("value of the record to add/delete"), 1,
938 &GNUNET_GETOPT_set_string, &value},
939 {'p', "public", NULL,
940 gettext_noop ("create or list public record"), 0,
941 &GNUNET_GETOPT_set_one, &public},
942 {'s', "shadow", NULL,
943 gettext_noop ("create shadow record (only valid if all other records of the same type have expired"), 0,
944 &GNUNET_GETOPT_set_one, &shadow},
946 gettext_noop ("name of the ego controlling the zone"), 1,
947 &GNUNET_GETOPT_set_string, &ego_name},
948 GNUNET_GETOPT_OPTION_END
951 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
954 GNUNET_log_setup ("gnunet-namestore", "WARNING", NULL);
956 GNUNET_PROGRAM_run (argc, argv, "gnunet-namestore",
957 _("GNUnet zone manipulation tool"),
961 GNUNET_free ((void*) argv);
962 GNUNET_CRYPTO_ecdsa_key_clear (&zone_pkey);
965 GNUNET_free ((void*) argv);
966 GNUNET_CRYPTO_ecdsa_key_clear (&zone_pkey);
970 /* end of gnunet-namestore.c */