src/gns/gns_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009-2013, 2016 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file gns/gns_api.c
  22  * @brief library to access the GNS service
  23  * @author Martin Schanzenbach
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_constants.h"
  29 #include "gnunet_arm_service.h"
  30 #include "gnunet_hello_lib.h"
  31 #include "gnunet_protocols.h"
  32 #include "gnunet_dht_service.h"
  33 #include "gns.h"
  34 #include "gnunet_gns_service.h"
  35
  36
  37 #define LOG(kind,...) GNUNET_log_from (kind, "gns-api",__VA_ARGS__)
  38
  39 /**
  40  * Handle to a lookup request
  41  */
  42 struct GNUNET_GNS_LookupRequest
  43 {
  44
  45   /**
  46    * DLL
  47    */
  48   struct GNUNET_GNS_LookupRequest *next;
  49
  50   /**
  51    * DLL
  52    */
  53   struct GNUNET_GNS_LookupRequest *prev;
  54
  55   /**
  56    * handle to gns
  57    */
  58   struct GNUNET_GNS_Handle *gns_handle;
  59
  60   /**
  61    * processor to call on lookup result
  62    */
  63   GNUNET_GNS_LookupResultProcessor lookup_proc;
  64
  65   /**
  66    * @e lookup_proc closure
  67    */
  68   void *proc_cls;
  69
  70   /**
  71    * Envelope with the message for this queue entry.
  72    */
  73   struct GNUNET_MQ_Envelope *env;
  74
  75   /**
  76    * request id
  77    */
  78   uint32_t r_id;
  79
  80 };
  81
  82
  83 /**
  84  * Connection to the GNS service.
  85  */
  86 struct GNUNET_GNS_Handle
  87 {
  88
  89   /**
  90    * Configuration to use.
  91    */
  92   const struct GNUNET_CONFIGURATION_Handle *cfg;
  93
  94   /**
  95    * Connection to service (if available).
  96    */
  97   struct GNUNET_MQ_Handle *mq;
  98
  99   /**
 100    * Head of linked list of active lookup requests.
 101    */
 102   struct GNUNET_GNS_LookupRequest *lookup_head;
 103
 104   /**
 105    * Tail of linked list of active lookup requests.
 106    */
 107   struct GNUNET_GNS_LookupRequest *lookup_tail;
 108
 109   /**
 110    * Reconnect task
 111    */
 112   struct GNUNET_SCHEDULER_Task *reconnect_task;
 113
 114   /**
 115    * How long do we wait until we try to reconnect?
 116    */
 117   struct GNUNET_TIME_Relative reconnect_backoff;
 118
 119   /**
 120    * Request Id generator.  Incremented by one for each request.
 121    */
 122   uint32_t r_id_gen;
 123
 124 };
 125
 126
 127 /**
 128  * Reconnect to GNS service.
 129  *
 130  * @param handle the handle to the GNS service
 131  */
 132 static void
 133 reconnect (struct GNUNET_GNS_Handle *handle);
 134
 135
 136 /**
 137  * Reconnect to GNS
 138  *
 139  * @param cls the handle
 140  */
 141 static void
 142 reconnect_task (void *cls)
 143 {
 144   struct GNUNET_GNS_Handle *handle = cls;
 145
 146   handle->reconnect_task = NULL;
 147   reconnect (handle);
 148 }
 149
 150
 151 /**
 152  * Disconnect from service and then reconnect.
 153  *
 154  * @param handle our handle
 155  */
 156 static void
 157 force_reconnect (struct GNUNET_GNS_Handle *handle)
 158 {
 159   GNUNET_MQ_destroy (handle->mq);
 160   handle->mq = NULL;
 161   handle->reconnect_backoff
 162     = GNUNET_TIME_STD_BACKOFF (handle->reconnect_backoff);
 163   handle->reconnect_task
 164     = GNUNET_SCHEDULER_add_delayed (handle->reconnect_backoff,
 165                                     &reconnect_task,
 166                                     handle);
 167 }
 168
 169
 170 /**
 171  * Generic error handler, called with the appropriate error code and
 172  * the same closure specified at the creation of the message queue.
 173  * Not every message queue implementation supports an error handler.
 174  *
 175  * @param cls closure with the `struct GNUNET_GNS_Handle *`
 176  * @param error error code
 177  */
 178 static void
 179 mq_error_handler (void *cls,
 180                   enum GNUNET_MQ_Error error)
 181 {
 182   struct GNUNET_GNS_Handle *handle = cls;
 183
 184   LOG (GNUNET_ERROR_TYPE_WARNING,
 185        "Problem with message queue. error: %i\n",
 186        error);
 187   force_reconnect (handle);
 188 }
 189
 190
 191 /**
 192  * Check validity of message received from the GNS service
 193  *
 194  * @param cls the `struct GNUNET_GNS_Handle *`
 195  * @param loookup_msg the incoming message
 196  */
 197 static int
 198 check_result (void *cls,
 199               const struct LookupResultMessage *lookup_msg)
 200 {
 201   size_t mlen = ntohs (lookup_msg->header.size) - sizeof (*lookup_msg);
 202   uint32_t rd_count = ntohl (lookup_msg->rd_count);
 203   struct GNUNET_GNSRECORD_Data rd[rd_count];
 204
 205   if (GNUNET_SYSERR ==
 206       GNUNET_GNSRECORD_records_deserialize (mlen,
 207                                             (const char*) &lookup_msg[1],
 208                                             rd_count,
 209                                             rd))
 210   {
 211     GNUNET_break (0);
 212     return GNUNET_SYSERR;
 213   }
 214   return GNUNET_OK;
 215 }
 216
 217
 218 /**
 219  * Handler for messages received from the GNS service
 220  *
 221  * @param cls the `struct GNUNET_GNS_Handle *`
 222  * @param loookup_msg the incoming message
 223  */
 224 static void
 225 handle_result (void *cls,
 226                const struct LookupResultMessage *lookup_msg)
 227 {
 228   struct GNUNET_GNS_Handle *handle = cls;
 229   size_t mlen = ntohs (lookup_msg->header.size) - sizeof (*lookup_msg);
 230   uint32_t rd_count = ntohl (lookup_msg->rd_count);
 231   struct GNUNET_GNSRECORD_Data rd[rd_count];
 232   uint32_t r_id = ntohl (lookup_msg->id);
 233   struct GNUNET_GNS_LookupRequest *lr;
 234   GNUNET_GNS_LookupResultProcessor proc;
 235   void *proc_cls;
 236
 237   LOG (GNUNET_ERROR_TYPE_DEBUG,
 238        "Received lookup reply from GNS service (%u records)\n",
 239        (unsigned int) rd_count);
 240   for (lr = handle->lookup_head; NULL != lr; lr = lr->next)
 241     if (lr->r_id == r_id)
 242       break;
 243   if (NULL == lr)
 244     return;
 245   proc = lr->lookup_proc;
 246   proc_cls = lr->proc_cls;
 247
 248   GNUNET_assert (GNUNET_OK ==
 249                  GNUNET_GNSRECORD_records_deserialize (mlen,
 250                                                        (const char*) &lookup_msg[1],
 251                                                        rd_count,
 252                                                        rd));
 253   proc (proc_cls,
 254         rd_count,
 255         rd);
 256   GNUNET_CONTAINER_DLL_remove (handle->lookup_head,
 257                                handle->lookup_tail,
 258                                lr);
 259   if (NULL != lr->env)
 260     GNUNET_MQ_discard (lr->env);
 261   GNUNET_free (lr);
 262 }
 263
 264
 265 /**
 266  * Reconnect to GNS service.
 267  *
 268  * @param handle the handle to the GNS service
 269  */
 270 static void
 271 reconnect (struct GNUNET_GNS_Handle *handle)
 272 {
 273   struct GNUNET_MQ_MessageHandler handlers[] = {
 274     GNUNET_MQ_hd_var_size (result,
 275                            GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT,
 276                            struct LookupResultMessage,
 277                            handle),
 278     GNUNET_MQ_handler_end ()
 279   };
 280   struct GNUNET_GNS_LookupRequest *lh;
 281
 282   GNUNET_assert (NULL == handle->mq);
 283   LOG (GNUNET_ERROR_TYPE_DEBUG,
 284        "Trying to connect to GNS\n");
 285   handle->mq = GNUNET_CLIENT_connect (handle->cfg,
 286                                       "gns",
 287                                       handlers,
 288                                       &mq_error_handler,
 289                                       handle);
 290   if (NULL == handle->mq)
 291     return;
 292   for (lh = handle->lookup_head; NULL != lh; lh = lh->next)
 293     GNUNET_MQ_send_copy (handle->mq,
 294                          lh->env);
 295 }
 296
 297
 298 /**
 299  * Initialize the connection with the GNS service.
 300  *
 301  * @param cfg configuration to use
 302  * @return handle to the GNS service, or NULL on error
 303  */
 304 struct GNUNET_GNS_Handle *
 305 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 306 {
 307   struct GNUNET_GNS_Handle *handle;
 308
 309   handle = GNUNET_new (struct GNUNET_GNS_Handle);
 310   handle->cfg = cfg;
 311   reconnect (handle);
 312   if (NULL == handle->mq)
 313   {
 314     GNUNET_free (handle);
 315     return NULL;
 316   }
 317   return handle;
 318 }
 319
 320
 321 /**
 322  * Shutdown connection with the GNS service.
 323  *
 324  * @param handle handle of the GNS connection to stop
 325  */
 326 void
 327 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle)
 328 {
 329   if (NULL != handle->mq)
 330   {
 331     GNUNET_MQ_destroy (handle->mq);
 332     handle->mq = NULL;
 333   }
 334   if (NULL != handle->reconnect_task)
 335   {
 336     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
 337     handle->reconnect_task = NULL;
 338   }
 339   GNUNET_assert (NULL == handle->lookup_head);
 340   GNUNET_free (handle);
 341 }
 342
 343
 344 /**
 345  * Cancel pending lookup request
 346  *
 347  * @param lr the lookup request to cancel
 348  */
 349 void
 350 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr)
 351 {
 352   struct GNUNET_GNS_Handle *handle = lr->gns_handle;
 353
 354   GNUNET_CONTAINER_DLL_remove (handle->lookup_head,
 355                                handle->lookup_tail,
 356                                lr);
 357   GNUNET_MQ_discard (lr->env);
 358   GNUNET_free (lr);
 359 }
 360
 361
 362 /**
 363  * Perform an asynchronous lookup operation on the GNS.
 364  *
 365  * @param handle handle to the GNS service
 366  * @param name the name to look up
 367  * @param zone the zone to start the resolution in
 368  * @param type the record type to look up
 369  * @param options local options for the lookup
 370  * @param proc processor to call on result
 371  * @param proc_cls closure for @a proc
 372  * @return handle to the get request
 373  */
 374 struct GNUNET_GNS_LookupRequest*
 375 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
 376                    const char *name,
 377                    const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
 378                    uint32_t type,
 379                    enum GNUNET_GNS_LocalOptions options,
 380                    GNUNET_GNS_LookupResultProcessor proc,
 381                    void *proc_cls)
 382 {
 383   /* IPC to shorten gns names, return shorten_handle */
 384   struct LookupMessage *lookup_msg;
 385   struct GNUNET_GNS_LookupRequest *lr;
 386   size_t nlen;
 387
 388   if (NULL == name)
 389   {
 390     GNUNET_break (0);
 391     return NULL;
 392   }
 393   LOG (GNUNET_ERROR_TYPE_DEBUG,
 394        "Trying to lookup `%s' in GNS\n",
 395        name);
 396   nlen = strlen (name) + 1;
 397   if (nlen >= GNUNET_MAX_MESSAGE_SIZE - sizeof (*lr))
 398   {
 399     GNUNET_break (0);
 400     return NULL;
 401   }
 402   lr = GNUNET_new (struct GNUNET_GNS_LookupRequest);
 403   lr->gns_handle = handle;
 404   lr->lookup_proc = proc;
 405   lr->proc_cls = proc_cls;
 406   lr->r_id = handle->r_id_gen++;
 407   lr->env = GNUNET_MQ_msg_extra (lookup_msg,
 408                                  nlen,
 409                                  GNUNET_MESSAGE_TYPE_GNS_LOOKUP);
 410   lookup_msg->id = htonl (lr->r_id);
 411   lookup_msg->options = htons ((uint16_t) options);
 412   lookup_msg->zone = *zone;
 413   lookup_msg->type = htonl (type);
 414   GNUNET_memcpy (&lookup_msg[1],
 415                  name,
 416                  nlen);
 417   GNUNET_CONTAINER_DLL_insert (handle->lookup_head,
 418                                handle->lookup_tail,
 419                                lr);
 420   if (NULL != handle->mq)
 421     GNUNET_MQ_send_copy (handle->mq,
 422                          lr->env);
 423   return lr;
 424 }
 425
 426 /* end of gns_api.c */