Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / gns / gnunet-gns.c
index 738c6878801da30c13d2e45e23210dd2bf25a2d8..a261e008b7f0f98661695bc81bacd702018f21e8 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2012 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2012-2013, 2017 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @file gnunet-gns.c
- * @brief command line tool to manipulate the local zone
+ * @brief command line tool to access distributed GNS
  * @author Christian Grothoff
- *
- * TODO:
- * - everything
  */
 #include "platform.h"
 #include <gnunet_util_lib.h>
 #include <gnunet_dnsparser_lib.h>
+#include <gnunet_identity_service.h>
+#include <gnunet_gnsrecord_lib.h>
 #include <gnunet_namestore_service.h>
+#include <gnunet_gns_service.h>
+
+/**
+ * Configuration we are using.
+ */
+static const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+/**
+ * Handle to GNS service.
+ */
+static struct GNUNET_GNS_Handle *gns;
+
+/**
+ * Desired timeout for the lookup (default is no timeout).
+ */
+static struct GNUNET_TIME_Relative timeout;
+
+/**
+ * GNS name to lookup. (-u option)
+ */
+static char *lookup_name;
 
 /**
- * Handle to the namestore.
+ * record type to look up (-t option)
  */
-static struct GNUNET_NAMESTORE_Handle *ns;
+static char *lookup_type;
 
 /**
- * Hash of the public key of our zone.
+ * Identity of the zone to use for the lookup (-z option)
  */
-static GNUNET_HashCode zone;
+static char *zone_ego_name;
 
 /**
- * Private key for the our zone.
+ * Public key of the zone to use for the lookup (-p option)
  */
-static struct GNUNET_CRYPTO_RsaPrivateKey *zone_pkey;
+static char *public_key;
 
 /**
- * Keyfile to manipulate.
+ * Set to GNUNET_GNS_LO_LOCAL_MASTER if we are looking up in the master zone.
  */
-static char *keyfile;  
+static enum GNUNET_GNS_LocalOptions local_options;
 
 /**
- * Desired action is to add a record.
+ * raw output
  */
-static int add;
+static int raw;
 
 /**
- * Desired action is to list records.
+ * Requested record type.
  */
-static int list;
+static int rtype;
 
 /**
- * Desired action is to remove a record.
+ * Handle to lookup request
  */
-static int del;
+static struct GNUNET_GNS_LookupRequest *lookup_request;
 
 /**
- * Name of the records to add/list/remove.
+ * Lookup an ego with the identity service.
  */
-static char *name;
+static struct GNUNET_IDENTITY_EgoLookup *el;
 
 /**
- * Value of the record to add/remove.
+ * Handle for identity service.
  */
-static char *value;
+static struct GNUNET_IDENTITY_Handle *identity;
 
 /**
- * Type of the record to add/remove, NULL to remove all.
+ * Active operation on identity service.
  */
-static char *typestring;
+static struct GNUNET_IDENTITY_Operation *id_op;
 
 /**
- * Desired expiration time.
+ * Task scheduled to handle timeout.
  */
-static char *expirationstring;
-               
+static struct GNUNET_SCHEDULER_Task *tt;
+
 
 /**
  * Task run on shutdown.  Cleans up everything.
  *
  * @param cls unused
- * @param tc scheduler context
  */
 static void
