src/namestore/namestore_common.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 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 /**
  22  * @file namestore/namestore_common.c
  23  * @brief API to access the NAMESTORE service
  24  * @author Martin Schanzenbach
  25  * @author Matthias Wachs
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_constants.h"
  31 #include "gnunet_signatures.h"
  32 #include "gnunet_arm_service.h"
  33 #include "gnunet_namestore_service.h"
  34 #include "gnunet_dnsparser_lib.h"
  35 #include "namestore.h"
  36 #define DEBUG_GNS_API GNUNET_EXTRA_LOGGING
  37
  38 #define LOG(kind,...) GNUNET_log_from (kind, "gns-api",__VA_ARGS__)
  39
  40
  41 /**
  42  * Internal format of a record in the serialized form.
  43  */
  44 struct NetworkRecord
  45 {
  46
  47   /**
  48    * Expiration time for the DNS record.
  49    */
  50   struct GNUNET_TIME_AbsoluteNBO expiration;
  51
  52   /**
  53    * Number of bytes in 'data', network byte order.
  54    */
  55   uint32_t data_size;
  56
  57   /**
  58    * Type of the GNS/DNS record, network byte order.
  59    */
  60   uint32_t record_type;
  61
  62   /**
  63    * Flags for the record, network byte order.
  64    */
  65   uint32_t flags;
  66
  67 };
  68
  69
  70 /**
  71  * Convert a short hash to a string (for printing debug messages).
  72  * This is one of the very few calls in the entire API that is
  73  * NOT reentrant!
  74  *
  75  * @param hc the short hash code
  76  * @return string form; will be overwritten by next call to GNUNET_h2s.
  77  */
  78 const char *
  79 GNUNET_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc)
  80 {
  81   static struct GNUNET_CRYPTO_ShortHashAsciiEncoded ret;
  82
  83   GNUNET_CRYPTO_short_hash_to_enc (hc, &ret);
  84   return (const char *) &ret;
  85 }
  86
  87
  88 /**
  89  * Calculate how many bytes we will need to serialize the given
  90  * records.
  91  *
  92  * @param rd_count number of records in the rd array
  93  * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
  94  *
  95  * @return the required size to serialize
  96  *
  97  */
  98 size_t
  99 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
 100                                    const struct GNUNET_NAMESTORE_RecordData *rd)
 101 {
 102   unsigned int i;
 103   size_t ret;
 104
 105   ret = sizeof (struct NetworkRecord) * rd_count;
 106   for (i=0;i<rd_count;i++)
 107   {
 108     GNUNET_assert ((ret + rd[i].data_size) >= ret);
 109     ret += rd[i].data_size;
 110   }
 111   return ret;
 112 }
 113
 114
 115 /**
 116  * Serialize the given records to the given destination buffer.
 117  *
 118  * @param rd_count number of records in the rd array
 119  * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
 120  * @param dest_size size of the destination array
 121  * @param dest where to write the result
 122  *
 123  * @return the size of serialized records
 124  */
 125 ssize_t
 126 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
 127                                     const struct GNUNET_NAMESTORE_RecordData *rd,
 128                                     size_t dest_size,
 129                                     char *dest)
 130 {
 131   struct NetworkRecord rec;
 132   unsigned int i;
 133   size_t off;
 134
 135   off = 0;
 136   for (i=0;i<rd_count;i++)
 137   {
 138     rec.expiration = GNUNET_TIME_absolute_hton (rd[i].expiration);
 139     rec.data_size = htonl ((uint32_t) rd[i].data_size);
 140     rec.record_type = htonl (rd[i].record_type);
 141     rec.flags = htonl (rd[i].flags);
 142     if (off + sizeof (rec) > dest_size)
 143       return -1;
 144     memcpy (&dest[off], &rec, sizeof (rec));
 145     off += sizeof (rec);
 146     if (off + rd[i].data_size > dest_size)
 147       return -1;
 148     memcpy (&dest[off], rd[i].data, rd[i].data_size);
 149     off += rd[i].data_size;
 150   }
 151   return off;
 152 }
 153
 154 /**
 155  * Compares if two records are equal
 156  *
 157  * @param a record
 158  * @param b record
 159  *
 160  * @return GNUNET_YES or GNUNET_NO
 161  */
 162 int
 163 GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
 164                               const struct GNUNET_NAMESTORE_RecordData *b)
 165 {
 166   if ((a->record_type == b->record_type) &&
 167       (a->expiration.abs_value == b->expiration.abs_value) &&
 168       (a->data_size == b->data_size) &&
 169       (0 == memcmp (a->data, b->data, a->data_size)))
 170     return GNUNET_YES;
 171   else
 172     return GNUNET_NO;
 173 }
 174
 175
 176 /**
 177  * Deserialize the given records to the given destination.
 178  *
 179  * @param len size of the serialized record data
 180  * @param src the serialized record data
 181  * @param rd_count number of records in the rd array
 182  * @param dest where to put the data
 183  *
 184  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 185  */
 186 int
 187 GNUNET_NAMESTORE_records_deserialize (size_t len,
 188                                       const char *src,
 189                                       unsigned int rd_count,
 190                                       struct GNUNET_NAMESTORE_RecordData *dest)
 191 {
 192   struct NetworkRecord rec;
 193   unsigned int i;
 194   size_t off;
 195
 196   off = 0;
 197   for (i=0;i<rd_count;i++)
 198   {
 199     if (off + sizeof (rec) > len)
 200       return GNUNET_SYSERR;
 201     memcpy (&rec, &src[off], sizeof (rec));
 202     dest[i].expiration = GNUNET_TIME_absolute_ntoh (rec.expiration);
 203     dest[i].data_size = ntohl ((uint32_t) rec.data_size);
 204     dest[i].record_type = ntohl (rec.record_type);
 205     dest[i].flags = ntohl (rec.flags);
 206     off += sizeof (rec);
 207
 208     if (off + dest[i].data_size > len)
 209       return GNUNET_SYSERR;
 210     dest[i].data = &src[off];
 211     off += dest[i].data_size;
 212   }
 213   return GNUNET_OK;
 214 }
 215
 216 /**
 217  * Sign name and records
 218  *
 219  * @param key the private key
 220  * @param expire block expiration
 221  * @param name the name
 222  * @param rd record data
 223  * @param rd_count number of records
 224  *
 225  * @return the signature
 226  */
 227 struct GNUNET_CRYPTO_RsaSignature *
 228 GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key,
 229     struct GNUNET_TIME_Absolute expire,
 230     const char *name,
 231     const struct GNUNET_NAMESTORE_RecordData *rd,
 232     unsigned int rd_count)
 233 {
 234   struct GNUNET_CRYPTO_RsaSignature *sig = GNUNET_malloc(sizeof (struct GNUNET_CRYPTO_RsaSignature));
 235   struct GNUNET_CRYPTO_RsaSignaturePurpose *sig_purpose;
 236   struct GNUNET_TIME_AbsoluteNBO expire_nbo = GNUNET_TIME_absolute_hton(expire);
 237   size_t rd_ser_len;
 238   size_t name_len;
 239
 240   struct GNUNET_TIME_AbsoluteNBO *expire_tmp;
 241   char * name_tmp;
 242   char * rd_tmp;
 243   int res;
 244
 245   if (name == NULL)
 246   {
 247     GNUNET_break (0);
 248     GNUNET_free (sig);
 249     return NULL;
 250   }
 251   name_len = strlen (name) + 1;
 252
 253   rd_ser_len = GNUNET_NAMESTORE_records_get_size(rd_count, rd);
 254   char rd_ser[rd_ser_len];
 255   GNUNET_NAMESTORE_records_serialize(rd_count, rd, rd_ser_len, rd_ser);
 256
 257   sig_purpose = GNUNET_malloc(sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) + sizeof (struct GNUNET_TIME_AbsoluteNBO) + rd_ser_len + name_len);
 258   sig_purpose->size = htonl (sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose)+ rd_ser_len + name_len);
 259   sig_purpose->purpose = htonl (GNUNET_SIGNATURE_PURPOSE_GNS_RECORD_SIGN);
 260   expire_tmp = (struct GNUNET_TIME_AbsoluteNBO *) &sig_purpose[1];
 261   name_tmp = (char *) &expire_tmp[1];
 262   rd_tmp = &name_tmp[name_len];
 263   memcpy (expire_tmp, &expire_nbo, sizeof (struct GNUNET_TIME_AbsoluteNBO));
 264   memcpy (name_tmp, name, name_len);
 265   memcpy (rd_tmp, rd_ser, rd_ser_len);
 266
 267   res = GNUNET_CRYPTO_rsa_sign (key, sig_purpose, sig);
 268
 269   GNUNET_free (sig_purpose);
 270
 271   if (GNUNET_OK != res)
 272   {
 273     GNUNET_break (0);
 274     GNUNET_free (sig);
 275     return NULL;
 276   }
 277   return sig;
 278 }
 279
 280 /**
 281  * Checks if a name is wellformed
 282  *
 283  * @param name the name to check
 284  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 285  */
 286 int
 287 GNUNET_NAMESTORE_check_name (const char * name)
 288 {
 289   if (name == NULL)
 290     return GNUNET_SYSERR;
 291   if (strlen (name) > 63)
 292     return GNUNET_SYSERR;
 293   return GNUNET_OK;
 294 }
 295
 296
 297 /**
 298  * Convert the 'value' of a record to a string.
 299  *
 300  * @param type type of the record
 301  * @param data value in binary encoding
 302  * @param data_size number of bytes in data
 303  * @return NULL on error, otherwise human-readable representation of the value
 304  */
 305 char *
 306 GNUNET_NAMESTORE_value_to_string (uint32_t type,
 307                                   const void *data,
 308                                   size_t data_size)
 309 {
 310   char tmp[INET6_ADDRSTRLEN];
 311   struct GNUNET_CRYPTO_ShortHashAsciiEncoded enc;
 312
 313   switch (type)
 314   {
 315   case 0:
 316     return NULL;
 317   case GNUNET_DNSPARSER_TYPE_A:
 318     if (data_size != sizeof (struct in_addr))
 319       return NULL;
 320     if (NULL == inet_ntop (AF_INET, data, tmp, sizeof (tmp)))
 321       return NULL;
 322     return GNUNET_strdup (tmp);
 323   case GNUNET_DNSPARSER_TYPE_NS:
 324     return GNUNET_strndup (data, data_size);
 325   case GNUNET_DNSPARSER_TYPE_CNAME:
 326     return GNUNET_strndup (data, data_size);
 327   case GNUNET_DNSPARSER_TYPE_SOA:
 328     GNUNET_break (0);
 329     // FIXME
 330     return NULL;
 331   case GNUNET_DNSPARSER_TYPE_PTR:
 332     GNUNET_break (0);
 333     // FIXME
 334     return NULL;
 335   case GNUNET_DNSPARSER_TYPE_MX:
 336     GNUNET_break (0);
 337     // FIXME
 338     return NULL;
 339   case GNUNET_DNSPARSER_TYPE_TXT:
 340     return GNUNET_strndup (data, data_size);
 341   case GNUNET_DNSPARSER_TYPE_AAAA:
 342     if (data_size != sizeof (struct in6_addr))
 343       return NULL;
 344     if (NULL == inet_ntop (AF_INET6, data, tmp, sizeof (tmp)))
 345       return NULL;
 346     return GNUNET_strdup (tmp);
 347   case GNUNET_NAMESTORE_TYPE_PKEY:
 348     if (data_size != sizeof (struct GNUNET_CRYPTO_ShortHashCode))
 349       return NULL;
 350     GNUNET_CRYPTO_short_hash_to_enc (data,
 351                                      &enc);
 352     return GNUNET_strdup ((const char*) enc.short_encoding);
 353   case GNUNET_NAMESTORE_TYPE_PSEU:
 354     return GNUNET_strndup (data, data_size);
 355   default:
 356     GNUNET_break (0);
 357   }
 358   GNUNET_break (0); // not implemented
 359   return NULL;
 360 }
 361
 362
 363 /**
 364  * Convert human-readable version of a 'value' of a record to the binary
 365  * representation.
 366  *
 367  * @param type type of the record
 368  * @param s human-readable string
 369  * @param data set to value in binary encoding (will be allocated)
 370  * @param data_size set to number of bytes in data
 371  * @return GNUNET_OK on success
 372  */
 373 int
 374 GNUNET_NAMESTORE_string_to_value (uint32_t type,
 375                                   const char *s,
 376                                   void **data,
 377                                   size_t *data_size)
 378 {
 379   struct in_addr value_a;
 380   struct in6_addr value_aaaa;
 381   GNUNET_HashCode pkey;
 382
 383   switch (type)
 384   {
 385   case 0:
 386     return GNUNET_SYSERR;
 387   case GNUNET_DNSPARSER_TYPE_A:
 388     if (1 != inet_pton (AF_INET, s, &value_a))
 389       return GNUNET_SYSERR;
 390     *data = GNUNET_malloc (sizeof (struct in_addr));
 391     memcpy (*data, &value_a, sizeof (value_a));
 392     *data_size = sizeof (value_a);
 393     return GNUNET_OK;
 394   case GNUNET_DNSPARSER_TYPE_NS:
 395     *data = GNUNET_strdup (s);
 396     *data_size = strlen (s);
 397     return GNUNET_OK;
 398   case GNUNET_DNSPARSER_TYPE_CNAME:
 399     *data = GNUNET_strdup (s);
 400     *data_size = strlen (s);
 401     return GNUNET_OK;
 402   case GNUNET_DNSPARSER_TYPE_SOA:
 403     GNUNET_break (0);
 404     // FIXME
 405     return GNUNET_SYSERR;
 406   case GNUNET_DNSPARSER_TYPE_PTR:
 407     GNUNET_break (0);
 408     // FIXME
 409     return GNUNET_SYSERR;
 410   case GNUNET_DNSPARSER_TYPE_MX:
 411     GNUNET_break (0);
 412     // FIXME
 413     return GNUNET_SYSERR;
 414   case GNUNET_DNSPARSER_TYPE_TXT:
 415     *data = GNUNET_strdup (s);
 416     *data_size = strlen (s);
 417     return GNUNET_OK;
 418   case GNUNET_DNSPARSER_TYPE_AAAA:
 419     if (1 != inet_pton (AF_INET6, s, &value_aaaa))
 420       return GNUNET_SYSERR;
 421     *data = GNUNET_malloc (sizeof (struct in6_addr));
 422     memcpy (*data, &value_aaaa, sizeof (value_aaaa));
 423     return GNUNET_OK;
 424   case GNUNET_NAMESTORE_TYPE_PKEY:
 425     if (GNUNET_OK !=
 426         GNUNET_CRYPTO_hash_from_string (s, &pkey))
 427       return GNUNET_SYSERR;
 428     *data = GNUNET_malloc (sizeof (GNUNET_HashCode));
 429     memcpy (*data, &pkey, sizeof (pkey));
 430     *data_size = sizeof (GNUNET_HashCode);
 431     return GNUNET_OK;
 432   case GNUNET_NAMESTORE_TYPE_PSEU:
 433     *data = GNUNET_strdup (s);
 434     *data_size = strlen (s);
 435     return GNUNET_OK;
 436   default:
 437     GNUNET_break (0);
 438   }
 439   return GNUNET_SYSERR;
 440 }
 441
 442
 443 static struct {
 444   const char *name;
 445   uint32_t number;
 446 } name_map[] = {
 447   { "A", GNUNET_DNSPARSER_TYPE_A },
 448   { "NS", GNUNET_DNSPARSER_TYPE_NS },
 449   { "CNAME", GNUNET_DNSPARSER_TYPE_CNAME },
 450   { "SOA", GNUNET_DNSPARSER_TYPE_SOA },
 451   { "PTR", GNUNET_DNSPARSER_TYPE_PTR },
 452   { "MX", GNUNET_DNSPARSER_TYPE_MX },
 453   { "TXT", GNUNET_DNSPARSER_TYPE_TXT },
 454   { "AAAA", GNUNET_DNSPARSER_TYPE_AAAA },
 455   { "PKEY",  GNUNET_NAMESTORE_TYPE_PKEY },
 456   { "PSEU",  GNUNET_NAMESTORE_TYPE_PSEU },
 457   { NULL, UINT32_MAX }
 458 };
 459
 460
 461 /**
 462  * Convert a type name (i.e. "AAAA") to the corresponding number.
 463  *
 464  * @param typename name to convert
 465  * @return corresponding number, UINT32_MAX on error
 466  */
 467 uint32_t
 468 GNUNET_NAMESTORE_typename_to_number (const char *typename)
 469 {
 470   unsigned int i;
 471
 472   i=0;
 473   while ( (name_map[i].name != NULL) &&
 474           (0 != strcasecmp (typename, name_map[i].name)) )
 475     i++;
 476   return name_map[i].number;
 477 }
 478
 479
 480 /**
 481  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 482  *
 483  * @param type number of a type to convert
 484  * @return corresponding typestring, NULL on error
 485  */
 486 const char *
 487 GNUNET_NAMESTORE_number_to_typename (uint32_t type)
 488 {
 489   unsigned int i;
 490
 491   i=0;
 492   while ( (name_map[i].name != NULL) &&
 493           (type != name_map[i].number) )
 494     i++;
 495   return name_map[i].name;
 496 }
 497
 498
 499
 500 /* end of namestore_common.c */