src/conversation/plugin_gnsrecord_conversation.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2013 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20
  21 /**
  22  * @file conversation/plugin_gnsrecord_conversation.c
  23  * @brief gnsrecord plugin to provide the API for fundamental GNS records
  24  *                  This includes the VPN record because GNS resolution
  25  *                  is expected to understand VPN records and (if needed)
  26  *                  map the result to A/AAAA.
  27  * @author Christian Grothoff
  28  */
  29
  30 #include "platform.h"
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet_gnsrecord_lib.h"
  33 #include "gnunet_conversation_service.h"
  34 #include "gnunet_gnsrecord_plugin.h"
  35
  36
  37 /**
  38  * Convert the 'value' of a record to a string.
  39  *
  40  * @param cls closure, unused
  41  * @param type type of the record
  42  * @param data value in binary encoding
  43  * @param data_size number of bytes in @a data
  44  * @return NULL on error, otherwise human-readable representation of the value
  45  */
  46 static char *
  47 conversation_value_to_string (void *cls,
  48                               uint32_t type,
  49                               const void *data,
  50                               size_t data_size)
  51 {
  52   char *s;
  53
  54   (void) cls;
  55   switch (type)
  56   {
  57   case GNUNET_GNSRECORD_TYPE_PHONE:
  58     {
  59       const struct GNUNET_CONVERSATION_PhoneRecord *pr;
  60       char *ret;
  61       char *pkey;
  62
  63       if (data_size != sizeof (struct GNUNET_CONVERSATION_PhoneRecord))
  64       {
  65         GNUNET_break_op (0);
  66         return NULL;
  67       }
  68       pr = data;
  69       if (1 != ntohl (pr->version))
  70       {
  71         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
  72                     _("PHONE version %u not supported\n"),
  73                     ntohl (pr->version));
  74         return NULL;
  75       }
  76       pkey = GNUNET_CRYPTO_eddsa_public_key_to_string (&pr->peer.public_key);
  77       s = GNUNET_STRINGS_data_to_string_alloc (&pr->line_port,
  78                                                sizeof (struct GNUNET_HashCode));
  79
  80       GNUNET_asprintf (&ret,
  81                        "%s-%s",
  82                        s,
  83                        pkey);
  84       GNUNET_free (s);
  85       GNUNET_free (pkey);
  86       return ret;
  87     }
  88   default:
  89     return NULL;
  90   }
  91 }
  92
  93
  94 /**
  95  * Convert human-readable version of a 'value' of a record to the binary
  96  * representation.
  97  *
  98  * @param cls closure, unused
  99  * @param type type of the record
 100  * @param s human-readable string
 101  * @param data set to value in binary encoding (will be allocated)
 102  * @param data_size set to number of bytes in @a data
 103  * @return #GNUNET_OK on success
 104  */
 105 static int
 106 conversation_string_to_value (void *cls,
 107                               uint32_t type,
 108                               const char *s,
 109                               void **data,
 110                               size_t *data_size)
 111 {
 112   (void) cls;
 113   if (NULL == s)
 114   {
 115     GNUNET_break (0);
 116     return GNUNET_SYSERR;
 117   }
 118   switch (type)
 119   {
 120   case GNUNET_GNSRECORD_TYPE_PHONE:
 121     {
 122       struct GNUNET_CONVERSATION_PhoneRecord *pr;
 123       char line_port[103];
 124       const char *dash;
 125       struct GNUNET_PeerIdentity peer;
 126
 127       if ( (NULL == (dash = strchr (s, '-'))) ||
 128            (1 != sscanf (s, "%103s-", line_port)) ||
 129            (GNUNET_OK !=
 130             GNUNET_CRYPTO_eddsa_public_key_from_string (dash + 1,
 131                                                         strlen (dash + 1),
 132                                                         &peer.public_key)) )
 133       {
 134         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 135                     _("Unable to parse PHONE record `%s'\n"),
 136                     s);
 137         return GNUNET_SYSERR;
 138       }
 139       pr = GNUNET_new (struct GNUNET_CONVERSATION_PhoneRecord);
 140       pr->version = htonl (1);
 141       pr->reserved = htonl (0);
 142       if (GNUNET_OK !=
 143           GNUNET_STRINGS_string_to_data (line_port,
 144                                          strlen (line_port),
 145                                          &pr->line_port,
 146                                          sizeof (struct GNUNET_HashCode)))
 147       {
 148         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 149                     _("Unable to parse PHONE record `%s'\n"),
 150                     s);
 151         GNUNET_free (pr);
 152         return GNUNET_SYSERR;
 153       }
 154       pr->peer = peer;
 155       *data = pr;
 156       *data_size = sizeof (struct GNUNET_CONVERSATION_PhoneRecord);
 157       return GNUNET_OK;
 158     }
 159   default:
 160     return GNUNET_SYSERR;
 161   }
 162 }
 163
 164
 165 /**
 166  * Mapping of record type numbers to human-readable
 167  * record type names.
 168  */
 169 static struct {
 170   const char *name;
 171   uint32_t number;
 172 } name_map[] = {
 173   { "PHONE",  GNUNET_GNSRECORD_TYPE_PHONE },
 174   { NULL, UINT32_MAX }
 175 };
 176
 177
 178 /**
 179  * Convert a type name (i.e. "AAAA") to the corresponding number.
 180  *
 181  * @param cls closure, unused
 182  * @param gns_typename name to convert
 183  * @return corresponding number, UINT32_MAX on error
 184  */
 185 static uint32_t
 186 conversation_typename_to_number (void *cls,
 187                                  const char *gns_typename)
 188 {
 189   unsigned int i;
 190
 191   (void) cls;
 192   i=0;
 193   while ( (name_map[i].name != NULL) &&
 194           (0 != strcasecmp (gns_typename, name_map[i].name)) )
 195     i++;
 196   return name_map[i].number;
 197 }
 198
 199
 200 /**
 201  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 202  *
 203  * @param cls closure, unused
 204  * @param type number of a type to convert
 205  * @return corresponding typestring, NULL on error
 206  */
 207 static const char *
 208 conversation_number_to_typename (void *cls,
 209                                  uint32_t type)
 210 {
 211   unsigned int i;
 212
 213   (void) cls;
 214   i=0;
 215   while ( (name_map[i].name != NULL) &&
 216           (type != name_map[i].number) )
 217     i++;
 218   return name_map[i].name;
 219 }
 220
 221
 222 /**
 223  * Entry point for the plugin.
 224  *
 225  * @param cls NULL
 226  * @return the exported block API
 227  */
 228 void *
 229 libgnunet_plugin_gnsrecord_conversation_init (void *cls)
 230 {
 231   struct GNUNET_GNSRECORD_PluginFunctions *api;
 232
 233   (void) cls;
 234   api = GNUNET_new (struct GNUNET_GNSRECORD_PluginFunctions);
 235   api->value_to_string = &conversation_value_to_string;
 236   api->string_to_value = &conversation_string_to_value;
 237   api->typename_to_number = &conversation_typename_to_number;
 238   api->number_to_typename = &conversation_number_to_typename;
 239   return api;
 240 }
 241
 242
 243 /**
 244  * Exit point from the plugin.
 245  *
 246  * @param cls the return value from #libgnunet_plugin_block_test_init
 247  * @return NULL
 248  */
 249 void *
 250 libgnunet_plugin_gnsrecord_conversation_done (void *cls)
 251 {
 252   struct GNUNET_GNSRECORD_PluginFunctions *api = cls;
 253
 254   GNUNET_free (api);
 255   return NULL;
 256 }
 257
 258 /* end of plugin_gnsrecord_conversation.c */