2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
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.
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.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 #include "gnunet_util_lib.h"
24 #include "gnunet_signatures.h"
25 #include "gnunet_statistics_service.h"
27 #include "cadet_protocol.h"
28 #include "cadet_path.h"
30 #include "gnunet-service-cadet_tunnel.h"
31 #include "gnunet-service-cadet_connection.h"
32 #include "gnunet-service-cadet_channel.h"
33 #include "gnunet-service-cadet_peer.h"
35 #define LOG(level, ...) GNUNET_log_from(level,"cadet-tun",__VA_ARGS__)
36 #define LOG2(level, ...) GNUNET_log_from_nocheck(level,"cadet-tun",__VA_ARGS__)
38 #define REKEY_WAIT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 5)
40 #define CONNECTIONS_PER_TUNNEL 3
42 #if !defined(GNUNET_CULL_LOGGING)
43 #define DUMP_KEYS_TO_STDERR GNUNET_YES
45 #define DUMP_KEYS_TO_STDERR GNUNET_NO
48 /******************************************************************************/
49 /******************************** STRUCTS **********************************/
50 /******************************************************************************/
54 struct CadetTChannel *next;
55 struct CadetTChannel *prev;
56 struct CadetChannel *ch;
61 * Connection list and metadata.
63 struct CadetTConnection
68 struct CadetTConnection *next;
73 struct CadetTConnection *prev;
78 struct CadetConnection *c;
81 * Creation time, to keep oldest connection alive.
83 struct GNUNET_TIME_Absolute created;
86 * Connection throughput, to keep fastest connection alive.
92 * Structure used during a Key eXchange.
94 struct CadetTunnelKXCtx
97 * Encryption ("our") old "confirmed" key, for encrypting traffic sent by us
98 * end before the key exchange is finished or times out.
100 struct GNUNET_CRYPTO_SymmetricSessionKey e_key_old;
103 * Decryption ("their") old "confirmed" key, for decrypting traffic sent by
104 * the other end before the key exchange started.
106 struct GNUNET_CRYPTO_SymmetricSessionKey d_key_old;
109 * Challenge to send in a ping and expect in the pong.
114 * When the rekey started. One minute after this the new key will be used.
116 struct GNUNET_TIME_Absolute rekey_start_time;
119 * Task for delayed destruction of the Key eXchange context, to allow delayed
120 * messages with the old key to be decrypted successfully.
122 GNUNET_SCHEDULER_TaskIdentifier finish_task;
126 * Struct containing all information regarding a tunnel to a peer.
131 * Endpoint of the tunnel.
133 struct CadetPeer *peer;
136 * State of the tunnel connectivity.
138 enum CadetTunnelCState cstate;
141 * State of the tunnel encryption.
143 enum CadetTunnelEState estate;
146 * Key eXchange context.
148 struct CadetTunnelKXCtx *kx_ctx;
151 * Peer's ephemeral key, to recreate @c e_key and @c d_key when own ephemeral
154 struct GNUNET_CRYPTO_EcdhePublicKey peers_ephemeral_key;
157 * Encryption ("our") key. It is only "confirmed" if kx_ctx is NULL.
159 struct GNUNET_CRYPTO_SymmetricSessionKey e_key;
162 * Decryption ("their") key. It is only "confirmed" if kx_ctx is NULL.
164 struct GNUNET_CRYPTO_SymmetricSessionKey d_key;
167 * Task to start the rekey process.
169 GNUNET_SCHEDULER_TaskIdentifier rekey_task;
172 * Paths that are actively used to reach the destination peer.
174 struct CadetTConnection *connection_head;
175 struct CadetTConnection *connection_tail;
178 * Next connection number.
183 * Channels inside this tunnel.
185 struct CadetTChannel *channel_head;
186 struct CadetTChannel *channel_tail;
189 * Channel ID for the next created channel.
191 CADET_ChannelNumber next_chid;
194 * Destroy flag: if true, destroy on last message.
196 GNUNET_SCHEDULER_TaskIdentifier destroy_task;
199 * Queued messages, to transmit once tunnel gets connected.
201 struct CadetTunnelDelayed *tq_head;
202 struct CadetTunnelDelayed *tq_tail;
205 * Task to trim connections if too many are present.
207 GNUNET_SCHEDULER_TaskIdentifier trim_connections_task;
212 * Struct used to save messages in a non-ready tunnel to send once connected.
214 struct CadetTunnelDelayed
219 struct CadetTunnelDelayed *next;
220 struct CadetTunnelDelayed *prev;
225 struct CadetTunnel *t;
228 * Tunnel queue given to the channel to cancel request. Update on send_queued.
230 struct CadetTunnelQueue *tq;
235 /* struct GNUNET_MessageHeader *msg; */
240 * Handle for messages queued but not yet sent.
242 struct CadetTunnelQueue
245 * Connection queue handle, to cancel if necessary.
247 struct CadetConnectionQueue *cq;
250 * Handle in case message hasn't been given to a connection yet.
252 struct CadetTunnelDelayed *tqd;
255 * Continuation to call once sent.
260 * Closure for @c cont.
266 /******************************************************************************/
267 /******************************* GLOBALS ***********************************/
268 /******************************************************************************/
271 * Global handle to the statistics service.
273 extern struct GNUNET_STATISTICS_Handle *stats;
276 * Local peer own ID (memory efficient handle).
278 extern GNUNET_PEER_Id myid;
281 * Local peer own ID (full value).
283 extern struct GNUNET_PeerIdentity my_full_id;
287 * Don't try to recover tunnels if shutting down.
289 extern int shutting_down;
293 * Set of all tunnels, in order to trigger a new exchange on rekey.
294 * Indexed by peer's ID.
296 static struct GNUNET_CONTAINER_MultiPeerMap *tunnels;
299 * Default TTL for payload packets.
301 static unsigned long long default_ttl;
306 const static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
309 * Own ephemeral private key.
311 static struct GNUNET_CRYPTO_EcdhePrivateKey *my_ephemeral_key;
314 * Cached message used to perform a key exchange.
316 static struct GNUNET_CADET_KX_Ephemeral kx_msg;
319 * Task to generate a new ephemeral key.
321 static GNUNET_SCHEDULER_TaskIdentifier rekey_task;
326 static struct GNUNET_TIME_Relative rekey_period;
328 /******************************************************************************/
329 /******************************** STATIC ***********************************/
330 /******************************************************************************/
333 * Get string description for tunnel connectivity state.
335 * @param cs Tunnel state.
337 * @return String representation.
340 cstate2s (enum CadetTunnelCState cs)
346 case CADET_TUNNEL_NEW:
347 return "CADET_TUNNEL_NEW";
348 case CADET_TUNNEL_SEARCHING:
349 return "CADET_TUNNEL_SEARCHING";
350 case CADET_TUNNEL_WAITING:
351 return "CADET_TUNNEL_WAITING";
352 case CADET_TUNNEL_READY:
353 return "CADET_TUNNEL_READY";
354 case CADET_TUNNEL_SHUTDOWN:
355 return "CADET_TUNNEL_SHUTDOWN";
357 sprintf (buf, "%u (UNKNOWN STATE)", cs);
365 * Get string description for tunnel encryption state.
367 * @param es Tunnel state.
369 * @return String representation.
372 estate2s (enum CadetTunnelEState es)
378 case CADET_TUNNEL_KEY_UNINITIALIZED:
379 return "CADET_TUNNEL_KEY_UNINITIALIZED";
380 case CADET_TUNNEL_KEY_SENT:
381 return "CADET_TUNNEL_KEY_SENT";
382 case CADET_TUNNEL_KEY_PING:
383 return "CADET_TUNNEL_KEY_PING";
384 case CADET_TUNNEL_KEY_OK:
385 return "CADET_TUNNEL_KEY_OK";
386 case CADET_TUNNEL_KEY_REKEY:
387 return "CADET_TUNNEL_KEY_REKEY";
389 sprintf (buf, "%u (UNKNOWN STATE)", es);
397 * @brief Check if tunnel is ready to send traffic.
399 * Tunnel must be connected and with encryption correctly set up.
401 * @param t Tunnel to check.
403 * @return #GNUNET_YES if ready, #GNUNET_NO otherwise
406 is_ready (struct CadetTunnel *t)
410 GCT_debug (t, GNUNET_ERROR_TYPE_DEBUG);
411 ready = CADET_TUNNEL_READY == t->cstate
412 && (CADET_TUNNEL_KEY_OK == t->estate
413 || CADET_TUNNEL_KEY_REKEY == t->estate);
414 ready = ready || GCT_is_loopback (t);
420 * Check if a key is invalid (NULL pointer or all 0)
422 * @param key Key to check.
424 * @return #GNUNET_YES if key is null, #GNUNET_NO if exists and is not 0.
427 is_key_null (struct GNUNET_CRYPTO_SymmetricSessionKey *key)
429 struct GNUNET_CRYPTO_SymmetricSessionKey null_key;
434 memset (&null_key, 0, sizeof (null_key));
435 if (0 == memcmp (key, &null_key, sizeof (null_key)))
442 * Ephemeral key message purpose size.
444 * @return Size of the part of the ephemeral key message that must be signed.
447 ephemeral_purpose_size (void)
449 return sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
450 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
451 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
452 sizeof (struct GNUNET_CRYPTO_EcdhePublicKey) +
453 sizeof (struct GNUNET_PeerIdentity);
458 * Size of the encrypted part of a ping message.
460 * @return Size of the encrypted part of a ping message.
463 ping_encryption_size (void)
465 return sizeof (struct GNUNET_PeerIdentity) + sizeof (uint32_t);
470 * Get the channel's buffer. ONLY FOR NON-LOOPBACK CHANNELS!!
472 * @param tch Tunnel's channel handle.
474 * @return Amount of messages the channel can still buffer towards the client.
477 get_channel_buffer (const struct CadetTChannel *tch)
481 /* If channel is outgoing, is origin in the FWD direction and fwd is YES */
482 fwd = GCCH_is_origin (tch->ch, GNUNET_YES);
484 return GCCH_get_buffer (tch->ch, fwd);
489 * Get the channel's allowance status.
491 * @param tch Tunnel's channel handle.
493 * @return #GNUNET_YES if we allowed the client to send data to us.
496 get_channel_allowed (const struct CadetTChannel *tch)
500 /* If channel is outgoing, is origin in the FWD direction and fwd is YES */
501 fwd = GCCH_is_origin (tch->ch, GNUNET_YES);
503 return GCCH_get_allowed (tch->ch, fwd);
508 * Get the connection's buffer.
510 * @param tc Tunnel's connection handle.
512 * @return Amount of messages the connection can still buffer.
515 get_connection_buffer (const struct CadetTConnection *tc)
519 /* If connection is outgoing, is origin in the FWD direction and fwd is YES */
520 fwd = GCC_is_origin (tc->c, GNUNET_YES);
522 return GCC_get_buffer (tc->c, fwd);
527 * Get the connection's allowance.
529 * @param tc Tunnel's connection handle.
531 * @return Amount of messages we have allowed the next peer to send us.
534 get_connection_allowed (const struct CadetTConnection *tc)
538 /* If connection is outgoing, is origin in the FWD direction and fwd is YES */
539 fwd = GCC_is_origin (tc->c, GNUNET_YES);
541 return GCC_get_allowed (tc->c, fwd);
546 * Check that a ephemeral key message s well formed and correctly signed.
548 * @param t Tunnel on which the message came.
549 * @param msg The ephemeral key message.
551 * @return GNUNET_OK if message is fine, GNUNET_SYSERR otherwise.
554 check_ephemeral (struct CadetTunnel *t,
555 const struct GNUNET_CADET_KX_Ephemeral *msg)
557 /* Check message size */
558 if (ntohs (msg->header.size) != sizeof (struct GNUNET_CADET_KX_Ephemeral))
559 return GNUNET_SYSERR;
561 /* Check signature size */
562 if (ntohl (msg->purpose.size) != ephemeral_purpose_size ())
563 return GNUNET_SYSERR;
566 if (0 != memcmp (&msg->origin_identity,
567 GCP_get_id (t->peer),
568 sizeof (struct GNUNET_PeerIdentity)))
569 return GNUNET_SYSERR;
571 /* Check signature */
573 GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_CADET_KX,
576 &msg->origin_identity.public_key))
577 return GNUNET_SYSERR;
584 * Select the best key to use for encryption (send), based on KX status.
586 * Normally, return the current key. If there is a KX in progress and the old
587 * key is fresh enough, return the old key.
589 * @param t Tunnel to choose the key from.
591 * @return The optimal key to encrypt/hmac outgoing traffic.
593 static const struct GNUNET_CRYPTO_SymmetricSessionKey *
594 select_key (const struct CadetTunnel *t)
596 const struct GNUNET_CRYPTO_SymmetricSessionKey *key;
598 if (NULL != t->kx_ctx
599 && GNUNET_SCHEDULER_NO_TASK == t->kx_ctx->finish_task)
601 struct GNUNET_TIME_Relative age;
603 age = GNUNET_TIME_absolute_get_duration (t->kx_ctx->rekey_start_time);
604 LOG (GNUNET_ERROR_TYPE_DEBUG,
605 " key exchange in progress, started %s ago\n",
606 GNUNET_STRINGS_relative_time_to_string (age, GNUNET_YES));
607 // FIXME make duration of old keys configurable
608 if (age.rel_value_us < GNUNET_TIME_UNIT_MINUTES.rel_value_us)
610 LOG (GNUNET_ERROR_TYPE_DEBUG, " using old key\n");
611 key = &t->kx_ctx->e_key_old;
615 LOG (GNUNET_ERROR_TYPE_DEBUG, " using new key\n");
621 LOG (GNUNET_ERROR_TYPE_DEBUG, " no KX: using current key\n");
631 * @param plaintext Content to HMAC.
632 * @param size Size of @c plaintext.
633 * @param iv Initialization vector for the message.
634 * @param key Key to use.
635 * @param hmac[out] Destination to store the HMAC.
638 t_hmac (const void *plaintext, size_t size,
639 uint32_t iv, const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
640 struct GNUNET_CADET_Hash *hmac)
642 static const char ctx[] = "cadet authentication key";
643 struct GNUNET_CRYPTO_AuthKey auth_key;
644 struct GNUNET_HashCode hash;
646 #if DUMP_KEYS_TO_STDERR
647 LOG (GNUNET_ERROR_TYPE_INFO, " HMAC with key %s\n",
648 GNUNET_h2s ((struct GNUNET_HashCode *) key));
650 GNUNET_CRYPTO_hmac_derive_key (&auth_key, key,
655 /* Two step: CADET_Hash is only 256 bits, HashCode is 512. */
656 GNUNET_CRYPTO_hmac (&auth_key, plaintext, size, &hash);
657 memcpy (hmac, &hash, sizeof (*hmac));
662 * Encrypt daforce_newest_keyta with the tunnel key.
664 * @param t Tunnel whose key to use.
665 * @param dst Destination for the encrypted data.
666 * @param src Source of the plaintext. Can overlap with @c dst.
667 * @param size Size of the plaintext.
668 * @param iv Initialization Vector to use.
669 * @param force_newest_key Force the use of the newest key, otherwise
670 * CADET will use the old key when allowed.
671 * This can happen in the case when a KX is going on
672 * and the old one hasn't expired.
675 t_encrypt (struct CadetTunnel *t, void *dst, const void *src,
676 size_t size, uint32_t iv, int force_newest_key)
678 struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
679 const struct GNUNET_CRYPTO_SymmetricSessionKey *key;
682 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_encrypt start\n");
684 key = GNUNET_YES == force_newest_key ? &t->e_key : select_key (t);
685 #if DUMP_KEYS_TO_STDERR
686 LOG (GNUNET_ERROR_TYPE_INFO, " ENC with key %s\n",
687 GNUNET_h2s ((struct GNUNET_HashCode *) key));
689 GNUNET_CRYPTO_symmetric_derive_iv (&siv, key, &iv, sizeof (iv), NULL);
690 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_encrypt IV derived\n");
691 out_size = GNUNET_CRYPTO_symmetric_encrypt (src, size, key, &siv, dst);
692 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_encrypt end\n");
699 * Decrypt and verify data with the appropriate tunnel key.
701 * @param key Key to use.
702 * @param dst Destination for the plaintext.
703 * @param src Source of the encrypted data. Can overlap with @c dst.
704 * @param size Size of the encrypted data.
705 * @param iv Initialization Vector to use.
707 * @return Size of the decrypted data, -1 if an error was encountered.
710 decrypt (const struct GNUNET_CRYPTO_SymmetricSessionKey *key,
711 void *dst, const void *src, size_t size, uint32_t iv)
713 struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
716 LOG (GNUNET_ERROR_TYPE_DEBUG, " decrypt start\n");
717 LOG (GNUNET_ERROR_TYPE_DEBUG, " decrypt iv\n");
718 GNUNET_CRYPTO_symmetric_derive_iv (&siv, key, &iv, sizeof (iv), NULL);
719 LOG (GNUNET_ERROR_TYPE_DEBUG, " decrypt iv done\n");
720 out_size = GNUNET_CRYPTO_symmetric_decrypt (src, size, key, &siv, dst);
721 LOG (GNUNET_ERROR_TYPE_DEBUG, " decrypt end\n");
728 * Decrypt and verify data with the most recent tunnel key.
730 * @param t Tunnel whose key to use.
731 * @param dst Destination for the plaintext.
732 * @param src Source of the encrypted data. Can overlap with @c dst.
733 * @param size Size of the encrypted data.
734 * @param iv Initialization Vector to use.
736 * @return Size of the decrypted data, -1 if an error was encountered.
739 t_decrypt (struct CadetTunnel *t, void *dst, const void *src,
740 size_t size, uint32_t iv)
744 #if DUMP_KEYS_TO_STDERR
745 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_decrypt with %s\n",
746 GNUNET_h2s ((struct GNUNET_HashCode *) &t->d_key));
748 if (t->estate == CADET_TUNNEL_KEY_UNINITIALIZED)
750 GNUNET_STATISTICS_update (stats, "# non decryptable data", 1, GNUNET_NO);
751 LOG (GNUNET_ERROR_TYPE_WARNING,
752 "got data on %s without a valid key\n",
754 GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
758 out_size = decrypt (&t->d_key, dst, src, size, iv);
765 * Decrypt and verify data with the appropriate tunnel key and verify that the
766 * data has not been altered since it was sent by the remote peer.
768 * @param t Tunnel whose key to use.
769 * @param dst Destination for the plaintext.
770 * @param src Source of the encrypted data. Can overlap with @c dst.
771 * @param size Size of the encrypted data.
772 * @param iv Initialization Vector to use.
773 * @param msg_hmac HMAC of the message, cannot be NULL.
775 * @return Size of the decrypted data, -1 if an error was encountered.
778 t_decrypt_and_validate (struct CadetTunnel *t,
779 void *dst, const void *src,
780 size_t size, uint32_t iv,
781 const struct GNUNET_CADET_Hash *msg_hmac)
783 struct GNUNET_CRYPTO_SymmetricSessionKey *key;
784 struct GNUNET_CADET_Hash hmac;
787 /* Try primary (newest) key */
789 decrypted_size = decrypt (key, dst, src, size, iv);
790 t_hmac (src, size, iv, key, &hmac);
791 if (0 == memcmp (msg_hmac, &hmac, sizeof (hmac)))
792 return decrypted_size;
794 /* If no key exchange is going on, we just failed */
795 if (NULL == t->kx_ctx)
797 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
798 "Failed checksum validation on tunnel %s with no KX\n",
800 GNUNET_STATISTICS_update (stats, "# wrong HMAC", 1, GNUNET_NO);
804 /* Try secondary (from previous KX period) key */
805 key = &t->kx_ctx->d_key_old;
806 decrypted_size = decrypt (key, dst, src, size, iv);
807 t_hmac (src, size, iv, key, &hmac);
808 if (0 == memcmp (msg_hmac, &hmac, sizeof (hmac)))
809 return decrypted_size;
811 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
812 "Failed checksum validation on tunnel %s with KX\n",
814 GNUNET_STATISTICS_update (stats, "# wrong HMAC", 1, GNUNET_NO);
820 * Create key material by doing ECDH on the local and remote ephemeral keys.
822 * @param key_material Where to store the key material.
823 * @param ephemeral_key Peer's public ephemeral key.
826 derive_key_material (struct GNUNET_HashCode *key_material,
827 const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral_key)
830 GNUNET_CRYPTO_ecc_ecdh (my_ephemeral_key,
840 * Create a symmetic key from the identities of both ends and the key material
843 * @param key Destination for the generated key.
844 * @param sender ID of the peer that will encrypt with @c key.
845 * @param receiver ID of the peer that will decrypt with @c key.
846 * @param key_material Hash created with ECDH with the ephemeral keys.
849 derive_symmertic (struct GNUNET_CRYPTO_SymmetricSessionKey *key,
850 const struct GNUNET_PeerIdentity *sender,
851 const struct GNUNET_PeerIdentity *receiver,
852 const struct GNUNET_HashCode *key_material)
854 const char salt[] = "CADET kx salt";
856 GNUNET_CRYPTO_kdf (key, sizeof (struct GNUNET_CRYPTO_SymmetricSessionKey),
858 key_material, sizeof (struct GNUNET_HashCode),
859 sender, sizeof (struct GNUNET_PeerIdentity),
860 receiver, sizeof (struct GNUNET_PeerIdentity),
866 * Create a new Key eXchange context for the tunnel.
868 * Initializes the key copies, KX start timestamp and creates a new nonce.
870 * @param t Tunnel for which to create the KX ctx.
873 create_kx_ctx (struct CadetTunnel *t)
875 if (NULL != t->kx_ctx)
877 if (GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
879 GNUNET_SCHEDULER_cancel (t->kx_ctx->finish_task);
880 t->kx_ctx->finish_task = GNUNET_SCHEDULER_NO_TASK;
885 LOG (GNUNET_ERROR_TYPE_INFO, " new kx ctx for %s\n", GCT_2s (t));
886 t->kx_ctx = GNUNET_new (struct CadetTunnelKXCtx);
887 t->kx_ctx->challenge = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
889 t->kx_ctx->d_key_old = t->d_key;
890 t->kx_ctx->e_key_old = t->e_key;
891 t->kx_ctx->rekey_start_time = GNUNET_TIME_absolute_get ();
896 * @brief Finish the Key eXchange and destroy the old keys.
898 * @param cls Closure (Tunnel for which to finish the KX).
899 * @param tc Task context.
902 finish_kx (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
904 struct CadetTunnel *t = cls;
906 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
909 LOG (GNUNET_ERROR_TYPE_INFO, "finish KX for %s\n", GCT_2s (t));
911 GNUNET_free (t->kx_ctx);
917 * Destroy a Key eXchange context for the tunnel. This function only schedules
918 * the destruction, the freeing of the memory (and clearing of old key material)
919 * happens after a delay!
921 * @param t Tunnel whose KX ctx to destroy.
924 destroy_kx_ctx (struct CadetTunnel *t)
926 struct GNUNET_TIME_Relative delay;
928 if (NULL == t->kx_ctx || GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
931 if (is_key_null (&t->kx_ctx->e_key_old))
933 t->kx_ctx->finish_task = GNUNET_SCHEDULER_add_now (finish_kx, t);
937 delay = GNUNET_TIME_relative_divide (rekey_period, 4);
938 delay = GNUNET_TIME_relative_min (delay, GNUNET_TIME_UNIT_MINUTES);
940 t->kx_ctx->finish_task = GNUNET_SCHEDULER_add_delayed (delay, finish_kx, t);
945 * Derive the tunnel's keys using our own and the peer's ephemeral keys.
947 * @param t Tunnel for which to create the keys.
950 create_keys (struct CadetTunnel *t)
952 struct GNUNET_HashCode km;
954 derive_key_material (&km, &t->peers_ephemeral_key);
955 derive_symmertic (&t->e_key, &my_full_id, GCP_get_id (t->peer), &km);
956 derive_symmertic (&t->d_key, GCP_get_id (t->peer), &my_full_id, &km);
957 #if DUMP_KEYS_TO_STDERR
958 LOG (GNUNET_ERROR_TYPE_INFO, "ME: %s\n",
959 GNUNET_h2s ((struct GNUNET_HashCode *) &kx_msg.ephemeral_key));
960 LOG (GNUNET_ERROR_TYPE_INFO, "PE: %s\n",
961 GNUNET_h2s ((struct GNUNET_HashCode *) &t->peers_ephemeral_key));
962 LOG (GNUNET_ERROR_TYPE_INFO, "KM: %s\n", GNUNET_h2s (&km));
963 LOG (GNUNET_ERROR_TYPE_INFO, "EK: %s\n",
964 GNUNET_h2s ((struct GNUNET_HashCode *) &t->e_key));
965 LOG (GNUNET_ERROR_TYPE_INFO, "DK: %s\n",
966 GNUNET_h2s ((struct GNUNET_HashCode *) &t->d_key));
972 * Pick a connection on which send the next data message.
974 * @param t Tunnel on which to send the message.
976 * @return The connection on which to send the next message.
978 static struct CadetConnection *
979 tunnel_get_connection (struct CadetTunnel *t)
981 struct CadetTConnection *iter;
982 struct CadetConnection *best;
984 unsigned int lowest_q;
986 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel_get_connection %s\n", GCT_2s (t));
989 for (iter = t->connection_head; NULL != iter; iter = iter->next)
991 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s: %u\n",
992 GCC_2s (iter->c), GCC_get_state (iter->c));
993 if (CADET_CONNECTION_READY == GCC_get_state (iter->c))
995 qn = GCC_get_qn (iter->c, GCC_is_origin (iter->c, GNUNET_YES));
996 LOG (GNUNET_ERROR_TYPE_DEBUG, " q_n %u, \n", qn);
1004 LOG (GNUNET_ERROR_TYPE_DEBUG, " selected: connection %s\n", GCC_2s (best));
1010 * Callback called when a queued message is sent.
1012 * Calculates the average time and connection packet tracking.
1014 * @param cls Closure (TunnelQueue handle).
1015 * @param c Connection this message was on.
1016 * @param q Connection queue handle (unused).
1017 * @param type Type of message sent.
1018 * @param fwd Was this a FWD going message?
1019 * @param size Size of the message.
1022 tun_message_sent (void *cls,
1023 struct CadetConnection *c,
1024 struct CadetConnectionQueue *q,
1025 uint16_t type, int fwd, size_t size)
1027 struct CadetTunnelQueue *qt = cls;
1028 struct CadetTunnel *t;
1030 LOG (GNUNET_ERROR_TYPE_DEBUG, "tun_message_sent\n");
1032 GNUNET_assert (NULL != qt->cont);
1033 t = NULL == c ? NULL : GCC_get_tunnel (c);
1034 qt->cont (qt->cont_cls, t, qt, type, size);
1040 count_queued_data (const struct CadetTunnel *t)
1042 struct CadetTunnelDelayed *iter;
1045 for (count = 0, iter = t->tq_head; iter != NULL; iter = iter->next)
1052 * Delete a queued message: either was sent or the channel was destroyed
1053 * before the tunnel's key exchange had a chance to finish.
1055 * @param tqd Delayed queue handle.
1058 unqueue_data (struct CadetTunnelDelayed *tqd)
1060 GNUNET_CONTAINER_DLL_remove (tqd->t->tq_head, tqd->t->tq_tail, tqd);
1066 * Cache a message to be sent once tunnel is online.
1068 * @param t Tunnel to hold the message.
1069 * @param msg Message itself (copy will be made).
1071 static struct CadetTunnelDelayed *
1072 queue_data (struct CadetTunnel *t, const struct GNUNET_MessageHeader *msg)
1074 struct CadetTunnelDelayed *tqd;
1075 uint16_t size = ntohs (msg->size);
1077 LOG (GNUNET_ERROR_TYPE_DEBUG, "queue data on Tunnel %s\n", GCT_2s (t));
1079 if (GNUNET_YES == is_ready (t))
1085 tqd = GNUNET_malloc (sizeof (struct CadetTunnelDelayed) + size);
1088 memcpy (&tqd[1], msg, size);
1089 GNUNET_CONTAINER_DLL_insert_tail (t->tq_head, t->tq_tail, tqd);
1095 * Sends an already built message on a tunnel, encrypting it and
1096 * choosing the best connection.
1098 * @param message Message to send. Function modifies it.
1099 * @param t Tunnel on which this message is transmitted.
1100 * @param c Connection to use (autoselect if NULL).
1101 * @param force Force the tunnel to take the message (buffer overfill).
1102 * @param cont Continuation to call once message is really sent.
1103 * @param cont_cls Closure for @c cont.
1104 * @param existing_q In case this a transmission of previously queued data,
1105 * this should be TunnelQueue given to the client.
1108 * @return Handle to cancel message.
1109 * NULL if @c cont is NULL or an error happens and message is dropped.
1111 static struct CadetTunnelQueue *
1112 send_prebuilt_message (const struct GNUNET_MessageHeader *message,
1113 struct CadetTunnel *t, struct CadetConnection *c,
1114 int force, GCT_sent cont, void *cont_cls,
1115 struct CadetTunnelQueue *existing_q)
1117 struct CadetTunnelQueue *tq;
1118 struct GNUNET_CADET_Encrypted *msg;
1119 size_t size = ntohs (message->size);
1120 char cbuf[sizeof (struct GNUNET_CADET_Encrypted) + size];
1126 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT Send on Tunnel %s\n", GCT_2s (t));
1128 if (GNUNET_NO == is_ready (t))
1130 struct CadetTunnelDelayed *tqd;
1131 /* A non null existing_q indicates sending of queued data.
1132 * Should only happen after tunnel becomes ready.
1134 GNUNET_assert (NULL == existing_q);
1135 tqd = queue_data (t, message);
1138 tq = GNUNET_new (struct CadetTunnelQueue);
1142 tq->cont_cls = cont_cls;
1146 GNUNET_assert (GNUNET_NO == GCT_is_loopback (t));
1148 iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1149 msg = (struct GNUNET_CADET_Encrypted *) cbuf;
1150 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED);
1152 GNUNET_assert (t_encrypt (t, &msg[1], message, size, iv, GNUNET_NO) == size);
1153 t_hmac (&msg[1], size, iv, select_key (t), &msg->hmac);
1154 msg->header.size = htons (sizeof (struct GNUNET_CADET_Encrypted) + size);
1157 c = tunnel_get_connection (t);
1160 /* Why is tunnel 'ready'? Should have been queued! */
1161 if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
1164 GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
1166 return NULL; /* Drop... */
1170 type = ntohs (message->type);
1173 case GNUNET_MESSAGE_TYPE_CADET_DATA:
1174 case GNUNET_MESSAGE_TYPE_CADET_DATA_ACK:
1175 if (GNUNET_MESSAGE_TYPE_CADET_DATA == type)
1176 mid = ntohl (((struct GNUNET_CADET_Data *) message)->mid);
1178 mid = ntohl (((struct GNUNET_CADET_DataACK *) message)->mid);
1180 case GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE:
1181 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
1182 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
1183 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_ACK:
1184 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK:
1185 msg->cid = *GCC_get_id (c);
1186 msg->ttl = htonl (default_ttl);
1190 LOG (GNUNET_ERROR_TYPE_ERROR, "type %s not valid\n", GC_m2s (type));
1192 LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s\n", GC_m2s (type));
1194 fwd = GCC_is_origin (c, GNUNET_YES);
1198 GNUNET_break (NULL == GCC_send_prebuilt_message (&msg->header, type, mid, c,
1199 fwd, force, NULL, NULL));
1202 if (NULL == existing_q)
1204 tq = GNUNET_new (struct CadetTunnelQueue); /* FIXME valgrind: leak*/
1211 tq->cq = GCC_send_prebuilt_message (&msg->header, type, mid, c, fwd, force,
1212 &tun_message_sent, tq);
1213 GNUNET_assert (NULL != tq->cq);
1215 tq->cont_cls = cont_cls;
1222 * Send all cached messages that we can, tunnel is online.
1224 * @param t Tunnel that holds the messages. Cannot be loopback.
1227 send_queued_data (struct CadetTunnel *t)
1229 struct CadetTunnelDelayed *tqd;
1230 struct CadetTunnelDelayed *next;
1233 LOG (GNUNET_ERROR_TYPE_DEBUG,
1234 "GCT_send_queued_data on tunnel %s\n",
1237 if (GCT_is_loopback (t))
1243 if (GNUNET_NO == is_ready (t))
1245 LOG (GNUNET_ERROR_TYPE_DEBUG, " not ready yet: %s/%s\n",
1246 estate2s (t->estate), cstate2s (t->cstate));
1250 room = GCT_get_connections_buffer (t);
1251 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space: %u\n", room);
1252 LOG (GNUNET_ERROR_TYPE_DEBUG, " tq head: %p\n", t->tq_head);
1253 for (tqd = t->tq_head; NULL != tqd && room > 0; tqd = next)
1255 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending queued data\n");
1258 send_prebuilt_message ((struct GNUNET_MessageHeader *) &tqd[1],
1259 tqd->t, NULL, GNUNET_YES,
1260 NULL != tqd->tq ? tqd->tq->cont : NULL,
1261 NULL != tqd->tq ? tqd->tq->cont_cls : NULL,
1265 LOG (GNUNET_ERROR_TYPE_DEBUG, "GCT_send_queued_data end\n", GCP_2s (t->peer));
1270 * Sends key exchange message on a tunnel, choosing the best connection.
1271 * Should not be called on loopback tunnels.
1273 * @param t Tunnel on which this message is transmitted.
1274 * @param message Message to send. Function modifies it.
1277 send_kx (struct CadetTunnel *t,
1278 const struct GNUNET_MessageHeader *message)
1280 struct CadetConnection *c;
1281 struct GNUNET_CADET_KX *msg;
1282 size_t size = ntohs (message->size);
1283 char cbuf[sizeof (struct GNUNET_CADET_KX) + size];
1287 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT KX on Tunnel %s\n", GCT_2s (t));
1289 /* Avoid loopback. */
1290 if (GCT_is_loopback (t))
1292 LOG (GNUNET_ERROR_TYPE_DEBUG, " loopback!\n");
1296 type = ntohs (message->type);
1298 /* Even if tunnel is being destroyed, send anyway.
1299 * Could be a response to a rekey initiated by remote peer,
1300 * who is trying to create a new channel!
1303 /* Must have a connection, or be looking for one. */
1304 if (NULL == t->connection_head)
1306 if (CADET_TUNNEL_SEARCHING != t->cstate)
1308 LOG (GNUNET_ERROR_TYPE_ERROR, "\n\n\n");
1310 LOG (GNUNET_ERROR_TYPE_ERROR, "no connection, sending %s\n", GC_m2s (type));
1311 GCT_debug (t, GNUNET_ERROR_TYPE_ERROR);
1312 GCP_debug (t->peer, GNUNET_ERROR_TYPE_ERROR);
1313 LOG (GNUNET_ERROR_TYPE_ERROR, "\n\n\n");
1318 msg = (struct GNUNET_CADET_KX *) cbuf;
1319 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX);
1320 msg->header.size = htons (sizeof (struct GNUNET_CADET_KX) + size);
1321 c = tunnel_get_connection (t);
1324 if (GNUNET_SCHEDULER_NO_TASK == t->destroy_task
1325 && CADET_TUNNEL_READY == t->cstate)
1328 GCT_debug (t, GNUNET_ERROR_TYPE_ERROR);
1334 case GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL:
1335 case GNUNET_MESSAGE_TYPE_CADET_KX_PING:
1336 case GNUNET_MESSAGE_TYPE_CADET_KX_PONG:
1337 memcpy (&msg[1], message, size);
1340 LOG (GNUNET_ERROR_TYPE_DEBUG, "unkown type %s\n",
1345 fwd = GCC_is_origin (t->connection_head->c, GNUNET_YES);
1346 /* TODO save handle and cancel in case of a unneeded retransmission */
1347 GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg->header, type, 0, c,
1354 * Send the ephemeral key on a tunnel.
1356 * @param t Tunnel on which to send the key.
1359 send_ephemeral (struct CadetTunnel *t)
1361 LOG (GNUNET_ERROR_TYPE_INFO, "===> EPHM for %s\n", GCT_2s (t));
1363 kx_msg.sender_status = htonl (t->estate);
1364 send_kx (t, &kx_msg.header);
1368 * Send a ping message on a tunnel.
1370 * @param t Tunnel on which to send the ping.
1373 send_ping (struct CadetTunnel *t)
1375 struct GNUNET_CADET_KX_Ping msg;
1377 LOG (GNUNET_ERROR_TYPE_INFO, "===> PING for %s\n", GCT_2s (t));
1378 msg.header.size = htons (sizeof (msg));
1379 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX_PING);
1380 msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1381 msg.target = *GCP_get_id (t->peer);
1382 msg.nonce = t->kx_ctx->challenge;
1384 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending %u\n", msg.nonce);
1385 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s\n", GNUNET_i2s (&msg.target));
1386 t_encrypt (t, &msg.target, &msg.target,
1387 ping_encryption_size(), msg.iv, GNUNET_YES);
1388 LOG (GNUNET_ERROR_TYPE_DEBUG, " e sending %u\n", msg.nonce);
1389 LOG (GNUNET_ERROR_TYPE_DEBUG, " e towards %s\n", GNUNET_i2s (&msg.target));
1391 send_kx (t, &msg.header);
1396 * Send a pong message on a tunnel.
1398 * @param t Tunnel on which to send the pong.
1399 * @param challenge Value sent in the ping that we have to send back.
1402 send_pong (struct CadetTunnel *t, uint32_t challenge)
1404 struct GNUNET_CADET_KX_Pong msg;
1406 LOG (GNUNET_ERROR_TYPE_INFO, "===> PONG for %s\n", GCT_2s (t));
1407 msg.header.size = htons (sizeof (msg));
1408 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX_PONG);
1409 msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1410 msg.nonce = challenge;
1411 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending %u\n", msg.nonce);
1412 t_encrypt (t, &msg.nonce, &msg.nonce,
1413 sizeof (msg.nonce), msg.iv, GNUNET_YES);
1414 LOG (GNUNET_ERROR_TYPE_DEBUG, " e sending %u\n", msg.nonce);
1416 send_kx (t, &msg.header);
1421 * Initiate a rekey with the remote peer.
1423 * @param cls Closure (tunnel).
1424 * @param tc TaskContext.
1427 rekey_tunnel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1429 struct CadetTunnel *t = cls;
1431 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
1433 LOG (GNUNET_ERROR_TYPE_INFO, "Re-key Tunnel %s\n", GCT_2s (t));
1434 if (NULL != tc && 0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1437 if (NULL == t->kx_ctx)
1444 struct GNUNET_TIME_Relative duration;
1446 if (GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
1448 GNUNET_SCHEDULER_cancel (t->kx_ctx->finish_task);
1449 t->kx_ctx->finish_task = GNUNET_SCHEDULER_NO_TASK;
1452 duration = GNUNET_TIME_absolute_get_duration (t->kx_ctx->rekey_start_time);
1453 LOG (GNUNET_ERROR_TYPE_DEBUG, " kx started %s ago\n",
1454 GNUNET_STRINGS_relative_time_to_string (duration, GNUNET_YES));
1456 // FIXME make duration of old keys configurable
1457 if (duration.rel_value_us >= GNUNET_TIME_UNIT_MINUTES.rel_value_us)
1459 memset (&t->kx_ctx->d_key_old, 0, sizeof (t->kx_ctx->d_key_old));
1460 memset (&t->kx_ctx->e_key_old, 0, sizeof (t->kx_ctx->e_key_old));
1468 case CADET_TUNNEL_KEY_UNINITIALIZED:
1469 t->estate = CADET_TUNNEL_KEY_SENT;
1471 case CADET_TUNNEL_KEY_SENT:
1473 case CADET_TUNNEL_KEY_OK:
1474 t->estate = CADET_TUNNEL_KEY_REKEY;
1476 case CADET_TUNNEL_KEY_PING:
1477 case CADET_TUNNEL_KEY_REKEY:
1481 LOG (GNUNET_ERROR_TYPE_DEBUG, "Unexpected state %u\n", t->estate);
1484 // FIXME exponential backoff
1485 struct GNUNET_TIME_Relative delay;
1487 delay = GNUNET_TIME_relative_divide (rekey_period, 16);
1488 delay = GNUNET_TIME_relative_min (delay, REKEY_WAIT);
1489 LOG (GNUNET_ERROR_TYPE_DEBUG, " next call in %s\n",
1490 GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1491 t->rekey_task = GNUNET_SCHEDULER_add_delayed (delay, &rekey_tunnel, t);
1496 * Our ephemeral key has changed, create new session key on all tunnels.
1498 * Each tunnel will start the Key Exchange with a random delay between
1499 * 0 and number_of_tunnels*100 milliseconds, so there are 10 key exchanges
1500 * per second, on average.
1502 * @param cls Closure (size of the hashmap).
1503 * @param key Current public key.
1504 * @param value Value in the hash map (tunnel).
1506 * @return #GNUNET_YES, so we should continue to iterate,
1509 rekey_iterator (void *cls,
1510 const struct GNUNET_PeerIdentity *key,
1513 struct CadetTunnel *t = value;
1514 struct GNUNET_TIME_Relative delay;
1515 long n = (long) cls;
1518 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
1521 if (GNUNET_YES == GCT_is_loopback (t))
1524 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, (uint32_t) n * 100);
1525 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, r);
1526 t->rekey_task = GNUNET_SCHEDULER_add_delayed (delay, &rekey_tunnel, t);
1533 * Create a new ephemeral key and key message, schedule next rekeying.
1535 * @param cls Closure (unused).
1536 * @param tc TaskContext.
1539 rekey (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1541 struct GNUNET_TIME_Absolute time;
1544 rekey_task = GNUNET_SCHEDULER_NO_TASK;
1546 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1549 GNUNET_free_non_null (my_ephemeral_key);
1550 my_ephemeral_key = GNUNET_CRYPTO_ecdhe_key_create ();
1552 time = GNUNET_TIME_absolute_get ();
1553 kx_msg.creation_time = GNUNET_TIME_absolute_hton (time);
1554 time = GNUNET_TIME_absolute_add (time, rekey_period);
1555 time = GNUNET_TIME_absolute_add (time, GNUNET_TIME_UNIT_MINUTES);
1556 kx_msg.expiration_time = GNUNET_TIME_absolute_hton (time);
1557 GNUNET_CRYPTO_ecdhe_key_get_public (my_ephemeral_key, &kx_msg.ephemeral_key);
1559 GNUNET_assert (GNUNET_OK ==
1560 GNUNET_CRYPTO_eddsa_sign (my_private_key,
1562 &kx_msg.signature));
1564 n = (long) GNUNET_CONTAINER_multipeermap_size (tunnels);
1565 GNUNET_CONTAINER_multipeermap_iterate (tunnels, &rekey_iterator, (void *) n);
1567 rekey_task = GNUNET_SCHEDULER_add_delayed (rekey_period, &rekey, NULL);
1572 * Called only on shutdown, destroy every tunnel.
1574 * @param cls Closure (unused).
1575 * @param key Current public key.
1576 * @param value Value in the hash map (tunnel).
1578 * @return #GNUNET_YES, so we should continue to iterate,
1581 destroy_iterator (void *cls,
1582 const struct GNUNET_PeerIdentity *key,
1585 struct CadetTunnel *t = value;
1587 LOG (GNUNET_ERROR_TYPE_DEBUG, "GCT_shutdown destroying tunnel at %p\n", t);
1594 * Notify remote peer that we don't know a channel he is talking about,
1595 * probably CHANNEL_DESTROY was missed.
1597 * @param t Tunnel on which to notify.
1598 * @param gid ID of the channel.
1601 send_channel_destroy (struct CadetTunnel *t, unsigned int gid)
1603 struct GNUNET_CADET_ChannelManage msg;
1605 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
1606 msg.header.size = htons (sizeof (msg));
1607 msg.chid = htonl (gid);
1609 LOG (GNUNET_ERROR_TYPE_DEBUG,
1610 "WARNING destroying unknown channel %u on tunnel %s\n",
1612 send_prebuilt_message (&msg.header, t, NULL, GNUNET_YES, NULL, NULL, NULL);
1617 * Demultiplex data per channel and call appropriate channel handler.
1619 * @param t Tunnel on which the data came.
1620 * @param msg Data message.
1621 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1622 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1623 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1624 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1627 handle_data (struct CadetTunnel *t,
1628 const struct GNUNET_CADET_Data *msg,
1631 struct CadetChannel *ch;
1635 size = ntohs (msg->header.size);
1637 sizeof (struct GNUNET_CADET_Data) +
1638 sizeof (struct GNUNET_MessageHeader))
1643 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload of type %s\n",
1644 GC_m2s (ntohs (msg[1].header.type)));
1647 ch = GCT_get_channel (t, ntohl (msg->chid));
1650 GNUNET_STATISTICS_update (stats, "# data on unknown channel",
1652 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel 0x%X unknown\n",
1654 send_channel_destroy (t, ntohl (msg->chid));
1658 GCCH_handle_data (ch, msg, fwd);
1663 * Demultiplex data ACKs per channel and update appropriate channel buffer info.
1665 * @param t Tunnel on which the DATA ACK came.
1666 * @param msg DATA ACK message.
1667 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1668 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1669 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1670 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1673 handle_data_ack (struct CadetTunnel *t,
1674 const struct GNUNET_CADET_DataACK *msg,
1677 struct CadetChannel *ch;
1681 size = ntohs (msg->header.size);
1682 if (size != sizeof (struct GNUNET_CADET_DataACK))
1689 ch = GCT_get_channel (t, ntohl (msg->chid));
1692 GNUNET_STATISTICS_update (stats, "# data ack on unknown channel",
1694 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1699 GCCH_handle_data_ack (ch, msg, fwd);
1704 * Handle channel create.
1706 * @param t Tunnel on which the data came.
1707 * @param msg Data message.
1710 handle_ch_create (struct CadetTunnel *t,
1711 const struct GNUNET_CADET_ChannelCreate *msg)
1713 struct CadetChannel *ch;
1717 size = ntohs (msg->header.size);
1718 if (size != sizeof (struct GNUNET_CADET_ChannelCreate))
1725 ch = GCT_get_channel (t, ntohl (msg->chid));
1726 if (NULL != ch && ! GCT_is_loopback (t))
1728 /* Probably a retransmission, safe to ignore */
1729 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists...\n");
1731 ch = GCCH_handle_create (t, msg);
1733 GCT_add_channel (t, ch);
1739 * Handle channel NACK: check correctness and call channel handler for NACKs.
1741 * @param t Tunnel on which the NACK came.
1742 * @param msg NACK message.
1745 handle_ch_nack (struct CadetTunnel *t,
1746 const struct GNUNET_CADET_ChannelManage *msg)
1748 struct CadetChannel *ch;
1752 size = ntohs (msg->header.size);
1753 if (size != sizeof (struct GNUNET_CADET_ChannelManage))
1760 ch = GCT_get_channel (t, ntohl (msg->chid));
1763 GNUNET_STATISTICS_update (stats, "# channel NACK on unknown channel",
1765 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1770 GCCH_handle_nack (ch);
1775 * Handle a CHANNEL ACK (SYNACK/ACK).
1777 * @param t Tunnel on which the CHANNEL ACK came.
1778 * @param msg CHANNEL ACK message.
1779 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1780 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1781 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1782 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1785 handle_ch_ack (struct CadetTunnel *t,
1786 const struct GNUNET_CADET_ChannelManage *msg,
1789 struct CadetChannel *ch;
1793 size = ntohs (msg->header.size);
1794 if (size != sizeof (struct GNUNET_CADET_ChannelManage))
1801 ch = GCT_get_channel (t, ntohl (msg->chid));
1804 GNUNET_STATISTICS_update (stats, "# channel ack on unknown channel",
1806 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1811 GCCH_handle_ack (ch, msg, fwd);
1816 * Handle a channel destruction message.
1818 * @param t Tunnel on which the message came.
1819 * @param msg Channel destroy message.
1820 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1821 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1822 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1823 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1826 handle_ch_destroy (struct CadetTunnel *t,
1827 const struct GNUNET_CADET_ChannelManage *msg,
1830 struct CadetChannel *ch;
1834 size = ntohs (msg->header.size);
1835 if (size != sizeof (struct GNUNET_CADET_ChannelManage))
1842 ch = GCT_get_channel (t, ntohl (msg->chid));
1845 /* Probably a retransmission, safe to ignore */
1849 GCCH_handle_destroy (ch, msg, fwd);
1854 * The peer's ephemeral key has changed: update the symmetrical keys.
1856 * @param t Tunnel this message came on.
1857 * @param msg Key eXchange message.
1860 handle_ephemeral (struct CadetTunnel *t,
1861 const struct GNUNET_CADET_KX_Ephemeral *msg)
1863 LOG (GNUNET_ERROR_TYPE_INFO, "<=== EPHM for %s\n", GCT_2s (t));
1865 if (GNUNET_OK != check_ephemeral (t, msg))
1867 GNUNET_break_op (0);
1872 if (0 != memcmp (&t->peers_ephemeral_key, &msg->ephemeral_key,
1873 sizeof (msg->ephemeral_key)))
1875 t->peers_ephemeral_key = msg->ephemeral_key;
1877 if (CADET_TUNNEL_KEY_OK == t->estate)
1879 t->estate = CADET_TUNNEL_KEY_REKEY;
1881 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
1882 GNUNET_SCHEDULER_cancel (t->rekey_task);
1883 t->rekey_task = GNUNET_SCHEDULER_add_now (rekey_tunnel, t);
1885 else if (CADET_TUNNEL_KEY_OK == t->estate)
1889 if (CADET_TUNNEL_KEY_SENT == t->estate)
1891 LOG (GNUNET_ERROR_TYPE_DEBUG, " our key was sent, sending ping\n");
1893 t->estate = CADET_TUNNEL_KEY_PING;
1899 * Peer wants to check our symmetrical keys by sending an encrypted challenge.
1900 * Answer with by retransmitting the challenge with the "opposite" key.
1902 * @param t Tunnel this message came on.
1903 * @param msg Key eXchange Ping message.
1906 handle_ping (struct CadetTunnel *t,
1907 const struct GNUNET_CADET_KX_Ping *msg)
1909 struct GNUNET_CADET_KX_Ping res;
1911 if (ntohs (msg->header.size) != sizeof (res))
1913 GNUNET_break_op (0);
1917 LOG (GNUNET_ERROR_TYPE_INFO, "<=== PING for %s\n", GCT_2s (t));
1918 t_decrypt (t, &res.target, &msg->target, ping_encryption_size (), msg->iv);
1919 if (0 != memcmp (&my_full_id, &res.target, sizeof (my_full_id)))
1921 /* probably peer hasn't got our new EPHM yet and derived the wrong keys */
1922 GNUNET_STATISTICS_update (stats, "# malformed PINGs", 1, GNUNET_NO);
1923 LOG (GNUNET_ERROR_TYPE_INFO, " malformed PING on %s\n", GCT_2s (t));
1924 LOG (GNUNET_ERROR_TYPE_DEBUG, " e got %u\n", msg->nonce);
1925 LOG (GNUNET_ERROR_TYPE_DEBUG, " e towards %s\n", GNUNET_i2s (&msg->target));
1926 LOG (GNUNET_ERROR_TYPE_DEBUG, " got %u\n", res.nonce);
1927 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s\n", GNUNET_i2s (&res.target));
1934 send_pong (t, res.nonce);
1939 * Peer has answer to our challenge.
1940 * If answer is successful, consider the key exchange finished and clean
1941 * up all related state.
1943 * @param t Tunnel this message came on.
1944 * @param msg Key eXchange Pong message.
1947 handle_pong (struct CadetTunnel *t,
1948 const struct GNUNET_CADET_KX_Pong *msg)
1952 LOG (GNUNET_ERROR_TYPE_INFO, "<=== PONG for %s\n", GCT_2s (t));
1953 if (GNUNET_SCHEDULER_NO_TASK == t->rekey_task)
1955 GNUNET_STATISTICS_update (stats, "# duplicate PONG messages", 1, GNUNET_NO);
1958 t_decrypt (t, &challenge, &msg->nonce, sizeof (uint32_t), msg->iv);
1960 if (challenge != t->kx_ctx->challenge)
1962 LOG (GNUNET_ERROR_TYPE_WARNING, "Wrong PONG challenge on %s\n", GCT_2s (t));
1963 LOG (GNUNET_ERROR_TYPE_DEBUG, "PONG: %u (e: %u). Expected: %u.\n",
1964 challenge, msg->nonce, t->kx_ctx->challenge);
1969 GNUNET_SCHEDULER_cancel (t->rekey_task);
1970 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
1972 /* Don't free the old keys right away, but after a delay.
1973 * Rationale: the KX could have happened over a very fast connection,
1974 * with payload traffic still signed with the old key stuck in a slower
1976 * Don't keep the keys longer than 1/4 the rekey period, and no longer than
1980 GCT_change_estate (t, CADET_TUNNEL_KEY_OK);
1985 * Demultiplex by message type and call appropriate handler for a message
1986 * towards a channel of a local tunnel.
1988 * @param t Tunnel this message came on.
1989 * @param msgh Message header.
1990 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1991 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1992 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1993 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1996 handle_decrypted (struct CadetTunnel *t,
1997 const struct GNUNET_MessageHeader *msgh,
2002 type = ntohs (msgh->type);
2003 LOG (GNUNET_ERROR_TYPE_INFO, "<=== %s on %s\n", GC_m2s (type), GCT_2s (t));
2007 case GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE:
2008 /* Do nothing, connection aleady got updated. */
2009 GNUNET_STATISTICS_update (stats, "# keepalives received", 1, GNUNET_NO);
2012 case GNUNET_MESSAGE_TYPE_CADET_DATA:
2013 /* Don't send hop ACK, wait for client to ACK */
2014 handle_data (t, (struct GNUNET_CADET_Data *) msgh, fwd);
2017 case GNUNET_MESSAGE_TYPE_CADET_DATA_ACK:
2018 handle_data_ack (t, (struct GNUNET_CADET_DataACK *) msgh, fwd);
2021 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
2022 handle_ch_create (t,
2023 (struct GNUNET_CADET_ChannelCreate *) msgh);
2026 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK:
2028 (struct GNUNET_CADET_ChannelManage *) msgh);
2031 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_ACK:
2033 (struct GNUNET_CADET_ChannelManage *) msgh,
2037 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
2038 handle_ch_destroy (t,
2039 (struct GNUNET_CADET_ChannelManage *) msgh,
2044 GNUNET_break_op (0);
2045 LOG (GNUNET_ERROR_TYPE_WARNING,
2046 "end-to-end message not known (%u)\n",
2047 ntohs (msgh->type));
2048 GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
2052 /******************************************************************************/
2053 /******************************** API ***********************************/
2054 /******************************************************************************/
2057 * Decrypt and demultiplex by message type. Call appropriate handler
2058 * for every message.
2060 * @param t Tunnel this message came on.
2061 * @param msg Encrypted message.
2064 GCT_handle_encrypted (struct CadetTunnel *t,
2065 const struct GNUNET_CADET_Encrypted *msg)
2067 size_t size = ntohs (msg->header.size);
2068 size_t payload_size = size - sizeof (struct GNUNET_CADET_Encrypted);
2070 char cbuf [payload_size];
2071 struct GNUNET_MessageHeader *msgh;
2074 decrypted_size = t_decrypt_and_validate (t, cbuf, &msg[1], payload_size,
2075 msg->iv, &msg->hmac);
2077 if (-1 == decrypted_size)
2079 GNUNET_break_op (0);
2084 while (off < decrypted_size)
2088 msgh = (struct GNUNET_MessageHeader *) &cbuf[off];
2089 msize = ntohs (msgh->size);
2090 if (msize < sizeof (struct GNUNET_MessageHeader))
2092 GNUNET_break_op (0);
2095 handle_decrypted (t, msgh, GNUNET_SYSERR);
2102 * Demultiplex an encapsulated KX message by message type.
2104 * @param t Tunnel on which the message came.
2105 * @param message Payload of KX message.
2108 GCT_handle_kx (struct CadetTunnel *t,
2109 const struct GNUNET_MessageHeader *message)
2113 type = ntohs (message->type);
2114 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message received\n", type);
2117 case GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL:
2118 handle_ephemeral (t, (struct GNUNET_CADET_KX_Ephemeral *) message);
2121 case GNUNET_MESSAGE_TYPE_CADET_KX_PING:
2122 handle_ping (t, (struct GNUNET_CADET_KX_Ping *) message);
2125 case GNUNET_MESSAGE_TYPE_CADET_KX_PONG:
2126 handle_pong (t, (struct GNUNET_CADET_KX_Pong *) message);
2130 GNUNET_break_op (0);
2131 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message not known (%u)\n", type);
2137 * Initialize the tunnel subsystem.
2139 * @param c Configuration handle.
2140 * @param key ECC private key, to derive all other keys and do crypto.
2143 GCT_init (const struct GNUNET_CONFIGURATION_Handle *c,
2144 const struct GNUNET_CRYPTO_EddsaPrivateKey *key)
2146 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2148 GNUNET_CONFIGURATION_get_value_number (c, "CADET", "DEFAULT_TTL",
2151 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
2152 "CADET", "DEFAULT_TTL", "USING DEFAULT");
2156 GNUNET_CONFIGURATION_get_value_time (c, "CADET", "REKEY_PERIOD",
2159 rekey_period = GNUNET_TIME_UNIT_DAYS;
2162 my_private_key = key;
2163 kx_msg.header.size = htons (sizeof (kx_msg));
2164 kx_msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL);
2165 kx_msg.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_CADET_KX);
2166 kx_msg.purpose.size = htonl (ephemeral_purpose_size ());
2167 kx_msg.origin_identity = my_full_id;
2168 rekey_task = GNUNET_SCHEDULER_add_now (&rekey, NULL);
2170 tunnels = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
2175 * Shut down the tunnel subsystem.
2180 if (GNUNET_SCHEDULER_NO_TASK != rekey_task)
2182 GNUNET_SCHEDULER_cancel (rekey_task);
2183 rekey_task = GNUNET_SCHEDULER_NO_TASK;
2185 GNUNET_CONTAINER_multipeermap_iterate (tunnels, &destroy_iterator, NULL);
2186 GNUNET_CONTAINER_multipeermap_destroy (tunnels);
2193 * @param destination Peer this tunnel is towards.
2195 struct CadetTunnel *
2196 GCT_new (struct CadetPeer *destination)
2198 struct CadetTunnel *t;
2200 t = GNUNET_new (struct CadetTunnel);
2202 t->peer = destination;
2205 GNUNET_CONTAINER_multipeermap_put (tunnels, GCP_get_id (destination), t,
2206 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
2217 * Change the tunnel's connection state.
2219 * @param t Tunnel whose connection state to change.
2220 * @param cstate New connection state.
2223 GCT_change_cstate (struct CadetTunnel* t, enum CadetTunnelCState cstate)
2227 LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s cstate %s => %s\n",
2228 GCP_2s (t->peer), cstate2s (t->cstate), cstate2s (cstate));
2229 if (myid != GCP_get_short_id (t->peer) &&
2230 CADET_TUNNEL_READY != t->cstate &&
2231 CADET_TUNNEL_READY == cstate)
2234 if (CADET_TUNNEL_KEY_OK == t->estate)
2236 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate triggered send queued data\n");
2237 send_queued_data (t);
2239 else if (CADET_TUNNEL_KEY_UNINITIALIZED == t->estate)
2241 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate triggered rekey\n");
2242 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
2243 GNUNET_SCHEDULER_cancel (t->rekey_task);
2244 rekey_tunnel (t, NULL);
2249 if (CADET_TUNNEL_READY == cstate
2250 && CONNECTIONS_PER_TUNNEL <= GCT_count_connections (t))
2252 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate triggered stop dht\n");
2253 GCP_stop_search (t->peer);
2258 * Change the tunnel encryption state.
2260 * @param t Tunnel whose encryption state to change.
2261 * @param state New encryption state.
2264 GCT_change_estate (struct CadetTunnel* t, enum CadetTunnelEState state)
2268 LOG (GNUNET_ERROR_TYPE_DEBUG,
2269 "Tunnel %s estate was %s\n",
2270 GCP_2s (t->peer), estate2s (t->estate));
2271 LOG (GNUNET_ERROR_TYPE_DEBUG,
2272 "Tunnel %s estate is now %s\n",
2273 GCP_2s (t->peer), estate2s (state));
2274 if (myid != GCP_get_short_id (t->peer) &&
2275 CADET_TUNNEL_KEY_OK != t->estate && CADET_TUNNEL_KEY_OK == state)
2278 send_queued_data (t);
2286 * @brief Check if tunnel has too many connections, and remove one if necessary.
2288 * Currently this means the newest connection, unless it is a direct one.
2289 * Implemented as a task to avoid freeing a connection that is in the middle
2290 * of being created/processed.
2292 * @param cls Closure (Tunnel to check).
2293 * @param tc Task context.
2296 trim_connections (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
2298 struct CadetTunnel *t = cls;
2300 t->trim_connections_task = GNUNET_SCHEDULER_NO_TASK;
2302 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
2305 if (GCT_count_connections (t) > 2 * CONNECTIONS_PER_TUNNEL)
2307 struct CadetTConnection *iter;
2308 struct CadetTConnection *c;
2310 for (c = iter = t->connection_head; NULL != iter; iter = iter->next)
2312 if ((NULL == c || iter->created.abs_value_us > c->created.abs_value_us)
2313 && GNUNET_NO == GCC_is_direct (iter->c))
2320 LOG (GNUNET_ERROR_TYPE_DEBUG, "Too many connections on tunnel %s\n",
2322 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying connection %s\n",
2335 * Add a connection to a tunnel.
2338 * @param c Connection.
2341 GCT_add_connection (struct CadetTunnel *t, struct CadetConnection *c)
2343 struct CadetTConnection *aux;
2345 GNUNET_assert (NULL != c);
2347 LOG (GNUNET_ERROR_TYPE_DEBUG, "add connection %s\n", GCC_2s (c));
2348 LOG (GNUNET_ERROR_TYPE_DEBUG, " to tunnel %s\n", GCT_2s (t));
2349 for (aux = t->connection_head; aux != NULL; aux = aux->next)
2353 aux = GNUNET_new (struct CadetTConnection);
2355 aux->created = GNUNET_TIME_absolute_get ();
2357 GNUNET_CONTAINER_DLL_insert (t->connection_head, t->connection_tail, aux);
2359 if (CADET_TUNNEL_SEARCHING == t->cstate)
2360 GCT_change_estate (t, CADET_TUNNEL_WAITING);
2362 if (GNUNET_SCHEDULER_NO_TASK != t->trim_connections_task)
2363 t->trim_connections_task = GNUNET_SCHEDULER_add_now (&trim_connections, t);
2368 * Remove a connection from a tunnel.
2371 * @param c Connection.
2374 GCT_remove_connection (struct CadetTunnel *t,
2375 struct CadetConnection *c)
2377 struct CadetTConnection *aux;
2378 struct CadetTConnection *next;
2381 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing connection %s from tunnel %s\n",
2382 GCC_2s (c), GCT_2s (t));
2383 for (aux = t->connection_head; aux != NULL; aux = next)
2388 GNUNET_CONTAINER_DLL_remove (t->connection_head, t->connection_tail, aux);
2393 conns = GCT_count_connections (t);
2395 && GNUNET_SCHEDULER_NO_TASK == t->destroy_task
2396 && CADET_TUNNEL_SHUTDOWN != t->cstate
2397 && GNUNET_NO == shutting_down)
2399 if (0 == GCT_count_any_connections (t))
2400 GCT_change_cstate (t, CADET_TUNNEL_SEARCHING);
2402 GCT_change_cstate (t, CADET_TUNNEL_WAITING);
2405 /* Start new connections if needed */
2406 if (CONNECTIONS_PER_TUNNEL > conns
2407 && GNUNET_SCHEDULER_NO_TASK == t->destroy_task
2408 && CADET_TUNNEL_SHUTDOWN != t->cstate
2409 && GNUNET_NO == shutting_down)
2411 LOG (GNUNET_ERROR_TYPE_DEBUG, " too few connections, getting new ones\n");
2412 GCP_connect (t->peer); /* Will change cstate to WAITING when possible */
2416 /* If not marked as ready, no change is needed */
2417 if (CADET_TUNNEL_READY != t->cstate)
2420 /* Check if any connection is ready to maintain cstate */
2421 for (aux = t->connection_head; aux != NULL; aux = aux->next)
2422 if (CADET_CONNECTION_READY == GCC_get_state (aux->c))
2428 * Add a channel to a tunnel.
2431 * @param ch Channel.
2434 GCT_add_channel (struct CadetTunnel *t, struct CadetChannel *ch)
2436 struct CadetTChannel *aux;
2438 GNUNET_assert (NULL != ch);
2440 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding channel %p to tunnel %p\n", ch, t);
2442 for (aux = t->channel_head; aux != NULL; aux = aux->next)
2444 LOG (GNUNET_ERROR_TYPE_DEBUG, " already there %p\n", aux->ch);
2449 aux = GNUNET_new (struct CadetTChannel);
2451 LOG (GNUNET_ERROR_TYPE_DEBUG, " adding %p to %p\n", aux, t->channel_head);
2452 GNUNET_CONTAINER_DLL_insert_tail (t->channel_head, t->channel_tail, aux);
2454 if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
2456 GNUNET_SCHEDULER_cancel (t->destroy_task);
2457 t->destroy_task = GNUNET_SCHEDULER_NO_TASK;
2458 LOG (GNUNET_ERROR_TYPE_DEBUG, " undo destroy!\n");
2464 * Remove a channel from a tunnel.
2467 * @param ch Channel.
2470 GCT_remove_channel (struct CadetTunnel *t, struct CadetChannel *ch)
2472 struct CadetTChannel *aux;
2474 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing channel %p from tunnel %p\n", ch, t);
2475 for (aux = t->channel_head; aux != NULL; aux = aux->next)
2479 LOG (GNUNET_ERROR_TYPE_DEBUG, " found! %s\n", GCCH_2s (ch));
2480 GNUNET_CONTAINER_DLL_remove (t->channel_head, t->channel_tail, aux);
2489 * Search for a channel by global ID.
2491 * @param t Tunnel containing the channel.
2492 * @param chid Public channel number.
2494 * @return channel handler, NULL if doesn't exist
2496 struct CadetChannel *
2497 GCT_get_channel (struct CadetTunnel *t, CADET_ChannelNumber chid)
2499 struct CadetTChannel *iter;
2504 for (iter = t->channel_head; NULL != iter; iter = iter->next)
2506 if (GCCH_get_id (iter->ch) == chid)
2510 return NULL == iter ? NULL : iter->ch;
2515 * @brief Destroy a tunnel and free all resources.
2517 * Should only be called a while after the tunnel has been marked as destroyed,
2518 * in case there is a new channel added to the same peer shortly after marking
2519 * the tunnel. This way we avoid a new public key handshake.
2521 * @param cls Closure (tunnel to destroy).
2522 * @param tc Task context.
2525 delayed_destroy (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
2527 struct CadetTunnel *t = cls;
2528 struct CadetTConnection *iter;
2530 LOG (GNUNET_ERROR_TYPE_DEBUG, "delayed destroying tunnel %p\n", t);
2531 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
2533 LOG (GNUNET_ERROR_TYPE_WARNING,
2534 "Not destroying tunnel, due to shutdown. "
2535 "Tunnel at %p should have been freed by GCT_shutdown\n", t);
2538 t->destroy_task = GNUNET_SCHEDULER_NO_TASK;
2539 t->cstate = CADET_TUNNEL_SHUTDOWN;
2541 for (iter = t->connection_head; NULL != iter; iter = iter->next)
2543 GCC_send_destroy (iter->c);
2550 * Tunnel is empty: destroy it.
2552 * Notifies all connections about the destruction.
2554 * @param t Tunnel to destroy.
2557 GCT_destroy_empty (struct CadetTunnel *t)
2559 if (GNUNET_YES == shutting_down)
2560 return; /* Will be destroyed immediately anyway */
2562 if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
2564 LOG (GNUNET_ERROR_TYPE_WARNING,
2565 "Tunnel %s is already scheduled for destruction. Tunnel debug dump:\n",
2567 GCT_debug (t, GNUNET_ERROR_TYPE_WARNING);
2569 /* should never happen, tunnel can only become empty once, and the
2570 * task identifier should be NO_TASK (cleaned when the tunnel was created
2571 * or became un-empty)
2576 LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s empty: destroying scheduled\n",
2579 // FIXME make delay a config option
2580 t->destroy_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
2581 &delayed_destroy, t);
2582 LOG (GNUNET_ERROR_TYPE_DEBUG, "Scheduled destroy of %p as %llX\n",
2583 t, t->destroy_task);
2588 * Destroy tunnel if empty (no more channels).
2590 * @param t Tunnel to destroy if empty.
2593 GCT_destroy_if_empty (struct CadetTunnel *t)
2595 LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s destroy if empty\n", GCT_2s (t));
2596 if (1 < GCT_count_channels (t))
2599 GCT_destroy_empty (t);
2604 * Destroy the tunnel.
2606 * This function does not generate any warning traffic to clients or peers.
2609 * Cancel messages belonging to this tunnel queued to neighbors.
2610 * Free any allocated resources linked to the tunnel.
2612 * @param t The tunnel to destroy.
2615 GCT_destroy (struct CadetTunnel *t)
2617 struct CadetTConnection *iter_c;
2618 struct CadetTConnection *next_c;
2619 struct CadetTChannel *iter_ch;
2620 struct CadetTChannel *next_ch;
2625 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying tunnel %s\n", GCP_2s (t->peer));
2627 GNUNET_break (GNUNET_YES ==
2628 GNUNET_CONTAINER_multipeermap_remove (tunnels,
2629 GCP_get_id (t->peer), t));
2631 for (iter_c = t->connection_head; NULL != iter_c; iter_c = next_c)
2633 next_c = iter_c->next;
2634 GCC_destroy (iter_c->c);
2636 for (iter_ch = t->channel_head; NULL != iter_ch; iter_ch = next_ch)
2638 next_ch = iter_ch->next;
2639 GCCH_destroy (iter_ch->ch);
2640 /* Should only happen on shutdown, but it's ok. */
2643 if (GNUNET_SCHEDULER_NO_TASK != t->destroy_task)
2645 LOG (GNUNET_ERROR_TYPE_DEBUG, "cancelling dest: %llX\n", t->destroy_task);
2646 GNUNET_SCHEDULER_cancel (t->destroy_task);
2647 t->destroy_task = GNUNET_SCHEDULER_NO_TASK;
2650 if (GNUNET_SCHEDULER_NO_TASK != t->trim_connections_task)
2652 LOG (GNUNET_ERROR_TYPE_DEBUG, "cancelling trim: %llX\n",
2653 t->trim_connections_task);
2654 GNUNET_SCHEDULER_cancel (t->trim_connections_task);
2655 t->trim_connections_task = GNUNET_SCHEDULER_NO_TASK;
2658 GNUNET_STATISTICS_update (stats, "# tunnels", -1, GNUNET_NO);
2659 GCP_set_tunnel (t->peer, NULL);
2661 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
2663 GNUNET_SCHEDULER_cancel (t->rekey_task);
2664 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
2666 if (NULL != t->kx_ctx)
2668 if (GNUNET_SCHEDULER_NO_TASK != t->kx_ctx->finish_task)
2669 GNUNET_SCHEDULER_cancel (t->kx_ctx->finish_task);
2670 GNUNET_free (t->kx_ctx);
2677 * @brief Use the given path for the tunnel.
2678 * Update the next and prev hops (and RCs).
2679 * (Re)start the path refresh in case the tunnel is locally owned.
2681 * @param t Tunnel to update.
2682 * @param p Path to use.
2684 * @return Connection created.
2686 struct CadetConnection *
2687 GCT_use_path (struct CadetTunnel *t, struct CadetPeerPath *p)
2689 struct CadetConnection *c;
2690 struct GNUNET_CADET_Hash cid;
2691 unsigned int own_pos;
2693 if (NULL == t || NULL == p)
2699 if (CADET_TUNNEL_SHUTDOWN == t->cstate)
2705 for (own_pos = 0; own_pos < p->length; own_pos++)
2707 if (p->peers[own_pos] == myid)
2710 if (own_pos >= p->length)
2712 GNUNET_break_op (0);
2716 GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_NONCE, &cid, sizeof (cid));
2717 c = GCC_new (&cid, t, p, own_pos);
2720 /* Path was flawed */
2723 GCT_add_connection (t, c);
2729 * Count all created connections of a tunnel. Not necessarily ready connections!
2731 * @param t Tunnel on which to count.
2733 * @return Number of connections created, either being established or ready.
2736 GCT_count_any_connections (struct CadetTunnel *t)
2738 struct CadetTConnection *iter;
2744 for (count = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
2752 * Count established (ready) connections of a tunnel.
2754 * @param t Tunnel on which to count.
2756 * @return Number of connections.
2759 GCT_count_connections (struct CadetTunnel *t)
2761 struct CadetTConnection *iter;
2767 for (count = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
2768 if (CADET_CONNECTION_DESTROYED != GCC_get_state (iter->c))
2776 * Count channels of a tunnel.
2778 * @param t Tunnel on which to count.
2780 * @return Number of channels.
2783 GCT_count_channels (struct CadetTunnel *t)
2785 struct CadetTChannel *iter;
2788 for (count = 0, iter = t->channel_head;
2790 iter = iter->next, count++) /* skip */;
2797 * Get the connectivity state of a tunnel.
2801 * @return Tunnel's connectivity state.
2803 enum CadetTunnelCState
2804 GCT_get_cstate (struct CadetTunnel *t)
2809 return (enum CadetTunnelCState) -1;
2816 * Get the encryption state of a tunnel.
2820 * @return Tunnel's encryption state.
2822 enum CadetTunnelEState
2823 GCT_get_estate (struct CadetTunnel *t)
2828 return (enum CadetTunnelEState) -1;
2834 * Get the maximum buffer space for a tunnel towards a local client.
2838 * @return Biggest buffer space offered by any channel in the tunnel.
2841 GCT_get_channels_buffer (struct CadetTunnel *t)
2843 struct CadetTChannel *iter;
2844 unsigned int buffer;
2845 unsigned int ch_buf;
2847 if (NULL == t->channel_head)
2849 /* Probably getting buffer for a channel create/handshake. */
2854 for (iter = t->channel_head; NULL != iter; iter = iter->next)
2856 ch_buf = get_channel_buffer (iter);
2857 if (ch_buf > buffer)
2865 * Get the total buffer space for a tunnel for P2P traffic.
2869 * @return Buffer space offered by all connections in the tunnel.
2872 GCT_get_connections_buffer (struct CadetTunnel *t)
2874 struct CadetTConnection *iter;
2875 unsigned int buffer;
2877 if (GNUNET_NO == is_ready (t))
2879 if (count_queued_data (t) > 3)
2886 for (iter = t->connection_head; NULL != iter; iter = iter->next)
2888 if (GCC_get_state (iter->c) != CADET_CONNECTION_READY)
2892 buffer += get_connection_buffer (iter);
2900 * Get the tunnel's destination.
2904 * @return ID of the destination peer.
2906 const struct GNUNET_PeerIdentity *
2907 GCT_get_destination (struct CadetTunnel *t)
2909 return GCP_get_id (t->peer);
2914 * Get the tunnel's next free global channel ID.
2918 * @return GID of a channel free to use.
2921 GCT_get_next_chid (struct CadetTunnel *t)
2923 CADET_ChannelNumber chid;
2924 CADET_ChannelNumber mask;
2927 /* Set bit 30 depending on the ID relationship. Bit 31 is always 0 for GID.
2928 * If our ID is bigger or loopback tunnel, start at 0, bit 30 = 0
2929 * If peer's ID is bigger, start at 0x4... bit 30 = 1
2931 result = GNUNET_CRYPTO_cmp_peer_identity (&my_full_id, GCP_get_id (t->peer));
2936 t->next_chid |= mask;
2938 while (NULL != GCT_get_channel (t, t->next_chid))
2940 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists...\n", t->next_chid);
2941 t->next_chid = (t->next_chid + 1) & ~GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
2942 t->next_chid |= mask;
2944 chid = t->next_chid;
2945 t->next_chid = (t->next_chid + 1) & ~GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
2946 t->next_chid |= mask;
2953 * Send ACK on one or more channels due to buffer in connections.
2955 * @param t Channel which has some free buffer space.
2958 GCT_unchoke_channels (struct CadetTunnel *t)
2960 struct CadetTChannel *iter;
2961 unsigned int buffer;
2962 unsigned int channels = GCT_count_channels (t);
2963 unsigned int choked_n;
2964 struct CadetChannel *choked[channels];
2966 LOG (GNUNET_ERROR_TYPE_DEBUG, "GCT_unchoke_channels on %s\n", GCT_2s (t));
2967 LOG (GNUNET_ERROR_TYPE_DEBUG, " head: %p\n", t->channel_head);
2968 if (NULL != t->channel_head)
2969 LOG (GNUNET_ERROR_TYPE_DEBUG, " head ch: %p\n", t->channel_head->ch);
2971 /* Get buffer space */
2972 buffer = GCT_get_connections_buffer (t);
2978 /* Count and remember choked channels */
2980 for (iter = t->channel_head; NULL != iter; iter = iter->next)
2982 if (GNUNET_NO == get_channel_allowed (iter))
2984 choked[choked_n++] = iter->ch;
2988 /* Unchoke random channels */
2989 while (0 < buffer && 0 < choked_n)
2991 unsigned int r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
2993 GCCH_allow_client (choked[r], GCCH_is_origin (choked[r], GNUNET_YES));
2996 choked[r] = choked[choked_n];
3002 * Send ACK on one or more connections due to buffer space to the client.
3004 * Iterates all connections of the tunnel and sends ACKs appropriately.
3009 GCT_send_connection_acks (struct CadetTunnel *t)
3011 struct CadetTConnection *iter;
3014 uint32_t allow_per_connection;
3016 unsigned int buffer;
3018 LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel send connection ACKs on %s\n",
3027 buffer = GCT_get_channels_buffer (t);
3028 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer %u\n", buffer);
3030 /* Count connections, how many messages are already allowed */
3031 cs = GCT_count_connections (t);
3032 for (allowed = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
3034 allowed += get_connection_allowed (iter);
3036 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowed %u\n", allowed);
3038 /* Make sure there is no overflow */
3039 if (allowed > buffer)
3044 /* Authorize connections to send more data */
3045 to_allow = buffer; /* - allowed; */
3047 for (iter = t->connection_head;
3048 NULL != iter && to_allow > 0;
3051 allow_per_connection = to_allow/cs;
3052 to_allow -= allow_per_connection;
3054 if (get_connection_allowed (iter) > 64 / 3)
3058 GCC_allow (iter->c, allow_per_connection,
3059 GCC_is_origin (iter->c, GNUNET_NO));
3062 GNUNET_break (to_allow == 0); //FIXME tripped
3067 * Cancel a previously sent message while it's in the queue.
3069 * ONLY can be called before the continuation given to the send function
3070 * is called. Once the continuation is called, the message is no longer in the
3073 * @param q Handle to the queue.
3076 GCT_cancel (struct CadetTunnelQueue *q)
3081 /* tun_message_sent() will be called and free q */
3083 else if (NULL != q->tqd)
3085 unqueue_data (q->tqd);
3087 if (NULL != q->cont)
3088 q->cont (q->cont_cls, NULL, q, 0, 0);
3099 * Sends an already built message on a tunnel, encrypting it and
3100 * choosing the best connection if not provided.
3102 * @param message Message to send. Function modifies it.
3103 * @param t Tunnel on which this message is transmitted.
3104 * @param c Connection to use (autoselect if NULL).
3105 * @param force Force the tunnel to take the message (buffer overfill).
3106 * @param cont Continuation to call once message is really sent.
3107 * @param cont_cls Closure for @c cont.
3109 * @return Handle to cancel message. NULL if @c cont is NULL.
3111 struct CadetTunnelQueue *
3112 GCT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
3113 struct CadetTunnel *t, struct CadetConnection *c,
3114 int force, GCT_sent cont, void *cont_cls)
3116 return send_prebuilt_message (message, t, c, force, cont, cont_cls, NULL);
3120 * Sends an already built and encrypted message on a tunnel, choosing the best
3121 * connection. Useful for re-queueing messages queued on a destroyed connection.
3123 * @param message Message to send. Function modifies it.
3124 * @param t Tunnel on which this message is transmitted.
3127 GCT_resend_message (const struct GNUNET_MessageHeader *message,
3128 struct CadetTunnel *t)
3130 struct CadetConnection *c;
3133 c = tunnel_get_connection (t);
3136 /* TODO queue in tunnel, marked as encrypted */
3137 LOG (GNUNET_ERROR_TYPE_DEBUG, "No connection available, dropping.\n");
3140 fwd = GCC_is_origin (c, GNUNET_YES);
3141 GNUNET_break (NULL == GCC_send_prebuilt_message (message, 0, 0, c, fwd,
3142 GNUNET_YES, NULL, NULL));
3147 * Is the tunnel directed towards the local peer?
3151 * @return #GNUNET_YES if it is loopback.
3154 GCT_is_loopback (const struct CadetTunnel *t)
3156 return (myid == GCP_get_short_id (t->peer));
3161 * Is the tunnel this path already?
3166 * @return #GNUNET_YES a connection uses this path.
3169 GCT_is_path_used (const struct CadetTunnel *t, const struct CadetPeerPath *p)
3171 struct CadetTConnection *iter;
3173 for (iter = t->connection_head; NULL != iter; iter = iter->next)
3174 if (GCC_get_path (iter->c) == p)
3182 * Get a cost of a path for a tunnel considering existing connections.
3185 * @param path Candidate path.
3187 * @return Cost of the path (path length + number of overlapping nodes)
3190 GCT_get_path_cost (const struct CadetTunnel *t,
3191 const struct CadetPeerPath *path)
3193 struct CadetTConnection *iter;
3194 const struct CadetPeerPath *aux;
3195 unsigned int overlap;
3203 GNUNET_assert (NULL != t);
3205 for (i = 0; i < path->length; i++)
3207 for (iter = t->connection_head; NULL != iter; iter = iter->next)
3209 aux = GCC_get_path (iter->c);
3213 for (j = 0; j < aux->length; j++)
3215 if (path->peers[i] == aux->peers[j])
3223 return path->length + overlap;
3228 * Get the static string for the peer this tunnel is directed.
3232 * @return Static string the destination peer's ID.
3235 GCT_2s (const struct CadetTunnel *t)
3240 return GCP_2s (t->peer);
3244 /******************************************************************************/
3245 /***************************** INFO/DEBUG *******************************/
3246 /******************************************************************************/
3249 * Log all possible info about the tunnel state.
3251 * @param t Tunnel to debug.
3252 * @param level Debug level to use.
3255 GCT_debug (const struct CadetTunnel *t, enum GNUNET_ErrorType level)
3257 struct CadetTChannel *iterch;
3258 struct CadetTConnection *iterc;
3261 do_log = GNUNET_get_log_call_status (level & (~GNUNET_ERROR_TYPE_BULK),
3263 __FILE__, __FUNCTION__, __LINE__);
3267 LOG2 (level, "TTT DEBUG TUNNEL TOWARDS %s\n", GCT_2s (t));
3268 LOG2 (level, "TTT cstate %s, estate %s\n",
3269 cstate2s (t->cstate), estate2s (t->estate));
3270 LOG2 (level, "TTT kx_ctx %p, rekey_task %u, finish task %u\n",
3271 t->kx_ctx, t->rekey_task, t->kx_ctx ? t->kx_ctx->finish_task : 0);
3272 #if DUMP_KEYS_TO_STDERR
3273 LOG2 (level, "TTT my EPHM\t %s\n",
3274 GNUNET_h2s ((struct GNUNET_HashCode *) &kx_msg.ephemeral_key));
3275 LOG2 (level, "TTT peers EPHM:\t %s\n",
3276 GNUNET_h2s ((struct GNUNET_HashCode *) &t->peers_ephemeral_key));
3277 LOG2 (level, "TTT ENC key:\t %s\n",
3278 GNUNET_h2s ((struct GNUNET_HashCode *) &t->e_key));
3279 LOG2 (level, "TTT DEC key:\t %s\n",
3280 GNUNET_h2s ((struct GNUNET_HashCode *) &t->d_key));
3283 LOG2 (level, "TTT OLD ENC key:\t %s\n",
3284 GNUNET_h2s ((struct GNUNET_HashCode *) &t->kx_ctx->e_key_old));
3285 LOG2 (level, "TTT OLD DEC key:\t %s\n",
3286 GNUNET_h2s ((struct GNUNET_HashCode *) &t->kx_ctx->d_key_old));
3289 LOG2 (level, "TTT tq_head %p, tq_tail %p\n", t->tq_head, t->tq_tail);
3290 LOG2 (level, "TTT destroy %u\n", t->destroy_task);
3292 LOG2 (level, "TTT channels:\n");
3293 for (iterch = t->channel_head; NULL != iterch; iterch = iterch->next)
3295 LOG2 (level, "TTT - %s\n", GCCH_2s (iterch->ch));
3298 LOG2 (level, "TTT connections:\n");
3299 for (iterc = t->connection_head; NULL != iterc; iterc = iterc->next)
3301 GCC_debug (iterc->c, level);
3304 LOG2 (level, "TTT DEBUG TUNNEL END\n");
3309 * Iterate all tunnels.
3311 * @param iter Iterator.
3312 * @param cls Closure for @c iter.
3315 GCT_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls)
3317 GNUNET_CONTAINER_multipeermap_iterate (tunnels, iter, cls);
3322 * Count all tunnels.
3324 * @return Number of tunnels to remote peers kept by this peer.
3327 GCT_count_all (void)
3329 return GNUNET_CONTAINER_multipeermap_size (tunnels);
3334 * Iterate all connections of a tunnel.
3336 * @param t Tunnel whose connections to iterate.
3337 * @param iter Iterator.
3338 * @param cls Closure for @c iter.
3341 GCT_iterate_connections (struct CadetTunnel *t, GCT_conn_iter iter, void *cls)
3343 struct CadetTConnection *ct;
3345 for (ct = t->connection_head; NULL != ct; ct = ct->next)
3351 * Iterate all channels of a tunnel.
3353 * @param t Tunnel whose channels to iterate.
3354 * @param iter Iterator.
3355 * @param cls Closure for @c iter.
3358 GCT_iterate_channels (struct CadetTunnel *t, GCT_chan_iter iter, void *cls)
3360 struct CadetTChannel *cht;
3362 for (cht = t->channel_head; NULL != cht; cht = cht->next)
3363 iter (cls, cht->ch);