-do_shutdown (void *cls,
-            const struct GNUNET_SCHEDULER_TaskContext *tc)
+do_shutdown (void *cls)
 {
-  if (NULL != ns)
+  if (NULL != el)
+  {
+    GNUNET_IDENTITY_ego_lookup_cancel (el);
+    el = NULL;
+  }
+  if (NULL != id_op)
   {
-    GNUNET_NAMESTORE_disconnect (ns, GNUNET_NO);
-    ns = NULL;
+    GNUNET_IDENTITY_cancel (id_op);
+    id_op = NULL;
   }
-  if (NULL != zone_pkey)
+  if (NULL != lookup_request)
   {
-    GNUNET_CRYPTO_rsa_key_free (zone_pkey);
-    zone_pkey = NULL;
+    GNUNET_GNS_lookup_cancel (lookup_request);
+    lookup_request = NULL;
+  }
+  if (NULL != identity)
+  {
+    GNUNET_IDENTITY_disconnect (identity);
+    identity = NULL;
+  }
+  if (NULL != gns)
+  {
+    GNUNET_GNS_disconnect (gns);
+    gns = NULL;
+  }
+  if (NULL != tt)
+  {
+    GNUNET_SCHEDULER_cancel (tt);
+    tt = NULL;
   }
 }
 
 
 /**
- * Main function that will be run.
+ * Task run on timeout. Triggers shutdown.
  *
- * @param cls closure
- * @param args remaining command-line arguments
- * @param cfgfile name of the configuration file used (for saving, can be NULL!)
- * @param cfg configuration
+ * @param cls unused
  */
 static void
-run (void *cls, char *const *args, const char *cfgfile,
-     const struct GNUNET_CONFIGURATION_Handle *cfg)
+do_timeout (void *cls)
 {
-  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pub;
-  uint32_t type;
-  const void *data;
-  size_t data_size;
-  struct in_addr value_a;
-  struct in6_addr value_aaaa;
-
-  if (NULL == keyfile)
+  tt = NULL;
+  GNUNET_SCHEDULER_shutdown ();
+}
+
+
+/**
+ * Function called with the result of a GNS lookup.
+ *
+ * @param cls the 'const char *' name that was resolved
+ * @param rd_count number of records returned
+ * @param rd array of @a rd_count records with the results
+ */
+static void
+process_lookup_result (void *cls,
+                       uint32_t rd_count,
+                      const struct GNUNET_GNSRECORD_Data *rd)
+{
+  const char *name = cls;
+  uint32_t i;
+  const char *typename;
+  char* string_val;
+
+  lookup_request = NULL;
+  if (!raw)
+  {
+    if (0 == rd_count)
+      printf ("No results.\n");
+    else
+      printf ("%s:\n",
+             name);
+  }
+  for (i=0; i<rd_count; i++)
+  {
+    if ( (rd[i].record_type != rtype) &&
+        (GNUNET_GNSRECORD_TYPE_ANY != rtype) )
+      continue;
+    typename = GNUNET_GNSRECORD_number_to_typename (rd[i].record_type);
+    string_val = GNUNET_GNSRECORD_value_to_string (rd[i].record_type,
+                                                  rd[i].data,
+                                                  rd[i].data_size);
+    if (NULL == string_val)
+    {
+      fprintf (stderr,
+              "Record %u of type %d malformed, skipping\n",
+              (unsigned int) i,
+              (int) rd[i].record_type);
+      continue;
+    }
+    if (raw)
+      printf ("%s\n",
+             string_val);
+    else
+      printf ("Got `%s' record: %s\n",
+             typename,
+             string_val);
+    GNUNET_free (string_val);
+  }
+  GNUNET_SCHEDULER_shutdown ();
+}
+
+
+/**
+ * Perform the actual resolution, starting with the zone
+ * identified by the given public key and the shorten zone.
+ *
+ * @param pkey public key to use for the zone, can be NULL
+ */
+static void
+lookup_with_public_key (const struct GNUNET_CRYPTO_EcdsaPublicKey *pkey)
+{
+  if (NULL != lookup_type)
+    rtype = GNUNET_GNSRECORD_typename_to_number (lookup_type);
+  else
+    rtype = GNUNET_DNSPARSER_TYPE_A;
+  if (UINT32_MAX == rtype)
   {
     fprintf (stderr,
-            _("Option `%s' not given, but I need a zone key file!\n"),
-            "z");
-    return;
+             _("Invalid typename specified, assuming `ANY'\n"));
+    rtype = GNUNET_GNSRECORD_TYPE_ANY;
   }
