2 This file is part of GNUnet.
3 (C) 2012, 2013 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.
21 * @file gnunet-namestore.c
22 * @brief command line tool to manipulate the local zone
23 * @author Christian Grothoff
29 #include <gnunet_util_lib.h>
30 #include <gnunet_dnsparser_lib.h>
31 #include <gnunet_identity_service.h>
32 #include <gnunet_gnsrecord_lib.h>
33 #include <gnunet_gns_service.h>
34 #include <gnunet_namestore_service.h>
38 * Handle to the namestore.
40 static struct GNUNET_NAMESTORE_Handle *ns;
43 * Private key for the our zone.
45 static struct GNUNET_CRYPTO_EcdsaPrivateKey zone_pkey;
48 * Handle to identity lookup.
50 static struct GNUNET_IDENTITY_EgoLookup *el;
53 * Identity service handle
55 static struct GNUNET_IDENTITY_Handle *idh;
60 struct GNUNET_IDENTITY_Operation *get_default;
63 * Name of the ego controlling the zone.
65 static char *ego_name;
68 * Desired action is to add a record.
73 * Queue entry for the 'add-uri' operation.
75 static struct GNUNET_NAMESTORE_QueueEntry *add_qe_uri;
78 * Queue entry for the 'add' operation.
80 static struct GNUNET_NAMESTORE_QueueEntry *add_qe;
83 * Queue entry for the 'reverse lookup' operation (in combination with a name).
85 static struct GNUNET_NAMESTORE_QueueEntry *reverse_qe;
88 * Desired action is to list records.
93 * List iterator for the 'list' operation.
95 static struct GNUNET_NAMESTORE_ZoneIterator *list_it;
98 * Desired action is to remove a record.
103 * Is record public (opposite of #GNUNET_GNSRECORD_RF_PRIVATE)
108 * Is record a shadow record (#GNUNET_GNSRECORD_RF_SHADOW_RECORD)
113 * Queue entry for the 'del' operation.
115 static struct GNUNET_NAMESTORE_QueueEntry *del_qe;
118 * Name of the records to add/list/remove.
123 * Value of the record to add/remove.
133 * Reverse lookup to perform.
135 static char *reverse_pkey;
138 * Type of the record to add/remove, NULL to remove all.
140 static char *typestring;
143 * Desired expiration time.
145 static char *expirationstring;
150 static char *nickstring;
153 * Global return value
158 * Type string converted to DNS type value.
160 static uint32_t type;
163 * Value in binary format.
168 * Number of bytes in 'data'.
170 static size_t data_size;
173 * Expirationstring converted to relative time.
175 static struct GNUNET_TIME_Relative etime_rel;
178 * Expirationstring converted to absolute time.
180 static struct GNUNET_TIME_Absolute etime_abs;
183 * Is expiration time relative or absolute time?
185 static int etime_is_rel = GNUNET_SYSERR;
190 static struct GNUNET_NAMESTORE_ZoneMonitor *zm;
193 * Enables monitor mode.
199 * Task run on shutdown. Cleans up everything.
202 * @param tc scheduler context
205 do_shutdown (void *cls,
206 const struct GNUNET_SCHEDULER_TaskContext *tc)
208 if (NULL != get_default)
210 GNUNET_IDENTITY_cancel (get_default);
215 GNUNET_IDENTITY_disconnect (idh);
220 GNUNET_IDENTITY_ego_lookup_cancel (el);
225 GNUNET_NAMESTORE_zone_iteration_stop (list_it);
230 GNUNET_NAMESTORE_cancel (add_qe);
233 if (NULL != add_qe_uri)
235 GNUNET_NAMESTORE_cancel (add_qe_uri);
240 GNUNET_NAMESTORE_cancel (del_qe);
245 GNUNET_NAMESTORE_disconnect (ns);
248 memset (&zone_pkey, 0, sizeof (zone_pkey));
256 GNUNET_NAMESTORE_zone_monitor_stop (zm);
268 * Check if we are finished, and if so, perform shutdown.
273 if ( (NULL == add_qe) &&
274 (NULL == add_qe_uri) &&
276 (NULL == reverse_qe) &&
278 GNUNET_SCHEDULER_shutdown ();
283 * Continuation called to notify client about result of the
286 * @param cls closure, location of the QueueEntry pointer to NULL out
287 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
288 * #GNUNET_NO if content was already there
289 * #GNUNET_YES (or other positive value) on success
290 * @param emsg NULL on success, otherwise an error message
293 add_continuation (void *cls,
297 struct GNUNET_NAMESTORE_QueueEntry **qe = cls;
300 if (GNUNET_YES != success)
303 _("Adding record failed: %s\n"),
304 (GNUNET_NO == success) ? "record exists" : emsg);
305 if (GNUNET_NO != success)
314 * Continuation called to notify client about result of the
317 * @param cls closure, unused
318 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
319 * #GNUNET_NO if content was already there
320 * #GNUNET_YES (or other positive value) on success
321 * @param emsg NULL on success, otherwise an error message
324 del_continuation (void *cls,
329 if (GNUNET_NO == success)
332 _("Deleting record failed, record does not exist%s%s\n"),
333 (NULL != emsg) ? ": " : "",
334 (NULL != emsg) ? emsg : "");
336 if (GNUNET_SYSERR == success)
339 _("Deleting record failed%s%s\n"),
340 (NULL != emsg) ? ": " : "",
341 (NULL != emsg) ? emsg : "");
348 * Process a record that was stored in the namestore.
351 * @param zone_key private key of the zone
352 * @param rname name that is being mapped (at most 255 characters long)
353 * @param rd_len number of entries in @a rd array
354 * @param rd array of records with data to store
357 display_record (void *cls,
358 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
361 const struct GNUNET_GNSRECORD_Data *rd)
363 const char *typestring;
367 struct GNUNET_TIME_Absolute at;
368 struct GNUNET_TIME_Relative rt;
376 if ( (NULL != name) &&
377 (0 != strcmp (name, rname)) )
379 GNUNET_NAMESTORE_zone_iterator_next (list_it);
385 for (i=0;i<rd_len;i++)
387 if ( (GNUNET_GNSRECORD_TYPE_NICK == rd[i].record_type) &&
391 typestring = GNUNET_GNSRECORD_number_to_typename (rd[i].record_type);
392 s = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
397 FPRINTF (stdout, _("\tCorrupt or unsupported record of type %u\n"),
398 (unsigned int) rd[i].record_type);
401 if (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION))
403 rt.rel_value_us = rd[i].expiration_time;
404 ets = GNUNET_STRINGS_relative_time_to_string (rt, GNUNET_YES);
408 at.abs_value_us = rd[i].expiration_time;
409 ets = GNUNET_STRINGS_absolute_time_to_string (at);
412 "\t%s: %s (%s)\t%s\t%s\t%s\n",
416 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PRIVATE)) ? "PRIVATE" : "PUBLIC",
417 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_SHADOW_RECORD)) ? "SHADOW" : "",
418 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PENDING)) ? "PENDING" : "");
421 FPRINTF (stdout, "%s", "\n");
422 GNUNET_NAMESTORE_zone_iterator_next (list_it);
427 * Function called once we are in sync in monitor mode.
434 FPRINTF (stdout, "%s", "Monitor is now in sync.\n");
439 * We're storing a record; this function is given the existing record
440 * so that we can merge the information.
442 * @param cls closure, unused
443 * @param zone_key private key of the zone
444 * @param rec_name name that is being mapped (at most 255 characters long)
445 * @param rd_count number of entries in @a rd array
446 * @param rd array of records with data to store
449 get_existing_record (void *cls,
450 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
451 const char *rec_name,
452 unsigned int rd_count,
453 const struct GNUNET_GNSRECORD_Data *rd)
455 struct GNUNET_GNSRECORD_Data rdn[rd_count + 1];
456 struct GNUNET_GNSRECORD_Data *rde;
459 if ( (NULL != zone_key) &&
460 (0 != strcmp (rec_name, name)) )
466 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received %u records for name `%s'\n",
469 memset (rdn, 0, sizeof (struct GNUNET_GNSRECORD_Data));
470 memcpy (&rdn[1], rd, rd_count * sizeof (struct GNUNET_GNSRECORD_Data));
471 /* FIXME: should add some logic to overwrite records if there
472 can only be one record of a particular type, and to check
473 if the combination of records is valid to begin with... */
476 rde->data_size = data_size;
477 rde->record_type = type;
479 rde->flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
481 rde->flags |= GNUNET_GNSRECORD_RF_PRIVATE;
482 if (GNUNET_YES == etime_is_rel)
484 rde->expiration_time = etime_rel.rel_value_us;
485 rde->flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
487 else if (GNUNET_NO == etime_is_rel)
488 rde->expiration_time = etime_abs.abs_value_us;
490 rde->expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
491 GNUNET_assert (NULL != name);
492 add_qe = GNUNET_NAMESTORE_records_store (ns,
503 * Function called with the result of our attempt to obtain a name for a given
507 * @param zone private key of the zone; NULL on disconnect
508 * @param label label of the records; NULL on disconnect
509 * @param rd_count number of entries in @a rd array, 0 if label was deleted
510 * @param rd array of records with data to store
513 handle_reverse_lookup (void *cls,
514 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
516 unsigned int rd_count,
517 const struct GNUNET_GNSRECORD_Data *rd)
533 * Function called with the result from the check if the namestore
534 * service is actually running. If it is, we start the actual
537 * @param cls closure with our configuration
538 * @param result #GNUNET_YES if the namestore service is running
541 testservice_task (void *cls,
544 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
545 struct GNUNET_CRYPTO_EcdsaPublicKey pub;
546 struct GNUNET_GNSRECORD_Data rd;
548 if (GNUNET_YES != result)
550 FPRINTF (stderr, _("Service `%s' is not running\n"),
554 if (! (add|del|list|(NULL != nickstring)|(NULL != uri)|(NULL != reverse_pkey)) )
556 /* nothing more to be done */
558 _("No options given\n"));
559 GNUNET_SCHEDULER_shutdown ();
562 GNUNET_CRYPTO_ecdsa_key_get_public (&zone_pkey,
565 ns = GNUNET_NAMESTORE_connect (cfg);
568 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
569 _("Failed to connect to namestore\n"));
577 _("Missing option `%s' for operation `%s'\n"),
579 GNUNET_SCHEDULER_shutdown ();
583 if (NULL == typestring)
586 _("Missing option `%s' for operation `%s'\n"),
588 GNUNET_SCHEDULER_shutdown ();
592 type = GNUNET_GNSRECORD_typename_to_number (typestring);
593 if (UINT32_MAX == type)
595 fprintf (stderr, _("Unsupported type `%s'\n"), typestring);
596 GNUNET_SCHEDULER_shutdown ();
603 _("Missing option `%s' for operation `%s'\n"),
606 GNUNET_SCHEDULER_shutdown ();
610 GNUNET_GNSRECORD_string_to_value (type,
615 fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"),
618 GNUNET_SCHEDULER_shutdown ();
622 if (NULL == expirationstring)
625 _("Missing option `%s' for operation `%s'\n"),
627 GNUNET_SCHEDULER_shutdown ();
631 if (0 == strcmp (expirationstring, "never"))
633 etime_abs = GNUNET_TIME_UNIT_FOREVER_ABS;
634 etime_is_rel = GNUNET_NO;
636 else if (GNUNET_OK ==
637 GNUNET_STRINGS_fancy_time_to_relative (expirationstring,
640 etime_is_rel = GNUNET_YES;
642 else if (GNUNET_OK ==
643 GNUNET_STRINGS_fancy_time_to_absolute (expirationstring,
646 etime_is_rel = GNUNET_NO;
651 _("Invalid time format `%s'\n"),
653 GNUNET_SCHEDULER_shutdown ();
657 add_qe = GNUNET_NAMESTORE_records_lookup (ns, &zone_pkey, name,
658 &get_existing_record, NULL );
665 _("Missing option `%s' for operation `%s'\n"),
667 GNUNET_SCHEDULER_shutdown ();
671 del_qe = GNUNET_NAMESTORE_records_store (ns,
680 list_it = GNUNET_NAMESTORE_zone_iteration_start (ns,
685 if (NULL != reverse_pkey)
687 struct GNUNET_CRYPTO_EcdsaPublicKey pubkey;
690 GNUNET_CRYPTO_ecdsa_public_key_from_string (reverse_pkey,
691 strlen (reverse_pkey),
695 _("Invalid public key for reverse lookup `%s'\n"),
697 GNUNET_SCHEDULER_shutdown ();
699 reverse_qe = GNUNET_NAMESTORE_zone_to_name (ns,
702 &handle_reverse_lookup,
709 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
711 if ( (2 != (sscanf (uri, "gnunet://gns/%52s/%63s", sh, sname)) ) ||
712 (GNUNET_OK != GNUNET_CRYPTO_ecdsa_public_key_from_string (sh, strlen (sh), &pkey)) )
715 _("Invalid URI `%s'\n"),
717 GNUNET_SCHEDULER_shutdown ();
721 memset (&rd, 0, sizeof (rd));
723 rd.data_size = sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey);
724 rd.record_type = GNUNET_GNSRECORD_TYPE_PKEY;
725 if (GNUNET_YES == etime_is_rel)
727 rd.expiration_time = etime_rel.rel_value_us;
728 rd.flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
730 else if (GNUNET_NO == etime_is_rel)
731 rd.expiration_time = etime_abs.abs_value_us;
733 rd.expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
736 rd.flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
737 add_qe_uri = GNUNET_NAMESTORE_records_store (ns,
745 if (NULL != nickstring)
747 if (0 == strlen(nickstring))
750 _("Invalid nick `%s'\n"),
752 GNUNET_SCHEDULER_shutdown ();
756 add_qe_uri = GNUNET_NAMESTORE_set_nick(ns, &zone_pkey, nickstring,
757 &add_continuation, &add_qe_uri);
761 zm = GNUNET_NAMESTORE_zone_monitor_start (cfg,
772 * Callback invoked from identity service with ego information.
773 * An @a ego of NULL means the ego was not found.
775 * @param cls closure with the configuration
776 * @param ego an ego known to identity service, or NULL
779 identity_cb (void *cls,
780 const struct GNUNET_IDENTITY_Ego *ego)
782 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
787 if (NULL != ego_name)
790 _("Ego `%s' not known to identity service\n"),
793 GNUNET_SCHEDULER_shutdown ();
797 zone_pkey = *GNUNET_IDENTITY_ego_get_private_key (ego);
798 GNUNET_free_non_null (ego_name);
800 GNUNET_CLIENT_service_test ("namestore", cfg,
801 GNUNET_TIME_UNIT_SECONDS,
808 default_ego_cb (void *cls,
809 struct GNUNET_IDENTITY_Ego *ego,
817 _("No default ego configured in identity service\n"));
818 GNUNET_SCHEDULER_shutdown ();
824 identity_cb (cls, ego);
830 id_connect_cb (void *cls,
831 struct GNUNET_IDENTITY_Ego *ego,
835 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
839 get_default = GNUNET_IDENTITY_get (idh,
841 &default_ego_cb, (void *) cfg);
847 testservice_id_task (void *cls, int result)
849 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
850 if (result != GNUNET_YES)
853 _("Identity service is not running\n"));
854 GNUNET_SCHEDULER_shutdown ();
858 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
859 &do_shutdown, (void *) cfg);
861 if (NULL == ego_name)
863 idh = GNUNET_IDENTITY_connect (cfg, &id_connect_cb, (void *) cfg);
865 fprintf (stderr, _("Cannot connect to identity service\n"));
869 el = GNUNET_IDENTITY_ego_lookup (cfg,
877 * Main function that will be run.
880 * @param args remaining command-line arguments
881 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
882 * @param cfg configuration
885 run (void *cls, char *const *args, const char *cfgfile,
886 const struct GNUNET_CONFIGURATION_Handle *cfg)
888 if ( (NULL != args[0]) && (NULL == uri) )
889 uri = GNUNET_strdup (args[0]);
891 GNUNET_CLIENT_service_test ("identity", cfg,
892 GNUNET_TIME_UNIT_SECONDS,
893 &testservice_id_task,
899 * The main function for gnunet-namestore.
901 * @param argc number of arguments from the command line
902 * @param argv command line arguments
903 * @return 0 ok, 1 on error
906 main (int argc, char *const *argv)
911 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
913 gettext_noop ("add record"), 0,
914 &GNUNET_GETOPT_set_one, &add},
915 {'d', "delete", NULL,
916 gettext_noop ("delete record"), 0,
917 &GNUNET_GETOPT_set_one, &del},
918 {'D', "display", NULL,
919 gettext_noop ("display records"), 0,
920 &GNUNET_GETOPT_set_one, &list},
921 {'e', "expiration", "TIME",
922 gettext_noop ("expiration time for record to use (for adding only), \"never\" is possible"), 1,
923 &GNUNET_GETOPT_set_string, &expirationstring},
924 {'i', "nick", "NICKNAME",
925 gettext_noop ("set the desired nick name for the zone"), 1,
926 &GNUNET_GETOPT_set_string, &nickstring},
927 {'m', "monitor", NULL,
928 gettext_noop ("monitor changes in the namestore"), 0,
929 &GNUNET_GETOPT_set_one, &monitor},
930 {'n', "name", "NAME",
931 gettext_noop ("name of the record to add/delete/display"), 1,
932 &GNUNET_GETOPT_set_string, &name},
933 {'r', "reverse", "PKEY",
934 gettext_noop ("determine our name for the given PKEY"), 1,
935 &GNUNET_GETOPT_set_string, &reverse_pkey},
936 {'t', "type", "TYPE",
937 gettext_noop ("type of the record to add/delete/display"), 1,
938 &GNUNET_GETOPT_set_string, &typestring},
940 gettext_noop ("URI to import into our zone"), 1,
941 &GNUNET_GETOPT_set_string, &uri},
942 {'V', "value", "VALUE",
943 gettext_noop ("value of the record to add/delete"), 1,
944 &GNUNET_GETOPT_set_string, &value},
945 {'p', "public", NULL,
946 gettext_noop ("create or list public record"), 0,
947 &GNUNET_GETOPT_set_one, &public},
948 {'s', "shadow", NULL,
949 gettext_noop ("create shadow record (only valid if all other records of the same type have expired"), 0,
950 &GNUNET_GETOPT_set_one, &shadow},
952 gettext_noop ("name of the ego controlling the zone"), 1,
953 &GNUNET_GETOPT_set_string, &ego_name},
954 GNUNET_GETOPT_OPTION_END
957 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
960 GNUNET_log_setup ("gnunet-namestore", "WARNING", NULL);
962 GNUNET_PROGRAM_run (argc, argv, "gnunet-namestore",
963 _("GNUnet zone manipulation tool"),
967 GNUNET_free ((void*) argv);
968 GNUNET_CRYPTO_ecdsa_key_clear (&zone_pkey);
971 GNUNET_free ((void*) argv);
972 GNUNET_CRYPTO_ecdsa_key_clear (&zone_pkey);
976 /* end of gnunet-namestore.c */