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
  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   uint16_t mx_pref;
 313   char* result;
 314   char* soa_rname;
 315   char* soa_mname;
 316   uint32_t* soa_data;
 317   uint32_t soa_serial;
 318   uint32_t soa_refresh;
 319   uint32_t soa_retry;
 320   uint32_t soa_expire;
 321   uint32_t soa_min;
 322
 323   switch (type)
 324   {
 325   case 0:
 326     return NULL;
 327   case GNUNET_DNSPARSER_TYPE_A:
 328     if (data_size != sizeof (struct in_addr))
 329       return NULL;
 330     if (NULL == inet_ntop (AF_INET, data, tmp, sizeof (tmp)))
 331       return NULL;
 332     return GNUNET_strdup (tmp);
 333   case GNUNET_DNSPARSER_TYPE_NS:
 334     return GNUNET_strndup (data, data_size);
 335   case GNUNET_DNSPARSER_TYPE_CNAME:
 336     return GNUNET_strndup (data, data_size);
 337   case GNUNET_DNSPARSER_TYPE_SOA:
 338     soa_rname = (char*)data;
 339     soa_mname = (char*)data+strlen(soa_rname)+1;
 340     soa_data = (uint32_t*)(soa_mname+strlen(soa_mname)+1);
 341     soa_serial = ntohl(soa_data[0]);
 342     soa_refresh = ntohl(soa_data[1]);
 343     soa_retry = ntohl(soa_data[2]);
 344     soa_expire = ntohl(soa_data[3]);
 345     soa_min = ntohl(soa_data[4]);
 346     if (GNUNET_asprintf(&result, "rname=%s mname=%s %lu,%lu,%lu,%lu,%lu",
 347                      soa_rname, soa_mname,
 348                      soa_serial, soa_refresh, soa_retry, soa_expire, soa_min))
 349       return result;
 350     else
 351       return NULL;
 352   case GNUNET_DNSPARSER_TYPE_PTR:
 353     return GNUNET_strndup (data, data_size);
 354   case GNUNET_DNSPARSER_TYPE_MX:
 355     mx_pref = ntohs(*((uint16_t*)data));
 356     if (GNUNET_asprintf(&result, "%hu,%s", mx_pref, data+sizeof(uint16_t))
 357         != 0)
 358       return result;
 359     else
 360       return NULL;
 361   case GNUNET_DNSPARSER_TYPE_TXT:
 362     return GNUNET_strndup (data, data_size);
 363   case GNUNET_DNSPARSER_TYPE_AAAA:
 364     if (data_size != sizeof (struct in6_addr))
 365       return NULL;
 366     if (NULL == inet_ntop (AF_INET6, data, tmp, sizeof (tmp)))
 367       return NULL;
 368     return GNUNET_strdup (tmp);
 369   case GNUNET_NAMESTORE_TYPE_PKEY:
 370     if (data_size != sizeof (struct GNUNET_CRYPTO_ShortHashCode))
 371       return NULL;
 372     GNUNET_CRYPTO_short_hash_to_enc (data,
 373                                      &enc);
 374     return GNUNET_strdup ((const char*) enc.short_encoding);
 375   case GNUNET_NAMESTORE_TYPE_PSEU:
 376     return GNUNET_strndup (data, data_size);
 377   case GNUNET_NAMESTORE_TYPE_LEHO:
 378     return GNUNET_strndup (data, data_size);
 379   default:
 380     GNUNET_break (0);
 381   }
 382   GNUNET_break (0); // not implemented
 383   return NULL;
 384 }
 385
 386
 387 /**
 388  * Convert human-readable version of a 'value' of a record to the binary
 389  * representation.
 390  *
 391  * @param type type of the record
 392  * @param s human-readable string
 393  * @param data set to value in binary encoding (will be allocated)
 394  * @param data_size set to number of bytes in data
 395  * @return GNUNET_OK on success
 396  */
 397 int
 398 GNUNET_NAMESTORE_string_to_value (uint32_t type,
 399                                   const char *s,
 400                                   void **data,
 401                                   size_t *data_size)
 402 {
 403   struct in_addr value_a;
 404   struct in6_addr value_aaaa;
 405   struct GNUNET_CRYPTO_ShortHashCode pkey;
 406   uint16_t mx_pref;
 407   uint16_t mx_pref_n;
 408   uint32_t soa_data[5];
 409   char result[253];
 410   char soa_rname[63];
 411   char soa_mname[63];
 412   uint32_t soa_serial;
 413   uint32_t soa_refresh;
 414   uint32_t soa_retry;
 415   uint32_t soa_expire;
 416   uint32_t soa_min;
 417
 418   switch (type)
 419   {
 420   case 0:
 421     return GNUNET_SYSERR;
 422   case GNUNET_DNSPARSER_TYPE_A:
 423     if (1 != inet_pton (AF_INET, s, &value_a))
 424       return GNUNET_SYSERR;
 425     *data = GNUNET_malloc (sizeof (struct in_addr));
 426     memcpy (*data, &value_a, sizeof (value_a));
 427     *data_size = sizeof (value_a);
 428     return GNUNET_OK;
 429   case GNUNET_DNSPARSER_TYPE_NS:
 430     *data = GNUNET_strdup (s);
 431     *data_size = strlen (s);
 432     return GNUNET_OK;
 433   case GNUNET_DNSPARSER_TYPE_CNAME:
 434     *data = GNUNET_strdup (s);
 435     *data_size = strlen (s);
 436     return GNUNET_OK;
 437   case GNUNET_DNSPARSER_TYPE_SOA:
 438
 439     if (SSCANF(s, "rname=%s mname=%s %u,%u,%u,%u,%u",
 440                soa_rname, soa_mname,
 441                &soa_serial, &soa_refresh, &soa_retry, &soa_expire, &soa_min)
 442         != 7)
 443       return GNUNET_SYSERR;
 444
 445     *data_size = sizeof (soa_data)+strlen(soa_rname)+strlen(soa_mname)+2;
 446     *data = GNUNET_malloc (*data_size);
 447     soa_data[0] = htonl(soa_serial);
 448     soa_data[1] = htonl(soa_refresh);
 449     soa_data[2] = htonl(soa_retry);
 450     soa_data[3] = htonl(soa_expire);
 451     soa_data[4] = htonl(soa_min);
 452     strcpy(*data, soa_rname);
 453     strcpy(*data+strlen(*data)+1, soa_mname);
 454     memcpy(*data+strlen(*data)+1+strlen(soa_mname)+1,
 455            soa_data, sizeof(soa_data));
 456     return GNUNET_OK;
 457
 458   case GNUNET_DNSPARSER_TYPE_PTR:
 459     *data = GNUNET_strdup (s);
 460     *data_size = strlen (s);
 461     return GNUNET_OK;
 462   case GNUNET_DNSPARSER_TYPE_MX:
 463     if (SSCANF(s, "%hu,%s", &mx_pref, result) != 2)
 464       return GNUNET_SYSERR;
 465     *data_size = sizeof (uint16_t)+strlen(result)+1;
 466     *data = GNUNET_malloc (*data_size);
 467     mx_pref_n = htons(mx_pref);
 468     memcpy(*data, &mx_pref_n, sizeof (uint16_t));
 469     strcpy((*data)+sizeof (uint16_t), result);
 470     return GNUNET_OK;
 471   case GNUNET_DNSPARSER_TYPE_TXT:
 472     *data = GNUNET_strdup (s);
 473     *data_size = strlen (s);
 474     return GNUNET_OK;
 475   case GNUNET_DNSPARSER_TYPE_AAAA:
 476     if (1 != inet_pton (AF_INET6, s, &value_aaaa))
 477       return GNUNET_SYSERR;
 478     *data = GNUNET_malloc (sizeof (struct in6_addr));
 479     *data_size = sizeof (struct in6_addr);
 480     memcpy (*data, &value_aaaa, sizeof (value_aaaa));
 481     return GNUNET_OK;
 482   case GNUNET_NAMESTORE_TYPE_PKEY:
 483     if (GNUNET_OK !=
 484         GNUNET_CRYPTO_short_hash_from_string (s, &pkey))
 485       return GNUNET_SYSERR;
 486     *data = GNUNET_malloc (sizeof (struct GNUNET_CRYPTO_ShortHashCode));
 487     memcpy (*data, &pkey, sizeof (pkey));
 488     *data_size = sizeof (struct GNUNET_CRYPTO_ShortHashCode);
 489     return GNUNET_OK;
 490   case GNUNET_NAMESTORE_TYPE_PSEU:
 491     *data = GNUNET_strdup (s);
 492     *data_size = strlen (s);
 493     return GNUNET_OK;
 494   case GNUNET_NAMESTORE_TYPE_LEHO:
 495     *data = GNUNET_strdup (s);
 496     *data_size = strlen (s);
 497     return GNUNET_OK;
 498   default:
 499     GNUNET_break (0);
 500   }
 501   return GNUNET_SYSERR;
 502 }
 503
 504
 505 static struct {
 506   const char *name;
 507   uint32_t number;
 508 } name_map[] = {
 509   { "A", GNUNET_DNSPARSER_TYPE_A },
 510   { "NS", GNUNET_DNSPARSER_TYPE_NS },
 511   { "CNAME", GNUNET_DNSPARSER_TYPE_CNAME },
 512   { "SOA", GNUNET_DNSPARSER_TYPE_SOA },
 513   { "PTR", GNUNET_DNSPARSER_TYPE_PTR },
 514   { "MX", GNUNET_DNSPARSER_TYPE_MX },
 515   { "TXT", GNUNET_DNSPARSER_TYPE_TXT },
 516   { "AAAA", GNUNET_DNSPARSER_TYPE_AAAA },
 517   { "PKEY",  GNUNET_NAMESTORE_TYPE_PKEY },
 518   { "PSEU",  GNUNET_NAMESTORE_TYPE_PSEU },
 519   { "LEHO",  GNUNET_NAMESTORE_TYPE_LEHO },
 520   { NULL, UINT32_MAX }
 521 };
 522
 523
 524 /**
 525  * Convert a type name (i.e. "AAAA") to the corresponding number.
 526  *
 527  * @param typename name to convert
 528  * @return corresponding number, UINT32_MAX on error
 529  */
 530 uint32_t
 531 GNUNET_NAMESTORE_typename_to_number (const char *typename)
 532 {
 533   unsigned int i;
 534
 535   i=0;
 536   while ( (name_map[i].name != NULL) &&
 537           (0 != strcasecmp (typename, name_map[i].name)) )
 538     i++;
 539   return name_map[i].number;
 540 }
 541
 542
 543 /**
 544  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 545  *
 546  * @param type number of a type to convert
 547  * @return corresponding typestring, NULL on error
 548  */
 549 const char *
 550 GNUNET_NAMESTORE_number_to_typename (uint32_t type)
 551 {
 552   unsigned int i;
 553
 554   i=0;
 555   while ( (name_map[i].name != NULL) &&
 556           (type != name_map[i].number) )
 557     i++;
 558   return name_map[i].name;
 559 }
 560
 561
 562
 563 /* end of namestore_common.c */