-fix remove testcase
[oweals/gnunet.git] / src / namestore / namestore_api_common.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009-2013 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_api_common.c
23  * @brief API to access the NAMESTORE service
24  * @author Martin Schanzenbach
25  * @author Matthias Wachs
26  * @author Christian Grothoff
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 "gnunet_tun_lib.h"
36 #include "namestore.h"
37
38
39 #define LOG(kind,...) GNUNET_log_from (kind, "gns-api",__VA_ARGS__)
40
41 GNUNET_NETWORK_STRUCT_BEGIN
42
43
44 /**
45  * Internal format of a record in the serialized form.
46  */
47 struct NetworkRecord
48 {
49
50   /**
51    * Expiration time for the DNS record; relative or absolute depends
52    * on 'flags', network byte order.
53    */
54   uint64_t expiration_time GNUNET_PACKED;
55
56   /**
57    * Number of bytes in 'data', network byte order.
58    */
59   uint32_t data_size GNUNET_PACKED;
60
61   /**
62    * Type of the GNS/DNS record, network byte order.
63    */
64   uint32_t record_type GNUNET_PACKED;
65
66   /**
67    * Flags for the record, network byte order.
68    */
69   uint32_t flags GNUNET_PACKED;
70   
71 };
72
73 GNUNET_NETWORK_STRUCT_END
74
75 /**
76  * Convert a UTF-8 string to UTF-8 lowercase
77  * @param src source string
78  * @return converted result
79  */
80 char *
81 GNUNET_NAMESTORE_normalize_string (const char *src)
82 {
83   GNUNET_assert (NULL != src);
84   char *res = strdup (src);
85   /* normalize */
86   GNUNET_STRINGS_utf8_tolower(src, &res);
87   return res;
88 }
89
90
91 /**
92  * Convert a zone key to a string (for printing debug messages).
93  * This is one of the very few calls in the entire API that is
94  * NOT reentrant!
95  *
96  * @param z the zone key
97  * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s
98  */
99 const char *
100 GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicSignKey *z)
101 {
102   static char buf[sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) * 8];
103   char *end;
104
105   end = GNUNET_STRINGS_data_to_string ((const unsigned char *) z, 
106                                        sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
107                                        buf, sizeof (buf));
108   if (NULL == end)
109   {
110     GNUNET_break (0);
111     return NULL;
112   }
113   *end = '\0';
114   return buf;
115 }
116
117
118 /**
119  * Calculate how many bytes we will need to serialize the given
120  * records.
121  *
122  * @param rd_count number of records in the rd array
123  * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
124  * @return the required size to serialize
125  */
126 size_t
127 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
128                                    const struct GNUNET_NAMESTORE_RecordData *rd)
129 {
130   unsigned int i;
131   size_t ret;
132
133   ret = sizeof (struct NetworkRecord) * rd_count;
134   for (i=0;i<rd_count;i++)
135   {
136     GNUNET_assert ((ret + rd[i].data_size) >= ret);
137     ret += rd[i].data_size;
138   }
139   return ret;  
140 }
141
142
143 /**
144  * Serialize the given records to the given destination buffer.
145  *
146  * @param rd_count number of records in the rd array
147  * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
148  * @param dest_size size of the destination array
149  * @param dest where to write the result
150  * @return the size of serialized records, -1 if records do not fit
151  */
152 ssize_t
153 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
154                                     const struct GNUNET_NAMESTORE_RecordData *rd,
155                                     size_t dest_size,
156                                     char *dest)
157 {
158   struct NetworkRecord rec;
159   unsigned int i;
160   size_t off;
161   
162   off = 0;
163   for (i=0;i<rd_count;i++)
164   {
165     rec.expiration_time = GNUNET_htonll (rd[i].expiration_time);
166     rec.data_size = htonl ((uint32_t) rd[i].data_size);
167     rec.record_type = htonl (rd[i].record_type);
168     rec.flags = htonl (rd[i].flags);
169     if (off + sizeof (rec) > dest_size)
170       return -1;
171     memcpy (&dest[off], &rec, sizeof (rec));
172     off += sizeof (rec);
173     if (off + rd[i].data_size > dest_size)
174       return -1;
175     memcpy (&dest[off], rd[i].data, rd[i].data_size);
176     off += rd[i].data_size;
177   }
178   return off;
179 }
180
181
182 /**
183  * Compares if two records are equal (ignoring flags such
184  * as authority, private and pending, but not relative vs.
185  * absolute expiration time).
186  *
187  * @param a record
188  * @param b record
189  * @return #GNUNET_YES if the records are equal or #GNUNET_NO if they are not
190  */
191 int
192 GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
193                               const struct GNUNET_NAMESTORE_RecordData *b)
194 {
195   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
196       "Comparing records\n");
197   if (a->record_type != b->record_type)
198   {
199     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
200         "Record type %lu != %lu\n", a->record_type, b->record_type);
201     return GNUNET_NO;
202   }
203   if ((a->expiration_time != b->expiration_time) &&
204       ((a->expiration_time != 0) && (b->expiration_time != 0)))
205   {
206     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
207         "Expiration time %llu != %llu\n", a->expiration_time, b->expiration_time);
208     return GNUNET_NO;
209   }
210   if ((a->flags & GNUNET_NAMESTORE_RF_RCMP_FLAGS) 
211        != (b->flags & GNUNET_NAMESTORE_RF_RCMP_FLAGS))
212   {
213     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
214         "Flags %lu (%lu) != %lu (%lu)\n", a->flags,
215         a->flags & GNUNET_NAMESTORE_RF_RCMP_FLAGS, b->flags,
216         b->flags & GNUNET_NAMESTORE_RF_RCMP_FLAGS);
217     return GNUNET_NO;
218   }
219   if (a->data_size != b->data_size)
220   {
221     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
222         "Data size %lu != %lu\n", a->data_size, b->data_size);
223     return GNUNET_NO;
224   }
225   if (0 != memcmp (a->data, b->data, a->data_size))
226   {
227     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
228         "Data contents do not match\n");
229     return GNUNET_NO;
230   }
231   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
232       "Records are equal\n");
233   return GNUNET_YES;
234 }
235
236
237 /**
238  * Deserialize the given records to the given destination.
239  *
240  * @param len size of the serialized record data
241  * @param src the serialized record data
242  * @param rd_count number of records in the rd array
243  * @param dest where to put the data
244  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
245  */
246 int
247 GNUNET_NAMESTORE_records_deserialize (size_t len,
248                                       const char *src,
249                                       unsigned int rd_count,
250                                       struct GNUNET_NAMESTORE_RecordData *dest)
251 {
252   struct NetworkRecord rec;
253   unsigned int i;
254   size_t off;
255   
256   off = 0;
257   for (i=0;i<rd_count;i++)
258   {
259     if (off + sizeof (rec) > len)
260       return GNUNET_SYSERR;
261     memcpy (&rec, &src[off], sizeof (rec));
262     dest[i].expiration_time = GNUNET_ntohll (rec.expiration_time);
263     dest[i].data_size = ntohl ((uint32_t) rec.data_size);
264     dest[i].record_type = ntohl (rec.record_type);
265     dest[i].flags = ntohl (rec.flags);
266     off += sizeof (rec);
267
268     if (off + dest[i].data_size > len)
269       return GNUNET_SYSERR;
270     dest[i].data = &src[off];
271     off += dest[i].data_size;
272   }
273   return GNUNET_OK; 
274 }
275
276
277 /**
278  * Returns the expiration time of the given block of records. The block
279  * expiration time is the expiration time of the block with smallest
280  * expiration time.
281  *
282  * @param rd_count number of records given in @a rd
283  * @param rd array of records
284  * @return absolute expiration time
285  */
286 struct GNUNET_TIME_Absolute
287 GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count, 
288                                              const struct GNUNET_NAMESTORE_RecordData *rd)
289 {
290   unsigned int c;
291   struct GNUNET_TIME_Absolute expire;
292   struct GNUNET_TIME_Absolute at;
293   struct GNUNET_TIME_Relative rt;
294
295   if (NULL == rd)
296     return GNUNET_TIME_UNIT_ZERO_ABS;
297   expire = GNUNET_TIME_UNIT_FOREVER_ABS;
298   for (c = 0; c < rd_count; c++)  
299   {
300     if (0 != (rd[c].flags & GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION))
301     {
302       rt.rel_value_us = rd[c].expiration_time;
303       at = GNUNET_TIME_relative_to_absolute (rt);
304     }
305     else
306     {
307       at.abs_value_us = rd[c].expiration_time;
308     }
309     expire = GNUNET_TIME_absolute_min (at, expire);  
310   }
311   return expire;
312 }
313
314
315 /**
316  * Derive session key and iv from label and public key.
317  *
318  * @param iv initialization vector to initialize
319  * @param skey session key to initialize
320  * @param label label to use for KDF
321  * @param pub public key to use for KDF
322  */
323 static void
324 derive_block_aes_key (struct GNUNET_CRYPTO_AesInitializationVector *iv,
325                       struct GNUNET_CRYPTO_AesSessionKey *skey,
326                       const char *label,
327                       const struct GNUNET_CRYPTO_EccPublicSignKey *pub)
328 {
329   static const char ctx_key[] = "gns-aes-ctx-key";
330   static const char ctx_iv[] = "gns-aes-ctx-iv";
331
332   GNUNET_CRYPTO_kdf (skey, sizeof (struct GNUNET_CRYPTO_AesSessionKey),
333                      pub, sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
334                      label, strlen (label),
335                      ctx_key, strlen (ctx_key),
336                      NULL, 0);
337   GNUNET_CRYPTO_kdf (iv, sizeof (struct GNUNET_CRYPTO_AesInitializationVector),
338                      pub, sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
339                      label, strlen (label),
340                      ctx_iv, strlen (ctx_iv),
341                      NULL, 0);
342 }
343
344
345 /**
346  * Sign name and records
347  *
348  * @param key the private key
349  * @param expire block expiration
350  * @param label the name for the records
351  * @param rd record data
352  * @param rd_count number of records
353  * @return NULL on error (block too large)
354  */
355 struct GNUNET_NAMESTORE_Block *
356 GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
357                                struct GNUNET_TIME_Absolute expire,
358                                const char *label,
359                                const struct GNUNET_NAMESTORE_RecordData *rd,
360                                unsigned int rd_count)
361 {
362   size_t payload_len = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
363   char payload[sizeof (uint32_t) + payload_len];
364   struct GNUNET_NAMESTORE_Block *block;
365   struct GNUNET_CRYPTO_EccPublicSignKey pkey;
366   struct GNUNET_CRYPTO_EccPrivateKey *dkey;
367   struct GNUNET_CRYPTO_AesInitializationVector iv;
368   struct GNUNET_CRYPTO_AesSessionKey skey;
369   uint32_t rd_count_nbo;
370
371   if (payload_len > GNUNET_NAMESTORE_MAX_VALUE_SIZE)
372     return NULL;
373   rd_count_nbo = htonl (rd_count);
374   memcpy (payload, &rd_count_nbo, sizeof (uint32_t));
375   GNUNET_assert (payload_len ==
376                  GNUNET_NAMESTORE_records_serialize (rd_count, rd,
377                                                      payload_len, &payload[sizeof (uint32_t)])); 
378   block = GNUNET_malloc (sizeof (struct GNUNET_NAMESTORE_Block) +
379                          sizeof (uint32_t) + payload_len);
380   block->purpose.size = htonl (sizeof (uint32_t) + payload_len + 
381                                sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
382                                sizeof (struct GNUNET_TIME_AbsoluteNBO));
383   block->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_GNS_RECORD_SIGN);
384   block->expiration_time = GNUNET_TIME_absolute_hton (expire);
385   dkey = GNUNET_CRYPTO_ecc_key_derive (key,
386                                        label,
387                                        "gns");
388   GNUNET_CRYPTO_ecc_key_get_public_for_signature (dkey,
389                                     &block->derived_key);
390   GNUNET_CRYPTO_ecc_key_get_public_for_signature (key,
391                                     &pkey);
392   derive_block_aes_key (&iv, &skey, label, &pkey);
393   GNUNET_break (payload_len + sizeof (uint32_t) ==
394                 GNUNET_CRYPTO_aes_encrypt (payload, payload_len + sizeof (uint32_t),
395                                            &skey, &iv,
396                                            &block[1]));
397   if (GNUNET_OK !=
398       GNUNET_CRYPTO_ecc_sign (dkey,
399                               &block->purpose,
400                               &block->signature))
401   {
402     GNUNET_break (0);
403     GNUNET_free (dkey);
404     GNUNET_free (block);
405     return NULL;
406   }
407   GNUNET_free (dkey);
408   return block;
409 }
410
411
412 /**
413  * Check if a signature is valid.  This API is used by the GNS Block
414  * to validate signatures received from the network.
415  *
416  * @param block block to verify
417  * @return #GNUNET_OK if the signature is valid
418  */
419 int
420 GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block)
421 {  
422   return GNUNET_CRYPTO_ecc_verify (GNUNET_SIGNATURE_PURPOSE_GNS_RECORD_SIGN, 
423                                    &block->purpose,
424                                    &block->signature,
425                                    &block->derived_key);
426 }
427
428
429 /**
430  * Decrypt block.
431  *
432  * @param block block to decrypt
433  * @param zone_key public key of the zone
434  * @param label the name for the records
435  * @param proc function to call with the result
436  * @param proc_cls closure for proc
437  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was 
438  *        not well-formed
439  */
440 int
441 GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
442                                 const struct GNUNET_CRYPTO_EccPublicSignKey *zone_key,
443                                 const char *label,
444                                 GNUNET_NAMESTORE_RecordCallback proc,
445                                 void *proc_cls)
446 {
447   size_t payload_len = ntohl (block->purpose.size) -
448     sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) -
449     sizeof (struct GNUNET_TIME_AbsoluteNBO);
450   struct GNUNET_CRYPTO_AesInitializationVector iv;
451   struct GNUNET_CRYPTO_AesSessionKey skey;
452
453   if (ntohl (block->purpose.size) <      
454       sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
455       sizeof (struct GNUNET_TIME_AbsoluteNBO))
456   {
457     GNUNET_break_op (0);
458     return GNUNET_SYSERR;
459   }
460   derive_block_aes_key (&iv, &skey, label, zone_key);
461   {
462     char payload[payload_len];    
463     uint32_t rd_count;
464
465     GNUNET_break (payload_len ==
466                   GNUNET_CRYPTO_aes_decrypt (&block[1], payload_len,
467                                              &skey, &iv,
468                                              payload));
469     memcpy (&rd_count,
470             payload,
471             sizeof (uint32_t));
472     rd_count = ntohl (rd_count);
473     if (rd_count > 2048)
474     {
475       /* limit to sane value */
476       GNUNET_break_op (0);
477       return GNUNET_SYSERR;
478     }
479     {
480       struct GNUNET_NAMESTORE_RecordData rd[rd_count];
481       
482       if (GNUNET_OK !=
483           GNUNET_NAMESTORE_records_deserialize (payload_len - sizeof (uint32_t),
484                                                 &payload[sizeof (uint32_t)],
485                                                 rd_count,
486                                                 rd))
487       {
488         GNUNET_break_op (0);
489         return GNUNET_SYSERR;
490       }
491       if (NULL != proc)
492         proc (proc_cls, rd_count, (0 != rd_count) ? rd : NULL);
493     }
494   }
495   return GNUNET_OK;
496 }
497
498
499 /**
500  * Convert the 'value' of a record to a string.
501  *
502  * @param type type of the record
503  * @param data value in binary encoding
504  * @param data_size number of bytes in data
505  * @return NULL on error, otherwise human-readable representation of the value
506  */
507 char *
508 GNUNET_NAMESTORE_value_to_string (uint32_t type,
509                                   const void *data,
510                                   size_t data_size)
511 {
512   uint16_t mx_pref;
513   const struct GNUNET_TUN_DnsSoaRecord *soa;
514   const struct GNUNET_TUN_GnsVpnRecord *vpn;
515   const struct GNUNET_TUN_DnsSrvRecord *srv;
516   const struct GNUNET_TUN_DnsTlsaRecord *tlsa;
517   struct GNUNET_CRYPTO_HashAsciiEncoded s_peer;
518   const char *cdata;
519   char* vpn_str;
520   char* srv_str;
521   char* tlsa_str;
522   char* result;
523   const char* soa_rname;
524   const char* soa_mname;
525   char tmp[INET6_ADDRSTRLEN];
526
527   switch (type)
528   {
529   case 0:
530     return NULL;
531   case GNUNET_DNSPARSER_TYPE_A:
532     if (data_size != sizeof (struct in_addr))
533       return NULL;
534     if (NULL == inet_ntop (AF_INET, data, tmp, sizeof (tmp)))
535       return NULL;
536     return GNUNET_strdup (tmp);
537   case GNUNET_DNSPARSER_TYPE_NS:
538     return GNUNET_strndup (data, data_size);
539   case GNUNET_DNSPARSER_TYPE_CNAME:
540     return GNUNET_strndup (data, data_size);
541   case GNUNET_DNSPARSER_TYPE_SOA:
542     if (data_size <= sizeof (struct GNUNET_TUN_DnsSoaRecord))
543       return NULL;
544     soa = data;
545     soa_rname = (const char*) &soa[1];
546     soa_mname = memchr (soa_rname, 0, data_size - sizeof (struct GNUNET_TUN_DnsSoaRecord) - 1);
547     if (NULL == soa_mname)
548       return NULL;
549     soa_mname++;
550     if (NULL == memchr (soa_mname, 0, 
551                         data_size - (sizeof (struct GNUNET_TUN_DnsSoaRecord) + strlen (soa_rname) + 1)))
552       return NULL;
553     GNUNET_asprintf (&result, 
554                      "rname=%s mname=%s %lu,%lu,%lu,%lu,%lu",
555                      soa_rname, soa_mname,
556                      ntohl (soa->serial), 
557                      ntohl (soa->refresh),
558                      ntohl (soa->retry), 
559                      ntohl (soa->expire),
560                      ntohl (soa->minimum));
561     return result;
562   case GNUNET_DNSPARSER_TYPE_PTR:
563     return GNUNET_strndup (data, data_size);
564   case GNUNET_DNSPARSER_TYPE_MX:
565     mx_pref = ntohs(*((uint16_t*)data));
566     if (GNUNET_asprintf(&result, "%hu,%s", mx_pref, data+sizeof(uint16_t))
567         != 0)
568       return result;
569     else
570     {
571       GNUNET_free (result);
572       return NULL;
573     }
574   case GNUNET_DNSPARSER_TYPE_TXT:
575     return GNUNET_strndup (data, data_size);
576   case GNUNET_DNSPARSER_TYPE_AAAA:
577     if (data_size != sizeof (struct in6_addr))
578       return NULL;
579     if (NULL == inet_ntop (AF_INET6, data, tmp, sizeof (tmp)))
580       return NULL;
581     return GNUNET_strdup (tmp);
582   case GNUNET_NAMESTORE_TYPE_PKEY:
583     if (data_size != sizeof (struct GNUNET_CRYPTO_EccPublicSignKey))
584       return NULL;
585     return GNUNET_CRYPTO_ecc_public_sign_key_to_string (data);
586   case GNUNET_NAMESTORE_TYPE_PSEU:
587     return GNUNET_strndup (data, data_size);
588   case GNUNET_NAMESTORE_TYPE_LEHO:
589     return GNUNET_strndup (data, data_size);
590   case GNUNET_NAMESTORE_TYPE_VPN:
591     cdata = data;
592     if ( (data_size <= sizeof (struct GNUNET_TUN_GnsVpnRecord)) ||
593          ('\0' != cdata[data_size - 1]) )
594       return NULL; /* malformed */
595     vpn = data;
596     GNUNET_CRYPTO_hash_to_enc (&vpn->peer.hashPubKey, &s_peer);
597     if (0 == GNUNET_asprintf (&vpn_str, "%u %s %s",
598                               (unsigned int) ntohs (vpn->proto),
599                               (const char*) &s_peer,
600                               (const char*) &vpn[1]))
601     {
602       GNUNET_free (vpn_str);
603       return NULL;
604     }
605     return vpn_str;
606   case GNUNET_DNSPARSER_TYPE_SRV:
607     cdata = data;
608     if ( (data_size <= sizeof (struct GNUNET_TUN_DnsSrvRecord)) ||
609          ('\0' != cdata[data_size - 1]) )
610       return NULL; /* malformed */
611     srv = data;
612
613     if (0 == GNUNET_asprintf (&srv_str, 
614                               "%d %d %d %s",
615                               ntohs (srv->prio),
616                               ntohs (srv->weight),
617                               ntohs (srv->port),
618                               (const char *)&srv[1]))
619     {
620       GNUNET_free (srv_str);
621       return NULL;
622     }
623     return srv_str;
624   case GNUNET_DNSPARSER_TYPE_TLSA:
625     cdata = data;
626     if ( (data_size <= sizeof (struct GNUNET_TUN_DnsTlsaRecord)) ||
627          ('\0' != cdata[data_size - 1]) )
628       return NULL; /* malformed */
629     tlsa = data;
630     if (0 == GNUNET_asprintf (&tlsa_str, 
631                               "%c %c %c %s",
632                               tlsa->usage,
633                               tlsa->selector,
634                               tlsa->matching_type,
635                               (const char *) &tlsa[1]))
636     {
637       GNUNET_free (tlsa_str);
638       return NULL;
639     }
640     return tlsa_str;
641   default:
642     GNUNET_break (0);
643   }
644   GNUNET_break (0); // not implemented
645   return NULL;
646 }
647
648
649 /**
650  * Convert human-readable version of a 'value' of a record to the binary
651  * representation.
652  *
653  * @param type type of the record
654  * @param s human-readable string
655  * @param data set to value in binary encoding (will be allocated)
656  * @param data_size set to number of bytes in data
657  * @return GNUNET_OK on success
658  */
659 int
660 GNUNET_NAMESTORE_string_to_value (uint32_t type,
661                                   const char *s,
662                                   void **data,
663                                   size_t *data_size)
664 {
665   struct in_addr value_a;
666   struct in6_addr value_aaaa;
667   struct GNUNET_CRYPTO_EccPublicSignKey pkey;
668   struct GNUNET_TUN_DnsSoaRecord *soa;
669   struct GNUNET_TUN_GnsVpnRecord *vpn;
670   struct GNUNET_TUN_DnsTlsaRecord *tlsa;
671   char result[253 + 1];
672   char soa_rname[253 + 1];
673   char soa_mname[253 + 1];
674   char s_peer[103 + 1];
675   char s_serv[253 + 1];
676   unsigned int soa_serial;
677   unsigned int soa_refresh;
678   unsigned int soa_retry;
679   unsigned int soa_expire;
680   unsigned int soa_min;
681   uint16_t mx_pref;
682   uint16_t mx_pref_n;
683   unsigned int proto;
684   
685   if (NULL == s)
686     return GNUNET_SYSERR;
687   switch (type)
688   {
689   case 0:
690     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
691                 _("Unsupported record type %d\n"),
692                 (int) type);
693     return GNUNET_SYSERR;
694   case GNUNET_DNSPARSER_TYPE_A:
695     if (1 != inet_pton (AF_INET, s, &value_a))
696     {
697       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
698                   _("Unable to parse IPv4 address `%s'\n"),
699                   s);
700       return GNUNET_SYSERR;
701     }
702     *data = GNUNET_malloc (sizeof (struct in_addr));
703     memcpy (*data, &value_a, sizeof (value_a));
704     *data_size = sizeof (value_a);
705     return GNUNET_OK;
706   case GNUNET_DNSPARSER_TYPE_NS:
707     *data = GNUNET_strdup (s);
708     *data_size = strlen (s) + 1;
709     return GNUNET_OK;
710   case GNUNET_DNSPARSER_TYPE_CNAME:
711     *data = GNUNET_strdup (s);
712     *data_size = strlen (s) + 1;
713     return GNUNET_OK;
714   case GNUNET_DNSPARSER_TYPE_SOA:
715     if (7 != SSCANF (s, 
716                      "rname=%253s mname=%253s %u,%u,%u,%u,%u",
717                      soa_rname, soa_mname,
718                      &soa_serial, &soa_refresh, &soa_retry, &soa_expire, &soa_min))
719     {
720       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
721                   _("Unable to parse SOA record `%s'\n"),
722                   s);
723       return GNUNET_SYSERR;
724     }
725     *data_size = sizeof (struct GNUNET_TUN_DnsSoaRecord)+strlen(soa_rname)+strlen(soa_mname)+2;
726     *data = GNUNET_malloc (*data_size);
727     soa = (struct GNUNET_TUN_DnsSoaRecord*)*data;
728     soa->serial = htonl(soa_serial);
729     soa->refresh = htonl(soa_refresh);
730     soa->retry = htonl(soa_retry);
731     soa->expire = htonl(soa_expire);
732     soa->minimum = htonl(soa_min);
733     strcpy((char*)&soa[1], soa_rname);
734     strcpy((char*)&soa[1]+strlen(*data)+1, soa_mname);
735     return GNUNET_OK;
736   case GNUNET_DNSPARSER_TYPE_PTR:
737     *data = GNUNET_strdup (s);
738     *data_size = strlen (s);
739     return GNUNET_OK;
740   case GNUNET_DNSPARSER_TYPE_MX:
741     if (2 != SSCANF(s, "%hu,%253s", &mx_pref, result))
742     {
743       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
744                   _("Unable to parse MX record `%s'\n"),
745                   s);
746       return GNUNET_SYSERR;
747     }
748     *data_size = sizeof (uint16_t)+strlen(result)+1;
749     *data = GNUNET_malloc (*data_size);
750     mx_pref_n = htons(mx_pref);
751     memcpy(*data, &mx_pref_n, sizeof (uint16_t));
752     strcpy((*data)+sizeof (uint16_t), result);
753     return GNUNET_OK;
754   case GNUNET_DNSPARSER_TYPE_TXT:
755     *data = GNUNET_strdup (s);
756     *data_size = strlen (s);
757     return GNUNET_OK;
758   case GNUNET_DNSPARSER_TYPE_AAAA:
759     if (1 != inet_pton (AF_INET6, s, &value_aaaa))    
760     {
761       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
762                   _("Unable to parse IPv6 address `%s'\n"),
763                   s);
764       return GNUNET_SYSERR;
765     }
766     *data = GNUNET_malloc (sizeof (struct in6_addr));
767     *data_size = sizeof (struct in6_addr);
768     memcpy (*data, &value_aaaa, sizeof (value_aaaa));
769     return GNUNET_OK;
770   case GNUNET_NAMESTORE_TYPE_PKEY:
771     if (GNUNET_OK !=
772         GNUNET_CRYPTO_ecc_public_sign_key_from_string (s, strlen (s), &pkey))
773     {
774       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
775                   _("Unable to parse PKEY record `%s'\n"),
776                   s);
777       return GNUNET_SYSERR;
778     }
779     *data = GNUNET_new (struct GNUNET_CRYPTO_EccPublicSignKey);
780     memcpy (*data, &pkey, sizeof (pkey));
781     *data_size = sizeof (struct GNUNET_CRYPTO_EccPublicSignKey);
782     return GNUNET_OK;
783   case GNUNET_NAMESTORE_TYPE_PSEU:
784     *data = GNUNET_strdup (s);
785     *data_size = strlen (s);
786     return GNUNET_OK;
787   case GNUNET_NAMESTORE_TYPE_LEHO:
788     *data = GNUNET_strdup (s);
789     *data_size = strlen (s);
790     return GNUNET_OK;
791   case GNUNET_NAMESTORE_TYPE_VPN:
792     if (3 != SSCANF (s,"%u %103s %253s",
793                      &proto, s_peer, s_serv))
794     {
795       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
796                   _("Unable to parse VPN record string `%s'\n"),
797                   s);
798       return GNUNET_SYSERR;
799     }
800     *data_size = sizeof (struct GNUNET_TUN_GnsVpnRecord) + strlen (s_serv) + 1;
801     *data = vpn = GNUNET_malloc (*data_size);
802     if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string ((char*)&s_peer,
803                                                      &vpn->peer.hashPubKey))
804     {
805       GNUNET_free (vpn);
806       *data_size = 0;
807       return GNUNET_SYSERR;
808     }
809     vpn->proto = htons ((uint16_t) proto);
810     strcpy ((char*)&vpn[1], s_serv);
811     return GNUNET_OK;
812   case GNUNET_DNSPARSER_TYPE_TLSA:
813     *data_size = sizeof (struct GNUNET_TUN_DnsTlsaRecord) + strlen (s) - 6;
814     *data = tlsa = GNUNET_malloc (*data_size);
815     if (4 != SSCANF (s, "%c %c %c %s",
816                      &tlsa->usage,
817                      &tlsa->selector,
818                      &tlsa->matching_type,
819                      (char*)&tlsa[1]))
820     {
821       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
822                   _("Unable to parse TLSA record string `%s'\n"), 
823                   s);
824       *data_size = 0;
825       GNUNET_free (tlsa);
826       return GNUNET_SYSERR;
827     }
828     return GNUNET_OK;
829   default:
830     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
831                 _("Unsupported record type %d\n"),
832                 (int) type);
833     return GNUNET_SYSERR;
834   }
835 }
836
837
838 /**
839  * Mapping of record type numbers to human-readable
840  * record type names.
841  */
842 static struct { 
843   const char *name; 
844   uint32_t number; 
845 } name_map[] = {
846   { "A", GNUNET_DNSPARSER_TYPE_A },
847   { "NS", GNUNET_DNSPARSER_TYPE_NS },
848   { "CNAME", GNUNET_DNSPARSER_TYPE_CNAME },
849   { "SOA", GNUNET_DNSPARSER_TYPE_SOA },
850   { "PTR", GNUNET_DNSPARSER_TYPE_PTR },
851   { "MX", GNUNET_DNSPARSER_TYPE_MX },
852   { "TXT", GNUNET_DNSPARSER_TYPE_TXT },
853   { "AAAA", GNUNET_DNSPARSER_TYPE_AAAA },
854   { "PKEY",  GNUNET_NAMESTORE_TYPE_PKEY },
855   { "PSEU",  GNUNET_NAMESTORE_TYPE_PSEU },
856   { "LEHO",  GNUNET_NAMESTORE_TYPE_LEHO },
857   { "VPN", GNUNET_NAMESTORE_TYPE_VPN },
858   { "TLSA", GNUNET_DNSPARSER_TYPE_TLSA },
859   { NULL, UINT32_MAX }
860 };
861
862
863 /**
864  * Convert a type name (i.e. "AAAA") to the corresponding number.
865  *
866  * @param typename name to convert
867  * @return corresponding number, UINT32_MAX on error
868  */
869 uint32_t
870 GNUNET_NAMESTORE_typename_to_number (const char *typename)
871 {
872   unsigned int i;
873
874   i=0;
875   while ( (name_map[i].name != NULL) &&
876           (0 != strcasecmp (typename, name_map[i].name)) )
877     i++;
878   return name_map[i].number;  
879 }
880
881
882 /**
883  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
884  *
885  * @param type number of a type to convert
886  * @return corresponding typestring, NULL on error
887  */
888 const char *
889 GNUNET_NAMESTORE_number_to_typename (uint32_t type)
890 {
891   unsigned int i;
892
893   i=0;
894   while ( (name_map[i].name != NULL) &&
895           (type != name_map[i].number) )
896     i++;
897   return name_map[i].name;  
898 }
899
900
901 /**
902  * Test if a given record is expired.
903  * 
904  * @return #GNUNET_YES if the record is expired,
905  *         #GNUNET_NO if not
906  */
907 int
908 GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd)
909 {
910   struct GNUNET_TIME_Absolute at;
911
912   if (0 != (rd->flags & GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION))
913     return GNUNET_NO;
914   at.abs_value_us = rd->expiration_time;
915   return (0 == GNUNET_TIME_absolute_get_remaining (at).rel_value_us) ? GNUNET_YES : GNUNET_NO;
916 }
917
918
919 /**
920  * Calculate the DHT query for a given @a label in a given @a zone.
921  * 
922  * @param zone private key of the zone
923  * @param label label of the record
924  * @param query hash to use for the query
925  */
926 void
927 GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone,
928                                          const char *label,
929                                          struct GNUNET_HashCode *query)
930 {
931   struct GNUNET_CRYPTO_EccPublicSignKey pub;
932
933   GNUNET_CRYPTO_ecc_key_get_public_for_signature (zone, &pub);
934   GNUNET_NAMESTORE_query_from_public_key (&pub, label, query);
935 }
936
937
938 /**
939  * Calculate the DHT query for a given @a label in a given @a zone.
940  * 
941  * @param pub public key of the zone
942  * @param label label of the record
943  * @param query hash to use for the query
944  */
945 void
946 GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicSignKey *pub,
947                                         const char *label,
948                                         struct GNUNET_HashCode *query)
949 {
950   struct GNUNET_CRYPTO_EccPublicSignKey pd;
951
952   GNUNET_CRYPTO_ecc_public_key_derive (pub, label, "gns", &pd);
953   GNUNET_CRYPTO_hash (&pd, sizeof (pd), query);
954 }
955
956
957 /**
958  * Convert public key to the respective absolute domain name in the
959  * ".zkey" pTLD. 
960  * This is one of the very few calls in the entire API that is
961  * NOT reentrant!
962  * 
963  * @param pkey a public key with a point on the eliptic curve 
964  * @return string "X.zkey" where X is the public 
965  *         key in an encoding suitable for DNS labels.
966  */
967 const char *
968 GNUNET_NAMESTORE_pkey_to_zkey (const struct GNUNET_CRYPTO_EccPublicSignKey *pkey)
969 {
970   static char ret[128];
971   char *pkeys;
972
973   pkeys = GNUNET_CRYPTO_ecc_public_sign_key_to_string (pkey);
974   GNUNET_snprintf (ret,
975                    sizeof (ret),
976                    "%s.zkey",
977                    pkeys);
978   GNUNET_free (pkeys);
979   return ret;
980 }
981
982
983 /**
984  * Convert an absolute domain name in the ".zkey" pTLD to the
985  * respective public key.
986  * 
987  * @param zkey string "X.zkey" where X is the coordinates of the public
988  *         key in an encoding suitable for DNS labels.
989  * @param pkey set to a public key on the eliptic curve 
990  * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
991  */
992 int
993 GNUNET_NAMESTORE_zkey_to_pkey (const char *zkey,
994                                struct GNUNET_CRYPTO_EccPublicSignKey *pkey)
995 {
996   char *cpy;
997   char *dot;
998   const char *x;
999     
1000   cpy = GNUNET_strdup (zkey);
1001   x = cpy;
1002   if (NULL == (dot = strchr (x, (int) '.')))
1003     goto error;
1004   *dot = '\0';
1005   if (0 != strcasecmp (dot + 1, 
1006                        "zkey"))
1007     goto error;
1008
1009   if (GNUNET_OK !=
1010       GNUNET_CRYPTO_ecc_public_sign_key_from_string (x,
1011                                                 strlen (x),
1012                                                 pkey))
1013     goto error;
1014   GNUNET_free (cpy);
1015   return GNUNET_OK;
1016  error:
1017   GNUNET_free (cpy);
1018   return GNUNET_SYSERR;
1019 }
1020
1021
1022 /* end of namestore_common.c */