- doxygen
[oweals/gnunet.git] / src / cadet / gnunet-service-cadet_tunnel.c
1 /*
2      This file is part of GNUnet.
3      (C) 2013 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 #include "platform.h"
22 #include "gnunet_util_lib.h"
23
24 #include "gnunet_signatures.h"
25 #include "gnunet_statistics_service.h"
26
27 #include "cadet_protocol.h"
28 #include "cadet_path.h"
29
30 #include "gnunet-service-cadet_tunnel.h"
31 #include "gnunet-service-cadet_connection.h"
32 #include "gnunet-service-cadet_channel.h"
33 #include "gnunet-service-cadet_peer.h"
34
35 #define LOG(level, ...) GNUNET_log_from(level,"cadet-tun",__VA_ARGS__)
36 #define LOG2(level, ...) GNUNET_log_from_nocheck(level,"cadet-tun",__VA_ARGS__)
37
38 #define REKEY_WAIT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 5)
39
40 #define CONNECTIONS_PER_TUNNEL 3
41
42 #if !defined(GNUNET_CULL_LOGGING)
43 #define DUMP_KEYS_TO_STDERR GNUNET_YES
44 #else
45 #define DUMP_KEYS_TO_STDERR GNUNET_NO
46 #endif
47
48 /******************************************************************************/
49 /********************************   STRUCTS  **********************************/
50 /******************************************************************************/
51
52 struct CadetTChannel
53 {
54   struct CadetTChannel *next;
55   struct CadetTChannel *prev;
56   struct CadetChannel *ch;
57 };
58
59
60 /**
61  * Connection list and metadata.
62  */
63 struct CadetTConnection
64 {
65   /**
66    * Next in DLL.
67    */
68   struct CadetTConnection *next;
69
70   /**
71    * Prev in DLL.
72    */
73   struct CadetTConnection *prev;
74
75   /**
76    * Connection handle.
77    */
78   struct CadetConnection *c;
79
80   /**
81    * Creation time, to keep oldest connection alive.
82    */
83   struct GNUNET_TIME_Absolute created;
84
85   /**
86    * Connection throughput, to keep fastest connection alive.
87    */
88   uint32_t throughput;
89 };
90
91 /**
92  * Structure used during a Key eXchange.
93  */
94 struct CadetTunnelKXCtx
95 {
96   /**
97    * Encryption ("our") old "confirmed" key, for encrypting traffic sent by us
98    * end before the key exchange is finished or times out.
99    */
100   struct GNUNET_CRYPTO_SymmetricSessionKey e_key_old;
101
102   /**
103    * Decryption ("their") old "confirmed" key, for decrypting traffic sent by
104    * the other end before the key exchange started.
105    */
106   struct GNUNET_CRYPTO_SymmetricSessionKey d_key_old;
107
108   /**
109    * Challenge to send in a ping and expect in the pong.
110    */
111   uint32_t challenge;
112
113   /**
114    * When the rekey started. One minute after this the new key will be used.
115    */
116   struct GNUNET_TIME_Absolute rekey_start_time;
117
118   /**
119    * Task for delayed destruction of the Key eXchange context, to allow delayed
120    * messages with the old key to be decrypted successfully.
121    */
122   GNUNET_SCHEDULER_TaskIdentifier finish_task;
123 };
124
125 /**
126  * Struct containing all information regarding a tunnel to a peer.
127  */
128 struct CadetTunnel
129 {
130     /**
131      * Endpoint of the tunnel.
132      */
133   struct CadetPeer *peer;
134
135     /**
136      * State of the tunnel connectivity.
137      */
138   enum CadetTunnelCState cstate;
139
140   /**
141    * State of the tunnel encryption.
142    */
143   enum CadetTunnelEState estate;
144
145   /**
146    * Key eXchange context.
147    */
148   struct CadetTunnelKXCtx *kx_ctx;
149
150   /**
151    * Peer's ephemeral key, to recreate @c e_key and @c d_key when own ephemeral
152    * key changes.
153    */
154   struct GNUNET_CRYPTO_EcdhePublicKey peers_ephemeral_key;
155
156   /**
157    * Encryption ("our") key. It is only "confirmed" if kx_ctx is NULL.
158    */
159   struct GNUNET_CRYPTO_SymmetricSessionKey e_key;
160
161   /**
162    * Decryption ("their") key. It is only "confirmed" if kx_ctx is NULL.
163    */
164   struct GNUNET_CRYPTO_SymmetricSessionKey d_key;
165
166   /**
167    * Task to start the rekey process.
168    */
169   GNUNET_SCHEDULER_TaskIdentifier rekey_task;
170
171   /**
172    * Paths that are actively used to reach the destination peer.
173    */
174   struct CadetTConnection *connection_head;
175   struct CadetTConnection *connection_tail;
176
177   /**
178    * Next connection number.
179    */
180   uint32_t next_cid;
181
182   /**
183    * Channels inside this tunnel.
184    */
185   struct CadetTChannel *channel_head;
186   struct CadetTChannel *channel_tail;
187
188   /**
189    * Channel ID for the next created channel.
190    */
191   CADET_ChannelNumber next_chid;
192
193   /**
194    * Destroy flag: if true, destroy on last message.
195    */
196   GNUNET_SCHEDULER_TaskIdentifier destroy_task;
197
198   /**
199    * Queued messages, to transmit once tunnel gets connected.
200    */
201   struct CadetTunnelDelayed *tq_head;
202   struct CadetTunnelDelayed *tq_tail;
203
204   /**
205    * Task to trim connections if too many are present.
206    */
207   GNUNET_SCHEDULER_TaskIdentifier trim_connections_task;
208 };
209
210
211 /**
212  * Struct used to save messages in a non-ready tunnel to send once connected.
213  */
214 struct CadetTunnelDelayed
215 {
216   /**
217    * DLL
218    */
219   struct CadetTunnelDelayed *next;
220   struct CadetTunnelDelayed *prev;
221
222   /**
223    * Tunnel.
224    */
225   struct CadetTunnel *t;
226
227   /**
228    * Tunnel queue given to the channel to cancel request. Update on send_queued.
229    */
230   struct CadetTunnelQueue *tq;
231
232   /**
233    * Message to send.
234    */
235   /* struct GNUNET_MessageHeader *msg; */
236 };
237
238
239 /**
240  * Handle for messages queued but not yet sent.
241  */
242 struct CadetTunnelQueue
243 {
244   /**
245    * Connection queue handle, to cancel if necessary.
246    */
247   struct CadetConnectionQueue *cq;
248
249   /**
250    * Handle in case message hasn't been given to a connection yet.
251    */
252   struct CadetTunnelDelayed *tqd;
253
254   /**
255    * Continuation to call once sent.
256    */
257   GCT_sent cont;
258
259   /**
260    * Closure for @c cont.
261    */
262   void *cont_cls;
263 };
264
265
266 /******************************************************************************/
267 /*******************************   GLOBALS  ***********************************/
268 /******************************************************************************/
269
270 /**
271  * Global handle to the statistics service.
272  */
273 extern struct GNUNET_STATISTICS_Handle *stats;
274
275 /**
276  * Local peer own ID (memory efficient handle).
277  */
278 extern GNUNET_PEER_Id myid;
279
280 /**
281  * Local peer own ID (full value).
282  */
283 extern struct GNUNET_PeerIdentity my_full_id;
284
285
286 /**
287  * Don't try to recover tunnels if shutting down.
288  */
289 extern int shutting_down;
290
291
292 /**
293  * Set of all tunnels, in order to trigger a new exchange on rekey.
294  * Indexed by peer's ID.
295  */
296 static struct GNUNET_CONTAINER_MultiPeerMap *tunnels;
297
298 /**
299  * Default TTL for payload packets.
300  */
301 static unsigned long long default_ttl;
302
303 /**
304  * Own private key.
305  */
306 const static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
307
308 /**
309  * Own ephemeral private key.
310  */
311 static struct GNUNET_CRYPTO_EcdhePrivateKey *my_ephemeral_key;
312
313 /**
314  * Cached message used to perform a key exchange.
315  */
316 static struct GNUNET_CADET_KX_Ephemeral kx_msg;
317
318 /**
319  * Task to generate a new ephemeral key.
320  */
321 static GNUNET_SCHEDULER_TaskIdentifier rekey_task;
322
323 /**
324  * Rekey period.
325  */
326 static struct GNUNET_TIME_Relative rekey_period;
327
328 /******************************************************************************/
329 /********************************   STATIC  ***********************************/
330 /******************************************************************************/
331
332 /**
333  * Get string description for tunnel connectivity state.
334  *
335  * @param cs Tunnel state.
336  *
337  * @return String representation.
338  */
339 static const char *
340 cstate2s (enum CadetTunnelCState cs)
341 {
342   static char buf[32];
343
344   switch (cs)
345   {
346     case CADET_TUNNEL_NEW:
347       return "CADET_TUNNEL_NEW";
348     case CADET_TUNNEL_SEARCHING:
349       return "CADET_TUNNEL_SEARCHING";
350     case CADET_TUNNEL_WAITING:
351       return "CADET_TUNNEL_WAITING";
352     case CADET_TUNNEL_READY:
353       return "CADET_TUNNEL_READY";
354     case CADET_TUNNEL_SHUTDOWN:
355       return "CADET_TUNNEL_SHUTDOWN";
356     default:
357       SPRINTF (buf, "%u (UNKNOWN STATE)", cs);
358       return buf;
359   }
360   return "";
361 }
362
363
364 /**
365  * Get string description for tunnel encryption state.
366  *
367  * @param es Tunnel state.
368  *
369  * @return String representation.
370  */
371 static const char *
372 estate2s (enum CadetTunnelEState es)
373 {
374   static char buf[32];
375
376   switch (es)
377   {
378     case CADET_TUNNEL_KEY_UNINITIALIZED:
379       return "CADET_TUNNEL_KEY_UNINITIALIZED";
380     case CADET_TUNNEL_KEY_SENT:
381       return "CADET_TUNNEL_KEY_SENT";
382     case CADET_TUNNEL_KEY_PING:
383       return "CADET_TUNNEL_KEY_PING";
384     case CADET_TUNNEL_KEY_OK:
385       return "CADET_TUNNEL_KEY_OK";
386     case CADET_TUNNEL_KEY_REKEY:
387       return "CADET_TUNNEL_KEY_REKEY";
388     default:
389       SPRINTF (buf, "%u (UNKNOWN STATE)", es);
390       return buf;
391   }
392   return "";
393 }
394
395
396 /**
397  * @brief Check if tunnel is ready to send traffic.
398  *
399  * Tunnel must be connected and with encryption correctly set up.
400  *
401  * @param t Tunnel to check.
402  *
403  * @return #GNUNET_YES if ready, #GNUNET_NO otherwise
404  */
405 static int
406 is_ready (struct CadetTunnel *t)
407 {
408   int ready;
409
410   GCT_debug (t, GNUNET_ERROR_TYPE_DEBUG);
411   ready = CADET_TUNNEL_READY == t->cstate
412           && (CADET_TUNNEL_KEY_OK == t->estate
413               || CADET_TUNNEL_KEY_REKEY == t->estate);
414   ready = ready || GCT_is_loopback (t);
415   return ready;
416 }
417
418
419 /**
420  * Check if a key is invalid (NULL pointer or all 0)
421  *
422  * @param key Key to check.
423  *
424  * @return #GNUNET_YES if key is null, #GNUNET_NO if exists and is not 0.
425  */
426 static int
427 is_key_null (struct GNUNET_CRYPTO_SymmetricSessionKey *key)
428 {
429   struct GNUNET_CRYPTO_SymmetricSessionKey null_key;
430
431   if (NULL == key)
432     return GNUNET_YES;
433
434   memset (&null_key, 0, sizeof (null_key));
435   if (0 == memcmp (key, &null_key, sizeof (null_key)))
436     return GNUNET_YES;
437   return GNUNET_NO;
438 }
439
440
441 /**
442  * Ephemeral key message purpose size.
443  *
444  * @return Size of the part of the ephemeral key message that must be signed.
445  */
446 size_t
447 ephemeral_purpose_size (void)
448 {
449   return sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
450          sizeof (struct GNUNET_TIME_AbsoluteNBO) +
451          sizeof (struct GNUNET_TIME_AbsoluteNBO) +
452          sizeof (struct GNUNET_CRYPTO_EcdhePublicKey) +
453          sizeof (struct GNUNET_PeerIdentity);
454 }
455
456
457 /**
458  * Size of the encrypted part of a ping message.
459  *
460  * @return Size of the encrypted part of a ping message.
461  */
462 size_t
463 ping_encryption_size (void)
464 {
465   return sizeof (struct GNUNET_PeerIdentity) + sizeof (uint32_t);
466 }
467
468
469 /**
470  * Get the channel's buffer. ONLY FOR NON-LOOPBACK CHANNELS!!
471  *
472  * @param tch Tunnel's channel handle.
473  *
474  * @return Amount of messages the channel can still buffer towards the client.
475  */
476 static unsigned int
477 get_channel_buffer (const struct CadetTChannel *tch)
478 {
479   int fwd;
480
481   /* If channel is outgoing, is origin in the FWD direction and fwd is YES */
482   fwd = GCCH_is_origin (tch->ch, GNUNET_YES);
483
484   return GCCH_get_buffer (tch->ch, fwd);
485 }
486
487
488 /**
489  * Get the channel's allowance status.
490  *
491  * @param tch Tunnel's channel handle.
492  *
493  * @return #GNUNET_YES if we allowed the client to send data to us.
494  */
495 static int
496 get_channel_allowed (const struct CadetTChannel *tch)
497 {
498   int fwd;
499
500   /* If channel is outgoing, is origin in the FWD direction and fwd is YES */
501   fwd = GCCH_is_origin (tch->ch, GNUNET_YES);
502
503   return GCCH_get_allowed (tch->ch, fwd);
504 }
505
506
507 /**
508  * Get the connection's buffer.
509  *
510  * @param tc Tunnel's connection handle.
511  *
512  * @return Amount of messages the connection can still buffer.
513  */
514 static unsigned int
515 get_connection_buffer (const struct CadetTConnection *tc)
516 {
517   int fwd;
518
519   /* If connection is outgoing, is origin in the FWD direction and fwd is YES */
520   fwd = GCC_is_origin (tc->c, GNUNET_YES);
521
522   return GCC_get_buffer (tc->c, fwd);
523 }
524
525
526 /**
527  * Get the connection's allowance.
528  *
529  * @param tc Tunnel's connection handle.
530  *
531  * @return Amount of messages we have allowed the next peer to send us.
532  */
533 static unsigned int
534 get_connection_allowed (const struct CadetTConnection *tc)
535 {
536   int fwd;
537
538   /* If connection is outgoing, is origin in the FWD direction and fwd is YES */
539   fwd = GCC_is_origin (tc->c, GNUNET_YES);
540
541   return GCC_get_allowed (tc->c, fwd);
542 }
543
544
545 /**
546  * Check that a ephemeral key message s well formed and correctly signed.
547  *
548  * @param t Tunnel on which the message came.
549  * @param msg The ephemeral key message.
550  *
551  * @return GNUNET_OK if message is fine, GNUNET_SYSERR otherwise.
552  */
553 int
554 check_ephemeral (struct CadetTunnel *t,
555                  const struct GNUNET_CADET_KX_Ephemeral *msg)
556 {
557   /* Check message size */
558   if (ntohs (msg->header.size) != sizeof (struct GNUNET_CADET_KX_Ephemeral))
559     return GNUNET_SYSERR;
560
561   /* Check signature size */
562   if (ntohl (msg->purpose.size) != ephemeral_purpose_size ())
563     return GNUNET_SYSERR;
564
565   /* Check origin */
566   if (0 != memcmp (&msg->origin_identity,
567                    GCP_get_id (t->peer),
568                    sizeof (struct GNUNET_PeerIdentity)))
569     return GNUNET_SYSERR;
570
571   /* Check signature */
572   if (GNUNET_OK !=
573       GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_CADET_KX,
574                                   &msg->purpose,
575                                   &msg->signature,
576                                   &msg->origin_identity.public_key))
577     return GNUNET_SYSERR;
578
579   return GNUNET_OK;
580 }
581
582
583 /**
584  * Select the best key to use for encryption (send), based on KX status.
585  *
586  * Normally, return the current key. If there is a KX in progress and the old
587  * key is fresh enough, return the old key.
588  *
589  * @param t Tunnel to choose the key from.
590  *
591  * @return The optimal key to encrypt/hmac outgoing traffic.
592  */
593 static const struct GNUNET_CRYPTO_SymmetricSessionKey *
594 select_key (const struct CadetTunnel *t)
595 {
596   const struct GNUNET_CRYPTO_SymmetricSessionKey *key;
597
598   if (NULL != t->kx_ctx
599       && GNUNET_SCHEDULER_NO_TASK == t->kx_ctx->finish_task)
600   {
601     struct GNUNET_TIME_Relative age;
602
603     age = GNUNET_TIME_absolute_get_duration (t->kx_ctx->rekey_start_time);
604     LOG (GNUNET_ERROR_TYPE_DEBUG,
605          "  key exchange in progress, started %s ago\n",
606          GNUNET_STRINGS_relative_time_to_string (age, GNUNET_YES));
607     // FIXME make duration of old keys configurable
608     if (age.rel_value_us < GNUNET_TIME_UNIT_MINUTES.rel_value_us)
609     {
610       LOG (GNUNET_ERROR_TYPE_DEBUG, "  using old key\n");
611       key = &t->kx_ctx->e_key_old;
612     }
613     else
614     {
615       LOG (GNUNET_ERROR_TYPE_DEBUG, "  using new key (old key too old)\n");
616       key = &t->e_key;
617     }
618   }
619   else
620   {
621     LOG (GNUNET_ERROR_TYPE_DEBUG, "  no KX: using current key\n");
622     key = &t->e_key;
623   }
624   return key;
625 }
626
627
628 /**
629  * Calculate HMAC.
630  *
631  * @param plaintext Content to HMAC.
632  * @param size Size of @c plaintext.
633  * @param iv Initialization vector for the message.
634  * @param key Key to use.
635  * @param hmac[out] Destination to store the HMAC.
636  */
637 static void
638 t_hmac (const void *plaintext, size_t size,
639         uint32_t iv, const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
640         struct GNUNET_CADET_Hash *hmac)
641 {
642   static const char ctx[] = "cadet authentication key";
643   struct GNUNET_CRYPTO_AuthKey auth_key;
644   struct GNUNET_HashCode hash;
645
646 #if DUMP_KEYS_TO_STDERR
647   LOG (GNUNET_ERROR_TYPE_INFO, "  HMAC with key %s\n",
648        GNUNET_h2s ((struct GNUNET_HashCode *) key));
649 #endif
650   GNUNET_CRYPTO_hmac_derive_key (&auth_key, key,
651                                  &iv, sizeof (iv),
652                                  key, sizeof (*key),
653                                  ctx, sizeof (ctx),
654                                  NULL);
655   /* Two step: CADET_Hash is only 256 bits, HashCode is 512. */
656   GNUNET_CRYPTO_hmac (&auth_key, plaintext, size, &hash);
657   memcpy (hmac, &hash, sizeof (*hmac));
658 }
659
660
661 /**
662  * Encrypt daforce_newest_keyta with the tunnel key.
663  *
664  * @param t Tunnel whose key to use.
665  * @param dst Destination for the encrypted data.
666  * @param src Source of the plaintext. Can overlap with @c dst.
667  * @param size Size of the plaintext.
668  * @param iv Initialization Vector to use.
669  * @param force_newest_key Force the use of the newest key, otherwise
670  *                         CADET will use the old key when allowed.
671  *                         This can happen in the case when a KX is going on
672  *                         and the old one hasn't expired.
673  */
674 static int
675 t_encrypt (struct CadetTunnel *t, void *dst, const void *src,
676            size_t size, uint32_t iv, int force_newest_key)
677 {
678   struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
679   const struct GNUNET_CRYPTO_SymmetricSessionKey *key;
680   size_t out_size;
681
682   LOG (GNUNET_ERROR_TYPE_DEBUG, "  t_encrypt start\n");
683
684   key = GNUNET_YES == force_newest_key ? &t->e_key : select_key (t);
685   #if DUMP_KEYS_TO_STDERR
686   LOG (GNUNET_ERROR_TYPE_INFO, "  ENC with key %s\n",
687        GNUNET_h2s ((struct GNUNET_HashCode *) key));
688   #endif
689   GNUNET_CRYPTO_symmetric_derive_iv (&siv, key, &iv, sizeof (iv), NULL);
690   LOG (GNUNET_ERROR_TYPE_DEBUG, "  t_encrypt IV derived\n");
691   out_size = GNUNET_CRYPTO_symmetric_encrypt (src, size, key, &siv, dst);
692   LOG (GNUNET_ERROR_TYPE_DEBUG, "  t_encrypt end\n");
693
694   return out_size;
695 }
696
697
698 /**
699  * Decrypt and verify data with the appropriate tunnel key.
700  *
701  * @param key Key to use.
702  * @param dst Destination for the plaintext.
703  * @param src Source of the encrypted data. Can overlap with @c dst.
704  * @param size Size of the encrypted data.
705  * @param iv Initialization Vector to use.
706  *
707  * @return Size of the decrypted data, -1 if an error was encountered.
708  */
709 static int
710 decrypt (const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
711          void *dst, const void *src, size_t size, uint32_t iv)
712 {
713   struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
714   size_t out_size;
715
716   LOG (GNUNET_ERROR_TYPE_DEBUG, "  decrypt start\n");
717   LOG (GNUNET_ERROR_TYPE_DEBUG, "  decrypt iv\n");
718   GNUNET_CRYPTO_symmetric_derive_iv (&siv, key, &iv, sizeof (iv), NULL);
719   LOG (GNUNET_ERROR_TYPE_DEBUG, "  decrypt iv done\n");
720   out_size = GNUNET_CRYPTO_symmetric_decrypt (src, size, key, &siv, dst);
721   LOG (GNUNET_ERROR_TYPE_DEBUG, "  decrypt end\n");
722
723   return out_size;
724 }
725
726
727 /**
728  * Decrypt and verify data with the most recent tunnel key.
729  *
730  * @param t Tunnel whose key to use.
731  * @param dst Destination for the plaintext.
732  * @param src Source of the encrypted data. Can overlap with @c dst.
733  * @param size Size of the encrypted data.
734  * @param iv Initialization Vector to use.
735  *
736  * @return Size of the decrypted data, -1 if an error was encountered.
737  */
738 static int
739 t_decrypt (struct CadetTunnel *t, void *dst, const void *src,
740            size_t size, uint32_t iv)
741 {
742   size_t out_size;
743
744 #if DUMP_KEYS_TO_STDERR
745   LOG (GNUNET_ERROR_TYPE_DEBUG, "  t_decrypt with %s\n",
746        GNUNET_h2s ((struct GNUNET_HashCode *) &t->d_key));
747 #endif
748   if (t->estate == CADET_TUNNEL_KEY_UNINITIALIZED)
749   {
750     GNUNET_STATISTICS_update (stats, "# non decryptable data", 1, GNUNET_NO);
751     LOG (GNUNET_ERROR_TYPE_WARNING,
752          "got data on %s without a valid key\n",
753          GCT_2s (t));
754     GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
755     return -1;
756   }
757
758   out_size = decrypt (&t->d_key, dst, src, size, iv);
759
760   return out_size;
761 }
762
763
764 /**
765  * Decrypt and verify data with the appropriate tunnel key and verify that the
766  * data has not been altered since it was sent by the remote peer.
767  *
768  * @param t Tunnel whose key to use.
769  * @param dst Destination for the plaintext.
770  * @param src Source of the encrypted data. Can overlap with @c dst.
771  * @param size Size of the encrypted data.
772  * @param iv Initialization Vector to use.
773  * @param msg_hmac HMAC of the message, cannot be NULL.
774  *
775  * @return Size of the decrypted data, -1 if an error was encountered.
776  */
777 static int
778 t_decrypt_and_validate (struct CadetTunnel *t,
779                         void *dst, const void *src,
780                         size_t size, uint32_t iv,
781                         const struct GNUNET_CADET_Hash *msg_hmac)
782 {
783   struct GNUNET_CRYPTO_SymmetricSessionKey *key;
784   struct GNUNET_CADET_Hash hmac;
785   int decrypted_size;
786
787   /* Try primary (newest) key */
788   key = &t->d_key;
789   decrypted_size = decrypt (key, dst, src, size, iv);
790   t_hmac (src, size, iv, key, &hmac);
791   if (0 == memcmp (msg_hmac, &hmac, sizeof (hmac)))
792     return decrypted_size;
793
794   /* If no key exchange is going on, we just failed */
795   if (NULL == t->kx_ctx)
796   {
797     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
798                 "Failed checksum validation on tunnel %s with no KX\n",
799                 GCT_2s (t));
800     GNUNET_STATISTICS_update (stats, "# wrong HMAC", 1, GNUNET_NO);
801     return -1;
802   }
803
804   /* Try secondary (from previous KX period) key */
805   key = &t->kx_ctx->d_key_old;
806   decrypted_size = decrypt (key, dst, src, size, iv);
807   t_hmac (src, size, iv, key, &hmac);
808   if (0 == memcmp (msg_hmac, &hmac, sizeof (hmac)))
809     return decrypted_size;
810
811   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
812               "Failed checksum validation on tunnel %s with KX\n",
813               GCT_2s (t));
814   GNUNET_STATISTICS_update (stats, "# wrong HMAC", 1, GNUNET_NO);
815   return -1;
816 }
817
818
819 /**
820  * Create key material by doing ECDH on the local and remote ephemeral keys.
821  *
822  * @param key_material Where to store the key material.
823  * @param ephemeral_key Peer's public ephemeral key.
824  */
825 void
826 derive_key_material (struct GNUNET_HashCode *key_material,
827                      const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral_key)
828 {
829   if (GNUNET_OK !=
830       GNUNET_CRYPTO_ecc_ecdh (my_ephemeral_key,
831                               ephemeral_key,
832                               key_material))
833   {
834     GNUNET_break (0);
835   }
836 }
837
838
839 /**
840  * Create a symmetic key from the identities of both ends and the key material
841  * from ECDH.
842  *
843  * @param key Destination for the generated key.
844  * @param sender ID of the peer that will encrypt with @c key.
845  * @param receiver ID of the peer that will decrypt with @c key.
846  * @param key_material Hash created with ECDH with the ephemeral keys.
847  */
848 void
849 derive_symmertic (struct GNUNET_CRYPTO_SymmetricSessionKey *key,
850                   const struct GNUNET_PeerIdentity *sender,
851                   const struct GNUNET_PeerIdentity *receiver,
852                   const struct GNUNET_HashCode *key_material)
853 {
854   const char salt[] = "CADET kx salt";
855
856   GNUNET_CRYPTO_kdf (key, sizeof (struct GNUNET_CRYPTO_SymmetricSessionKey),
857                      salt, sizeof (salt),
858                      key_material, sizeof (struct GNUNET_HashCode),
859                      sender, sizeof (struct GNUNET_PeerIdentity),
860                      receiver, sizeof (struct GNUNET_PeerIdentity),
861                      NULL);
862 }
863
864
865 /**
866  * Create a new Key eXchange context for the tunnel.
867  *
868  * If context exists, just cancels the finish_task, does not create new nonce.
869  * Otherwise copies the keys, timestamps the KX and creates a new nonce.
870  *
871  * @param t Tunnel for which to create the KX ctx.
872  */
873 static void
874 create_kx_ctx (struct CadetTunnel *t)
875 {
876   LOG (GNUNET_ERROR_TYPE_INFO, "  new kx ctx for %s\n", GCT_2s (t));
877
878   if (NULL != t->kx_ctx)
879   {
880     if (GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
881     {
882       LOG (GNUNET_ERROR_TYPE_INFO, "  resetting exisiting finish task\n");
883       GNUNET_SCHEDULER_cancel (t->kx_ctx->finish_task);
884       t->kx_ctx->finish_task = GNUNET_SCHEDULER_NO_TASK;
885     }
886     return;
887   }
888
889   t->kx_ctx = GNUNET_new (struct CadetTunnelKXCtx);
890   t->kx_ctx->challenge = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
891                                                    UINT32_MAX);
892   t->kx_ctx->d_key_old = t->d_key;
893   t->kx_ctx->e_key_old = t->e_key;
894   t->kx_ctx->rekey_start_time = GNUNET_TIME_absolute_get ();
895 }
896
897
898 /**
899  * @brief Finish the Key eXchange and destroy the old keys.
900  *
901  * @param cls Closure (Tunnel for which to finish the KX).
902  * @param tc Task context.
903  */
904 static void
905 finish_kx (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
906 {
907   struct CadetTunnel *t = cls;
908
909   LOG (GNUNET_ERROR_TYPE_INFO, "finish KX for %s\n", GCT_2s (t));
910
911   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
912   {
913     LOG (GNUNET_ERROR_TYPE_INFO, "  shutdown\n");
914     return;
915   }
916
917   GNUNET_free (t->kx_ctx);
918   t->kx_ctx = NULL;
919 }
920
921
922 /**
923  * Destroy a Key eXchange context for the tunnel. This function only schedules
924  * the destruction, the freeing of the memory (and clearing of old key material)
925  * happens after a delay!
926  *
927  * @param t Tunnel whose KX ctx to destroy.
928  */
929 static void
930 destroy_kx_ctx (struct CadetTunnel *t)
931 {
932   struct GNUNET_TIME_Relative delay;
933
934   if (NULL == t->kx_ctx || GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
935     return;
936
937   if (is_key_null (&t->kx_ctx->e_key_old))
938   {
939     t->kx_ctx->finish_task = GNUNET_SCHEDULER_add_now (finish_kx, t);
940     return;
941   }
942
943   delay = GNUNET_TIME_relative_divide (rekey_period, 4);
944   delay = GNUNET_TIME_relative_min (delay, GNUNET_TIME_UNIT_MINUTES);
945
946   t->kx_ctx->finish_task = GNUNET_SCHEDULER_add_delayed (delay, finish_kx, t);
947 }
948
949
950 /**
951  * Derive the tunnel's keys using our own and the peer's ephemeral keys.
952  *
953  * @param t Tunnel for which to create the keys.
954  */
955 static void
956 create_keys (struct CadetTunnel *t)
957 {
958   struct GNUNET_HashCode km;
959
960   derive_key_material (&km, &t->peers_ephemeral_key);
961   derive_symmertic (&t->e_key, &my_full_id, GCP_get_id (t->peer), &km);
962   derive_symmertic (&t->d_key, GCP_get_id (t->peer), &my_full_id, &km);
963 #if DUMP_KEYS_TO_STDERR
964   LOG (GNUNET_ERROR_TYPE_INFO, "ME: %s\n",
965        GNUNET_h2s ((struct GNUNET_HashCode *) &kx_msg.ephemeral_key));
966   LOG (GNUNET_ERROR_TYPE_INFO, "PE: %s\n",
967        GNUNET_h2s ((struct GNUNET_HashCode *) &t->peers_ephemeral_key));
968   LOG (GNUNET_ERROR_TYPE_INFO, "KM: %s\n", GNUNET_h2s (&km));
969   LOG (GNUNET_ERROR_TYPE_INFO, "EK: %s\n",
970        GNUNET_h2s ((struct GNUNET_HashCode *) &t->e_key));
971   LOG (GNUNET_ERROR_TYPE_INFO, "DK: %s\n",
972        GNUNET_h2s ((struct GNUNET_HashCode *) &t->d_key));
973 #endif
974 }
975
976
977 /**
978  * Pick a connection on which send the next data message.
979  *
980  * @param t Tunnel on which to send the message.
981  *
982  * @return The connection on which to send the next message.
983  */
984 static struct CadetConnection *
985 tunnel_get_connection (struct CadetTunnel *t)
986 {
987   struct CadetTConnection *iter;
988   struct CadetConnection *best;
989   unsigned int qn;
990   unsigned int lowest_q;
991
992   LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel_get_connection %s\n", GCT_2s (t));
993   best = NULL;
994   lowest_q = UINT_MAX;
995   for (iter = t->connection_head; NULL != iter; iter = iter->next)
996   {
997     LOG (GNUNET_ERROR_TYPE_DEBUG, "  connection %s: %u\n",
998          GCC_2s (iter->c), GCC_get_state (iter->c));
999     if (CADET_CONNECTION_READY == GCC_get_state (iter->c))
1000     {
1001       qn = GCC_get_qn (iter->c, GCC_is_origin (iter->c, GNUNET_YES));
1002       LOG (GNUNET_ERROR_TYPE_DEBUG, "    q_n %u, \n", qn);
1003       if (qn < lowest_q)
1004       {
1005         best = iter->c;
1006         lowest_q = qn;
1007       }
1008     }
1009   }
1010   LOG (GNUNET_ERROR_TYPE_DEBUG, " selected: connection %s\n", GCC_2s (best));
1011   return best;
1012 }
1013
1014
1015 /**
1016  * Callback called when a queued message is sent.
1017  *
1018  * Calculates the average time and connection packet tracking.
1019  *
1020  * @param cls Closure (TunnelQueue handle).
1021  * @param c Connection this message was on.
1022  * @param q Connection queue handle (unused).
1023  * @param type Type of message sent.
1024  * @param fwd Was this a FWD going message?
1025  * @param size Size of the message.
1026  */
1027 static void
1028 tun_message_sent (void *cls,
1029               struct CadetConnection *c,
1030               struct CadetConnectionQueue *q,
1031               uint16_t type, int fwd, size_t size)
1032 {
1033   struct CadetTunnelQueue *qt = cls;
1034   struct CadetTunnel *t;
1035
1036   LOG (GNUNET_ERROR_TYPE_DEBUG, "tun_message_sent\n");
1037
1038   GNUNET_assert (NULL != qt->cont);
1039   t = NULL == c ? NULL : GCC_get_tunnel (c);
1040   qt->cont (qt->cont_cls, t, qt, type, size);
1041   GNUNET_free (qt);
1042 }
1043
1044
1045 static unsigned int
1046 count_queued_data (const struct CadetTunnel *t)
1047 {
1048   struct CadetTunnelDelayed *iter;
1049   unsigned int count;
1050
1051   for (count = 0, iter = t->tq_head; iter != NULL; iter = iter->next)
1052     count++;
1053
1054   return count;
1055 }
1056
1057 /**
1058  * Delete a queued message: either was sent or the channel was destroyed
1059  * before the tunnel's key exchange had a chance to finish.
1060  *
1061  * @param tqd Delayed queue handle.
1062  */
1063 static void
1064 unqueue_data (struct CadetTunnelDelayed *tqd)
1065 {
1066   GNUNET_CONTAINER_DLL_remove (tqd->t->tq_head, tqd->t->tq_tail, tqd);
1067   GNUNET_free (tqd);
1068 }
1069
1070
1071 /**
1072  * Cache a message to be sent once tunnel is online.
1073  *
1074  * @param t Tunnel to hold the message.
1075  * @param msg Message itself (copy will be made).
1076  */
1077 static struct CadetTunnelDelayed *
1078 queue_data (struct CadetTunnel *t, const struct GNUNET_MessageHeader *msg)
1079 {
1080   struct CadetTunnelDelayed *tqd;
1081   uint16_t size = ntohs (msg->size);
1082
1083   LOG (GNUNET_ERROR_TYPE_DEBUG, "queue data on Tunnel %s\n", GCT_2s (t));
1084
1085   if (GNUNET_YES == is_ready (t))
1086   {
1087     GNUNET_break (0);
1088     return NULL;
1089   }
1090
1091   tqd = GNUNET_malloc (sizeof (struct CadetTunnelDelayed) + size);
1092
1093   tqd->t = t;
1094   memcpy (&tqd[1], msg, size);
1095   GNUNET_CONTAINER_DLL_insert_tail (t->tq_head, t->tq_tail, tqd);
1096   return tqd;
1097 }
1098
1099
1100 /**
1101  * Sends an already built message on a tunnel, encrypting it and
1102  * choosing the best connection.
1103  *
1104  * @param message Message to send. Function modifies it.
1105  * @param t Tunnel on which this message is transmitted.
1106  * @param c Connection to use (autoselect if NULL).
1107  * @param force Force the tunnel to take the message (buffer overfill).
1108  * @param cont Continuation to call once message is really sent.
1109  * @param cont_cls Closure for @c cont.
1110  * @param existing_q In case this a transmission of previously queued data,
1111  *                   this should be TunnelQueue given to the client.
1112  *                   Otherwise, NULL.
1113  *
1114  * @return Handle to cancel message.
1115  *         NULL if @c cont is NULL or an error happens and message is dropped.
1116  */
1117 static struct CadetTunnelQueue *
1118 send_prebuilt_message (const struct GNUNET_MessageHeader *message,
1119                        struct CadetTunnel *t, struct CadetConnection *c,
1120                        int force, GCT_sent cont, void *cont_cls,
1121                        struct CadetTunnelQueue *existing_q)
1122 {
1123   struct CadetTunnelQueue *tq;
1124   struct GNUNET_CADET_Encrypted *msg;
1125   size_t size = ntohs (message->size);
1126   char cbuf[sizeof (struct GNUNET_CADET_Encrypted) + size];
1127   uint32_t mid;
1128   uint32_t iv;
1129   uint16_t type;
1130   int fwd;
1131
1132   LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT Send on Tunnel %s\n", GCT_2s (t));
1133
1134   if (GNUNET_NO == is_ready (t))
1135   {
1136     struct CadetTunnelDelayed *tqd;
1137     /* A non null existing_q indicates sending of queued data.
1138      * Should only happen after tunnel becomes ready.
1139      */
1140     GNUNET_assert (NULL == existing_q);
1141     tqd = queue_data (t, message);
1142     if (NULL == cont)
1143       return NULL;
1144     tq = GNUNET_new (struct CadetTunnelQueue);
1145     tq->tqd = tqd;
1146     tqd->tq = tq;
1147     tq->cont = cont;
1148     tq->cont_cls = cont_cls;
1149     return tq;
1150   }
1151
1152   GNUNET_assert (GNUNET_NO == GCT_is_loopback (t));
1153
1154   iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1155   msg = (struct GNUNET_CADET_Encrypted *) cbuf;
1156   msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED);
1157   msg->iv = iv;
1158   GNUNET_assert (t_encrypt (t, &msg[1], message, size, iv, GNUNET_NO) == size);
1159   t_hmac (&msg[1], size, iv, select_key (t), &msg->hmac);
1160   msg->header.size = htons (sizeof (struct GNUNET_CADET_Encrypted) + size);
1161
1162   if (NULL == c)
1163     c = tunnel_get_connection (t);
1164   if (NULL == c)
1165   {
1166     /* Why is tunnel 'ready'? Should have been queued! */
1167     if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
1168     {
1169       GNUNET_break (0);
1170       GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
1171     }
1172     return NULL; /* Drop... */
1173   }
1174
1175   mid = 0;
1176   type = ntohs (message->type);
1177   switch (type)
1178   {
1179     case GNUNET_MESSAGE_TYPE_CADET_DATA:
1180     case GNUNET_MESSAGE_TYPE_CADET_DATA_ACK:
1181       if (GNUNET_MESSAGE_TYPE_CADET_DATA == type)
1182         mid = ntohl (((struct GNUNET_CADET_Data *) message)->mid);
1183       else
1184         mid = ntohl (((struct GNUNET_CADET_DataACK *) message)->mid);
1185       /* Fall thru */
1186     case GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE:
1187     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
1188     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
1189     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_ACK:
1190     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK:
1191       msg->cid = *GCC_get_id (c);
1192       msg->ttl = htonl (default_ttl);
1193       break;
1194     default:
1195       GNUNET_break (0);
1196       LOG (GNUNET_ERROR_TYPE_ERROR, "type %s not valid\n", GC_m2s (type));
1197   }
1198   LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s\n", GC_m2s (type));
1199
1200   fwd = GCC_is_origin (c, GNUNET_YES);
1201
1202   if (NULL == cont)
1203   {
1204     GNUNET_break (NULL == GCC_send_prebuilt_message (&msg->header, type, mid, c,
1205                                                      fwd, force, NULL, NULL));
1206     return NULL;
1207   }
1208   if (NULL == existing_q)
1209   {
1210     tq = GNUNET_new (struct CadetTunnelQueue); /* FIXME valgrind: leak*/
1211   }
1212   else
1213   {
1214     tq = existing_q;
1215     tq->tqd = NULL;
1216   }
1217   tq->cq = GCC_send_prebuilt_message (&msg->header, type, mid, c, fwd, force,
1218                                       &tun_message_sent, tq);
1219   GNUNET_assert (NULL != tq->cq);
1220   tq->cont = cont;
1221   tq->cont_cls = cont_cls;
1222
1223   return tq;
1224 }
1225
1226
1227 /**
1228  * Send all cached messages that we can, tunnel is online.
1229  *
1230  * @param t Tunnel that holds the messages. Cannot be loopback.
1231  */
1232 static void
1233 send_queued_data (struct CadetTunnel *t)
1234 {
1235   struct CadetTunnelDelayed *tqd;
1236   struct CadetTunnelDelayed *next;
1237   unsigned int room;
1238
1239   LOG (GNUNET_ERROR_TYPE_DEBUG,
1240        "GCT_send_queued_data on tunnel %s\n",
1241        GCT_2s (t));
1242
1243   if (GCT_is_loopback (t))
1244   {
1245     GNUNET_break (0);
1246     return;
1247   }
1248
1249   if (GNUNET_NO == is_ready (t))
1250   {
1251     LOG (GNUNET_ERROR_TYPE_DEBUG, "  not ready yet: %s/%s\n",
1252          estate2s (t->estate), cstate2s (t->cstate));
1253     return;
1254   }
1255
1256   room = GCT_get_connections_buffer (t);
1257   LOG (GNUNET_ERROR_TYPE_DEBUG, "  buffer space: %u\n", room);
1258   LOG (GNUNET_ERROR_TYPE_DEBUG, "  tq head: %p\n", t->tq_head);
1259   for (tqd = t->tq_head; NULL != tqd && room > 0; tqd = next)
1260   {
1261     LOG (GNUNET_ERROR_TYPE_DEBUG, " sending queued data\n");
1262     next = tqd->next;
1263     room--;
1264     send_prebuilt_message ((struct GNUNET_MessageHeader *) &tqd[1],
1265                            tqd->t, NULL, GNUNET_YES,
1266                            NULL != tqd->tq ? tqd->tq->cont : NULL,
1267                            NULL != tqd->tq ? tqd->tq->cont_cls : NULL,
1268                            tqd->tq);
1269     unqueue_data (tqd);
1270   }
1271   LOG (GNUNET_ERROR_TYPE_DEBUG, "GCT_send_queued_data end\n", GCP_2s (t->peer));
1272 }
1273
1274
1275 /**
1276  * Sends key exchange message on a tunnel, choosing the best connection.
1277  * Should not be called on loopback tunnels.
1278  *
1279  * @param t Tunnel on which this message is transmitted.
1280  * @param message Message to send. Function modifies it.
1281  */
1282 static void
1283 send_kx (struct CadetTunnel *t,
1284          const struct GNUNET_MessageHeader *message)
1285 {
1286   struct CadetConnection *c;
1287   struct GNUNET_CADET_KX *msg;
1288   size_t size = ntohs (message->size);
1289   char cbuf[sizeof (struct GNUNET_CADET_KX) + size];
1290   uint16_t type;
1291   int fwd;
1292
1293   LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT KX on Tunnel %s\n", GCT_2s (t));
1294
1295   /* Avoid loopback. */
1296   if (GCT_is_loopback (t))
1297   {
1298     LOG (GNUNET_ERROR_TYPE_DEBUG, "  loopback!\n");
1299     GNUNET_break (0);
1300     return;
1301   }
1302   type = ntohs (message->type);
1303
1304   /* Even if tunnel is being destroyed, send anyway.
1305    * Could be a response to a rekey initiated by remote peer,
1306    * who is trying to create a new channel!
1307    */
1308
1309   /* Must have a connection, or be looking for one. */
1310   if (NULL == t->connection_head)
1311   {
1312     if (CADET_TUNNEL_SEARCHING != t->cstate)
1313     {
1314       LOG (GNUNET_ERROR_TYPE_ERROR, "\n\n\n");
1315       GNUNET_break (0);
1316       LOG (GNUNET_ERROR_TYPE_ERROR, "no connection, sending %s\n", GC_m2s (type));
1317       GCT_debug (t, GNUNET_ERROR_TYPE_ERROR);
1318       GCP_debug (t->peer, GNUNET_ERROR_TYPE_ERROR);
1319       LOG (GNUNET_ERROR_TYPE_ERROR, "\n\n\n");
1320     }
1321     return;
1322   }
1323
1324   msg = (struct GNUNET_CADET_KX *) cbuf;
1325   msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX);
1326   msg->header.size = htons (sizeof (struct GNUNET_CADET_KX) + size);
1327   c = tunnel_get_connection (t);
1328   if (NULL == c)
1329   {
1330     if (GNUNET_SCHEDULER_NO_TASK == t->destroy_task
1331         && CADET_TUNNEL_READY == t->cstate)
1332     {
1333       GNUNET_break (0);
1334       GCT_debug (t, GNUNET_ERROR_TYPE_ERROR);
1335     }
1336     return;
1337   }
1338   switch (type)
1339   {
1340     case GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL:
1341     case GNUNET_MESSAGE_TYPE_CADET_KX_PING:
1342     case GNUNET_MESSAGE_TYPE_CADET_KX_PONG:
1343       memcpy (&msg[1], message, size);
1344       break;
1345     default:
1346       LOG (GNUNET_ERROR_TYPE_DEBUG, "unkown type %s\n",
1347            GC_m2s (type));
1348       GNUNET_break (0);
1349   }
1350
1351   fwd = GCC_is_origin (t->connection_head->c, GNUNET_YES);
1352   /* TODO save handle and cancel in case of a unneeded retransmission */
1353   GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg->header, type, 0, c,
1354                                                     fwd, GNUNET_YES,
1355                                                     NULL, NULL));
1356 }
1357
1358
1359 /**
1360  * Send the ephemeral key on a tunnel.
1361  *
1362  * @param t Tunnel on which to send the key.
1363  */
1364 static void
1365 send_ephemeral (struct CadetTunnel *t)
1366 {
1367   LOG (GNUNET_ERROR_TYPE_INFO, "===> EPHM for %s\n", GCT_2s (t));
1368
1369   kx_msg.sender_status = htonl (t->estate);
1370   send_kx (t, &kx_msg.header);
1371 }
1372
1373 /**
1374  * Send a ping message on a tunnel.
1375  *
1376  * @param t Tunnel on which to send the ping.
1377  */
1378 static void
1379 send_ping (struct CadetTunnel *t)
1380 {
1381   struct GNUNET_CADET_KX_Ping msg;
1382
1383   LOG (GNUNET_ERROR_TYPE_INFO, "===> PING for %s\n", GCT_2s (t));
1384   msg.header.size = htons (sizeof (msg));
1385   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX_PING);
1386   msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1387   msg.target = *GCP_get_id (t->peer);
1388   msg.nonce = t->kx_ctx->challenge;
1389
1390   LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending %u\n", msg.nonce);
1391   LOG (GNUNET_ERROR_TYPE_DEBUG, "  towards %s\n", GNUNET_i2s (&msg.target));
1392   t_encrypt (t, &msg.target, &msg.target,
1393              ping_encryption_size(), msg.iv, GNUNET_YES);
1394   LOG (GNUNET_ERROR_TYPE_DEBUG, "  e sending %u\n", msg.nonce);
1395   LOG (GNUNET_ERROR_TYPE_DEBUG, "  e towards %s\n", GNUNET_i2s (&msg.target));
1396
1397   send_kx (t, &msg.header);
1398 }
1399
1400
1401 /**
1402  * Send a pong message on a tunnel.
1403  *d_
1404  * @param t Tunnel on which to send the pong.
1405  * @param challenge Value sent in the ping that we have to send back.
1406  */
1407 static void
1408 send_pong (struct CadetTunnel *t, uint32_t challenge)
1409 {
1410   struct GNUNET_CADET_KX_Pong msg;
1411
1412   LOG (GNUNET_ERROR_TYPE_INFO, "===> PONG for %s\n", GCT_2s (t));
1413   msg.header.size = htons (sizeof (msg));
1414   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX_PONG);
1415   msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1416   msg.nonce = challenge;
1417   LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending %u\n", msg.nonce);
1418   t_encrypt (t, &msg.nonce, &msg.nonce,
1419              sizeof (msg.nonce), msg.iv, GNUNET_YES);
1420   LOG (GNUNET_ERROR_TYPE_DEBUG, "  e sending %u\n", msg.nonce);
1421
1422   send_kx (t, &msg.header);
1423 }
1424
1425
1426 /**
1427  * Initiate a rekey with the remote peer.
1428  *
1429  * @param cls Closure (tunnel).
1430  * @param tc TaskContext.
1431  */
1432 static void
1433 rekey_tunnel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1434 {
1435   struct CadetTunnel *t = cls;
1436
1437   t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
1438
1439   LOG (GNUNET_ERROR_TYPE_INFO, "Re-key Tunnel %s\n", GCT_2s (t));
1440   if (NULL != tc && 0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1441     return;
1442
1443   create_kx_ctx (t);
1444
1445   if (NULL == t->kx_ctx)
1446   {
1447     create_keys (t);
1448   }
1449   else
1450   {
1451     struct GNUNET_TIME_Relative duration;
1452
1453     duration = GNUNET_TIME_absolute_get_duration (t->kx_ctx->rekey_start_time);
1454     LOG (GNUNET_ERROR_TYPE_DEBUG, " kx started %s ago\n",
1455          GNUNET_STRINGS_relative_time_to_string (duration, GNUNET_YES));
1456
1457     // FIXME make duration of old keys configurable
1458     if (duration.rel_value_us >= GNUNET_TIME_UNIT_MINUTES.rel_value_us)
1459     {
1460       memset (&t->kx_ctx->d_key_old, 0, sizeof (t->kx_ctx->d_key_old));
1461       memset (&t->kx_ctx->e_key_old, 0, sizeof (t->kx_ctx->e_key_old));
1462     }
1463   }
1464
1465   send_ephemeral (t);
1466
1467   switch (t->estate)
1468   {
1469     case CADET_TUNNEL_KEY_UNINITIALIZED:
1470       t->estate = CADET_TUNNEL_KEY_SENT;
1471       break;
1472     case CADET_TUNNEL_KEY_SENT:
1473       break;
1474     case CADET_TUNNEL_KEY_OK:
1475       t->estate = CADET_TUNNEL_KEY_REKEY;
1476       /* fall-thru */
1477     case CADET_TUNNEL_KEY_PING:
1478     case CADET_TUNNEL_KEY_REKEY:
1479       send_ping (t);
1480       break;
1481     default:
1482       LOG (GNUNET_ERROR_TYPE_DEBUG, "Unexpected state %u\n", t->estate);
1483   }
1484
1485   // FIXME exponential backoff
1486   struct GNUNET_TIME_Relative delay;
1487
1488   delay = GNUNET_TIME_relative_divide (rekey_period, 16);
1489   delay = GNUNET_TIME_relative_min (delay, REKEY_WAIT);
1490   LOG (GNUNET_ERROR_TYPE_DEBUG, "  next call in %s\n",
1491        GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1492   t->rekey_task = GNUNET_SCHEDULER_add_delayed (delay, &rekey_tunnel, t);
1493 }
1494
1495
1496 /**
1497  * Our ephemeral key has changed, create new session key on all tunnels.
1498  *
1499  * Each tunnel will start the Key Exchange with a random delay between
1500  * 0 and number_of_tunnels*100 milliseconds, so there are 10 key exchanges
1501  * per second, on average.
1502  *
1503  * @param cls Closure (size of the hashmap).
1504  * @param key Current public key.
1505  * @param value Value in the hash map (tunnel).
1506  *
1507  * @return #GNUNET_YES, so we should continue to iterate,
1508  */
1509 static int
1510 rekey_iterator (void *cls,
1511                 const struct GNUNET_PeerIdentity *key,
1512                 void *value)
1513 {
1514   struct CadetTunnel *t = value;
1515   struct GNUNET_TIME_Relative delay;
1516   long n = (long) cls;
1517   uint32_t r;
1518
1519   if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
1520     return GNUNET_YES;
1521
1522   if (GNUNET_YES == GCT_is_loopback (t))
1523     return GNUNET_YES;
1524
1525   r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, (uint32_t) n * 100);
1526   delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, r);
1527   t->rekey_task = GNUNET_SCHEDULER_add_delayed (delay, &rekey_tunnel, t);
1528
1529   return GNUNET_YES;
1530 }
1531
1532
1533 /**
1534  * Create a new ephemeral key and key message, schedule next rekeying.
1535  *
1536  * @param cls Closure (unused).
1537  * @param tc TaskContext.
1538  */
1539 static void
1540 rekey (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1541 {
1542   struct GNUNET_TIME_Absolute time;
1543   long n;
1544
1545   rekey_task = GNUNET_SCHEDULER_NO_TASK;
1546
1547   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1548     return;
1549
1550   GNUNET_free_non_null (my_ephemeral_key);
1551   my_ephemeral_key = GNUNET_CRYPTO_ecdhe_key_create ();
1552
1553   time = GNUNET_TIME_absolute_get ();
1554   kx_msg.creation_time = GNUNET_TIME_absolute_hton (time);
1555   time = GNUNET_TIME_absolute_add (time, rekey_period);
1556   time = GNUNET_TIME_absolute_add (time, GNUNET_TIME_UNIT_MINUTES);
1557   kx_msg.expiration_time = GNUNET_TIME_absolute_hton (time);
1558   GNUNET_CRYPTO_ecdhe_key_get_public (my_ephemeral_key, &kx_msg.ephemeral_key);
1559
1560   GNUNET_assert (GNUNET_OK ==
1561                  GNUNET_CRYPTO_eddsa_sign (my_private_key,
1562                                            &kx_msg.purpose,
1563                                            &kx_msg.signature));
1564
1565   n = (long) GNUNET_CONTAINER_multipeermap_size (tunnels);
1566   GNUNET_CONTAINER_multipeermap_iterate (tunnels, &rekey_iterator, (void *) n);
1567
1568   rekey_task = GNUNET_SCHEDULER_add_delayed (rekey_period, &rekey, NULL);
1569 }
1570
1571
1572 /**
1573  * Called only on shutdown, destroy every tunnel.
1574  *
1575  * @param cls Closure (unused).
1576  * @param key Current public key.
1577  * @param value Value in the hash map (tunnel).
1578  *
1579  * @return #GNUNET_YES, so we should continue to iterate,
1580  */
1581 static int
1582 destroy_iterator (void *cls,
1583                 const struct GNUNET_PeerIdentity *key,
1584                 void *value)
1585 {
1586   struct CadetTunnel *t = value;
1587
1588   LOG (GNUNET_ERROR_TYPE_DEBUG, "GCT_shutdown destroying tunnel at %p\n", t);
1589   GCT_destroy (t);
1590   return GNUNET_YES;
1591 }
1592
1593
1594 /**
1595  * Notify remote peer that we don't know a channel he is talking about,
1596  * probably CHANNEL_DESTROY was missed.
1597  *
1598  * @param t Tunnel on which to notify.
1599  * @param gid ID of the channel.
1600  */
1601 static void
1602 send_channel_destroy (struct CadetTunnel *t, unsigned int gid)
1603 {
1604   struct GNUNET_CADET_ChannelManage msg;
1605
1606   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
1607   msg.header.size = htons (sizeof (msg));
1608   msg.chid = htonl (gid);
1609
1610   LOG (GNUNET_ERROR_TYPE_DEBUG,
1611        "WARNING destroying unknown channel %u on tunnel %s\n",
1612        gid, GCT_2s (t));
1613   send_prebuilt_message (&msg.header, t, NULL, GNUNET_YES, NULL, NULL, NULL);
1614 }
1615
1616
1617 /**
1618  * Demultiplex data per channel and call appropriate channel handler.
1619  *
1620  * @param t Tunnel on which the data came.
1621  * @param msg Data message.
1622  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1623  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1624  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1625  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1626  */
1627 static void
1628 handle_data (struct CadetTunnel *t,
1629              const struct GNUNET_CADET_Data *msg,
1630              int fwd)
1631 {
1632   struct CadetChannel *ch;
1633   size_t size;
1634
1635   /* Check size */
1636   size = ntohs (msg->header.size);
1637   if (size <
1638       sizeof (struct GNUNET_CADET_Data) +
1639       sizeof (struct GNUNET_MessageHeader))
1640   {
1641     GNUNET_break (0);
1642     return;
1643   }
1644   LOG (GNUNET_ERROR_TYPE_DEBUG, " payload of type %s\n",
1645               GC_m2s (ntohs (msg[1].header.type)));
1646
1647   /* Check channel */
1648   ch = GCT_get_channel (t, ntohl (msg->chid));
1649   if (NULL == ch)
1650   {
1651     GNUNET_STATISTICS_update (stats, "# data on unknown channel",
1652                               1, GNUNET_NO);
1653     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel 0x%X unknown\n",
1654          ntohl (msg->chid));
1655     send_channel_destroy (t, ntohl (msg->chid));
1656     return;
1657   }
1658
1659   GCCH_handle_data (ch, msg, fwd);
1660 }
1661
1662
1663 /**
1664  * Demultiplex data ACKs per channel and update appropriate channel buffer info.
1665  *
1666  * @param t Tunnel on which the DATA ACK came.
1667  * @param msg DATA ACK message.
1668  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1669  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1670  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1671  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1672  */
1673 static void
1674 handle_data_ack (struct CadetTunnel *t,
1675                  const struct GNUNET_CADET_DataACK *msg,
1676                  int fwd)
1677 {
1678   struct CadetChannel *ch;
1679   size_t size;
1680
1681   /* Check size */
1682   size = ntohs (msg->header.size);
1683   if (size != sizeof (struct GNUNET_CADET_DataACK))
1684   {
1685     GNUNET_break (0);
1686     return;
1687   }
1688
1689   /* Check channel */
1690   ch = GCT_get_channel (t, ntohl (msg->chid));
1691   if (NULL == ch)
1692   {
1693     GNUNET_STATISTICS_update (stats, "# data ack on unknown channel",
1694                               1, GNUNET_NO);
1695     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1696          ntohl (msg->chid));
1697     return;
1698   }
1699
1700   GCCH_handle_data_ack (ch, msg, fwd);
1701 }
1702
1703
1704 /**
1705  * Handle channel create.
1706  *
1707  * @param t Tunnel on which the data came.
1708  * @param msg Data message.
1709  */
1710 static void
1711 handle_ch_create (struct CadetTunnel *t,
1712                   const struct GNUNET_CADET_ChannelCreate *msg)
1713 {
1714   struct CadetChannel *ch;
1715   size_t size;
1716
1717   /* Check size */
1718   size = ntohs (msg->header.size);
1719   if (size != sizeof (struct GNUNET_CADET_ChannelCreate))
1720   {
1721     GNUNET_break (0);
1722     return;
1723   }
1724
1725   /* Check channel */
1726   ch = GCT_get_channel (t, ntohl (msg->chid));
1727   if (NULL != ch && ! GCT_is_loopback (t))
1728   {
1729     /* Probably a retransmission, safe to ignore */
1730     LOG (GNUNET_ERROR_TYPE_DEBUG, "   already exists...\n");
1731   }
1732   ch = GCCH_handle_create (t, msg);
1733   if (NULL != ch)
1734     GCT_add_channel (t, ch);
1735 }
1736
1737
1738
1739 /**
1740  * Handle channel NACK: check correctness and call channel handler for NACKs.
1741  *
1742  * @param t Tunnel on which the NACK came.
1743  * @param msg NACK message.
1744  */
1745 static void
1746 handle_ch_nack (struct CadetTunnel *t,
1747                 const struct GNUNET_CADET_ChannelManage *msg)
1748 {
1749   struct CadetChannel *ch;
1750   size_t size;
1751
1752   /* Check size */
1753   size = ntohs (msg->header.size);
1754   if (size != sizeof (struct GNUNET_CADET_ChannelManage))
1755   {
1756     GNUNET_break (0);
1757     return;
1758   }
1759
1760   /* Check channel */
1761   ch = GCT_get_channel (t, ntohl (msg->chid));
1762   if (NULL == ch)
1763   {
1764     GNUNET_STATISTICS_update (stats, "# channel NACK on unknown channel",
1765                               1, GNUNET_NO);
1766     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1767          ntohl (msg->chid));
1768     return;
1769   }
1770
1771   GCCH_handle_nack (ch);
1772 }
1773
1774
1775 /**
1776  * Handle a CHANNEL ACK (SYNACK/ACK).
1777  *
1778  * @param t Tunnel on which the CHANNEL ACK came.
1779  * @param msg CHANNEL ACK message.
1780  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1781  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1782  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1783  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1784  */
1785 static void
1786 handle_ch_ack (struct CadetTunnel *t,
1787                const struct GNUNET_CADET_ChannelManage *msg,
1788                int fwd)
1789 {
1790   struct CadetChannel *ch;
1791   size_t size;
1792
1793   /* Check size */
1794   size = ntohs (msg->header.size);
1795   if (size != sizeof (struct GNUNET_CADET_ChannelManage))
1796   {
1797     GNUNET_break (0);
1798     return;
1799   }
1800
1801   /* Check channel */
1802   ch = GCT_get_channel (t, ntohl (msg->chid));
1803   if (NULL == ch)
1804   {
1805     GNUNET_STATISTICS_update (stats, "# channel ack on unknown channel",
1806                               1, GNUNET_NO);
1807     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1808          ntohl (msg->chid));
1809     return;
1810   }
1811
1812   GCCH_handle_ack (ch, msg, fwd);
1813 }
1814
1815
1816 /**
1817  * Handle a channel destruction message.
1818  *
1819  * @param t Tunnel on which the message came.
1820  * @param msg Channel destroy message.
1821  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1822  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1823  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1824  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1825  */
1826 static void
1827 handle_ch_destroy (struct CadetTunnel *t,
1828                    const struct GNUNET_CADET_ChannelManage *msg,
1829                    int fwd)
1830 {
1831   struct CadetChannel *ch;
1832   size_t size;
1833
1834   /* Check size */
1835   size = ntohs (msg->header.size);
1836   if (size != sizeof (struct GNUNET_CADET_ChannelManage))
1837   {
1838     GNUNET_break (0);
1839     return;
1840   }
1841
1842   /* Check channel */
1843   ch = GCT_get_channel (t, ntohl (msg->chid));
1844   if (NULL == ch)
1845   {
1846     /* Probably a retransmission, safe to ignore */
1847     return;
1848   }
1849
1850   GCCH_handle_destroy (ch, msg, fwd);
1851 }
1852
1853
1854 /**
1855  * The peer's ephemeral key has changed: update the symmetrical keys.
1856  *
1857  * @param t Tunnel this message came on.
1858  * @param msg Key eXchange message.
1859  */
1860 static void
1861 handle_ephemeral (struct CadetTunnel *t,
1862                   const struct GNUNET_CADET_KX_Ephemeral *msg)
1863 {
1864   LOG (GNUNET_ERROR_TYPE_INFO, "<=== EPHM for %s\n", GCT_2s (t));
1865
1866   if (GNUNET_OK != check_ephemeral (t, msg))
1867   {
1868     GNUNET_break_op (0);
1869     return;
1870   }
1871
1872   create_kx_ctx (t);
1873   if (0 != memcmp (&t->peers_ephemeral_key, &msg->ephemeral_key,
1874                    sizeof (msg->ephemeral_key)))
1875   {
1876     t->peers_ephemeral_key = msg->ephemeral_key;
1877     create_keys (t);
1878     if (CADET_TUNNEL_KEY_OK == t->estate)
1879     {
1880       t->estate = CADET_TUNNEL_KEY_REKEY;
1881     }
1882     if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
1883       GNUNET_SCHEDULER_cancel (t->rekey_task);
1884     t->rekey_task = GNUNET_SCHEDULER_add_now (rekey_tunnel, t);
1885   }
1886   else if (CADET_TUNNEL_KEY_OK == t->estate)
1887   {
1888     destroy_kx_ctx (t);
1889   }
1890   if (CADET_TUNNEL_KEY_SENT == t->estate)
1891   {
1892     LOG (GNUNET_ERROR_TYPE_DEBUG, "  our key was sent, sending ping\n");
1893     send_ping (t);
1894     t->estate = CADET_TUNNEL_KEY_PING;
1895   }
1896 }
1897
1898
1899 /**
1900  * Peer wants to check our symmetrical keys by sending an encrypted challenge.
1901  * Answer with by retransmitting the challenge with the "opposite" key.
1902  *
1903  * @param t Tunnel this message came on.
1904  * @param msg Key eXchange Ping message.
1905  */
1906 static void
1907 handle_ping (struct CadetTunnel *t,
1908              const struct GNUNET_CADET_KX_Ping *msg)
1909 {
1910   struct GNUNET_CADET_KX_Ping res;
1911
1912   if (ntohs (msg->header.size) != sizeof (res))
1913   {
1914     GNUNET_break_op (0);
1915     return;
1916   }
1917
1918   LOG (GNUNET_ERROR_TYPE_INFO, "<=== PING for %s\n", GCT_2s (t));
1919   t_decrypt (t, &res.target, &msg->target, ping_encryption_size (), msg->iv);
1920   if (0 != memcmp (&my_full_id, &res.target, sizeof (my_full_id)))
1921   {
1922     /* probably peer hasn't got our new EPHM yet and derived the wrong keys */
1923     GNUNET_STATISTICS_update (stats, "# malformed PINGs", 1, GNUNET_NO);
1924     LOG (GNUNET_ERROR_TYPE_INFO, "  malformed PING on %s\n", GCT_2s (t));
1925     LOG (GNUNET_ERROR_TYPE_DEBUG, "  e got %u\n", msg->nonce);
1926     LOG (GNUNET_ERROR_TYPE_DEBUG, "  e towards %s\n", GNUNET_i2s (&msg->target));
1927     LOG (GNUNET_ERROR_TYPE_DEBUG, "  got %u\n", res.nonce);
1928     LOG (GNUNET_ERROR_TYPE_DEBUG, "  towards %s\n", GNUNET_i2s (&res.target));
1929     create_kx_ctx (t);
1930     send_ephemeral (t);
1931     send_ping (t);
1932     return;
1933   }
1934
1935   send_pong (t, res.nonce);
1936 }
1937
1938
1939 /**
1940  * Peer has answer to our challenge.
1941  * If answer is successful, consider the key exchange finished and clean
1942  * up all related state.
1943  *
1944  * @param t Tunnel this message came on.
1945  * @param msg Key eXchange Pong message.
1946  */
1947 static void
1948 handle_pong (struct CadetTunnel *t,
1949              const struct GNUNET_CADET_KX_Pong *msg)
1950 {
1951   uint32_t challenge;
1952
1953   LOG (GNUNET_ERROR_TYPE_INFO, "<=== PONG for %s\n", GCT_2s (t));
1954   if (GNUNET_SCHEDULER_NO_TASK == t->rekey_task)
1955   {
1956     GNUNET_STATISTICS_update (stats, "# duplicate PONG messages", 1, GNUNET_NO);
1957     return;
1958   }
1959   t_decrypt (t, &challenge, &msg->nonce, sizeof (uint32_t), msg->iv);
1960
1961   if (challenge != t->kx_ctx->challenge)
1962   {
1963     LOG (GNUNET_ERROR_TYPE_WARNING, "Wrong PONG challenge on %s\n", GCT_2s (t));
1964     LOG (GNUNET_ERROR_TYPE_DEBUG, "PONG: %u (e: %u). Expected: %u.\n",
1965          challenge, msg->nonce, t->kx_ctx->challenge);
1966     send_ephemeral (t);
1967     send_ping (t);
1968     return;
1969   }
1970   GNUNET_SCHEDULER_cancel (t->rekey_task);
1971   t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
1972
1973   /* Don't free the old keys right away, but after a delay.
1974    * Rationale: the KX could have happened over a very fast connection,
1975    * with payload traffic still signed with the old key stuck in a slower
1976    * connection.
1977    * Don't keep the keys longer than 1/4 the rekey period, and no longer than
1978    * one minute.
1979    */
1980   destroy_kx_ctx (t);
1981   GCT_change_estate (t, CADET_TUNNEL_KEY_OK);
1982 }
1983
1984
1985 /**
1986  * Demultiplex by message type and call appropriate handler for a message
1987  * towards a channel of a local tunnel.
1988  *
1989  * @param t Tunnel this message came on.
1990  * @param msgh Message header.
1991  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1992  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1993  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1994  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1995  */
1996 static void
1997 handle_decrypted (struct CadetTunnel *t,
1998                   const struct GNUNET_MessageHeader *msgh,
1999                   int fwd)
2000 {
2001   uint16_t type;
2002
2003   type = ntohs (msgh->type);
2004   LOG (GNUNET_ERROR_TYPE_INFO, "<=== %s on %s\n", GC_m2s (type), GCT_2s (t));
2005
2006   switch (type)
2007   {
2008     case GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE:
2009       /* Do nothing, connection aleady got updated. */
2010       GNUNET_STATISTICS_update (stats, "# keepalives received", 1, GNUNET_NO);
2011       break;
2012
2013     case GNUNET_MESSAGE_TYPE_CADET_DATA:
2014       /* Don't send hop ACK, wait for client to ACK */
2015       handle_data (t, (struct GNUNET_CADET_Data *) msgh, fwd);
2016       break;
2017
2018     case GNUNET_MESSAGE_TYPE_CADET_DATA_ACK:
2019       handle_data_ack (t, (struct GNUNET_CADET_DataACK *) msgh, fwd);
2020       break;
2021
2022     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
2023       handle_ch_create (t,
2024                         (struct GNUNET_CADET_ChannelCreate *) msgh);
2025       break;
2026
2027     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK:
2028       handle_ch_nack (t,
2029                       (struct GNUNET_CADET_ChannelManage *) msgh);
2030       break;
2031
2032     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_ACK:
2033       handle_ch_ack (t,
2034                      (struct GNUNET_CADET_ChannelManage *) msgh,
2035                      fwd);
2036       break;
2037
2038     case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
2039       handle_ch_destroy (t,
2040                          (struct GNUNET_CADET_ChannelManage *) msgh,
2041                          fwd);
2042       break;
2043
2044     default:
2045       GNUNET_break_op (0);
2046       LOG (GNUNET_ERROR_TYPE_WARNING,
2047            "end-to-end message not known (%u)\n",
2048            ntohs (msgh->type));
2049       GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
2050   }
2051 }
2052
2053 /******************************************************************************/
2054 /********************************    API    ***********************************/
2055 /******************************************************************************/
2056
2057 /**
2058  * Decrypt and demultiplex by message type. Call appropriate handler
2059  * for every message.
2060  *
2061  * @param t Tunnel this message came on.
2062  * @param msg Encrypted message.
2063  */
2064 void
2065 GCT_handle_encrypted (struct CadetTunnel *t,
2066                       const struct GNUNET_CADET_Encrypted *msg)
2067 {
2068   size_t size = ntohs (msg->header.size);
2069   size_t payload_size = size - sizeof (struct GNUNET_CADET_Encrypted);
2070   int decrypted_size;
2071   char cbuf [payload_size];
2072   struct GNUNET_MessageHeader *msgh;
2073   unsigned int off;
2074
2075   decrypted_size = t_decrypt_and_validate (t, cbuf, &msg[1], payload_size,
2076                                            msg->iv, &msg->hmac);
2077
2078   if (-1 == decrypted_size)
2079   {
2080     GNUNET_break_op (0);
2081     return;
2082   }
2083
2084   off = 0;
2085   while (off < decrypted_size)
2086   {
2087     uint16_t msize;
2088
2089     msgh = (struct GNUNET_MessageHeader *) &cbuf[off];
2090     msize = ntohs (msgh->size);
2091     if (msize < sizeof (struct GNUNET_MessageHeader))
2092     {
2093       GNUNET_break_op (0);
2094       return;
2095     }
2096     handle_decrypted (t, msgh, GNUNET_SYSERR);
2097     off += msize;
2098   }
2099 }
2100
2101
2102 /**
2103  * Demultiplex an encapsulated KX message by message type.
2104  *
2105  * @param t Tunnel on which the message came.
2106  * @param message Payload of KX message.
2107  */
2108 void
2109 GCT_handle_kx (struct CadetTunnel *t,
2110                const struct GNUNET_MessageHeader *message)
2111 {
2112   uint16_t type;
2113
2114   type = ntohs (message->type);
2115   LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message received\n", type);
2116   switch (type)
2117   {
2118     case GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL:
2119       handle_ephemeral (t, (struct GNUNET_CADET_KX_Ephemeral *) message);
2120       break;
2121
2122     case GNUNET_MESSAGE_TYPE_CADET_KX_PING:
2123       handle_ping (t, (struct GNUNET_CADET_KX_Ping *) message);
2124       break;
2125
2126     case GNUNET_MESSAGE_TYPE_CADET_KX_PONG:
2127       handle_pong (t, (struct GNUNET_CADET_KX_Pong *) message);
2128       break;
2129
2130     default:
2131       GNUNET_break_op (0);
2132       LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message not known (%u)\n", type);
2133   }
2134 }
2135
2136
2137 /**
2138  * Initialize the tunnel subsystem.
2139  *
2140  * @param c Configuration handle.
2141  * @param key ECC private key, to derive all other keys and do crypto.
2142  */
2143 void
2144 GCT_init (const struct GNUNET_CONFIGURATION_Handle *c,
2145           const struct GNUNET_CRYPTO_EddsaPrivateKey *key)
2146 {
2147   int expected_overhead;
2148
2149   LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2150
2151   expected_overhead =
2152     sizeof (struct GNUNET_CADET_Encrypted) + sizeof (struct GNUNET_CADET_Data);
2153   GNUNET_assert (GNUNET_CONSTANTS_CADET_P2P_OVERHEAD == expected_overhead);
2154
2155   if (GNUNET_OK !=
2156       GNUNET_CONFIGURATION_get_value_number (c, "CADET", "DEFAULT_TTL",
2157                                              &default_ttl))
2158   {
2159     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
2160                                "CADET", "DEFAULT_TTL", "USING DEFAULT");
2161     default_ttl = 64;
2162   }
2163   if (GNUNET_OK !=
2164       GNUNET_CONFIGURATION_get_value_time (c, "CADET", "REKEY_PERIOD",
2165                                            &rekey_period))
2166   {
2167     rekey_period = GNUNET_TIME_UNIT_DAYS;
2168   }
2169
2170   my_private_key = key;
2171   kx_msg.header.size = htons (sizeof (kx_msg));
2172   kx_msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL);
2173   kx_msg.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_CADET_KX);
2174   kx_msg.purpose.size = htonl (ephemeral_purpose_size ());
2175   kx_msg.origin_identity = my_full_id;
2176   rekey_task = GNUNET_SCHEDULER_add_now (&rekey, NULL);
2177
2178   tunnels = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
2179 }
2180
2181
2182 /**
2183  * Shut down the tunnel subsystem.
2184  */
2185 void
2186 GCT_shutdown (void)
2187 {
2188   if (GNUNET_SCHEDULER_NO_TASK != rekey_task)
2189   {
2190     GNUNET_SCHEDULER_cancel (rekey_task);
2191     rekey_task = GNUNET_SCHEDULER_NO_TASK;
2192   }
2193   GNUNET_CONTAINER_multipeermap_iterate (tunnels, &destroy_iterator, NULL);
2194   GNUNET_CONTAINER_multipeermap_destroy (tunnels);
2195 }
2196
2197
2198 /**
2199  * Create a tunnel.
2200  *
2201  * @param destination Peer this tunnel is towards.
2202  */
2203 struct CadetTunnel *
2204 GCT_new (struct CadetPeer *destination)
2205 {
2206   struct CadetTunnel *t;
2207
2208   t = GNUNET_new (struct CadetTunnel);
2209   t->next_chid = 0;
2210   t->peer = destination;
2211
2212   if (GNUNET_OK !=
2213       GNUNET_CONTAINER_multipeermap_put (tunnels, GCP_get_id (destination), t,
2214                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
2215   {
2216     GNUNET_break (0);
2217     GNUNET_free (t);
2218     return NULL;
2219   }
2220   return t;
2221 }
2222
2223
2224 /**
2225  * Change the tunnel's connection state.
2226  *
2227  * @param t Tunnel whose connection state to change.
2228  * @param cstate New connection state.
2229  */
2230 void
2231 GCT_change_cstate (struct CadetTunnel* t, enum CadetTunnelCState cstate)
2232 {
2233   if (NULL == t)
2234     return;
2235   LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s cstate %s => %s\n",
2236        GCP_2s (t->peer), cstate2s (t->cstate), cstate2s (cstate));
2237   if (myid != GCP_get_short_id (t->peer) &&
2238       CADET_TUNNEL_READY != t->cstate &&
2239       CADET_TUNNEL_READY == cstate)
2240   {
2241     t->cstate = cstate;
2242     if (CADET_TUNNEL_KEY_OK == t->estate)
2243     {
2244       LOG (GNUNET_ERROR_TYPE_DEBUG, "  cstate triggered send queued data\n");
2245       send_queued_data (t);
2246     }
2247     else if (CADET_TUNNEL_KEY_UNINITIALIZED == t->estate)
2248     {
2249       LOG (GNUNET_ERROR_TYPE_DEBUG, "  cstate triggered rekey\n");
2250       if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
2251         GNUNET_SCHEDULER_cancel (t->rekey_task);
2252       rekey_tunnel (t, NULL);
2253     }
2254   }
2255   t->cstate = cstate;
2256
2257   if (CADET_TUNNEL_READY == cstate
2258       && CONNECTIONS_PER_TUNNEL <= GCT_count_connections (t))
2259   {
2260     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cstate triggered stop dht\n");
2261     GCP_stop_search (t->peer);
2262   }
2263 }
2264
2265 /**
2266  * Change the tunnel encryption state.
2267  *
2268  * @param t Tunnel whose encryption state to change.
2269  * @param state New encryption state.
2270  */
2271 void
2272 GCT_change_estate (struct CadetTunnel* t, enum CadetTunnelEState state)
2273 {
2274   if (NULL == t)
2275     return;
2276   LOG (GNUNET_ERROR_TYPE_DEBUG,
2277        "Tunnel %s estate was %s\n",
2278        GCP_2s (t->peer), estate2s (t->estate));
2279   LOG (GNUNET_ERROR_TYPE_DEBUG,
2280        "Tunnel %s estate is now %s\n",
2281        GCP_2s (t->peer), estate2s (state));
2282   if (myid != GCP_get_short_id (t->peer) &&
2283       CADET_TUNNEL_KEY_OK != t->estate && CADET_TUNNEL_KEY_OK == state)
2284   {
2285     t->estate = state;
2286     send_queued_data (t);
2287     return;
2288   }
2289   t->estate = state;
2290 }
2291
2292
2293 /**
2294  * @brief Check if tunnel has too many connections, and remove one if necessary.
2295  *
2296  * Currently this means the newest connection, unless it is a direct one.
2297  * Implemented as a task to avoid freeing a connection that is in the middle
2298  * of being created/processed.
2299  *
2300  * @param cls Closure (Tunnel to check).
2301  * @param tc Task context.
2302  */
2303 static void
2304 trim_connections (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
2305 {
2306   struct CadetTunnel *t = cls;
2307
2308   t->trim_connections_task = GNUNET_SCHEDULER_NO_TASK;
2309
2310   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
2311     return;
2312
2313   if (GCT_count_connections (t) > 2 * CONNECTIONS_PER_TUNNEL)
2314   {
2315     struct CadetTConnection *iter;
2316     struct CadetTConnection *c;
2317
2318     for (c = iter = t->connection_head; NULL != iter; iter = iter->next)
2319     {
2320       if ((NULL == c || iter->created.abs_value_us > c->created.abs_value_us)
2321           && GNUNET_NO == GCC_is_direct (iter->c))
2322       {
2323         c = iter;
2324       }
2325     }
2326     if (NULL != c)
2327     {
2328       LOG (GNUNET_ERROR_TYPE_DEBUG, "Too many connections on tunnel %s\n",
2329            GCT_2s (t));
2330       LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying connection %s\n",
2331            GCC_2s (c->c));
2332       GCC_destroy (c->c);
2333     }
2334     else
2335     {
2336       GNUNET_break (0);
2337     }
2338   }
2339 }
2340
2341
2342 /**
2343  * Add a connection to a tunnel.
2344  *
2345  * @param t Tunnel.
2346  * @param c Connection.
2347  */
2348 void
2349 GCT_add_connection (struct CadetTunnel *t, struct CadetConnection *c)
2350 {
2351   struct CadetTConnection *aux;
2352
2353   GNUNET_assert (NULL != c);
2354
2355   LOG (GNUNET_ERROR_TYPE_DEBUG, "add connection %s\n", GCC_2s (c));
2356   LOG (GNUNET_ERROR_TYPE_DEBUG, " to tunnel %s\n", GCT_2s (t));
2357   for (aux = t->connection_head; aux != NULL; aux = aux->next)
2358     if (aux->c == c)
2359       return;
2360
2361   aux = GNUNET_new (struct CadetTConnection);
2362   aux->c = c;
2363   aux->created = GNUNET_TIME_absolute_get ();
2364
2365   GNUNET_CONTAINER_DLL_insert (t->connection_head, t->connection_tail, aux);
2366
2367   if (CADET_TUNNEL_SEARCHING == t->cstate)
2368     GCT_change_estate (t, CADET_TUNNEL_WAITING);
2369
2370   if (GNUNET_SCHEDULER_NO_TASK != t->trim_connections_task)
2371     t->trim_connections_task = GNUNET_SCHEDULER_add_now (&trim_connections, t);
2372 }
2373
2374
2375 /**
2376  * Remove a connection from a tunnel.
2377  *
2378  * @param t Tunnel.
2379  * @param c Connection.
2380  */
2381 void
2382 GCT_remove_connection (struct CadetTunnel *t,
2383                        struct CadetConnection *c)
2384 {
2385   struct CadetTConnection *aux;
2386   struct CadetTConnection *next;
2387   unsigned int conns;
2388
2389   LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing connection %s from tunnel %s\n",
2390        GCC_2s (c), GCT_2s (t));
2391   for (aux = t->connection_head; aux != NULL; aux = next)
2392   {
2393     next = aux->next;
2394     if (aux->c == c)
2395     {
2396       GNUNET_CONTAINER_DLL_remove (t->connection_head, t->connection_tail, aux);
2397       GNUNET_free (aux);
2398     }
2399   }
2400
2401   conns = GCT_count_connections (t);
2402   if (0 == conns
2403       && GNUNET_SCHEDULER_NO_TASK == t->destroy_task
2404       && CADET_TUNNEL_SHUTDOWN != t->cstate
2405       && GNUNET_NO == shutting_down)
2406   {
2407     if (0 == GCT_count_any_connections (t))
2408       GCT_change_cstate (t, CADET_TUNNEL_SEARCHING);
2409     else
2410       GCT_change_cstate (t, CADET_TUNNEL_WAITING);
2411   }
2412
2413   /* Start new connections if needed */
2414   if (CONNECTIONS_PER_TUNNEL > conns
2415       && GNUNET_SCHEDULER_NO_TASK == t->destroy_task
2416       && CADET_TUNNEL_SHUTDOWN != t->cstate
2417       && GNUNET_NO == shutting_down)
2418   {
2419     LOG (GNUNET_ERROR_TYPE_DEBUG, "  too few connections, getting new ones\n");
2420     GCP_connect (t->peer); /* Will change cstate to WAITING when possible */
2421     return;
2422   }
2423
2424   /* If not marked as ready, no change is needed */
2425   if (CADET_TUNNEL_READY != t->cstate)
2426     return;
2427
2428   /* Check if any connection is ready to maintain cstate */
2429   for (aux = t->connection_head; aux != NULL; aux = aux->next)
2430     if (CADET_CONNECTION_READY == GCC_get_state (aux->c))
2431       return;
2432 }
2433
2434
2435 /**
2436  * Add a channel to a tunnel.
2437  *
2438  * @param t Tunnel.
2439  * @param ch Channel.
2440  */
2441 void
2442 GCT_add_channel (struct CadetTunnel *t, struct CadetChannel *ch)
2443 {
2444   struct CadetTChannel *aux;
2445
2446   GNUNET_assert (NULL != ch);
2447
2448   LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding channel %p to tunnel %p\n", ch, t);
2449
2450   for (aux = t->channel_head; aux != NULL; aux = aux->next)
2451   {
2452     LOG (GNUNET_ERROR_TYPE_DEBUG, "  already there %p\n", aux->ch);
2453     if (aux->ch == ch)
2454       return;
2455   }
2456
2457   aux = GNUNET_new (struct CadetTChannel);
2458   aux->ch = ch;
2459   LOG (GNUNET_ERROR_TYPE_DEBUG, " adding %p to %p\n", aux, t->channel_head);
2460   GNUNET_CONTAINER_DLL_insert_tail (t->channel_head, t->channel_tail, aux);
2461
2462   if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
2463   {
2464     GNUNET_SCHEDULER_cancel (t->destroy_task);
2465     t->destroy_task = GNUNET_SCHEDULER_NO_TASK;
2466     LOG (GNUNET_ERROR_TYPE_DEBUG, " undo destroy!\n");
2467   }
2468 }
2469
2470
2471 /**
2472  * Remove a channel from a tunnel.
2473  *
2474  * @param t Tunnel.
2475  * @param ch Channel.
2476  */
2477 void
2478 GCT_remove_channel (struct CadetTunnel *t, struct CadetChannel *ch)
2479 {
2480   struct CadetTChannel *aux;
2481
2482   LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing channel %p from tunnel %p\n", ch, t);
2483   for (aux = t->channel_head; aux != NULL; aux = aux->next)
2484   {
2485     if (aux->ch == ch)
2486     {
2487       LOG (GNUNET_ERROR_TYPE_DEBUG, " found! %s\n", GCCH_2s (ch));
2488       GNUNET_CONTAINER_DLL_remove (t->channel_head, t->channel_tail, aux);
2489       GNUNET_free (aux);
2490       return;
2491     }
2492   }
2493 }
2494
2495
2496 /**
2497  * Search for a channel by global ID.
2498  *
2499  * @param t Tunnel containing the channel.
2500  * @param chid Public channel number.
2501  *
2502  * @return channel handler, NULL if doesn't exist
2503  */
2504 struct CadetChannel *
2505 GCT_get_channel (struct CadetTunnel *t, CADET_ChannelNumber chid)
2506 {
2507   struct CadetTChannel *iter;
2508
2509   if (NULL == t)
2510     return NULL;
2511
2512   for (iter = t->channel_head; NULL != iter; iter = iter->next)
2513   {
2514     if (GCCH_get_id (iter->ch) == chid)
2515       break;
2516   }
2517
2518   return NULL == iter ? NULL : iter->ch;
2519 }
2520
2521
2522 /**
2523  * @brief Destroy a tunnel and free all resources.
2524  *
2525  * Should only be called a while after the tunnel has been marked as destroyed,
2526  * in case there is a new channel added to the same peer shortly after marking
2527  * the tunnel. This way we avoid a new public key handshake.
2528  *
2529  * @param cls Closure (tunnel to destroy).
2530  * @param tc Task context.
2531  */
2532 static void
2533 delayed_destroy (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
2534 {
2535   struct CadetTunnel *t = cls;
2536   struct CadetTConnection *iter;
2537
2538   LOG (GNUNET_ERROR_TYPE_DEBUG, "delayed destroying tunnel %p\n", t);
2539   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
2540   {
2541     LOG (GNUNET_ERROR_TYPE_WARNING,
2542          "Not destroying tunnel, due to shutdown. "
2543          "Tunnel at %p should have been freed by GCT_shutdown\n", t);
2544     return;
2545   }
2546   t->destroy_task = GNUNET_SCHEDULER_NO_TASK;
2547   t->cstate = CADET_TUNNEL_SHUTDOWN;
2548
2549   for (iter = t->connection_head; NULL != iter; iter = iter->next)
2550   {
2551     GCC_send_destroy (iter->c);
2552   }
2553   GCT_destroy (t);
2554 }
2555
2556
2557 /**
2558  * Tunnel is empty: destroy it.
2559  *
2560  * Notifies all connections about the destruction.
2561  *
2562  * @param t Tunnel to destroy.
2563  */
2564 void
2565 GCT_destroy_empty (struct CadetTunnel *t)
2566 {
2567   if (GNUNET_YES == shutting_down)
2568     return; /* Will be destroyed immediately anyway */
2569
2570   if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
2571   {
2572     LOG (GNUNET_ERROR_TYPE_WARNING,
2573          "Tunnel %s is already scheduled for destruction. Tunnel debug dump:\n",
2574          GCT_2s (t));
2575     GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
2576     GNUNET_break (0);
2577     /* should never happen, tunnel can only become empty once, and the
2578      * task identifier should be NO_TASK (cleaned when the tunnel was created
2579      * or became un-empty)
2580      */
2581     return;
2582   }
2583
2584   LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s empty: destroying scheduled\n",
2585        GCT_2s (t));
2586
2587   // FIXME make delay a config option
2588   t->destroy_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
2589                                                   &delayed_destroy, t);
2590   LOG (GNUNET_ERROR_TYPE_DEBUG, "Scheduled destroy of %p as %llX\n",
2591        t, t->destroy_task);
2592 }
2593
2594
2595 /**
2596  * Destroy tunnel if empty (no more channels).
2597  *
2598  * @param t Tunnel to destroy if empty.
2599  */
2600 void
2601 GCT_destroy_if_empty (struct CadetTunnel *t)
2602 {
2603   LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s destroy if empty\n", GCT_2s (t));
2604   if (1 < GCT_count_channels (t))
2605     return;
2606
2607   GCT_destroy_empty (t);
2608 }
2609
2610
2611 /**
2612  * Destroy the tunnel.
2613  *
2614  * This function does not generate any warning traffic to clients or peers.
2615  *
2616  * Tasks:
2617  * Cancel messages belonging to this tunnel queued to neighbors.
2618  * Free any allocated resources linked to the tunnel.
2619  *
2620  * @param t The tunnel to destroy.
2621  */
2622 void
2623 GCT_destroy (struct CadetTunnel *t)
2624 {
2625   struct CadetTConnection *iter_c;
2626   struct CadetTConnection *next_c;
2627   struct CadetTChannel *iter_ch;
2628   struct CadetTChannel *next_ch;
2629
2630   if (NULL == t)
2631     return;
2632
2633   LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying tunnel %s\n", GCP_2s (t->peer));
2634
2635   GNUNET_break (GNUNET_YES ==
2636                 GNUNET_CONTAINER_multipeermap_remove (tunnels,
2637                                                       GCP_get_id (t->peer), t));
2638
2639   for (iter_c = t->connection_head; NULL != iter_c; iter_c = next_c)
2640   {
2641     next_c = iter_c->next;
2642     GCC_destroy (iter_c->c);
2643   }
2644   for (iter_ch = t->channel_head; NULL != iter_ch; iter_ch = next_ch)
2645   {
2646     next_ch = iter_ch->next;
2647     GCCH_destroy (iter_ch->ch);
2648     /* Should only happen on shutdown, but it's ok. */
2649   }
2650
2651   if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
2652   {
2653     LOG (GNUNET_ERROR_TYPE_DEBUG, "cancelling dest: %llX\n", t->destroy_task);
2654     GNUNET_SCHEDULER_cancel (t->destroy_task);
2655     t->destroy_task = GNUNET_SCHEDULER_NO_TASK;
2656   }
2657
2658   if (GNUNET_SCHEDULER_NO_TASK != t->trim_connections_task)
2659   {
2660     LOG (GNUNET_ERROR_TYPE_DEBUG, "cancelling trim: %llX\n",
2661          t->trim_connections_task);
2662     GNUNET_SCHEDULER_cancel (t->trim_connections_task);
2663     t->trim_connections_task = GNUNET_SCHEDULER_NO_TASK;
2664   }
2665
2666   GNUNET_STATISTICS_update (stats, "# tunnels", -1, GNUNET_NO);
2667   GCP_set_tunnel (t->peer, NULL);
2668
2669   if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
2670   {
2671     GNUNET_SCHEDULER_cancel (t->rekey_task);
2672     t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
2673   }
2674   if (NULL != t->kx_ctx)
2675   {
2676     if (GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
2677       GNUNET_SCHEDULER_cancel (t->kx_ctx->finish_task);
2678     GNUNET_free (t->kx_ctx);
2679   }
2680   GNUNET_free (t);
2681 }
2682
2683
2684 /**
2685  * @brief Use the given path for the tunnel.
2686  * Update the next and prev hops (and RCs).
2687  * (Re)start the path refresh in case the tunnel is locally owned.
2688  *
2689  * @param t Tunnel to update.
2690  * @param p Path to use.
2691  *
2692  * @return Connection created.
2693  */
2694 struct CadetConnection *
2695 GCT_use_path (struct CadetTunnel *t, struct CadetPeerPath *p)
2696 {
2697   struct CadetConnection *c;
2698   struct GNUNET_CADET_Hash cid;
2699   unsigned int own_pos;
2700
2701   if (NULL == t || NULL == p)
2702   {
2703     GNUNET_break (0);
2704     return NULL;
2705   }
2706
2707   if (CADET_TUNNEL_SHUTDOWN == t->cstate)
2708   {
2709     GNUNET_break (0);
2710     return NULL;
2711   }
2712
2713   for (own_pos = 0; own_pos < p->length; own_pos++)
2714   {
2715     if (p->peers[own_pos] == myid)
2716       break;
2717   }
2718   if (own_pos >= p->length)
2719   {
2720     GNUNET_break_op (0);
2721     return NULL;
2722   }
2723
2724   GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_NONCE, &cid, sizeof (cid));
2725   c = GCC_new (&cid, t, p, own_pos);
2726   if (NULL == c)
2727   {
2728     /* Path was flawed */
2729     return NULL;
2730   }
2731   GCT_add_connection (t, c);
2732   return c;
2733 }
2734
2735
2736 /**
2737  * Count all created connections of a tunnel. Not necessarily ready connections!
2738  *
2739  * @param t Tunnel on which to count.
2740  *
2741  * @return Number of connections created, either being established or ready.
2742  */
2743 unsigned int
2744 GCT_count_any_connections (struct CadetTunnel *t)
2745 {
2746   struct CadetTConnection *iter;
2747   unsigned int count;
2748
2749   if (NULL == t)
2750     return 0;
2751
2752   for (count = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
2753     count++;
2754
2755   return count;
2756 }
2757
2758
2759 /**
2760  * Count established (ready) connections of a tunnel.
2761  *
2762  * @param t Tunnel on which to count.
2763  *
2764  * @return Number of connections.
2765  */
2766 unsigned int
2767 GCT_count_connections (struct CadetTunnel *t)
2768 {
2769   struct CadetTConnection *iter;
2770   unsigned int count;
2771
2772   if (NULL == t)
2773     return 0;
2774
2775   for (count = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
2776     if (CADET_CONNECTION_DESTROYED != GCC_get_state (iter->c))
2777       count++;
2778
2779   return count;
2780 }
2781
2782
2783 /**
2784  * Count channels of a tunnel.
2785  *
2786  * @param t Tunnel on which to count.
2787  *
2788  * @return Number of channels.
2789  */
2790 unsigned int
2791 GCT_count_channels (struct CadetTunnel *t)
2792 {
2793   struct CadetTChannel *iter;
2794   unsigned int count;
2795
2796   for (count = 0, iter = t->channel_head;
2797        NULL != iter;
2798        iter = iter->next, count++) /* skip */;
2799
2800   return count;
2801 }
2802
2803
2804 /**
2805  * Get the connectivity state of a tunnel.
2806  *
2807  * @param t Tunnel.
2808  *
2809  * @return Tunnel's connectivity state.
2810  */
2811 enum CadetTunnelCState
2812 GCT_get_cstate (struct CadetTunnel *t)
2813 {
2814   if (NULL == t)
2815   {
2816     GNUNET_assert (0);
2817     return (enum CadetTunnelCState) -1;
2818   }
2819   return t->cstate;
2820 }
2821
2822
2823 /**
2824  * Get the encryption state of a tunnel.
2825  *
2826  * @param t Tunnel.
2827  *
2828  * @return Tunnel's encryption state.
2829  */
2830 enum CadetTunnelEState
2831 GCT_get_estate (struct CadetTunnel *t)
2832 {
2833   if (NULL == t)
2834   {
2835     GNUNET_assert (0);
2836     return (enum CadetTunnelEState) -1;
2837   }
2838   return t->estate;
2839 }
2840
2841 /**
2842  * Get the maximum buffer space for a tunnel towards a local client.
2843  *
2844  * @param t Tunnel.
2845  *
2846  * @return Biggest buffer space offered by any channel in the tunnel.
2847  */
2848 unsigned int
2849 GCT_get_channels_buffer (struct CadetTunnel *t)
2850 {
2851   struct CadetTChannel *iter;
2852   unsigned int buffer;
2853   unsigned int ch_buf;
2854
2855   if (NULL == t->channel_head)
2856   {
2857     /* Probably getting buffer for a channel create/handshake. */
2858     return 64;
2859   }
2860
2861   buffer = 0;
2862   for (iter = t->channel_head; NULL != iter; iter = iter->next)
2863   {
2864     ch_buf = get_channel_buffer (iter);
2865     if (ch_buf > buffer)
2866       buffer = ch_buf;
2867   }
2868   return buffer;
2869 }
2870
2871
2872 /**
2873  * Get the total buffer space for a tunnel for P2P traffic.
2874  *
2875  * @param t Tunnel.
2876  *
2877  * @return Buffer space offered by all connections in the tunnel.
2878  */
2879 unsigned int
2880 GCT_get_connections_buffer (struct CadetTunnel *t)
2881 {
2882   struct CadetTConnection *iter;
2883   unsigned int buffer;
2884
2885   if (GNUNET_NO == is_ready (t))
2886   {
2887     if (count_queued_data (t) > 3)
2888       return 0;
2889     else
2890       return 1;
2891   }
2892
2893   buffer = 0;
2894   for (iter = t->connection_head; NULL != iter; iter = iter->next)
2895   {
2896     if (GCC_get_state (iter->c) != CADET_CONNECTION_READY)
2897     {
2898       continue;
2899     }
2900     buffer += get_connection_buffer (iter);
2901   }
2902
2903   return buffer;
2904 }
2905
2906
2907 /**
2908  * Get the tunnel's destination.
2909  *
2910  * @param t Tunnel.
2911  *
2912  * @return ID of the destination peer.
2913  */
2914 const struct GNUNET_PeerIdentity *
2915 GCT_get_destination (struct CadetTunnel *t)
2916 {
2917   return GCP_get_id (t->peer);
2918 }
2919
2920
2921 /**
2922  * Get the tunnel's next free global channel ID.
2923  *
2924  * @param t Tunnel.
2925  *
2926  * @return GID of a channel free to use.
2927  */
2928 CADET_ChannelNumber
2929 GCT_get_next_chid (struct CadetTunnel *t)
2930 {
2931   CADET_ChannelNumber chid;
2932   CADET_ChannelNumber mask;
2933   int result;
2934
2935   /* Set bit 30 depending on the ID relationship. Bit 31 is always 0 for GID.
2936    * If our ID is bigger or loopback tunnel, start at 0, bit 30 = 0
2937    * If peer's ID is bigger, start at 0x4... bit 30 = 1
2938    */
2939   result = GNUNET_CRYPTO_cmp_peer_identity (&my_full_id, GCP_get_id (t->peer));
2940   if (0 > result)
2941     mask = 0x40000000;
2942   else
2943     mask = 0x0;
2944   t->next_chid |= mask;
2945
2946   while (NULL != GCT_get_channel (t, t->next_chid))
2947   {
2948     LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists...\n", t->next_chid);
2949     t->next_chid = (t->next_chid + 1) & ~GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
2950     t->next_chid |= mask;
2951   }
2952   chid = t->next_chid;
2953   t->next_chid = (t->next_chid + 1) & ~GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
2954   t->next_chid |= mask;
2955
2956   return chid;
2957 }
2958
2959
2960 /**
2961  * Send ACK on one or more channels due to buffer in connections.
2962  *
2963  * @param t Channel which has some free buffer space.
2964  */
2965 void
2966 GCT_unchoke_channels (struct CadetTunnel *t)
2967 {
2968   struct CadetTChannel *iter;
2969   unsigned int buffer;
2970   unsigned int channels = GCT_count_channels (t);
2971   unsigned int choked_n;
2972   struct CadetChannel *choked[channels];
2973
2974   LOG (GNUNET_ERROR_TYPE_DEBUG, "GCT_unchoke_channels on %s\n", GCT_2s (t));
2975   LOG (GNUNET_ERROR_TYPE_DEBUG, " head: %p\n", t->channel_head);
2976   if (NULL != t->channel_head)
2977     LOG (GNUNET_ERROR_TYPE_DEBUG, " head ch: %p\n", t->channel_head->ch);
2978
2979   /* Get buffer space */
2980   buffer = GCT_get_connections_buffer (t);
2981   if (0 == buffer)
2982   {
2983     return;
2984   }
2985
2986   /* Count and remember choked channels */
2987   choked_n = 0;
2988   for (iter = t->channel_head; NULL != iter; iter = iter->next)
2989   {
2990     if (GNUNET_NO == get_channel_allowed (iter))
2991     {
2992       choked[choked_n++] = iter->ch;
2993     }
2994   }
2995
2996   /* Unchoke random channels */
2997   while (0 < buffer && 0 < choked_n)
2998   {
2999     unsigned int r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
3000                                                choked_n);
3001     GCCH_allow_client (choked[r], GCCH_is_origin (choked[r], GNUNET_YES));
3002     choked_n--;
3003     buffer--;
3004     choked[r] = choked[choked_n];
3005   }
3006 }
3007
3008
3009 /**
3010  * Send ACK on one or more connections due to buffer space to the client.
3011  *
3012  * Iterates all connections of the tunnel and sends ACKs appropriately.
3013  *
3014  * @param t Tunnel.
3015  */
3016 void
3017 GCT_send_connection_acks (struct CadetTunnel *t)
3018 {
3019   struct CadetTConnection *iter;
3020   uint32_t allowed;
3021   uint32_t to_allow;
3022   uint32_t allow_per_connection;
3023   unsigned int cs;
3024   unsigned int buffer;
3025
3026   LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel send connection ACKs on %s\n",
3027        GCT_2s (t));
3028
3029   if (NULL == t)
3030   {
3031     GNUNET_break (0);
3032     return;
3033   }
3034
3035   buffer = GCT_get_channels_buffer (t);
3036   LOG (GNUNET_ERROR_TYPE_DEBUG, "  buffer %u\n", buffer);
3037
3038   /* Count connections, how many messages are already allowed */
3039   cs = GCT_count_connections (t);
3040   for (allowed = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
3041   {
3042     allowed += get_connection_allowed (iter);
3043   }
3044   LOG (GNUNET_ERROR_TYPE_DEBUG, "  allowed %u\n", allowed);
3045
3046   /* Make sure there is no overflow */
3047   if (allowed > buffer)
3048   {
3049     return;
3050   }
3051
3052   /* Authorize connections to send more data */
3053   to_allow = buffer; /* - allowed; */
3054
3055   for (iter = t->connection_head;
3056        NULL != iter && to_allow > 0;
3057        iter = iter->next)
3058   {
3059     allow_per_connection = to_allow/cs;
3060     to_allow -= allow_per_connection;
3061     cs--;
3062     if (get_connection_allowed (iter) > 64 / 3)
3063     {
3064       continue;
3065     }
3066     GCC_allow (iter->c, allow_per_connection,
3067                GCC_is_origin (iter->c, GNUNET_NO));
3068   }
3069
3070   GNUNET_break (to_allow == 0); //FIXME tripped
3071 }
3072
3073
3074 /**
3075  * Cancel a previously sent message while it's in the queue.
3076  *
3077  * ONLY can be called before the continuation given to the send function
3078  * is called. Once the continuation is called, the message is no longer in the
3079  * queue.
3080  *
3081  * @param q Handle to the queue.
3082  */
3083 void
3084 GCT_cancel (struct CadetTunnelQueue *q)
3085 {
3086   if (NULL != q->cq)
3087   {
3088     GCC_cancel (q->cq);
3089     /* tun_message_sent() will be called and free q */
3090   }
3091   else if (NULL != q->tqd)
3092   {
3093     unqueue_data (q->tqd);
3094     q->tqd = NULL;
3095     if (NULL != q->cont)
3096       q->cont (q->cont_cls, NULL, q, 0, 0);
3097     GNUNET_free (q);
3098   }
3099   else
3100   {
3101     GNUNET_break (0);
3102   }
3103 }
3104
3105
3106 /**
3107  * Sends an already built message on a tunnel, encrypting it and
3108  * choosing the best connection if not provided.
3109  *
3110  * @param message Message to send. Function modifies it.
3111  * @param t Tunnel on which this message is transmitted.
3112  * @param c Connection to use (autoselect if NULL).
3113  * @param force Force the tunnel to take the message (buffer overfill).
3114  * @param cont Continuation to call once message is really sent.
3115  * @param cont_cls Closure for @c cont.
3116  *
3117  * @return Handle to cancel message. NULL if @c cont is NULL.
3118  */
3119 struct CadetTunnelQueue *
3120 GCT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
3121                            struct CadetTunnel *t, struct CadetConnection *c,
3122                            int force, GCT_sent cont, void *cont_cls)
3123 {
3124   return send_prebuilt_message (message, t, c, force, cont, cont_cls, NULL);
3125 }
3126
3127 /**
3128  * Sends an already built and encrypted message on a tunnel, choosing the best
3129  * connection. Useful for re-queueing messages queued on a destroyed connection.
3130  *
3131  * @param message Message to send. Function modifies it.
3132  * @param t Tunnel on which this message is transmitted.
3133  */
3134 void
3135 GCT_resend_message (const struct GNUNET_MessageHeader *message,
3136                     struct CadetTunnel *t)
3137 {
3138   struct CadetConnection *c;
3139   int fwd;
3140
3141   c = tunnel_get_connection (t);
3142   if (NULL == c)
3143   {
3144     /* TODO queue in tunnel, marked as encrypted */
3145     LOG (GNUNET_ERROR_TYPE_DEBUG, "No connection available, dropping.\n");
3146     return;
3147   }
3148   fwd = GCC_is_origin (c, GNUNET_YES);
3149   GNUNET_break (NULL == GCC_send_prebuilt_message (message, 0, 0, c, fwd,
3150                                                    GNUNET_YES, NULL, NULL));
3151 }
3152
3153
3154 /**
3155  * Is the tunnel directed towards the local peer?
3156  *
3157  * @param t Tunnel.
3158  *
3159  * @return #GNUNET_YES if it is loopback.
3160  */
3161 int
3162 GCT_is_loopback (const struct CadetTunnel *t)
3163 {
3164   return (myid == GCP_get_short_id (t->peer));
3165 }
3166
3167
3168 /**
3169  * Is the tunnel this path already?
3170  *
3171  * @param t Tunnel.
3172  * @param p Path.
3173  *
3174  * @return #GNUNET_YES a connection uses this path.
3175  */
3176 int
3177 GCT_is_path_used (const struct CadetTunnel *t, const struct CadetPeerPath *p)
3178 {
3179   struct CadetTConnection *iter;
3180
3181   for (iter = t->connection_head; NULL != iter; iter = iter->next)
3182     if (GCC_get_path (iter->c) == p)
3183       return GNUNET_YES;
3184
3185   return GNUNET_NO;
3186 }
3187
3188
3189 /**
3190  * Get a cost of a path for a tunnel considering existing connections.
3191  *
3192  * @param t Tunnel.
3193  * @param path Candidate path.
3194  *
3195  * @return Cost of the path (path length + number of overlapping nodes)
3196  */
3197 unsigned int
3198 GCT_get_path_cost (const struct CadetTunnel *t,
3199                    const struct CadetPeerPath *path)
3200 {
3201   struct CadetTConnection *iter;
3202   const struct CadetPeerPath *aux;
3203   unsigned int overlap;
3204   unsigned int i;
3205   unsigned int j;
3206
3207   if (NULL == path)
3208     return 0;
3209
3210   overlap = 0;
3211   GNUNET_assert (NULL != t);
3212
3213   for (i = 0; i < path->length; i++)
3214   {
3215     for (iter = t->connection_head; NULL != iter; iter = iter->next)
3216     {
3217       aux = GCC_get_path (iter->c);
3218       if (NULL == aux)
3219         continue;
3220
3221       for (j = 0; j < aux->length; j++)
3222       {
3223         if (path->peers[i] == aux->peers[j])
3224         {
3225           overlap++;
3226           break;
3227         }
3228       }
3229     }
3230   }
3231   return path->length + overlap;
3232 }
3233
3234
3235 /**
3236  * Get the static string for the peer this tunnel is directed.
3237  *
3238  * @param t Tunnel.
3239  *
3240  * @return Static string the destination peer's ID.
3241  */
3242 const char *
3243 GCT_2s (const struct CadetTunnel *t)
3244 {
3245   if (NULL == t)
3246     return "(NULL)";
3247
3248   return GCP_2s (t->peer);
3249 }
3250
3251
3252 /******************************************************************************/
3253 /*****************************    INFO/DEBUG    *******************************/
3254 /******************************************************************************/
3255
3256 /**
3257  * Log all possible info about the tunnel state.
3258  *
3259  * @param t Tunnel to debug.
3260  * @param level Debug level to use.
3261  */
3262 void
3263 GCT_debug (const struct CadetTunnel *t, enum GNUNET_ErrorType level)
3264 {
3265   struct CadetTChannel *iterch;
3266   struct CadetTConnection *iterc;
3267   int do_log;
3268
3269   do_log = GNUNET_get_log_call_status (level & (~GNUNET_ERROR_TYPE_BULK),
3270                                        "cadet-tun",
3271                                        __FILE__, __FUNCTION__, __LINE__);
3272   if (0 == do_log)
3273     return;
3274
3275   LOG2 (level, "TTT DEBUG TUNNEL TOWARDS %s\n", GCT_2s (t));
3276   LOG2 (level, "TTT  cstate %s, estate %s\n",
3277        cstate2s (t->cstate), estate2s (t->estate));
3278   LOG2 (level, "TTT  kx_ctx %p, rekey_task %u, finish task %u\n",
3279         t->kx_ctx, t->rekey_task, t->kx_ctx ? t->kx_ctx->finish_task : 0);
3280 #if DUMP_KEYS_TO_STDERR
3281   LOG2 (level, "TTT  my EPHM\t %s\n",
3282         GNUNET_h2s ((struct GNUNET_HashCode *) &kx_msg.ephemeral_key));
3283   LOG2 (level, "TTT  peers EPHM:\t %s\n",
3284         GNUNET_h2s ((struct GNUNET_HashCode *) &t->peers_ephemeral_key));
3285   LOG2 (level, "TTT  ENC key:\t %s\n",
3286         GNUNET_h2s ((struct GNUNET_HashCode *) &t->e_key));
3287   LOG2 (level, "TTT  DEC key:\t %s\n",
3288         GNUNET_h2s ((struct GNUNET_HashCode *) &t->d_key));
3289   if (t->kx_ctx)
3290   {
3291     LOG2 (level, "TTT  OLD ENC key:\t %s\n",
3292           GNUNET_h2s ((struct GNUNET_HashCode *) &t->kx_ctx->e_key_old));
3293     LOG2 (level, "TTT  OLD DEC key:\t %s\n",
3294           GNUNET_h2s ((struct GNUNET_HashCode *) &t->kx_ctx->d_key_old));
3295   }
3296 #endif
3297   LOG2 (level, "TTT  tq_head %p, tq_tail %p\n", t->tq_head, t->tq_tail);
3298   LOG2 (level, "TTT  destroy %u\n", t->destroy_task);
3299
3300   LOG2 (level, "TTT  channels:\n");
3301   for (iterch = t->channel_head; NULL != iterch; iterch = iterch->next)
3302   {
3303     LOG2 (level, "TTT  - %s\n", GCCH_2s (iterch->ch));
3304   }
3305
3306   LOG2 (level, "TTT  connections:\n");
3307   for (iterc = t->connection_head; NULL != iterc; iterc = iterc->next)
3308   {
3309     GCC_debug (iterc->c, level);
3310   }
3311
3312   LOG2 (level, "TTT DEBUG TUNNEL END\n");
3313 }
3314
3315
3316 /**
3317  * Iterate all tunnels.
3318  *
3319  * @param iter Iterator.
3320  * @param cls Closure for @c iter.
3321  */
3322 void
3323 GCT_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls)
3324 {
3325   GNUNET_CONTAINER_multipeermap_iterate (tunnels, iter, cls);
3326 }
3327
3328
3329 /**
3330  * Count all tunnels.
3331  *
3332  * @return Number of tunnels to remote peers kept by this peer.
3333  */
3334 unsigned int
3335 GCT_count_all (void)
3336 {
3337   return GNUNET_CONTAINER_multipeermap_size (tunnels);
3338 }
3339
3340
3341 /**
3342  * Iterate all connections of a tunnel.
3343  *
3344  * @param t Tunnel whose connections to iterate.
3345  * @param iter Iterator.
3346  * @param cls Closure for @c iter.
3347  */
3348 void
3349 GCT_iterate_connections (struct CadetTunnel *t, GCT_conn_iter iter, void *cls)
3350 {
3351   struct CadetTConnection *ct;
3352
3353   for (ct = t->connection_head; NULL != ct; ct = ct->next)
3354     iter (cls, ct->c);
3355 }
3356
3357
3358 /**
3359  * Iterate all channels of a tunnel.
3360  *
3361  * @param t Tunnel whose channels to iterate.
3362  * @param iter Iterator.
3363  * @param cls Closure for @c iter.
3364  */
3365 void
3366 GCT_iterate_channels (struct CadetTunnel *t, GCT_chan_iter iter, void *cls)
3367 {
3368   struct CadetTChannel *cht;
3369
3370   for (cht = t->channel_head; NULL != cht; cht = cht->next)
3371     iter (cls, cht->ch);
3372 }