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