compile
[oweals/gnunet.git] / src / transport / gnunet-service-transport_validation.c
1 /*
2      This file is part of GNUnet.
3      (C) 2010,2011 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_validation.h"
28 #include "gnunet-service-transport_plugins.h"
29 #include "gnunet-service-transport_hello.h"
30 #include "gnunet-service-transport_blacklist.h"
31 #include "gnunet-service-transport.h"
32 #include "gnunet_hello_lib.h"
33 #include "gnunet_ats_service.h"
34 #include "gnunet_peerinfo_service.h"
35 #include "gnunet_signatures.h"
36
37 // TODO: observe latency between PING/PONG and give information to ATS!
38
39 /**
40  * How long is a PONG signature valid?  We'll recycle a signature until
41  * 1/4 of this time is remaining.  PONGs should expire so that if our
42  * external addresses change an adversary cannot replay them indefinitely.
43  * OTOH, we don't want to spend too much time generating PONG signatures,
44  * so they must have some lifetime to reduce our CPU usage.
45  */
46 #define PONG_SIGNATURE_LIFETIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
47
48 /**
49  * After how long do we expire an address in a HELLO that we just
50  * validated?  This value is also used for our own addresses when we
51  * create a HELLO.
52  */
53 #define HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
54
55 /**
56  * How long before an existing address expires should we again try to
57  * validate it?  Must be (significantly) smaller than
58  * HELLO_ADDRESS_EXPIRATION.
59  */
60 #define HELLO_REVALIDATION_START_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
61
62 /**
63  * Size of the validation map hashmap.
64  */
65 #define VALIDATION_MAP_SIZE 256
66
67 /**
68  * Priority to use for PINGs
69  */
70 #define PING_PRIORITY 2
71
72 /**
73  * Priority to use for PONGs
74  */
75 #define PONG_PRIORITY 4
76
77
78 /**
79  * Message used to ask a peer to validate receipt (to check an address
80  * from a HELLO).  Followed by the address we are trying to validate,
81  * or an empty address if we are just sending a PING to confirm that a
82  * connection which the receiver (of the PING) initiated is still valid.
83  */
84 struct TransportPingMessage
85 {
86
87   /**
88    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PING
89    */
90   struct GNUNET_MessageHeader header;
91
92   /**
93    * Challenge code (to ensure fresh reply).
94    */
95   uint32_t challenge GNUNET_PACKED;
96
97   /**
98    * Who is the intended recipient?
99    */
100   struct GNUNET_PeerIdentity target;
101
102 };
103
104
105 /**
106  * Message used to validate a HELLO.  The challenge is included in the
107  * confirmation to make matching of replies to requests possible.  The
108  * signature signs our public key, an expiration time and our address.<p>
109  *
110  * This message is followed by our transport address that the PING tried
111  * to confirm (if we liked it).  The address can be empty (zero bytes)
112  * if the PING had not address either (and we received the request via
113  * a connection that we initiated).
114  */
115 struct TransportPongMessage
116 {
117
118   /**
119    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PONG
120    */
121   struct GNUNET_MessageHeader header;
122
123   /**
124    * Challenge code from PING (showing freshness).  Not part of what
125    * is signed so that we can re-use signatures.
126    */
127   uint32_t challenge GNUNET_PACKED;
128
129   /**
130    * Signature.
131    */
132   struct GNUNET_CRYPTO_RsaSignature signature;
133
134   /**
135    * GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN to confirm that this is a
136    * plausible address for the signing peer.
137    */
138   struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
139
140   /**
141    * When does this signature expire?
142    */
143   struct GNUNET_TIME_AbsoluteNBO expiration;
144
145   /**
146    * Size of address appended to this message (part of what is
147    * being signed, hence not redundant).
148    */
149   uint32_t addrlen GNUNET_PACKED;
150
151 };
152
153
154 /**
155  * Information about an address under validation
156  */
157 struct ValidationEntry
158 {
159
160   /**
161    * Name of the transport.
162    */
163   char *transport_name;
164
165   /**
166    * The address, actually a pointer to the end
167    * of this struct.  Do not free!
168    */
169   const void *addr;
170
171   /**
172    * Handle to the blacklist check (if we're currently in it).
173    */
174   struct GST_BlacklistCheck *bc;
175
176   /**
177    * Public key of the peer.
178    */
179   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
180
181   /**
182    * The identity of the peer.
183    */
184   struct GNUNET_PeerIdentity pid;
185
186   /**
187    * ID of task that will clean up this entry if nothing happens.
188    */
189   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
190
191   /**
192    * At what time did we send the latest validation request?
193    */
194   struct GNUNET_TIME_Absolute send_time;
195
196   /**
197    * Until when is this address valid?
198    * ZERO if it is not currently considered valid.
199    */
200   struct GNUNET_TIME_Absolute valid_until;
201
202   /**
203    * How long until we can try to validate this address again?
204    * FOREVER if the address is for an unsupported plugin (from PEERINFO)
205    * ZERO if the address is considered valid (no validation needed)
206    * otherwise a time in the future if we're currently denying re-validation
207    */
208   struct GNUNET_TIME_Absolute validation_block;
209
210   /**
211    * Challenge number we used.
212    */
213   uint32_t challenge;
214
215   /**
216    * Length of addr.
217    */
218   size_t addrlen;
219
220   /**
221    * When passing the address in 'add_valid_peer_address', did we
222    * copy the address to the HELLO yet?
223    */
224   int copied;
225
226 };
227
228
229 /**
230  * Context of currently active requests to peerinfo
231  * for validation of HELLOs.
232  */
233 struct CheckHelloValidatedContext
234 {
235
236   /**
237    * This is a doubly-linked list.
238    */
239   struct CheckHelloValidatedContext *next;
240
241   /**
242    * This is a doubly-linked list.
243    */
244   struct CheckHelloValidatedContext *prev;
245
246   /**
247    * Hello that we are validating.
248    */
249   const struct GNUNET_HELLO_Message *hello;
250
251 };
252
253
254 /**
255  * Head of linked list of HELLOs awaiting validation.
256  */
257 static struct CheckHelloValidatedContext *chvc_head;
258
259 /**
260  * Tail of linked list of HELLOs awaiting validation
261  */
262 static struct CheckHelloValidatedContext *chvc_tail;
263
264 /**
265  * Map of PeerIdentities to 'struct ValidationEntry*'s (addresses
266  * of the given peer that we are currently validating, have validated
267  * or are blocked from re-validation for a while).
268  */
269 static struct GNUNET_CONTAINER_MultiHashMap *validation_map;
270
271 /**
272  * Context for peerinfo iteration.
273  */
274 static struct GNUNET_PEERINFO_NotifyContext *pnc;
275
276
277 /**
278  * Context for the validation entry match function.
279  */
280 struct ValidationEntryMatchContext
281 {
282   /**
283    * Where to store the result?
284    */
285   struct ValidationEntry *ve;
286
287   /**
288    * Transport name we're looking for.
289    */
290   const char *transport_name;
291
292   /**
293    * Address we're interested in.
294    */
295   const char *addr;
296
297   /**
298    * Number of bytes in 'addr'.
299    */
300   size_t addrlen;
301 };
302
303
304 /**
305  * Iterate over validation entries until a matching one is found.
306  *
307  * @param cls the 'struct ValidationEntryMatchContext'
308  * @param key peer identity (unused)
309  * @param value a 'struct ValidationEntry' to match
310  * @return GNUNET_YES if the entry does not match,
311  *         GNUNET_NO if the entry does match
312  */
313 static int
314 validation_entry_match (void *cls, const GNUNET_HashCode * key, void *value)
315 {
316   struct ValidationEntryMatchContext *vemc = cls;
317   struct ValidationEntry *ve = value;
318
319   if ((ve->addrlen == vemc->addrlen) &&
320       (0 == memcmp (ve->addr, vemc->addr, ve->addrlen)) &&
321       (0 == strcmp (ve->transport_name, vemc->transport_name)))
322   {
323     vemc->ve = ve;
324     return GNUNET_NO;
325   }
326   return GNUNET_YES;
327 }
328
329
330 /**
331  * Find a ValidationEntry entry for the given neighbour that matches
332  * the given address and transport.  If none exists, create one (but
333  * without starting any validation).
334  *
335  * @param public_key public key of the peer, NULL for unknown
336  * @param neighbour which peer we care about
337  * @param tname name of the transport plugin
338  * @param addr binary address
339  * @param addrlen length of addr
340  * @return validation entry matching the given specifications, NULL
341  *         if we don't have an existing entry and no public key was given
342  */
343 static struct ValidationEntry *
344 find_validation_entry (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
345                        *public_key, const struct GNUNET_PeerIdentity *neighbour,
346                        const char *tname, const char *addr, size_t addrlen)
347 {
348   struct ValidationEntryMatchContext vemc;
349   struct ValidationEntry *ve;
350
351   vemc.ve = NULL;
352   vemc.transport_name = tname;
353   vemc.addr = addr;
354   vemc.addrlen = addrlen;
355   GNUNET_CONTAINER_multihashmap_get_multiple (validation_map,
356                                               &neighbour->hashPubKey,
357                                               &validation_entry_match, &vemc);
358   if (NULL != (ve = vemc.ve))
359     return ve;
360   if (public_key == NULL)
361     return NULL;
362   ve = GNUNET_malloc (sizeof (struct ValidationEntry) + addrlen);
363   ve->transport_name = GNUNET_strdup (tname);
364   ve->addr = (void *) &ve[1];
365   ve->public_key = *public_key;
366   ve->pid = *neighbour;
367   ve->challenge =
368       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
369   memcpy (&ve[1], addr, addrlen);
370   ve->addrlen = addrlen;
371   GNUNET_CONTAINER_multihashmap_put (validation_map, &neighbour->hashPubKey, ve,
372                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
373   return ve;
374 }
375
376
377 /**
378  * Iterator which adds the given address to the set of validated
379  * addresses.
380  *
381  * @param cls original HELLO message
382  * @param tname name of the transport
383  * @param expiration expiration time
384  * @param addr the address
385  * @param addrlen length of the address
386  * @return GNUNET_OK (keep the address)
387  */
388 static int
389 add_valid_address (void *cls, const char *tname,
390                    struct GNUNET_TIME_Absolute expiration, const void *addr,
391                    uint16_t addrlen)
392 {
393   const struct GNUNET_HELLO_Message *hello = cls;
394   struct ValidationEntry *ve;
395   struct GNUNET_PeerIdentity pid;
396   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
397
398   if (GNUNET_TIME_absolute_get_remaining (expiration).rel_value == 0)
399     return GNUNET_OK;           /* expired */
400   if ((GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid)) ||
401       (GNUNET_OK != GNUNET_HELLO_get_key (hello, &public_key)))
402   {
403     GNUNET_break (0);
404     return GNUNET_OK;           /* invalid HELLO !? */
405   }
406   ve = find_validation_entry (&public_key, &pid, tname, addr, addrlen);
407   ve->valid_until = GNUNET_TIME_absolute_max (ve->valid_until, expiration);
408   GNUNET_ATS_address_update (GST_ats, &pid, tname, addr,
409                              addrlen, NULL, NULL, 0);
410   return GNUNET_OK;
411 }
412
413
414 /**
415  * Function called for any HELLO known to PEERINFO.
416  *
417  * @param cls unused
418  * @param peer id of the peer, NULL for last call
419  * @param hello hello message for the peer (can be NULL)
420  * @param err_msg error message
421  */
422 static void
423 process_peerinfo_hello (void *cls, const struct GNUNET_PeerIdentity *peer,
424                         const struct GNUNET_HELLO_Message *hello,
425                         const char *err_msg)
426 {
427   GNUNET_assert (NULL != peer);
428   if (NULL == hello)
429     return;
430   GNUNET_assert (NULL ==
431                  GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO,
432                                                  &add_valid_address,
433                                                  (void *) hello));
434 }
435
436
437 /**
438  * Start the validation subsystem.
439  */
440 void
441 GST_validation_start ()
442 {
443   validation_map = GNUNET_CONTAINER_multihashmap_create (VALIDATION_MAP_SIZE);
444   pnc = GNUNET_PEERINFO_notify (GST_cfg, &process_peerinfo_hello, NULL);
445 }
446
447
448 /**
449  * Iterate over validation entries and free them.
450  *
451  * @param cls (unused)
452  * @param key peer identity (unused)
453  * @param value a 'struct ValidationEntry' to clean up
454  * @return GNUNET_YES (continue to iterate)
455  */
456 static int
457 cleanup_validation_entry (void *cls, const GNUNET_HashCode * key, void *value)
458 {
459   struct ValidationEntry *ve = value;
460
461   if (NULL != ve->bc)
462   {
463     GST_blacklist_test_cancel (ve->bc);
464     ve->bc = NULL;
465   }
466   GNUNET_break (GNUNET_OK ==
467                 GNUNET_CONTAINER_multihashmap_remove (validation_map,
468                                                       &ve->pid.hashPubKey, ve));
469   GNUNET_free (ve->transport_name);
470   if (GNUNET_SCHEDULER_NO_TASK != ve->timeout_task)
471   {
472     GNUNET_SCHEDULER_cancel (ve->timeout_task);
473     ve->timeout_task = GNUNET_SCHEDULER_NO_TASK;
474   }
475   GNUNET_free (ve);
476   return GNUNET_OK;
477 }
478
479
480 /**
481  * Stop the validation subsystem.
482  */
483 void
484 GST_validation_stop ()
485 {
486   struct CheckHelloValidatedContext *chvc;
487
488   GNUNET_CONTAINER_multihashmap_iterate (validation_map,
489                                          &cleanup_validation_entry, NULL);
490   GNUNET_CONTAINER_multihashmap_destroy (validation_map);
491   validation_map = NULL;
492   while (NULL != (chvc = chvc_head))
493   {
494     GNUNET_CONTAINER_DLL_remove (chvc_head, chvc_tail, chvc);
495     GNUNET_free (chvc);
496   }
497   GNUNET_PEERINFO_notify_cancel (pnc);
498 }
499
500
501 /**
502  * Address validation cleanup task (record no longer needed).
503  *
504  * @param cls the 'struct ValidationEntry'
505  * @param tc scheduler context (unused)
506  */
507 static void
508 timeout_hello_validation (void *cls,
509                           const struct GNUNET_SCHEDULER_TaskContext *tc)
510 {
511   struct ValidationEntry *ve = cls;
512
513   ve->timeout_task = GNUNET_SCHEDULER_NO_TASK;
514   GNUNET_STATISTICS_update (GST_stats,
515                             gettext_noop ("# address records discarded"), 1,
516                             GNUNET_NO);
517   cleanup_validation_entry (NULL, &ve->pid.hashPubKey, ve);
518 }
519
520
521 /**
522  * Send the given PONG to the given address.
523  *
524  * @param cls the PONG message
525  * @param public_key public key for the peer, never NULL
526  * @param target peer this change is about, never NULL
527  * @param valid_until is ZERO if we never validated the address,
528  *                    otherwise a time up to when we consider it (or was) valid
529  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
530  *                          is ZERO if the address is considered valid (no validation needed)
531  *                          otherwise a time in the future if we're currently denying re-validation
532  * @param plugin_name name of the plugin
533  * @param plugin_address binary address
534  * @param plugin_address_len length of address
535  */
536 static void
537 multicast_pong (void *cls,
538                 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
539                 *public_key, const struct GNUNET_PeerIdentity *target,
540                 struct GNUNET_TIME_Absolute valid_until,
541                 struct GNUNET_TIME_Absolute validation_block,
542                 const char *plugin_name, const void *plugin_address,
543                 size_t plugin_address_len)
544 {
545   struct TransportPongMessage *pong = cls;
546   struct GNUNET_TRANSPORT_PluginFunctions *papi;
547
548   papi = GST_plugins_find (plugin_name);
549   if (papi == NULL)
550     return;
551   (void) papi->send (papi->cls, target, (const char *) pong,
552                      ntohs (pong->header.size), PONG_PRIORITY,
553                      HELLO_REVALIDATION_START_TIME, NULL, plugin_address,
554                      plugin_address_len, GNUNET_YES, NULL, NULL);
555 }
556
557
558 /**
559  * We've received a PING.  If appropriate, generate a PONG.
560  *
561  * @param sender peer sending the PING
562  * @param hdr the PING
563  * @param session session we got the PING from
564  * @param plugin_name name of plugin that received the PING
565  * @param sender_address address of the sender as known to the plugin, NULL
566  *                       if we did not initiate the connection
567  * @param sender_address_len number of bytes in sender_address
568  */
569 void
570 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
571                             const struct GNUNET_MessageHeader *hdr,
572                             const char *plugin_name, struct Session *session,
573                             const void *sender_address,
574                             size_t sender_address_len)
575 {
576   const struct TransportPingMessage *ping;
577   struct TransportPongMessage *pong;
578   struct GNUNET_TRANSPORT_PluginFunctions *papi;
579   struct GNUNET_CRYPTO_RsaSignature *sig_cache;
580   struct GNUNET_TIME_Absolute *sig_cache_exp;
581   const char *addr;
582   const char *addrend;
583   size_t alen;
584   size_t slen;
585   ssize_t ret;
586
587   if (ntohs (hdr->size) < sizeof (struct TransportPingMessage))
588   {
589     GNUNET_break_op (0);
590     return;
591   }
592   ping = (const struct TransportPingMessage *) hdr;
593   if (0 !=
594       memcmp (&ping->target, &GST_my_identity,
595               sizeof (struct GNUNET_PeerIdentity)))
596   {
597     GNUNET_break_op (0);
598     return;
599   }
600   GNUNET_STATISTICS_update (GST_stats,
601                             gettext_noop ("# PING messages received"), 1,
602                             GNUNET_NO);
603   addr = (const char *) &ping[1];
604   alen = ntohs (hdr->size) - sizeof (struct TransportPingMessage);
605   /* peer wants to confirm that this is one of our addresses, this is what is
606    * used for address validation */
607
608   addrend = memchr (addr, '\0', alen);
609   if (NULL == addrend)
610   {
611     GNUNET_break_op (0);
612     return;
613   }
614   addrend++;
615   slen = strlen (addr) + 1;
616   alen -= slen;
617
618   if (GNUNET_YES !=
619       GST_hello_test_address (addr, addrend, alen, &sig_cache, &sig_cache_exp))
620   {
621     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
622                 _
623                 ("Not confirming PING with address `%s' since I cannot confirm having this address.\n"),
624                 GST_plugins_a2s (addr, addrend, alen));
625     return;
626   }
627
628   pong = GNUNET_malloc (sizeof (struct TransportPongMessage) + alen + slen);
629   pong->header.size =
630       htons (sizeof (struct TransportPongMessage) + alen + slen);
631   pong->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_PONG);
632   pong->purpose.size =
633       htonl (sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
634              sizeof (uint32_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO) +
635              alen + slen);
636   pong->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN);
637   pong->challenge = ping->challenge;
638   pong->addrlen = htonl (alen + slen);
639   memcpy (&pong[1], addr, slen);
640   memcpy (&((char *) &pong[1])[slen], addrend, alen);
641   if (GNUNET_TIME_absolute_get_remaining (*sig_cache_exp).rel_value <
642       PONG_SIGNATURE_LIFETIME.rel_value / 4)
643   {
644     /* create / update cached sig */
645 #if DEBUG_TRANSPORT
646     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
647                 "Creating PONG signature to indicate ownership.\n");
648 #endif
649     *sig_cache_exp = GNUNET_TIME_relative_to_absolute (PONG_SIGNATURE_LIFETIME);
650     pong->expiration = GNUNET_TIME_absolute_hton (*sig_cache_exp);
651     GNUNET_assert (GNUNET_OK ==
652                    GNUNET_CRYPTO_rsa_sign (GST_my_private_key, &pong->purpose,
653                                            sig_cache));
654   }
655   else
656   {
657     pong->expiration = GNUNET_TIME_absolute_hton (*sig_cache_exp);
658   }
659   pong->signature = *sig_cache;
660
661   /* first see if the session we got this PING from can be used to transmit
662    * a response reliably */
663   papi = GST_plugins_find (plugin_name);
664   if (papi == NULL)
665     ret = -1;
666   else
667     ret =
668         papi->send (papi->cls, sender, (const char *) pong,
669                     ntohs (pong->header.size), PONG_PRIORITY,
670                     HELLO_REVALIDATION_START_TIME, session, sender_address,
671                     sender_address_len, GNUNET_SYSERR, NULL, NULL);
672   if (ret != -1)
673   {
674     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
675                 "Transmitted PONG to `%s' via reliable mechanism\n",
676                 GNUNET_i2s (sender));
677     /* done! */
678     GNUNET_STATISTICS_update (GST_stats,
679                               gettext_noop
680                               ("# PONGs unicast via reliable transport"), 1,
681                               GNUNET_NO);
682     GNUNET_free (pong);
683     return;
684   }
685
686   /* no reliable method found, try transmission via all known addresses */
687   GNUNET_STATISTICS_update (GST_stats,
688                             gettext_noop
689                             ("# PONGs multicast to all available addresses"), 1,
690                             GNUNET_NO);
691   GST_validation_get_addresses (sender, &multicast_pong, pong);
692   GNUNET_free (pong);
693 }
694
695
696 /**
697  * Context for the 'validate_address' function
698  */
699 struct ValidateAddressContext
700 {
701   /**
702    * Hash of the public key of the peer whose address is being validated.
703    */
704   struct GNUNET_PeerIdentity pid;
705
706   /**
707    * Public key of the peer whose address is being validated.
708    */
709   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
710 };
711
712
713 /**
714  * Function called with the result from blacklisting.
715  * Send a PING to the other peer if a communication is allowed.
716  *
717  * @param cls ou r'struct ValidationEntry'
718  * @param pid identity of the other peer
719  * @param result GNUNET_OK if the connection is allowed, GNUNET_NO if not
720  */
721 static void
722 transmit_ping_if_allowed (void *cls, const struct GNUNET_PeerIdentity *pid,
723                           int result)
724 {
725   struct ValidationEntry *ve = cls;
726   struct TransportPingMessage ping;
727   struct GNUNET_TRANSPORT_PluginFunctions *papi;
728   const struct GNUNET_MessageHeader *hello;
729   ssize_t ret;
730   size_t tsize;
731   size_t slen;
732   uint16_t hsize;
733
734   ve->bc = NULL;
735   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting plain PING to `%s'\n",
736               GNUNET_i2s (pid));
737
738   slen = strlen (ve->transport_name) + 1;
739   hello = GST_hello_get ();
740   hsize = ntohs (hello->size);
741   tsize = sizeof (struct TransportPingMessage) + ve->addrlen + slen + hsize;
742
743   ping.header.size =
744       htons (sizeof (struct TransportPingMessage) + ve->addrlen + slen);
745   ping.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_PING);
746   ping.challenge = htonl (ve->challenge);
747   ping.target = *pid;
748
749   if (tsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
750   {
751     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
752                 _
753                 ("Not transmitting `%s' with `%s', message too big (%u bytes!). This should not happen.\n"),
754                 "HELLO", "PING", (unsigned int) tsize);
755     /* message too big (!?), get rid of HELLO */
756     hsize = 0;
757     tsize = sizeof (struct TransportPingMessage) + ve->addrlen + slen + hsize;
758   }
759   {
760     char message_buf[tsize];
761
762     /* build message with structure:
763      *  [HELLO][TransportPingMessage][Transport name][Address] */
764     memcpy (message_buf, hello, hsize);
765     memcpy (&message_buf[hsize], &ping, sizeof (struct TransportPingMessage));
766     memcpy (&message_buf[sizeof (struct TransportPingMessage) + hsize],
767             ve->transport_name, slen);
768     memcpy (&message_buf[sizeof (struct TransportPingMessage) + slen + hsize],
769             ve->addr, ve->addrlen);
770     papi = GST_plugins_find (ve->transport_name);
771     if (papi == NULL)
772       ret = -1;
773     else
774     {
775       GNUNET_assert (papi->send != NULL);
776       ret =
777           papi->send (papi->cls, pid, message_buf, tsize, PING_PRIORITY,
778                       HELLO_REVALIDATION_START_TIME, NULL /* no session */ ,
779                       ve->addr, ve->addrlen, GNUNET_YES, NULL, NULL);
780     }
781   }
782   if (-1 != ret)
783   {
784     ve->send_time = GNUNET_TIME_absolute_get ();
785     GNUNET_STATISTICS_update (GST_stats,
786                               gettext_noop
787                               ("# PING without HELLO messages sent"), 1,
788                               GNUNET_NO);
789   }
790 }
791
792
793 /**
794  * Iterator callback to go over all addresses and try to validate them
795  * (unless blocked or already validated).
796  *
797  * @param cls pointer to a 'struct ValidateAddressContext'
798  * @param tname name of the transport
799  * @param expiration expiration time
800  * @param addr the address
801  * @param addrlen length of the address
802  * @return GNUNET_OK (keep the address)
803  */
804 static int
805 validate_address (void *cls, const char *tname,
806                   struct GNUNET_TIME_Absolute expiration, const void *addr,
807                   uint16_t addrlen)
808 {
809   const struct ValidateAddressContext *vac = cls;
810   const struct GNUNET_PeerIdentity *pid = &vac->pid;
811   struct ValidationEntry *ve;
812   struct GST_BlacklistCheck *bc;
813
814   if (GNUNET_TIME_absolute_get_remaining (expiration).rel_value == 0)
815     return GNUNET_OK;           /* expired */
816   ve = find_validation_entry (&vac->public_key, pid, tname, addr, addrlen);
817   if (GNUNET_TIME_absolute_get_remaining (ve->validation_block).rel_value > 0)
818     return GNUNET_OK;           /* blocked */
819   if ((GNUNET_SCHEDULER_NO_TASK != ve->timeout_task) &&
820       (GNUNET_TIME_absolute_get_remaining (ve->valid_until).rel_value > 0))
821     return GNUNET_OK;           /* revalidation task already scheduled & still  valid */
822   ve->validation_block =
823       GNUNET_TIME_relative_to_absolute (HELLO_REVALIDATION_START_TIME);
824   if (GNUNET_SCHEDULER_NO_TASK != ve->timeout_task)
825     GNUNET_SCHEDULER_cancel (ve->timeout_task);
826   ve->timeout_task =
827       GNUNET_SCHEDULER_add_delayed (HELLO_REVALIDATION_START_TIME,
828                                     &timeout_hello_validation, ve);
829   bc = GST_blacklist_test_allowed (pid, tname, &transmit_ping_if_allowed, ve);
830   if (NULL != bc)
831     ve->bc = bc;
832   return GNUNET_OK;
833 }
834
835
836 /**
837  * Do address validation again to keep address valid.
838  *
839  * @param cls the 'struct ValidationEntry'
840  * @param tc scheduler context (unused)
841  */
842 static void
843 revalidate_address (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
844 {
845   struct ValidationEntry *ve = cls;
846   struct GNUNET_TIME_Relative delay;
847   struct ValidateAddressContext vac;
848
849   ve->timeout_task = GNUNET_SCHEDULER_NO_TASK;
850   delay = GNUNET_TIME_absolute_get_remaining (ve->validation_block);
851   if (delay.rel_value > 0)
852   {
853     /* should wait a bit longer */
854     ve->timeout_task =
855         GNUNET_SCHEDULER_add_delayed (delay, &revalidate_address, ve);
856     return;
857   }
858   GNUNET_STATISTICS_update (GST_stats,
859                             gettext_noop ("# address revalidations started"), 1,
860                             GNUNET_NO);
861   vac.pid = ve->pid;
862   vac.public_key = ve->public_key;
863   validate_address (&vac, ve->transport_name, ve->valid_until, ve->addr,
864                     (uint16_t) ve->addrlen);
865 }
866
867
868 /**
869  * Add the validated peer address to the HELLO.
870  *
871  * @param cls the 'struct ValidationEntry' with the validated address
872  * @param max space in buf
873  * @param buf where to add the address
874  * @return number of bytes written, 0 to signal the
875  *         end of the iteration.
876  */
877 static size_t
878 add_valid_peer_address (void *cls, size_t max, void *buf)
879 {
880   struct ValidationEntry *ve = cls;
881
882   if (GNUNET_YES == ve->copied)
883     return 0;                   /* terminate */
884   ve->copied = GNUNET_YES;
885   return GNUNET_HELLO_add_address (ve->transport_name, ve->valid_until,
886                                    ve->addr, ve->addrlen, buf, max);
887 }
888
889
890 /**
891  * We've received a PONG.  Check if it matches a pending PING and
892  * mark the respective address as confirmed.
893  *
894  * @param sender peer sending the PONG
895  * @param hdr the PONG
896  */
897 void
898 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
899                             const struct GNUNET_MessageHeader *hdr)
900 {
901   const struct TransportPongMessage *pong;
902   struct ValidationEntry *ve;
903   const char *tname;
904   const char *addr;
905   size_t addrlen;
906   size_t slen;
907   size_t size;
908   uint32_t rdelay;
909   struct GNUNET_TIME_Relative delay;
910   struct GNUNET_HELLO_Message *hello;
911
912   if (ntohs (hdr->size) < sizeof (struct TransportPongMessage))
913   {
914     GNUNET_break_op (0);
915     return;
916   }
917   GNUNET_STATISTICS_update (GST_stats,
918                             gettext_noop ("# PONG messages received"), 1,
919                             GNUNET_NO);
920
921   pong = (const struct TransportPongMessage *) hdr;
922   tname = (const char *) &pong[1];
923   size = ntohs (hdr->size) - sizeof (struct TransportPongMessage);
924   addr = memchr (tname, '\0', size);
925   if (NULL == addr)
926   {
927     GNUNET_break_op (0);
928     return;
929   }
930   addr++;
931   slen = strlen (tname) + 1;
932   addrlen = size - slen;
933
934   ve = find_validation_entry (NULL, sender, tname, addr, addrlen);
935
936   if (NULL == ve)
937   {
938     GNUNET_STATISTICS_update (GST_stats,
939                               gettext_noop
940                               ("# PONGs dropped, no matching pending validation"),
941                               1, GNUNET_NO);
942     return;
943   }
944   /* now check that PONG is well-formed */
945   if (0 != memcmp (&ve->pid, sender, sizeof (struct GNUNET_PeerIdentity)))
946   {
947     GNUNET_break_op (0);
948     return;
949   }
950
951   if (GNUNET_TIME_absolute_get_remaining
952       (GNUNET_TIME_absolute_ntoh (pong->expiration)).rel_value == 0)
953   {
954     GNUNET_STATISTICS_update (GST_stats,
955                               gettext_noop
956                               ("# PONGs dropped, signature expired"), 1,
957                               GNUNET_NO);
958     return;
959   }
960   if (GNUNET_OK !=
961       GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_TRANSPORT_PONG_OWN,
962                                 &pong->purpose, &pong->signature,
963                                 &ve->public_key))
964   {
965     GNUNET_break_op (0);
966     return;
967   }
968 #if DEBUG_TRANSPORT
969   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
970               "Address validated for peer `%s' with plugin `%s': `%s'\n",
971               GNUNET_i2s (sender), tname, GST_plugins_a2s (tname, addr,
972                                                            addrlen));
973 #endif
974
975   /* validity achieved, remember it! */
976   ve->valid_until = GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
977   {
978     struct GNUNET_TRANSPORT_ATS_Information ats;
979
980     ats.type = htonl (GNUNET_TRANSPORT_ATS_QUALITY_NET_DELAY);
981     ats.value = htonl ((uint32_t) GNUNET_TIME_absolute_get_duration (ve->send_time).rel_value);
982     GNUNET_ATS_address_update (GST_ats, &ve->pid,
983                                ve->transport_name,ve->addr, ve->addrlen, NULL,
984                                &ats, 1);
985   }
986   
987   /* build HELLO to store in PEERINFO */
988   ve->copied = GNUNET_NO;
989   hello = GNUNET_HELLO_create (&ve->public_key, &add_valid_peer_address, ve);
990   GNUNET_PEERINFO_add_peer (GST_peerinfo, hello);
991   GNUNET_free (hello);
992
993   if (GNUNET_SCHEDULER_NO_TASK != ve->timeout_task)
994     GNUNET_SCHEDULER_cancel (ve->timeout_task);
995
996   /* randomly delay by up to 1h to avoid   synchronous validations */
997   rdelay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 60 * 60);
998   delay =
999       GNUNET_TIME_relative_add (HELLO_REVALIDATION_START_TIME,
1000                                 GNUNET_TIME_relative_multiply
1001                                 (GNUNET_TIME_UNIT_SECONDS, rdelay));
1002   ve->timeout_task =
1003       GNUNET_SCHEDULER_add_delayed (delay, &revalidate_address, ve);
1004 }
1005
1006
1007 /**
1008  * We've received a HELLO, check which addresses are new and trigger
1009  * validation.
1010  *
1011  * @param hello the HELLO we received
1012  */
1013 void
1014 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello)
1015 {
1016   const struct GNUNET_HELLO_Message *hm =
1017       (const struct GNUNET_HELLO_Message *) hello;
1018   struct ValidateAddressContext vac;
1019   struct GNUNET_HELLO_Message *h;
1020
1021   if ((GNUNET_OK != GNUNET_HELLO_get_id (hm, &vac.pid)) ||
1022       (GNUNET_OK != GNUNET_HELLO_get_key (hm, &vac.public_key)))
1023   {
1024     /* malformed HELLO */
1025     GNUNET_break (0);
1026     return;
1027   }
1028   /* Add peer identity without addresses to peerinfo service */
1029   h = GNUNET_HELLO_create (&vac.public_key, NULL, NULL);
1030   GNUNET_PEERINFO_add_peer (GST_peerinfo, h);
1031 #if VERBOSE_VALIDATION
1032   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1033               _
1034               ("Adding `%s' without addresses for peer `%s'\n"),
1035               "HELLO",
1036               GNUNET_i2s(&vac.pid));
1037 #endif
1038   GNUNET_free (h);
1039
1040   GNUNET_assert (NULL ==
1041                  GNUNET_HELLO_iterate_addresses (hm, GNUNET_NO,
1042                                                  &validate_address, &vac));
1043 }
1044
1045
1046 /**
1047  * Closure for 'iterate_addresses'
1048  */
1049 struct IteratorContext
1050 {
1051   /**
1052    * Function to call on each address.
1053    */
1054   GST_ValidationAddressCallback cb;
1055
1056   /**
1057    * Closure for 'cb'.
1058    */
1059   void *cb_cls;
1060
1061 };
1062
1063
1064 /**
1065  * Call the callback in the closure for each validation entry.
1066  *
1067  * @param cls the 'struct GST_ValidationIteratorContext'
1068  * @param key the peer's identity
1069  * @param value the 'struct ValidationEntry'
1070  * @return GNUNET_OK (continue to iterate)
1071  */
1072 static int
1073 iterate_addresses (void *cls, const GNUNET_HashCode * key, void *value)
1074 {
1075   struct IteratorContext *ic = cls;
1076   struct ValidationEntry *ve = value;
1077
1078   ic->cb (ic->cb_cls, &ve->public_key, &ve->pid, ve->valid_until,
1079           ve->validation_block, ve->transport_name, ve->addr, ve->addrlen);
1080   return GNUNET_OK;
1081 }
1082
1083
1084 /**
1085  * Call the given function for each address for the given target.
1086  * Can either give a snapshot (synchronous API) or be continuous.
1087  *
1088  * @param target peer information is requested for
1089  * @param cb function to call; will not be called after this function returns
1090  * @param cb_cls closure for 'cb'
1091  */
1092 void
1093 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
1094                               GST_ValidationAddressCallback cb, void *cb_cls)
1095 {
1096   struct IteratorContext ic;
1097
1098   ic.cb = cb;
1099   ic.cb_cls = cb_cls;
1100   GNUNET_CONTAINER_multihashmap_get_multiple (validation_map,
1101                                               &target->hashPubKey,
1102                                               &iterate_addresses, &ic);
1103 }
1104
1105
1106 /* end of file gnunet-service-transport_validation.c */