log if we get a redundant KX_AUTH, do not assert
[oweals/gnunet.git] / src / cadet / gnunet-service-cadet-new_tunnels.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2013, 2017 GNUnet e.V.
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, USA.
19 */
20 /**
21  * @file cadet/gnunet-service-cadet-new_tunnels.c
22  * @brief Information we track per tunnel.
23  * @author Bartlomiej Polot
24  * @author Christian Grothoff
25  *
26  * FIXME:
27  * - proper connection evaluation during connection management:
28  *   + consider quality (or quality spread?) of current connection set
29  *     when deciding how often to do maintenance
30  *   + interact with PEER to drive DHT GET/PUT operations based
31  *     on how much we like our connections
32  */
33 #include "platform.h"
34 #include "gnunet_util_lib.h"
35 #include "gnunet_statistics_service.h"
36 #include "gnunet_signatures.h"
37 #include "gnunet-service-cadet-new.h"
38 #include "cadet_protocol.h"
39 #include "gnunet-service-cadet-new_channel.h"
40 #include "gnunet-service-cadet-new_connection.h"
41 #include "gnunet-service-cadet-new_tunnels.h"
42 #include "gnunet-service-cadet-new_peer.h"
43 #include "gnunet-service-cadet-new_paths.h"
44
45
46 #define LOG(level, ...) GNUNET_log_from(level,"cadet-tun",__VA_ARGS__)
47
48 /**
49  * How often do we try to decrypt payload with unverified key
50  * material?  Used to limit CPU increase upon receiving bogus
51  * KX.
52  */
53 #define MAX_UNVERIFIED_ATTEMPTS 16
54
55 /**
56  * How long do we wait until tearing down an idle tunnel?
57  */
58 #define IDLE_DESTROY_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 90)
59
60 /**
61  * How long do we wait initially before retransmitting the KX?
62  * TODO: replace by 2 RTT if/once we have connection-level RTT data!
63  */
64 #define INITIAL_KX_RETRY_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 250)
65
66 /**
67  * Maximum number of skipped keys we keep in memory per tunnel.
68  */
69 #define MAX_SKIPPED_KEYS 64
70
71 /**
72  * Maximum number of keys (and thus ratchet steps) we are willing to
73  * skip before we decide this is either a bogus packet or a DoS-attempt.
74  */
75 #define MAX_KEY_GAP 256
76
77
78 /**
79  * Struct to old keys for skipped messages while advancing the Axolotl ratchet.
80  */
81 struct CadetTunnelSkippedKey
82 {
83   /**
84    * DLL next.
85    */
86   struct CadetTunnelSkippedKey *next;
87
88   /**
89    * DLL prev.
90    */
91   struct CadetTunnelSkippedKey *prev;
92
93   /**
94    * When was this key stored (for timeout).
95    */
96   struct GNUNET_TIME_Absolute timestamp;
97
98   /**
99    * Header key.
100    */
101   struct GNUNET_CRYPTO_SymmetricSessionKey HK;
102
103   /**
104    * Message key.
105    */
106   struct GNUNET_CRYPTO_SymmetricSessionKey MK;
107
108   /**
109    * Key number for a given HK.
110    */
111   unsigned int Kn;
112 };
113
114
115 /**
116  * Axolotl data, according to https://github.com/trevp/axolotl/wiki .
117  */
118 struct CadetTunnelAxolotl
119 {
120   /**
121    * A (double linked) list of stored message keys and associated header keys
122    * for "skipped" messages, i.e. messages that have not been
123    * received despite the reception of more recent messages, (head).
124    */
125   struct CadetTunnelSkippedKey *skipped_head;
126
127   /**
128    * Skipped messages' keys DLL, tail.
129    */
130   struct CadetTunnelSkippedKey *skipped_tail;
131
132   /**
133    * 32-byte root key which gets updated by DH ratchet.
134    */
135   struct GNUNET_CRYPTO_SymmetricSessionKey RK;
136
137   /**
138    * 32-byte header key (currently used for sending).
139    */
140   struct GNUNET_CRYPTO_SymmetricSessionKey HKs;
141
142   /**
143    * 32-byte header key (currently used for receiving)
144    */
145   struct GNUNET_CRYPTO_SymmetricSessionKey HKr;
146
147   /**
148    * 32-byte next header key (for sending), used once the
149    * ratchet advances.  We are sure that the sender has this
150    * key as well only after @e ratchet_allowed is #GNUNET_YES.
151    */
152   struct GNUNET_CRYPTO_SymmetricSessionKey NHKs;
153
154   /**
155    * 32-byte next header key (for receiving).  To be tried
156    * when decrypting with @e HKr fails and thus the sender
157    * may have advanced the ratchet.
158    */
159   struct GNUNET_CRYPTO_SymmetricSessionKey NHKr;
160
161   /**
162    * 32-byte chain keys (used for forward-secrecy) for
163    * sending messages. Updated for every message.
164    */
165   struct GNUNET_CRYPTO_SymmetricSessionKey CKs;
166
167   /**
168    * 32-byte chain keys (used for forward-secrecy) for
169    * receiving messages. Updated for every message. If
170    * messages are skipped, the respective derived MKs
171    * (and the current @HKr) are kept in the @e skipped_head DLL.
172    */
173   struct GNUNET_CRYPTO_SymmetricSessionKey CKr;
174
175   /**
176    * ECDH for key exchange (A0 / B0).  Note that for the
177    * 'unverified_ax', this member is an alias with the main
178    * 't->ax.kx_0' value, so do not free it!
179    */
180   struct GNUNET_CRYPTO_EcdhePrivateKey *kx_0;
181
182   /**
183    * ECDH Ratchet key (our private key in the current DH).  Note that
184    * for the 'unverified_ax', this member is an alias with the main
185    * 't->ax.kx_0' value, so do not free it!
186    */
187   struct GNUNET_CRYPTO_EcdhePrivateKey *DHRs;
188
189   /**
190    * ECDH Ratchet key (other peer's public key in the current DH).
191    */
192   struct GNUNET_CRYPTO_EcdhePublicKey DHRr;
193
194   /**
195    * Time when the current ratchet expires and a new one is triggered
196    * (if @e ratchet_allowed is #GNUNET_YES).
197    */
198   struct GNUNET_TIME_Absolute ratchet_expiration;
199
200   /**
201    * Number of elements in @a skipped_head <-> @a skipped_tail.
202    */
203   unsigned int skipped;
204
205   /**
206    * Message number (reset to 0 with each new ratchet, next message to send).
207    */
208   uint32_t Ns;
209
210   /**
211    * Message number (reset to 0 with each new ratchet, next message to recv).
212    */
213   uint32_t Nr;
214
215   /**
216    * Previous message numbers (# of msgs sent under prev ratchet)
217    */
218   uint32_t PNs;
219
220   /**
221    * True (#GNUNET_YES) if we have to send a new ratchet key in next msg.
222    */
223   int ratchet_flag;
224
225   /**
226    * True (#GNUNET_YES) if we have received a message from the
227    * other peer that uses the keys from our last ratchet step.
228    * This implies that we are again allowed to advance the ratchet,
229    * otherwise we have to wait until the other peer sees our current
230    * ephemeral key and advances first.
231    *
232    * #GNUNET_NO if we have advanced the ratched but lack any evidence
233    * that the other peer has noticed this.
234    */
235   int ratchet_allowed;
236
237   /**
238    * Number of messages recieved since our last ratchet advance.
239    *
240    * If this counter = 0, we cannot send a new ratchet key in the next
241    * message.
242    *
243    * If this counter > 0, we could (but don't have to) send a new key.
244    *
245    * Once the @e ratchet_counter is larger than
246    * #ratchet_messages (or @e ratchet_expiration time has past), and
247    * @e ratchet_allowed is #GNUNET_YES, we advance the ratchet.
248    */
249   unsigned int ratchet_counter;
250
251 };
252
253
254 /**
255  * Struct used to save messages in a non-ready tunnel to send once connected.
256  */
257 struct CadetTunnelQueueEntry
258 {
259   /**
260    * We are entries in a DLL
261    */
262   struct CadetTunnelQueueEntry *next;
263
264   /**
265    * We are entries in a DLL
266    */
267   struct CadetTunnelQueueEntry *prev;
268
269   /**
270    * Tunnel these messages belong in.
271    */
272   struct CadetTunnel *t;
273
274   /**
275    * Continuation to call once sent (on the channel layer).
276    */
277   GCT_SendContinuation cont;
278
279   /**
280    * Closure for @c cont.
281    */
282   void *cont_cls;
283
284   /**
285    * Envelope of message to send follows.
286    */
287   struct GNUNET_MQ_Envelope *env;
288
289   /**
290    * Where to put the connection identifier into the payload
291    * of the message in @e env once we have it?
292    */
293   struct GNUNET_CADET_ConnectionTunnelIdentifier *cid;
294 };
295
296
297 /**
298  * Struct containing all information regarding a tunnel to a peer.
299  */
300 struct CadetTunnel
301 {
302   /**
303    * Destination of the tunnel.
304    */
305   struct CadetPeer *destination;
306
307   /**
308    * Peer's ephemeral key, to recreate @c e_key and @c d_key when own
309    * ephemeral key changes.
310    */
311   struct GNUNET_CRYPTO_EcdhePublicKey peers_ephemeral_key;
312
313   /**
314    * Encryption ("our") key. It is only "confirmed" if kx_ctx is NULL.
315    */
316   struct GNUNET_CRYPTO_SymmetricSessionKey e_key;
317
318   /**
319    * Decryption ("their") key. It is only "confirmed" if kx_ctx is NULL.
320    */
321   struct GNUNET_CRYPTO_SymmetricSessionKey d_key;
322
323   /**
324    * Axolotl info.
325    */
326   struct CadetTunnelAxolotl ax;
327
328   /**
329    * Unverified Axolotl info, used only if we got a fresh KX (not a
330    * KX_AUTH) while our end of the tunnel was still up.  In this case,
331    * we keep the fresh KX around but do not put it into action until
332    * we got encrypted payload that assures us of the authenticity of
333    * the KX.
334    */
335   struct CadetTunnelAxolotl *unverified_ax;
336
337   /**
338    * Task scheduled if there are no more channels using the tunnel.
339    */
340   struct GNUNET_SCHEDULER_Task *destroy_task;
341
342   /**
343    * Task to trim connections if too many are present.
344    */
345   struct GNUNET_SCHEDULER_Task *maintain_connections_task;
346
347   /**
348    * Task to send messages from queue (if possible).
349    */
350   struct GNUNET_SCHEDULER_Task *send_task;
351
352   /**
353    * Task to trigger KX.
354    */
355   struct GNUNET_SCHEDULER_Task *kx_task;
356
357   /**
358    * Tokenizer for decrypted messages.
359    */
360   struct GNUNET_MessageStreamTokenizer *mst;
361
362   /**
363    * Dispatcher for decrypted messages only (do NOT use for sending!).
364    */
365   struct GNUNET_MQ_Handle *mq;
366
367   /**
368    * DLL of ready connections that are actively used to reach the destination peer.
369    */
370   struct CadetTConnection *connection_ready_head;
371
372   /**
373    * DLL of ready connections that are actively used to reach the destination peer.
374    */
375   struct CadetTConnection *connection_ready_tail;
376
377   /**
378    * DLL of connections that we maintain that might be used to reach the destination peer.
379    */
380   struct CadetTConnection *connection_busy_head;
381
382   /**
383    * DLL of connections that we maintain that might be used to reach the destination peer.
384    */
385   struct CadetTConnection *connection_busy_tail;
386
387   /**
388    * Channels inside this tunnel. Maps
389    * `struct GNUNET_CADET_ChannelTunnelNumber` to a `struct CadetChannel`.
390    */
391   struct GNUNET_CONTAINER_MultiHashMap32 *channels;
392
393   /**
394    * Channel ID for the next created channel in this tunnel.
395    */
396   struct GNUNET_CADET_ChannelTunnelNumber next_ctn;
397
398   /**
399    * Queued messages, to transmit once tunnel gets connected.
400    */
401   struct CadetTunnelQueueEntry *tq_head;
402
403   /**
404    * Queued messages, to transmit once tunnel gets connected.
405    */
406   struct CadetTunnelQueueEntry *tq_tail;
407
408   /**
409    * Identification of the connection from which we are currently processing
410    * a message. Only valid (non-NULL) during #handle_decrypted() and the
411    * handle-*()-functions called from our @e mq during that function.
412    */
413   struct CadetTConnection *current_ct;
414
415   /**
416    * How long do we wait until we retry the KX?
417    */
418   struct GNUNET_TIME_Relative kx_retry_delay;
419
420   /**
421    * When do we try the next KX?
422    */
423   struct GNUNET_TIME_Absolute next_kx_attempt;
424
425   /**
426    * Number of connections in the @e connection_ready_head DLL.
427    */
428   unsigned int num_ready_connections;
429
430   /**
431    * Number of connections in the @e connection_busy_head DLL.
432    */
433   unsigned int num_busy_connections;
434
435   /**
436    * How often have we tried and failed to decrypt a message using
437    * the unverified KX material from @e unverified_ax?  Used to
438    * stop trying after #MAX_UNVERIFIED_ATTEMPTS.
439    */
440   unsigned int unverified_attempts;
441
442   /**
443    * Number of entries in the @e tq_head DLL.
444    */
445   unsigned int tq_len;
446
447   /**
448    * State of the tunnel encryption.
449    */
450   enum CadetTunnelEState estate;
451
452   /**
453    * Force triggering KX_AUTH independent of @e estate.
454    */
455   int kx_auth_requested;
456
457 };
458
459
460 /**
461  * Connection @a ct is now unready, clear it's ready flag
462  * and move it from the ready DLL to the busy DLL.
463  *
464  * @param ct connection to move to unready status
465  */
466 static void
467 mark_connection_unready (struct CadetTConnection *ct)
468 {
469   struct CadetTunnel *t = ct->t;
470
471   GNUNET_assert (GNUNET_YES == ct->is_ready);
472   GNUNET_CONTAINER_DLL_remove (t->connection_ready_head,
473                                t->connection_ready_tail,
474                                ct);
475   GNUNET_assert (0 < t->num_ready_connections);
476   t->num_ready_connections--;
477   ct->is_ready = GNUNET_NO;
478   GNUNET_CONTAINER_DLL_insert (t->connection_busy_head,
479                                t->connection_busy_tail,
480                                ct);
481   t->num_busy_connections++;
482 }
483
484
485 /**
486  * Get the static string for the peer this tunnel is directed.
487  *
488  * @param t Tunnel.
489  *
490  * @return Static string the destination peer's ID.
491  */
492 const char *
493 GCT_2s (const struct CadetTunnel *t)
494 {
495   static char buf[64];
496
497   if (NULL == t)
498     return "Tunnel(NULL)";
499   GNUNET_snprintf (buf,
500                    sizeof (buf),
501                    "Tunnel %s",
502                    GNUNET_i2s (GCP_get_id (t->destination)));
503   return buf;
504 }
505
506
507 /**
508  * Get string description for tunnel encryption state.
509  *
510  * @param es Tunnel state.
511  *
512  * @return String representation.
513  */
514 static const char *
515 estate2s (enum CadetTunnelEState es)
516 {
517   static char buf[32];
518
519   switch (es)
520   {
521   case CADET_TUNNEL_KEY_UNINITIALIZED:
522     return "CADET_TUNNEL_KEY_UNINITIALIZED";
523   case CADET_TUNNEL_KEY_AX_RECV:
524     return "CADET_TUNNEL_KEY_AX_RECV";
525   case CADET_TUNNEL_KEY_AX_SENT:
526     return "CADET_TUNNEL_KEY_AX_SENT";
527   case CADET_TUNNEL_KEY_AX_SENT_AND_RECV:
528     return "CADET_TUNNEL_KEY_AX_SENT_AND_RECV";
529   case CADET_TUNNEL_KEY_AX_AUTH_SENT:
530     return "CADET_TUNNEL_KEY_AX_AUTH_SENT";
531   case CADET_TUNNEL_KEY_OK:
532     return "CADET_TUNNEL_KEY_OK";
533   default:
534     GNUNET_snprintf (buf,
535                      sizeof (buf),
536                      "%u (UNKNOWN STATE)",
537                      es);
538     return buf;
539   }
540 }
541
542
543 /**
544  * Return the peer to which this tunnel goes.
545  *
546  * @param t a tunnel
547  * @return the destination of the tunnel
548  */
549 struct CadetPeer *
550 GCT_get_destination (struct CadetTunnel *t)
551 {
552   return t->destination;
553 }
554
555
556 /**
557  * Count channels of a tunnel.
558  *
559  * @param t Tunnel on which to count.
560  *
561  * @return Number of channels.
562  */
563 unsigned int
564 GCT_count_channels (struct CadetTunnel *t)
565 {
566   return GNUNET_CONTAINER_multihashmap32_size (t->channels);
567 }
568
569
570 /**
571  * Lookup a channel by its @a ctn.
572  *
573  * @param t tunnel to look in
574  * @param ctn number of channel to find
575  * @return NULL if channel does not exist
576  */
577 struct CadetChannel *
578 lookup_channel (struct CadetTunnel *t,
579                 struct GNUNET_CADET_ChannelTunnelNumber ctn)
580 {
581   return GNUNET_CONTAINER_multihashmap32_get (t->channels,
582                                               ntohl (ctn.cn));
583 }
584
585
586 /**
587  * Count all created connections of a tunnel. Not necessarily ready connections!
588  *
589  * @param t Tunnel on which to count.
590  *
591  * @return Number of connections created, either being established or ready.
592  */
593 unsigned int
594 GCT_count_any_connections (const struct CadetTunnel *t)
595 {
596   return t->num_ready_connections + t->num_busy_connections;
597 }
598
599
600 /**
601  * Find first connection that is ready in the list of
602  * our connections.  Picks ready connections round-robin.
603  *
604  * @param t tunnel to search
605  * @return NULL if we have no connection that is ready
606  */
607 static struct CadetTConnection *
608 get_ready_connection (struct CadetTunnel *t)
609 {
610   return t->connection_ready_head;
611 }
612
613
614 /**
615  * Get the encryption state of a tunnel.
616  *
617  * @param t Tunnel.
618  *
619  * @return Tunnel's encryption state.
620  */
621 enum CadetTunnelEState
622 GCT_get_estate (struct CadetTunnel *t)
623 {
624   return t->estate;
625 }
626
627
628 /**
629  * Called when either we have a new connection, or a new message in the
630  * queue, or some existing connection has transmission capacity.  Looks
631  * at our message queue and if there is a message, picks a connection
632  * to send it on.
633  *
634  * @param cls the `struct CadetTunnel` to process messages on
635  */
636 static void
637 trigger_transmissions (void *cls);
638
639
640 /* ************************************** start core crypto ***************************** */
641
642
643 /**
644  * Create a new Axolotl ephemeral (ratchet) key.
645  *
646  * @param ax key material to update
647  */
648 static void
649 new_ephemeral (struct CadetTunnelAxolotl *ax)
650 {
651   GNUNET_free_non_null (ax->DHRs);
652   LOG (GNUNET_ERROR_TYPE_DEBUG,
653        "Creating new ephemeral ratchet key (DHRs)\n");
654   ax->DHRs = GNUNET_CRYPTO_ecdhe_key_create ();
655 }
656
657
658 /**
659  * Calculate HMAC.
660  *
661  * @param plaintext Content to HMAC.
662  * @param size Size of @c plaintext.
663  * @param iv Initialization vector for the message.
664  * @param key Key to use.
665  * @param hmac[out] Destination to store the HMAC.
666  */
667 static void
668 t_hmac (const void *plaintext,
669         size_t size,
670         uint32_t iv,
671         const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
672         struct GNUNET_ShortHashCode *hmac)
673 {
674   static const char ctx[] = "cadet authentication key";
675   struct GNUNET_CRYPTO_AuthKey auth_key;
676   struct GNUNET_HashCode hash;
677
678   GNUNET_CRYPTO_hmac_derive_key (&auth_key,
679                                  key,
680                                  &iv, sizeof (iv),
681                                  key, sizeof (*key),
682                                  ctx, sizeof (ctx),
683                                  NULL);
684   /* Two step: GNUNET_ShortHash is only 256 bits,
685      GNUNET_HashCode is 512, so we truncate. */
686   GNUNET_CRYPTO_hmac (&auth_key,
687                       plaintext,
688                       size,
689                       &hash);
690   GNUNET_memcpy (hmac,
691                  &hash,
692                  sizeof (*hmac));
693 }
694
695
696 /**
697  * Perform a HMAC.
698  *
699  * @param key Key to use.
700  * @param[out] hash Resulting HMAC.
701  * @param source Source key material (data to HMAC).
702  * @param len Length of @a source.
703  */
704 static void
705 t_ax_hmac_hash (const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
706                 struct GNUNET_HashCode *hash,
707                 const void *source,
708                 unsigned int len)
709 {
710   static const char ctx[] = "axolotl HMAC-HASH";
711   struct GNUNET_CRYPTO_AuthKey auth_key;
712
713   GNUNET_CRYPTO_hmac_derive_key (&auth_key,
714                                  key,
715                                  ctx, sizeof (ctx),
716                                  NULL);
717   GNUNET_CRYPTO_hmac (&auth_key,
718                       source,
719                       len,
720                       hash);
721 }
722
723
724 /**
725  * Derive a symmetric encryption key from an HMAC-HASH.
726  *
727  * @param key Key to use for the HMAC.
728  * @param[out] out Key to generate.
729  * @param source Source key material (data to HMAC).
730  * @param len Length of @a source.
731  */
732 static void
733 t_hmac_derive_key (const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
734                    struct GNUNET_CRYPTO_SymmetricSessionKey *out,
735                    const void *source,
736                    unsigned int len)
737 {
738   static const char ctx[] = "axolotl derive key";
739   struct GNUNET_HashCode h;
740
741   t_ax_hmac_hash (key,
742                   &h,
743                   source,
744                   len);
745   GNUNET_CRYPTO_kdf (out, sizeof (*out),
746                      ctx, sizeof (ctx),
747                      &h, sizeof (h),
748                      NULL);
749 }
750
751
752 /**
753  * Encrypt data with the axolotl tunnel key.
754  *
755  * @param ax key material to use.
756  * @param dst Destination with @a size bytes for the encrypted data.
757  * @param src Source of the plaintext. Can overlap with @c dst, must contain @a size bytes
758  * @param size Size of the buffers at @a src and @a dst
759  */
760 static void
761 t_ax_encrypt (struct CadetTunnelAxolotl *ax,
762               void *dst,
763               const void *src,
764               size_t size)
765 {
766   struct GNUNET_CRYPTO_SymmetricSessionKey MK;
767   struct GNUNET_CRYPTO_SymmetricInitializationVector iv;
768   size_t out_size;
769
770   ax->ratchet_counter++;
771   if ( (GNUNET_YES == ax->ratchet_allowed) &&
772        ( (ratchet_messages <= ax->ratchet_counter) ||
773          (0 == GNUNET_TIME_absolute_get_remaining (ax->ratchet_expiration).rel_value_us)) )
774   {
775     ax->ratchet_flag = GNUNET_YES;
776   }
777   if (GNUNET_YES == ax->ratchet_flag)
778   {
779     /* Advance ratchet */
780     struct GNUNET_CRYPTO_SymmetricSessionKey keys[3];
781     struct GNUNET_HashCode dh;
782     struct GNUNET_HashCode hmac;
783     static const char ctx[] = "axolotl ratchet";
784
785     new_ephemeral (ax);
786     ax->HKs = ax->NHKs;
787
788     /* RK, NHKs, CKs = KDF( HMAC-HASH(RK, DH(DHRs, DHRr)) ) */
789     GNUNET_CRYPTO_ecc_ecdh (ax->DHRs,
790                             &ax->DHRr,
791                             &dh);
792     t_ax_hmac_hash (&ax->RK,
793                     &hmac,
794                     &dh,
795                     sizeof (dh));
796     GNUNET_CRYPTO_kdf (keys, sizeof (keys),
797                        ctx, sizeof (ctx),
798                        &hmac, sizeof (hmac),
799                        NULL);
800     ax->RK = keys[0];
801     ax->NHKs = keys[1];
802     ax->CKs = keys[2];
803
804     ax->PNs = ax->Ns;
805     ax->Ns = 0;
806     ax->ratchet_flag = GNUNET_NO;
807     ax->ratchet_allowed = GNUNET_NO;
808     ax->ratchet_counter = 0;
809     ax->ratchet_expiration
810       = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(),
811                                   ratchet_time);
812   }
813
814   t_hmac_derive_key (&ax->CKs,
815                      &MK,
816                      "0",
817                      1);
818   GNUNET_CRYPTO_symmetric_derive_iv (&iv,
819                                      &MK,
820                                      NULL, 0,
821                                      NULL);
822
823   out_size = GNUNET_CRYPTO_symmetric_encrypt (src,
824                                               size,
825                                               &MK,
826                                               &iv,
827                                               dst);
828   GNUNET_assert (size == out_size);
829   t_hmac_derive_key (&ax->CKs,
830                      &ax->CKs,
831                      "1",
832                      1);
833 }
834
835
836 /**
837  * Decrypt data with the axolotl tunnel key.
838  *
839  * @param ax key material to use.
840  * @param dst Destination for the decrypted data, must contain @a size bytes.
841  * @param src Source of the ciphertext. Can overlap with @c dst, must contain @a size bytes.
842  * @param size Size of the @a src and @a dst buffers
843  */
844 static void
845 t_ax_decrypt (struct CadetTunnelAxolotl *ax,
846               void *dst,
847               const void *src,
848               size_t size)
849 {
850   struct GNUNET_CRYPTO_SymmetricSessionKey MK;
851   struct GNUNET_CRYPTO_SymmetricInitializationVector iv;
852   size_t out_size;
853
854   t_hmac_derive_key (&ax->CKr,
855                      &MK,
856                      "0",
857                      1);
858   GNUNET_CRYPTO_symmetric_derive_iv (&iv,
859                                      &MK,
860                                      NULL, 0,
861                                      NULL);
862   GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
863   out_size = GNUNET_CRYPTO_symmetric_decrypt (src,
864                                               size,
865                                               &MK,
866                                               &iv,
867                                               dst);
868   GNUNET_assert (out_size == size);
869   t_hmac_derive_key (&ax->CKr,
870                      &ax->CKr,
871                      "1",
872                      1);
873 }
874
875
876 /**
877  * Encrypt header with the axolotl header key.
878  *
879  * @param ax key material to use.
880  * @param[in|out] msg Message whose header to encrypt.
881  */
882 static void
883 t_h_encrypt (struct CadetTunnelAxolotl *ax,
884              struct GNUNET_CADET_TunnelEncryptedMessage *msg)
885 {
886   struct GNUNET_CRYPTO_SymmetricInitializationVector iv;
887   size_t out_size;
888
889   GNUNET_CRYPTO_symmetric_derive_iv (&iv,
890                                      &ax->HKs,
891                                      NULL, 0,
892                                      NULL);
893   out_size = GNUNET_CRYPTO_symmetric_encrypt (&msg->ax_header,
894                                               sizeof (struct GNUNET_CADET_AxHeader),
895                                               &ax->HKs,
896                                               &iv,
897                                               &msg->ax_header);
898   GNUNET_assert (sizeof (struct GNUNET_CADET_AxHeader) == out_size);
899 }
900
901
902 /**
903  * Decrypt header with the current axolotl header key.
904  *
905  * @param ax key material to use.
906  * @param src Message whose header to decrypt.
907  * @param dst Where to decrypt header to.
908  */
909 static void
910 t_h_decrypt (struct CadetTunnelAxolotl *ax,
911              const struct GNUNET_CADET_TunnelEncryptedMessage *src,
912              struct GNUNET_CADET_TunnelEncryptedMessage *dst)
913 {
914   struct GNUNET_CRYPTO_SymmetricInitializationVector iv;
915   size_t out_size;
916
917   GNUNET_CRYPTO_symmetric_derive_iv (&iv,
918                                      &ax->HKr,
919                                      NULL, 0,
920                                      NULL);
921   out_size = GNUNET_CRYPTO_symmetric_decrypt (&src->ax_header.Ns,
922                                               sizeof (struct GNUNET_CADET_AxHeader),
923                                               &ax->HKr,
924                                               &iv,
925                                               &dst->ax_header.Ns);
926   GNUNET_assert (sizeof (struct GNUNET_CADET_AxHeader) == out_size);
927 }
928
929
930 /**
931  * Delete a key from the list of skipped keys.
932  *
933  * @param ax key material to delete @a key from.
934  * @param key Key to delete.
935  */
936 static void
937 delete_skipped_key (struct CadetTunnelAxolotl *ax,
938                     struct CadetTunnelSkippedKey *key)
939 {
940   GNUNET_CONTAINER_DLL_remove (ax->skipped_head,
941                                ax->skipped_tail,
942                                key);
943   GNUNET_free (key);
944   ax->skipped--;
945 }
946
947
948 /**
949  * Decrypt and verify data with the appropriate tunnel key and verify that the
950  * data has not been altered since it was sent by the remote peer.
951  *
952  * @param ax key material to use.
953  * @param dst Destination for the plaintext.
954  * @param src Source of the message. Can overlap with @c dst.
955  * @param size Size of the message.
956  * @return Size of the decrypted data, -1 if an error was encountered.
957  */
958 static ssize_t
959 try_old_ax_keys (struct CadetTunnelAxolotl *ax,
960                  void *dst,
961                  const struct GNUNET_CADET_TunnelEncryptedMessage *src,
962                  size_t size)
963 {
964   struct CadetTunnelSkippedKey *key;
965   struct GNUNET_ShortHashCode *hmac;
966   struct GNUNET_CRYPTO_SymmetricInitializationVector iv;
967   struct GNUNET_CADET_TunnelEncryptedMessage plaintext_header;
968   struct GNUNET_CRYPTO_SymmetricSessionKey *valid_HK;
969   size_t esize;
970   size_t res;
971   size_t len;
972   unsigned int N;
973
974   LOG (GNUNET_ERROR_TYPE_DEBUG,
975        "Trying skipped keys\n");
976   hmac = &plaintext_header.hmac;
977   esize = size - sizeof (struct GNUNET_CADET_TunnelEncryptedMessage);
978
979   /* Find a correct Header Key */
980   valid_HK = NULL;
981   for (key = ax->skipped_head; NULL != key; key = key->next)
982   {
983     t_hmac (&src->ax_header,
984             sizeof (struct GNUNET_CADET_AxHeader) + esize,
985             0,
986             &key->HK,
987             hmac);
988     if (0 == memcmp (hmac,
989                      &src->hmac,
990                      sizeof (*hmac)))
991     {
992       valid_HK = &key->HK;
993       break;
994     }
995   }
996   if (NULL == key)
997     return -1;
998
999   /* Should've been checked in -cadet_connection.c handle_cadet_encrypted. */
1000   GNUNET_assert (size > sizeof (struct GNUNET_CADET_TunnelEncryptedMessage));
1001   len = size - sizeof (struct GNUNET_CADET_TunnelEncryptedMessage);
1002   GNUNET_assert (len >= sizeof (struct GNUNET_MessageHeader));
1003
1004   /* Decrypt header */
1005   GNUNET_CRYPTO_symmetric_derive_iv (&iv,
1006                                      &key->HK,
1007                                      NULL, 0,
1008                                      NULL);
1009   res = GNUNET_CRYPTO_symmetric_decrypt (&src->ax_header.Ns,
1010                                          sizeof (struct GNUNET_CADET_AxHeader),
1011                                          &key->HK,
1012                                          &iv,
1013                                          &plaintext_header.ax_header.Ns);
1014   GNUNET_assert (sizeof (struct GNUNET_CADET_AxHeader) == res);
1015
1016   /* Find the correct message key */
1017   N = ntohl (plaintext_header.ax_header.Ns);
1018   while ( (NULL != key) &&
1019           (N != key->Kn) )
1020     key = key->next;
1021   if ( (NULL == key) ||
1022        (0 != memcmp (&key->HK,
1023                      valid_HK,
1024                      sizeof (*valid_HK))) )
1025     return -1;
1026
1027   /* Decrypt payload */
1028   GNUNET_CRYPTO_symmetric_derive_iv (&iv,
1029                                      &key->MK,
1030                                      NULL,
1031                                      0,
1032                                      NULL);
1033   res = GNUNET_CRYPTO_symmetric_decrypt (&src[1],
1034                                          len,
1035                                          &key->MK,
1036                                          &iv,
1037                                          dst);
1038   delete_skipped_key (ax,
1039                       key);
1040   return res;
1041 }
1042
1043
1044 /**
1045  * Delete a key from the list of skipped keys.
1046  *
1047  * @param ax key material to delete from.
1048  * @param HKr Header Key to use.
1049  */
1050 static void
1051 store_skipped_key (struct CadetTunnelAxolotl *ax,
1052                    const struct GNUNET_CRYPTO_SymmetricSessionKey *HKr)
1053 {
1054   struct CadetTunnelSkippedKey *key;
1055
1056   key = GNUNET_new (struct CadetTunnelSkippedKey);
1057   key->timestamp = GNUNET_TIME_absolute_get ();
1058   key->Kn = ax->Nr;
1059   key->HK = ax->HKr;
1060   t_hmac_derive_key (&ax->CKr,
1061                      &key->MK,
1062                      "0",
1063                      1);
1064   t_hmac_derive_key (&ax->CKr,
1065                      &ax->CKr,
1066                      "1",
1067                      1);
1068   GNUNET_CONTAINER_DLL_insert (ax->skipped_head,
1069                                ax->skipped_tail,
1070                                key);
1071   ax->skipped++;
1072   ax->Nr++;
1073 }
1074
1075
1076 /**
1077  * Stage skipped AX keys and calculate the message key.
1078  * Stores each HK and MK for skipped messages.
1079  *
1080  * @param ax key material to use
1081  * @param HKr Header key.
1082  * @param Np Received meesage number.
1083  * @return #GNUNET_OK if keys were stored.
1084  *         #GNUNET_SYSERR if an error ocurred (@a Np not expected).
1085  */
1086 static int
1087 store_ax_keys (struct CadetTunnelAxolotl *ax,
1088                const struct GNUNET_CRYPTO_SymmetricSessionKey *HKr,
1089                uint32_t Np)
1090 {
1091   int gap;
1092
1093   gap = Np - ax->Nr;
1094   LOG (GNUNET_ERROR_TYPE_DEBUG,
1095        "Storing skipped keys [%u, %u)\n",
1096        ax->Nr,
1097        Np);
1098   if (MAX_KEY_GAP < gap)
1099   {
1100     /* Avoid DoS (forcing peer to do more than #MAX_KEY_GAP HMAC operations) */
1101     /* TODO: start new key exchange on return */
1102     GNUNET_break_op (0);
1103     LOG (GNUNET_ERROR_TYPE_WARNING,
1104          "Got message %u, expected %u+\n",
1105          Np,
1106          ax->Nr);
1107     return GNUNET_SYSERR;
1108   }
1109   if (0 > gap)
1110   {
1111     /* Delayed message: don't store keys, flag to try old keys. */
1112     return GNUNET_SYSERR;
1113   }
1114
1115   while (ax->Nr < Np)
1116     store_skipped_key (ax,
1117                        HKr);
1118
1119   while (ax->skipped > MAX_SKIPPED_KEYS)
1120     delete_skipped_key (ax,
1121                         ax->skipped_tail);
1122   return GNUNET_OK;
1123 }
1124
1125
1126 /**
1127  * Decrypt and verify data with the appropriate tunnel key and verify that the
1128  * data has not been altered since it was sent by the remote peer.
1129  *
1130  * @param ax key material to use
1131  * @param dst Destination for the plaintext.
1132  * @param src Source of the message. Can overlap with @c dst.
1133  * @param size Size of the message.
1134  * @return Size of the decrypted data, -1 if an error was encountered.
1135  */
1136 static ssize_t
1137 t_ax_decrypt_and_validate (struct CadetTunnelAxolotl *ax,
1138                            void *dst,
1139                            const struct GNUNET_CADET_TunnelEncryptedMessage *src,
1140                            size_t size)
1141 {
1142   struct GNUNET_ShortHashCode msg_hmac;
1143   struct GNUNET_HashCode hmac;
1144   struct GNUNET_CADET_TunnelEncryptedMessage plaintext_header;
1145   uint32_t Np;
1146   uint32_t PNp;
1147   size_t esize; /* Size of encryped payload */
1148
1149   esize = size - sizeof (struct GNUNET_CADET_TunnelEncryptedMessage);
1150
1151   /* Try current HK */
1152   t_hmac (&src->ax_header,
1153           sizeof (struct GNUNET_CADET_AxHeader) + esize,
1154           0, &ax->HKr,
1155           &msg_hmac);
1156   if (0 != memcmp (&msg_hmac,
1157                    &src->hmac,
1158                    sizeof (msg_hmac)))
1159   {
1160     static const char ctx[] = "axolotl ratchet";
1161     struct GNUNET_CRYPTO_SymmetricSessionKey keys[3]; /* RKp, NHKp, CKp */
1162     struct GNUNET_CRYPTO_SymmetricSessionKey HK;
1163     struct GNUNET_HashCode dh;
1164     struct GNUNET_CRYPTO_EcdhePublicKey *DHRp;
1165
1166     /* Try Next HK */
1167     t_hmac (&src->ax_header,
1168             sizeof (struct GNUNET_CADET_AxHeader) + esize,
1169             0,
1170             &ax->NHKr,
1171             &msg_hmac);
1172     if (0 != memcmp (&msg_hmac,
1173                      &src->hmac,
1174                      sizeof (msg_hmac)))
1175     {
1176       /* Try the skipped keys, if that fails, we're out of luck. */
1177       return try_old_ax_keys (ax,
1178                               dst,
1179                               src,
1180                               size);
1181     }
1182     HK = ax->HKr;
1183     ax->HKr = ax->NHKr;
1184     t_h_decrypt (ax,
1185                  src,
1186                  &plaintext_header);
1187     Np = ntohl (plaintext_header.ax_header.Ns);
1188     PNp = ntohl (plaintext_header.ax_header.PNs);
1189     DHRp = &plaintext_header.ax_header.DHRs;
1190     store_ax_keys (ax,
1191                    &HK,
1192                    PNp);
1193
1194     /* RKp, NHKp, CKp = KDF (HMAC-HASH (RK, DH (DHRp, DHRs))) */
1195     GNUNET_CRYPTO_ecc_ecdh (ax->DHRs,
1196                             DHRp,
1197                             &dh);
1198     t_ax_hmac_hash (&ax->RK,
1199                     &hmac,
1200                     &dh, sizeof (dh));
1201     GNUNET_CRYPTO_kdf (keys, sizeof (keys),
1202                        ctx, sizeof (ctx),
1203                        &hmac, sizeof (hmac),
1204                        NULL);
1205
1206     /* Commit "purported" keys */
1207     ax->RK = keys[0];
1208     ax->NHKr = keys[1];
1209     ax->CKr = keys[2];
1210     ax->DHRr = *DHRp;
1211     ax->Nr = 0;
1212     ax->ratchet_allowed = GNUNET_YES;
1213   }
1214   else
1215   {
1216     t_h_decrypt (ax,
1217                  src,
1218                  &plaintext_header);
1219     Np = ntohl (plaintext_header.ax_header.Ns);
1220     PNp = ntohl (plaintext_header.ax_header.PNs);
1221   }
1222   if ( (Np != ax->Nr) &&
1223        (GNUNET_OK != store_ax_keys (ax,
1224                                     &ax->HKr,
1225                                     Np)) )
1226   {
1227     /* Try the skipped keys, if that fails, we're out of luck. */
1228     return try_old_ax_keys (ax,
1229                             dst,
1230                             src,
1231                             size);
1232   }
1233
1234   t_ax_decrypt (ax,
1235                 dst,
1236                 &src[1],
1237                 esize);
1238   ax->Nr = Np + 1;
1239   return esize;
1240 }
1241
1242
1243 /**
1244  * Our tunnel became ready for the first time, notify channels
1245  * that have been waiting.
1246  *
1247  * @param cls our tunnel, not used
1248  * @param key unique ID of the channel, not used
1249  * @param value the `struct CadetChannel` to notify
1250  * @return #GNUNET_OK (continue to iterate)
1251  */
1252 static int
1253 notify_tunnel_up_cb (void *cls,
1254                      uint32_t key,
1255                      void *value)
1256 {
1257   struct CadetChannel *ch = value;
1258
1259   GCCH_tunnel_up (ch);
1260   return GNUNET_OK;
1261 }
1262
1263
1264 /**
1265  * Change the tunnel encryption state.
1266  * If the encryption state changes to OK, stop the rekey task.
1267  *
1268  * @param t Tunnel whose encryption state to change, or NULL.
1269  * @param state New encryption state.
1270  */
1271 void
1272 GCT_change_estate (struct CadetTunnel *t,
1273                    enum CadetTunnelEState state)
1274 {
1275   enum CadetTunnelEState old = t->estate;
1276
1277   t->estate = state;
1278   LOG (GNUNET_ERROR_TYPE_DEBUG,
1279        "%s estate changed from %s to %s\n",
1280        GCT_2s (t),
1281        estate2s (old),
1282        estate2s (state));
1283
1284   if ( (CADET_TUNNEL_KEY_OK != old) &&
1285        (CADET_TUNNEL_KEY_OK == t->estate) )
1286   {
1287     if (NULL != t->kx_task)
1288     {
1289       GNUNET_SCHEDULER_cancel (t->kx_task);
1290       t->kx_task = NULL;
1291     }
1292     /* notify all channels that have been waiting */
1293     GNUNET_CONTAINER_multihashmap32_iterate (t->channels,
1294                                              &notify_tunnel_up_cb,
1295                                              t);
1296     if (NULL != t->send_task)
1297       GNUNET_SCHEDULER_cancel (t->send_task);
1298     t->send_task = GNUNET_SCHEDULER_add_now (&trigger_transmissions,
1299                                              t);
1300   }
1301 }
1302
1303
1304 /**
1305  * Send a KX message.
1306  *
1307  * @param t tunnel on which to send the KX_AUTH
1308  * @param ct Tunnel and connection on which to send the KX_AUTH, NULL if
1309  *           we are to find one that is ready.
1310  * @param ax axolotl key context to use
1311  */
1312 static void
1313 send_kx (struct CadetTunnel *t,
1314          struct CadetTConnection *ct,
1315          struct CadetTunnelAxolotl *ax)
1316 {
1317   struct CadetConnection *cc;
1318   struct GNUNET_MQ_Envelope *env;
1319   struct GNUNET_CADET_TunnelKeyExchangeMessage *msg;
1320   enum GNUNET_CADET_KX_Flags flags;
1321
1322   if (NULL == ct)
1323     ct = get_ready_connection (t);
1324   if (NULL == ct)
1325   {
1326     LOG (GNUNET_ERROR_TYPE_DEBUG,
1327          "Wanted to send %s in state %s, but no connection is ready, deferring\n",
1328          GCT_2s (t),
1329          estate2s (t->estate));
1330     t->next_kx_attempt = GNUNET_TIME_absolute_get ();
1331     return;
1332   }
1333   cc = ct->cc;
1334   LOG (GNUNET_ERROR_TYPE_DEBUG,
1335        "Sending KX on %s via %s using %s in state %s\n",
1336        GCT_2s (t),
1337        GCC_2s (cc),
1338        estate2s (t->estate));
1339   env = GNUNET_MQ_msg (msg,
1340                        GNUNET_MESSAGE_TYPE_CADET_TUNNEL_KX);
1341   flags = GNUNET_CADET_KX_FLAG_FORCE_REPLY; /* always for KX */
1342   msg->flags = htonl (flags);
1343   msg->cid = *GCC_get_id (cc);
1344   GNUNET_CRYPTO_ecdhe_key_get_public (ax->kx_0,
1345                                       &msg->ephemeral_key);
1346   GNUNET_CRYPTO_ecdhe_key_get_public (ax->DHRs,
1347                                       &msg->ratchet_key);
1348   mark_connection_unready (ct);
1349   t->kx_retry_delay = GNUNET_TIME_STD_BACKOFF (t->kx_retry_delay);
1350   t->next_kx_attempt = GNUNET_TIME_relative_to_absolute (t->kx_retry_delay);
1351   if (CADET_TUNNEL_KEY_UNINITIALIZED == t->estate)
1352     GCT_change_estate (t,
1353                        CADET_TUNNEL_KEY_AX_SENT);
1354   else if (CADET_TUNNEL_KEY_AX_RECV == t->estate)
1355     GCT_change_estate (t,
1356                        CADET_TUNNEL_KEY_AX_SENT_AND_RECV);
1357   GCC_transmit (cc,
1358                 env);
1359 }
1360
1361
1362 /**
1363  * Send a KX_AUTH message.
1364  *
1365  * @param t tunnel on which to send the KX_AUTH
1366  * @param ct Tunnel and connection on which to send the KX_AUTH, NULL if
1367  *           we are to find one that is ready.
1368  * @param ax axolotl key context to use
1369  * @param force_reply Force the other peer to reply with a KX_AUTH message
1370  *         (set if we would like to transmit right now, but cannot)
1371  */
1372 static void
1373 send_kx_auth (struct CadetTunnel *t,
1374               struct CadetTConnection *ct,
1375               struct CadetTunnelAxolotl *ax,
1376               int force_reply)
1377 {
1378   struct CadetConnection *cc;
1379   struct GNUNET_MQ_Envelope *env;
1380   struct GNUNET_CADET_TunnelKeyExchangeAuthMessage *msg;
1381   enum GNUNET_CADET_KX_Flags flags;
1382
1383   if ( (NULL == ct) ||
1384        (GNUNET_NO == ct->is_ready) )
1385     ct = get_ready_connection (t);
1386   if (NULL == ct)
1387   {
1388     LOG (GNUNET_ERROR_TYPE_DEBUG,
1389          "Wanted to send KX_AUTH on %s, but no connection is ready, deferring\n",
1390          GCT_2s (t));
1391     t->next_kx_attempt = GNUNET_TIME_absolute_get ();
1392     t->kx_auth_requested = GNUNET_YES; /* queue KX_AUTH independent of estate */
1393     return;
1394   }
1395   t->kx_auth_requested = GNUNET_NO; /* clear flag */
1396   cc = ct->cc;
1397   LOG (GNUNET_ERROR_TYPE_DEBUG,
1398        "Sending KX_AUTH on %s using %s\n",
1399        GCT_2s (t),
1400        GCC_2s (ct->cc));
1401
1402   env = GNUNET_MQ_msg (msg,
1403                        GNUNET_MESSAGE_TYPE_CADET_TUNNEL_KX_AUTH);
1404   flags = GNUNET_CADET_KX_FLAG_NONE;
1405   if (GNUNET_YES == force_reply)
1406     flags |= GNUNET_CADET_KX_FLAG_FORCE_REPLY;
1407   msg->kx.flags = htonl (flags);
1408   msg->kx.cid = *GCC_get_id (cc);
1409   GNUNET_CRYPTO_ecdhe_key_get_public (ax->kx_0,
1410                                       &msg->kx.ephemeral_key);
1411   GNUNET_CRYPTO_ecdhe_key_get_public (ax->DHRs,
1412                                       &msg->kx.ratchet_key);
1413   /* Compute authenticator (this is the main difference to #send_kx()) */
1414   GNUNET_CRYPTO_hash (&ax->RK,
1415                       sizeof (ax->RK),
1416                       &msg->auth);
1417
1418   /* Compute when to be triggered again; actual job will
1419      be scheduled via #connection_ready_cb() */
1420   t->kx_retry_delay
1421     = GNUNET_TIME_STD_BACKOFF (t->kx_retry_delay);
1422   t->next_kx_attempt
1423     = GNUNET_TIME_relative_to_absolute (t->kx_retry_delay);
1424
1425   /* Send via cc, mark it as unready */
1426   mark_connection_unready (ct);
1427
1428   /* Update state machine, unless we are already OK */
1429   if (CADET_TUNNEL_KEY_OK != t->estate)
1430     GCT_change_estate (t,
1431                        CADET_TUNNEL_KEY_AX_AUTH_SENT);
1432
1433   GCC_transmit (cc,
1434                 env);
1435 }
1436
1437
1438 /**
1439  * Cleanup state used by @a ax.
1440  *
1441  * @param ax state to free, but not memory of @a ax itself
1442  */
1443 static void
1444 cleanup_ax (struct CadetTunnelAxolotl *ax)
1445 {
1446   while (NULL != ax->skipped_head)
1447     delete_skipped_key (ax,
1448                         ax->skipped_head);
1449   GNUNET_assert (0 == ax->skipped);
1450   GNUNET_free_non_null (ax->kx_0);
1451   GNUNET_free_non_null (ax->DHRs);
1452 }
1453
1454
1455 /**
1456  * Update our Axolotl key state based on the KX data we received.
1457  * Computes the new chain keys, and root keys, etc, and also checks
1458  * wether this is a replay of the current chain.
1459  *
1460  * @param[in|out] axolotl chain key state to recompute
1461  * @param pid peer identity of the other peer
1462  * @param ephemeral_key ephemeral public key of the other peer
1463  * @param ratchet_key senders next ephemeral public key
1464  * @return #GNUNET_OK on success, #GNUNET_NO if the resulting
1465  *       root key is already in @a ax and thus the KX is useless;
1466  *       #GNUNET_SYSERR on hard errors (i.e. @a pid is #my_full_id)
1467  */
1468 static int
1469 update_ax_by_kx (struct CadetTunnelAxolotl *ax,
1470                  const struct GNUNET_PeerIdentity *pid,
1471                  const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral_key,
1472                  const struct GNUNET_CRYPTO_EcdhePublicKey *ratchet_key)
1473 {
1474   struct GNUNET_HashCode key_material[3];
1475   struct GNUNET_CRYPTO_SymmetricSessionKey keys[5];
1476   const char salt[] = "CADET Axolotl salt";
1477   int am_I_alice;
1478
1479   if (0 > GNUNET_CRYPTO_cmp_peer_identity (&my_full_id,
1480                                            pid))
1481     am_I_alice = GNUNET_YES;
1482   else if (0 < GNUNET_CRYPTO_cmp_peer_identity (&my_full_id,
1483                                                 pid))
1484     am_I_alice = GNUNET_NO;
1485   else
1486   {
1487     GNUNET_break_op (0);
1488     return GNUNET_SYSERR;
1489   }
1490
1491   if (0 == memcmp (&ax->DHRr,
1492                    ratchet_key,
1493                    sizeof (*ratchet_key)))
1494   {
1495     LOG (GNUNET_ERROR_TYPE_DEBUG,
1496          "Ratchet key already known. Ignoring KX.\n");
1497     return GNUNET_NO;
1498   }
1499
1500   ax->DHRr = *ratchet_key;
1501
1502   /* ECDH A B0 */
1503   if (GNUNET_YES == am_I_alice)
1504   {
1505     GNUNET_CRYPTO_eddsa_ecdh (my_private_key,      /* A */
1506                               ephemeral_key, /* B0 */
1507                               &key_material[0]);
1508   }
1509   else
1510   {
1511     GNUNET_CRYPTO_ecdh_eddsa (ax->kx_0,            /* B0 */
1512                               &pid->public_key,    /* A */
1513                               &key_material[0]);
1514   }
1515
1516   /* ECDH A0 B */
1517   if (GNUNET_YES == am_I_alice)
1518   {
1519     GNUNET_CRYPTO_ecdh_eddsa (ax->kx_0,            /* A0 */
1520                               &pid->public_key,    /* B */
1521                               &key_material[1]);
1522   }
1523   else
1524   {
1525     GNUNET_CRYPTO_eddsa_ecdh (my_private_key,      /* A */
1526                               ephemeral_key, /* B0 */
1527                               &key_material[1]);
1528
1529
1530   }
1531
1532   /* ECDH A0 B0 */
1533   /* (This is the triple-DH, we could probably safely skip this,
1534      as A0/B0 are already in the key material.) */
1535   GNUNET_CRYPTO_ecc_ecdh (ax->kx_0,             /* A0 or B0 */
1536                           ephemeral_key,  /* B0 or A0 */
1537                           &key_material[2]);
1538
1539   /* KDF */
1540   GNUNET_CRYPTO_kdf (keys, sizeof (keys),
1541                      salt, sizeof (salt),
1542                      &key_material, sizeof (key_material),
1543                      NULL);
1544
1545   if (0 == memcmp (&ax->RK,
1546                    &keys[0],
1547                    sizeof (ax->RK)))
1548   {
1549     LOG (GNUNET_ERROR_TYPE_DEBUG,
1550          "Root key of handshake already known. Ignoring KX.\n");
1551     return GNUNET_NO;
1552   }
1553
1554   ax->RK = keys[0];
1555   if (GNUNET_YES == am_I_alice)
1556   {
1557     ax->HKr = keys[1];
1558     ax->NHKs = keys[2];
1559     ax->NHKr = keys[3];
1560     ax->CKr = keys[4];
1561     ax->ratchet_flag = GNUNET_YES;
1562   }
1563   else
1564   {
1565     ax->HKs = keys[1];
1566     ax->NHKr = keys[2];
1567     ax->NHKs = keys[3];
1568     ax->CKs = keys[4];
1569     ax->ratchet_flag = GNUNET_NO;
1570     ax->ratchet_expiration
1571       = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(),
1572                                   ratchet_time);
1573   }
1574   return GNUNET_OK;
1575 }
1576
1577
1578 /**
1579  * Try to redo the KX or KX_AUTH handshake, if we can.
1580  *
1581  * @param cls the `struct CadetTunnel` to do KX for.
1582  */
1583 static void
1584 retry_kx (void *cls)
1585 {
1586   struct CadetTunnel *t = cls;
1587   struct CadetTunnelAxolotl *ax;
1588
1589   t->kx_task = NULL;
1590   LOG (GNUNET_ERROR_TYPE_DEBUG,
1591        "Trying to make KX progress on %s in state %s\n",
1592        GCT_2s (t),
1593        estate2s (t->estate));
1594   switch (t->estate)
1595   {
1596   case CADET_TUNNEL_KEY_UNINITIALIZED: /* first attempt */
1597   case CADET_TUNNEL_KEY_AX_SENT:       /* trying again */
1598     send_kx (t,
1599              NULL,
1600              &t->ax);
1601     break;
1602   case CADET_TUNNEL_KEY_AX_RECV:
1603   case CADET_TUNNEL_KEY_AX_SENT_AND_RECV:
1604     /* We are responding, so only require reply
1605        if WE have a channel waiting. */
1606     if (NULL != t->unverified_ax)
1607     {
1608       /* Send AX_AUTH so we might get this one verified */
1609       ax = t->unverified_ax;
1610     }
1611     else
1612     {
1613       /* How can this be? */
1614       GNUNET_break (0);
1615       ax = &t->ax;
1616     }
1617     send_kx_auth (t,
1618                   NULL,
1619                   ax,
1620                   (0 == GCT_count_channels (t))
1621                   ? GNUNET_NO
1622                   : GNUNET_YES);
1623     break;
1624   case CADET_TUNNEL_KEY_AX_AUTH_SENT:
1625     /* We are responding, so only require reply
1626        if WE have a channel waiting. */
1627     if (NULL != t->unverified_ax)
1628     {
1629       /* Send AX_AUTH so we might get this one verified */
1630       ax = t->unverified_ax;
1631     }
1632     else
1633     {
1634       /* How can this be? */
1635       GNUNET_break (0);
1636       ax = &t->ax;
1637     }
1638     send_kx_auth (t,
1639                   NULL,
1640                   ax,
1641                   (0 == GCT_count_channels (t))
1642                   ? GNUNET_NO
1643                   : GNUNET_YES);
1644     break;
1645   case CADET_TUNNEL_KEY_OK:
1646     /* Must have been the *other* peer asking us to
1647        respond with a KX_AUTH. */
1648     if (NULL != t->unverified_ax)
1649     {
1650       /* Sending AX_AUTH in response to AX so we might get this one verified */
1651       ax = t->unverified_ax;
1652     }
1653     else
1654     {
1655       /* Sending AX_AUTH in response to AX_AUTH */
1656       ax = &t->ax;
1657     }
1658     send_kx_auth (t,
1659                   NULL,
1660                   ax,
1661                   GNUNET_NO);
1662     break;
1663   }
1664 }
1665
1666
1667 /**
1668  * Handle KX message that lacks authentication (and which will thus
1669  * only be considered authenticated after we respond with our own
1670  * KX_AUTH and finally successfully decrypt payload).
1671  *
1672  * @param ct connection/tunnel combo that received encrypted message
1673  * @param msg the key exchange message
1674  */
1675 void
1676 GCT_handle_kx (struct CadetTConnection *ct,
1677                const struct GNUNET_CADET_TunnelKeyExchangeMessage *msg)
1678 {
1679   struct CadetTunnel *t = ct->t;
1680   struct CadetTunnelAxolotl *ax;
1681   int ret;
1682
1683   if (0 ==
1684       memcmp (&t->ax.DHRr,
1685               &msg->ratchet_key,
1686               sizeof (msg->ratchet_key)))
1687   {
1688     LOG (GNUNET_ERROR_TYPE_DEBUG,
1689          "Got duplicate KX. Firing back KX_AUTH.\n");
1690     send_kx_auth (t,
1691                   ct,
1692                   &t->ax,
1693                   GNUNET_NO);
1694     return;
1695   }
1696
1697   /* We only keep ONE unverified KX around, so if there is an existing one,
1698      clean it up. */
1699   if (NULL != t->unverified_ax)
1700   {
1701     if (0 ==
1702         memcmp (&t->unverified_ax->DHRr,
1703                 &msg->ratchet_key,
1704                 sizeof (msg->ratchet_key)))
1705     {
1706       LOG (GNUNET_ERROR_TYPE_DEBUG,
1707            "Got duplicate unverified KX on %s. Fire back KX_AUTH again.\n",
1708            GCT_2s (t));
1709       send_kx_auth (t,
1710                     ct,
1711                     t->unverified_ax,
1712                     GNUNET_NO);
1713       return;
1714     }
1715     LOG (GNUNET_ERROR_TYPE_DEBUG,
1716          "Dropping old unverified KX state. Got a fresh KX for %s.\n",
1717          GCT_2s (t));
1718     memset (t->unverified_ax,
1719             0,
1720             sizeof (struct CadetTunnelAxolotl));
1721     t->unverified_ax->DHRs = t->ax.DHRs;
1722     t->unverified_ax->kx_0 = t->ax.kx_0;
1723   }
1724   else
1725   {
1726     LOG (GNUNET_ERROR_TYPE_DEBUG,
1727          "Creating fresh unverified KX for %s.\n",
1728          GCT_2s (t));
1729     t->unverified_ax = GNUNET_new (struct CadetTunnelAxolotl);
1730     t->unverified_ax->DHRs = t->ax.DHRs;
1731     t->unverified_ax->kx_0 = t->ax.kx_0;
1732   }
1733   /* Set as the 'current' RK/DHRr the one we are currently using,
1734      so that the duplicate-detection logic of
1735      #update_ax_by_kx can work. */
1736   t->unverified_ax->RK = t->ax.RK;
1737   t->unverified_ax->DHRr = t->ax.DHRr;
1738   t->unverified_attempts = 0;
1739   ax = t->unverified_ax;
1740
1741   /* Update 'ax' by the new key material */
1742   ret = update_ax_by_kx (ax,
1743                          GCP_get_id (t->destination),
1744                          &msg->ephemeral_key,
1745                          &msg->ratchet_key);
1746   GNUNET_break (GNUNET_SYSERR != ret);
1747   if (GNUNET_OK != ret)
1748     return; /* duplicate KX, nothing to do */
1749
1750   /* move ahead in our state machine */
1751   if (CADET_TUNNEL_KEY_UNINITIALIZED == t->estate)
1752     GCT_change_estate (t,
1753                        CADET_TUNNEL_KEY_AX_RECV);
1754   else if (CADET_TUNNEL_KEY_AX_SENT == t->estate)
1755     GCT_change_estate (t,
1756                        CADET_TUNNEL_KEY_AX_SENT_AND_RECV);
1757
1758   /* KX is still not done, try again our end. */
1759   if (CADET_TUNNEL_KEY_OK != t->estate)
1760   {
1761     if (NULL != t->kx_task)
1762       GNUNET_SCHEDULER_cancel (t->kx_task);
1763     t->kx_task
1764       = GNUNET_SCHEDULER_add_now (&retry_kx,
1765                                   t);
1766   }
1767 }
1768
1769
1770 /**
1771  * Handle KX_AUTH message.
1772  *
1773  * @param ct connection/tunnel combo that received encrypted message
1774  * @param msg the key exchange message
1775  */
1776 void
1777 GCT_handle_kx_auth (struct CadetTConnection *ct,
1778                     const struct GNUNET_CADET_TunnelKeyExchangeAuthMessage *msg)
1779 {
1780   struct CadetTunnel *t = ct->t;
1781   struct CadetTunnelAxolotl ax_tmp;
1782   struct GNUNET_HashCode kx_auth;
1783   int ret;
1784
1785   if ( (CADET_TUNNEL_KEY_UNINITIALIZED == t->estate) ||
1786        (CADET_TUNNEL_KEY_AX_RECV == t->estate) )
1787   {
1788     /* Confusing, we got a KX_AUTH before we even send our own
1789        KX. This should not happen. We'll send our own KX ASAP anyway,
1790        so let's ignore this here. */
1791     GNUNET_break_op (0);
1792     return;
1793   }
1794   LOG (GNUNET_ERROR_TYPE_DEBUG,
1795        "Handling KX_AUTH message for %s\n",
1796        GCT_2s (t));
1797
1798   /* We do everything in ax_tmp until we've checked the authentication
1799      so we don't clobber anything we care about by accident. */
1800   ax_tmp = t->ax;
1801
1802   /* Update 'ax' by the new key material */
1803   ret = update_ax_by_kx (&ax_tmp,
1804                          GCP_get_id (t->destination),
1805                          &msg->kx.ephemeral_key,
1806                          &msg->kx.ratchet_key);
1807   if (GNUNET_OK != ret)
1808   {
1809     if (GNUNET_NO == ret)
1810       GNUNET_STATISTICS_update (stats,
1811                                 "# redundant KX_AUTH received",
1812                                 1,
1813                                 GNUNET_NO);
1814     else
1815       GNUNET_break (0); /* connect to self!? */
1816     return;
1817   }
1818   GNUNET_CRYPTO_hash (&ax_tmp.RK,
1819                       sizeof (ax_tmp.RK),
1820                       &kx_auth);
1821   if (0 != memcmp (&kx_auth,
1822                    &msg->auth,
1823                    sizeof (kx_auth)))
1824   {
1825     /* This KX_AUTH is not using the latest KX/KX_AUTH data
1826        we transmitted to the sender, refuse it, try KX again. */
1827     GNUNET_break_op (0);
1828     send_kx (t,
1829              NULL,
1830              &t->ax);
1831     return;
1832   }
1833   /* Yep, we're good. */
1834   t->ax = ax_tmp;
1835   if (NULL != t->unverified_ax)
1836   {
1837     /* We got some "stale" KX before, drop that. */
1838     t->unverified_ax->DHRs = NULL; /* aliased with ax.DHRs */
1839     t->unverified_ax->kx_0 = NULL; /* aliased with ax.DHRs */
1840     cleanup_ax (t->unverified_ax);
1841     GNUNET_free (t->unverified_ax);
1842     t->unverified_ax = NULL;
1843   }
1844
1845   /* move ahead in our state machine */
1846   switch (t->estate)
1847   {
1848   case CADET_TUNNEL_KEY_UNINITIALIZED:
1849   case CADET_TUNNEL_KEY_AX_RECV:
1850     /* Checked above, this is impossible. */
1851     GNUNET_assert (0);
1852     break;
1853   case CADET_TUNNEL_KEY_AX_SENT:      /* This is the normal case */
1854   case CADET_TUNNEL_KEY_AX_SENT_AND_RECV: /* both peers started KX */
1855   case CADET_TUNNEL_KEY_AX_AUTH_SENT: /* both peers now did KX_AUTH */
1856     GCT_change_estate (t,
1857                        CADET_TUNNEL_KEY_OK);
1858     break;
1859   case CADET_TUNNEL_KEY_OK:
1860     /* Did not expect another KX_AUTH, but so what, still acceptable.
1861        Nothing to do here. */
1862     break;
1863   }
1864 }
1865
1866
1867
1868 /* ************************************** end core crypto ***************************** */
1869
1870
1871 /**
1872  * Compute the next free channel tunnel number for this tunnel.
1873  *
1874  * @param t the tunnel
1875  * @return unused number that can uniquely identify a channel in the tunnel
1876  */
1877 static struct GNUNET_CADET_ChannelTunnelNumber
1878 get_next_free_ctn (struct CadetTunnel *t)
1879 {
1880 #define HIGH_BIT 0x8000000
1881   struct GNUNET_CADET_ChannelTunnelNumber ret;
1882   uint32_t ctn;
1883   int cmp;
1884   uint32_t highbit;
1885
1886   cmp = GNUNET_CRYPTO_cmp_peer_identity (&my_full_id,
1887                                          GCP_get_id (GCT_get_destination (t)));
1888   if (0 < cmp)
1889     highbit = HIGH_BIT;
1890   else if (0 > cmp)
1891     highbit = 0;
1892   else
1893     GNUNET_assert (0); // loopback must never go here!
1894   ctn = ntohl (t->next_ctn.cn);
1895   while (NULL !=
1896          GNUNET_CONTAINER_multihashmap32_get (t->channels,
1897                                               ctn))
1898   {
1899     ctn = ((ctn + 1) & (~ HIGH_BIT)) | highbit;
1900   }
1901   t->next_ctn.cn = htonl (((ctn + 1) & (~ HIGH_BIT)) | highbit);
1902   ret.cn = ntohl (ctn);
1903   return ret;
1904 }
1905
1906
1907 /**
1908  * Add a channel to a tunnel, and notify channel that we are ready
1909  * for transmission if we are already up.  Otherwise that notification
1910  * will be done later in #notify_tunnel_up_cb().
1911  *
1912  * @param t Tunnel.
1913  * @param ch Channel
1914  * @return unique number identifying @a ch within @a t
1915  */
1916 struct GNUNET_CADET_ChannelTunnelNumber
1917 GCT_add_channel (struct CadetTunnel *t,
1918                  struct CadetChannel *ch)
1919 {
1920   struct GNUNET_CADET_ChannelTunnelNumber ctn;
1921
1922   ctn = get_next_free_ctn (t);
1923   if (NULL != t->destroy_task)
1924   {
1925     GNUNET_SCHEDULER_cancel (t->destroy_task);
1926     t->destroy_task = NULL;
1927   }
1928   GNUNET_assert (GNUNET_YES ==
1929                  GNUNET_CONTAINER_multihashmap32_put (t->channels,
1930                                                       ntohl (ctn.cn),
1931                                                       ch,
1932                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1933   LOG (GNUNET_ERROR_TYPE_DEBUG,
1934        "Adding %s to %s\n",
1935        GCCH_2s (ch),
1936        GCT_2s (t));
1937   switch (t->estate)
1938   {
1939   case CADET_TUNNEL_KEY_UNINITIALIZED:
1940     /* waiting for connection to start KX */
1941     break;
1942   case CADET_TUNNEL_KEY_AX_RECV:
1943   case CADET_TUNNEL_KEY_AX_SENT:
1944   case CADET_TUNNEL_KEY_AX_SENT_AND_RECV:
1945     /* we're currently waiting for KX to complete */
1946     break;
1947   case CADET_TUNNEL_KEY_AX_AUTH_SENT:
1948     /* waiting for OTHER peer to send us data,
1949        we might need to prompt more aggressively! */
1950     if (NULL == t->kx_task)
1951       t->kx_task
1952         = GNUNET_SCHEDULER_add_at (t->next_kx_attempt,
1953                                    &retry_kx,
1954                                    t);
1955     break;
1956   case CADET_TUNNEL_KEY_OK:
1957     /* We are ready. Tell the new channel that we are up. */
1958     GCCH_tunnel_up (ch);
1959     break;
1960   }
1961   return ctn;
1962 }
1963
1964
1965 /**
1966  * We lost a connection, remove it from our list and clean up
1967  * the connection object itself.
1968  *
1969  * @param ct binding of connection to tunnel of the connection that was lost.
1970  */
1971 void
1972 GCT_connection_lost (struct CadetTConnection *ct)
1973 {
1974   struct CadetTunnel *t = ct->t;
1975
1976   if (GNUNET_YES == ct->is_ready)
1977     GNUNET_CONTAINER_DLL_remove (t->connection_ready_head,
1978                                  t->connection_ready_tail,
1979                                  ct);
1980   else
1981     GNUNET_CONTAINER_DLL_remove (t->connection_busy_head,
1982                                  t->connection_busy_tail,
1983                                  ct);
1984   GNUNET_free (ct);
1985 }
1986
1987
1988 /**
1989  * Clean up connection @a ct of a tunnel.
1990  *
1991  * @param cls the `struct CadetTunnel`
1992  * @param ct connection to clean up
1993  */
1994 static void
1995 destroy_t_connection (void *cls,
1996                       struct CadetTConnection *ct)
1997 {
1998   struct CadetTunnel *t = cls;
1999   struct CadetConnection *cc = ct->cc;
2000
2001   GNUNET_assert (ct->t == t);
2002   GCT_connection_lost (ct);
2003   GCC_destroy_without_tunnel (cc);
2004 }
2005
2006
2007 /**
2008  * This tunnel is no longer used, destroy it.
2009  *
2010  * @param cls the idle tunnel
2011  */
2012 static void
2013 destroy_tunnel (void *cls)
2014 {
2015   struct CadetTunnel *t = cls;
2016   struct CadetTunnelQueueEntry *tq;
2017
2018   t->destroy_task = NULL;
2019   LOG (GNUNET_ERROR_TYPE_DEBUG,
2020        "Destroying idle %s\n",
2021        GCT_2s (t));
2022   GNUNET_assert (0 == GCT_count_channels (t));
2023   GCT_iterate_connections (t,
2024                            &destroy_t_connection,
2025                            t);
2026   GNUNET_assert (NULL == t->connection_ready_head);
2027   GNUNET_assert (NULL == t->connection_busy_head);
2028   while (NULL != (tq = t->tq_head))
2029   {
2030     if (NULL != tq->cont)
2031       tq->cont (tq->cont_cls,
2032                 NULL);
2033     GCT_send_cancel (tq);
2034   }
2035   GCP_drop_tunnel (t->destination,
2036                    t);
2037   GNUNET_CONTAINER_multihashmap32_destroy (t->channels);
2038   if (NULL != t->maintain_connections_task)
2039   {
2040     GNUNET_SCHEDULER_cancel (t->maintain_connections_task);
2041     t->maintain_connections_task = NULL;
2042   }
2043   if (NULL != t->send_task)
2044   {
2045     GNUNET_SCHEDULER_cancel (t->send_task);
2046     t->send_task = NULL;
2047   }
2048   if (NULL != t->kx_task)
2049   {
2050     GNUNET_SCHEDULER_cancel (t->kx_task);
2051     t->kx_task = NULL;
2052   }
2053   GNUNET_MST_destroy (t->mst);
2054   GNUNET_MQ_destroy (t->mq);
2055   if (NULL != t->unverified_ax)
2056   {
2057     t->unverified_ax->DHRs = NULL; /* aliased with ax.DHRs */
2058     t->unverified_ax->kx_0 = NULL; /* aliased with ax.DHRs */
2059     cleanup_ax (t->unverified_ax);
2060     GNUNET_free (t->unverified_ax);
2061   }
2062   cleanup_ax (&t->ax);
2063   GNUNET_assert (NULL == t->destroy_task);
2064   GNUNET_free (t);
2065 }
2066
2067
2068 /**
2069  * Remove a channel from a tunnel.
2070  *
2071  * @param t Tunnel.
2072  * @param ch Channel
2073  * @param ctn unique number identifying @a ch within @a t
2074  */
2075 void
2076 GCT_remove_channel (struct CadetTunnel *t,
2077                     struct CadetChannel *ch,
2078                     struct GNUNET_CADET_ChannelTunnelNumber ctn)
2079 {
2080   LOG (GNUNET_ERROR_TYPE_DEBUG,
2081        "Removing %s from %s\n",
2082        GCCH_2s (ch),
2083        GCT_2s (t));
2084   GNUNET_assert (GNUNET_YES ==
2085                  GNUNET_CONTAINER_multihashmap32_remove (t->channels,
2086                                                          ntohl (ctn.cn),
2087                                                          ch));
2088   if ( (0 ==
2089         GCT_count_channels (t)) &&
2090        (NULL == t->destroy_task) )
2091   {
2092     t->destroy_task
2093       = GNUNET_SCHEDULER_add_delayed (IDLE_DESTROY_DELAY,
2094                                       &destroy_tunnel,
2095                                       t);
2096   }
2097 }
2098
2099
2100 /**
2101  * Destroy remaining channels during shutdown.
2102  *
2103  * @param cls the `struct CadetTunnel` of the channel
2104  * @param key key of the channel
2105  * @param value the `struct CadetChannel`
2106  * @return #GNUNET_OK (continue to iterate)
2107  */
2108 static int
2109 destroy_remaining_channels (void *cls,
2110                             uint32_t key,
2111                             void *value)
2112 {
2113   struct CadetChannel *ch = value;
2114
2115   GCCH_handle_remote_destroy (ch,
2116                               NULL);
2117   return GNUNET_OK;
2118 }
2119
2120
2121 /**
2122  * Destroys the tunnel @a t now, without delay. Used during shutdown.
2123  *
2124  * @param t tunnel to destroy
2125  */
2126 void
2127 GCT_destroy_tunnel_now (struct CadetTunnel *t)
2128 {
2129   GNUNET_assert (GNUNET_YES == shutting_down);
2130   GNUNET_CONTAINER_multihashmap32_iterate (t->channels,
2131                                            &destroy_remaining_channels,
2132                                            t);
2133   GNUNET_assert (0 ==
2134                  GCT_count_channels (t));
2135   if (NULL != t->destroy_task)
2136   {
2137     GNUNET_SCHEDULER_cancel (t->destroy_task);
2138     t->destroy_task = NULL;
2139   }
2140   destroy_tunnel (t);
2141 }
2142
2143
2144 /**
2145  * Send normal payload from queue in @a t via connection @a ct.
2146  * Does nothing if our payload queue is empty.
2147  *
2148  * @param t tunnel to send data from
2149  * @param ct connection to use for transmission (is ready)
2150  */
2151 static void
2152 try_send_normal_payload (struct CadetTunnel *t,
2153                          struct CadetTConnection *ct)
2154 {
2155   struct CadetTunnelQueueEntry *tq;
2156
2157   GNUNET_assert (GNUNET_YES == ct->is_ready);
2158   tq = t->tq_head;
2159   if (NULL == tq)
2160   {
2161     /* no messages pending right now */
2162     LOG (GNUNET_ERROR_TYPE_DEBUG,
2163          "Not sending payload of %s on ready %s (nothing pending)\n",
2164          GCT_2s (t),
2165          GCC_2s (ct->cc));
2166     return;
2167   }
2168   /* ready to send message 'tq' on tunnel 'ct' */
2169   GNUNET_assert (t == tq->t);
2170   GNUNET_CONTAINER_DLL_remove (t->tq_head,
2171                                t->tq_tail,
2172                                tq);
2173   if (NULL != tq->cid)
2174     *tq->cid = *GCC_get_id (ct->cc);
2175   mark_connection_unready (ct);
2176   LOG (GNUNET_ERROR_TYPE_DEBUG,
2177        "Sending payload of %s on %s\n",
2178        GCT_2s (t),
2179        GCC_2s (ct->cc));
2180   GCC_transmit (ct->cc,
2181                 tq->env);
2182   if (NULL != tq->cont)
2183     tq->cont (tq->cont_cls,
2184               GCC_get_id (ct->cc));
2185   GNUNET_free (tq);
2186 }
2187
2188
2189 /**
2190  * A connection is @a is_ready for transmission.  Looks at our message
2191  * queue and if there is a message, sends it out via the connection.
2192  *
2193  * @param cls the `struct CadetTConnection` that is @a is_ready
2194  * @param is_ready #GNUNET_YES if connection are now ready,
2195  *                 #GNUNET_NO if connection are no longer ready
2196  */
2197 static void
2198 connection_ready_cb (void *cls,
2199                      int is_ready)
2200 {
2201   struct CadetTConnection *ct = cls;
2202   struct CadetTunnel *t = ct->t;
2203
2204   if (GNUNET_NO == is_ready)
2205   {
2206     LOG (GNUNET_ERROR_TYPE_DEBUG,
2207          "%s no longer ready for %s\n",
2208          GCC_2s (ct->cc),
2209          GCT_2s (t));
2210     mark_connection_unready (ct);
2211     return;
2212   }
2213   GNUNET_assert (GNUNET_NO == ct->is_ready);
2214   GNUNET_CONTAINER_DLL_remove (t->connection_busy_head,
2215                                t->connection_busy_tail,
2216                                ct);
2217   GNUNET_assert (0 < t->num_busy_connections);
2218   t->num_busy_connections--;
2219   ct->is_ready = GNUNET_YES;
2220   GNUNET_CONTAINER_DLL_insert_tail (t->connection_ready_head,
2221                                     t->connection_ready_tail,
2222                                     ct);
2223   t->num_ready_connections++;
2224
2225   LOG (GNUNET_ERROR_TYPE_DEBUG,
2226        "%s now ready for %s in state %s\n",
2227        GCC_2s (ct->cc),
2228        GCT_2s (t),
2229        estate2s (t->estate));
2230   switch (t->estate)
2231   {
2232   case CADET_TUNNEL_KEY_UNINITIALIZED:
2233     /* Do not begin KX if WE have no channels waiting! */
2234     if (0 == GCT_count_channels (t))
2235       return;
2236     /* We are uninitialized, just transmit immediately,
2237        without undue delay. */
2238     if (NULL != t->kx_task)
2239     {
2240       GNUNET_SCHEDULER_cancel (t->kx_task);
2241       t->kx_task = NULL;
2242     }
2243     send_kx (t,
2244              ct,
2245              &t->ax);
2246     break;
2247   case CADET_TUNNEL_KEY_AX_RECV:
2248   case CADET_TUNNEL_KEY_AX_SENT:
2249   case CADET_TUNNEL_KEY_AX_SENT_AND_RECV:
2250   case CADET_TUNNEL_KEY_AX_AUTH_SENT:
2251     /* we're currently waiting for KX to complete, schedule job */
2252     if (NULL == t->kx_task)
2253       t->kx_task
2254         = GNUNET_SCHEDULER_add_at (t->next_kx_attempt,
2255                                    &retry_kx,
2256                                    t);
2257     break;
2258   case CADET_TUNNEL_KEY_OK:
2259     if (GNUNET_YES == t->kx_auth_requested)
2260     {
2261       if (NULL != t->kx_task)
2262       {
2263         GNUNET_SCHEDULER_cancel (t->kx_task);
2264         t->kx_task = NULL;
2265       }
2266       send_kx_auth (t,
2267                     ct,
2268                     &t->ax,
2269                     GNUNET_NO);
2270       return;
2271     }
2272     try_send_normal_payload (t,
2273                              ct);
2274     break;
2275   }
2276 }
2277
2278
2279 /**
2280  * Called when either we have a new connection, or a new message in the
2281  * queue, or some existing connection has transmission capacity.  Looks
2282  * at our message queue and if there is a message, picks a connection
2283  * to send it on.
2284  *
2285  * @param cls the `struct CadetTunnel` to process messages on
2286  */
2287 static void
2288 trigger_transmissions (void *cls)
2289 {
2290   struct CadetTunnel *t = cls;
2291   struct CadetTConnection *ct;
2292
2293   t->send_task = NULL;
2294   if (NULL == t->tq_head)
2295     return; /* no messages pending right now */
2296   ct = get_ready_connection (t);
2297   if (NULL == ct)
2298     return; /* no connections ready */
2299   try_send_normal_payload (t,
2300                            ct);
2301 }
2302
2303
2304 /**
2305  * Closure for #evaluate_connection. Used to assemble summary information
2306  * about the existing connections so we can evaluate a new path.
2307  */
2308 struct EvaluationSummary
2309 {
2310
2311   /**
2312    * Minimum length of any of our connections, `UINT_MAX` if we have none.
2313    */
2314   unsigned int min_length;
2315
2316   /**
2317    * Maximum length of any of our connections, 0 if we have none.
2318    */
2319   unsigned int max_length;
2320
2321   /**
2322    * Minimum desirability of any of our connections, UINT64_MAX if we have none.
2323    */
2324   GNUNET_CONTAINER_HeapCostType min_desire;
2325
2326   /**
2327    * Maximum desirability of any of our connections, 0 if we have none.
2328    */
2329   GNUNET_CONTAINER_HeapCostType max_desire;
2330
2331   /**
2332    * Path we are comparing against for #evaluate_connection, can be NULL.
2333    */
2334   struct CadetPeerPath *path;
2335
2336   /**
2337    * Connection deemed the "worst" so far encountered by #evaluate_connection,
2338    * NULL if we did not yet encounter any connections.
2339    */
2340   struct CadetTConnection *worst;
2341
2342   /**
2343    * Numeric score of @e worst, only set if @e worst is non-NULL.
2344    */
2345   double worst_score;
2346
2347   /**
2348    * Set to #GNUNET_YES if we have a connection over @e path already.
2349    */
2350   int duplicate;
2351
2352 };
2353
2354
2355 /**
2356  * Evaluate a connection, updating our summary information in @a cls about
2357  * what kinds of connections we have.
2358  *
2359  * @param cls the `struct EvaluationSummary *` to update
2360  * @param ct a connection to include in the summary
2361  */
2362 static void
2363 evaluate_connection (void *cls,
2364                      struct CadetTConnection *ct)
2365 {
2366   struct EvaluationSummary *es = cls;
2367   struct CadetConnection *cc = ct->cc;
2368   struct CadetPeerPath *ps = GCC_get_path (cc);
2369   const struct CadetConnectionMetrics *metrics;
2370   GNUNET_CONTAINER_HeapCostType ct_desirability;
2371   struct GNUNET_TIME_Relative uptime;
2372   struct GNUNET_TIME_Relative last_use;
2373   uint32_t ct_length;
2374   double score;
2375   double success_rate;
2376
2377   if (ps == es->path)
2378   {
2379     LOG (GNUNET_ERROR_TYPE_DEBUG,
2380          "Ignoring duplicate path %s.\n",
2381          GCPP_2s (es->path));
2382     es->duplicate = GNUNET_YES;
2383     return;
2384   }
2385   ct_desirability = GCPP_get_desirability (ps);
2386   ct_length = GCPP_get_length (ps);
2387   metrics = GCC_get_metrics (cc);
2388   uptime = GNUNET_TIME_absolute_get_duration (metrics->age);
2389   last_use = GNUNET_TIME_absolute_get_duration (metrics->last_use);
2390   /* We add 1.0 here to avoid division by zero. */
2391   success_rate = (metrics->num_acked_transmissions + 1.0) / (metrics->num_successes + 1.0);
2392   score
2393     = ct_desirability
2394     + 100.0 / (1.0 + ct_length) /* longer paths = better */
2395     + sqrt (uptime.rel_value_us / 60000000LL) /* larger uptime = better */
2396     - last_use.rel_value_us / 1000L;          /* longer idle = worse */
2397   score *= success_rate;        /* weigh overall by success rate */
2398
2399   if ( (NULL == es->worst) ||
2400        (score < es->worst_score) )
2401   {
2402     es->worst = ct;
2403     es->worst_score = score;
2404   }
2405   es->min_length = GNUNET_MIN (es->min_length,
2406                                ct_length);
2407   es->max_length = GNUNET_MAX (es->max_length,
2408                                ct_length);
2409   es->min_desire = GNUNET_MIN (es->min_desire,
2410                                ct_desirability);
2411   es->max_desire = GNUNET_MAX (es->max_desire,
2412                                ct_desirability);
2413 }
2414
2415
2416 /**
2417  * Consider using the path @a p for the tunnel @a t.
2418  * The tunnel destination is at offset @a off in path @a p.
2419  *
2420  * @param cls our tunnel
2421  * @param path a path to our destination
2422  * @param off offset of the destination on path @a path
2423  * @return #GNUNET_YES (should keep iterating)
2424  */
2425 static int
2426 consider_path_cb (void *cls,
2427                   struct CadetPeerPath *path,
2428                   unsigned int off)
2429 {
2430   struct CadetTunnel *t = cls;
2431   struct EvaluationSummary es;
2432   struct CadetTConnection *ct;
2433
2434   GNUNET_assert (off < GCPP_get_length (path));
2435   es.min_length = UINT_MAX;
2436   es.max_length = 0;
2437   es.max_desire = 0;
2438   es.min_desire = UINT64_MAX;
2439   es.path = path;
2440   es.duplicate = GNUNET_NO;
2441   es.worst = NULL;
2442
2443   /* Compute evaluation summary over existing connections. */
2444   GCT_iterate_connections (t,
2445                            &evaluate_connection,
2446                            &es);
2447   if (GNUNET_YES == es.duplicate)
2448     return GNUNET_YES;
2449
2450   /* FIXME: not sure we should really just count
2451      'num_connections' here, as they may all have
2452      consistently failed to connect. */
2453
2454   /* We iterate by increasing path length; if we have enough paths and
2455      this one is more than twice as long than what we are currently
2456      using, then ignore all of these super-long ones! */
2457   if ( (GCT_count_any_connections (t) > DESIRED_CONNECTIONS_PER_TUNNEL) &&
2458        (es.min_length * 2 < off) &&
2459        (es.max_length < off) )
2460   {
2461     LOG (GNUNET_ERROR_TYPE_DEBUG,
2462          "Ignoring paths of length %u, they are way too long.\n",
2463          es.min_length * 2);
2464     return GNUNET_NO;
2465   }
2466   /* If we have enough paths and this one looks no better, ignore it. */
2467   if ( (GCT_count_any_connections (t) >= DESIRED_CONNECTIONS_PER_TUNNEL) &&
2468        (es.min_length < GCPP_get_length (path)) &&
2469        (es.min_desire > GCPP_get_desirability (path)) &&
2470        (es.max_length < off) )
2471   {
2472     LOG (GNUNET_ERROR_TYPE_DEBUG,
2473          "Ignoring path (%u/%llu) to %s, got something better already.\n",
2474          GCPP_get_length (path),
2475          (unsigned long long) GCPP_get_desirability (path),
2476          GCP_2s (t->destination));
2477     return GNUNET_YES;
2478   }
2479
2480   /* Path is interesting (better by some metric, or we don't have
2481      enough paths yet). */
2482   ct = GNUNET_new (struct CadetTConnection);
2483   ct->created = GNUNET_TIME_absolute_get ();
2484   ct->t = t;
2485   ct->cc = GCC_create (t->destination,
2486                        path,
2487                        off,
2488                        GNUNET_CADET_OPTION_DEFAULT, /* FIXME: set based on what channels want/need! */
2489                        ct,
2490                        &connection_ready_cb,
2491                        ct);
2492
2493   /* FIXME: schedule job to kill connection (and path?)  if it takes
2494      too long to get ready! (And track performance data on how long
2495      other connections took with the tunnel!)
2496      => Note: to be done within 'connection'-logic! */
2497   GNUNET_CONTAINER_DLL_insert (t->connection_busy_head,
2498                                t->connection_busy_tail,
2499                                ct);
2500   t->num_busy_connections++;
2501   LOG (GNUNET_ERROR_TYPE_DEBUG,
2502        "Found interesting path %s for %s, created %s\n",
2503        GCPP_2s (path),
2504        GCT_2s (t),
2505        GCC_2s (ct->cc));
2506   return GNUNET_YES;
2507 }
2508
2509
2510 /**
2511  * Function called to maintain the connections underlying our tunnel.
2512  * Tries to maintain (incl. tear down) connections for the tunnel, and
2513  * if there is a significant change, may trigger transmissions.
2514  *
2515  * Basically, needs to check if there are connections that perform
2516  * badly, and if so eventually kill them and trigger a replacement.
2517  * The strategy is to open one more connection than
2518  * #DESIRED_CONNECTIONS_PER_TUNNEL, and then periodically kick out the
2519  * least-performing one, and then inquire for new ones.
2520  *
2521  * @param cls the `struct CadetTunnel`
2522  */
2523 static void
2524 maintain_connections_cb (void *cls)
2525 {
2526   struct CadetTunnel *t = cls;
2527   struct GNUNET_TIME_Relative delay;
2528   struct EvaluationSummary es;
2529
2530   t->maintain_connections_task = NULL;
2531   LOG (GNUNET_ERROR_TYPE_DEBUG,
2532        "Performing connection maintenance for %s.\n",
2533        GCT_2s (t));
2534
2535   es.min_length = UINT_MAX;
2536   es.max_length = 0;
2537   es.max_desire = 0;
2538   es.min_desire = UINT64_MAX;
2539   es.path = NULL;
2540   es.worst = NULL;
2541   es.duplicate = GNUNET_NO;
2542   GCT_iterate_connections (t,
2543                            &evaluate_connection,
2544                            &es);
2545   if ( (NULL != es.worst) &&
2546        (GCT_count_any_connections (t) > DESIRED_CONNECTIONS_PER_TUNNEL) )
2547   {
2548     /* Clear out worst-performing connection 'es.worst'. */
2549     destroy_t_connection (t,
2550                           es.worst);
2551   }
2552
2553   /* Consider additional paths */
2554   (void) GCP_iterate_paths (t->destination,
2555                             &consider_path_cb,
2556                             t);
2557
2558   /* FIXME: calculate when to try again based on how well we are doing;
2559      in particular, if we have to few connections, we might be able
2560      to do without this (as PATHS should tell us whenever a new path
2561      is available instantly; however, need to make sure this job is
2562      restarted after that happens).
2563      Furthermore, if the paths we do know are in a reasonably narrow
2564      quality band and are plentyful, we might also consider us stabilized
2565      and then reduce the frequency accordingly.  */
2566   delay = GNUNET_TIME_UNIT_MINUTES;
2567   t->maintain_connections_task
2568     = GNUNET_SCHEDULER_add_delayed (delay,
2569                                     &maintain_connections_cb,
2570                                     t);
2571 }
2572
2573
2574 /**
2575  * Consider using the path @a p for the tunnel @a t.
2576  * The tunnel destination is at offset @a off in path @a p.
2577  *
2578  * @param cls our tunnel
2579  * @param path a path to our destination
2580  * @param off offset of the destination on path @a path
2581  */
2582 void
2583 GCT_consider_path (struct CadetTunnel *t,
2584                    struct CadetPeerPath *p,
2585                    unsigned int off)
2586 {
2587   (void) consider_path_cb (t,
2588                            p,
2589                            off);
2590 }
2591
2592
2593 /**
2594  * We got a keepalive. Track in statistics.
2595  *
2596  * @param cls the `struct CadetTunnel` for which we decrypted the message
2597  * @param msg  the message we received on the tunnel
2598  */
2599 static void
2600 handle_plaintext_keepalive (void *cls,
2601                             const struct GNUNET_MessageHeader *msg)
2602 {
2603   struct CadetTunnel *t = cls;
2604
2605   LOG (GNUNET_ERROR_TYPE_DEBUG,
2606        "Received KEEPALIVE on %s\n",
2607        GCT_2s (t));
2608   GNUNET_STATISTICS_update (stats,
2609                             "# keepalives received",
2610                             1,
2611                             GNUNET_NO);
2612 }
2613
2614
2615 /**
2616  * Check that @a msg is well-formed.
2617  *
2618  * @param cls the `struct CadetTunnel` for which we decrypted the message
2619  * @param msg  the message we received on the tunnel
2620  * @return #GNUNET_OK (any variable-size payload goes)
2621  */
2622 static int
2623 check_plaintext_data (void *cls,
2624                       const struct GNUNET_CADET_ChannelAppDataMessage *msg)
2625 {
2626   return GNUNET_OK;
2627 }
2628
2629
2630 /**
2631  * We received payload data for a channel.  Locate the channel
2632  * and process the data, or return an error if the channel is unknown.
2633  *
2634  * @param cls the `struct CadetTunnel` for which we decrypted the message
2635  * @param msg the message we received on the tunnel
2636  */
2637 static void
2638 handle_plaintext_data (void *cls,
2639                        const struct GNUNET_CADET_ChannelAppDataMessage *msg)
2640 {
2641   struct CadetTunnel *t = cls;
2642   struct CadetChannel *ch;
2643
2644   ch = lookup_channel (t,
2645                        msg->ctn);
2646   if (NULL == ch)
2647   {
2648     /* We don't know about such a channel, might have been destroyed on our
2649        end in the meantime, or never existed. Send back a DESTROY. */
2650     LOG (GNUNET_ERROR_TYPE_DEBUG,
2651          "Receicved %u bytes of application data for unknown channel %u, sending DESTROY\n",
2652          (unsigned int) (ntohs (msg->header.size) - sizeof (*msg)),
2653          ntohl (msg->ctn.cn));
2654     GCT_send_channel_destroy (t,
2655                               msg->ctn);
2656     return;
2657   }
2658   GCCH_handle_channel_plaintext_data (ch,
2659                                       GCC_get_id (t->current_ct->cc),
2660                                       msg);
2661 }
2662
2663
2664 /**
2665  * We received an acknowledgement for data we sent on a channel.
2666  * Locate the channel and process it, or return an error if the
2667  * channel is unknown.
2668  *
2669  * @param cls the `struct CadetTunnel` for which we decrypted the message
2670  * @param ack the message we received on the tunnel
2671  */
2672 static void
2673 handle_plaintext_data_ack (void *cls,
2674                            const struct GNUNET_CADET_ChannelDataAckMessage *ack)
2675 {
2676   struct CadetTunnel *t = cls;
2677   struct CadetChannel *ch;
2678
2679   ch = lookup_channel (t,
2680                        ack->ctn);
2681   if (NULL == ch)
2682   {
2683     /* We don't know about such a channel, might have been destroyed on our
2684        end in the meantime, or never existed. Send back a DESTROY. */
2685     LOG (GNUNET_ERROR_TYPE_DEBUG,
2686          "Receicved DATA_ACK for unknown channel %u, sending DESTROY\n",
2687          ntohl (ack->ctn.cn));
2688     GCT_send_channel_destroy (t,
2689                               ack->ctn);
2690     return;
2691   }
2692   GCCH_handle_channel_plaintext_data_ack (ch,
2693                                           GCC_get_id (t->current_ct->cc),
2694                                           ack);
2695 }
2696
2697
2698 /**
2699  * We have received a request to open a channel to a port from
2700  * another peer.  Creates the incoming channel.
2701  *
2702  * @param cls the `struct CadetTunnel` for which we decrypted the message
2703  * @param copen the message we received on the tunnel
2704  */
2705 static void
2706 handle_plaintext_channel_open (void *cls,
2707                                const struct GNUNET_CADET_ChannelOpenMessage *copen)
2708 {
2709   struct CadetTunnel *t = cls;
2710   struct CadetChannel *ch;
2711
2712   ch = GNUNET_CONTAINER_multihashmap32_get (t->channels,
2713                                             ntohl (copen->ctn.cn));
2714   if (NULL != ch)
2715   {
2716     LOG (GNUNET_ERROR_TYPE_DEBUG,
2717          "Receicved duplicate channel OPEN on port %s from %s (%s), resending ACK\n",
2718          GNUNET_h2s (&copen->port),
2719          GCT_2s (t),
2720          GCCH_2s (ch));
2721     GCCH_handle_duplicate_open (ch,
2722                                 GCC_get_id (t->current_ct->cc));
2723     return;
2724   }
2725   LOG (GNUNET_ERROR_TYPE_DEBUG,
2726        "Receicved channel OPEN on port %s from %s\n",
2727        GNUNET_h2s (&copen->port),
2728        GCT_2s (t));
2729   ch = GCCH_channel_incoming_new (t,
2730                                   copen->ctn,
2731                                   &copen->port,
2732                                   ntohl (copen->opt));
2733   if (NULL != t->destroy_task)
2734   {
2735     GNUNET_SCHEDULER_cancel (t->destroy_task);
2736     t->destroy_task = NULL;
2737   }
2738   GNUNET_assert (GNUNET_OK ==
2739                  GNUNET_CONTAINER_multihashmap32_put (t->channels,
2740                                                       ntohl (copen->ctn.cn),
2741                                                       ch,
2742                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2743 }
2744
2745
2746 /**
2747  * Send a DESTROY message via the tunnel.
2748  *
2749  * @param t the tunnel to transmit over
2750  * @param ctn ID of the channel to destroy
2751  */
2752 void
2753 GCT_send_channel_destroy (struct CadetTunnel *t,
2754                           struct GNUNET_CADET_ChannelTunnelNumber ctn)
2755 {
2756   struct GNUNET_CADET_ChannelManageMessage msg;
2757
2758   LOG (GNUNET_ERROR_TYPE_DEBUG,
2759        "Sending DESTORY message for channel ID %u\n",
2760        ntohl (ctn.cn));
2761   msg.header.size = htons (sizeof (msg));
2762   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
2763   msg.reserved = htonl (0);
2764   msg.ctn = ctn;
2765   GCT_send (t,
2766             &msg.header,
2767             NULL,
2768             NULL);
2769 }
2770
2771
2772 /**
2773  * We have received confirmation from the target peer that the
2774  * given channel could be established (the port is open).
2775  * Tell the client.
2776  *
2777  * @param cls the `struct CadetTunnel` for which we decrypted the message
2778  * @param cm the message we received on the tunnel
2779  */
2780 static void
2781 handle_plaintext_channel_open_ack (void *cls,
2782                                    const struct GNUNET_CADET_ChannelManageMessage *cm)
2783 {
2784   struct CadetTunnel *t = cls;
2785   struct CadetChannel *ch;
2786
2787   ch = lookup_channel (t,
2788                        cm->ctn);
2789   if (NULL == ch)
2790   {
2791     /* We don't know about such a channel, might have been destroyed on our
2792        end in the meantime, or never existed. Send back a DESTROY. */
2793     LOG (GNUNET_ERROR_TYPE_DEBUG,
2794          "Received channel OPEN_ACK for unknown channel %u, sending DESTROY\n",
2795          ntohl (cm->ctn.cn));
2796     GCT_send_channel_destroy (t,
2797                               cm->ctn);
2798     return;
2799   }
2800   LOG (GNUNET_ERROR_TYPE_DEBUG,
2801        "Received channel OPEN_ACK on channel %s from %s\n",
2802        GCCH_2s (ch),
2803        GCT_2s (t));
2804   GCCH_handle_channel_open_ack (ch,
2805                                 GCC_get_id (t->current_ct->cc));
2806 }
2807
2808
2809 /**
2810  * We received a message saying that a channel should be destroyed.
2811  * Pass it on to the correct channel.
2812  *
2813  * @param cls the `struct CadetTunnel` for which we decrypted the message
2814  * @param cm the message we received on the tunnel
2815  */
2816 static void
2817 handle_plaintext_channel_destroy (void *cls,
2818                                   const struct GNUNET_CADET_ChannelManageMessage *cm)
2819 {
2820   struct CadetTunnel *t = cls;
2821   struct CadetChannel *ch;
2822
2823   ch = lookup_channel (t,
2824                        cm->ctn);
2825   if (NULL == ch)
2826   {
2827     /* We don't know about such a channel, might have been destroyed on our
2828        end in the meantime, or never existed. */
2829     LOG (GNUNET_ERROR_TYPE_DEBUG,
2830          "Received channel DESTORY for unknown channel %u. Ignoring.\n",
2831          ntohl (cm->ctn.cn));
2832     return;
2833   }
2834   LOG (GNUNET_ERROR_TYPE_DEBUG,
2835        "Receicved channel DESTROY on %s from %s\n",
2836        GCCH_2s (ch),
2837        GCT_2s (t));
2838   GCCH_handle_remote_destroy (ch,
2839                               GCC_get_id (t->current_ct->cc));
2840 }
2841
2842
2843 /**
2844  * Handles a message we decrypted, by injecting it into
2845  * our message queue (which will do the dispatching).
2846  *
2847  * @param cls the `struct CadetTunnel` that got the message
2848  * @param msg the message
2849  * @return #GNUNET_OK (continue to process)
2850  */
2851 static int
2852 handle_decrypted (void *cls,
2853                   const struct GNUNET_MessageHeader *msg)
2854 {
2855   struct CadetTunnel *t = cls;
2856
2857   GNUNET_assert (NULL != t->current_ct);
2858   GNUNET_MQ_inject_message (t->mq,
2859                             msg);
2860   return GNUNET_OK;
2861 }
2862
2863
2864 /**
2865  * Function called if we had an error processing
2866  * an incoming decrypted message.
2867  *
2868  * @param cls the `struct CadetTunnel`
2869  * @param error error code
2870  */
2871 static void
2872 decrypted_error_cb (void *cls,
2873                     enum GNUNET_MQ_Error error)
2874 {
2875   GNUNET_break_op (0);
2876 }
2877
2878
2879 /**
2880  * Create a tunnel to @a destionation.  Must only be called
2881  * from within #GCP_get_tunnel().
2882  *
2883  * @param destination where to create the tunnel to
2884  * @return new tunnel to @a destination
2885  */
2886 struct CadetTunnel *
2887 GCT_create_tunnel (struct CadetPeer *destination)
2888 {
2889   struct CadetTunnel *t = GNUNET_new (struct CadetTunnel);
2890   struct GNUNET_MQ_MessageHandler handlers[] = {
2891     GNUNET_MQ_hd_fixed_size (plaintext_keepalive,
2892                              GNUNET_MESSAGE_TYPE_CADET_CHANNEL_KEEPALIVE,
2893                              struct GNUNET_MessageHeader,
2894                              t),
2895     GNUNET_MQ_hd_var_size (plaintext_data,
2896                            GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA,
2897                            struct GNUNET_CADET_ChannelAppDataMessage,
2898                            t),
2899     GNUNET_MQ_hd_fixed_size (plaintext_data_ack,
2900                              GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA_ACK,
2901                              struct GNUNET_CADET_ChannelDataAckMessage,
2902                              t),
2903     GNUNET_MQ_hd_fixed_size (plaintext_channel_open,
2904                              GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN,
2905                              struct GNUNET_CADET_ChannelOpenMessage,
2906                              t),
2907     GNUNET_MQ_hd_fixed_size (plaintext_channel_open_ack,
2908                              GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_ACK,
2909                              struct GNUNET_CADET_ChannelManageMessage,
2910                              t),
2911     GNUNET_MQ_hd_fixed_size (plaintext_channel_destroy,
2912                              GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY,
2913                              struct GNUNET_CADET_ChannelManageMessage,
2914                              t),
2915     GNUNET_MQ_handler_end ()
2916   };
2917
2918   t->kx_retry_delay = INITIAL_KX_RETRY_DELAY;
2919   new_ephemeral (&t->ax);
2920   t->ax.kx_0 = GNUNET_CRYPTO_ecdhe_key_create ();
2921   t->destination = destination;
2922   t->channels = GNUNET_CONTAINER_multihashmap32_create (8);
2923   t->maintain_connections_task
2924     = GNUNET_SCHEDULER_add_now (&maintain_connections_cb,
2925                                 t);
2926   t->mq = GNUNET_MQ_queue_for_callbacks (NULL,
2927                                          NULL,
2928                                          NULL,
2929                                          NULL,
2930                                          handlers,
2931                                          &decrypted_error_cb,
2932                                          t);
2933   t->mst = GNUNET_MST_create (&handle_decrypted,
2934                               t);
2935   return t;
2936 }
2937
2938
2939 /**
2940  * Add a @a connection to the @a tunnel.
2941  *
2942  * @param t a tunnel
2943  * @param cid connection identifer to use for the connection
2944  * @param options options for the connection
2945  * @param path path to use for the connection
2946  * @return #GNUNET_OK on success,
2947  *         #GNUNET_SYSERR on failure (duplicate connection)
2948  */
2949 int
2950 GCT_add_inbound_connection (struct CadetTunnel *t,
2951                             const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid,
2952                             enum GNUNET_CADET_ChannelOption options,
2953                             struct CadetPeerPath *path)
2954 {
2955   struct CadetTConnection *ct;
2956
2957   ct = GNUNET_new (struct CadetTConnection);
2958   ct->created = GNUNET_TIME_absolute_get ();
2959   ct->t = t;
2960   ct->cc = GCC_create_inbound (t->destination,
2961                                path,
2962                                options,
2963                                ct,
2964                                cid,
2965                                &connection_ready_cb,
2966                                ct);
2967   if (NULL == ct->cc)
2968   {
2969     LOG (GNUNET_ERROR_TYPE_DEBUG,
2970          "%s refused inbound %s (duplicate)\n",
2971          GCT_2s (t),
2972          GCC_2s (ct->cc));
2973     GNUNET_free (ct);
2974     return GNUNET_SYSERR;
2975   }
2976   /* FIXME: schedule job to kill connection (and path?)  if it takes
2977      too long to get ready! (And track performance data on how long
2978      other connections took with the tunnel!)
2979      => Note: to be done within 'connection'-logic! */
2980   GNUNET_CONTAINER_DLL_insert (t->connection_busy_head,
2981                                t->connection_busy_tail,
2982                                ct);
2983   t->num_busy_connections++;
2984   LOG (GNUNET_ERROR_TYPE_DEBUG,
2985        "%s has new %s\n",
2986        GCT_2s (t),
2987        GCC_2s (ct->cc));
2988   return GNUNET_OK;
2989 }
2990
2991
2992 /**
2993  * Handle encrypted message.
2994  *
2995  * @param ct connection/tunnel combo that received encrypted message
2996  * @param msg the encrypted message to decrypt
2997  */
2998 void
2999 GCT_handle_encrypted (struct CadetTConnection *ct,
3000                       const struct GNUNET_CADET_TunnelEncryptedMessage *msg)
3001 {
3002   struct CadetTunnel *t = ct->t;
3003   uint16_t size = ntohs (msg->header.size);
3004   char cbuf [size] GNUNET_ALIGN;
3005   ssize_t decrypted_size;
3006
3007   LOG (GNUNET_ERROR_TYPE_DEBUG,
3008        "%s received %u bytes of encrypted data in state %d\n",
3009        GCT_2s (t),
3010        (unsigned int) size,
3011        t->estate);
3012
3013   switch (t->estate)
3014   {
3015   case CADET_TUNNEL_KEY_UNINITIALIZED:
3016   case CADET_TUNNEL_KEY_AX_RECV:
3017     /* We did not even SEND our KX, how can the other peer
3018        send us encrypted data? */
3019     GNUNET_break_op (0);
3020     return;
3021   case CADET_TUNNEL_KEY_AX_SENT_AND_RECV:
3022     /* We send KX, and other peer send KX to us at the same time.
3023        Neither KX is AUTH'ed, so let's try KX_AUTH this time. */
3024     GNUNET_STATISTICS_update (stats,
3025                               "# received encrypted without KX_AUTH",
3026                               1,
3027                               GNUNET_NO);
3028     if (NULL != t->kx_task)
3029     {
3030       GNUNET_SCHEDULER_cancel (t->kx_task);
3031       t->kx_task = NULL;
3032     }
3033     send_kx_auth (t,
3034                   ct,
3035                   &t->ax,
3036                   GNUNET_YES);
3037     return;
3038   case CADET_TUNNEL_KEY_AX_SENT:
3039     /* We did not get the KX of the other peer, but that
3040        might have been lost.  Send our KX again immediately. */
3041     GNUNET_STATISTICS_update (stats,
3042                               "# received encrypted without KX",
3043                               1,
3044                               GNUNET_NO);
3045     if (NULL != t->kx_task)
3046     {
3047       GNUNET_SCHEDULER_cancel (t->kx_task);
3048       t->kx_task = NULL;
3049     }
3050     send_kx (t,
3051              ct,
3052              &t->ax);
3053     return;
3054   case CADET_TUNNEL_KEY_AX_AUTH_SENT:
3055     /* Great, first payload, we might graduate to OK! */
3056   case CADET_TUNNEL_KEY_OK:
3057     /* We are up and running, all good. */
3058     break;
3059   }
3060
3061   GNUNET_STATISTICS_update (stats,
3062                             "# received encrypted",
3063                             1,
3064                             GNUNET_NO);
3065   decrypted_size = -1;
3066   if (CADET_TUNNEL_KEY_OK == t->estate)
3067   {
3068     /* We have well-established key material available,
3069        try that. (This is the common case.) */
3070     decrypted_size = t_ax_decrypt_and_validate (&t->ax,
3071                                                 cbuf,
3072                                                 msg,
3073                                                 size);
3074   }
3075
3076   if ( (-1 == decrypted_size) &&
3077        (NULL != t->unverified_ax) )
3078   {
3079     /* We have un-authenticated KX material available. We should try
3080        this as a back-up option, in case the sender crashed and
3081        switched keys. */
3082     decrypted_size = t_ax_decrypt_and_validate (t->unverified_ax,
3083                                                 cbuf,
3084                                                 msg,
3085                                                 size);
3086     if (-1 != decrypted_size)
3087     {
3088       /* It worked! Treat this as authentication of the AX data! */
3089       t->ax.DHRs = NULL; /* aliased with ax.DHRs */
3090       t->ax.kx_0 = NULL; /* aliased with ax.DHRs */
3091       cleanup_ax (&t->ax);
3092       t->ax = *t->unverified_ax;
3093       GNUNET_free (t->unverified_ax);
3094       t->unverified_ax = NULL;
3095     }
3096     if (CADET_TUNNEL_KEY_AX_AUTH_SENT == t->estate)
3097     {
3098       /* First time it worked, move tunnel into production! */
3099       GCT_change_estate (t,
3100                          CADET_TUNNEL_KEY_OK);
3101       if (NULL != t->send_task)
3102         GNUNET_SCHEDULER_cancel (t->send_task);
3103       t->send_task = GNUNET_SCHEDULER_add_now (&trigger_transmissions,
3104                                                t);
3105     }
3106   }
3107   if (NULL != t->unverified_ax)
3108   {
3109     /* We had unverified KX material that was useless; so increment
3110        counter and eventually move to ignore it.  Note that we even do
3111        this increment if we successfully decrypted with the old KX
3112        material and thus didn't even both with the new one.  This is
3113        the ideal case, as a malicious injection of bogus KX data
3114        basically only causes us to increment a counter a few times. */
3115     t->unverified_attempts++;
3116     LOG (GNUNET_ERROR_TYPE_DEBUG,
3117          "Failed to decrypt message with unverified KX data %u times\n",
3118          t->unverified_attempts);
3119     if (t->unverified_attempts > MAX_UNVERIFIED_ATTEMPTS)
3120     {
3121       t->unverified_ax->DHRs = NULL; /* aliased with ax.DHRs */
3122       t->unverified_ax->kx_0 = NULL; /* aliased with ax.DHRs */
3123       cleanup_ax (t->unverified_ax);
3124       GNUNET_free (t->unverified_ax);
3125       t->unverified_ax = NULL;
3126     }
3127   }
3128
3129   if (-1 == decrypted_size)
3130   {
3131     /* Decryption failed for good, complain. */
3132     GNUNET_break_op (0);
3133     LOG (GNUNET_ERROR_TYPE_WARNING,
3134          "%s failed to decrypt and validate encrypted data\n",
3135          GCT_2s (t));
3136     GNUNET_STATISTICS_update (stats,
3137                               "# unable to decrypt",
3138                               1,
3139                               GNUNET_NO);
3140     return;
3141   }
3142
3143   /* The MST will ultimately call #handle_decrypted() on each message. */
3144   t->current_ct = ct;
3145   GNUNET_break_op (GNUNET_OK ==
3146                    GNUNET_MST_from_buffer (t->mst,
3147                                            cbuf,
3148                                            decrypted_size,
3149                                            GNUNET_YES,
3150                                            GNUNET_NO));
3151   t->current_ct = NULL;
3152 }
3153
3154
3155 /**
3156  * Sends an already built message on a tunnel, encrypting it and
3157  * choosing the best connection if not provided.
3158  *
3159  * @param message Message to send. Function modifies it.
3160  * @param t Tunnel on which this message is transmitted.
3161  * @param cont Continuation to call once message is really sent.
3162  * @param cont_cls Closure for @c cont.
3163  * @return Handle to cancel message
3164  */
3165 struct CadetTunnelQueueEntry *
3166 GCT_send (struct CadetTunnel *t,
3167           const struct GNUNET_MessageHeader *message,
3168           GCT_SendContinuation cont,
3169           void *cont_cls)
3170 {
3171   struct CadetTunnelQueueEntry *tq;
3172   uint16_t payload_size;
3173   struct GNUNET_MQ_Envelope *env;
3174   struct GNUNET_CADET_TunnelEncryptedMessage *ax_msg;
3175
3176   if (CADET_TUNNEL_KEY_OK != t->estate)
3177   {
3178     GNUNET_break (0);
3179     return NULL;
3180   }
3181   payload_size = ntohs (message->size);
3182   LOG (GNUNET_ERROR_TYPE_DEBUG,
3183        "Encrypting %u bytes for %s\n",
3184        (unsigned int) payload_size,
3185        GCT_2s (t));
3186   env = GNUNET_MQ_msg_extra (ax_msg,
3187                              payload_size,
3188                              GNUNET_MESSAGE_TYPE_CADET_TUNNEL_ENCRYPTED);
3189   t_ax_encrypt (&t->ax,
3190                 &ax_msg[1],
3191                 message,
3192                 payload_size);
3193   ax_msg->ax_header.Ns = htonl (t->ax.Ns++);
3194   ax_msg->ax_header.PNs = htonl (t->ax.PNs);
3195   /* FIXME: we should do this once, not once per message;
3196      this is a point multiplication, and DHRs does not
3197      change all the time. */
3198   GNUNET_CRYPTO_ecdhe_key_get_public (t->ax.DHRs,
3199                                       &ax_msg->ax_header.DHRs);
3200   t_h_encrypt (&t->ax,
3201                ax_msg);
3202   t_hmac (&ax_msg->ax_header,
3203           sizeof (struct GNUNET_CADET_AxHeader) + payload_size,
3204           0,
3205           &t->ax.HKs,
3206           &ax_msg->hmac);
3207
3208   tq = GNUNET_malloc (sizeof (*tq));
3209   tq->t = t;
3210   tq->env = env;
3211   tq->cid = &ax_msg->cid; /* will initialize 'ax_msg->cid' once we know the connection */
3212   tq->cont = cont;
3213   tq->cont_cls = cont_cls;
3214   GNUNET_CONTAINER_DLL_insert_tail (t->tq_head,
3215                                     t->tq_tail,
3216                                     tq);
3217   if (NULL != t->send_task)
3218     GNUNET_SCHEDULER_cancel (t->send_task);
3219   t->send_task
3220     = GNUNET_SCHEDULER_add_now (&trigger_transmissions,
3221                                 t);
3222   return tq;
3223 }
3224
3225
3226 /**
3227  * Cancel a previously sent message while it's in the queue.
3228  *
3229  * ONLY can be called before the continuation given to the send
3230  * function is called. Once the continuation is called, the message is
3231  * no longer in the queue!
3232  *
3233  * @param tq Handle to the queue entry to cancel.
3234  */
3235 void
3236 GCT_send_cancel (struct CadetTunnelQueueEntry *tq)
3237 {
3238   struct CadetTunnel *t = tq->t;
3239
3240   GNUNET_CONTAINER_DLL_remove (t->tq_head,
3241                                t->tq_tail,
3242                                tq);
3243   GNUNET_MQ_discard (tq->env);
3244   GNUNET_free (tq);
3245 }
3246
3247
3248 /**
3249  * Iterate over all connections of a tunnel.
3250  *
3251  * @param t Tunnel whose connections to iterate.
3252  * @param iter Iterator.
3253  * @param iter_cls Closure for @c iter.
3254  */
3255 void
3256 GCT_iterate_connections (struct CadetTunnel *t,
3257                          GCT_ConnectionIterator iter,
3258                          void *iter_cls)
3259 {
3260   struct CadetTConnection *n;
3261   for (struct CadetTConnection *ct = t->connection_ready_head;
3262        NULL != ct;
3263        ct = n)
3264   {
3265     n = ct->next;
3266     iter (iter_cls,
3267           ct);
3268   }
3269   for (struct CadetTConnection *ct = t->connection_busy_head;
3270        NULL != ct;
3271        ct = n)
3272   {
3273     n = ct->next;
3274     iter (iter_cls,
3275           ct);
3276   }
3277 }
3278
3279
3280 /**
3281  * Closure for #iterate_channels_cb.
3282  */
3283 struct ChanIterCls
3284 {
3285   /**
3286    * Function to call.
3287    */
3288   GCT_ChannelIterator iter;
3289
3290   /**
3291    * Closure for @e iter.
3292    */
3293   void *iter_cls;
3294 };
3295
3296
3297 /**
3298  * Helper function for #GCT_iterate_channels.
3299  *
3300  * @param cls the `struct ChanIterCls`
3301  * @param key unused
3302  * @param value a `struct CadetChannel`
3303  * @return #GNUNET_OK
3304  */
3305 static int
3306 iterate_channels_cb (void *cls,
3307                      uint32_t key,
3308                      void *value)
3309 {
3310   struct ChanIterCls *ctx = cls;
3311   struct CadetChannel *ch = value;
3312
3313   ctx->iter (ctx->iter_cls,
3314              ch);
3315   return GNUNET_OK;
3316 }
3317
3318
3319 /**
3320  * Iterate over all channels of a tunnel.
3321  *
3322  * @param t Tunnel whose channels to iterate.
3323  * @param iter Iterator.
3324  * @param iter_cls Closure for @c iter.
3325  */
3326 void
3327 GCT_iterate_channels (struct CadetTunnel *t,
3328                       GCT_ChannelIterator iter,
3329                       void *iter_cls)
3330 {
3331   struct ChanIterCls ctx;
3332
3333   ctx.iter = iter;
3334   ctx.iter_cls = iter_cls;
3335   GNUNET_CONTAINER_multihashmap32_iterate (t->channels,
3336                                            &iterate_channels_cb,
3337                                            &ctx);
3338
3339 }
3340
3341
3342 /**
3343  * Call #GCCH_debug() on a channel.
3344  *
3345  * @param cls points to the log level to use
3346  * @param key unused
3347  * @param value the `struct CadetChannel` to dump
3348  * @return #GNUNET_OK (continue iteration)
3349  */
3350 static int
3351 debug_channel (void *cls,
3352                uint32_t key,
3353                void *value)
3354 {
3355   const enum GNUNET_ErrorType *level = cls;
3356   struct CadetChannel *ch = value;
3357
3358   GCCH_debug (ch, *level);
3359   return GNUNET_OK;
3360 }
3361
3362
3363 #define LOG2(level, ...) GNUNET_log_from_nocheck(level,"cadet-tun",__VA_ARGS__)
3364
3365
3366 /**
3367  * Log all possible info about the tunnel state.
3368  *
3369  * @param t Tunnel to debug.
3370  * @param level Debug level to use.
3371  */
3372 void
3373 GCT_debug (const struct CadetTunnel *t,
3374            enum GNUNET_ErrorType level)
3375 {
3376   struct CadetTConnection *iter_c;
3377   int do_log;
3378
3379   do_log = GNUNET_get_log_call_status (level & (~GNUNET_ERROR_TYPE_BULK),
3380                                        "cadet-tun",
3381                                        __FILE__, __FUNCTION__, __LINE__);
3382   if (0 == do_log)
3383     return;
3384
3385   LOG2 (level,
3386         "TTT TUNNEL TOWARDS %s in estate %s tq_len: %u #cons: %u\n",
3387         GCT_2s (t),
3388         estate2s (t->estate),
3389         t->tq_len,
3390         GCT_count_any_connections (t));
3391   LOG2 (level,
3392         "TTT channels:\n");
3393   GNUNET_CONTAINER_multihashmap32_iterate (t->channels,
3394                                            &debug_channel,
3395                                            &level);
3396   LOG2 (level,
3397         "TTT connections:\n");
3398   for (iter_c = t->connection_ready_head; NULL != iter_c; iter_c = iter_c->next)
3399     GCC_debug (iter_c->cc,
3400                level);
3401   for (iter_c = t->connection_busy_head; NULL != iter_c; iter_c = iter_c->next)
3402     GCC_debug (iter_c->cc,
3403                level);
3404
3405   LOG2 (level,
3406         "TTT TUNNEL END\n");
3407 }
3408
3409
3410 /* end of gnunet-service-cadet-new_tunnels.c */