-check transport-side for connect-to-self
[oweals/gnunet.git] / 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., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, 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     GNUNET_assert (GNUNET_NO ==
433                    GST_ats_is_known_no_session (ve->address));
434     ve->known_to_ats = GNUNET_NO;
435   }
436   GNUNET_HELLO_address_free (ve->address);
437   if (NULL != ve->timeout_task)
438   {
439     GNUNET_SCHEDULER_cancel (ve->timeout_task);
440     ve->timeout_task = NULL;
441   }
442   if (NULL != ve->revalidation_task)
443   {
444     GNUNET_SCHEDULER_cancel (ve->revalidation_task);
445     ve->revalidation_task = NULL;
446   }
447   if ( (GNUNET_YES == ve->expecting_pong) &&
448        (validations_running > 0) )
449   {
450     validations_running--;
451     GNUNET_STATISTICS_set (GST_stats,
452                            gettext_noop ("# validations running"),
453                            validations_running,
454                            GNUNET_NO);
455   }
456   GNUNET_free (ve);
457   return GNUNET_OK;
458 }
459
460
461 /**
462  * Address validation cleanup task.  Assesses if the record is no
463  * longer valid and then possibly triggers its removal.
464  *
465  * @param cls the `struct ValidationEntry`
466  * @param tc scheduler context (unused)
467  */
468 static void
469 timeout_hello_validation (void *cls,
470                           const struct GNUNET_SCHEDULER_TaskContext *tc)
471 {
472   struct ValidationEntry *ve = cls;
473   struct GNUNET_TIME_Absolute max;
474   struct GNUNET_TIME_Relative left;
475
476   ve->timeout_task = NULL;
477   /* For valid addresses, we want to wait until the expire;
478      for addresses under PING validation, we want to wait
479      until we give up on the PING */
480   max = GNUNET_TIME_absolute_max (ve->valid_until,
481                                   ve->revalidation_block);
482   left = GNUNET_TIME_absolute_get_remaining (max);
483   if (left.rel_value_us > 0)
484   {
485     /* We should wait a bit longer. This happens when
486        address lifetimes are extended due to successful
487        validations. */
488     ve->timeout_task =
489         GNUNET_SCHEDULER_add_delayed (left,
490                                       &timeout_hello_validation,
491                                       ve);
492     return;
493   }
494   GNUNET_STATISTICS_update (GST_stats,
495                             gettext_noop ("# address records discarded (timeout)"),
496                             1,
497                             GNUNET_NO);
498   cleanup_validation_entry (NULL,
499                             &ve->address->peer,
500                             ve);
501 }
502
503
504 /**
505  * Function called with the result from blacklisting.
506  * Send a PING to the other peer if a communication is allowed.
507  *
508  * @param cls our `struct ValidationEntry`
509  * @param pid identity of the other peer
510  * @param address_null address associated with the request, always NULL
511  * @param session_null session associated with the request, always NULL
512  * @param result #GNUNET_OK if the connection is allowed,
513  *               #GNUNET_NO if not,
514  *               #GNUNET_SYSERR if operation was aborted
515  */
516 static void
517 transmit_ping_if_allowed (void *cls,
518                           const struct GNUNET_PeerIdentity *pid,
519                           const struct GNUNET_HELLO_Address *address_null,
520                           struct GNUNET_ATS_Session *session_null,
521                           int result)
522 {
523   struct ValidationEntry *ve = cls;
524   struct TransportPingMessage ping;
525   struct GNUNET_TRANSPORT_PluginFunctions *papi;
526   struct GNUNET_TIME_Absolute next;
527   const struct GNUNET_MessageHeader *hello;
528   ssize_t ret;
529   size_t tsize;
530   size_t slen;
531   uint16_t hsize;
532   struct GNUNET_ATS_Session *session;
533
534   ve->bc = NULL;
535   if (GNUNET_OK != result)
536   {
537     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
538                 "Blacklist denies sending PING to `%s' `%s' `%s'\n",
539                 GNUNET_i2s (pid),
540                 GST_plugins_a2s (ve->address),
541                 ve->address->transport_name);
542     GNUNET_STATISTICS_update (GST_stats,
543                               gettext_noop ("# address records discarded (blacklist)"),
544                               1,
545                               GNUNET_NO);
546     cleanup_validation_entry (NULL,
547                               pid,
548                               ve);
549     return;
550   }
551   hello = GST_hello_get ();
552   GNUNET_assert (NULL != hello);
553   slen = strlen (ve->address->transport_name) + 1;
554   hsize = ntohs (hello->size);
555   tsize = sizeof (struct TransportPingMessage) +
556     ve->address->address_length + slen + hsize;
557
558   ping.header.size =
559       htons (sizeof (struct TransportPingMessage) +
560              ve->address->address_length + slen);
561   ping.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_PING);
562   ping.challenge = htonl (ve->challenge);
563   ping.target = *pid;
564
565   if (tsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
566   {
567     GNUNET_break (0);
568     hsize = 0;
569     tsize =
570         sizeof (struct TransportPingMessage) + ve->address->address_length +
571         slen + hsize;
572   }
573   {
574     char message_buf[tsize] GNUNET_ALIGN;
575
576     memcpy (message_buf,
577             hello,
578             hsize);
579     memcpy (&message_buf[hsize],
580             &ping,
581             sizeof (struct TransportPingMessage));
582     memcpy (&message_buf[sizeof (struct TransportPingMessage) + hsize],
583             ve->address->transport_name,
584             slen);
585     memcpy (&message_buf[sizeof (struct TransportPingMessage) + slen + hsize],
586             ve->address->address,
587             ve->address->address_length);
588     papi = GST_plugins_find (ve->address->transport_name);
589     GNUNET_assert (NULL != papi);
590     session = papi->get_session (papi->cls,
591                                  ve->address);
592     if (NULL == session)
593     {
594       /* Could not get a valid session */
595       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
596                   "Failed to get session to send PING to `%s' at `%s'\n",
597                   GNUNET_i2s (pid),
598                   GST_plugins_a2s (ve->address));
599       return;
600     }
601
602     ret = papi->send (papi->cls, session,
603                       message_buf, tsize,
604                       PING_PRIORITY,
605                       ACCEPTABLE_PING_DELAY,
606                       NULL, NULL);
607     if (-1 == ret)
608     {
609       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
610                   "Failed to send PING to `%s' at `%s'\n",
611                   GNUNET_i2s (pid),
612                   GST_plugins_a2s (ve->address));
613       return;
614     }
615     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
616                 "Transmitted plain PING to `%s' `%s' `%s'\n",
617                 GNUNET_i2s (pid),
618                 GST_plugins_a2s (ve->address),
619                 ve->address->transport_name);
620     ve->network = papi->get_network (papi->cls,
621                                      session);
622     GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != ve->network);
623     GST_neighbours_notify_data_sent (ve->address,
624                                      session,
625                                      tsize);
626     next = GNUNET_TIME_relative_to_absolute (validation_delay);
627     validation_next = GNUNET_TIME_absolute_max (next,
628                                                 validation_next);
629     ve->send_time = GNUNET_TIME_absolute_get ();
630     GNUNET_STATISTICS_update (GST_stats,
631                               gettext_noop ("# PINGs for address validation sent"),
632                               1,
633                               GNUNET_NO);
634     ve->expecting_pong = GNUNET_YES;
635     validations_running++;
636     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
637                 "Validation started, %u validation processes running\n",
638                 validations_running);
639     GNUNET_STATISTICS_set (GST_stats,
640                            gettext_noop ("# validations running"),
641                            validations_running,
642                            GNUNET_NO);
643     /*  Notify about PING sent */
644     validation_entry_changed (ve,
645                               GNUNET_TRANSPORT_VS_UPDATE);
646
647   }
648 }
649
650
651 /**
652  * Do address validation again to keep address valid.
653  *
654  * @param cls the `struct ValidationEntry`
655  * @param tc scheduler context (unused)
656  */
657 static void
658 revalidate_address (void *cls,
659                     const struct GNUNET_SCHEDULER_TaskContext *tc)
660 {
661   struct ValidationEntry *ve = cls;
662   struct GNUNET_TIME_Relative canonical_delay;
663   struct GNUNET_TIME_Relative delay;
664   struct GNUNET_TIME_Relative blocked_for;
665   struct GST_BlacklistCheck *bc;
666   uint32_t rdelay;
667
668   ve->revalidation_task = NULL;
669   delay = GNUNET_TIME_absolute_get_remaining (ve->revalidation_block);
670   /* Considering current connectivity situation, what is the maximum
671      block period permitted? */
672   if (GNUNET_YES == ve->in_use)
673     canonical_delay = CONNECTED_PING_FREQUENCY;
674   else if (GNUNET_TIME_absolute_get_remaining (ve->valid_until).rel_value_us > 0)
675     canonical_delay = VALIDATED_PING_FREQUENCY;
676   else
677     canonical_delay = UNVALIDATED_PING_KEEPALIVE;
678   /* Use delay that is MIN of original delay and possibly adjusted
679      new maximum delay (which may be lower); the real delay
680      is originally randomized between "canonical_delay" and "2 * canonical_delay",
681      so continue to permit that window for the operation. */
682   delay = GNUNET_TIME_relative_min (delay,
683                                     GNUNET_TIME_relative_multiply (canonical_delay,
684                                                                    2));
685   ve->revalidation_block = GNUNET_TIME_relative_to_absolute (delay);
686   if (delay.rel_value_us > 0)
687   {
688     /* should wait a bit longer */
689     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
690                 "Waiting for %s longer before (re)validating address `%s'\n",
691                 GNUNET_STRINGS_relative_time_to_string (delay,
692                                                         GNUNET_YES),
693                 GST_plugins_a2s (ve->address));
694     ve->revalidation_task =
695         GNUNET_SCHEDULER_add_delayed (delay,
696                                       &revalidate_address, ve);
697     ve->next_validation = GNUNET_TIME_relative_to_absolute (delay);
698     return;
699   }
700   /* check if globally we have too many active validations at a
701      too high rate, if so, delay ours */
702   blocked_for = GNUNET_TIME_absolute_get_remaining (validation_next);
703   if ( (validations_running > validations_fast_start_threshold) &&
704        (blocked_for.rel_value_us > 0) )
705   {
706     /* Validations are blocked, have to wait for blocked_for time */
707     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
708                 "Validations blocked for another %s, delaying validating address `%s'\n",
709                 GNUNET_STRINGS_relative_time_to_string (blocked_for,
710                                                         GNUNET_YES),
711                 GST_plugins_a2s (ve->address));
712     GNUNET_STATISTICS_update (GST_stats,
713                               gettext_noop ("# validations delayed by global throttle"),
714                               1,
715                               GNUNET_NO);
716     ve->revalidation_task =
717       GNUNET_SCHEDULER_add_delayed (blocked_for,
718                                     &revalidate_address,
719                                     ve);
720     ve->next_validation = GNUNET_TIME_relative_to_absolute (blocked_for);
721     return;
722   }
723
724   /* We are good to go; remember to not go again for `canonical_delay` time;
725      add up to `canonical_delay` to randomize start time */
726   ve->revalidation_block = GNUNET_TIME_relative_to_absolute (canonical_delay);
727   /* schedule next PINGing with some extra random delay to avoid synchronous re-validations */
728   rdelay =
729       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
730                                 canonical_delay.rel_value_us);
731
732   delay = GNUNET_TIME_relative_add (canonical_delay,
733                                     GNUNET_TIME_relative_multiply
734                                     (GNUNET_TIME_UNIT_MICROSECONDS,
735                                      rdelay));
736
737   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
738               "Validating now, next scheduled for %s, now validating address `%s'\n",
739               GNUNET_STRINGS_relative_time_to_string (blocked_for,
740                                                       GNUNET_YES),
741               GST_plugins_a2s (ve->address));
742   ve->revalidation_task =
743       GNUNET_SCHEDULER_add_delayed (delay,
744                                     &revalidate_address,
745                                     ve);
746   ve->next_validation = GNUNET_TIME_relative_to_absolute (delay);
747
748   /* start PINGing by checking blacklist */
749   GNUNET_STATISTICS_update (GST_stats,
750                             gettext_noop ("# address revalidations started"), 1,
751                             GNUNET_NO);
752   bc = GST_blacklist_test_allowed (&ve->address->peer,
753                                    ve->address->transport_name,
754                                    &transmit_ping_if_allowed,
755                                    ve,
756                                    NULL,
757                                    NULL);
758   if (NULL != bc)
759     ve->bc = bc;                /* only set 'bc' if 'transmit_ping_if_allowed' was not already
760                                  * called... */
761 }
762
763
764 /**
765  * Find a ValidationEntry entry for the given neighbour that matches
766  * the given address and transport.  If none exists, create one (but
767  * without starting any validation).
768  *
769  * @param address address to find
770  * @return validation entry matching the given specifications, NULL
771  *         if we don't have an existing entry and no public key was given
772  */
773 static struct ValidationEntry *
774 find_validation_entry (const struct GNUNET_HELLO_Address *address)
775 {
776   struct ValidationEntryMatchContext vemc;
777   struct ValidationEntry *ve;
778
779   vemc.ve = NULL;
780   vemc.address = address;
781   GNUNET_CONTAINER_multipeermap_get_multiple (validation_map,
782                                               &address->peer,
783                                               &validation_entry_match, &vemc);
784   if (NULL != (ve = vemc.ve))
785     return ve;
786   GNUNET_assert (GNUNET_NO ==
787                  GST_ats_is_known_no_session (address));
788   ve = GNUNET_new (struct ValidationEntry);
789   ve->in_use = GNUNET_SYSERR; /* not defined */
790   ve->address = GNUNET_HELLO_address_copy (address);
791   ve->pong_sig_valid_until = GNUNET_TIME_UNIT_ZERO_ABS;
792   memset (&ve->pong_sig_cache,
793           '\0',
794           sizeof (struct GNUNET_CRYPTO_EddsaSignature));
795   ve->latency = GNUNET_TIME_UNIT_FOREVER_REL;
796   ve->challenge =
797       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
798   ve->timeout_task =
799       GNUNET_SCHEDULER_add_delayed (UNVALIDATED_PING_KEEPALIVE,
800                                     &timeout_hello_validation,
801                                     ve);
802   GNUNET_CONTAINER_multipeermap_put (validation_map,
803                                      &address->peer,
804                                      ve,
805                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
806   publish_ve_stat_update ();
807   validation_entry_changed (ve,
808                             GNUNET_TRANSPORT_VS_NEW);
809   return ve;
810 }
811
812
813 /**
814  * Iterator which adds the given address to the set of validated
815  * addresses.
816  *
817  * @param cls original HELLO message
818  * @param address the address
819  * @param expiration expiration time
820  * @return #GNUNET_OK (keep the address), could return
821  *         #GNUNET_NO (delete address, but this is ignored);
822  *         #GNUNET_SYSERR would abort iteration (but we always iterate all)
823  */
824 static int
825 add_valid_address (void *cls,
826                    const struct GNUNET_HELLO_Address *address,
827                    struct GNUNET_TIME_Absolute expiration)
828 {
829   const struct GNUNET_HELLO_Message *hello = cls;
830   struct ValidationEntry *ve;
831   struct GNUNET_PeerIdentity pid;
832   struct GNUNET_ATS_Properties prop;
833   struct GNUNET_TRANSPORT_PluginFunctions *papi;
834
835   if (0 == GNUNET_TIME_absolute_get_remaining (expiration).rel_value_us)
836     return GNUNET_OK;           /* expired */
837   if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
838   {
839     GNUNET_break (0);
840     return GNUNET_OK;           /* invalid HELLO !? */
841   }
842   if (NULL == (papi = GST_plugins_find (address->transport_name)))
843   {
844     /* might have been valid in the past, but we don't have that
845        plugin loaded right now */
846     return GNUNET_OK;
847   }
848   if (NULL ==
849       papi->address_to_string (papi->cls,
850                                address->address,
851                                address->address_length))
852   {
853     /* Why do we try to add an ill-formed address? */
854     GNUNET_break (0);
855     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
856                 "Address with %u bytes for plugin %s and peer %s is malformed\n",
857                 (unsigned int) address->address_length,
858                 address->transport_name,
859                 GNUNET_i2s (&pid));
860     return GNUNET_OK;
861   }
862
863   ve = find_validation_entry (address);
864   ve->network = papi->get_network_for_address (papi->cls,
865                                                address);
866   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != ve->network);
867   ve->valid_until = GNUNET_TIME_absolute_max (ve->valid_until,
868                                               expiration);
869   if (NULL == ve->revalidation_task)
870   {
871     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
872                 "Starting revalidations for valid address `%s'\n",
873                 GST_plugins_a2s (ve->address));
874     ve->next_validation = GNUNET_TIME_absolute_get();
875     ve->revalidation_task = GNUNET_SCHEDULER_add_now (&revalidate_address, ve);
876   }
877   validation_entry_changed (ve,
878                             GNUNET_TRANSPORT_VS_UPDATE);
879   memset (&prop, 0, sizeof (prop));
880   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != ve->network);
881   prop.scope = ve->network;
882   prop.delay = GNUNET_TIME_relative_divide (ve->latency, 2);
883   if (GNUNET_YES != ve->known_to_ats)
884   {
885     ve->known_to_ats = GNUNET_YES;
886     GST_ats_add_address (address, &prop);
887     GNUNET_assert (GNUNET_YES ==
888                    GST_ats_is_known_no_session (ve->address));
889   }
890   return GNUNET_OK;
891 }
892
893
894 /**
895  * Function called for any HELLO known to PEERINFO.
896  *
897  * @param cls unused (NULL)
898  * @param peer id of the peer, NULL for last call (during iteration,
899  *             as we are monitoring, this should never happen)
900  * @param hello hello message for the peer (can be NULL)
901  * @param err_msg error message
902  */
903 static void
904 process_peerinfo_hello (void *cls,
905                         const struct GNUNET_PeerIdentity *peer,
906                         const struct GNUNET_HELLO_Message *hello,
907                         const char *err_msg)
908 {
909   GNUNET_assert (NULL != peer);
910   if (NULL == hello)
911     return;
912   if (0 == memcmp (&GST_my_identity,
913                    peer,
914                    sizeof (struct GNUNET_PeerIdentity)))
915   {
916     /* Peerinfo returned own identity, skip validation */
917     return;
918   }
919   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
920               "Handling HELLO for peer `%s'\n",
921               GNUNET_i2s (peer));
922   GNUNET_assert (NULL ==
923                  GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO,
924                                                  &add_valid_address,
925                                                  (void *) hello));
926 }
927
928
929 /**
930  * Start the validation subsystem.
931  *
932  * @param max_fds maximum number of fds to use
933  */
934 void
935 GST_validation_start (unsigned int max_fds)
936 {
937   /**
938    * Initialization for validation throttling
939    *
940    * We have a maximum number max_fds of connections we can use for validation
941    * We monitor the number of validations in parallel and start to throttle it
942    * when doing to many validations in parallel:
943    * if (running validations < (max_fds / 2))
944    * - "fast start": run validation immediately
945    * - have delay of (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us) / (max_fds / 2)
946    *   (300 sec / ~150 == ~2 sec.) between two validations
947    */
948
949   validation_next = GNUNET_TIME_absolute_get();
950   validation_delay.rel_value_us = (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value_us) / (max_fds / 2);
951   validations_fast_start_threshold = (max_fds / 2);
952   validations_running = 0;
953   GNUNET_STATISTICS_set (GST_stats,
954                          gettext_noop ("# validations running"),
955                          validations_running,
956                          GNUNET_NO);
957   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
958               "Validation uses a fast start threshold of %u connections and a delay of %s\n",
959               validations_fast_start_threshold,
960               GNUNET_STRINGS_relative_time_to_string (validation_delay,
961                                                       GNUNET_YES));
962   validation_map = GNUNET_CONTAINER_multipeermap_create (VALIDATION_MAP_SIZE,
963                                                          GNUNET_NO);
964   pnc = GNUNET_PEERINFO_notify (GST_cfg, GNUNET_YES,
965                                 &process_peerinfo_hello, NULL);
966 }
967
968
969 /**
970  * Stop the validation subsystem.
971  */
972 void
973 GST_validation_stop ()
974 {
975   GNUNET_CONTAINER_multipeermap_iterate (validation_map,
976                                          &cleanup_validation_entry,
977                                          NULL);
978   GNUNET_CONTAINER_multipeermap_destroy (validation_map);
979   validation_map = NULL;
980   GNUNET_PEERINFO_notify_cancel (pnc);
981 }
982
983
984 /**
985  * Send the given PONG to the given address.
986  *
987  * @param cls the PONG message
988  * @param valid_until is ZERO if we never validated the address,
989  *                    otherwise a time up to when we consider it (or was) valid
990  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
991  *                          is ZERO if the address is considered valid (no validation needed)
992  *                          otherwise a time in the future if we're currently denying re-validation
993  * @param address target address
994  */
995 static void
996 multicast_pong (void *cls,
997                 struct GNUNET_TIME_Absolute valid_until,
998                 struct GNUNET_TIME_Absolute validation_block,
999                 const struct GNUNET_HELLO_Address *address)
1000 {
1001   struct TransportPongMessage *pong = cls;
1002   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1003   struct GNUNET_ATS_Session *session;
1004
1005   papi = GST_plugins_find (address->transport_name);
1006   if (NULL == papi)
1007   {
1008     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1009                 "Plugin %s not supported, cannot send PONG\n",
1010                 address->transport_name);
1011     return;
1012   }
1013   GNUNET_assert (NULL != papi->send);
1014   GNUNET_assert (NULL != papi->get_session);
1015   session = papi->get_session(papi->cls, address);
1016   if (NULL == session)
1017   {
1018      GNUNET_break (0);
1019      return;
1020   }
1021   GST_ats_new_session (address, session);
1022   papi->send (papi->cls, session,
1023               (const char *) pong,
1024               ntohs (pong->header.size),
1025               PONG_PRIORITY,
1026               ACCEPTABLE_PING_DELAY,
1027               NULL, NULL);
1028   GST_neighbours_notify_data_sent (address,
1029                                    session,
1030                                    pong->header.size);
1031 }
1032
1033
1034 /**
1035  * We've received a PING.  If appropriate, generate a PONG.
1036  *
1037  * @param sender peer sending the PING
1038  * @param hdr the PING
1039  * @param sender_address the sender address as we got it
1040  * @param session session we got the PING from
1041  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
1042  */
1043 int
1044 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
1045                             const struct GNUNET_MessageHeader *hdr,
1046                             const struct GNUNET_HELLO_Address *sender_address,
1047                             struct GNUNET_ATS_Session *session)
1048 {
1049   const struct TransportPingMessage *ping;
1050   struct TransportPongMessage *pong;
1051   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1052   struct GNUNET_CRYPTO_EddsaSignature *sig_cache;
1053   struct GNUNET_TIME_Absolute *sig_cache_exp;
1054   const char *addr;
1055   const char *addrend;
1056   char *plugin_name;
1057   char *pos;
1058   size_t len_address;
1059   size_t len_plugin;
1060   ssize_t ret;
1061   struct GNUNET_HELLO_Address address;
1062
1063   if (ntohs (hdr->size) < sizeof (struct TransportPingMessage))
1064   {
1065     GNUNET_break_op (0);
1066     return GNUNET_SYSERR;
1067   }
1068   ping = (const struct TransportPingMessage *) hdr;
1069   if (0 !=
1070       memcmp (&ping->target, &GST_my_identity,
1071               sizeof (struct GNUNET_PeerIdentity)))
1072   {
1073     GNUNET_STATISTICS_update (GST_stats,
1074                               gettext_noop
1075                               ("# PING message for different peer received"), 1,
1076                               GNUNET_NO);
1077     return GNUNET_SYSERR;
1078   }
1079   GNUNET_STATISTICS_update (GST_stats,
1080                             gettext_noop ("# PING messages received"), 1,
1081                             GNUNET_NO);
1082   addr = (const char *) &ping[1];
1083   len_address = ntohs (hdr->size) - sizeof (struct TransportPingMessage);
1084   /* peer wants to confirm that this is one of our addresses, this is what is
1085    * used for address validation */
1086
1087   sig_cache = NULL;
1088   sig_cache_exp = NULL;
1089   papi = NULL;
1090   if (len_address > 0)
1091   {
1092     addrend = memchr (addr, '\0', len_address);
1093     if (NULL == addrend)
1094     {
1095       GNUNET_break_op (0);
1096       return GNUNET_SYSERR;
1097     }
1098     addrend++;
1099     len_plugin = strlen (addr) + 1;
1100     len_address -= len_plugin;
1101     address.local_info = GNUNET_HELLO_ADDRESS_INFO_NONE;
1102     address.address = addrend;
1103     address.address_length = len_address;
1104     address.transport_name = addr;
1105     address.peer = GST_my_identity;
1106
1107     if (NULL == address.transport_name)
1108     {
1109       GNUNET_break (0);
1110     }
1111
1112     if (0 != strstr (address.transport_name, "_client"))
1113     {
1114       plugin_name = GNUNET_strdup (address.transport_name);
1115       pos = strstr (plugin_name, "_client");
1116       GNUNET_assert (NULL != pos);
1117       GNUNET_snprintf (pos, strlen ("_server") + 1, "%s", "_server");
1118     }
1119     else
1120       plugin_name = GNUNET_strdup (address.transport_name);
1121
1122     if (NULL == (papi = GST_plugins_find (plugin_name)))
1123     {
1124       /* we don't have the plugin for this address */
1125       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1126                   _("Plugin `%s' not available, cannot confirm having this address\n"),
1127                   plugin_name);
1128       GNUNET_free (plugin_name);
1129       return GNUNET_SYSERR;
1130     }
1131     GNUNET_free (plugin_name);
1132     if (GNUNET_OK !=
1133         papi->check_address (papi->cls,
1134                              addrend,
1135                              len_address))
1136     {
1137       GNUNET_STATISTICS_update (GST_stats,
1138                                 gettext_noop
1139                                 ("# failed address checks during validation"), 1,
1140                                 GNUNET_NO);
1141       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1142                   _("Address `%s' is not one of my addresses, not confirming PING\n"),
1143                   GST_plugins_a2s (&address));
1144       return GNUNET_SYSERR;
1145     }
1146     else
1147     {
1148       GNUNET_STATISTICS_update (GST_stats,
1149                                 gettext_noop
1150                                 ("# successful address checks during validation"), 1,
1151                                 GNUNET_NO);
1152       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1153                   "Address `%s' is one of my addresses, confirming PING\n",
1154                   GST_plugins_a2s (&address));
1155     }
1156
1157     if (GNUNET_YES !=
1158         GST_hello_test_address (&address,
1159                                 &sig_cache,
1160                                 &sig_cache_exp))
1161     {
1162       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1163                   _("Not confirming PING from peer `%s' with address `%s' since I cannot confirm having this address.\n"),
1164                   GNUNET_i2s (sender),
1165                   GST_plugins_a2s (&address));
1166       return GNUNET_SYSERR;
1167     }
1168   }
1169   else
1170   {
1171     addrend = NULL;             /* make gcc happy */
1172     len_plugin = 0;
1173     static struct GNUNET_CRYPTO_EddsaSignature no_address_signature;
1174     static struct GNUNET_TIME_Absolute no_address_signature_expiration;
1175
1176     sig_cache = &no_address_signature;
1177     sig_cache_exp = &no_address_signature_expiration;
1178   }
1179
1180   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1181               "I am `%s', sending PONG to peer `%s'\n",
1182               GNUNET_i2s_full (&GST_my_identity),
1183               GNUNET_i2s (sender));
1184
1185   /* message with structure:
1186    * [TransportPongMessage][Transport name][Address] */
1187
1188   pong = GNUNET_malloc (sizeof (struct TransportPongMessage) + len_address + len_plugin);
1189   pong->header.size =
1190       htons (sizeof (struct TransportPongMessage) + len_address + len_plugin);
1191   pong->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_PONG);
1192   pong->purpose.size =
1193       htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
1194              sizeof (uint32_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO) +
1195              len_address + len_plugin);
1196   pong->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN);
1197   memcpy (&pong->challenge, &ping->challenge, sizeof (ping->challenge));
1198   pong->addrlen = htonl (len_address + len_plugin);
1199   memcpy (&pong[1], addr, len_plugin);   /* Copy transport plugin */
1200   if (len_address > 0)
1201   {
1202     GNUNET_assert (NULL != addrend);
1203     memcpy (&((char *) &pong[1])[len_plugin], addrend, len_address);
1204   }
1205   if (GNUNET_TIME_absolute_get_remaining (*sig_cache_exp).rel_value_us <
1206       PONG_SIGNATURE_LIFETIME.rel_value_us / 4)
1207   {
1208     /* create / update cached sig */
1209     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1210                 "Creating PONG signature to indicate ownership.\n");
1211     *sig_cache_exp = GNUNET_TIME_relative_to_absolute (PONG_SIGNATURE_LIFETIME);
1212     pong->expiration = GNUNET_TIME_absolute_hton (*sig_cache_exp);
1213     if (GNUNET_OK !=
1214                    GNUNET_CRYPTO_eddsa_sign (GST_my_private_key, &pong->purpose,
1215                                            sig_cache))
1216     {
1217         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1218                 _("Failed to create PONG signature for peer `%s'\n"), GNUNET_i2s (sender));
1219     }
1220   }
1221   else
1222   {
1223     pong->expiration = GNUNET_TIME_absolute_hton (*sig_cache_exp);
1224   }
1225   pong->signature = *sig_cache;
1226
1227   GNUNET_assert (NULL != sender_address);
1228
1229   /* first see if the session we got this PING from can be used to transmit
1230    * a response reliably */
1231   if (NULL == papi)
1232   {
1233     ret = -1;
1234   }
1235   else
1236   {
1237     GNUNET_assert (NULL != papi->send);
1238     GNUNET_assert (NULL != papi->get_session);
1239     if (NULL == session)
1240     {
1241       session = papi->get_session (papi->cls, sender_address);
1242     }
1243     if (NULL == session)
1244     {
1245       GNUNET_break (0);
1246       ret = -1;
1247     }
1248     else
1249     {
1250       ret = papi->send (papi->cls, session,
1251                         (const char *) pong,
1252                         ntohs (pong->header.size),
1253                         PONG_PRIORITY, ACCEPTABLE_PING_DELAY,
1254                         NULL, NULL);
1255       if (-1 != ret)
1256         GST_neighbours_notify_data_sent (sender_address,
1257                                          session,
1258                                          pong->header.size);
1259     }
1260   }
1261   if (-1 != ret)
1262   {
1263     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1264                 "Transmitted PONG to `%s' via reliable mechanism\n",
1265                 GNUNET_i2s (sender));
1266     /* done! */
1267     GNUNET_STATISTICS_update (GST_stats,
1268                               gettext_noop
1269                               ("# PONGs unicast via reliable transport"), 1,
1270                               GNUNET_NO);
1271     GNUNET_free (pong);
1272     return GNUNET_OK;
1273   }
1274
1275   /* no reliable method found, try transmission via all known addresses */
1276   GNUNET_STATISTICS_update (GST_stats,
1277                             gettext_noop
1278                             ("# PONGs multicast to all available addresses"), 1,
1279                             GNUNET_NO);
1280   GST_validation_get_addresses (sender,
1281                                 &multicast_pong, pong);
1282   GNUNET_free (pong);
1283   return GNUNET_OK;
1284 }
1285
1286
1287 /**
1288  * Validate an individual address.
1289  *
1290  * @param address address we should try to validate
1291  */
1292 void
1293 GST_validation_handle_address (const struct GNUNET_HELLO_Address *address)
1294 {
1295   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1296   struct ValidationEntry *ve;
1297
1298   papi = GST_plugins_find (address->transport_name);
1299   if (NULL == papi)
1300   {
1301     /* This plugin is currently unvailable ... ignore */
1302     return;
1303   }
1304   ve = find_validation_entry (address);
1305   if (NULL == ve->revalidation_task)
1306   {
1307     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1308                 "Validation process started for fresh address `%s' of %s\n",
1309                 GST_plugins_a2s (ve->address),
1310                 GNUNET_i2s (&ve->address->peer));
1311     ve->revalidation_task = GNUNET_SCHEDULER_add_now (&revalidate_address, ve);
1312   }
1313 }
1314
1315
1316 /**
1317  * Iterator callback to go over all addresses and try to validate them
1318  * (unless blocked or already validated).
1319  *
1320  * @param cls NULL
1321  * @param address the address
1322  * @param expiration expiration time
1323  * @return #GNUNET_OK (keep the address)
1324  */
1325 static int
1326 validate_address_iterator (void *cls,
1327                            const struct GNUNET_HELLO_Address *address,
1328                            struct GNUNET_TIME_Absolute expiration)
1329 {
1330   if (0 == GNUNET_TIME_absolute_get_remaining (expiration).rel_value_us)
1331   {
1332     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1333                 "Skipping expired address from HELLO\n");
1334     return GNUNET_OK;           /* expired */
1335   }
1336   GST_validation_handle_address (address);
1337   return GNUNET_OK;
1338 }
1339
1340
1341 /**
1342  * Add the validated peer address to the HELLO.
1343  *
1344  * @param cls the `struct ValidationEntry *` with the validated address
1345  * @param max space in @a buf
1346  * @param buf where to add the address
1347  * @return number of bytes written, #GNUNET_SYSERR to signal the
1348  *         end of the iteration.
1349  */
1350 static ssize_t
1351 add_valid_peer_address (void *cls,
1352                         size_t max,
1353                         void *buf)
1354 {
1355   struct ValidationEntry *ve = cls;
1356
1357   if (GNUNET_YES == ve->copied)
1358     return GNUNET_SYSERR; /* Done */
1359   ve->copied = GNUNET_YES;
1360   return GNUNET_HELLO_add_address (ve->address,
1361                                    ve->valid_until,
1362                                    buf,
1363                                    max);
1364 }
1365
1366
1367 /**
1368  * We've received a PONG.  Check if it matches a pending PING and
1369  * mark the respective address as confirmed.
1370  *
1371  * @param sender peer sending the PONG
1372  * @param hdr the PONG
1373  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
1374  */
1375 int
1376 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
1377                             const struct GNUNET_MessageHeader *hdr)
1378 {
1379   const struct TransportPongMessage *pong;
1380   struct ValidationEntry *ve;
1381   const char *tname;
1382   const char *addr;
1383   size_t addrlen;
1384   size_t slen;
1385   size_t size;
1386   struct GNUNET_HELLO_Message *hello;
1387   struct GNUNET_HELLO_Address address;
1388   int sig_res;
1389   int do_verify;
1390
1391   if (ntohs (hdr->size) < sizeof (struct TransportPongMessage))
1392   {
1393     GNUNET_break_op (0);
1394     return GNUNET_SYSERR;
1395   }
1396   GNUNET_STATISTICS_update (GST_stats,
1397                             gettext_noop ("# PONG messages received"), 1,
1398                             GNUNET_NO);
1399
1400   /* message with structure:
1401    * [TransportPongMessage][Transport name][Address] */
1402
1403   pong = (const struct TransportPongMessage *) hdr;
1404   tname = (const char *) &pong[1];
1405   size = ntohs (hdr->size) - sizeof (struct TransportPongMessage);
1406   addr = memchr (tname, '\0', size);
1407   if (NULL == addr)
1408   {
1409     GNUNET_break_op (0);
1410     return GNUNET_SYSERR;
1411   }
1412   addr++;
1413   slen = strlen (tname) + 1;
1414   addrlen = size - slen;
1415
1416   if (NULL == GST_plugins_find (tname))
1417   {
1418     /* we got the PONG, but the transport plugin specified in it
1419        is not supported by this peer, so this cannot be a good
1420        PONG for us. */
1421     GNUNET_break_op (0);
1422     return GNUNET_OK;
1423   }
1424
1425   address.peer = *sender;
1426   address.address = addr;
1427   address.address_length = addrlen;
1428   address.transport_name = tname;
1429   address.local_info = GNUNET_HELLO_ADDRESS_INFO_NONE;
1430   ve = find_validation_entry (&address);
1431   if ((NULL == ve) || (GNUNET_NO == ve->expecting_pong))
1432   {
1433     GNUNET_STATISTICS_update (GST_stats,
1434                               gettext_noop
1435                               ("# PONGs dropped, no matching pending validation"),
1436                               1, GNUNET_NO);
1437     return GNUNET_OK;
1438   }
1439   /* now check that PONG is well-formed */
1440   if (0 != memcmp (&ve->address->peer,
1441                    sender,
1442                    sizeof (struct GNUNET_PeerIdentity)))
1443   {
1444     GNUNET_break_op (0);
1445     return GNUNET_SYSERR;
1446   }
1447   if (0 ==
1448       GNUNET_TIME_absolute_get_remaining
1449       (GNUNET_TIME_absolute_ntoh (pong->expiration)).rel_value_us)
1450   {
1451     GNUNET_STATISTICS_update (GST_stats,
1452                               gettext_noop
1453                               ("# PONGs dropped, signature expired"), 1,
1454                               GNUNET_NO);
1455     return GNUNET_SYSERR;
1456   }
1457
1458   sig_res = GNUNET_SYSERR;
1459   do_verify = GNUNET_YES;
1460   if (0 != GNUNET_TIME_absolute_get_remaining (ve->pong_sig_valid_until).rel_value_us)
1461   {
1462     /* We have a cached and valid signature for this peer,
1463      * try to compare instead of verify */
1464     if (0 == memcmp (&ve->pong_sig_cache,
1465                      &pong->signature,
1466                      sizeof (struct GNUNET_CRYPTO_EddsaSignature)))
1467     {
1468       /* signatures are identical, we can skip verification */
1469       sig_res = GNUNET_OK;
1470       do_verify = GNUNET_NO;
1471     }
1472     else
1473     {
1474       sig_res = GNUNET_SYSERR;
1475       /* signatures do not match, we have to verify */
1476     }
1477   }
1478
1479   if (GNUNET_YES == do_verify)
1480   {
1481     /* Do expensive verification */
1482     sig_res = GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN,
1483                                           &pong->purpose,
1484                                           &pong->signature,
1485                                           &ve->address->peer.public_key);
1486     if (sig_res == GNUNET_SYSERR)
1487     {
1488       GNUNET_break_op (0);
1489       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1490                   "Failed to verify: invalid signature on address `%s':%s from peer `%s'\n",
1491                   tname,
1492                   GST_plugins_a2s (ve->address),
1493                   GNUNET_i2s (sender));
1494     }
1495   }
1496   if (sig_res == GNUNET_SYSERR)
1497   {
1498     GNUNET_break_op (0);
1499     return GNUNET_SYSERR;
1500   }
1501
1502   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1503               "Validation process successful for peer `%s' with plugin `%s' address `%s'\n",
1504               GNUNET_i2s (sender),
1505               tname,
1506               GST_plugins_a2s (ve->address));
1507   GNUNET_STATISTICS_update (GST_stats,
1508                             gettext_noop ("# validations succeeded"),
1509                             1,
1510                             GNUNET_NO);
1511   /* validity achieved, remember it! */
1512   ve->expecting_pong = GNUNET_NO;
1513   ve->valid_until = GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
1514   ve->pong_sig_cache = pong->signature;
1515   ve->pong_sig_valid_until = GNUNET_TIME_absolute_ntoh (pong->expiration);
1516   ve->latency = GNUNET_TIME_absolute_get_duration (ve->send_time);
1517   {
1518     if (GNUNET_YES == ve->known_to_ats)
1519     {
1520       GNUNET_assert (GNUNET_YES ==
1521                      GST_ats_is_known_no_session (ve->address));
1522       GST_ats_update_delay (ve->address,
1523                             GNUNET_TIME_relative_divide (ve->latency, 2));
1524     }
1525     else
1526     {
1527       struct GNUNET_ATS_Properties prop;
1528
1529       memset (&prop, 0, sizeof (prop));
1530       GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != ve->network);
1531       prop.scope = ve->network;
1532       prop.delay = GNUNET_TIME_relative_divide (ve->latency, 2);
1533       GNUNET_assert (GNUNET_NO ==
1534                      GST_ats_is_known_no_session (ve->address));
1535       ve->known_to_ats = GNUNET_YES;
1536       GST_ats_add_address (ve->address, &prop);
1537       GNUNET_assert (GNUNET_YES ==
1538                      GST_ats_is_known_no_session (ve->address));
1539     }
1540   }
1541   if (validations_running > 0)
1542   {
1543     validations_running--;
1544     GNUNET_STATISTICS_set (GST_stats,
1545                            gettext_noop ("# validations running"),
1546                            validations_running,
1547                            GNUNET_NO);
1548     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1549                 "Validation finished, %u validation processes running\n",
1550                 validations_running);
1551   }
1552   else
1553   {
1554     GNUNET_break (0);
1555   }
1556
1557   /* Notify about new validity */
1558   validation_entry_changed (ve,
1559                             GNUNET_TRANSPORT_VS_UPDATE);
1560
1561   /* build HELLO to store in PEERINFO */
1562   ve->copied = GNUNET_NO;
1563   hello = GNUNET_HELLO_create (&ve->address->peer.public_key,
1564                                &add_valid_peer_address,
1565                                ve,
1566                                GNUNET_NO);
1567   GNUNET_PEERINFO_add_peer (GST_peerinfo,
1568                             hello,
1569                             NULL,
1570                             NULL);
1571   GNUNET_free (hello);
1572   return GNUNET_OK;
1573 }
1574
1575
1576 /**
1577  * We've received a HELLO, check which addresses are new and trigger
1578  * validation.
1579  *
1580  * @param hello the HELLO we received
1581  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
1582  */
1583 int
1584 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello)
1585 {
1586   const struct GNUNET_HELLO_Message *hm =
1587       (const struct GNUNET_HELLO_Message *) hello;
1588   struct GNUNET_PeerIdentity pid;
1589   int friend;
1590
1591   friend = GNUNET_HELLO_is_friend_only (hm);
1592   if ( ( (GNUNET_YES != friend) &&
1593          (GNUNET_NO != friend) ) ||
1594        (GNUNET_OK != GNUNET_HELLO_get_id (hm, &pid)) )
1595   {
1596     /* malformed HELLO */
1597     GNUNET_break_op (0);
1598     return GNUNET_SYSERR;
1599   }
1600   if (0 ==
1601       memcmp (&GST_my_identity,
1602               &pid,
1603               sizeof (struct GNUNET_PeerIdentity)))
1604   {
1605     /* got our own HELLO, how boring */
1606     return GNUNET_OK;
1607   }
1608   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1609               "Validation received HELLO message for peer `%s' with size %u, checking for new addresses\n",
1610               GNUNET_i2s (&pid),
1611               ntohs (hello->size));
1612   GNUNET_assert (NULL ==
1613                  GNUNET_HELLO_iterate_addresses (hm,
1614                                                  GNUNET_NO,
1615                                                  &validate_address_iterator,
1616                                                  NULL));
1617   return GNUNET_OK;
1618 }
1619
1620
1621 /**
1622  * Closure for #iterate_addresses().
1623  */
1624 struct IteratorContext
1625 {
1626   /**
1627    * Function to call on each address.
1628    */
1629   GST_ValidationAddressCallback cb;
1630
1631   /**
1632    * Closure for @e cb.
1633    */
1634   void *cb_cls;
1635
1636 };
1637
1638
1639 /**
1640  * Call the callback in the closure for each validation entry.
1641  *
1642  * @param cls the `struct IteratorContext`
1643  * @param key the peer's identity
1644  * @param value the `struct ValidationEntry`
1645  * @return #GNUNET_OK (continue to iterate)
1646  */
1647 static int
1648 iterate_addresses (void *cls,
1649                    const struct GNUNET_PeerIdentity *key,
1650                    void *value)
1651 {
1652   struct IteratorContext *ic = cls;
1653   struct ValidationEntry *ve = value;
1654
1655   ic->cb (ic->cb_cls,
1656           ve->valid_until,
1657           ve->revalidation_block,
1658           ve->address);
1659   return GNUNET_OK;
1660 }
1661
1662
1663 /**
1664  * Call the given function for each address for the given target.
1665  * Can either give a snapshot (synchronous API) or be continuous.
1666  *
1667  * @param target peer information is requested for
1668  * @param cb function to call; will not be called after this function returns
1669  * @param cb_cls closure for @a cb
1670  */
1671 void
1672 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
1673                               GST_ValidationAddressCallback cb,
1674                               void *cb_cls)
1675 {
1676   struct IteratorContext ic;
1677
1678   ic.cb = cb;
1679   ic.cb_cls = cb_cls;
1680   GNUNET_CONTAINER_multipeermap_get_multiple (validation_map,
1681                                               target,
1682                                               &iterate_addresses, &ic);
1683 }
1684
1685
1686 /**
1687  * Update if we are using an address for a connection actively right now.
1688  * Based on this, the validation module will measure latency for the
1689  * address more or less often.
1690  *
1691  * @param address the address that we are now using (or not)
1692  * @param in_use #GNUNET_YES if we are now using the address for a connection,
1693  *               #GNUNET_NO if we are no longer using the address for a connection
1694  */
1695 void
1696 GST_validation_set_address_use (const struct GNUNET_HELLO_Address *address,
1697                                 int in_use)
1698 {
1699   struct ValidationEntry *ve;
1700
1701   if (GNUNET_HELLO_address_check_option (address,
1702                                          GNUNET_HELLO_ADDRESS_INFO_INBOUND))
1703     return; /* ignore inbound for validation */
1704   if (NULL == GST_plugins_find (address->transport_name))
1705   {
1706     /* How can we use an address for which we don't have the plugin? */
1707     GNUNET_break (0);
1708     return;
1709   }
1710   ve = find_validation_entry (address);
1711   if (NULL == ve)
1712   {
1713     GNUNET_break (0);
1714     return;
1715   }
1716   if (in_use == ve->in_use)
1717     return;
1718   ve->in_use = in_use;
1719   if (GNUNET_YES == in_use)
1720   {
1721     /* from now on, higher frequeny, so reschedule now */
1722     if (NULL != ve->revalidation_task)
1723       GNUNET_SCHEDULER_cancel (ve->revalidation_task);
1724     ve->revalidation_task = GNUNET_SCHEDULER_add_now (&revalidate_address,
1725                                                       ve);
1726   }
1727 }
1728
1729
1730 /**
1731  * Closure for the validation_entries_iterate function.
1732  */
1733 struct ValidationIteratorContext
1734 {
1735   /**
1736    * Function to call on each validation entry
1737    */
1738   GST_ValidationChangedCallback cb;
1739
1740   /**
1741    * Closure for @e cb.
1742    */
1743   void *cb_cls;
1744 };
1745
1746
1747 /**
1748  * Function called on each entry in the validation map.
1749  * Passes the information from the validation entry to
1750  * the callback given in the closure.
1751  *
1752  * @param cls the `struct ValidationIteratorContext`
1753  * @param key peer this is about
1754  * @param value the `struct ValidationEntry`
1755  * @return #GNUNET_OK (continue to iterate)
1756  */
1757 static int
1758 validation_entries_iterate (void *cls,
1759                             const struct GNUNET_PeerIdentity *key,
1760                             void *value)
1761 {
1762   struct ValidationIteratorContext *ic = cls;
1763   struct ValidationEntry *ve = value;
1764
1765   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1766               "Notifying about validation entry for peer `%s' address `%s' \n",
1767               GNUNET_i2s (&ve->address->peer),
1768               GST_plugins_a2s (ve->address));
1769   ic->cb (ic->cb_cls,
1770           ve->address,
1771           ve->send_time,
1772           ve->valid_until,
1773           ve->next_validation,
1774           ve->state);
1775   return GNUNET_OK;
1776 }
1777
1778
1779 /**
1780  * Iterate over all iteration entries
1781  *
1782  * @param cb function to call
1783  * @param cb_cls closure for @a cb
1784  */
1785 void
1786 GST_validation_iterate (GST_ValidationChangedCallback cb,
1787                         void *cb_cls)
1788 {
1789   struct ValidationIteratorContext ic;
1790
1791   if (NULL == validation_map)
1792     return; /* can happen during shutdown */
1793   ic.cb = cb;
1794   ic.cb_cls = cb_cls;
1795   GNUNET_CONTAINER_multipeermap_iterate (validation_map,
1796                                          &validation_entries_iterate,
1797                                          &ic);
1798 }
1799
1800 /* end of file gnunet-service-transport_validation.c */