src/transport/transport_api_address_to_string.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 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 #include "platform.h"
  21 #include "gnunet_util_lib.h"
  22 #include "gnunet_arm_service.h"
  23 #include "gnunet_hello_lib.h"
  24 #include "gnunet_protocols.h"
  25 #include "gnunet_transport_service.h"
  26 #include "transport.h"
  27
  28 /**
  29  * Context for the address lookup.
  30  */
  31 struct GNUNET_TRANSPORT_AddressToStringContext
  32 {
  33   /**
  34    * Function to call with the human-readable address.
  35    */
  36   GNUNET_TRANSPORT_AddressToStringCallback cb;
  37
  38   /**
  39    * Closure for cb.
  40    */
  41   void *cb_cls;
  42
  43   /**
  44    * Connection to the service.
  45    */
  46   struct GNUNET_CLIENT_Connection *client;
  47
  48   /**
  49    * When should this operation time out?
  50    */
  51   struct GNUNET_TIME_Absolute timeout;
  52 };
  53
  54
  55 /**
  56  * Function called with responses from the service.
  57  *
  58  * @param cls our 'struct GNUNET_TRANSPORT_AddressToStringContext*'
  59  * @param msg NULL on timeout or error, otherwise presumably a
  60  *        message with the human-readable address
  61  */
  62 static void
  63 address_response_processor (void *cls, const struct GNUNET_MessageHeader *msg)
  64 {
  65   struct GNUNET_TRANSPORT_AddressToStringContext *alucb = cls;
  66   struct AddressToStringResultMessage *atsm;
  67   const char *address;
  68   uint16_t size;
  69   uint32_t result;
  70   uint32_t addr_len;
  71   char *empty_str = "";
  72
  73   if (msg == NULL)
  74   {
  75     alucb->cb (alucb->cb_cls, NULL, GNUNET_OK);
  76     GNUNET_CLIENT_disconnect (alucb->client);
  77     GNUNET_free (alucb);
  78     return;
  79   }
  80   GNUNET_break (ntohs (msg->type) ==
  81                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
  82
  83   size = ntohs (msg->size);
  84   if (size < sizeof (struct AddressToStringResultMessage))
  85   {
  86     alucb->cb (alucb->cb_cls, NULL, GNUNET_OK);
  87     GNUNET_CLIENT_disconnect (alucb->client);
  88     GNUNET_free (alucb);
  89     return;
  90   }
  91   atsm = (struct AddressToStringResultMessage *) msg;
  92
  93   result = ntohl (atsm->res);
  94   addr_len = ntohl (atsm->addr_len);
  95
  96   if (size == (sizeof (struct AddressToStringResultMessage)))
  97   {
  98     /* done, success depends on result */
  99     alucb->cb (alucb->cb_cls, NULL, result);
 100     GNUNET_CLIENT_disconnect (alucb->client);
 101     GNUNET_free (alucb);
 102     return;
 103   }
 104
 105   if (GNUNET_NO == result)
 106   {
 107     alucb->cb (alucb->cb_cls, NULL, GNUNET_SYSERR);
 108
 109     /* expect more replies */
 110     GNUNET_CLIENT_receive (alucb->client, &address_response_processor, alucb,
 111                            GNUNET_TIME_absolute_get_remaining (alucb->timeout));
 112     return;
 113   }
 114
 115
 116   address = (const char *) &atsm[1];
 117   if ( (addr_len > (size - (sizeof (struct AddressToStringResultMessage)))) ||
 118        (address[addr_len -1] != '\0') )
 119   {
 120     /* invalid reply */
 121     GNUNET_break (0);
 122     alucb->cb (alucb->cb_cls, NULL, GNUNET_SYSERR);
 123     GNUNET_CLIENT_disconnect (alucb->client);
 124     GNUNET_free (alucb);
 125     return;
 126   }
 127
 128   /* expect more replies */
 129   GNUNET_CLIENT_receive (alucb->client, &address_response_processor, alucb,
 130                          GNUNET_TIME_absolute_get_remaining (alucb->timeout));
 131
 132   if (GNUNET_NO == result)
 133   {
 134     alucb->cb (alucb->cb_cls, empty_str, GNUNET_SYSERR);
 135   }
 136   else
 137   {
 138     alucb->cb (alucb->cb_cls, address, GNUNET_OK);
 139   }
 140 }
 141
 142
 143 /**
 144  * Convert a binary address into a human readable address.
 145  *
 146  * @param cfg configuration to use
 147  * @param address address to convert (binary format)
 148  * @param numeric should (IP) addresses be displayed in numeric form
 149  *                (otherwise do reverse DNS lookup)
 150  * @param timeout how long is the lookup allowed to take at most
 151  * @param aluc function to call with the results
 152  * @param aluc_cls closure for aluc
 153  * @return handle to cancel the operation, NULL on error
 154  */
 155 struct GNUNET_TRANSPORT_AddressToStringContext *
 156 GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
 157                                     *cfg,
 158                                     const struct GNUNET_HELLO_Address *address,
 159                                     int numeric,
 160                                     struct GNUNET_TIME_Relative timeout,
 161                                     GNUNET_TRANSPORT_AddressToStringCallback
 162                                     aluc, void *aluc_cls)
 163 {
 164   size_t len;
 165   size_t alen;
 166   size_t slen;
 167   struct AddressLookupMessage *msg;
 168   struct GNUNET_TRANSPORT_AddressToStringContext *alc;
 169   struct GNUNET_CLIENT_Connection *client;
 170   char *addrbuf;
 171
 172   GNUNET_assert (address != NULL);
 173   alen = address->address_length;
 174   slen = strlen (address->transport_name) + 1;
 175   len = sizeof (struct AddressLookupMessage) + alen + slen;
 176   if (len >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 177   {
 178     GNUNET_break (0);
 179     return NULL;
 180   }
 181   client = GNUNET_CLIENT_connect ("transport", cfg);
 182   if (NULL == client)
 183     return NULL;
 184   msg = GNUNET_malloc (len);
 185   msg->header.size = htons (len);
 186   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING);
 187   msg->numeric_only = htons ((int16_t) numeric);
 188   msg->addrlen = htons ((uint16_t) alen);
 189   msg->timeout = GNUNET_TIME_relative_hton (timeout);
 190   addrbuf = (char *) &msg[1];
 191   memcpy (addrbuf, address->address, alen);
 192   memcpy (&addrbuf[alen], address->transport_name, slen);
 193
 194   alc = GNUNET_new (struct GNUNET_TRANSPORT_AddressToStringContext);
 195   alc->cb = aluc;
 196   alc->cb_cls = aluc_cls;
 197   alc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 198   alc->client = client;
 199   GNUNET_assert (GNUNET_OK ==
 200                  GNUNET_CLIENT_transmit_and_get_response (client, &msg->header,
 201                                                           timeout, GNUNET_YES,
 202                                                           &address_response_processor,
 203                                                           alc));
 204   GNUNET_free (msg);
 205   return alc;
 206 }
 207
 208
 209 /**
 210  * Cancel request for address conversion.
 211  *
 212  * @param pic the context handle
 213  */
 214 void
 215 GNUNET_TRANSPORT_address_to_string_cancel (struct
 216                                            GNUNET_TRANSPORT_AddressToStringContext
 217                                            *pic)
 218 {
 219   GNUNET_CLIENT_disconnect (pic->client);
 220   GNUNET_free (pic);
 221 }
 222
 223
 224
 225 /* end of transport_api_address_to_string.c */