-  zone_pkey = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
-  GNUNET_free (keyfile);
-  keyfile = NULL;
-  if (NULL == zone_pkey)
+
+  if (NULL != lookup_name)
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-               _("Failed to read or create private zone key\n"));
-    return;
+    lookup_request = GNUNET_GNS_lookup (gns,
+                                       lookup_name,
+                                       pkey,
+                                       rtype,
+                                       local_options,
+                                       &process_lookup_result,
+                                       lookup_name);
   }
-  GNUNET_CRYPTO_rsa_key_get_public (zone_pkey,
-                                   &pub);
-  GNUNET_CRYPTO_hash (&pub, sizeof (pub), &zone);
-  ns = GNUNET_NAMESTORE_connect (cfg);
-  if (NULL == ns)
+  else
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-               _("Failed to connect to namestore\n"));
+    fprintf (stderr,
+            _("Please specify name to lookup!\n"));
+    GNUNET_SCHEDULER_shutdown ();
     return;
   }
-  GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
-  if (NULL == typestring)
-    type = 0;
+}
+
+
+/**
+ * Method called to with the ego we are to use for the lookup,
+ * when the ego is determined by a name.
+ *
+ * @param cls closure (NULL, unused)
+ * @param ego ego handle, NULL if not found
+ */
+static void
+identity_zone_cb (void *cls,
+                 const struct GNUNET_IDENTITY_Ego *ego)
+{
+  struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
+
+  el = NULL;
+  if (NULL == ego)
+  {
+    fprintf (stderr,
+            _("Ego for `%s' not found, cannot perform lookup.\n"),
+            zone_ego_name);
+    GNUNET_SCHEDULER_shutdown ();
+  }
   else
-    type = GNUNET_NAMESTORE_typename_to_number (typestring);
-  if (UINT32_MAX == type)
   {
-    fprintf (stderr, _("Unsupported type `%s'\n"), typestring);
+    GNUNET_IDENTITY_ego_get_public_key (ego, &pkey);
+    lookup_with_public_key (&pkey);
+  }
+  GNUNET_free_non_null (zone_ego_name);
+  zone_ego_name = NULL;
+}
+
+
+/**
+ * Method called to with the ego we are to use for the lookup,
+ * when the ego is the one for the default master zone.
+ *
+ * @param cls closure (NULL, unused)
+ * @param ego ego handle, NULL if not found
+ * @param ctx context for application to store data for this ego
+ *                 (during the lifetime of this process, initially NULL)
+ * @param name name assigned by the user for this ego,
+ *                   NULL if the user just deleted the ego and it
+ *                   must thus no longer be used
+ */
+static void
+identity_master_cb (void *cls,
+                   struct GNUNET_IDENTITY_Ego *ego,
+                   void **ctx,
+                   const char *name)
+{
+  struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
+  const char *dot;
+
+  id_op = NULL;
+  if (NULL == ego)
+  {
+    fprintf (stderr,
+            _("Ego for `gns-master' not found, cannot perform lookup.  Did you run gnunet-gns-import.sh?\n"));
     GNUNET_SCHEDULER_shutdown ();
     return;
   }
-  if (NULL != value)
+  GNUNET_IDENTITY_ego_get_public_key (ego, &pkey);
+  /* main name is our own master zone, do no look for that in the DHT */
+  local_options = GNUNET_GNS_LO_LOCAL_MASTER;
+
+  /* if the name is of the form 'label.gnu', never go to the DHT */
+  dot = NULL;
+  if (NULL != lookup_name)
+    dot = strchr (lookup_name, '.');
+  if ( (NULL != dot) &&
+       (0 == strcasecmp (dot, ".gnu")) )
+    local_options = GNUNET_GNS_LO_NO_DHT;
+  lookup_with_public_key (&pkey);
+}
+
+
+/**
+ * Main function that will be run.
+ *
+ * @param cls closure
+ * @param args remaining command-line arguments
+ * @param cfgfile name of the configuration file used (for saving, can be NULL!)
+ * @param c configuration
+ */
+static void
+run (void *cls,
+     char *const *args,
+     const char *cfgfile,
+     const struct GNUNET_CONFIGURATION_Handle *c)
+{
+  struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
+
+  cfg = c;
+  gns = GNUNET_GNS_connect (cfg);
+  if (NULL == gns)
+  {
+    fprintf (stderr,
+            _("Failed to connect to GNS\n"));
+    return;
+  }
+  tt = GNUNET_SCHEDULER_add_delayed (timeout,
+                                     &do_timeout,
+                                     NULL);
+  GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
+                                 NULL);
+  identity = GNUNET_IDENTITY_connect (cfg,
+                                      NULL,
+                                      NULL);
+  if (NULL != public_key)
   {
-    switch (type)
+    if (GNUNET_OK !=
+        GNUNET_CRYPTO_ecdsa_public_key_from_string (public_key,
+                                                    strlen (public_key),
+                                                    &pkey))
     {
-    case 0:
-      fprintf (stderr, _("Need a record type to interpret value `%s'\n"), value);
-      GNUNET_SCHEDULER_shutdown ();
-      break;
-    case GNUNET_DNSPARSER_TYPE_A:
-      if (1 != inet_pton (AF_INET, value, &value_a))
-      {
-       fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"), 
-                value,
-                typestring);
-       GNUNET_SCHEDULER_shutdown ();
-       return;
-      }
-      data = &value_a;
-      data_size = sizeof (value_a);
-      break;
-    case GNUNET_DNSPARSER_TYPE_NS:
-      data = value;
-      data_size = strlen (value);
-      break;
-    case GNUNET_DNSPARSER_TYPE_CNAME:
-      data = value;
-      data_size = strlen (value);
-      break;
-    case GNUNET_DNSPARSER_TYPE_SOA:
-      fprintf (stderr, _("Record type `%s' not implemented yet\n"), typestring);
-      GNUNET_SCHEDULER_shutdown ();
-      return;
-    case GNUNET_DNSPARSER_TYPE_PTR:
-      fprintf (stderr, _("Record type `%s' not implemented yet\n"), typestring);
-      GNUNET_SCHEDULER_shutdown ();
-      return;
-    case GNUNET_DNSPARSER_TYPE_MX:
-      fprintf (stderr, _("Record type `%s' not implemented yet\n"), typestring);
-      GNUNET_SCHEDULER_shutdown ();
-      return;
-    case GNUNET_DNSPARSER_TYPE_TXT:
-      data = value;
-      data_size = strlen (value);
-      break;
-    case GNUNET_DNSPARSER_TYPE_AAAA:
-      if (1 != inet_pton (AF_INET6, value, &value_aaaa))
-      {
-       fprintf (stderr, _("Value `%s' invalid for record type `%s'\n"), 
-                value,
-                typestring);
-       GNUNET_SCHEDULER_shutdown ();
-       return;
-      }
-      data = &value_aaaa;
-      data_size = sizeof (value_aaaa);
-      break;
-    case GNUNET_GNS_TYPE_PKEY:
-      fprintf (stderr, _("Record type `%s' not implemented yet\n"), typestring);
+      fprintf (stderr,
+               _("Public key `%s' is not well-formed\n"),
+               public_key);
       GNUNET_SCHEDULER_shutdown ();
       return;
-    case GNUNET_GNS_TYPE_PSEU:
-      data = value;
-      data_size = strlen (value);
-      break;
-    default:
-      GNUNET_assert (0);
     }
