src/hello/hello.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2015 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 hello/hello.c
  23  * @brief helper library for handling HELLOs
  24  * @author Christian Grothoff
  25  * @author Matthias Wachs
  26  */
  27 #include "platform.h"
  28 #include "gnunet_hello_lib.h"
  29 #include "gnunet_protocols.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_transport_plugin.h"
  32
  33 /**
  34  * Context used for building our own URI.
  35  */
  36 struct GNUNET_HELLO_ComposeUriContext
  37 {
  38   /**
  39    * Final URI.
  40    */
  41   char *uri;
  42
  43   /**
  44    * Function for finding transport plugins by name.
  45    */
  46   GNUNET_HELLO_TransportPluginsFind plugins_find;
  47 };
  48
  49
  50 /**
  51  * Context for #add_address_to_hello().
  52  */
  53 struct GNUNET_HELLO_ParseUriContext
  54 {
  55   /**
  56    * Position in the URI with the next address to parse.
  57    */
  58   const char *pos;
  59
  60   /**
  61    * Set to #GNUNET_SYSERR to indicate parse errors.
  62    */
  63   int ret;
  64
  65   /**
  66    * Counter
  67    */
  68   unsigned int counter_total;
  69
  70   /**
  71    * Counter skipped addresses
  72    */
  73   unsigned int counter_added;
  74
  75   /**
  76    * Function for finding transport plugins by name.
  77    */
  78   GNUNET_HELLO_TransportPluginsFind plugins_find;
  79 };
  80
  81
  82 /**
  83  * Return HELLO type
  84  *
  85  * @param h HELLO Message to test
  86  * @return #GNUNET_YES for friend-only or #GNUNET_NO otherwise
  87  */
  88 int
  89 GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h)
  90 {
  91   if (GNUNET_YES == ntohl(h->friend_only))
  92     return GNUNET_YES;
  93   return GNUNET_NO;
  94 }
  95
  96
  97 /**
  98  * Copy the given address information into
  99  * the given buffer using the format of HELLOs.
 100  *
 101  * @param address the address
 102  * @param expiration expiration for the @a address
 103  * @param target where to copy the @a address
 104  * @param max maximum number of bytes to copy to target
 105  * @return number of bytes copied, 0 if
 106  *         the target buffer was not big enough.
 107  */
 108 size_t
 109 GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
 110                           struct GNUNET_TIME_Absolute expiration,
 111                           char *target,
 112                           size_t max)
 113 {
 114   uint16_t alen;
 115   size_t slen;
 116   struct GNUNET_TIME_AbsoluteNBO exp;
 117
 118   slen = strlen (address->transport_name) + 1;
 119   if (slen + sizeof (uint16_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO) +
 120       address->address_length > max)
 121     return 0;
 122   exp = GNUNET_TIME_absolute_hton (expiration);
 123   alen = htons ((uint16_t) address->address_length);
 124   GNUNET_memcpy (target, address->transport_name, slen);
 125   GNUNET_memcpy (&target[slen], &alen, sizeof (uint16_t));
 126   slen += sizeof (uint16_t);
 127   GNUNET_memcpy (&target[slen], &exp, sizeof (struct GNUNET_TIME_AbsoluteNBO));
 128   slen += sizeof (struct GNUNET_TIME_AbsoluteNBO);
 129   GNUNET_memcpy (&target[slen], address->address, address->address_length);
 130   slen += address->address_length;
 131   return slen;
 132 }
 133
 134
 135 /**
 136  * Get the size of an address entry in a HELLO message.
 137  *
 138  * @param buf pointer to the start of the address entry
 139  * @param max maximum size of the entry (end of @a buf)
 140  * @param ralen set to the address length
 141  * @return size of the entry, or 0 if @a max is not large enough
 142  */
 143 static size_t
 144 get_hello_address_size (const char *buf,
 145                         size_t max,
 146                         uint16_t *ralen)
 147 {
 148   const char *pos;
 149   uint16_t alen;
 150   size_t left;
 151   size_t slen;
 152
 153   left = max;
 154   pos = buf;
 155   slen = 1;
 156   while ((left > 0) && ('\0' != *pos))
 157   {
 158     left--;
 159     pos++;
 160     slen++;
 161   }
 162   if (0 == left)
 163   {
 164     /* 0-termination not found */
 165     GNUNET_break_op (0);
 166     return 0;
 167   }
 168   pos++;
 169   if (left < sizeof (uint16_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO))
 170   {
 171     /* not enough space for addrlen */
 172     GNUNET_break_op (0);
 173     return 0;
 174   }
 175   GNUNET_memcpy (&alen, pos, sizeof (uint16_t));
 176   alen = ntohs (alen);
 177   *ralen = alen;
 178   slen += alen + sizeof (uint16_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO);
 179   if (max < slen)
 180   {
 181     /* not enough space for addr */
 182     GNUNET_break_op (0);
 183     return 0;
 184   }
 185   return slen;
 186 }
 187
 188
 189 /**
 190  * Construct a HELLO message given the public key,
 191  * expiration time and an iterator that spews the
 192  * transport addresses.
 193  *
 194  * If friend only is set to #GNUNET_YES we create a FRIEND_HELLO which
 195  * will not be gossiped to other peers.
 196  *
 197  * @param public_key public key to include in the HELLO
 198  * @param addrgen callback to invoke to get addresses
 199  * @param addrgen_cls closure for @a addrgen
 200  * @param friend_only should the returned HELLO be only visible to friends?
 201  * @return the hello message
 202  */
 203 struct GNUNET_HELLO_Message *
 204 GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EddsaPublicKey *public_key,
 205                      GNUNET_HELLO_GenerateAddressListCallback addrgen,
 206                      void *addrgen_cls,
 207                      int friend_only)
 208 {
 209   char buffer[GNUNET_MAX_MESSAGE_SIZE - 1 - 256 -
 210               sizeof (struct GNUNET_HELLO_Message)];
 211   size_t max;
 212   size_t used;
 213   size_t ret;
 214   struct GNUNET_HELLO_Message *hello;
 215
 216   GNUNET_assert (NULL != public_key);
 217   GNUNET_assert ( (GNUNET_YES == friend_only) ||
 218                   (GNUNET_NO == friend_only) );
 219   max = sizeof (buffer);
 220   used = 0;
 221   if (NULL != addrgen)
 222   {
 223     while (GNUNET_SYSERR != (ret = addrgen (addrgen_cls,
 224                                             max,
 225                                             &buffer[used])))
 226     {
 227       max -= ret;
 228       used += ret;
 229     }
 230   }
 231   hello = GNUNET_malloc (sizeof (struct GNUNET_HELLO_Message) + used);
 232   hello->header.type = htons (GNUNET_MESSAGE_TYPE_HELLO);
 233   hello->header.size = htons (sizeof (struct GNUNET_HELLO_Message) + used);
 234   hello->friend_only = htonl (friend_only);
 235   hello->publicKey = *public_key;
 236   GNUNET_memcpy (&hello[1],
 237           buffer,
 238           used);
 239   return hello;
 240 }
 241
 242
 243 /**
 244  * Iterate over all of the addresses in the HELLO.
 245  *
 246  * @param msg HELLO to iterate over
 247  * @param return_modified if a modified copy should be returned,
 248  *         otherwise NULL will be returned
 249  * @param it iterator to call on each address
 250  * @param it_cls closure for @a it
 251  * @return modified HELLO message
 252  */
 253 struct GNUNET_HELLO_Message *
 254 GNUNET_HELLO_iterate_addresses (const struct GNUNET_HELLO_Message *msg,
 255                                 int return_modified,
 256                                 GNUNET_HELLO_AddressIterator it,
 257                                 void *it_cls)
 258 {
 259   struct GNUNET_HELLO_Address address;
 260   uint16_t msize;
 261   struct GNUNET_HELLO_Message *ret;
 262   const char *inptr;
 263   size_t insize;
 264   size_t esize;
 265   size_t wpos;
 266   char *woff;
 267   uint16_t alen;
 268   struct GNUNET_TIME_AbsoluteNBO expire;
 269   int iret;
 270
 271   msize = GNUNET_HELLO_size (msg);
 272   if ((msize < sizeof (struct GNUNET_HELLO_Message)) ||
 273       (ntohs (msg->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
 274   {
 275     GNUNET_break_op (0);
 276     return NULL;
 277   }
 278   ret = NULL;
 279   if (return_modified)
 280   {
 281     ret = GNUNET_malloc (msize);
 282     GNUNET_memcpy (ret,
 283             msg,
 284             msize);
 285   }
 286   inptr = (const char *) &msg[1];
 287   insize = msize - sizeof (struct GNUNET_HELLO_Message);
 288   wpos = 0;
 289   woff = (NULL != ret) ? (char *) &ret[1] : NULL;
 290   address.peer.public_key = msg->publicKey;
 291   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 292               "HELLO has %u bytes of address data\n",
 293               (unsigned int) insize);
 294
 295   while (insize > 0)
 296   {
 297     esize = get_hello_address_size (inptr,
 298                                     insize,
 299                                     &alen);
 300     if (0 == esize)
 301     {
 302       GNUNET_break (0);
 303       GNUNET_free_non_null (ret);
 304       return NULL;
 305     }
 306     /* need GNUNET_memcpy() due to possibility of misalignment */
 307     GNUNET_memcpy (&expire,
 308             &inptr[esize - alen - sizeof (struct GNUNET_TIME_AbsoluteNBO)],
 309             sizeof (struct GNUNET_TIME_AbsoluteNBO));
 310     address.address = &inptr[esize - alen];
 311     address.address_length = alen;
 312     address.transport_name = inptr;
 313     address.local_info = GNUNET_HELLO_ADDRESS_INFO_NONE;
 314     iret = it (it_cls,
 315                &address,
 316                GNUNET_TIME_absolute_ntoh (expire));
 317     if (GNUNET_SYSERR == iret)
 318       break;
 319     if ( (GNUNET_OK == iret) &&
 320          (NULL != ret) )
 321     {
 322       /* copy address over */
 323       GNUNET_memcpy (woff,
 324               inptr,
 325               esize);
 326       woff += esize;
 327       wpos += esize;
 328     }
 329     insize -= esize;
 330     inptr += esize;
 331   }
 332   if (NULL != ret)
 333     ret->header.size = ntohs (sizeof (struct GNUNET_HELLO_Message) + wpos);
 334   return ret;
 335 }
 336
 337
 338 /**
 339  * Closure for #get_match_exp().
 340  */
 341 struct ExpireContext
 342 {
 343   /**
 344    * Address we are looking for.
 345    */
 346   const struct GNUNET_HELLO_Address *address;
 347
 348   /**
 349    * Set to #GNUNET_YES if we found the @e address.
 350    */
 351   int found;
 352
 353   /**
 354    * Set to the expiration of the match if @e found is #GNUNET_YES.
 355    */
 356   struct GNUNET_TIME_Absolute expiration;
 357 };
 358
 359
 360 /**
 361  * Store the expiration time of an address that matches the template.
 362  *
 363  * @param cls the `struct ExpireContext`
 364  * @param address address to match against the template
 365  * @param expiration expiration time of @a address, to store in @a cls
 366  * @return #GNUNET_SYSERR if we found a matching address, #GNUNET_OK otherwise
 367  */
 368 static int
 369 get_match_exp (void *cls,
 370                const struct GNUNET_HELLO_Address *address,
 371                struct GNUNET_TIME_Absolute expiration)
 372 {
 373   struct ExpireContext *ec = cls;
 374
 375   if (0 != GNUNET_HELLO_address_cmp (address,
 376                                      ec->address))
 377     return GNUNET_OK;
 378   ec->found = GNUNET_YES;
 379   ec->expiration = expiration;
 380   return GNUNET_SYSERR;       /* done here */
 381 }
 382
 383
 384 /**
 385  * Context for a #GNUNET_HELLO_Merge operation.
 386  */
 387 struct MergeContext
 388 {
 389   /**
 390    * First HELLO we are merging.
 391    */
 392   const struct GNUNET_HELLO_Message *h1;
 393
 394   /**
 395    * Second HELLO we are merging.
 396    */
 397   const struct GNUNET_HELLO_Message *h2;
 398
 399   /**
 400    * Either @e h1 or @e h2, used when copying
 401    * to compare against (so we only copy the
 402    * most recent entry).
 403    */
 404   const struct GNUNET_HELLO_Message *other;
 405
 406   /**
 407    * Buffer where we copy to.
 408    */
 409   char *buf;
 410
 411   /**
 412    * Number of bytes allocated in @e buf
 413    */
 414   size_t max;
 415
 416   /**
 417    * Current (write) offset in @e buf.
 418    */
 419   size_t ret;
 420
 421   /**
 422    * Should we copy addresses with an identical value
 423    * and expiration time in @e other, or do we only
 424    * copy addresses with strictly later expiration times?
 425    */
 426   int take_equal;
 427
 428 };
 429
 430
 431 /**
 432  * Append the address @a address to the buffer from
 433  * the merge context IF it is more recent than equivalent
 434  * addresses in `other`.
 435  *
 436  * @param cls the `struct MergeContext`
 437  * @param address the HELLO address we might copy
 438  * @param expiration expiration time for @a address
 439  * @return always #GNUNET_OK
 440  */
 441 static int
 442 copy_latest (void *cls,
 443              const struct GNUNET_HELLO_Address *address,
 444              struct GNUNET_TIME_Absolute expiration)
 445 {
 446   struct MergeContext *mc = cls;
 447   struct ExpireContext ec;
 448
 449   ec.address = address;
 450   ec.found = GNUNET_NO;
 451   /* check if address exists in other */
 452   GNUNET_HELLO_iterate_addresses (mc->other,
 453                                   GNUNET_NO,
 454                                   &get_match_exp,
 455                                   &ec);
 456   if ( (GNUNET_NO == ec.found) ||
 457        (ec.expiration.abs_value_us < expiration.abs_value_us) ||
 458        ( (ec.expiration.abs_value_us == expiration.abs_value_us) &&
 459          (GNUNET_YES == mc->take_equal) ) )
 460   {
 461     /* copy address to buffer */
 462     mc->ret +=
 463         GNUNET_HELLO_add_address (address,
 464                                   expiration,
 465                                   &mc->buf[mc->ret],
 466                                   mc->max - mc->ret);
 467   }
 468   return GNUNET_OK;
 469 }
 470
 471
 472 /**
 473  * Function called to build the HELLO during
 474  * #GNUNET_HELLO_merge() by merging addresses from
 475  * two original HELLOs.
 476  *
 477  * @param cls the `struct MergeContext`
 478  * @param max number of bytes we can write at most in @a buf
 479  * @param buf where to copy the addresses
 480  * @return #GNUNET_SYSERR to end iteration, otherwise number of bytes written to @a buf
 481  */
 482 static ssize_t
 483 merge_addr (void *cls,
 484             size_t max,
 485             void *buf)
 486 {
 487   struct MergeContext *mc = cls;
 488
 489   if (NULL == mc->h1)
 490     return GNUNET_SYSERR; /* Stop iteration */
 491   mc->ret = 0;
 492   mc->max = max;
 493   mc->buf = buf;
 494   mc->take_equal = GNUNET_NO;
 495   mc->other = mc->h2;
 496   /* copy addresses from h1, if strictly larger expiration than h2 */
 497   GNUNET_HELLO_iterate_addresses (mc->h1,
 498                                   GNUNET_NO,
 499                                   &copy_latest,
 500                                   mc);
 501   mc->take_equal = GNUNET_YES;
 502   mc->other = mc->h1;
 503   /* copy addresses from h2, if larger or equal expiration than h1 */
 504   GNUNET_HELLO_iterate_addresses (mc->h2,
 505                                   GNUNET_NO,
 506                                   &copy_latest,
 507                                   mc);
 508   /* set marker to stop iteration */
 509   mc->h1 = NULL;
 510   return mc->ret;
 511 }
 512
 513
 514 /**
 515  * Construct a HELLO message by merging the
 516  * addresses in two existing HELLOs (which
 517  * must be for the same peer).
 518  *
 519  * @param h1 first HELLO message
 520  * @param h2 the second HELLO message
 521  * @return the combined HELLO message
 522  */
 523 struct GNUNET_HELLO_Message *
 524 GNUNET_HELLO_merge (const struct GNUNET_HELLO_Message *h1,
 525                     const struct GNUNET_HELLO_Message *h2)
 526 {
 527   struct MergeContext mc = { h1, h2, NULL, NULL, 0, 0, 0 };
 528   int friend_only;
 529
 530   if (h1->friend_only != h2->friend_only)
 531     friend_only = GNUNET_YES; /* One of the HELLOs is friend only */
 532   else
 533     friend_only = ntohl (h1->friend_only); /* Both HELLO's have the same type */
 534
 535   return GNUNET_HELLO_create (&h1->publicKey,
 536                               &merge_addr,
 537                               &mc,
 538                               friend_only);
 539 }
 540
 541
 542 /**
 543  * Context used in #GNUNET_HELLO_iterate_new_addresses() to
 544  * figure out which addresses are in fact 'new'.
 545  */
 546 struct DeltaContext
 547 {
 548   /**
 549    * We should ignore addresses that expire before this time.
 550    */
 551   struct GNUNET_TIME_Absolute expiration_limit;
 552
 553   /**
 554    * Function to call on addresses that are indeed new.
 555    */
 556   GNUNET_HELLO_AddressIterator it;
 557
 558   /**
 559    * Closure for @e it.
 560    */
 561   void *it_cls;
 562
 563   /**
 564    * HELLO with known addresses, addresses in this HELLO
 565    * we must always ignore.
 566    */
 567   const struct GNUNET_HELLO_Message *old_hello;
 568 };
 569
 570
 571 /**
 572  * Check if the given address is 'new', and if so, call
 573  * the iterator.  Compares the existing address against
 574  * addresses in the context's `old_hello` and calls the
 575  * iterator on those that are new (and not expired).
 576  *
 577  * @param cls the `struct DeltaContext`
 578  * @param address an address to check whether it is new
 579  * @param expiration expiration time for @a address
 580  * @return #GNUNET_YES if the address is ignored, otherwise
 581  *         whatever the iterator returned.
 582  */
 583 static int
 584 delta_match (void *cls,
 585              const struct GNUNET_HELLO_Address *address,
 586              struct GNUNET_TIME_Absolute expiration)
 587 {
 588   struct DeltaContext *dc = cls;
 589   int ret;
 590   struct ExpireContext ec;
 591
 592   ec.address = address;
 593   ec.found = GNUNET_NO;
 594   GNUNET_HELLO_iterate_addresses (dc->old_hello,
 595                                   GNUNET_NO,
 596                                   &get_match_exp,
 597                                   &ec);
 598   if ( (GNUNET_YES == ec.found) &&
 599        ( (ec.expiration.abs_value_us > expiration.abs_value_us) ||
 600          (ec.expiration.abs_value_us >= dc->expiration_limit.abs_value_us)))
 601     return GNUNET_YES;          /* skip: found and boring */
 602   ret = dc->it (dc->it_cls,
 603                 address,
 604                 expiration);
 605   return ret;
 606 }
 607
 608
 609 /**
 610  * Iterate over addresses in @a new_hello that are NOT already present
 611  * in @a old_hello.  Note that if the address is present in @a old_hello
 612  * but the expiration time in @a new_hello is more recent, the iterator
 613  * is also called.
 614  *
 615  * @param new_hello a HELLO message
 616  * @param old_hello a HELLO message
 617  * @param expiration_limit ignore addresses in @a old_hello
 618  *        that expired before the given time stamp
 619  * @param it iterator to call on each address
 620  * @param it_cls closure for @a it
 621  */
 622 void
 623 GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message *new_hello,
 624                                     const struct GNUNET_HELLO_Message *old_hello,
 625                                     struct GNUNET_TIME_Absolute expiration_limit,
 626                                     GNUNET_HELLO_AddressIterator it,
 627                                     void *it_cls)
 628 {
 629   struct DeltaContext dc;
 630
 631   dc.expiration_limit = expiration_limit;
 632   dc.it = it;
 633   dc.it_cls = it_cls;
 634   dc.old_hello = old_hello;
 635   GNUNET_assert (NULL ==
 636                  GNUNET_HELLO_iterate_addresses (new_hello,
 637                                                  GNUNET_NO,
 638                                                  &delta_match,
 639                                                  &dc));
 640 }
 641
 642
 643 /**
 644  * Return the size of the given HELLO message.
 645  * @param hello to inspect
 646  * @return the size, 0 if HELLO is invalid
 647  */
 648 uint16_t
 649 GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello)
 650 {
 651   uint16_t ret = ntohs (hello->header.size);
 652
 653   if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
 654       (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
 655     return 0;
 656   return ret;
 657 }
 658
 659
 660 /**
 661  * Get the peer identity from a HELLO message.
 662  *
 663  * @param hello the hello message
 664  * @param peer where to store the peer's identity
 665  * @return #GNUNET_SYSERR if the HELLO was malformed
 666  */
 667 int
 668 GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
 669                      struct GNUNET_PeerIdentity *peer)
 670 {
 671   uint16_t ret = ntohs (hello->header.size);
 672
 673   if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
 674       (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
 675     return GNUNET_SYSERR;
 676   peer->public_key = hello->publicKey;
 677   return GNUNET_OK;
 678 }
 679
 680
 681 /**
 682  * Get the header from a HELLO message, used so other code
 683  * can correctly send HELLO messages.
 684  *
 685  * @param hello the hello message
 686  *
 687  * @return header or NULL if the HELLO was malformed
 688  */
 689 struct GNUNET_MessageHeader *
 690 GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello)
 691 {
 692   uint16_t ret = ntohs (hello->header.size);
 693
 694   if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
 695       (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
 696     return NULL;
 697
 698   return &hello->header;
 699 }
 700
 701
 702 /**
 703  * Context used for comparing HELLOs in #GNUNET_HELLO_equals().
 704  */
 705 struct EqualsContext
 706 {
 707   /**
 708    * Addresses that expired before this date are ignored for
 709    * the comparisson.
 710    */
 711   struct GNUNET_TIME_Absolute expiration_limit;
 712
 713   /**
 714    * Earliest expiration time for which we found a match
 715    * with a difference in expiration times.
 716    * At this time, the two HELLOs may start to diverge.
 717    */
 718   struct GNUNET_TIME_Absolute result;
 719
 720   /**
 721    * HELLO message to compare against. (First set to the second
 722    * HELLO, then set to the first HELLO.)
 723    */
 724   const struct GNUNET_HELLO_Message *ref;
 725
 726   /**
 727    * Address we are currently looking for.
 728    */
 729   const struct GNUNET_HELLO_Address *address;
 730
 731   /**
 732    * Expiration time of @e address.
 733    */
 734   struct GNUNET_TIME_Absolute expiration;
 735
 736   /**
 737    * Did we find the address we were looking for?
 738    */
 739   int found;
 740
 741 };
 742
 743
 744 /**
 745  * Check if the given address matches the address we are currently
 746  * looking for. If so, sets `found` to #GNUNET_YES and, if the
 747  * expiration times for the two addresses differ, updates `result` to
 748  * the minimum of our @a expiration and the existing value
 749  *
 750  * @param cls the `struct EqualsContext`
 751  * @param address address from the reference HELLO
 752  * @param expiration expiration time for @a address
 753  * @return #GNUNET_YES if the address is expired or does not match
 754  *         #GNUNET_SYSERR if the address does match.
 755  */
 756 static int
 757 find_other_matching (void *cls,
 758                      const struct GNUNET_HELLO_Address *address,
 759                      struct GNUNET_TIME_Absolute expiration)
 760 {
 761   struct EqualsContext *ec = cls;
 762
 763   if (expiration.abs_value_us < ec->expiration_limit.abs_value_us)
 764     return GNUNET_YES;
 765   if (0 == GNUNET_HELLO_address_cmp (address, ec->address))
 766   {
 767     ec->found = GNUNET_YES;
 768     if (expiration.abs_value_us < ec->expiration.abs_value_us)
 769       ec->result = GNUNET_TIME_absolute_min (expiration,
 770                                              ec->result);
 771     return GNUNET_SYSERR;
 772   }
 773   return GNUNET_YES;
 774 }
 775
 776
 777 /**
 778  * Helper function for #GNUNET_HELLO_equals().  Checks
 779  * if the given @a address exists also in the other HELLO;
 780  * if not, the result time is set to zero and the iteration
 781  * is aborted.
 782  *
 783  * @param cls the `struct EqualsContext`
 784  * @param address address to locate
 785  * @param expiration expiration time of the current address
 786  * @return #GNUNET_OK if the address exists or is expired,
 787  *         #GNUNET_SYSERR if it was not found
 788  */
 789 static int
 790 find_matching (void *cls,
 791                const struct GNUNET_HELLO_Address *address,
 792                struct GNUNET_TIME_Absolute expiration)
 793 {
 794   struct EqualsContext *ec = cls;
 795
 796   if (expiration.abs_value_us < ec->expiration_limit.abs_value_us)
 797     return GNUNET_OK; /* expired, we don't care */
 798   ec->address = address;
 799   ec->expiration = expiration;
 800   ec->found = GNUNET_NO;
 801   GNUNET_HELLO_iterate_addresses (ec->ref,
 802                                   GNUNET_NO,
 803                                   &find_other_matching,
 804                                   ec);
 805   if (GNUNET_NO == ec->found)
 806   {
 807     /* not found, we differ *now* */
 808     ec->result = GNUNET_TIME_UNIT_ZERO_ABS;
 809     return GNUNET_SYSERR;
 810   }
 811   return GNUNET_OK;
 812 }
 813
 814
 815 /**
 816  * Test if two HELLO messages contain the same addresses.
 817  * If they only differ in expiration time, the lowest
 818  * expiration time larger than @a now where they differ
 819  * is returned.
 820  *
 821  * @param h1 first HELLO message
 822  * @param h2 the second HELLO message
 823  * @param now time to use for deciding which addresses have
 824  *            expired and should not be considered at all
 825  * @return absolute time forever if the two HELLOs are
 826  *         totally identical; smallest timestamp >= @a now if
 827  *         they only differ in timestamps;
 828  *         zero if the some addresses with expirations >= @a now
 829  *         do not match at all
 830  */
 831 struct GNUNET_TIME_Absolute
 832 GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1,
 833                      const struct GNUNET_HELLO_Message *h2,
 834                      struct GNUNET_TIME_Absolute now)
 835 {
 836   struct EqualsContext ec;
 837
 838   if (h1->header.type != h2->header.type)
 839     return GNUNET_TIME_UNIT_ZERO_ABS;
 840   if (0 !=
 841       GNUNET_memcmp (&h1->publicKey,
 842               &h2->publicKey))
 843     return GNUNET_TIME_UNIT_ZERO_ABS;
 844   ec.expiration_limit = now;
 845   ec.result = GNUNET_TIME_UNIT_FOREVER_ABS;
 846   ec.ref = h2;
 847   GNUNET_HELLO_iterate_addresses (h1,
 848                                   GNUNET_NO,
 849                                   &find_matching,
 850                                   &ec);
 851   if (ec.result.abs_value_us == GNUNET_TIME_UNIT_ZERO.rel_value_us)
 852     return ec.result;
 853   ec.ref = h1;
 854   GNUNET_HELLO_iterate_addresses (h2,
 855                                   GNUNET_NO,
 856                                   &find_matching,
 857                                   &ec);
 858   return ec.result;
 859 }
 860
 861
 862 /**
 863  * Iterator to find the time when the last address will expire.
 864  * Updates the maximum value stored in @a cls.
 865  *
 866  * @param cls where to store the max, a `struct GNUNET_TIME_Absolute`
 867  * @param address an address (ignored)
 868  * @param expiration expiration time for @a address
 869  * @return #GNUNET_OK (always)
 870  */
 871 static int
 872 find_max_expire (void *cls,
 873                  const struct GNUNET_HELLO_Address *address,
 874                  struct GNUNET_TIME_Absolute expiration)
 875 {
 876   struct GNUNET_TIME_Absolute *max = cls;
 877
 878   *max = GNUNET_TIME_absolute_max (*max, expiration);
 879   return GNUNET_OK;
 880 }
 881
 882
 883 /**
 884  * When does the last address in the given HELLO expire?
 885  *
 886  * @param msg HELLO to inspect
 887  * @return time the last address expires, 0 if there are no addresses in the HELLO
 888  */
 889 struct GNUNET_TIME_Absolute
 890 GNUNET_HELLO_get_last_expiration (const struct GNUNET_HELLO_Message *msg)
 891 {
 892   struct GNUNET_TIME_Absolute ret;
 893
 894   ret = GNUNET_TIME_UNIT_ZERO_ABS;
 895   GNUNET_HELLO_iterate_addresses (msg,
 896                                   GNUNET_NO,
 897                                   &find_max_expire,
 898                                   &ret);
 899   return ret;
 900 }
 901
 902
 903 /**
 904  * GNUnet URIs are of the general form "gnunet://MODULE/IDENTIFIER".
 905  * The specific structure of "IDENTIFIER" depends on the module and
 906  * maybe differenciated into additional subcategories if applicable.
 907  * This module only deals with hello identifiers (MODULE = "hello").
 908  * <p>
 909  *
 910  * The concrete URI format is:
 911  *
 912  * "gnunet://hello/PEER[+YYYYMMDDHHMMSS+<TYPE>+<ADDRESS>]...".
 913  * These URIs can be used to add a peer record to peerinfo service.
 914  * PEER is the string representation of peer's public key.
 915  * YYYYMMDDHHMMSS is the expiration date.
 916  * TYPE is a transport type.
 917  * ADDRESS is the address, its format depends upon the transport type.
 918  * The concrete transport types and corresponding address formats are:
 919  *
 920  * <ul><li>
 921  *
 922  * <TCP|UDP>!IPADDRESS
 923  * IPVDDRESS is either IPV4 .-delimited address in form of XXX.XXX.XXX.XXX:PPPPP
 924  * or IPV6 :-delimited address  with '[' and ']' (according to RFC2732):
 925  * [XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX]:PPPPP
 926  * PPPPP is the port number. May be 0.
 927  *
 928  * </li><li>
 929  *
 930  * [add SMTP, HTTP and other addresses here]
 931  *
 932  * </li></ul>
 933  *
 934  * The encoding for hexadecimal values is defined in the crypto_hash.c
 935  * module in the gnunetutil library and discussed there.
 936  *
 937  * Examples:
 938  *
 939  * gnunet://hello/V8XXK9GAN5ZJFRFQP8MQX3D83BZTSBQVHKWWD0JPE63Z821906EG+20120302010059+TCP+192.168.0.1:2086+TCP+64.23.8.174:0
 940  * gnunet://hello/V8XXK9GAN5ZJFRFQP8MQX3D83BZTSBQVHKWWD0JPE63Z821906EG+20120302010059+TCP+[2001:db8:85a3:8d3:1319:8a2e:370:7348]:2086
 941  *
 942  * <p>
 943  */
 944
 945
 946
 947 /**
 948  * Function that is called on each address of this peer.
 949  * Expands the corresponding URI string.
 950  *
 951  * @param cls the `struct GNUNET_HELLO_ComposeUriContext`
 952  * @param address address to add
 953  * @param expiration expiration time for the address
 954  * @return #GNUNET_OK (continue iteration).
 955  */
 956 static int
 957 add_address_to_uri (void *cls,
 958                     const struct GNUNET_HELLO_Address *address,
 959                     struct GNUNET_TIME_Absolute expiration)
 960 {
 961   struct GNUNET_HELLO_ComposeUriContext *ctx = cls;
 962   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 963   const char *addr;
 964   char *ret;
 965   char *addr_dup;
 966   char *pos;
 967   char tbuf[16] = "";
 968   char *client_str = "_client";
 969   struct tm *t;
 970   time_t seconds;
 971
 972   papi = ctx->plugins_find (address->transport_name);
 973   if (NULL == papi)
 974   {
 975     /* Not an error - we might just not have the right plugin. */
 976     return GNUNET_OK;
 977   }
 978   if (NULL == papi->address_to_string)
 979   {
 980     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 981                 "URI conversion not implemented for plugin `%s'\n",
 982                 address->transport_name);
 983     return GNUNET_OK;
 984   }
 985   addr = papi->address_to_string (papi->cls,
 986                                   address->address,
 987                                   address->address_length);
 988   if ( (NULL == addr) ||
 989        (0 == strlen(addr)) )
 990     return GNUNET_OK;
 991
 992   addr_dup = GNUNET_strdup (addr);
 993   if (NULL != (pos = strstr (addr_dup, "_server")))
 994     GNUNET_memcpy (pos,
 995             client_str,
 996             strlen (client_str)); /* Replace all server addresses with client addresses */
 997
 998   seconds = expiration.abs_value_us / 1000LL / 1000LL;
 999   t = gmtime (&seconds);
