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