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 * Name of the ego controlling the zone.
56 static char *ego_name;
59 * Desired action is to add a record.
64 * Queue entry for the 'add-uri' operation.
66 static struct GNUNET_NAMESTORE_QueueEntry *add_qe_uri;
69 * Queue entry for the 'add' operation.
71 static struct GNUNET_NAMESTORE_QueueEntry *add_qe;
74 * Queue entry for the 'reverse lookup' operation (in combination with a name).
76 static struct GNUNET_NAMESTORE_QueueEntry *reverse_qe;
79 * Desired action is to list records.
84 * List iterator for the 'list' operation.
86 static struct GNUNET_NAMESTORE_ZoneIterator *list_it;
89 * Desired action is to remove a record.
94 * Is record public (opposite of #GNUNET_GNSRECORD_RF_PRIVATE)
99 * Is record a shadow record (#GNUNET_GNSRECORD_RF_SHADOW_RECORD)
104 * Queue entry for the 'del' operation.
106 static struct GNUNET_NAMESTORE_QueueEntry *del_qe;
109 * Name of the records to add/list/remove.
114 * Value of the record to add/remove.
124 * Reverse lookup to perform.
126 static char *reverse_pkey;
129 * Type of the record to add/remove, NULL to remove all.
131 static char *typestring;
134 * Desired expiration time.
136 static char *expirationstring;
141 static char *nickstring;
144 * Global return value
149 * Type string converted to DNS type value.
151 static uint32_t type;
154 * Value in binary format.
159 * Number of bytes in 'data'.
161 static size_t data_size;
164 * Expirationstring converted to relative time.
166 static struct GNUNET_TIME_Relative etime_rel;
169 * Expirationstring converted to absolute time.
171 static struct GNUNET_TIME_Absolute etime_abs;
174 * Is expiration time relative or absolute time?
176 static int etime_is_rel = GNUNET_SYSERR;
181 static struct GNUNET_NAMESTORE_ZoneMonitor *zm;
184 * Enables monitor mode.
190 * Task run on shutdown. Cleans up everything.
193 * @param tc scheduler context
196 do_shutdown (void *cls,
197 const struct GNUNET_SCHEDULER_TaskContext *tc)
201 GNUNET_IDENTITY_ego_lookup_cancel (el);
206 GNUNET_NAMESTORE_zone_iteration_stop (list_it);
211 GNUNET_NAMESTORE_cancel (add_qe);
214 if (NULL != add_qe_uri)
216 GNUNET_NAMESTORE_cancel (add_qe_uri);
221 GNUNET_NAMESTORE_cancel (del_qe);
226 GNUNET_NAMESTORE_disconnect (ns);
229 memset (&zone_pkey, 0, sizeof (zone_pkey));
237 GNUNET_NAMESTORE_zone_monitor_stop (zm);
249 * Check if we are finished, and if so, perform shutdown.
254 if ( (NULL == add_qe) &&
255 (NULL == add_qe_uri) &&
257 (NULL == reverse_qe) &&
259 GNUNET_SCHEDULER_shutdown ();
264 * Continuation called to notify client about result of the
267 * @param cls closure, location of the QueueEntry pointer to NULL out
268 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
269 * #GNUNET_NO if content was already there
270 * #GNUNET_YES (or other positive value) on success
271 * @param emsg NULL on success, otherwise an error message
274 add_continuation (void *cls,
278 struct GNUNET_NAMESTORE_QueueEntry **qe = cls;
281 if (GNUNET_YES != success)
284 _("Adding record failed: %s\n"),
285 (GNUNET_NO == success) ? "record exists" : emsg);
286 if (GNUNET_NO != success)
294 * Continuation called to notify client about result of the
297 * @param cls closure, unused
298 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
299 * #GNUNET_NO if content was already there
300 * #GNUNET_YES (or other positive value) on success
301 * @param emsg NULL on success, otherwise an error message
304 del_continuation (void *cls,
309 if (GNUNET_NO == success)
312 _("Deleting record failed, record does not exist%s%s\n"),
313 (NULL != emsg) ? ": " : "",
314 (NULL != emsg) ? emsg : "");
316 if (GNUNET_SYSERR == success)
319 _("Deleting record failed%s%s\n"),
320 (NULL != emsg) ? ": " : "",
321 (NULL != emsg) ? emsg : "");
328 * Process a record that was stored in the namestore.
331 * @param zone_key private key of the zone
332 * @param rname name that is being mapped (at most 255 characters long)
333 * @param rd_len number of entries in @a rd array
334 * @param rd array of records with data to store
337 display_record (void *cls,
338 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
341 const struct GNUNET_GNSRECORD_Data *rd)
343 const char *typestring;
347 struct GNUNET_TIME_Absolute at;
348 struct GNUNET_TIME_Relative rt;
356 if ( (NULL != name) &&
357 (0 != strcmp (name, rname)) )
359 GNUNET_NAMESTORE_zone_iterator_next (list_it);
365 for (i=0;i<rd_len;i++)
367 typestring = GNUNET_GNSRECORD_number_to_typename (rd[i].record_type);
368 s = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
373 FPRINTF (stdout, _("\tCorrupt or unsupported record of type %u\n"),
374 (unsigned int) rd[i].record_type);
377 if (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION))
379 rt.rel_value_us = rd[i].expiration_time;
380 ets = GNUNET_STRINGS_relative_time_to_string (rt, GNUNET_YES);
384 at.abs_value_us = rd[i].expiration_time;
385 ets = GNUNET_STRINGS_absolute_time_to_string (at);
388 "\t%s: %s (%s)\t%s\t%s\t%s\n",
392 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PRIVATE)) ? "PRIVATE" : "PUBLIC",
393 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_SHADOW_RECORD)) ? "SHADOW" : "",
394 (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PENDING)) ? "PENDING" : "");
397 FPRINTF (stdout, "%s", "\n");
398 GNUNET_NAMESTORE_zone_iterator_next (list_it);
403 * Function called once we are in sync in monitor mode.
410 FPRINTF (stdout, "%s", "Monitor is now in sync.\n");
415 * We're storing a record; this function is given the existing record
416 * so that we can merge the information.
418 * @param cls closure, unused
419 * @param zone_key private key of the zone
420 * @param rec_name name that is being mapped (at most 255 characters long)
421 * @param rd_count number of entries in @a rd array
422 * @param rd array of records with data to store
425 get_existing_record (void *cls,
426 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
427 const char *rec_name,
428 unsigned int rd_count,
429 const struct GNUNET_GNSRECORD_Data *rd)
431 struct GNUNET_GNSRECORD_Data rdn[rd_count + 1];
432 struct GNUNET_GNSRECORD_Data *rde;
435 if ( (NULL != zone_key) &&
436 (0 != strcmp (rec_name, name)) )
442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received %u records for name `%s'\n",
445 memset (rdn, 0, sizeof (struct GNUNET_GNSRECORD_Data));
446 memcpy (&rdn[1], rd, rd_count * sizeof (struct GNUNET_GNSRECORD_Data));
447 /* FIXME: should add some logic to overwrite records if there
448 can only be one record of a particular type, and to check
449 if the combination of records is valid to begin with... */
452 rde->data_size = data_size;
453 rde->record_type = type;
455 rde->flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
457 rde->flags |= GNUNET_GNSRECORD_RF_PRIVATE;
458 if (GNUNET_YES == etime_is_rel)
460 rde->expiration_time = etime_rel.rel_value_us;
461 rde->flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
463 else if (GNUNET_NO == etime_is_rel)
464 rde->expiration_time = etime_abs.abs_value_us;
466 rde->expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
467 GNUNET_assert (NULL != name);
468 add_qe = GNUNET_NAMESTORE_records_store (ns,
479 * Function called with the result of our attempt to obtain a name for a given
483 * @param zone private key of the zone; NULL on disconnect
484 * @param label label of the records; NULL on disconnect
485 * @param rd_count number of entries in @a rd array, 0 if label was deleted
486 * @param rd array of records with data to store
489 handle_reverse_lookup (void *cls,
490 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
492 unsigned int rd_count,
493 const struct GNUNET_GNSRECORD_Data *rd)
509 * Function called with the result from the check if the namestore
510 * service is actually running. If it is, we start the actual
513 * @param cls closure with our configuration
514 * @param result #GNUNET_YES if the namestore service is running
517 testservice_task (void *cls,
520 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
521 struct GNUNET_CRYPTO_EcdsaPublicKey pub;
522 struct GNUNET_GNSRECORD_Data rd;
524 if (GNUNET_YES != result)
526 FPRINTF (stderr, _("Service `%s' is not running\n"),
530 if (! (add|del|list|(NULL != nickstring)|(NULL != uri)|(NULL != reverse_pkey)) )
532 /* nothing more to be done */
534 _("No options given\n"));
535 GNUNET_SCHEDULER_shutdown ();
538 GNUNET_CRYPTO_ecdsa_key_get_public (&zone_pkey,
541 ns = GNUNET_NAMESTORE_connect (cfg);
544 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
545 _("Failed to connect to namestore\n"));
553 _("Missing option `%s' for operation `%s'\n"),
555 GNUNET_SCHEDULER_shutdown ();
559 if (NULL == typestring)
562 _("Missing option `%s' for operation `%s'\n"),
564 GNUNET_SCHEDULER_shutdown ();
568 type = GNUNET_GNSRECORD_typename_to_number (typestring);
569 if (UINT32_MAX == type)
571 fprintf (stderr, _("Unsupported type `%s'\n"), typestring);
572 GNUNET_SCHEDULER_shutdown ();
579 _("Missing option `%s' for operation `%s'\n"),
582 GNUNET_SCHEDULER_shutdown ();
586 GNUNET_GNSRECORD_string_to_value (type,
591 fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"),
594 GNUNET_SCHEDULER_shutdown ();
598 if (NULL == expirationstring)
601 _("Missing option `%s' for operation `%s'\n"),
603 GNUNET_SCHEDULER_shutdown ();
607 if (0 == strcmp (expirationstring, "never"))
609 etime_abs = GNUNET_TIME_UNIT_FOREVER_ABS;
610 etime_is_rel = GNUNET_NO;
612 else if (GNUNET_OK ==
613 GNUNET_STRINGS_fancy_time_to_relative (expirationstring,
616 etime_is_rel = GNUNET_YES;
618 else if (GNUNET_OK ==
619 GNUNET_STRINGS_fancy_time_to_absolute (expirationstring,
622 etime_is_rel = GNUNET_NO;
627 _("Invalid time format `%s'\n"),
629 GNUNET_SCHEDULER_shutdown ();
633 add_qe = GNUNET_NAMESTORE_records_lookup (ns, &zone_pkey, name,
634 &get_existing_record, NULL );
641 _("Missing option `%s' for operation `%s'\n"),
643 GNUNET_SCHEDULER_shutdown ();
647 del_qe = GNUNET_NAMESTORE_records_store (ns,
656 list_it = GNUNET_NAMESTORE_zone_iteration_start (ns,
661 if (NULL != reverse_pkey)
663 struct GNUNET_CRYPTO_EcdsaPublicKey pubkey;
666 GNUNET_CRYPTO_ecdsa_public_key_from_string (reverse_pkey,
667 strlen (reverse_pkey),
671 _("Invalid public key for reverse lookup `%s'\n"),
673 GNUNET_SCHEDULER_shutdown ();
675 reverse_qe = GNUNET_NAMESTORE_zone_to_name (ns,
678 &handle_reverse_lookup,
685 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
687 if ( (2 != (sscanf (uri,
688 "gnunet://gns/%104s/%63s",
692 GNUNET_CRYPTO_ecdsa_public_key_from_string (sh, strlen (sh), &pkey)) )
695 _("Invalid URI `%s'\n"),
697 GNUNET_SCHEDULER_shutdown ();
701 memset (&rd, 0, sizeof (rd));
703 rd.data_size = sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey);
704 rd.record_type = GNUNET_GNSRECORD_TYPE_PKEY;
705 if (GNUNET_YES == etime_is_rel)
707 rd.expiration_time = etime_rel.rel_value_us;
708 rd.flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
710 else if (GNUNET_NO == etime_is_rel)
711 rd.expiration_time = etime_abs.abs_value_us;
713 rd.expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
716 rd.flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
717 add_qe_uri = GNUNET_NAMESTORE_records_store (ns,
725 if (NULL != nickstring)
727 if (0 == strlen(nickstring))
730 _("Invalid nick `%s'\n"),
732 GNUNET_SCHEDULER_shutdown ();
736 add_qe_uri = GNUNET_NAMESTORE_set_nick(ns, &zone_pkey, nickstring,
737 &add_continuation, &add_qe_uri);
741 zm = GNUNET_NAMESTORE_zone_monitor_start (cfg,
752 * Callback invoked from identity service with ego information.
753 * An @a ego of NULL means the ego was not found.
755 * @param cls closure with the configuration
756 * @param ego an ego known to identity service, or NULL
759 identity_cb (void *cls,
760 const struct GNUNET_IDENTITY_Ego *ego)
762 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
768 _("Ego `%s' not known to identity service\n"),
770 GNUNET_SCHEDULER_shutdown ();
773 zone_pkey = *GNUNET_IDENTITY_ego_get_private_key (ego);
774 GNUNET_free (ego_name);
776 GNUNET_CLIENT_service_test ("namestore", cfg,
777 GNUNET_TIME_UNIT_SECONDS,
784 * Main function that will be run.
787 * @param args remaining command-line arguments
788 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
789 * @param cfg configuration
792 run (void *cls, char *const *args, const char *cfgfile,
793 const struct GNUNET_CONFIGURATION_Handle *cfg)
795 if (NULL == ego_name)
798 _("You must specify which zone should be accessed\n"));
802 if ( (NULL != args[0]) && (NULL == uri) )
803 uri = GNUNET_strdup (args[0]);
804 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
806 el = GNUNET_IDENTITY_ego_lookup (cfg,
814 * The main function for gnunet-namestore.
816 * @param argc number of arguments from the command line
817 * @param argv command line arguments
818 * @return 0 ok, 1 on error
821 main (int argc, char *const *argv)
826 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
828 gettext_noop ("add record"), 0,
829 &GNUNET_GETOPT_set_one, &add},
830 {'d', "delete", NULL,
831 gettext_noop ("delete record"), 0,
832 &GNUNET_GETOPT_set_one, &del},
833 {'D', "display", NULL,
834 gettext_noop ("display records"), 0,
835 &GNUNET_GETOPT_set_one, &list},
836 {'e', "expiration", "TIME",
837 gettext_noop ("expiration time for record to use (for adding only), \"never\" is possible"), 1,
838 &GNUNET_GETOPT_set_string, &expirationstring},
839 {'i', "nick", "NICKNAME",
840 gettext_noop ("set the desired nick name for the zone"), 1,
841 &GNUNET_GETOPT_set_string, &nickstring},
842 {'m', "monitor", NULL,
843 gettext_noop ("monitor changes in the namestore"), 0,
844 &GNUNET_GETOPT_set_one, &monitor},
845 {'n', "name", "NAME",
846 gettext_noop ("name of the record to add/delete/display"), 1,
847 &GNUNET_GETOPT_set_string, &name},
848 {'r', "reverse", "PKEY",
849 gettext_noop ("determine our name for the given PKEY"), 1,
850 &GNUNET_GETOPT_set_string, &reverse_pkey},
851 {'t', "type", "TYPE",
852 gettext_noop ("type of the record to add/delete/display"), 1,
853 &GNUNET_GETOPT_set_string, &typestring},
855 gettext_noop ("URI to import into our zone"), 1,
856 &GNUNET_GETOPT_set_string, &uri},
857 {'V', "value", "VALUE",
858 gettext_noop ("value of the record to add/delete"), 1,
859 &GNUNET_GETOPT_set_string, &value},
860 {'p', "public", NULL,
861 gettext_noop ("create or list public record"), 0,
862 &GNUNET_GETOPT_set_one, &public},
863 {'s', "shadow", NULL,
864 gettext_noop ("create shadow record (only valid if all other records of the same type have expired"), 0,
865 &GNUNET_GETOPT_set_one, &shadow},
867 gettext_noop ("name of the ego controlling the zone"), 1,
868 &GNUNET_GETOPT_set_string, &ego_name},
869 GNUNET_GETOPT_OPTION_END
872 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
875 GNUNET_log_setup ("gnunet-namestore", "WARNING", NULL);
877 GNUNET_PROGRAM_run (argc, argv, "gnunet-namestore",
878 _("GNUnet zone manipulation tool"),
882 GNUNET_free ((void*) argv);
883 GNUNET_CRYPTO_ecdsa_key_clear (&zone_pkey);
886 GNUNET_free ((void*) argv);
887 GNUNET_CRYPTO_ecdsa_key_clear (&zone_pkey);
891 /* end of gnunet-namestore.c */