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 "mesh_protocol_enc.h"
28 #include "mesh_path.h"
30 #include "gnunet-service-mesh_tunnel.h"
31 #include "gnunet-service-mesh_connection.h"
32 #include "gnunet-service-mesh_channel.h"
33 #include "gnunet-service-mesh_peer.h"
35 #define LOG(level, ...) GNUNET_log_from(level,"mesh-tun",__VA_ARGS__)
37 #define REKEY_WAIT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30)
39 /******************************************************************************/
40 /******************************** STRUCTS **********************************/
41 /******************************************************************************/
45 struct MeshTChannel *next;
46 struct MeshTChannel *prev;
47 struct MeshChannel *ch;
50 struct MeshTConnection
52 struct MeshTConnection *next;
53 struct MeshTConnection *prev;
54 struct MeshConnection *c;
58 * Structure used during a Key eXchange.
60 struct MeshTunnelKXCtx
63 * Decryption ("their") old key, for decrypting traffic sent by the
64 * other end before the key exchange started.
66 struct GNUNET_CRYPTO_SymmetricSessionKey d_key_old;
69 * Challenge to send in a ping and expect in the pong.
75 * Struct containing all information regarding a tunnel to a peer.
80 * Endpoint of the tunnel.
82 struct MeshPeer *peer;
85 * State of the tunnel.
87 enum MeshTunnel3State state;
90 * Key eXchange context.
92 struct MeshTunnelKXCtx *kx_ctx;
95 * Encryption ("our") key.
97 struct GNUNET_CRYPTO_SymmetricSessionKey e_key;
100 * Decryption ("their") key.
102 struct GNUNET_CRYPTO_SymmetricSessionKey d_key;
105 * Task to start the rekey process.
107 GNUNET_SCHEDULER_TaskIdentifier rekey_task;
110 * Paths that are actively used to reach the destination peer.
112 struct MeshTConnection *connection_head;
113 struct MeshTConnection *connection_tail;
116 * Next connection number.
121 * Channels inside this tunnel.
123 struct MeshTChannel *channel_head;
124 struct MeshTChannel *channel_tail;
127 * Channel ID for the next created channel.
129 MESH_ChannelNumber next_chid;
132 * Destroy flag: if true, destroy on last message.
137 * Queued messages, to transmit once tunnel gets connected.
139 struct MeshTunnelQueue *tq_head;
140 struct MeshTunnelQueue *tq_tail;
145 * Struct used to queue messages in a tunnel.
147 struct MeshTunnelQueue
152 struct MeshTunnelQueue *next;
153 struct MeshTunnelQueue *prev;
158 struct MeshChannel *ch;
163 /* struct GNUNET_MessageHeader *msg; */
167 /******************************************************************************/
168 /******************************* GLOBALS ***********************************/
169 /******************************************************************************/
172 * Global handle to the statistics service.
174 extern struct GNUNET_STATISTICS_Handle *stats;
177 * Local peer own ID (memory efficient handle).
179 extern GNUNET_PEER_Id myid;
182 * Local peer own ID (full value).
184 extern struct GNUNET_PeerIdentity my_full_id;
188 * Set of all tunnels, in order to trigger a new exchange on rekey.
189 * Indexed by peer's ID.
191 static struct GNUNET_CONTAINER_MultiPeerMap *tunnels;
194 * Default TTL for payload packets.
196 static unsigned long long default_ttl;
201 const static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
204 * Own ephemeral private key.
206 static struct GNUNET_CRYPTO_EcdhePrivateKey *my_ephemeral_key;
209 * Cached message used to perform a key exchange.
211 static struct GNUNET_MESH_KX_Ephemeral kx_msg;
214 * Task to generate a new ephemeral key.
216 static GNUNET_SCHEDULER_TaskIdentifier rekey_task;
221 static struct GNUNET_TIME_Relative rekey_period;
223 /******************************************************************************/
224 /******************************** STATIC ***********************************/
225 /******************************************************************************/
228 * Get string description for tunnel state.
230 * @param s Tunnel state.
232 * @return String representation.
235 GMT_state2s (enum MeshTunnel3State s)
237 static char buf[128];
241 case MESH_TUNNEL3_NEW:
242 return "MESH_TUNNEL3_NEW";
243 case MESH_TUNNEL3_SEARCHING:
244 return "MESH_TUNNEL3_SEARCHING";
245 case MESH_TUNNEL3_WAITING:
246 return "MESH_TUNNEL3_WAITING";
247 case MESH_TUNNEL3_READY:
248 return "MESH_TUNNEL3_READY";
249 case MESH_TUNNEL3_RECONNECTING:
250 return "MESH_TUNNEL3_RECONNECTING";
253 sprintf (buf, "%u (UNKNOWN STATE)", s);
260 * Ephemeral key message purpose size.
262 * @return Size of the part of the ephemeral key message that must be signed.
265 ephemeral_purpose_size (void)
267 return sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
268 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
269 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
270 sizeof (struct GNUNET_CRYPTO_EcdhePublicKey) +
271 sizeof (struct GNUNET_PeerIdentity);
276 * Size of the encrypted part of a ping message.
278 * @return Size of the encrypted part of a ping message.
281 ping_encryption_size (void)
283 return sizeof (struct GNUNET_PeerIdentity) + sizeof (uint32_t);
288 * Check that a ephemeral key message s well formed and correctly signed.
290 * @param t Tunnel on which the message came.
291 * @param msg The ephemeral key message.
293 * @return \GNUNET_OK if message is fine, \GNUNET_SYSERR otherwise.
296 check_ephemeral (struct MeshTunnel3 *t,
297 const struct GNUNET_MESH_KX_Ephemeral *msg)
299 /* Check message size */
300 if (ntohs (msg->header.size) != sizeof (struct GNUNET_MESH_KX_Ephemeral))
301 return GNUNET_SYSERR;
303 /* Check signature size */
304 if (ntohl (msg->purpose.size) != ephemeral_purpose_size ())
305 return GNUNET_SYSERR;
308 if (0 != memcmp (&msg->origin_identity,
309 GMP_get_id (t->peer),
310 sizeof (struct GNUNET_PeerIdentity)))
311 return GNUNET_SYSERR;
313 /* Check signature */
315 GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_MESH_KX,
318 &msg->origin_identity.public_key))
319 return GNUNET_SYSERR;
326 * Encrypt data with the tunnel key.
328 * @param t Tunnel whose key to use.
329 * @param dst Destination for the encrypted data.
330 * @param src Source of the plaintext. Can overlap with @c dst.
331 * @param size Size of the plaintext.
332 * @param iv Initialization Vector to use.
335 t_encrypt (struct MeshTunnel3 *t,
336 void *dst, const void *src,
337 size_t size, uint32_t iv)
339 struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
341 GNUNET_CRYPTO_symmetric_derive_iv (&siv, &t->e_key, &iv, sizeof (uint32_t), NULL);
342 return GNUNET_CRYPTO_symmetric_encrypt (src, size, &t->e_key, &siv, dst);
347 * Decrypt data with the tunnel key.
349 * @param t Tunnel whose key to use.
350 * @param dst Destination for the plaintext.
351 * @param src Source of the encrypted data. Can overlap with @c dst.
352 * @param size Size of the encrypted data.
353 * @param iv Initialization Vector to use.
356 t_decrypt (struct MeshTunnel3 *t,
357 void *dst, const void *src,
358 size_t size, uint32_t iv)
360 struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
362 GNUNET_CRYPTO_symmetric_derive_iv (&siv, &t->e_key, &iv, sizeof (uint32_t), NULL);
363 return GNUNET_CRYPTO_symmetric_decrypt (src, size, &t->d_key, &siv, dst);
368 * Create key material by doing ECDH on the local and remote ephemeral keys.
370 * @param key_material Where to store the key material.
371 * @param ephemeral_key Peer's public ephemeral key.
374 derive_key_material (struct GNUNET_HashCode *key_material,
375 const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral_key)
378 GNUNET_CRYPTO_ecc_ecdh (my_ephemeral_key,
387 * Create a symmetic key from the identities of both ends and the key material
390 * @param key Destination for the generated key.
391 * @param sender ID of the peer that will encrypt with @c key.
392 * @param receiver ID of the peer that will decrypt with @c key.
393 * @param key_material Hash created with ECDH with the ephemeral keys.
396 derive_symmertic (struct GNUNET_CRYPTO_SymmetricSessionKey *key,
397 const struct GNUNET_PeerIdentity *sender,
398 const struct GNUNET_PeerIdentity *receiver,
399 const struct GNUNET_HashCode *key_material)
401 const char salt[] = "MESH kx salt";
403 GNUNET_CRYPTO_kdf (key, sizeof (struct GNUNET_CRYPTO_SymmetricSessionKey),
405 key_material, sizeof (struct GNUNET_HashCode),
406 sender, sizeof (struct GNUNET_PeerIdentity),
407 receiver, sizeof (struct GNUNET_PeerIdentity),
412 * Pick a connection on which send the next data message.
414 * @param t Tunnel on which to send the message.
415 * @param fwd Is this a fwd message?
417 * @return The connection on which to send the next message.
419 static struct MeshConnection *
420 tunnel_get_connection (struct MeshTunnel3 *t, int fwd)
422 struct MeshTConnection *iter;
423 struct MeshConnection *best;
425 unsigned int lowest_q;
427 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel_get_connection %s\n", GMP_2s (t->peer));
430 for (iter = t->connection_head; NULL != iter; iter = iter->next)
432 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s: %u\n",
433 GNUNET_h2s (GMC_get_id (iter->c)), GMC_get_state (iter->c));
434 if (MESH_CONNECTION_READY == GMC_get_state (iter->c))
436 qn = GMC_get_qn (iter->c, fwd);
437 LOG (GNUNET_ERROR_TYPE_DEBUG, " q_n %u, \n", qn);
450 * Send the ephemeral key on a tunnel.
452 * @param t Tunnel on which to send the key.
455 send_ephemeral (struct MeshTunnel3 *t)
457 kx_msg.sender_status = htonl (t->state);
459 /* When channel is NULL, fwd is irrelevant. */
460 GMT_send_prebuilt_message (&kx_msg.header, t, NULL, GNUNET_YES);
464 * Send a ping message on a tunnel.
466 * @param t Tunnel on which to send the ping.
469 send_ping (struct MeshTunnel3 *t)
471 struct GNUNET_MESH_KX_Ping msg;
473 msg.header.size = htons (sizeof (msg));
474 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX_PING);
475 msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
476 msg.target = *GMP_get_id (t->peer);
477 msg.nonce = t->kx_ctx->challenge;
478 t_encrypt (t, &msg.target, &msg.target, ping_encryption_size(), msg.iv);
480 /* When channel is NULL, fwd is irrelevant. */
481 GMT_send_prebuilt_message (&msg.header, t, NULL, GNUNET_YES);
486 * Send a pong message on a tunnel.
488 * @param t Tunnel on which to send the pong.
489 * @param challenge Value sent in the ping that we have to send back.
492 send_pong (struct MeshTunnel3 *t, uint32_t challenge)
494 struct GNUNET_MESH_KX_Pong msg;
496 msg.header.size = htons (sizeof (msg));
497 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX_PONG);
498 msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
499 msg.nonce = challenge;
500 t_encrypt (t, &msg.nonce, &msg.nonce, sizeof (msg.nonce), msg.iv);
502 /* When channel is NULL, fwd is irrelevant. */
503 GMT_send_prebuilt_message (&msg.header, t, NULL, GNUNET_YES);
508 * Initiate a rekey with the remote peer.
510 * @param cls Closure (tunnel).
511 * @param tc TaskContext.
514 rekey_tunnel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
516 struct MeshTunnel3 *t = cls;
518 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
520 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
523 t->kx_ctx = GNUNET_new (struct MeshTunnelKXCtx);
524 t->kx_ctx->challenge = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
526 t->kx_ctx->d_key_old = t->d_key;
529 t->rekey_task = GNUNET_SCHEDULER_add_delayed (REKEY_WAIT, &rekey_tunnel, t);
534 * Out ephemeral key has changed, create new session key on all tunnels.
536 * @param cls Closure (size of the hashmap).
537 * @param key Current public key.
538 * @param value Value in the hash map (tunnel).
540 * @return #GNUNET_YES, so we should continue to iterate,
543 rekey_iterator (void *cls,
544 const struct GNUNET_PeerIdentity *key,
547 struct MeshTunnel3 *t = value;
548 struct GNUNET_TIME_Relative delay;
552 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, (uint32_t) n * 100);
553 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, r);
554 t->rekey_task = GNUNET_SCHEDULER_add_delayed (delay, &rekey_tunnel, t);
561 * Create a new ephemeral key and key message, schedule next rekeying.
563 * @param cls Closure (unused).
564 * @param tc TaskContext.
567 rekey (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
569 struct GNUNET_TIME_Absolute time;
572 rekey_task = GNUNET_SCHEDULER_NO_TASK;
574 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
577 GNUNET_free_non_null (my_ephemeral_key);
578 my_ephemeral_key = GNUNET_CRYPTO_ecdhe_key_create ();
580 time = GNUNET_TIME_absolute_get ();
581 kx_msg.creation_time = GNUNET_TIME_absolute_hton (time);
582 time = GNUNET_TIME_absolute_add (time, rekey_period);
583 time = GNUNET_TIME_absolute_add (time, GNUNET_TIME_UNIT_MINUTES);
584 kx_msg.expiration_time = GNUNET_TIME_absolute_hton (time);
585 GNUNET_CRYPTO_ecdhe_key_get_public (my_ephemeral_key, &kx_msg.ephemeral_key);
587 GNUNET_assert (GNUNET_OK ==
588 GNUNET_CRYPTO_eddsa_sign (my_private_key,
592 n = (long) GNUNET_CONTAINER_multipeermap_size (tunnels);
593 GNUNET_CONTAINER_multipeermap_iterate (tunnels, &rekey_iterator, (void *) n);
595 rekey_task = GNUNET_SCHEDULER_add_delayed (rekey_period, &rekey, NULL);
600 * Demultiplex data per channel and call appropriate channel handler.
602 * @param t Tunnel on which the data came.
603 * @param msg Data message.
604 * @param fwd Is this FWD data? (root -> dest)
607 handle_data (struct MeshTunnel3 *t,
608 const struct GNUNET_MESH_Data *msg,
611 struct MeshChannel *ch;
616 size = ntohs (msg->header.size);
618 sizeof (struct GNUNET_MESH_Data) +
619 sizeof (struct GNUNET_MessageHeader))
624 type = ntohs (msg->header.type);
625 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message\n",
626 GNUNET_MESH_DEBUG_M2S (type));
627 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload of type %s\n",
628 GNUNET_MESH_DEBUG_M2S (ntohs (msg[1].header.type)));
631 ch = GMT_get_channel (t, ntohl (msg->chid));
634 GNUNET_STATISTICS_update (stats, "# data on unknown channel",
636 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
641 GMT_change_state (t, MESH_TUNNEL3_READY);
642 GMCH_handle_data (ch, msg, fwd);
646 handle_data_ack (struct MeshTunnel3 *t,
647 const struct GNUNET_MESH_DataACK *msg,
650 struct MeshChannel *ch;
654 size = ntohs (msg->header.size);
655 if (size != sizeof (struct GNUNET_MESH_DataACK))
662 ch = GMT_get_channel (t, ntohl (msg->chid));
665 GNUNET_STATISTICS_update (stats, "# data ack on unknown channel",
667 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
672 GMCH_handle_data_ack (ch, msg, fwd);
676 handle_ch_create (struct MeshTunnel3 *t,
677 const struct GNUNET_MESH_ChannelCreate *msg,
680 struct MeshChannel *ch;
684 size = ntohs (msg->header.size);
685 if (size != sizeof (struct GNUNET_MESH_ChannelCreate))
692 ch = GMT_get_channel (t, ntohl (msg->chid));
695 /* Probably a retransmission, safe to ignore */
696 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists...\n");
700 ch = GMCH_handle_create (t, msg, fwd);
702 GMT_add_channel (t, ch);
706 handle_ch_ack (struct MeshTunnel3 *t,
707 const struct GNUNET_MESH_ChannelManage *msg,
710 struct MeshChannel *ch;
714 size = ntohs (msg->header.size);
715 if (size != sizeof (struct GNUNET_MESH_ChannelManage))
722 ch = GMT_get_channel (t, ntohl (msg->chid));
725 GNUNET_STATISTICS_update (stats, "# channel ack on unknown channel",
727 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
732 GMCH_handle_ack (ch, msg, fwd);
736 handle_ch_destroy (struct MeshTunnel3 *t,
737 const struct GNUNET_MESH_ChannelManage *msg,
740 struct MeshChannel *ch;
744 size = ntohs (msg->header.size);
745 if (size != sizeof (struct GNUNET_MESH_ChannelManage))
752 ch = GMT_get_channel (t, ntohl (msg->chid));
755 /* Probably a retransmission, safe to ignore */
759 GMCH_handle_destroy (ch, msg, fwd);
764 * The peer's ephemeral key has changed: update the symmetrical keys.
766 * @param t Tunnel this message came on.
767 * @param msg Key eXchange message.
770 handle_ephemeral (struct MeshTunnel3 *t,
771 const struct GNUNET_MESH_KX_Ephemeral *msg)
773 struct GNUNET_HashCode km;
774 LOG (GNUNET_ERROR_TYPE_DEBUG, " ephemeral key message\n");
776 if (GNUNET_OK != check_ephemeral (t, msg))
781 derive_key_material (&km, &msg->ephemeral_key);
782 derive_symmertic (&t->e_key, &my_full_id, GMP_get_id (t->peer), &km);
783 derive_symmertic (&t->d_key, GMP_get_id (t->peer), &my_full_id, &km);
788 * Peer wants to check our symmetrical keys by sending an encrypted challenge.
789 * Answer with by retransmitting the challenge with the "opposite" key.
791 * @param t Tunnel this message came on.
792 * @param msg Key eXchange Ping message.
795 handle_ping (struct MeshTunnel3 *t,
796 const struct GNUNET_MESH_KX_Ping *msg)
798 struct GNUNET_MESH_KX_Ping res;
800 LOG (GNUNET_ERROR_TYPE_DEBUG, " ping message\n");
801 t_decrypt (t, &res.target, &msg->target, ping_encryption_size(), msg->iv);
802 if (0 != memcmp (&my_full_id, &msg->target, sizeof (my_full_id)))
805 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %s\n", GNUNET_i2s (&my_full_id));
806 LOG (GNUNET_ERROR_TYPE_DEBUG, " for %s\n", GNUNET_i2s (&msg->target));
810 send_pong (t, res.iv);
815 * Peer has answer to our challenge.
816 * If answer is successful, consider the key exchange finished and clean
817 * up all related state.
819 * @param t Tunnel this message came on.
820 * @param msg Key eXchange Pong message.
823 handle_pong (struct MeshTunnel3 *t,
824 const struct GNUNET_MESH_KX_Pong *msg)
826 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
828 GNUNET_SCHEDULER_cancel (t->rekey_task);
829 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
830 GNUNET_free (t->kx_ctx);
841 * Demultiplex by message type and call appropriate handler for a message
842 * towards a channel of a local tunnel.
844 * @param t Tunnel this message came on.
845 * @param msgh Message header.
846 * @param fwd Is this message fwd?
849 handle_decrypted (struct MeshTunnel3 *t,
850 const struct GNUNET_MessageHeader *msgh,
855 type = ntohs (msgh->type);
856 LOG (GNUNET_ERROR_TYPE_DEBUG,
857 "Got a %s message!\n",
858 GNUNET_MESH_DEBUG_M2S (type));
862 case GNUNET_MESSAGE_TYPE_MESH_DATA:
863 /* Don't send hop ACK, wait for client to ACK */
864 handle_data (t, (struct GNUNET_MESH_Data *) msgh, fwd);
867 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
868 handle_data_ack (t, (struct GNUNET_MESH_DataACK *) msgh, fwd);
871 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
873 (struct GNUNET_MESH_ChannelCreate *) msgh,
877 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
879 (struct GNUNET_MESH_ChannelManage *) msgh,
883 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
884 handle_ch_destroy (t,
885 (struct GNUNET_MESH_ChannelManage *) msgh,
891 LOG (GNUNET_ERROR_TYPE_DEBUG,
892 "end-to-end message not known (%u)\n",
897 /******************************************************************************/
898 /******************************** API ***********************************/
899 /******************************************************************************/
902 * Decrypt and demultiplex by message type. Call appropriate handler
905 * @param t Tunnel this message came on.
906 * @param msg Encrypted message.
907 * @param fwd Is this message fwd?
910 GMT_handle_encrypted (struct MeshTunnel3 *t,
911 const struct GNUNET_MESH_Encrypted *msg,
914 size_t size = ntohs (msg->header.size);
915 size_t payload_size = size - sizeof (struct GNUNET_MESH_Encrypted);
916 size_t decrypted_size;
917 char cbuf [payload_size];
918 struct GNUNET_MessageHeader *msgh;
921 decrypted_size = t_decrypt (t, cbuf, &msg[1], payload_size, msg->iv);
923 while (off < decrypted_size)
925 msgh = (struct GNUNET_MessageHeader *) &cbuf[off];
926 handle_decrypted (t, msgh, fwd);
927 off += ntohs (msgh->size);
933 * Demultiplex an encapsulated KX message by message type.
935 * @param t Tunnel on which the message came.
936 * @param message Payload of KX message.
939 GMT_handle_kx (struct MeshTunnel3 *t,
940 const struct GNUNET_MessageHeader *message)
944 type = ntohs (message->type);
945 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message received\n", type);
948 case GNUNET_MESSAGE_TYPE_MESH_KX:
949 handle_ephemeral (t, (struct GNUNET_MESH_KX_Ephemeral *) message);
952 case GNUNET_MESSAGE_TYPE_MESH_KX_PING:
953 handle_ping (t, (struct GNUNET_MESH_KX_Ping *) message);
956 case GNUNET_MESSAGE_TYPE_MESH_KX_PONG:
957 handle_pong (t, (struct GNUNET_MESH_KX_Pong *) message);
962 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message not known (%u)\n", type);
969 * Cache a message to be sent once tunnel is online.
971 * @param t Tunnel to hold the message.
972 * @param ch Channel the message is about.
973 * @param msg Message itself (copy will be made).
974 * @param fwd Is this fwd?
977 GMT_queue_data (struct MeshTunnel3 *t,
978 struct MeshChannel *ch,
979 struct GNUNET_MessageHeader *msg,
982 struct MeshTunnelQueue *tq;
983 uint16_t size = ntohs (msg->size);
985 tq = GNUNET_malloc (sizeof (struct MeshTunnelQueue) + size);
988 memcpy (&tq[1], msg, size);
989 GNUNET_CONTAINER_DLL_insert_tail (t->tq_head, t->tq_tail, tq);
991 if (MESH_TUNNEL3_READY == t->state)
992 GMT_send_queued_data (t, fwd);
997 * Send all cached messages that we can, tunnel is online.
999 * @param t Tunnel that holds the messages.
1000 * @param fwd Is this fwd?
1003 GMT_send_queued_data (struct MeshTunnel3 *t, int fwd)
1005 struct MeshTunnelQueue *tq;
1006 struct MeshTunnelQueue *next;
1009 LOG (GNUNET_ERROR_TYPE_DEBUG,
1010 "GMT_send_queued_data on tunnel %s\n",
1012 room = GMT_get_buffer (t, fwd);
1013 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space: %u\n", room);
1014 for (tq = t->tq_head; NULL != tq && room > 0; tq = next)
1016 LOG (GNUNET_ERROR_TYPE_DEBUG, " data on channel %s\n", GMCH_2s (tq->ch));
1019 GNUNET_CONTAINER_DLL_remove (t->tq_head, t->tq_tail, tq);
1020 GMCH_send_prebuilt_message ((struct GNUNET_MessageHeader *) &tq[1],
1025 LOG (GNUNET_ERROR_TYPE_DEBUG,
1026 "GMT_send_queued_data end\n",
1032 * Initialize the tunnel subsystem.
1034 * @param c Configuration handle.
1035 * @param key ECC private key, to derive all other keys and do crypto.
1038 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
1039 const struct GNUNET_CRYPTO_EddsaPrivateKey *key)
1041 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1043 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DEFAULT_TTL",
1046 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1047 "MESH", "DEFAULT_TTL", "USING DEFAULT");
1051 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REKEY_PERIOD",
1054 rekey_period = GNUNET_TIME_UNIT_DAYS;
1057 my_private_key = key;
1058 kx_msg.header.size = htons (sizeof (kx_msg));
1059 kx_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX);
1060 kx_msg.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_MESH_KX);
1061 kx_msg.purpose.size = htonl (ephemeral_purpose_size ());
1062 kx_msg.origin_identity = my_full_id;
1063 rekey_task = GNUNET_SCHEDULER_add_now (&rekey, NULL);
1065 tunnels = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
1070 * Shut down the tunnel subsystem.
1075 if (GNUNET_SCHEDULER_NO_TASK != rekey_task)
1077 GNUNET_SCHEDULER_cancel (rekey_task);
1078 rekey_task = GNUNET_SCHEDULER_NO_TASK;
1080 GNUNET_CONTAINER_multipeermap_destroy (tunnels);
1087 * @param destination Peer this tunnel is towards.
1089 struct MeshTunnel3 *
1090 GMT_new (struct MeshPeer *destination)
1092 struct MeshTunnel3 *t;
1094 t = GNUNET_new (struct MeshTunnel3);
1096 t->peer = destination;
1099 GNUNET_CONTAINER_multipeermap_put (tunnels, GMP_get_id (destination), t,
1100 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
1111 * Change the tunnel state.
1113 * @param t Tunnel whose state to change.
1114 * @param state New state.
1117 GMT_change_state (struct MeshTunnel3* t, enum MeshTunnel3State state)
1121 LOG (GNUNET_ERROR_TYPE_DEBUG,
1122 "Tunnel %s state was %s\n",
1124 GMT_state2s (t->state));
1125 LOG (GNUNET_ERROR_TYPE_DEBUG,
1126 "Tunnel %s state is now %s\n",
1128 GMT_state2s (state));
1130 if (MESH_TUNNEL3_READY == state && 3 <= GMT_count_connections (t))
1132 GMP_stop_search (t->peer);
1138 * Add a connection to a tunnel.
1141 * @param c Connection.
1144 GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c)
1146 struct MeshTConnection *aux;
1148 for (aux = t->connection_head; aux != NULL; aux = aux->next)
1152 aux = GNUNET_new (struct MeshTConnection);
1154 GNUNET_CONTAINER_DLL_insert_tail (t->connection_head, t->connection_tail, aux);
1159 * Remove a connection from a tunnel.
1162 * @param c Connection.
1165 GMT_remove_connection (struct MeshTunnel3 *t, struct MeshConnection *c)
1167 struct MeshTConnection *aux;
1169 for (aux = t->connection_head; aux != NULL; aux = aux->next)
1172 GNUNET_CONTAINER_DLL_remove (t->connection_head, t->connection_tail, aux);
1180 * Add a channel to a tunnel.
1183 * @param ch Channel.
1186 GMT_add_channel (struct MeshTunnel3 *t, struct MeshChannel *ch)
1188 struct MeshTChannel *aux;
1190 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding channel %p to tunnel %p\n", ch, t);
1192 for (aux = t->channel_head; aux != NULL; aux = aux->next)
1194 LOG (GNUNET_ERROR_TYPE_DEBUG, " already there %p\n", aux->ch);
1199 aux = GNUNET_new (struct MeshTChannel);
1201 LOG (GNUNET_ERROR_TYPE_DEBUG, " adding %p to %p\n", aux, t->channel_head);
1202 GNUNET_CONTAINER_DLL_insert_tail (t->channel_head, t->channel_tail, aux);
1207 * Remove a channel from a tunnel.
1210 * @param ch Channel.
1213 GMT_remove_channel (struct MeshTunnel3 *t, struct MeshChannel *ch)
1215 struct MeshTChannel *aux;
1217 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing channel %p from tunnel %p\n", ch, t);
1218 for (aux = t->channel_head; aux != NULL; aux = aux->next)
1222 LOG (GNUNET_ERROR_TYPE_DEBUG, " found! %s\n", GMCH_2s (ch));
1223 GNUNET_CONTAINER_DLL_remove (t->channel_head, t->channel_tail, aux);
1232 * Search for a channel by global ID.
1234 * @param t Tunnel containing the channel.
1235 * @param chid Public channel number.
1237 * @return channel handler, NULL if doesn't exist
1239 struct MeshChannel *
1240 GMT_get_channel (struct MeshTunnel3 *t, MESH_ChannelNumber chid)
1242 struct MeshTChannel *iter;
1247 for (iter = t->channel_head; NULL != iter; iter = iter->next)
1249 if (GMCH_get_id (iter->ch) == chid)
1253 return NULL == iter ? NULL : iter->ch;
1258 * Tunnel is empty: destroy it.
1260 * Notifies all connections about the destruction.
1262 * @param t Tunnel to destroy.
1265 GMT_destroy_empty (struct MeshTunnel3 *t)
1267 struct MeshTConnection *iter;
1269 for (iter = t->connection_head; NULL != iter; iter = iter->next)
1271 GMC_send_destroy (iter->c);
1274 t->destroy = GNUNET_YES;
1279 * Destroy tunnel if empty (no more channels).
1281 * @param t Tunnel to destroy if empty.
1284 GMT_destroy_if_empty (struct MeshTunnel3 *t)
1286 if (1 < GMT_count_channels (t))
1289 GMT_destroy_empty (t);
1294 * Destroy the tunnel.
1296 * This function does not generate any warning traffic to clients or peers.
1299 * Cancel messages belonging to this tunnel queued to neighbors.
1300 * Free any allocated resources linked to the tunnel.
1302 * @param t The tunnel to destroy.
1305 GMT_destroy (struct MeshTunnel3 *t)
1307 struct MeshTConnection *iter;
1308 struct MeshTConnection *next;
1313 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying tunnel %s\n", GMP_2s (t->peer));
1315 // if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_remove (tunnels, &t->id, t))
1316 // GNUNET_break (0);
1318 for (iter = t->connection_head; NULL != iter; iter = next)
1321 GMC_destroy (iter->c);
1324 GNUNET_STATISTICS_update (stats, "# tunnels", -1, GNUNET_NO);
1325 GMP_set_tunnel (t->peer, NULL);
1327 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
1328 GNUNET_SCHEDULER_cancel (t->rekey_task);
1335 * @brief Use the given path for the tunnel.
1336 * Update the next and prev hops (and RCs).
1337 * (Re)start the path refresh in case the tunnel is locally owned.
1339 * @param t Tunnel to update.
1340 * @param p Path to use.
1342 * @return Connection created.
1344 struct MeshConnection *
1345 GMT_use_path (struct MeshTunnel3 *t, struct MeshPeerPath *p)
1347 struct MeshConnection *c;
1348 struct GNUNET_HashCode cid;
1349 unsigned int own_pos;
1351 if (NULL == t || NULL == p)
1357 for (own_pos = 0; own_pos < p->length; own_pos++)
1359 if (p->peers[own_pos] == myid)
1362 if (own_pos > p->length - 1)
1368 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE, &cid);
1369 c = GMC_new (&cid, t, p, own_pos);
1370 GMT_add_connection (t, c);
1376 * Count established (ready) connections of a tunnel.
1378 * @param t Tunnel on which to count.
1380 * @return Number of connections.
1383 GMT_count_connections (struct MeshTunnel3 *t)
1385 struct MeshTConnection *iter;
1388 for (count = 0, iter = t->connection_head;
1390 iter = iter->next, count++);
1396 * Count channels of a tunnel.
1398 * @param t Tunnel on which to count.
1400 * @return Number of channels.
1403 GMT_count_channels (struct MeshTunnel3 *t)
1405 struct MeshTChannel *iter;
1408 for (count = 0, iter = t->channel_head;
1410 iter = iter->next, count++) /* skip */;
1417 * Get the state of a tunnel.
1421 * @return Tunnel's state.
1423 enum MeshTunnel3State
1424 GMT_get_state (struct MeshTunnel3 *t)
1427 return (enum MeshTunnel3State) -1;
1432 * Get the total buffer space for a tunnel.
1434 * If terminal, use the biggest channel buffer (or 64) if no channel exists.
1435 * If not terminal, use the sum of all connection buffers.
1438 * @param fwd Is this for FWD traffic?
1440 * @return Buffer space offered by all entities (c/ch) in the tunnel.
1443 GMT_get_buffer (struct MeshTunnel3 *t, int fwd)
1445 struct MeshTConnection *iter;
1446 unsigned int buffer;
1448 iter = t->connection_head;
1451 /* If terminal, return biggest channel buffer */
1452 if (NULL == iter || GMC_is_terminal (iter->c, fwd))
1454 struct MeshTChannel *iter_ch;
1455 unsigned int ch_buf;
1457 if (NULL == t->channel_head)
1459 /* Probably getting buffer for a channel create/handshake. */
1463 for (iter_ch = t->channel_head; NULL != iter_ch; iter_ch = iter_ch->next)
1465 ch_buf = GMCH_get_buffer (iter_ch->ch, fwd);
1466 if (ch_buf > buffer)
1472 /* If not terminal, return sum of connection buffers */
1473 while (NULL != iter)
1475 if (GMC_get_state (iter->c) != MESH_CONNECTION_READY)
1481 buffer += GMC_get_buffer (iter->c, fwd);
1490 * Get the tunnel's destination.
1494 * @return ID of the destination peer.
1496 const struct GNUNET_PeerIdentity *
1497 GMT_get_destination (struct MeshTunnel3 *t)
1499 return GMP_get_id (t->peer);
1504 * Get the tunnel's next free global channel ID.
1508 * @return GID of a channel free to use.
1511 GMT_get_next_chid (struct MeshTunnel3 *t)
1513 MESH_ChannelNumber chid;
1515 while (NULL != GMT_get_channel (t, t->next_chid))
1517 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists...\n", t->next_chid);
1518 t->next_chid = (t->next_chid + 1) & ~GNUNET_MESH_LOCAL_CHANNEL_ID_CLI;
1520 chid = t->next_chid;
1521 t->next_chid = (t->next_chid + 1) & ~GNUNET_MESH_LOCAL_CHANNEL_ID_CLI;
1528 * Send ACK on one or more channels due to buffer in connections.
1530 * @param t Channel which has some free buffer space.
1531 * @param fwd Is this for FWD traffic? (ACK goes to root)
1534 GMT_unchoke_channels (struct MeshTunnel3 *t, int fwd)
1536 struct MeshTChannel *iter;
1537 unsigned int buffer;
1538 unsigned int channels = GMT_count_channels (t);
1539 unsigned int choked_n;
1540 struct MeshChannel *choked[channels];
1542 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT_unchoke_channels on %s\n", GMT_2s (t));
1543 LOG (GNUNET_ERROR_TYPE_DEBUG, " head: %p\n", t->channel_head);
1544 if (NULL != t->channel_head)
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, " head ch: %p\n", t->channel_head->ch);
1553 /* Get buffer space */
1554 buffer = GMT_get_buffer (t, fwd);
1560 /* Count and remember choked channels */
1562 for (iter = t->channel_head; NULL != iter; iter = iter->next)
1564 if (GNUNET_NO == GMCH_get_allowed (iter->ch, fwd))
1566 choked[choked_n++] = iter->ch;
1570 /* Unchoke random channels */
1571 while (0 < buffer && 0 < choked_n)
1573 unsigned int r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1575 GMCH_allow_client (choked[r], fwd);
1578 choked[r] = choked[choked_n];
1584 * Send ACK on one or more connections due to buffer space to the client.
1586 * Iterates all connections of the tunnel and sends ACKs appropriately.
1589 * @param fwd Is this in for FWD traffic? (ACK goes dest->root)
1592 GMT_send_acks (struct MeshTunnel3 *t, int fwd)
1594 struct MeshTConnection *iter;
1597 uint32_t allow_per_connection;
1599 unsigned int buffer;
1601 LOG (GNUNET_ERROR_TYPE_DEBUG,
1602 "Tunnel send %s ACKs on %s\n",
1603 fwd ? "FWD" : "BCK", GMT_2s (t));
1610 if (NULL == t->channel_head ||
1611 GNUNET_NO == GMCH_is_origin (t->channel_head->ch, !fwd))
1617 buffer = GMT_get_buffer (t, fwd);
1619 /* Count connections, how many messages are already allowed */
1620 cs = GMT_count_connections (t);
1621 for (allowed = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
1623 allowed += GMC_get_allowed (iter->c, fwd);
1626 /* Make sure there is no overflow */
1627 if (allowed > buffer)
1633 /* Authorize connections to send more data */
1634 to_allow = buffer; /* - allowed; */
1636 for (iter = t->connection_head; NULL != iter && to_allow > 0; iter = iter->next)
1638 allow_per_connection = to_allow/cs;
1639 to_allow -= allow_per_connection;
1641 if (GMC_get_allowed (iter->c, fwd) > 64 / 3)
1645 GMC_allow (iter->c, buffer, fwd);
1648 GNUNET_break (to_allow == 0);
1653 * Sends an already built message on a tunnel, encrypting it and
1654 * choosing the best connection.
1656 * @param message Message to send. Function modifies it.
1657 * @param t Tunnel on which this message is transmitted.
1658 * @param ch Channel on which this message is transmitted.
1659 * @param fwd Is this a fwd message?
1662 GMT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
1663 struct MeshTunnel3 *t,
1664 struct MeshChannel *ch,
1667 struct MeshConnection *c;
1668 struct GNUNET_MESH_Encrypted *msg;
1669 size_t size = ntohs (message->size);
1670 size_t encrypted_size;
1671 char *cbuf[sizeof (struct GNUNET_MESH_Encrypted) + size + 64];
1675 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT Send on Tunnel %s\n", GMT_2s (t));
1677 iv = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_NONCE, UINT64_MAX);
1678 msg = (struct GNUNET_MESH_Encrypted *) cbuf;
1679 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED);
1680 msg->iv = GNUNET_htonll (iv);
1681 encrypted_size = t_encrypt (t, &msg[1], message, size, iv);
1682 msg->header.size = htons (sizeof (struct GNUNET_MESH_Encrypted) + encrypted_size);
1683 c = tunnel_get_connection (t, fwd);
1686 GNUNET_break (GNUNET_YES == t->destroy);
1689 type = ntohs (message->type);
1692 case GNUNET_MESSAGE_TYPE_MESH_DATA:
1693 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1694 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1695 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1696 msg->cid = *GMC_get_id (c);
1697 msg->ttl = htonl (default_ttl);
1700 LOG (GNUNET_ERROR_TYPE_DEBUG, "unkown type %s\n",
1701 GNUNET_MESH_DEBUG_M2S (type));
1705 GMC_send_prebuilt_message (&msg->header, c, fwd);
1709 * Is the tunnel directed towards the local peer?
1713 * @return GNUNET_YES if it is loopback.
1716 GMT_is_loopback (const struct MeshTunnel3 *t)
1718 return (myid == GMP_get_short_id(t->peer));
1723 * Is the tunnel using this path already?
1728 * @return GNUNET_YES a connection uses this path.
1731 GMT_is_path_used (const struct MeshTunnel3 *t, const struct MeshPeerPath *p)
1733 struct MeshTConnection *iter;
1735 for (iter = t->connection_head; NULL != iter; iter = iter->next)
1736 if (GMC_get_path (iter->c) == p)
1744 * Get a cost of a path for a tunnel considering existing connections.
1747 * @param path Candidate path.
1749 * @return Cost of the path (path length + number of overlapping nodes)
1752 GMT_get_path_cost (const struct MeshTunnel3 *t,
1753 const struct MeshPeerPath *path)
1755 struct MeshTConnection *iter;
1756 unsigned int overlap;
1764 GNUNET_assert (NULL != t);
1766 for (i = 0; i < path->length; i++)
1768 for (iter = t->connection_head; NULL != iter; iter = iter->next)
1770 for (j = 0; j < GMC_get_path (iter->c)->length; j++)
1772 if (path->peers[i] == GMC_get_path (iter->c)->peers[j])
1780 return (path->length + overlap) * (path->score * -1);
1785 * Get the static string for the peer this tunnel is directed.
1789 * @return Static string the destination peer's ID.
1792 GMT_2s (const struct MeshTunnel3 *t)
1794 return GMP_2s (t->peer);