1000
1001   GNUNET_asprintf (&ret,
1002                    "%s%c%s%c%s%c%s",
1003                    ctx->uri,
1004                    GNUNET_HELLO_URI_SEP,
1005                    strftime (tbuf,
1006                              sizeof (tbuf),
1007                              "%Y%m%d%H%M%S",
1008                              t) ? tbuf : "0",
1009                    GNUNET_HELLO_URI_SEP,
1010                    address->transport_name,
1011                    GNUNET_HELLO_URI_SEP,
1012                    addr_dup);
1013   GNUNET_free (addr_dup);
1014   GNUNET_free (ctx->uri);
1015   ctx->uri = ret;
1016   return GNUNET_OK;
1017 }
1018
1019
1020 /**
1021  * Compose a hello URI string from a hello message.
1022  *
1023  * @param hello Hello message
1024  * @param plugins_find Function to find transport plugins by name
1025  * @return Hello URI string
1026  */
1027 char *
1028 GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
1029                           GNUNET_HELLO_TransportPluginsFind plugins_find)
1030 {
1031   struct GNUNET_HELLO_ComposeUriContext ctx;
1032   char *pkey;
1033
1034   ctx.plugins_find = plugins_find;
1035   pkey = GNUNET_CRYPTO_eddsa_public_key_to_string (&hello->publicKey);
1036   GNUNET_asprintf (&ctx.uri,
1037                    "%s%s",
1038                    (GNUNET_YES == GNUNET_HELLO_is_friend_only (hello))
1039                    ? GNUNET_FRIEND_HELLO_URI_PREFIX
1040                    : GNUNET_HELLO_URI_PREFIX,
1041                    pkey);
1042   GNUNET_free (pkey);
1043   GNUNET_HELLO_iterate_addresses (hello,
1044                                   GNUNET_NO,
1045                                   &add_address_to_uri,
1046                                   &ctx);
1047   return ctx.uri;
1048 }
1049
1050
1051 /* ************************* Parse HELLO URI ********************* */
1052
1053
1054 /**
1055  * We're building a HELLO.  Parse the next address from the
1056  * parsing context and append it.
1057  *
1058  * @param cls the `struct GNUNET_HELLO_ParseUriContext`
1059  * @param max number of bytes available for HELLO construction
1060  * @param buffer where to copy the next address (in binary format)
1061  * @return number of bytes added to buffer, #GNUNET_SYSERR on error
1062  */
1063 static ssize_t
1064 add_address_to_hello (void *cls,
1065                       size_t max,
1066                       void *buffer)
1067 {
1068   struct GNUNET_HELLO_ParseUriContext *ctx = cls;
1069   const char *tname;
1070   const char *address;
1071   char *uri_address;
1072   const char *end;
1073   char *plugin_name;
1074   struct tm expiration_time;
1075   time_t expiration_seconds;
1076   struct GNUNET_TIME_Absolute expire;
1077   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1078   void *addr;
1079   size_t addr_len;
1080   struct GNUNET_HELLO_Address haddr;
1081   ssize_t ret;
1082
1083   if (NULL == ctx->pos)
1084     return GNUNET_SYSERR;
1085   if (GNUNET_HELLO_URI_SEP != ctx->pos[0])
1086   {
1087     ctx->ret = GNUNET_SYSERR;
1088     GNUNET_break (0);
1089     return GNUNET_SYSERR;
1090   }
1091   ctx->pos++;
1092
1093   if ( ('0' == ctx->pos[0]) &&
1094        (GNUNET_HELLO_URI_SEP == ctx->pos[1]) )
1095   {
1096     expire = GNUNET_TIME_UNIT_FOREVER_ABS;
1097     tname = ctx->pos + 1;
1098   }
1099   else
1100   {
1101     memset (&expiration_time, 0, sizeof (expiration_time));
1102     tname = strptime (ctx->pos,
1103                       "%Y%m%d%H%M%S",
1104                       &expiration_time);
1105     if (NULL == tname)
1106     {
1107       ctx->ret = GNUNET_SYSERR;
1108       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1109                   _("Failed to parse HELLO message: missing expiration time\n"));
1110       GNUNET_break (0);
1111       return GNUNET_SYSERR;
1112     }
1113
1114     expiration_seconds = mktime (&expiration_time);
1115     if (expiration_seconds == (time_t) -1)
1116     {
1117       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1118                   _("Failed to parse HELLO message: invalid expiration time\n"));
1119       ctx->ret = GNUNET_SYSERR;
1120       GNUNET_break (0);
1121       return GNUNET_SYSERR;
1122     }
1123     expire.abs_value_us = expiration_seconds * 1000LL * 1000LL;
1124   }
1125   if (GNUNET_HELLO_URI_SEP != tname[0])
1126   {
1127     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1128                 _("Failed to parse HELLO message: malformed\n"));
1129     ctx->ret = GNUNET_SYSERR;
1130     GNUNET_break (0);
1131     return GNUNET_SYSERR;
1132   }
1133   tname++;
1134   address = strchr (tname,
1135                     (int) GNUNET_HELLO_URI_SEP);
1136   if (NULL == address)
1137   {
1138     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1139                 _("Failed to parse HELLO message: missing transport plugin\n"));
1140     ctx->ret = GNUNET_SYSERR;
1141     GNUNET_break (0);
1142     return GNUNET_SYSERR;
1143   }
1144   address++;
1145   end = strchr (address, (int) GNUNET_HELLO_URI_SEP);
1146   ctx->pos = end;
1147   ctx->counter_total ++;
1148   plugin_name = GNUNET_strndup (tname, address - (tname+1));
1149   papi = ctx->plugins_find (plugin_name);
1150   if (NULL == papi)
1151   {
1152     /* Not an error - we might just not have the right plugin.
1153      * Skip this part, advance to the next one and recurse.
1154      * But only if this is not the end of string.
1155      */
1156     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1157                 _("Plugin `%s' not found, skipping address\n"),
1158                 plugin_name);
1159     GNUNET_free (plugin_name);
1160     return 0;
1161   }
1162   if (NULL == papi->string_to_address)
1163   {
1164     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1165                 _("Plugin `%s' does not support URIs yet\n"),
1166                 plugin_name);
1167     GNUNET_free (plugin_name);
1168     GNUNET_break (0);
1169     return 0;
1170   }
1171   uri_address = GNUNET_strndup (address, end - address);
1172   if (GNUNET_OK !=
1173       papi->string_to_address (papi->cls,
1174                                uri_address,
1175                                strlen (uri_address) + 1,
1176                                &addr,
1177                                &addr_len))
1178   {
1179     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1180                 _("Failed to parse `%s' as an address for plugin `%s'\n"),
1181                 uri_address,
1182                 plugin_name);
1183     GNUNET_free (plugin_name);
1184     GNUNET_free (uri_address);
1185     return 0;
1186   }
1187   GNUNET_free (uri_address);
1188   /* address.peer is unset - not used by add_address() */
1189   haddr.address_length = addr_len;
1190   haddr.address = addr;
1191   haddr.transport_name = plugin_name;
1192   ret = GNUNET_HELLO_add_address (&haddr,
1193                                   expire,
1194                                   buffer,
1195                                   max);
1196   ctx->counter_added ++;
1197   GNUNET_free (addr);
1198   GNUNET_free (plugin_name);
1199   return ret;
1200 }
1201
1202
1203 /**
1204  * Parse a hello URI string to a hello message.
1205  *
1206  * @param uri URI string to parse
1207  * @param pubkey Pointer to struct where public key is parsed
1208  * @param hello Pointer to struct where hello message is parsed
1209  * @param plugins_find Function to find transport plugins by name
1210  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the URI was invalid, #GNUNET_NO on other errors
1211  */
1212 int
1213 GNUNET_HELLO_parse_uri (const char *uri,
1214                         struct GNUNET_CRYPTO_EddsaPublicKey *pubkey,
1215                         struct GNUNET_HELLO_Message **hello,
1216                         GNUNET_HELLO_TransportPluginsFind plugins_find)
1217 {
1218   const char *pks;
1219   const char *exc;
1220   int friend_only;
1221   struct GNUNET_HELLO_ParseUriContext ctx;
1222
1223   if (0 == strncmp (uri,
1224                     GNUNET_HELLO_URI_PREFIX,
1225                     strlen (GNUNET_HELLO_URI_PREFIX)))
1226   {
1227     pks = &uri[strlen (GNUNET_HELLO_URI_PREFIX)];
1228     friend_only = GNUNET_NO;
1229   }
1230   else if (0 == strncmp (uri,
1231             GNUNET_FRIEND_HELLO_URI_PREFIX,
1232             strlen (GNUNET_FRIEND_HELLO_URI_PREFIX)))
1233   {
1234     pks = &uri[strlen (GNUNET_FRIEND_HELLO_URI_PREFIX)];
1235     friend_only = GNUNET_YES;
1236   }
1237   else
1238     return GNUNET_SYSERR;
1239   exc = strchr (pks, GNUNET_HELLO_URI_SEP);
1240
1241   if (GNUNET_OK !=
1242       GNUNET_STRINGS_string_to_data (pks,
1243                                      (NULL == exc) ? strlen (pks) : (exc - pks),
1244                                      (unsigned char *) pubkey,
1245                                      sizeof (*pubkey)))
1246     return GNUNET_SYSERR;
1247
1248   ctx.pos = exc;
1249   ctx.ret = GNUNET_OK;
1250   ctx.counter_total = 0;
1251   ctx.counter_added = 0;
1252   ctx.plugins_find = plugins_find;
1253   *hello = GNUNET_HELLO_create (pubkey,
1254                                 &add_address_to_hello,
1255                                 &ctx,
1256                                 friend_only);
1257
1258   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1259               "HELLO URI contained %u addresses, added %u addresses\n",
1260               ctx.counter_total,
1261               ctx.counter_added);
1262
1263   return ctx.ret;
1264 }
1265
1266
1267 /* end of hello.c */