+    lookup_with_public_key (&pkey);
+    return;
+  }
+  if (NULL != zone_ego_name)
+  {
+    el = GNUNET_IDENTITY_ego_lookup (cfg,
+                                     zone_ego_name,
+                                     &identity_zone_cb,
+                                     NULL);
+    return;
+  }
+  if ( (NULL != lookup_name) &&
+       (strlen (lookup_name) > 4) &&
+       (0 == strcmp (".zkey",
+                     &lookup_name[strlen (lookup_name) - 4])) )
+  {
+    /* no zone required, use 'anonymous' zone */
+    GNUNET_CRYPTO_ecdsa_key_get_public (GNUNET_CRYPTO_ecdsa_key_get_anonymous (),
+                                        &pkey);
+    lookup_with_public_key (&pkey);
+  }
+  else
+  {
+    GNUNET_break (NULL == id_op);
+    id_op = GNUNET_IDENTITY_get (identity,
+                                 "gns-master",
+                                 &identity_master_cb,
+                                 NULL);
+    GNUNET_assert (NULL != id_op);
   }
-
-
 }
 
 
@@ -246,46 +417,48 @@ run (void *cls, char *const *args, const char *cfgfile,
  * @return 0 ok, 1 on error
  */
 int
-main (int argc, char *const *argv)
+main (int argc,
+      char *const *argv)
 {
   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
-    {'a', "add", NULL,
-     gettext_noop ("add record"), 0,
-     &GNUNET_GETOPT_set_one, &add},   
-    {'d', "delete", NULL,
-     gettext_noop ("delete record"), 0,
-     &GNUNET_GETOPT_set_one, &del},   
-    {'D', "display", NULL,
-     gettext_noop ("display records"), 0,
-     &GNUNET_GETOPT_set_one, &list},   
-    {'e', "expiration", "TIME",
-     gettext_noop ("expiration time to use (for adding only)"), 1,
-     &GNUNET_GETOPT_set_string, &expirationstring},   
-    {'n', "name", "NAME",
-     gettext_noop ("name of the record to add/delete/display"), 1,
-     &GNUNET_GETOPT_set_string, &name},   
+    {'u', "lookup", "NAME",
+      gettext_noop ("Lookup a record for the given name"), 1,
+      &GNUNET_GETOPT_set_string, &lookup_name},
     {'t', "type", "TYPE",
-     gettext_noop ("type of the record to add/delete/display"), 1,
-     &GNUNET_GETOPT_set_string, &typestring},   
-    {'V', "value", "VALUE",
-     gettext_noop ("value of the record to add/delete"), 1,
-     &GNUNET_GETOPT_set_string, &value},   
-    {'z', "zonekey", "FILENAME",
-     gettext_noop ("filename with the zone key"), 1,
-     &GNUNET_GETOPT_set_string, &keyfile},   
+      gettext_noop ("Specify the type of the record to lookup"), 1,
+      &GNUNET_GETOPT_set_string, &lookup_type},
+    { 'T', "timeout", "DELAY",
+      gettext_noop ("Specify timeout for the lookup"), 1,
+      &GNUNET_GETOPT_set_relative_time, &timeout },
+    {'r', "raw", NULL,
+      gettext_noop ("No unneeded output"), 0,
+      &GNUNET_GETOPT_set_one, &raw},
+    {'p', "public-key", "PKEY",
+      gettext_noop ("Specify the public key of the zone to lookup the record in"), 1,
+      &GNUNET_GETOPT_set_string, &public_key},
+    {'z', "zone", "NAME",
+      gettext_noop ("Specify the name of the ego of the zone to lookup the record in"), 1,
+      &GNUNET_GETOPT_set_string, &zone_ego_name},
     GNUNET_GETOPT_OPTION_END
   };
-
   int ret;
 
-  GNUNET_log_setup ("gnunet-gns", "WARNING", NULL);
-  ret =
-      (GNUNET_OK ==
-       GNUNET_PROGRAM_run (argc, argv, "gnunet-gns",
-                           _("GNUnet GNS zone manipulation tool"), 
-                          options,
-                           &run, NULL)) ? 0 : 1;
+  timeout = GNUNET_TIME_UNIT_FOREVER_REL;
+  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv,
+                                                 &argc, &argv))
+    return 2;
 
+  GNUNET_log_setup ("gnunet-gns",
+                    "WARNING",
+                    NULL);
+  ret =
+    (GNUNET_OK ==
+     GNUNET_PROGRAM_run (argc, argv,
+                         "gnunet-gns",
+                         _("GNUnet GNS resolver tool"),
+                         options,
+                         &run, NULL)) ? 0 : 1;
+  GNUNET_free ((void*) argv);
   return ret;
 }