src/namestore/gnunet-namestore.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20 /**
  21  * @file gnunet-namestore.c
  22  * @brief command line tool to manipulate the local zone
  23  * @author Christian Grothoff
  24  *
  25  * TODO:
  26  * - allow users to set record options (not just 'RF_AUTHORITY')
  27  * - test
  28  * - add options to list/lookup individual records
  29  */
  30 #include "platform.h"
  31 #include <gnunet_util_lib.h>
  32 #include <gnunet_dnsparser_lib.h>
  33 #include <gnunet_namestore_service.h>
  34
  35
  36 /**
  37  * Handle to the namestore.
  38  */
  39 static struct GNUNET_NAMESTORE_Handle *ns;
  40
  41 /**
  42  * Hash of the public key of our zone.
  43  */
  44 static struct GNUNET_CRYPTO_ShortHashCode zone;
  45
  46 /**
  47  * Private key for the our zone.
  48  */
  49 static struct GNUNET_CRYPTO_RsaPrivateKey *zone_pkey;
  50
  51 /**
  52  * Keyfile to manipulate.
  53  */
  54 static char *keyfile;
  55
  56 /**
  57  * Desired action is to add a record.
  58  */
  59 static int add;
  60
  61 /**
  62  * Queue entry for the 'add' operation.
  63  */
  64 static struct GNUNET_NAMESTORE_QueueEntry *add_qe;
  65
  66 /**
  67  * Desired action is to list records.
  68  */
  69 static int list;
  70
  71 /**
  72  * List iterator for the 'list' operation.
  73  */
  74 static struct GNUNET_NAMESTORE_ZoneIterator *list_it;
  75
  76 /**
  77  * Desired action is to remove a record.
  78  */
  79 static int del;
  80
  81 /**
  82  * Is record public
  83  */
  84 static int public;
  85
  86 /**
  87  * Is record authority
  88  */
  89 static int nonauthority;
  90
  91 /**
  92  * Queue entry for the 'del' operation.
  93  */
  94 static struct GNUNET_NAMESTORE_QueueEntry *del_qe;
  95
  96 /**
  97  * Name of the records to add/list/remove.
  98  */
  99 static char *name;
 100
 101 /**
 102  * Value of the record to add/remove.
 103  */
 104 static char *value;
 105
 106 /**
 107  * Type of the record to add/remove, NULL to remove all.
 108  */
 109 static char *typestring;
 110
 111 /**
 112  * Desired expiration time.
 113  */
 114 static char *expirationstring;
 115
 116
 117 /**
 118  * Task run on shutdown.  Cleans up everything.
 119  *
 120  * @param cls unused
 121  * @param tc scheduler context
 122  */
 123 static void
 124 do_shutdown (void *cls,
 125              const struct GNUNET_SCHEDULER_TaskContext *tc)
 126 {
 127   if (NULL != ns)
 128   {
 129     GNUNET_NAMESTORE_disconnect (ns, GNUNET_NO);
 130     ns = NULL;
 131   }
 132   if (NULL != zone_pkey)
 133   {
 134     GNUNET_CRYPTO_rsa_key_free (zone_pkey);
 135     zone_pkey = NULL;
 136   }
 137 }
 138
 139
 140 /**
 141  * Continuation called to notify client about result of the
 142  * operation.
 143  *
 144  * @param cls closure, unused
 145  * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
 146  *                GNUNET_NO if content was already there
 147  *                GNUNET_YES (or other positive value) on success
 148  * @param emsg NULL on success, otherwise an error message
 149  */
 150 static void
 151 add_continuation (void *cls,
 152                   int32_t success,
 153                   const char *emsg)
 154 {
 155   add_qe = NULL;
 156   if (success != GNUNET_YES)
 157     fprintf (stderr,
 158              _("Adding record failed: %s\n"),
 159              (success == GNUNET_NO) ? "record exists" : emsg);
 160   if ( (NULL == del_qe) &&
 161        (NULL == list_it) )
 162     GNUNET_SCHEDULER_shutdown ();
 163 }
 164
 165
 166 /**
 167  * Continuation called to notify client about result of the
 168  * operation.
 169  *
 170  * @param cls closure, unused
 171  * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
 172  *                GNUNET_NO if content was already there
 173  *                GNUNET_YES (or other positive value) on success
 174  * @param emsg NULL on success, otherwise an error message
 175  */
 176 static void
 177 del_continuation (void *cls,
 178                   int32_t success,
 179                   const char *emsg)
 180 {
 181   del_qe = NULL;
 182   if (success != GNUNET_YES)
 183     fprintf (stderr,
 184              _("Deleting record failed: %s\n"),
 185              emsg);
 186   if ( (NULL == add_qe) &&
 187        (NULL == list_it) )
 188     GNUNET_SCHEDULER_shutdown ();
 189 }
 190
 191
 192 /**
 193  * Process a record that was stored in the namestore.
 194  *
 195  * @param cls closure
 196  * @param zone_key public key of the zone
 197  * @param expire when does the corresponding block in the DHT expire (until
 198  *               when should we never do a DHT lookup for the same name again)?;
 199  *               GNUNET_TIME_UNIT_ZERO_ABS if there are no records of any type in the namestore,
 200  *               or the expiration time of the block in the namestore (even if there are zero
 201  *               records matching the desired record type)
 202  * @param name name that is being mapped (at most 255 characters long)
 203  * @param rd_len number of entries in 'rd' array
 204  * @param rd array of records with data to store
 205  * @param signature signature of the record block, NULL if signature is unavailable (i.e.
 206  *        because the user queried for a particular record type only)
 207  */
 208 static void
 209 display_record (void *cls,
 210                 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
 211                 struct GNUNET_TIME_Absolute expire,
 212                 const char *name,
 213                 unsigned int rd_len,
 214                 const struct GNUNET_NAMESTORE_RecordData *rd,
 215                 const struct GNUNET_CRYPTO_RsaSignature *signature)
 216 {
 217   const char *typestring;
 218   char *s;
 219   unsigned int i;
 220
 221   if (NULL == name)
 222   {
 223     list_it = NULL;
 224     if ( (NULL == del_qe) &&
 225          (NULL == add_qe) )
 226       GNUNET_SCHEDULER_shutdown ();
 227     return;
 228   }
 229   FPRINTF (stdout,
 230            "%s:\n",
 231            name);
 232   for (i=0;i<rd_len;i++)
 233   {
 234     typestring = GNUNET_NAMESTORE_number_to_typename (rd[i].record_type);
 235     s = GNUNET_NAMESTORE_value_to_string (rd[i].record_type,
 236                                           rd[i].data,
 237                                           rd[i].data_size);
 238     if (NULL == s)
 239     {
 240       FPRINTF (stdout, _("\tCorrupt or unsupported record of type %u\n"),
 241                (unsigned int) rd[i].record_type);
 242       continue;
 243     }
 244     FPRINTF (stdout, "\t%s: %s\n", typestring, s);
 245     GNUNET_free (s);
 246   }
 247   FPRINTF (stdout, "%s", "\n");
 248   GNUNET_NAMESTORE_zone_iterator_next (list_it);
 249 }
 250
 251
 252 /**
 253  * Main function that will be run.
 254  *
 255  * @param cls closure
 256  * @param args remaining command-line arguments
 257  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 258  * @param cfg configuration
 259  */
 260 static void
 261 run (void *cls, char *const *args, const char *cfgfile,
 262      const struct GNUNET_CONFIGURATION_Handle *cfg)
 263 {
 264   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pub;
 265   uint32_t type;
 266   void *data = NULL;
 267   size_t data_size = 0;
 268   struct GNUNET_TIME_Relative etime_rel;
 269   struct GNUNET_TIME_Absolute etime_abs;
 270   int etime_is_rel = GNUNET_SYSERR;
 271   struct GNUNET_NAMESTORE_RecordData rd;
 272
 273   if (NULL == keyfile)
 274   {
 275       if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (cfg, "gns",
 276                                                  "ZONEKEY", &keyfile))
 277       {
 278         fprintf (stderr,
 279                  _("Option `%s' not given, but I need a zone key file!\n"),
 280                  "z");
 281         return;
 282       }
 283       fprintf (stderr,
 284                _("Using default zone file `%s'\n"),
 285                keyfile);
 286   }
 287   zone_pkey = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 288   GNUNET_free (keyfile);
 289   keyfile = NULL;
 290   if (! (add|del|list))
 291   {
 292     /* nothing more to be done */
 293     fprintf (stderr,
 294              _("No options given\n"));
 295     GNUNET_CRYPTO_rsa_key_free (zone_pkey);
 296     zone_pkey = NULL;
 297     return;
 298   }
 299   if (NULL == zone_pkey)
 300   {
 301     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 302                 _("Failed to read or create private zone key\n"));
 303     return;
 304   }
 305   GNUNET_CRYPTO_rsa_key_get_public (zone_pkey,
 306                                     &pub);
 307   GNUNET_CRYPTO_short_hash (&pub, sizeof (pub), &zone);
 308
 309   ns = GNUNET_NAMESTORE_connect (cfg);
 310   if (NULL == ns)
 311   {
 312     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 313                 _("Failed to connect to namestore\n"));
 314     return;
 315   }
 316   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 317                                 &do_shutdown, NULL);
 318   if (NULL == typestring)
 319     type = 0;
 320   else
 321     type = GNUNET_NAMESTORE_typename_to_number (typestring);
 322   if (UINT32_MAX == type)
 323   {
 324     fprintf (stderr, _("Unsupported type `%s'\n"), typestring);
 325     GNUNET_SCHEDULER_shutdown ();
 326     return;
 327   }
 328   if ((NULL == typestring) && (add | del))
 329   {
 330     fprintf (stderr,
 331              _("Missing option `%s' for operation `%s'\n"),
 332              "-t", _("add/del"));
 333     GNUNET_SCHEDULER_shutdown ();
 334     return;
 335   }
 336   if (NULL != value)
 337   {
 338     if (GNUNET_OK !=
 339         GNUNET_NAMESTORE_string_to_value (type,
 340                                           value,
 341                                           &data,
 342                                           &data_size))
 343       {
 344         fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"),
 345                  value,
 346                  typestring);
 347         GNUNET_SCHEDULER_shutdown ();
 348         return;
 349       }
 350   } else if (add | del)
 351   {
 352     fprintf (stderr,
 353              _("Missing option `%s' for operation `%s'\n"),
 354              "-V", _("add/del"));
 355     GNUNET_SCHEDULER_shutdown ();
 356     return;
 357   }
 358   if (NULL != expirationstring)
 359   {
 360     if (0 == strcmp (expirationstring, "never"))
 361     {
 362       etime_abs = GNUNET_TIME_UNIT_FOREVER_ABS;
 363       etime_is_rel = GNUNET_NO;
 364     }
 365     else if (GNUNET_OK ==
 366              GNUNET_STRINGS_fancy_time_to_relative (expirationstring,
 367                                                     &etime_rel))
 368     {
 369       etime_is_rel = GNUNET_YES;
 370     }
 371     else if (GNUNET_OK ==
 372              GNUNET_STRINGS_fancy_time_to_absolute (expirationstring,
 373                                                     &etime_abs))
 374     {
 375       etime_is_rel = GNUNET_NO;
 376     }
 377     else
 378     {
 379       fprintf (stderr,
 380                _("Invalid time format `%s'\n"),
 381                expirationstring);
 382       GNUNET_SCHEDULER_shutdown ();
 383       return;
 384     }
 385   }
 386   else if (add)
 387   {
 388     fprintf (stderr,
 389              _("Missing option `%s' for operation `%s'\n"),
 390              "-e", _("add"));
 391     GNUNET_SCHEDULER_shutdown ();
 392     return;
 393   }
 394   if (add)
 395   {
 396     if (NULL == name)
 397     {
 398       fprintf (stderr,
 399                _("Missing option `%s' for operation `%s'\n"),
 400                "-n", _("add"));
 401       GNUNET_SCHEDULER_shutdown ();
 402       return;
 403     }
 404     rd.data = data;
 405     rd.data_size = data_size;
 406     rd.record_type = type;
 407     if (GNUNET_YES == etime_is_rel)
 408     {
 409       rd.expiration_time = etime_rel.rel_value;
 410       rd.flags |= GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION;
 411     }
 412     else if (GNUNET_NO == etime_is_rel)
 413       rd.expiration_time = etime_abs.abs_value;
 414     else
 415     {
 416       fprintf (stderr,
 417                _("No valid expiration time for operation `%s'\n"),
 418                _("add"));
 419       GNUNET_SCHEDULER_shutdown ();
 420       return;
 421     }
 422     if (1 != nonauthority)
 423       rd.flags |= GNUNET_NAMESTORE_RF_AUTHORITY;
 424     if (1 != public)
 425       rd.flags |= GNUNET_NAMESTORE_RF_PRIVATE;
 426     add_qe = GNUNET_NAMESTORE_record_create (ns,
 427                                              zone_pkey,
 428                                              name,
 429                                              &rd,
 430                                              &add_continuation,
 431                                              NULL);
 432   }
 433   if (del)
 434   {
 435     if (NULL == name)
 436     {
 437       fprintf (stderr,
 438                _("Missing option `%s' for operation `%s'\n"),
 439                "-n", _("del"));
 440       GNUNET_SCHEDULER_shutdown ();
 441       return;
 442     }
 443     rd.data = data;
 444     rd.data_size = data_size;
 445     rd.record_type = type;
 446     rd.expiration_time = 0;
 447     rd.flags = GNUNET_NAMESTORE_RF_AUTHORITY;
 448     del_qe = GNUNET_NAMESTORE_record_remove (ns,
 449                                              zone_pkey,
 450                                              name,
 451                                              &rd,
 452                                              &del_continuation,
 453                                              NULL);
 454   }
 455   if (list)
 456   {
 457     uint32_t must_not_flags = 0;
 458
 459     if (1 == nonauthority) /* List non-authority records */
 460       must_not_flags |= GNUNET_NAMESTORE_RF_AUTHORITY;
 461
 462     if (1 == public)
 463       must_not_flags |= GNUNET_NAMESTORE_RF_PRIVATE;
 464
 465     list_it = GNUNET_NAMESTORE_zone_iteration_start (ns,
 466                                                      &zone,
 467                                                      0,
 468                                                      must_not_flags,
 469                                                      &display_record,
 470                                                      NULL);
 471   }
 472   GNUNET_free_non_null (data);
 473 }
 474
 475
 476 /**
 477  * The main function for gnunet-namestore.
 478  *
 479  * @param argc number of arguments from the command line
 480  * @param argv command line arguments
 481  * @return 0 ok, 1 on error
 482  */
 483 int
 484 main (int argc, char *const *argv)
 485 {
 486   nonauthority = -1;
 487   public = -1;
 488
 489   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 490     {'a', "add", NULL,
 491      gettext_noop ("add record"), 0,
 492      &GNUNET_GETOPT_set_one, &add},
 493     {'d', "delete", NULL,
 494      gettext_noop ("delete record"), 0,
 495      &GNUNET_GETOPT_set_one, &del},
 496     {'D', "display", NULL,
 497      gettext_noop ("display records"), 0,
 498      &GNUNET_GETOPT_set_one, &list},
 499     {'e', "expiration", "TIME",
 500      gettext_noop ("expiration time for record to use (for adding only), \"never\" is possible"), 1,
 501      &GNUNET_GETOPT_set_string, &expirationstring},
 502     {'n', "name", "NAME",
 503      gettext_noop ("name of the record to add/delete/display"), 1,
 504      &GNUNET_GETOPT_set_string, &name},
 505     {'t', "type", "TYPE",
 506      gettext_noop ("type of the record to add/delete/display"), 1,
 507      &GNUNET_GETOPT_set_string, &typestring},
 508     {'V', "value", "VALUE",
 509      gettext_noop ("value of the record to add/delete"), 1,
 510      &GNUNET_GETOPT_set_string, &value},
 511     {'p', "public", NULL,
 512      gettext_noop ("create or list public record"), 0,
 513      &GNUNET_GETOPT_set_one, &public},
 514     {'N', "non-authority", NULL,
 515      gettext_noop ("create or list non-authority record"), 0,
 516      &GNUNET_GETOPT_set_one, &nonauthority},
 517     {'z', "zonekey", "FILENAME",
 518      gettext_noop ("filename with the zone key"), 1,
 519      &GNUNET_GETOPT_set_string, &keyfile},
 520     GNUNET_GETOPT_OPTION_END
 521   };
 522
 523   int ret;
 524
 525   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 526     return 2;
 527
 528   GNUNET_log_setup ("gnunet-namestore", "WARNING", NULL);
 529   ret =
 530       (GNUNET_OK ==
 531        GNUNET_PROGRAM_run (argc, argv, "gnunet-namestore",
 532                            _("GNUnet zone manipulation tool"),
 533                            options,
 534                            &run, NULL)) ? 0 : 1;
 535
 536   return ret;
 537 }
 538
 539 /* end of gnunet-namestore.c */