src/transport/gnunet-service-transport_validation.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010-2015 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 transport/gnunet-service-transport_validation.c
  23  * @brief address validation subsystem
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-transport_ats.h"
  28 #include "gnunet-service-transport_blacklist.h"
  29 #include "gnunet-service-transport_clients.h"
  30 #include "gnunet-service-transport_hello.h"
  31 #include "gnunet-service-transport_neighbours.h"
  32 #include "gnunet-service-transport_plugins.h"
  33 #include "gnunet-service-transport_validation.h"
  34 #include "gnunet-service-transport.h"
  35 #include "gnunet_hello_lib.h"
  36 #include "gnunet_ats_service.h"
  37 #include "gnunet_peerinfo_service.h"
  38 #include "gnunet_signatures.h"
  39
  40
  41 /**
  42  * How long is a PONG signature valid?  We'll recycle a signature until
  43  * 1/4 of this time is remaining.  PONGs should expire so that if our
  44  * external addresses change an adversary cannot replay them indefinitely.
  45  * OTOH, we don't want to spend too much time generating PONG signatures,
  46  * so they must have some lifetime to reduce our CPU usage.
  47  */
  48 #define PONG_SIGNATURE_LIFETIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
  49
  50 /**
  51  * After how long do we expire an address in a HELLO that we just
  52  * validated?  This value is also used for our own addresses when we
  53  * create a HELLO.
  54  */
  55 #define HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
  56
  57 /**
  58  * How often do we allow PINGing an address that we have not yet
  59  * validated?  This also determines how long we track an address that
  60  * we cannot validate (because after this time we can destroy the
  61  * validation record).
  62  */
  63 #define UNVALIDATED_PING_KEEPALIVE GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
  64
  65 /**
  66  * How often do we PING an address that we have successfully validated
  67  * in the past but are not actively using?  Should be (significantly)
  68  * smaller than HELLO_ADDRESS_EXPIRATION.
  69  */
  70 #define VALIDATED_PING_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
  71
  72 /**
  73  * How often do we PING an address that we are currently using?
  74  */
  75 #define CONNECTED_PING_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
  76
  77 /**
  78  * How much delay is acceptable for sending the PING or PONG?
  79  */
  80 #define ACCEPTABLE_PING_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
  81
  82 /**
  83  * Size of the validation map hashmap.
  84  */
  85 #define VALIDATION_MAP_SIZE 256
  86
  87 /**
  88  * Priority to use for PINGs
  89  */
  90 #define PING_PRIORITY 2
  91
  92 /**
  93  * Priority to use for PONGs
  94  */
  95 #define PONG_PRIORITY 4
  96
  97
  98 GNUNET_NETWORK_STRUCT_BEGIN
  99
 100 /**
 101  * Message used to ask a peer to validate receipt (to check an address
 102  * from a HELLO).  Followed by the address we are trying to validate,
 103  * or an empty address if we are just sending a PING to confirm that a
 104  * connection which the receiver (of the PING) initiated is still valid.
 105  */
 106 struct TransportPingMessage
 107 {
 108
 109   /**
 110    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_PING
 111    */
 112   struct GNUNET_MessageHeader header;
 113
 114   /**
 115    * Challenge code (to ensure fresh reply).
 116    */
 117   uint32_t challenge GNUNET_PACKED;
 118
 119   /**
 120    * Who is the intended recipient?
 121    */
 122   struct GNUNET_PeerIdentity target;
 123
 124 };
 125
 126
 127 /**
 128  * Message used to validate a HELLO.  The challenge is included in the
 129  * confirmation to make matching of replies to requests possible.  The
 130  * signature signs our public key, an expiration time and our address.<p>
 131  *
 132  * This message is followed by our transport address that the PING tried
 133  * to confirm (if we liked it).  The address can be empty (zero bytes)
 134  * if the PING had not address either (and we received the request via
 135  * a connection that we initiated).
 136  */
 137 struct TransportPongMessage
 138 {
 139
 140   /**
 141    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_PONG
 142    */
 143   struct GNUNET_MessageHeader header;
 144
 145   /**
 146    * Challenge code from PING (showing freshness).  Not part of what
 147    * is signed so that we can re-use signatures.
 148    */
 149   uint32_t challenge GNUNET_PACKED;
 150
 151   /**
 152    * Signature.
 153    */
 154   struct GNUNET_CRYPTO_EddsaSignature signature;
 155
 156   /**
 157    * #GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN to confirm that this is a
 158    * plausible address for the signing peer.
 159    */
 160   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 161
 162   /**
 163    * When does this signature expire?
 164    */
 165   struct GNUNET_TIME_AbsoluteNBO expiration;
 166
 167   /**
 168    * Size of address appended to this message (part of what is
 169    * being signed, hence not redundant).
 170    */
 171   uint32_t addrlen GNUNET_PACKED;
 172
 173 };
 174 GNUNET_NETWORK_STRUCT_END
 175
 176 /**
 177  * Information about an address under validation
 178  */
 179 struct ValidationEntry
 180 {
 181
 182   /**
 183    * The address.
 184    */
 185   struct GNUNET_HELLO_Address *address;
 186
 187   /**
 188    * Handle to the blacklist check (if we're currently in it).
 189    */
 190   struct GST_BlacklistCheck *bc;
 191
 192   /**
 193    * Cached PONG signature
 194    */
 195   struct GNUNET_CRYPTO_EddsaSignature pong_sig_cache;
 196
 197   /**
 198    * ID of task that will clean up this entry if nothing happens.
 199    */
 200   struct GNUNET_SCHEDULER_Task *timeout_task;
 201
 202   /**
 203    * ID of task that will trigger address revalidation.
 204    */
 205   struct GNUNET_SCHEDULER_Task *revalidation_task;
 206
 207   /**
 208    * At what time did we send the latest validation request (PING)?
 209    */
 210   struct GNUNET_TIME_Absolute send_time;
 211
 212   /**
 213    * At what time do we send the next validation request (PING)?
 214    */
 215   struct GNUNET_TIME_Absolute next_validation;
 216
 217   /**
 218    * Until when is this address valid?
 219    * ZERO if it is not currently considered valid.
 220    */
 221   struct GNUNET_TIME_Absolute valid_until;
 222
 223   /**
 224    * Until when is the cached PONG signature valid?
 225    * ZERO if it is not currently considered valid.
 226    */
 227   struct GNUNET_TIME_Absolute pong_sig_valid_until;
 228
 229   /**
 230    * How long until we can try to validate this address again?
 231    * FOREVER if the address is for an unsupported plugin (from PEERINFO)
 232    * ZERO if the address is considered valid (no validation needed)
 233    * otherwise a time in the future if we're currently denying re-validation
 234    */
 235   struct GNUNET_TIME_Absolute revalidation_block;
 236
 237   /**
 238    * Last observed latency for this address (round-trip), delay between
 239    * last PING sent and PONG received; FOREVER if we never got a PONG.
 240    */
 241   struct GNUNET_TIME_Relative latency;
 242
 243   /**
 244    * Current state of this validation entry
 245    */
 246   enum GNUNET_TRANSPORT_ValidationState state;
 247
 248   /**
 249    * Challenge number we used.
 250    */
 251   uint32_t challenge;
 252
 253   /**
 254    * When passing the address in #add_valid_peer_address(), did we
 255    * copy the address to the HELLO yet?
 256    */
 257   int copied;
 258
 259   /**
 260    * Are we currently using this address for a connection?
 261    */
 262   int in_use;
 263
 264   /**
 265    * Are we expecting a PONG message for this validation entry?
 266    */
 267   int expecting_pong;
 268
 269   /**
 270    * Is this address known to ATS as valid right now?
 271    */
 272   int known_to_ats;
 273
 274   /**
 275    * Which network type does our address belong to?
 276    */
 277   enum GNUNET_ATS_Network_Type network;
 278 };
 279
 280
 281 /**
 282  * Map of PeerIdentities to 'struct ValidationEntry*'s (addresses
 283  * of the given peer that we are currently validating, have validated
 284  * or are blocked from re-validation for a while).
 285  */
 286 static struct GNUNET_CONTAINER_MultiPeerMap *validation_map;
 287
 288 /**
 289  * Context for peerinfo iteration.
 290  */
 291 static struct GNUNET_PEERINFO_NotifyContext *pnc;
 292
 293 /**
 294  * Minimum delay between to validations
 295  */
 296 static struct GNUNET_TIME_Relative validation_delay;
 297
 298 /**
 299  * Number of validations running; any PING that was not yet
 300  * matched by a PONG and for which we have not yet hit the
 301  * timeout is considered a running 'validation'.
 302  */
 303 static unsigned int validations_running;
 304
 305 /**
 306  * Validition fast start threshold
 307  */
 308 static unsigned int validations_fast_start_threshold;
 309
 310 /**
 311  * When is next validation allowed
 312  */
 313 static struct GNUNET_TIME_Absolute validation_next;
 314
 315
 316 /**
 317  * Context for the validation entry match function.
 318  */
 319 struct ValidationEntryMatchContext
 320 {
 321   /**
 322    * Where to store the result?
 323    */
 324   struct ValidationEntry *ve;
 325
 326   /**
 327    * Address we're interested in.
 328    */
 329   const struct GNUNET_HELLO_Address *address;
 330
 331 };
 332
 333
 334 /**
 335  * Provide an update on the `validation_map` map size to statistics.
 336  * This function should be called whenever the `validation_map`
 337  * is changed.
 338  */
 339 static void
 340 publish_ve_stat_update ()
 341 {
 342   GNUNET_STATISTICS_set (GST_stats,
 343                          gettext_noop ("# Addresses in validation map"),
 344                          GNUNET_CONTAINER_multipeermap_size (validation_map),
 345                          GNUNET_NO);
 346 }
 347
 348
 349 /**
 350  * Iterate over validation entries until a matching one is found.
 351  *
 352  * @param cls the `struct ValidationEntryMatchContext *`
 353  * @param key peer identity (unused)
 354  * @param value a `struct ValidationEntry *` to match
 355  * @return #GNUNET_YES if the entry does not match,
 356  *         #GNUNET_NO if the entry does match
 357  */
 358 static int
 359 validation_entry_match (void *cls,
 360                         const struct GNUNET_PeerIdentity *key,
 361                         void *value)
 362 {
 363   struct ValidationEntryMatchContext *vemc = cls;
 364   struct ValidationEntry *ve = value;
 365
 366   if (0 == GNUNET_HELLO_address_cmp (ve->address,
 367                                      vemc->address))
 368   {
 369     vemc->ve = ve;
 370     return GNUNET_NO;
 371   }
 372   return GNUNET_YES;
 373 }
 374
 375
 376 /**
 377  * A validation entry changed.  Update the state and notify
 378  * monitors.
 379  *
 380  * @param ve validation entry that changed
 381  * @param state new state
 382  */
 383 static void
 384 validation_entry_changed (struct ValidationEntry *ve,
 385                           enum GNUNET_TRANSPORT_ValidationState state)
 386 {
 387   ve->state = state;
 388   GST_clients_broadcast_validation_notification (&ve->address->peer,
 389                                                  ve->address,
 390                                                  ve->send_time,
 391                                                  ve->valid_until,
 392                                                  ve->next_validation,
 393                                                  state);
 394 }
 395
 396
 397 /**
 398  * Iterate over validation entries and free them.
 399  *
 400  * @param cls (unused)
 401  * @param key peer identity (unused)
 402  * @param value a `struct ValidationEntry *` to clean up
 403  * @return #GNUNET_YES (continue to iterate)
 404  */
 405 static int
 406 cleanup_validation_entry (void *cls,
 407                           const struct GNUNET_PeerIdentity *key,
 408                           void *value)
 409 {
 410   struct ValidationEntry *ve = value;
 411
 412   ve->next_validation = GNUNET_TIME_UNIT_ZERO_ABS;
 413   ve->valid_until = GNUNET_TIME_UNIT_ZERO_ABS;
 414
 415   /* Notify about deleted entry */
 416   validation_entry_changed (ve,
 417                             GNUNET_TRANSPORT_VS_REMOVE);
 418
 419   if (NULL != ve->bc)
 420   {
 421     GST_blacklist_test_cancel (ve->bc);
 422     ve->bc = NULL;
 423   }
 424   GNUNET_break (GNUNET_OK ==
 425                 GNUNET_CONTAINER_multipeermap_remove (validation_map,
 426                                                       &ve->address->peer,
 427                                                       ve));
 428   publish_ve_stat_update ();
 429   if (GNUNET_YES == ve->known_to_ats)
 430   {
 431     GST_ats_expire_address (ve->address);
 432     ve->known_to_ats = GNUNET_NO;
 433   }
 434   GNUNET_HELLO_address_free (ve->address);
 435   if (NULL != ve->timeout_task)
 436   {
 437     GNUNET_SCHEDULER_cancel (ve->timeout_task);
 438     ve->timeout_task = NULL;
 439   }
 440   if (NULL != ve->revalidation_task)
 441   {
 442     GNUNET_SCHEDULER_cancel (ve->revalidation_task);
 443     ve->revalidation_task = NULL;
 444   }
 445   if ( (GNUNET_YES == ve->expecting_pong) &&
 446        (validations_running > 0) )
 447   {
 448     validations_running--;
 449     GNUNET_STATISTICS_set (GST_stats,
 450                            gettext_noop ("# validations running"),
 451                            validations_running,
 452                            GNUNET_NO);
 453   }
 454   GNUNET_free (ve);
 455   return GNUNET_OK;
 456 }
 457
 458
 459 /**
 460  * Address validation cleanup task.  Assesses if the record is no
 461  * longer valid and then possibly triggers its removal.
 462  *
 463  * @param cls the `struct ValidationEntry`
 464  * @param tc scheduler context (unused)
 465  */
 466 static void
 467 timeout_hello_validation (void *cls,
 468                           const struct GNUNET_SCHEDULER_TaskContext *tc)
 469 {
 470   struct ValidationEntry *ve = cls;
 471   struct GNUNET_TIME_Absolute max;
 472   struct GNUNET_TIME_Relative left;
 473
 474   ve->timeout_task = NULL;
 475   /* For valid addresses, we want to wait until the expire;
 476      for addresses under PING validation, we want to wait
 477      until we give up on the PING */
 478   max = GNUNET_TIME_absolute_max (ve->valid_until,
 479                                   ve->revalidation_block);
 480   left = GNUNET_TIME_absolute_get_remaining (max);
 481   if (left.rel_value_us > 0)
 482   {
 483     /* We should wait a bit longer. This happens when
 484        address lifetimes are extended due to successful
 485        validations. */
 486     ve->timeout_task =
 487         GNUNET_SCHEDULER_add_delayed (left,
 488                                       &timeout_hello_validation,
 489                                       ve);
 490     return;
 491   }
 492   GNUNET_STATISTICS_update (GST_stats,
 493                             gettext_noop ("# address records discarded (timeout)"),
 494                             1,
 495                             GNUNET_NO);
 496   cleanup_validation_entry (NULL,
 497                             &ve->address->peer,
 498                             ve);
 499 }
 500
 501
 502 /**
 503  * Function called with the result from blacklisting.
 504  * Send a PING to the other peer if a communication is allowed.
 505  *
 506  * @param cls our `struct ValidationEntry`
 507  * @param pid identity of the other peer
 508  * @param address_null address associated with the request, always NULL
 509  * @param session_null session associated with the request, always NULL
 510  * @param result #GNUNET_OK if the connection is allowed,
 511  *               #GNUNET_NO if not,
 512  *               #GNUNET_SYSERR if operation was aborted
 513  */
 514 static void
 515 transmit_ping_if_allowed (void *cls,
 516                           const struct GNUNET_PeerIdentity *pid,
 517                           const struct GNUNET_HELLO_Address *address_null,
 518                           struct Session *session_null,
 519                           int result)
 520 {
 521   struct ValidationEntry *ve = cls;
 522   struct TransportPingMessage ping;
 523   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 524   struct GNUNET_TIME_Absolute next;
 525   const struct GNUNET_MessageHeader *hello;
 526   ssize_t ret;
 527   size_t tsize;
 528   size_t slen;
 529   uint16_t hsize;
 530   struct Session *session;
 531
 532   ve->bc = NULL;
 533   if (GNUNET_OK != result)
 534   {
 535     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 536                 "Blacklist denies sending PING to `%s' `%s' `%s'\n",
 537                 GNUNET_i2s (pid),
 538                 GST_plugins_a2s (ve->address),
 539                 ve->address->transport_name);
 540     GNUNET_STATISTICS_update (GST_stats,
 541                               gettext_noop ("# address records discarded (blacklist)"),
 542                               1,
 543                               GNUNET_NO);
 544     cleanup_validation_entry (NULL,
 545                               pid,
 546                               ve);
 547     return;
 548   }
 549   hello = GST_hello_get ();
 550   GNUNET_assert (NULL != hello);
 551   slen = strlen (ve->address->transport_name) + 1;
 552   hsize = ntohs (hello->size);
 553   tsize = sizeof (struct TransportPingMessage) +
 554     ve->address->address_length + slen + hsize;
 555
 556   ping.header.size =
 557       htons (sizeof (struct TransportPingMessage) +
 558              ve->address->address_length + slen);
 559   ping.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_PING);
 560   ping.challenge = htonl (ve->challenge);
 561   ping.target = *pid;
 562
 563   if (tsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 564   {
 565     GNUNET_break (0);
 566     hsize = 0;
 567     tsize =
 568         sizeof (struct TransportPingMessage) + ve->address->address_length +
 569         slen + hsize;
 570   }
 571   {
 572     char message_buf[tsize] GNUNET_ALIGN;
 573
 574     memcpy (message_buf,
 575             hello,
 576             hsize);
 577     memcpy (&message_buf[hsize],
 578             &ping,
 579             sizeof (struct TransportPingMessage));
 580     memcpy (&message_buf[sizeof (struct TransportPingMessage) + hsize],
 581             ve->address->transport_name,
 582             slen);
 583     memcpy (&message_buf[sizeof (struct TransportPingMessage) + slen + hsize],
 584             ve->address->address,
 585             ve->address->address_length);
 586     papi = GST_plugins_find (ve->address->transport_name);
 587     GNUNET_assert (NULL != papi);
 588     session = papi->get_session (papi->cls,
 589                                  ve->address);
 590     if (NULL == session)
 591     {
 592       /* Could not get a valid session */
 593       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 594                   "Failed to get session to send PING to `%s' at `%s'\n",
 595                   GNUNET_i2s (pid),
 596                   GST_plugins_a2s (ve->address));
 597       return;
 598     }
 599
 600     ret = papi->send (papi->cls, session,
 601                       message_buf, tsize,
 602                       PING_PRIORITY,
 603                       ACCEPTABLE_PING_DELAY,
 604                       NULL, NULL);
 605     if (-1 == ret)
 606     {
 607       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 608                   "Failed to send PING to `%s' at `%s'\n",
 609                   GNUNET_i2s (pid),
 610                   GST_plugins_a2s (ve->address));
 611       return;
 612     }
 613     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 614                 "Transmitted plain PING to `%s' `%s' `%s'\n",
 615                 GNUNET_i2s (pid),
 616                 GST_plugins_a2s (ve->address),
 617                 ve->address->transport_name);
 618     ve->network = papi->get_network (papi->cls,
 619                                      session);
 620     GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != ve->network);
 621     GST_neighbours_notify_data_sent (ve->address,
 622                                      session,
 623                                      tsize);
 624     next = GNUNET_TIME_relative_to_absolute (validation_delay);
 625     validation_next = GNUNET_TIME_absolute_max (next,
 626                                                 validation_next);
 627     ve->send_time = GNUNET_TIME_absolute_get ();
 628     GNUNET_STATISTICS_update (GST_stats,
 629                               gettext_noop ("# PINGs for address validation sent"),
 630                               1,
 631                               GNUNET_NO);
 632     ve->expecting_pong = GNUNET_YES;
 633     validations_running++;
 634     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 635                 "Validation started, %u validation processes running\n",
 636                 validations_running);
 637     GNUNET_STATISTICS_set (GST_stats,
 638                            gettext_noop ("# validations running"),
 639                            validations_running,
 640                            GNUNET_NO);
 641     /*  Notify about PING sent */
 642     validation_entry_changed (ve,
 643                               GNUNET_TRANSPORT_VS_UPDATE);
 644
 645   }
 646 }
 647
 648
 649 /**
 650  * Do address validation again to keep address valid.
 651  *
 652  * @param cls the `struct ValidationEntry`
 653  * @param tc scheduler context (unused)
 654  */
 655 static void
 656 revalidate_address (void *cls,
 657                     const struct GNUNET_SCHEDULER_TaskContext *tc)
 658 {
 659   struct ValidationEntry *ve = cls;
 660   struct GNUNET_TIME_Relative canonical_delay;
 661   struct GNUNET_TIME_Relative delay;
 662   struct GNUNET_TIME_Relative blocked_for;
 663   struct GST_BlacklistCheck *bc;
 664   uint32_t rdelay;
 665
 666   ve->revalidation_task = NULL;
 667   delay = GNUNET_TIME_absolute_get_remaining (ve->revalidation_block);
 668   /* Considering current connectivity situation, what is the maximum
 669      block period permitted? */
 670   if (GNUNET_YES == ve->in_use)
 671     canonical_delay = CONNECTED_PING_FREQUENCY;
 672   else if (GNUNET_TIME_absolute_get_remaining (ve->valid_until).rel_value_us > 0)
 673     canonical_delay = VALIDATED_PING_FREQUENCY;
 674   else
 675     canonical_delay = UNVALIDATED_PING_KEEPALIVE;
 676   /* Use delay that is MIN of original delay and possibly adjusted
 677      new maximum delay (which may be lower); the real delay
 678      is originally randomized between "canonical_delay" and "2 * canonical_delay",
 679      so continue to permit that window for the operation. */
 680   delay = GNUNET_TIME_relative_min (delay,
 681                                     GNUNET_TIME_relative_multiply (canonical_delay,
 682                                                                    2));
 683   ve->revalidation_block = GNUNET_TIME_relative_to_absolute (delay);
 684   if (delay.rel_value_us > 0)
 685   {
 686     /* should wait a bit longer */
 687     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 688                 "Waiting for %s longer before (re)validating address `%s'\n",
 689                 GNUNET_STRINGS_relative_time_to_string (delay,
 690                                                         GNUNET_YES),
 691                 GST_plugins_a2s (ve->address));
 692     ve->revalidation_task =
 693         GNUNET_SCHEDULER_add_delayed (delay,
 694                                       &revalidate_address, ve);
 695     ve->next_validation = GNUNET_TIME_relative_to_absolute (delay);
 696     return;
 697   }
 698   /* check if globally we have too many active validations at a
 699      too high rate, if so, delay ours */
 700   blocked_for = GNUNET_TIME_absolute_get_remaining (validation_next);
 701   if ( (validations_running > validations_fast_start_threshold) &&
 702        (blocked_for.rel_value_us > 0) )
 703   {
 704     /* Validations are blocked, have to wait for blocked_for time */
 705     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 706                 "Validations blocked for another %s, delaying validating address `%s'\n",
 707                 GNUNET_STRINGS_relative_time_to_string (blocked_for,
 708                                                         GNUNET_YES),
 709                 GST_plugins_a2s (ve->address));
 710     GNUNET_STATISTICS_update (GST_stats,
 711                               gettext_noop ("# validations delayed by global throttle"),
 712                               1,
 713                               GNUNET_NO);
 714     ve->revalidation_task =
 715       GNUNET_SCHEDULER_add_delayed (blocked_for,
 716                                     &revalidate_address,
 717                                     ve);
 718     ve->next_validation = GNUNET_TIME_relative_to_absolute (blocked_for);
 719     return;
 720   }
 721
 722   /* We are good to go; remember to not go again for `canonical_delay` time;
 723      add up to `canonical_delay` to randomize start time */
 724   ve->revalidation_block = GNUNET_TIME_relative_to_absolute (canonical_delay);
 725   /* schedule next PINGing with some extra random delay to avoid synchronous re-validations */
 726   rdelay =
 727       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 728                                 canonical_delay.rel_value_us);
 729
 730   delay = GNUNET_TIME_relative_add (canonical_delay,
 731                                     GNUNET_TIME_relative_multiply
 732                                     (GNUNET_TIME_UNIT_MICROSECONDS,
 733                                      rdelay));
 734
 735   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 736               "Validating now, next scheduled for %s, now validating address `%s'\n",
 737               GNUNET_STRINGS_relative_time_to_string (blocked_for,
 738                                                       GNUNET_YES),
 739               GST_plugins_a2s (ve->address));
 740   ve->revalidation_task =
 741       GNUNET_SCHEDULER_add_delayed (delay,
 742                                     &revalidate_address,
 743                                     ve);
 744   ve->next_validation = GNUNET_TIME_relative_to_absolute (delay);
 745
 746   /* start PINGing by checking blacklist */
 747   GNUNET_STATISTICS_update (GST_stats,
 748                             gettext_noop ("# address revalidations started"), 1,
 749                             GNUNET_NO);
 750   bc = GST_blacklist_test_allowed (&ve->address->peer,
 751                                    ve->address->transport_name,
 752                                    &transmit_ping_if_allowed,
 753                                    ve,
 754                                    NULL,
 755                                    NULL);
 756   if (NULL != bc)
 757     ve->bc = bc;                /* only set 'bc' if 'transmit_ping_if_allowed' was not already
 758                                  * called... */
 759 }
 760
 761
 762 /**
 763  * Find a ValidationEntry entry for the given neighbour that matches
 764  * the given address and transport.  If none exists, create one (but
 765  * without starting any validation).
 766  *
 767  * @param address address to find
 768  * @return validation entry matching the given specifications, NULL
 769  *         if we don't have an existing entry and no public key was given
 770  */
 771 static struct ValidationEntry *
 772 find_validation_entry (const struct GNUNET_HELLO_Address *address)
 773 {
 774   struct ValidationEntryMatchContext vemc;
 775   struct ValidationEntry *ve;
 776
 777   vemc.ve = NULL;
 778   vemc.address = address;
 779   GNUNET_CONTAINER_multipeermap_get_multiple (validation_map,
 780                                               &address->peer,
 781                                               &validation_entry_match, &vemc);
 782   if (NULL != (ve = vemc.ve))
 783     return ve;
 784   ve = GNUNET_new (struct ValidationEntry);
 785   ve->in_use = GNUNET_SYSERR; /* not defined */
 786   ve->address = GNUNET_HELLO_address_copy (address);
 787   ve->pong_sig_valid_until = GNUNET_TIME_UNIT_ZERO_ABS;
 788   memset (&ve->pong_sig_cache, '\0', sizeof (struct GNUNET_CRYPTO_EddsaSignature));
 789   ve->latency = GNUNET_TIME_UNIT_FOREVER_REL;
 790   ve->challenge =
 791       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
 792   ve->timeout_task =
 793       GNUNET_SCHEDULER_add_delayed (UNVALIDATED_PING_KEEPALIVE,
 794                                     &timeout_hello_validation,
 795                                     ve);
 796   GNUNET_CONTAINER_multipeermap_put (validation_map,
 797                                      &address->peer,
 798                                      ve,
 799                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 800   publish_ve_stat_update ();
 801   validation_entry_changed (ve,
 802                             GNUNET_TRANSPORT_VS_NEW);
 803   return ve;
 804 }
 805
 806
 807 /**
 808  * Iterator which adds the given address to the set of validated
 809  * addresses.
 810  *
 811  * @param cls original HELLO message
 812  * @param address the address
 813  * @param expiration expiration time
 814  * @return #GNUNET_OK (keep the address), could return
 815  *         #GNUNET_NO (delete address, but this is ignored);
 816  *         #GNUNET_SYSERR would abort iteration (but we always iterate all)
 817  */
 818 static int
 819 add_valid_address (void *cls,
 820                    const struct GNUNET_HELLO_Address *address,
 821                    struct GNUNET_TIME_Absolute expiration)
 822 {
 823   const struct GNUNET_HELLO_Message *hello = cls;
 824   struct ValidationEntry *ve;
 825   struct GNUNET_PeerIdentity pid;
 826   struct GNUNET_ATS_Properties prop;
 827
 828   if (0 == GNUNET_TIME_absolute_get_remaining (expiration).rel_value_us)
 829     return GNUNET_OK;           /* expired */
 830   if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
 831   {
 832     GNUNET_break (0);
 833     return GNUNET_OK;           /* invalid HELLO !? */
 834   }
 835   if (NULL == GST_plugins_find (address->transport_name))
 836   {
 837     /* might have been valid in the past, but we don't have that
 838        plugin loaded right now */
 839     return GNUNET_OK;
 840   }
 841
 842   ve = find_validation_entry (address);
 843   ve->valid_until = GNUNET_TIME_absolute_max (ve->valid_until,
 844                                               expiration);
 845   if (NULL == ve->revalidation_task)
 846   {
 847     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 848                 "Starting revalidations for valid address `%s'\n",
 849                 GST_plugins_a2s (ve->address));
 850     ve->next_validation = GNUNET_TIME_absolute_get();
 851     ve->revalidation_task = GNUNET_SCHEDULER_add_now (&revalidate_address, ve);
 852   }
 853   validation_entry_changed (ve,
 854                             GNUNET_TRANSPORT_VS_UPDATE);
 855   memset (&prop, 0, sizeof (prop));
 856   prop.scope = ve->network;
 857   prop.delay = GNUNET_TIME_relative_divide (ve->latency, 2);
 858   if (GNUNET_YES != ve->known_to_ats)
 859   {
 860     ve->known_to_ats = GNUNET_YES;
 861     GST_ats_add_address (address, &prop);
 862   }
 863   return GNUNET_OK;
 864 }
 865
 866
 867 /**
 868  * Function called for any HELLO known to PEERINFO.
 869  *
 870  * @param cls unused (NULL)
 871  * @param peer id of the peer, NULL for last call (during iteration,
 872  *             as we are monitoring, this should never happen)
 873  * @param hello hello message for the peer (can be NULL)
 874  * @param err_msg error message
 875  */
 876 static void
 877 process_peerinfo_hello (void *cls,
 878                         const struct GNUNET_PeerIdentity *peer,
 879                         const struct GNUNET_HELLO_Message *hello,
 880                         const char *err_msg)
 881 {
 882   GNUNET_assert (NULL != peer);
 883   if (NULL == hello)
 884     return;
 885   if (0 == memcmp (&GST_my_identity,
 886                    peer,
 887                    sizeof (struct GNUNET_PeerIdentity)))
 888   {
 889     /* Peerinfo returned own identity, skip validation */
 890     return;
 891   }
 892   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 893               "Handling HELLO for peer `%s'\n",
 894               GNUNET_i2s (peer));
 895   GNUNET_assert (NULL ==
 896                  GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO,
 897                                                  &add_valid_address,
 898                                                  (void *) hello));
 899 }
 900
 901
 902 /**
 903  * Start the validation subsystem.
 904  *
 905  * @param max_fds maximum number of fds to use
 906  */
 907 void
 908 GST_validation_start (unsigned int max_fds)
 909 {
 910   /**
 911    * Initialization for validation throttling
 912    *
 913    * We have a maximum number max_fds of connections we can use for validation
 914    * We monitor the number of validations in parallel and start to throttle it
 915    * when doing to many validations in parallel:
 916    * if (running validations < (max_fds / 2))
 917    * - "fast start": run validation immediately
 918    * - have delay of (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us) / (max_fds / 2)
 919    *   (300 sec / ~150 == ~2 sec.) between two validations
 920    */
 921
 922   validation_next = GNUNET_TIME_absolute_get();
 923   validation_delay.rel_value_us = (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us) / (max_fds / 2);
 924   validations_fast_start_threshold = (max_fds / 2);
 925   validations_running = 0;
 926   GNUNET_STATISTICS_set (GST_stats,
 927                          gettext_noop ("# validations running"),
 928                          validations_running,
 929                          GNUNET_NO);
 930   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 931               "Validation uses a fast start threshold of %u connections and a delay of %s\n",
 932               validations_fast_start_threshold,
 933               GNUNET_STRINGS_relative_time_to_string (validation_delay,
 934                                                       GNUNET_YES));
 935   validation_map = GNUNET_CONTAINER_multipeermap_create (VALIDATION_MAP_SIZE,
 936                                                          GNUNET_NO);
 937   pnc = GNUNET_PEERINFO_notify (GST_cfg, GNUNET_YES,
 938                                 &process_peerinfo_hello, NULL);
 939 }
 940
 941
 942 /**
 943  * Stop the validation subsystem.
 944  */
 945 void
 946 GST_validation_stop ()
 947 {
 948   GNUNET_CONTAINER_multipeermap_iterate (validation_map,
 949                                          &cleanup_validation_entry,
 950                                          NULL);
 951   GNUNET_CONTAINER_multipeermap_destroy (validation_map);
 952   validation_map = NULL;
 953   GNUNET_PEERINFO_notify_cancel (pnc);
 954 }
 955
 956
 957 /**
 958  * Send the given PONG to the given address.
 959  *
 960  * @param cls the PONG message
 961  * @param valid_until is ZERO if we never validated the address,
 962  *                    otherwise a time up to when we consider it (or was) valid
 963  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
 964  *                          is ZERO if the address is considered valid (no validation needed)
 965  *                          otherwise a time in the future if we're currently denying re-validation
 966  * @param address target address
 967  */
 968 static void
 969 multicast_pong (void *cls,
 970                 struct GNUNET_TIME_Absolute valid_until,
 971                 struct GNUNET_TIME_Absolute validation_block,
 972                 const struct GNUNET_HELLO_Address *address)
 973 {
 974   struct TransportPongMessage *pong = cls;
 975   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 976   struct Session *session;
 977
 978   papi = GST_plugins_find (address->transport_name);
 979   if (NULL == papi)
 980   {
 981     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 982                 "Plugin %s not supported, cannot send PONG\n",
 983                 address->transport_name);
 984     return;
 985   }
 986   GNUNET_assert (NULL != papi->send);
 987   GNUNET_assert (NULL != papi->get_session);
 988   session = papi->get_session(papi->cls, address);
 989   if (NULL == session)
 990   {
 991      GNUNET_break (0);
 992      return;
 993   }
 994   GST_ats_new_session (address, session);
 995   papi->send (papi->cls, session,
 996               (const char *) pong,
 997               ntohs (pong->header.size),
 998               PONG_PRIORITY,
 999               ACCEPTABLE_PING_DELAY,
1000               NULL, NULL);
1001   GST_neighbours_notify_data_sent (address,
1002                                    session,
1003                                    pong->header.size);
1004 }
1005
1006
1007 /**
1008  * We've received a PING.  If appropriate, generate a PONG.
1009  *
1010  * @param sender peer sending the PING
1011  * @param hdr the PING
1012  * @param sender_address the sender address as we got it
1013  * @param session session we got the PING from
1014  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
1015  */
1016 int
1017 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
1018                             const struct GNUNET_MessageHeader *hdr,
1019                             const struct GNUNET_HELLO_Address *sender_address,
1020                             struct Session *session)
1021 {
1022   const struct TransportPingMessage *ping;
1023   struct TransportPongMessage *pong;
1024   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1025   struct GNUNET_CRYPTO_EddsaSignature *sig_cache;
1026   struct GNUNET_TIME_Absolute *sig_cache_exp;
1027   const char *addr;
1028   const char *addrend;
1029   char *plugin_name;
1030   char *pos;
1031   size_t len_address;
1032   size_t len_plugin;
1033   ssize_t ret;
1034   struct GNUNET_HELLO_Address address;
1035
1036   if (ntohs (hdr->size) < sizeof (struct TransportPingMessage))
1037   {
1038     GNUNET_break_op (0);
1039     return GNUNET_SYSERR;
1040   }
1041   ping = (const struct TransportPingMessage *) hdr;
1042   if (0 !=
1043       memcmp (&ping->target, &GST_my_identity,
1044               sizeof (struct GNUNET_PeerIdentity)))
1045   {
1046     GNUNET_STATISTICS_update (GST_stats,
1047                               gettext_noop
1048                               ("# PING message for different peer received"), 1,
1049                               GNUNET_NO);
1050     return GNUNET_SYSERR;
1051   }
1052   GNUNET_STATISTICS_update (GST_stats,
1053                             gettext_noop ("# PING messages received"), 1,
1054                             GNUNET_NO);
1055   addr = (const char *) &ping[1];
1056   len_address = ntohs (hdr->size) - sizeof (struct TransportPingMessage);
1057   /* peer wants to confirm that this is one of our addresses, this is what is
1058    * used for address validation */
1059
1060   sig_cache = NULL;
1061   sig_cache_exp = NULL;
1062   papi = NULL;
1063   if (len_address > 0)
1064   {
1065     addrend = memchr (addr, '\0', len_address);
1066     if (NULL == addrend)
1067     {
1068       GNUNET_break_op (0);
1069       return GNUNET_SYSERR;
1070     }
1071     addrend++;
1072     len_plugin = strlen (addr) + 1;
1073     len_address -= len_plugin;
1074     address.local_info = GNUNET_HELLO_ADDRESS_INFO_NONE;
1075     address.address = addrend;
1076     address.address_length = len_address;
1077     address.transport_name = addr;
1078     address.peer = GST_my_identity;
1079
1080     if (NULL == address.transport_name)
1081     {
1082       GNUNET_break (0);
1083     }
1084
1085     if (0 != strstr (address.transport_name, "_client"))
1086     {
1087       plugin_name = GNUNET_strdup (address.transport_name);
1088       pos = strstr (plugin_name, "_client");
1089       GNUNET_assert (NULL != pos);
1090       GNUNET_snprintf (pos, strlen ("_server") + 1, "%s", "_server");
1091     }
1092     else
1093       plugin_name = GNUNET_strdup (address.transport_name);
1094
1095     if (NULL == (papi = GST_plugins_find (plugin_name)))
1096     {
1097       /* we don't have the plugin for this address */
1098       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1099                   _("Plugin `%s' not available, cannot confirm having this address\n"),
1100                   plugin_name);
1101       GNUNET_free (plugin_name);
1102       return GNUNET_SYSERR;
1103     }
1104     GNUNET_free (plugin_name);
1105     if (GNUNET_OK !=
1106         papi->check_address (papi->cls,
1107                              addrend,
1108                              len_address))
1109     {
1110       GNUNET_STATISTICS_update (GST_stats,
1111                                 gettext_noop
1112                                 ("# failed address checks during validation"), 1,
1113                                 GNUNET_NO);
1114       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1115                   _("Address `%s' is not one of my addresses, not confirming PING\n"),
1116                   GST_plugins_a2s (&address));
1117       return GNUNET_SYSERR;
1118     }
1119     else
1120     {
1121       GNUNET_STATISTICS_update (GST_stats,
1122                                 gettext_noop
1123                                 ("# successful address checks during validation"), 1,
1124                                 GNUNET_NO);
1125       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1126                   "Address `%s' is one of my addresses, confirming PING\n",
1127                   GST_plugins_a2s (&address));
1128     }
1129
1130     if (GNUNET_YES !=
1131         GST_hello_test_address (&address,
1132                                 &sig_cache,
1133                                 &sig_cache_exp))
1134     {
1135       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1136                   _("Not confirming PING from peer `%s' with address `%s' since I cannot confirm having this address.\n"),
1137                   GNUNET_i2s (sender),
1138                   GST_plugins_a2s (&address));
1139       return GNUNET_SYSERR;
1140     }
1141   }
1142   else
1143   {
1144     addrend = NULL;             /* make gcc happy */
1145     len_plugin = 0;
1146     static struct GNUNET_CRYPTO_EddsaSignature no_address_signature;
1147     static struct GNUNET_TIME_Absolute no_address_signature_expiration;
1148
1149     sig_cache = &no_address_signature;
1150     sig_cache_exp = &no_address_signature_expiration;
1151   }
1152
1153   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1154               "I am `%s', sending PONG to peer `%s'\n",
1155               GNUNET_i2s_full (&GST_my_identity),
1156               GNUNET_i2s (sender));
1157
1158   /* message with structure:
1159    * [TransportPongMessage][Transport name][Address] */
1160
1161   pong = GNUNET_malloc (sizeof (struct TransportPongMessage) + len_address + len_plugin);
1162   pong->header.size =
1163       htons (sizeof (struct TransportPongMessage) + len_address + len_plugin);
1164   pong->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_PONG);
1165   pong->purpose.size =
1166       htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
1167              sizeof (uint32_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO) +
1168              len_address + len_plugin);
1169   pong->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN);
1170   memcpy (&pong->challenge, &ping->challenge, sizeof (ping->challenge));
1171   pong->addrlen = htonl (len_address + len_plugin);
1172   memcpy (&pong[1], addr, len_plugin);   /* Copy transport plugin */
1173   if (len_address > 0)
1174   {
1175     GNUNET_assert (NULL != addrend);
1176     memcpy (&((char *) &pong[1])[len_plugin], addrend, len_address);
1177   }
1178   if (GNUNET_TIME_absolute_get_remaining (*sig_cache_exp).rel_value_us <
1179       PONG_SIGNATURE_LIFETIME.rel_value_us / 4)
1180   {
1181     /* create / update cached sig */
1182     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1183                 "Creating PONG signature to indicate ownership.\n");
1184     *sig_cache_exp = GNUNET_TIME_relative_to_absolute (PONG_SIGNATURE_LIFETIME);
1185     pong->expiration = GNUNET_TIME_absolute_hton (*sig_cache_exp);
1186     if (GNUNET_OK !=
1187                    GNUNET_CRYPTO_eddsa_sign (GST_my_private_key, &pong->purpose,
1188                                            sig_cache))
1189     {
1190         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1191                 _("Failed to create PONG signature for peer `%s'\n"), GNUNET_i2s (sender));
1192     }
1193   }
1194   else
1195   {
1196     pong->expiration = GNUNET_TIME_absolute_hton (*sig_cache_exp);
1197   }
1198   pong->signature = *sig_cache;
1199
1200   GNUNET_assert (NULL != sender_address);
1201
1202   /* first see if the session we got this PING from can be used to transmit
1203    * a response reliably */
1204   if (NULL == papi)
1205   {
1206     ret = -1;
1207   }
1208   else
1209   {
1210     GNUNET_assert (NULL != papi->send);
1211     GNUNET_assert (NULL != papi->get_session);
1212     if (NULL == session)
1213     {
1214       session = papi->get_session (papi->cls, sender_address);
1215     }
1216     if (NULL == session)
1217     {
1218       GNUNET_break (0);
1219       ret = -1;
1220     }
1221     else
1222     {
1223       ret = papi->send (papi->cls, session,
1224                         (const char *) pong,
1225                         ntohs (pong->header.size),
1226                         PONG_PRIORITY, ACCEPTABLE_PING_DELAY,
1227                         NULL, NULL);
1228       if (-1 != ret)
1229         GST_neighbours_notify_data_sent (sender_address,
1230                                          session,
1231                                          pong->header.size);
1232     }
1233   }
1234   if (-1 != ret)
1235   {
1236     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1237                 "Transmitted PONG to `%s' via reliable mechanism\n",
1238                 GNUNET_i2s (sender));
1239     /* done! */
1240     GNUNET_STATISTICS_update (GST_stats,
1241                               gettext_noop
1242                               ("# PONGs unicast via reliable transport"), 1,
1243                               GNUNET_NO);
1244     GNUNET_free (pong);
1245     return GNUNET_OK;
1246   }
1247
1248   /* no reliable method found, try transmission via all known addresses */
1249   GNUNET_STATISTICS_update (GST_stats,
1250                             gettext_noop
1251                             ("# PONGs multicast to all available addresses"), 1,
1252                             GNUNET_NO);
1253   GST_validation_get_addresses (sender,
1254                                 &multicast_pong, pong);
1255   GNUNET_free (pong);
1256   return GNUNET_OK;
1257 }
1258
1259
1260 /**
1261  * Validate an individual address.
1262  *
1263  * @param address address we should try to validate
1264  */
1265 void
1266 GST_validation_handle_address (const struct GNUNET_HELLO_Address *address)
1267 {
1268   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1269   struct ValidationEntry *ve;
1270
1271   papi = GST_plugins_find (address->transport_name);
1272   if (NULL == papi)
1273   {
1274     /* This plugin is currently unvailable ... ignore */
1275     return;
1276   }
1277   ve = find_validation_entry (address);
1278   if (NULL == ve->revalidation_task)
1279   {
1280     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1281                 "Validation process started for fresh address `%s' of %s\n",
1282                 GST_plugins_a2s (ve->address),
1283                 GNUNET_i2s (&ve->address->peer));
1284     ve->revalidation_task = GNUNET_SCHEDULER_add_now (&revalidate_address, ve);
1285   }
1286 }
1287
1288
1289 /**
1290  * Iterator callback to go over all addresses and try to validate them
1291  * (unless blocked or already validated).
1292  *
1293  * @param cls NULL
1294  * @param address the address
1295  * @param expiration expiration time
1296  * @return #GNUNET_OK (keep the address)
1297  */
1298 static int
1299 validate_address_iterator (void *cls,
1300                            const struct GNUNET_HELLO_Address *address,
1301                            struct GNUNET_TIME_Absolute expiration)
1302 {
1303   if (0 == GNUNET_TIME_absolute_get_remaining (expiration).rel_value_us)
1304   {
1305     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1306                 "Skipping expired address from HELLO\n");
1307     return GNUNET_OK;           /* expired */
1308   }
1309   GST_validation_handle_address (address);
1310   return GNUNET_OK;
1311 }
1312
1313
1314 /**
1315  * Add the validated peer address to the HELLO.
1316  *
1317  * @param cls the `struct ValidationEntry *` with the validated address
1318  * @param max space in @a buf
1319  * @param buf where to add the address
1320  * @return number of bytes written, #GNUNET_SYSERR to signal the
1321  *         end of the iteration.
1322  */
1323 static ssize_t
1324 add_valid_peer_address (void *cls,
1325                         size_t max,
1326                         void *buf)
1327 {
1328   struct ValidationEntry *ve = cls;
1329
1330   if (GNUNET_YES == ve->copied)
1331     return GNUNET_SYSERR; /* Done */
1332   ve->copied = GNUNET_YES;
1333   return GNUNET_HELLO_add_address (ve->address,
1334                                    ve->valid_until,
1335                                    buf,
1336                                    max);
1337 }
1338
1339
1340 /**
1341  * We've received a PONG.  Check if it matches a pending PING and
1342  * mark the respective address as confirmed.
1343  *
1344  * @param sender peer sending the PONG
1345  * @param hdr the PONG
1346  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
1347  */
1348 int
1349 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
1350                             const struct GNUNET_MessageHeader *hdr)
1351 {
1352   const struct TransportPongMessage *pong;
1353   struct ValidationEntry *ve;
1354   const char *tname;
1355   const char *addr;
1356   size_t addrlen;
1357   size_t slen;
1358   size_t size;
1359   struct GNUNET_HELLO_Message *hello;
1360   struct GNUNET_HELLO_Address address;
1361   int sig_res;
1362   int do_verify;
1363
1364   if (ntohs (hdr->size) < sizeof (struct TransportPongMessage))
1365   {
1366     GNUNET_break_op (0);
1367     return GNUNET_SYSERR;
1368   }
1369   GNUNET_STATISTICS_update (GST_stats,
1370                             gettext_noop ("# PONG messages received"), 1,
1371                             GNUNET_NO);
1372
1373   /* message with structure:
1374    * [TransportPongMessage][Transport name][Address] */
1375
1376   pong = (const struct TransportPongMessage *) hdr;
1377   tname = (const char *) &pong[1];
1378   size = ntohs (hdr->size) - sizeof (struct TransportPongMessage);
1379   addr = memchr (tname, '\0', size);
1380   if (NULL == addr)
1381   {
1382     GNUNET_break_op (0);
1383     return GNUNET_SYSERR;
1384   }
1385   addr++;
1386   slen = strlen (tname) + 1;
1387   addrlen = size - slen;
1388
1389   if (NULL == GST_plugins_find (tname))
1390   {
1391     /* we got the PONG, but the transport plugin specified in it
1392        is not supported by this peer, so this cannot be a good
1393        PONG for us. */
1394     GNUNET_break_op (0);
1395     return GNUNET_OK;
1396   }
1397
1398   address.peer = *sender;
1399   address.address = addr;
1400   address.address_length = addrlen;
1401   address.transport_name = tname;
1402   address.local_info = GNUNET_HELLO_ADDRESS_INFO_NONE;
1403   ve = find_validation_entry (&address);
1404   if ((NULL == ve) || (GNUNET_NO == ve->expecting_pong))
1405   {
1406     GNUNET_STATISTICS_update (GST_stats,
1407                               gettext_noop
1408                               ("# PONGs dropped, no matching pending validation"),
1409                               1, GNUNET_NO);
1410     return GNUNET_OK;
1411   }
1412   /* now check that PONG is well-formed */
1413   if (0 != memcmp (&ve->address->peer,
1414                    sender,
1415                    sizeof (struct GNUNET_PeerIdentity)))
1416   {
1417     GNUNET_break_op (0);
1418     return GNUNET_SYSERR;
1419   }
1420   if (0 ==
1421       GNUNET_TIME_absolute_get_remaining
1422       (GNUNET_TIME_absolute_ntoh (pong->expiration)).rel_value_us)
1423   {
1424     GNUNET_STATISTICS_update (GST_stats,
1425                               gettext_noop
1426                               ("# PONGs dropped, signature expired"), 1,
1427                               GNUNET_NO);
1428     return GNUNET_SYSERR;
1429   }
1430
1431   sig_res = GNUNET_SYSERR;
1432   do_verify = GNUNET_YES;
1433   if (0 != GNUNET_TIME_absolute_get_remaining (ve->pong_sig_valid_until).rel_value_us)
1434   {
1435     /* We have a cached and valid signature for this peer,
1436      * try to compare instead of verify */
1437     if (0 == memcmp (&ve->pong_sig_cache, &pong->signature, sizeof (struct GNUNET_CRYPTO_EddsaSignature)))
1438     {
1439       /* signatures are identical, we can skip verification */
1440       sig_res = GNUNET_OK;
1441       do_verify = GNUNET_NO;
1442     }
1443     else
1444     {
1445       sig_res = GNUNET_SYSERR;
1446       /* signatures do not match, we have to verify */
1447     }
1448   }
1449
1450   if (GNUNET_YES == do_verify)
1451   {
1452     /* Do expensive verification */
1453     sig_res = GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN,
1454                                           &pong->purpose, &pong->signature,
1455                                           &ve->address->peer.public_key);
1456     if (sig_res == GNUNET_SYSERR)
1457     {
1458       GNUNET_break_op (0);
1459       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1460                   "Failed to verify: invalid signature on address `%s':%s from peer `%s'\n",
1461                   tname,
1462                   GST_plugins_a2s (ve->address),
1463                   GNUNET_i2s (sender));
1464     }
1465   }
1466   if (sig_res == GNUNET_SYSERR)
1467   {
1468     GNUNET_break_op (0);
1469     return GNUNET_SYSERR;
1470   }
1471
1472   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1473               "Validation process successful for peer `%s' with plugin `%s' address `%s'\n",
1474               GNUNET_i2s (sender),
1475               tname,
1476               GST_plugins_a2s (ve->address));
1477   GNUNET_STATISTICS_update (GST_stats,
1478                             gettext_noop ("# validations succeeded"),
1479                             1,
1480                             GNUNET_NO);
1481   /* validity achieved, remember it! */
1482   ve->expecting_pong = GNUNET_NO;
1483   ve->valid_until = GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
1484   ve->pong_sig_cache = pong->signature;
1485         ve->pong_sig_valid_until = GNUNET_TIME_absolute_ntoh (pong->expiration);
1486   ve->latency = GNUNET_TIME_absolute_get_duration (ve->send_time);
1487   {
1488     if (GNUNET_YES == ve->known_to_ats)
1489     {
1490       GST_ats_update_delay (ve->address,
1491                             GNUNET_TIME_relative_divide (ve->latency, 2));
1492     }
1493     else
1494     {
1495       struct GNUNET_ATS_Properties prop;
1496
1497       memset (&prop, 0, sizeof (prop));
1498       prop.scope = ve->network;
1499       prop.delay = GNUNET_TIME_relative_divide (ve->latency, 2);
1500       ve->known_to_ats = GNUNET_YES;
1501       GST_ats_add_address (ve->address, &prop);
1502     }
1503   }
1504   if (validations_running > 0)
1505   {
1506     validations_running--;
1507     GNUNET_STATISTICS_set (GST_stats,
1508                            gettext_noop ("# validations running"),
1509                            validations_running,
1510                            GNUNET_NO);
1511     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1512                 "Validation finished, %u validation processes running\n",
1513                 validations_running);
1514   }
1515   else
1516   {
1517     GNUNET_break (0);
1518   }
1519
1520   /* Notify about new validity */
1521   validation_entry_changed (ve,
1522                             GNUNET_TRANSPORT_VS_UPDATE);
1523
1524   /* build HELLO to store in PEERINFO */
1525   ve->copied = GNUNET_NO;
1526   hello = GNUNET_HELLO_create (&ve->address->peer.public_key,
1527                                &add_valid_peer_address,
1528                                ve,
1529                                GNUNET_NO);
1530   GNUNET_PEERINFO_add_peer (GST_peerinfo,
1531                             hello,
1532                             NULL,
1533                             NULL);
1534   GNUNET_free (hello);
1535   return GNUNET_OK;
1536 }
1537
1538
1539 /**
1540  * We've received a HELLO, check which addresses are new and trigger
1541  * validation.
1542  *
1543  * @param hello the HELLO we received
1544  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
1545  */
1546 int
1547 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello)
1548 {
1549   const struct GNUNET_HELLO_Message *hm =
1550       (const struct GNUNET_HELLO_Message *) hello;
1551   struct GNUNET_PeerIdentity pid;
1552   struct GNUNET_HELLO_Message *h;
1553   int friend;
1554
1555   friend = GNUNET_HELLO_is_friend_only (hm);
1556   if ( ( (GNUNET_YES != friend) &&
1557          (GNUNET_NO != friend) ) ||
1558        (GNUNET_OK != GNUNET_HELLO_get_id (hm, &pid)) )
1559   {
1560     /* malformed HELLO */
1561     GNUNET_break_op (0);
1562     return GNUNET_SYSERR;
1563   }
1564   if (0 ==
1565       memcmp (&GST_my_identity,
1566               &pid,
1567               sizeof (struct GNUNET_PeerIdentity)))
1568   {
1569     /* got our own HELLO, how boring */
1570     return GNUNET_OK;
1571   }
1572   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1573               "Validation received HELLO message for peer `%s' with size %u, checking for new addresses\n",
1574               GNUNET_i2s (&pid),
1575               ntohs (hello->size));
1576   GNUNET_assert (NULL ==
1577                  GNUNET_HELLO_iterate_addresses (hm,
1578                                                  GNUNET_NO,
1579                                                  &validate_address_iterator,
1580                                                  NULL));
1581   return GNUNET_OK;
1582 }
1583
1584
1585 /**
1586  * Closure for #iterate_addresses().
1587  */
1588 struct IteratorContext
1589 {
1590   /**
1591    * Function to call on each address.
1592    */
1593   GST_ValidationAddressCallback cb;
1594
1595   /**
1596    * Closure for @e cb.
1597    */
1598   void *cb_cls;
1599
1600 };
1601
1602
1603 /**
1604  * Call the callback in the closure for each validation entry.
1605  *
1606  * @param cls the `struct IteratorContext`
1607  * @param key the peer's identity
1608  * @param value the `struct ValidationEntry`
1609  * @return #GNUNET_OK (continue to iterate)
1610  */
1611 static int
1612 iterate_addresses (void *cls,
1613                    const struct GNUNET_PeerIdentity *key,
1614                    void *value)
1615 {
1616   struct IteratorContext *ic = cls;
1617   struct ValidationEntry *ve = value;
1618
1619   ic->cb (ic->cb_cls,
1620           ve->valid_until,
1621           ve->revalidation_block,
1622           ve->address);
1623   return GNUNET_OK;
1624 }
1625
1626
1627 /**
1628  * Call the given function for each address for the given target.
1629  * Can either give a snapshot (synchronous API) or be continuous.
1630  *
1631  * @param target peer information is requested for
1632  * @param cb function to call; will not be called after this function returns
1633  * @param cb_cls closure for @a cb
1634  */
1635 void
1636 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
1637                               GST_ValidationAddressCallback cb,
1638                               void *cb_cls)
1639 {
1640   struct IteratorContext ic;
1641
1642   ic.cb = cb;
1643   ic.cb_cls = cb_cls;
1644   GNUNET_CONTAINER_multipeermap_get_multiple (validation_map,
1645                                               target,
1646                                               &iterate_addresses, &ic);
1647 }
1648
1649
1650 /**
1651  * Update if we are using an address for a connection actively right now.
1652  * Based on this, the validation module will measure latency for the
1653  * address more or less often.
1654  *
1655  * @param address the address that we are now using (or not)
1656  * @param in_use #GNUNET_YES if we are now using the address for a connection,
1657  *               #GNUNET_NO if we are no longer using the address for a connection
1658  */
1659 void
1660 GST_validation_set_address_use (const struct GNUNET_HELLO_Address *address,
1661                                 int in_use)
1662 {
1663   struct ValidationEntry *ve;
1664
1665   if (GNUNET_HELLO_address_check_option (address,
1666                                          GNUNET_HELLO_ADDRESS_INFO_INBOUND))
1667     return; /* ignore inbound for validation */
1668   if (NULL == GST_plugins_find (address->transport_name))
1669   {
1670     /* How can we use an address for which we don't have the plugin? */
1671     GNUNET_break (0);
1672     return;
1673   }
1674   ve = find_validation_entry (address);
1675   if (NULL == ve)
1676   {
1677     GNUNET_break (0);
1678     return;
1679   }
1680   if (in_use == ve->in_use)
1681     return;
1682   ve->in_use = in_use;
1683   if (GNUNET_YES == in_use)
1684   {
1685     /* from now on, higher frequeny, so reschedule now */
1686     if (NULL != ve->revalidation_task)
1687       GNUNET_SCHEDULER_cancel (ve->revalidation_task);
1688     ve->revalidation_task = GNUNET_SCHEDULER_add_now (&revalidate_address,
1689                                                       ve);
1690   }
1691 }
1692
1693
1694 /**
1695  * Closure for the validation_entries_iterate function.
1696  */
1697 struct ValidationIteratorContext
1698 {
1699   /**
1700    * Function to call on each validation entry
1701    */
1702   GST_ValidationChangedCallback cb;
1703
1704   /**
1705    * Closure for @e cb.
1706    */
1707   void *cb_cls;
1708 };
1709
1710
1711 /**
1712  * Function called on each entry in the validation map.
1713  * Passes the information from the validation entry to
1714  * the callback given in the closure.
1715  *
1716  * @param cls the `struct ValidationIteratorContext`
1717  * @param key peer this is about
1718  * @param value the `struct ValidationEntry`
1719  * @return #GNUNET_OK (continue to iterate)
1720  */
1721 static int
1722 validation_entries_iterate (void *cls,
1723                             const struct GNUNET_PeerIdentity *key,
1724                             void *value)
1725 {
1726   struct ValidationIteratorContext *ic = cls;
1727   struct ValidationEntry *ve = value;
1728
1729   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1730               "Notifying about validation entry for peer `%s' address `%s' \n",
1731               GNUNET_i2s (&ve->address->peer),
1732               GST_plugins_a2s (ve->address));
1733   ic->cb (ic->cb_cls,
1734           ve->address,
1735           ve->send_time,
1736           ve->valid_until,
1737           ve->next_validation,
1738           ve->state);
1739   return GNUNET_OK;
1740 }
1741
1742
1743 /**
1744  * Iterate over all iteration entries
1745  *
1746  * @param cb function to call
1747  * @param cb_cls closure for @a cb
1748  */
1749 void
1750 GST_validation_iterate (GST_ValidationChangedCallback cb,
1751                         void *cb_cls)
1752 {
1753   struct ValidationIteratorContext ic;
1754
1755   if (NULL == validation_map)
1756     return; /* can happen during shutdown */
1757   ic.cb = cb;
1758   ic.cb_cls = cb_cls;
1759   GNUNET_CONTAINER_multipeermap_iterate (validation_map,
1760                                          &validation_entries_iterate,
1761                                          &ic);
1762 }
1763
1764 /* end of file gnunet-service-transport_validation.c */