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.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, 5)
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 connectivity.
87 enum MeshTunnel3CState cstate;
90 * State of the tunnel encryption.
92 enum MeshTunnel3EState estate;
95 * Key eXchange context.
97 struct MeshTunnelKXCtx *kx_ctx;
100 * Encryption ("our") key.
102 struct GNUNET_CRYPTO_SymmetricSessionKey e_key;
105 * Decryption ("their") key.
107 struct GNUNET_CRYPTO_SymmetricSessionKey d_key;
110 * Task to start the rekey process.
112 GNUNET_SCHEDULER_TaskIdentifier rekey_task;
115 * Paths that are actively used to reach the destination peer.
117 struct MeshTConnection *connection_head;
118 struct MeshTConnection *connection_tail;
121 * Next connection number.
126 * Channels inside this tunnel.
128 struct MeshTChannel *channel_head;
129 struct MeshTChannel *channel_tail;
132 * Channel ID for the next created channel.
134 MESH_ChannelNumber next_chid;
137 * Destroy flag: if true, destroy on last message.
142 * Queued messages, to transmit once tunnel gets connected.
144 struct MeshTunnelDelayed *tq_head;
145 struct MeshTunnelDelayed *tq_tail;
150 * Struct used to save messages in a non-ready tunnel to send once connected.
152 struct MeshTunnelDelayed
157 struct MeshTunnelDelayed *next;
158 struct MeshTunnelDelayed *prev;
163 struct MeshTunnel3 *t;
166 * Tunnel queue given to the channel to cancel request. Update on send_queued.
168 struct MeshTunnel3Queue *tq;
173 /* struct GNUNET_MessageHeader *msg; */
178 * Handle for messages queued but not yet sent.
180 struct MeshTunnel3Queue
183 * Connection queue handle, to cancel if necessary.
185 struct MeshConnectionQueue *cq;
188 * Handle in case message hasn't been given to a connection yet.
190 struct MeshTunnelDelayed *tqd;
193 * Continuation to call once sent.
198 * Closure for @c cont.
204 /******************************************************************************/
205 /******************************* GLOBALS ***********************************/
206 /******************************************************************************/
209 * Global handle to the statistics service.
211 extern struct GNUNET_STATISTICS_Handle *stats;
214 * Local peer own ID (memory efficient handle).
216 extern GNUNET_PEER_Id myid;
219 * Local peer own ID (full value).
221 extern struct GNUNET_PeerIdentity my_full_id;
225 * Don't try to recover tunnels if shutting down.
227 extern int shutting_down;
231 * Set of all tunnels, in order to trigger a new exchange on rekey.
232 * Indexed by peer's ID.
234 static struct GNUNET_CONTAINER_MultiPeerMap *tunnels;
237 * Default TTL for payload packets.
239 static unsigned long long default_ttl;
244 const static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
247 * Own ephemeral private key.
249 static struct GNUNET_CRYPTO_EcdhePrivateKey *my_ephemeral_key;
252 * Cached message used to perform a key exchange.
254 static struct GNUNET_MESH_KX_Ephemeral kx_msg;
257 * Task to generate a new ephemeral key.
259 static GNUNET_SCHEDULER_TaskIdentifier rekey_task;
264 static struct GNUNET_TIME_Relative rekey_period;
266 /******************************************************************************/
267 /******************************** STATIC ***********************************/
268 /******************************************************************************/
271 * Get string description for tunnel connectivity state.
273 * @param cs Tunnel state.
275 * @return String representation.
278 cstate2s (enum MeshTunnel3CState cs)
280 static char buf[128];
284 case MESH_TUNNEL3_NEW:
285 return "MESH_TUNNEL3_NEW";
286 case MESH_TUNNEL3_SEARCHING:
287 return "MESH_TUNNEL3_SEARCHING";
288 case MESH_TUNNEL3_WAITING:
289 return "MESH_TUNNEL3_WAITING";
290 case MESH_TUNNEL3_READY:
291 return "MESH_TUNNEL3_READY";
294 sprintf (buf, "%u (UNKNOWN STATE)", cs);
302 * Get string description for tunnel encryption state.
304 * @param es Tunnel state.
306 * @return String representation.
309 estate2s (enum MeshTunnel3EState es)
311 static char buf[128];
315 case MESH_TUNNEL3_KEY_UNINITIALIZED:
316 return "MESH_TUNNEL3_KEY_UNINITIALIZED";
317 case MESH_TUNNEL3_KEY_SENT:
318 return "MESH_TUNNEL3_KEY_SENT";
319 case MESH_TUNNEL3_KEY_PING:
320 return "MESH_TUNNEL3_KEY_PING";
321 case MESH_TUNNEL3_KEY_OK:
322 return "MESH_TUNNEL3_KEY_OK";
325 sprintf (buf, "%u (UNKNOWN STATE)", es);
333 * @brief Check if tunnel is ready to send traffic.
335 * Tunnel must be connected and with encryption correctly set up.
337 * @param t Tunnel to check.
339 * @return #GNUNET_YES if ready, #GNUNET_NO otherwise
342 is_ready (struct MeshTunnel3 *t)
347 ready = (MESH_TUNNEL3_READY == t->cstate && MESH_TUNNEL3_KEY_OK == t->estate);
348 ready = ready || GMT_is_loopback (t);
354 * Ephemeral key message purpose size.
356 * @return Size of the part of the ephemeral key message that must be signed.
359 ephemeral_purpose_size (void)
361 return sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
362 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
363 sizeof (struct GNUNET_TIME_AbsoluteNBO) +
364 sizeof (struct GNUNET_CRYPTO_EcdhePublicKey) +
365 sizeof (struct GNUNET_PeerIdentity);
370 * Size of the encrypted part of a ping message.
372 * @return Size of the encrypted part of a ping message.
375 ping_encryption_size (void)
377 return sizeof (struct GNUNET_PeerIdentity) + sizeof (uint32_t);
382 * Get the channel's buffer. ONLY FOR NON-LOOPBACK CHANNELS!!
384 * @param tch Tunnel's channel handle.
386 * @return Amount of messages the channel can still buffer towards the client.
389 get_channel_buffer (const struct MeshTChannel *tch)
393 /* If channel is outgoing, is origin in the FWD direction and fwd is YES */
394 fwd = GMCH_is_origin (tch->ch, GNUNET_YES);
396 return GMCH_get_buffer (tch->ch, fwd);
401 * Get the channel's allowance status.
403 * @param tch Tunnel's channel handle.
405 * @return #GNUNET_YES if we allowed the client to send data to us.
408 get_channel_allowed (const struct MeshTChannel *tch)
412 /* If channel is outgoing, is origin in the FWD direction and fwd is YES */
413 fwd = GMCH_is_origin (tch->ch, GNUNET_YES);
415 return GMCH_get_allowed (tch->ch, fwd);
420 * Get the connection's buffer.
422 * @param tc Tunnel's connection handle.
424 * @return Amount of messages the connection can still buffer.
427 get_connection_buffer (const struct MeshTConnection *tc)
431 /* If connection is outgoing, is origin in the FWD direction and fwd is YES */
432 fwd = GMC_is_origin (tc->c, GNUNET_YES);
434 return GMC_get_buffer (tc->c, fwd);
439 * Get the connection's allowance.
441 * @param tc Tunnel's connection handle.
443 * @return Amount of messages we have allowed the next peer to send us.
446 get_connection_allowed (const struct MeshTConnection *tc)
450 /* If connection is outgoing, is origin in the FWD direction and fwd is YES */
451 fwd = GMC_is_origin (tc->c, GNUNET_YES);
453 return GMC_get_allowed (tc->c, fwd);
458 * Check that a ephemeral key message s well formed and correctly signed.
460 * @param t Tunnel on which the message came.
461 * @param msg The ephemeral key message.
463 * @return GNUNET_OK if message is fine, GNUNET_SYSERR otherwise.
466 check_ephemeral (struct MeshTunnel3 *t,
467 const struct GNUNET_MESH_KX_Ephemeral *msg)
469 /* Check message size */
470 if (ntohs (msg->header.size) != sizeof (struct GNUNET_MESH_KX_Ephemeral))
471 return GNUNET_SYSERR;
473 /* Check signature size */
474 if (ntohl (msg->purpose.size) != ephemeral_purpose_size ())
475 return GNUNET_SYSERR;
478 if (0 != memcmp (&msg->origin_identity,
479 GMP_get_id (t->peer),
480 sizeof (struct GNUNET_PeerIdentity)))
481 return GNUNET_SYSERR;
483 /* Check signature */
485 GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_MESH_KX,
488 &msg->origin_identity.public_key))
489 return GNUNET_SYSERR;
496 * Encrypt data with the tunnel key.
498 * @param t Tunnel whose key to use.
499 * @param dst Destination for the encrypted data.
500 * @param src Source of the plaintext. Can overlap with @c dst.
501 * @param size Size of the plaintext.
502 * @param iv Initialization Vector to use.
505 t_encrypt (struct MeshTunnel3 *t,
506 void *dst, const void *src,
507 size_t size, uint32_t iv)
509 struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
512 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_encrypt start\n");
513 GNUNET_CRYPTO_symmetric_derive_iv (&siv, &t->e_key, &iv, sizeof (iv), NULL);
514 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_encrypt IV derived\n");
515 out_size = GNUNET_CRYPTO_symmetric_encrypt (src, size, &t->e_key, &siv, dst);
516 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_encrypt end\n");
523 * Decrypt data with the tunnel key.
525 * @param t Tunnel whose key to use.
526 * @param dst Destination for the plaintext.
527 * @param src Source of the encrypted data. Can overlap with @c dst.
528 * @param size Size of the encrypted data.
529 * @param iv Initialization Vector to use.
532 t_decrypt (struct MeshTunnel3 *t,
533 void *dst, const void *src,
534 size_t size, uint32_t iv)
536 struct GNUNET_CRYPTO_SymmetricInitializationVector siv;
537 struct GNUNET_CRYPTO_SymmetricSessionKey *key;
540 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_decrypt start\n");
541 if (t->estate == MESH_TUNNEL3_KEY_OK || t->estate == MESH_TUNNEL3_KEY_PING)
545 else if (NULL != t->kx_ctx)
547 key = &t->kx_ctx->d_key_old;
551 GNUNET_STATISTICS_update (stats, "# non decryptable data", 1, GNUNET_NO);
552 LOG (GNUNET_ERROR_TYPE_DEBUG,
553 "WARNING got data on %s without a valid key\n",
559 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_decrypt iv\n");
560 GNUNET_CRYPTO_symmetric_derive_iv (&siv, key, &iv, sizeof (iv), NULL);
561 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_decrypt iv done\n");
562 out_size = GNUNET_CRYPTO_symmetric_decrypt (src, size, key, &siv, dst);
563 LOG (GNUNET_ERROR_TYPE_DEBUG, " t_decrypt end\n");
570 * Create key material by doing ECDH on the local and remote ephemeral keys.
572 * @param key_material Where to store the key material.
573 * @param ephemeral_key Peer's public ephemeral key.
576 derive_key_material (struct GNUNET_HashCode *key_material,
577 const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral_key)
580 GNUNET_CRYPTO_ecc_ecdh (my_ephemeral_key,
589 * Create a symmetic key from the identities of both ends and the key material
592 * @param key Destination for the generated key.
593 * @param sender ID of the peer that will encrypt with @c key.
594 * @param receiver ID of the peer that will decrypt with @c key.
595 * @param key_material Hash created with ECDH with the ephemeral keys.
598 derive_symmertic (struct GNUNET_CRYPTO_SymmetricSessionKey *key,
599 const struct GNUNET_PeerIdentity *sender,
600 const struct GNUNET_PeerIdentity *receiver,
601 const struct GNUNET_HashCode *key_material)
603 const char salt[] = "MESH kx salt";
605 GNUNET_CRYPTO_kdf (key, sizeof (struct GNUNET_CRYPTO_SymmetricSessionKey),
607 key_material, sizeof (struct GNUNET_HashCode),
608 sender, sizeof (struct GNUNET_PeerIdentity),
609 receiver, sizeof (struct GNUNET_PeerIdentity),
614 * Pick a connection on which send the next data message.
616 * @param t Tunnel on which to send the message.
618 * @return The connection on which to send the next message.
620 static struct MeshConnection *
621 tunnel_get_connection (struct MeshTunnel3 *t)
623 struct MeshTConnection *iter;
624 struct MeshConnection *best;
626 unsigned int lowest_q;
628 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel_get_connection %s\n", GMP_2s (t->peer));
631 for (iter = t->connection_head; NULL != iter; iter = iter->next)
633 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s: %u\n",
634 GMC_2s (iter->c), GMC_get_state (iter->c));
635 if (MESH_CONNECTION_READY == GMC_get_state (iter->c))
637 qn = GMC_get_qn (iter->c, GMC_is_origin (iter->c, GNUNET_YES));
638 LOG (GNUNET_ERROR_TYPE_DEBUG, " q_n %u, \n", qn);
646 LOG (GNUNET_ERROR_TYPE_DEBUG, " selected: connection %s\n", GMC_2s (best));
652 * Callback called when a queued message is sent.
654 * Calculates the average time and connection packet tracking.
656 * @param cls Closure (TunnelQueue handle).
657 * @param c Connection this message was on.
658 * @param q Connection queue handle (unused).
659 * @param type Type of message sent.
660 * @param fwd Was this a FWD going message?
661 * @param size Size of the message.
664 message_sent (void *cls,
665 struct MeshConnection *c,
666 struct MeshConnectionQueue *q,
667 uint16_t type, int fwd, size_t size)
669 struct MeshTunnel3Queue *qt = cls;
671 GNUNET_assert (NULL != qt->cont);
672 qt->cont (qt->cont_cls, GMC_get_tunnel (c), qt, type, size);
678 * Delete a queued message: either was sent or the channel was destroyed
679 * before the tunnel's key exchange had a chance to finish.
681 * @param tqd Delayed queue handle.
684 unqueue_data (struct MeshTunnelDelayed *tqd)
686 GNUNET_CONTAINER_DLL_remove (tqd->t->tq_head, tqd->t->tq_tail, tqd);
692 * Cache a message to be sent once tunnel is online.
694 * @param t Tunnel to hold the message.
695 * @param msg Message itself (copy will be made).
697 static struct MeshTunnelDelayed *
698 queue_data (struct MeshTunnel3 *t, const struct GNUNET_MessageHeader *msg)
700 struct MeshTunnelDelayed *tqd;
701 uint16_t size = ntohs (msg->size);
703 LOG (GNUNET_ERROR_TYPE_DEBUG, "queue data on Tunnel %s\n", GMT_2s (t));
705 if (GNUNET_YES == is_ready (t))
711 tqd = GNUNET_malloc (sizeof (struct MeshTunnelDelayed) + size);
714 memcpy (&tqd[1], msg, size);
715 GNUNET_CONTAINER_DLL_insert_tail (t->tq_head, t->tq_tail, tqd);
722 * Sends an already built message on a tunnel, encrypting it and
723 * choosing the best connection.
725 * @param message Message to send. Function modifies it.
726 * @param t Tunnel on which this message is transmitted.
727 * @param force Force the tunnel to take the message (buffer overfill).
728 * @param cont Continuation to call once message is really sent.
729 * @param cont_cls Closure for @c cont.
730 * @param existing_q In case this a transmission of previously queued data,
731 * this should be TunnelQueue given to the client.
734 * @return Handle to cancel message. NULL if @c cont is NULL.
736 static struct MeshTunnel3Queue *
737 send_prebuilt_message (const struct GNUNET_MessageHeader *message,
738 struct MeshTunnel3 *t, int force,
739 GMT_sent cont, void *cont_cls,
740 struct MeshTunnel3Queue *existing_q)
742 struct MeshTunnel3Queue *tq;
743 struct MeshConnection *c;
744 struct GNUNET_MESH_Encrypted *msg;
745 size_t size = ntohs (message->size);
746 char cbuf[sizeof (struct GNUNET_MESH_Encrypted) + size];
751 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT Send on Tunnel %s\n", GMT_2s (t));
753 if (GNUNET_NO == is_ready (t))
755 struct MeshTunnelDelayed *tqd;
756 /* A non null existing_q indicates sending of queued data.
757 * Should only happen after tunnel becomes ready.
759 GNUNET_assert (NULL == existing_q);
760 tqd = queue_data (t, message);
763 tq = GNUNET_new (struct MeshTunnel3Queue);
767 tq->cont_cls = cont_cls;
771 GNUNET_assert (GNUNET_NO == GMT_is_loopback (t));
773 iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
774 msg = (struct GNUNET_MESH_Encrypted *) cbuf;
775 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED);
777 GNUNET_assert (t_encrypt (t, &msg[1], message, size, iv) == size);
778 msg->header.size = htons (sizeof (struct GNUNET_MESH_Encrypted) + size);
779 c = tunnel_get_connection (t);
782 if (GNUNET_YES == t->destroy || MESH_TUNNEL3_SEARCHING != t->cstate)
789 type = ntohs (message->type);
792 case GNUNET_MESSAGE_TYPE_MESH_DATA:
793 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
794 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
795 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
796 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
797 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
798 msg->cid = *GMC_get_id (c);
799 msg->ttl = htonl (default_ttl);
802 LOG (GNUNET_ERROR_TYPE_DEBUG, "unkown type %s\n",
807 fwd = GMC_is_origin (c, GNUNET_YES);
811 (void) GMC_send_prebuilt_message (&msg->header, c, fwd, force, NULL, NULL);
814 if (NULL == existing_q)
816 tq = GNUNET_new (struct MeshTunnel3Queue); /* FIXME valgrind: leak*/
823 tq->cq = GMC_send_prebuilt_message (&msg->header, c, fwd, force,
826 tq->cont_cls = cont_cls;
833 * Send all cached messages that we can, tunnel is online.
835 * @param t Tunnel that holds the messages. Cannot be loopback.
838 send_queued_data (struct MeshTunnel3 *t)
840 struct MeshTunnelDelayed *tqd;
841 struct MeshTunnelDelayed *next;
844 LOG (GNUNET_ERROR_TYPE_DEBUG,
845 "GMT_send_queued_data on tunnel %s\n",
848 if (GMT_is_loopback (t))
854 if (GNUNET_NO == is_ready (t))
856 LOG (GNUNET_ERROR_TYPE_DEBUG, " not ready yet: %s/%s\n",
857 estate2s (t->estate), cstate2s (t->cstate));
861 room = GMT_get_connections_buffer (t);
862 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space: %u\n", room);
863 LOG (GNUNET_ERROR_TYPE_DEBUG, " tq head: %p\n", t->tq_head);
864 for (tqd = t->tq_head; NULL != tqd && room > 0; tqd = next)
866 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending queued data\n");
869 send_prebuilt_message ((struct GNUNET_MessageHeader *) &tqd[1],
871 NULL != tqd->tq ? tqd->tq->cont : NULL,
872 NULL != tqd->tq ? tqd->tq->cont_cls : NULL,
876 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT_send_queued_data end\n", GMP_2s (t->peer));
881 * Sends key exchange message on a tunnel, choosing the best connection.
882 * Should not be called on loopback tunnels.
884 * @param t Tunnel on which this message is transmitted.
885 * @param message Message to send. Function modifies it.
888 send_kx (struct MeshTunnel3 *t,
889 const struct GNUNET_MessageHeader *message)
891 struct MeshConnection *c;
892 struct GNUNET_MESH_KX *msg;
893 size_t size = ntohs (message->size);
894 char cbuf[sizeof (struct GNUNET_MESH_KX) + size];
898 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT KX on Tunnel %s\n", GMT_2s (t));
900 /* Avoid loopback. */
901 if (GMT_is_loopback (t))
903 LOG (GNUNET_ERROR_TYPE_DEBUG, " loopback!\n");
908 if (GNUNET_NO != t->destroy)
910 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother\n");
914 /* Must have a connection. */
915 if (NULL == t->connection_head)
917 GNUNET_break (MESH_TUNNEL3_SEARCHING == t->cstate);
922 msg = (struct GNUNET_MESH_KX *) cbuf;
923 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX);
924 msg->header.size = htons (sizeof (struct GNUNET_MESH_KX) + size);
925 c = tunnel_get_connection (t);
928 GNUNET_break (GNUNET_YES == t->destroy || MESH_TUNNEL3_READY != t->cstate);
932 type = ntohs (message->type);
935 case GNUNET_MESSAGE_TYPE_MESH_KX_EPHEMERAL:
936 case GNUNET_MESSAGE_TYPE_MESH_KX_PING:
937 case GNUNET_MESSAGE_TYPE_MESH_KX_PONG:
938 msg->reserved = htonl (0);
939 memcpy (&msg[1], message, size);
942 LOG (GNUNET_ERROR_TYPE_DEBUG, "unkown type %s\n",
947 fwd = GMC_is_origin (t->connection_head->c, GNUNET_YES);
948 /* TODO save handle and cancel in case of a unneeded retransmission */
949 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_YES, NULL, NULL);
954 * Send the ephemeral key on a tunnel.
956 * @param t Tunnel on which to send the key.
959 send_ephemeral (struct MeshTunnel3 *t)
961 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s()\n", __FUNCTION__);
963 kx_msg.sender_status = htonl (t->estate);
964 send_kx (t, &kx_msg.header);
968 * Send a ping message on a tunnel.
970 * @param t Tunnel on which to send the ping.
973 send_ping (struct MeshTunnel3 *t)
975 struct GNUNET_MESH_KX_Ping msg;
977 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s()\n", __FUNCTION__);
978 msg.header.size = htons (sizeof (msg));
979 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX_PING);
980 msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
981 msg.target = *GMP_get_id (t->peer);
982 msg.nonce = t->kx_ctx->challenge;
984 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending %u\n", msg.nonce);
985 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s\n", GNUNET_i2s (&msg.target));
986 t_encrypt (t, &msg.target, &msg.target, ping_encryption_size(), msg.iv);
987 LOG (GNUNET_ERROR_TYPE_DEBUG, " e sending %u\n", msg.nonce);
988 LOG (GNUNET_ERROR_TYPE_DEBUG, " e towards %s\n", GNUNET_i2s (&msg.target));
990 send_kx (t, &msg.header);
995 * Send a pong message on a tunnel.
997 * @param t Tunnel on which to send the pong.
998 * @param challenge Value sent in the ping that we have to send back.
1001 send_pong (struct MeshTunnel3 *t, uint32_t challenge)
1003 struct GNUNET_MESH_KX_Pong msg;
1005 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s()\n", __FUNCTION__);
1006 msg.header.size = htons (sizeof (msg));
1007 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX_PONG);
1008 msg.iv = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1009 msg.nonce = challenge;
1010 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending %u\n", msg.nonce);
1011 t_encrypt (t, &msg.nonce, &msg.nonce, sizeof (msg.nonce), msg.iv);
1012 LOG (GNUNET_ERROR_TYPE_DEBUG, " e sending %u\n", msg.nonce);
1014 send_kx (t, &msg.header);
1019 * Initiate a rekey with the remote peer.
1021 * @param cls Closure (tunnel).
1022 * @param tc TaskContext.
1025 rekey_tunnel (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1027 struct MeshTunnel3 *t = cls;
1029 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
1031 LOG (GNUNET_ERROR_TYPE_DEBUG, "Re-key Tunnel %s\n", GMT_2s (t));
1032 if (NULL != tc && 0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1035 if (NULL == t->kx_ctx)
1037 LOG (GNUNET_ERROR_TYPE_DEBUG, " new kx ctx\n");
1038 t->kx_ctx = GNUNET_new (struct MeshTunnelKXCtx);
1039 t->kx_ctx->challenge =
1040 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1041 t->kx_ctx->d_key_old = t->d_key;
1042 LOG (GNUNET_ERROR_TYPE_DEBUG, " new challenge for %s: %u\n",
1043 GMT_2s (t), t->kx_ctx->challenge);
1048 case MESH_TUNNEL3_KEY_UNINITIALIZED:
1049 t->estate = MESH_TUNNEL3_KEY_SENT;
1051 case MESH_TUNNEL3_KEY_SENT:
1053 case MESH_TUNNEL3_KEY_PING:
1054 case MESH_TUNNEL3_KEY_OK:
1056 t->estate = MESH_TUNNEL3_KEY_PING;
1059 LOG (GNUNET_ERROR_TYPE_DEBUG, "Unexpected state %u\n", t->estate);
1062 LOG (GNUNET_ERROR_TYPE_DEBUG, " next call in %s\n",
1063 GNUNET_STRINGS_relative_time_to_string (REKEY_WAIT, GNUNET_YES));
1064 t->rekey_task = GNUNET_SCHEDULER_add_delayed (REKEY_WAIT, &rekey_tunnel, t);
1069 * Out ephemeral key has changed, create new session key on all tunnels.
1071 * @param cls Closure (size of the hashmap).
1072 * @param key Current public key.
1073 * @param value Value in the hash map (tunnel).
1075 * @return #GNUNET_YES, so we should continue to iterate,
1078 rekey_iterator (void *cls,
1079 const struct GNUNET_PeerIdentity *key,
1082 struct MeshTunnel3 *t = value;
1083 struct GNUNET_TIME_Relative delay;
1084 long n = (long) cls;
1087 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
1090 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, (uint32_t) n * 100);
1091 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, r);
1092 t->rekey_task = GNUNET_SCHEDULER_add_delayed (delay, &rekey_tunnel, t);
1099 * Create a new ephemeral key and key message, schedule next rekeying.
1101 * @param cls Closure (unused).
1102 * @param tc TaskContext.
1105 rekey (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1107 struct GNUNET_TIME_Absolute time;
1110 rekey_task = GNUNET_SCHEDULER_NO_TASK;
1112 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1115 GNUNET_free_non_null (my_ephemeral_key);
1116 my_ephemeral_key = GNUNET_CRYPTO_ecdhe_key_create ();
1118 time = GNUNET_TIME_absolute_get ();
1119 kx_msg.creation_time = GNUNET_TIME_absolute_hton (time);
1120 time = GNUNET_TIME_absolute_add (time, rekey_period);
1121 time = GNUNET_TIME_absolute_add (time, GNUNET_TIME_UNIT_MINUTES);
1122 kx_msg.expiration_time = GNUNET_TIME_absolute_hton (time);
1123 GNUNET_CRYPTO_ecdhe_key_get_public (my_ephemeral_key, &kx_msg.ephemeral_key);
1125 GNUNET_assert (GNUNET_OK ==
1126 GNUNET_CRYPTO_eddsa_sign (my_private_key,
1128 &kx_msg.signature));
1130 n = (long) GNUNET_CONTAINER_multipeermap_size (tunnels);
1131 GNUNET_CONTAINER_multipeermap_iterate (tunnels, &rekey_iterator, (void *) n);
1133 rekey_task = GNUNET_SCHEDULER_add_delayed (rekey_period, &rekey, NULL);
1138 * Called only on shutdown, destroy every tunnel.
1140 * @param cls Closure (unused).
1141 * @param key Current public key.
1142 * @param value Value in the hash map (tunnel).
1144 * @return #GNUNET_YES, so we should continue to iterate,
1147 destroy_iterator (void *cls,
1148 const struct GNUNET_PeerIdentity *key,
1151 struct MeshTunnel3 *t = value;
1159 * Notify remote peer that we don't know a channel he is talking about,
1160 * probably CHANNEL_DESTROY was missed.
1162 * @param t Tunnel on which to notify.
1163 * @param gid ID of the channel.
1166 send_channel_destroy (struct MeshTunnel3 *t, unsigned int gid)
1168 struct GNUNET_MESH_ChannelManage msg;
1170 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
1171 msg.header.size = htons (sizeof (msg));
1172 msg.chid = htonl (gid);
1174 LOG (GNUNET_ERROR_TYPE_DEBUG,
1175 "WARNING destroying unknown channel %u on tunnel %s\n",
1177 send_prebuilt_message (&msg.header, t, GNUNET_YES, NULL, NULL, NULL);
1182 * Demultiplex data per channel and call appropriate channel handler.
1184 * @param t Tunnel on which the data came.
1185 * @param msg Data message.
1186 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1187 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1188 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1189 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1192 handle_data (struct MeshTunnel3 *t,
1193 const struct GNUNET_MESH_Data *msg,
1196 struct MeshChannel *ch;
1200 size = ntohs (msg->header.size);
1202 sizeof (struct GNUNET_MESH_Data) +
1203 sizeof (struct GNUNET_MessageHeader))
1208 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload of type %s\n",
1209 GM_m2s (ntohs (msg[1].header.type)));
1212 ch = GMT_get_channel (t, ntohl (msg->chid));
1215 GNUNET_STATISTICS_update (stats, "# data on unknown channel",
1217 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel 0x%X unknown\n",
1219 send_channel_destroy (t, ntohl (msg->chid));
1223 GMCH_handle_data (ch, msg, fwd);
1228 * Demultiplex data ACKs per channel and update appropriate channel buffer info.
1230 * @param t Tunnel on which the DATA ACK came.
1231 * @param msg DATA ACK message.
1232 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1233 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1234 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1235 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1238 handle_data_ack (struct MeshTunnel3 *t,
1239 const struct GNUNET_MESH_DataACK *msg,
1242 struct MeshChannel *ch;
1246 size = ntohs (msg->header.size);
1247 if (size != sizeof (struct GNUNET_MESH_DataACK))
1254 ch = GMT_get_channel (t, ntohl (msg->chid));
1257 GNUNET_STATISTICS_update (stats, "# data ack on unknown channel",
1259 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1264 GMCH_handle_data_ack (ch, msg, fwd);
1269 * Handle channel create.
1271 * @param t Tunnel on which the data came.
1272 * @param msg Data message.
1275 handle_ch_create (struct MeshTunnel3 *t,
1276 const struct GNUNET_MESH_ChannelCreate *msg)
1278 struct MeshChannel *ch;
1282 size = ntohs (msg->header.size);
1283 if (size != sizeof (struct GNUNET_MESH_ChannelCreate))
1290 ch = GMT_get_channel (t, ntohl (msg->chid));
1291 if (NULL != ch && ! GMT_is_loopback (t))
1293 /* Probably a retransmission, safe to ignore */
1294 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists...\n");
1298 ch = GMCH_handle_create (t, msg);
1301 GMT_add_channel (t, ch);
1307 * Handle channel NACK: check correctness and call channel handler for NACKs.
1309 * @param t Tunnel on which the NACK came.
1310 * @param msg NACK message.
1313 handle_ch_nack (struct MeshTunnel3 *t,
1314 const struct GNUNET_MESH_ChannelManage *msg)
1316 struct MeshChannel *ch;
1320 size = ntohs (msg->header.size);
1321 if (size != sizeof (struct GNUNET_MESH_ChannelManage))
1328 ch = GMT_get_channel (t, ntohl (msg->chid));
1331 GNUNET_STATISTICS_update (stats, "# channel NACK on unknown channel",
1333 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1338 GMCH_handle_nack (ch);
1343 * Handle a CHANNEL ACK (SYNACK/ACK).
1345 * @param t Tunnel on which the CHANNEL ACK came.
1346 * @param msg CHANNEL ACK message.
1347 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1348 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1349 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1350 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1353 handle_ch_ack (struct MeshTunnel3 *t,
1354 const struct GNUNET_MESH_ChannelManage *msg,
1357 struct MeshChannel *ch;
1361 size = ntohs (msg->header.size);
1362 if (size != sizeof (struct GNUNET_MESH_ChannelManage))
1369 ch = GMT_get_channel (t, ntohl (msg->chid));
1372 GNUNET_STATISTICS_update (stats, "# channel ack on unknown channel",
1374 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING channel %u unknown\n",
1379 GMCH_handle_ack (ch, msg, fwd);
1385 * Handle a channel destruction message.
1387 * @param t Tunnel on which the message came.
1388 * @param msg Channel destroy message.
1389 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1390 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1391 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1392 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1395 handle_ch_destroy (struct MeshTunnel3 *t,
1396 const struct GNUNET_MESH_ChannelManage *msg,
1399 struct MeshChannel *ch;
1403 size = ntohs (msg->header.size);
1404 if (size != sizeof (struct GNUNET_MESH_ChannelManage))
1411 ch = GMT_get_channel (t, ntohl (msg->chid));
1414 /* Probably a retransmission, safe to ignore */
1418 GMCH_handle_destroy (ch, msg, fwd);
1423 * The peer's ephemeral key has changed: update the symmetrical keys.
1425 * @param t Tunnel this message came on.
1426 * @param msg Key eXchange message.
1429 handle_ephemeral (struct MeshTunnel3 *t,
1430 const struct GNUNET_MESH_KX_Ephemeral *msg)
1432 struct GNUNET_HashCode km;
1433 LOG (GNUNET_ERROR_TYPE_DEBUG, " ephemeral key message\n");
1435 if (GNUNET_OK != check_ephemeral (t, msg))
1437 GNUNET_break_op (0);
1440 derive_key_material (&km, &msg->ephemeral_key);
1441 LOG (GNUNET_ERROR_TYPE_DEBUG, " km is %s\n", GNUNET_h2s (&km));
1442 derive_symmertic (&t->e_key, &my_full_id, GMP_get_id (t->peer), &km);
1443 derive_symmertic (&t->d_key, GMP_get_id (t->peer), &my_full_id, &km);
1444 if (MESH_TUNNEL3_KEY_SENT == t->estate)
1446 LOG (GNUNET_ERROR_TYPE_DEBUG, " our key was sent, send ping\n");
1448 t->estate = MESH_TUNNEL3_KEY_PING;
1454 * Peer wants to check our symmetrical keys by sending an encrypted challenge.
1455 * Answer with by retransmitting the challenge with the "opposite" key.
1457 * @param t Tunnel this message came on.
1458 * @param msg Key eXchange Ping message.
1461 handle_ping (struct MeshTunnel3 *t,
1462 const struct GNUNET_MESH_KX_Ping *msg)
1464 struct GNUNET_MESH_KX_Ping res;
1466 if (ntohs (msg->header.size) != sizeof (res))
1468 GNUNET_break_op (0);
1472 LOG (GNUNET_ERROR_TYPE_DEBUG, " ping message\n");
1473 t_decrypt (t, &res.target, &msg->target, ping_encryption_size (), msg->iv);
1474 if (0 != memcmp (&my_full_id, &res.target, sizeof (my_full_id)))
1476 GNUNET_STATISTICS_update (stats, "# malformed PINGs", 1, GNUNET_NO);
1477 LOG (GNUNET_ERROR_TYPE_WARNING, " malformed PING\n");
1478 LOG (GNUNET_ERROR_TYPE_DEBUG, " e got %u\n", msg->nonce);
1479 LOG (GNUNET_ERROR_TYPE_DEBUG, " e towards %s\n", GNUNET_i2s (&msg->target));
1480 LOG (GNUNET_ERROR_TYPE_DEBUG, " got %u\n", res.nonce);
1481 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s\n", GNUNET_i2s (&res.target));
1485 send_pong (t, res.nonce);
1490 * Peer has answer to our challenge.
1491 * If answer is successful, consider the key exchange finished and clean
1492 * up all related state.
1494 * @param t Tunnel this message came on.
1495 * @param msg Key eXchange Pong message.
1498 handle_pong (struct MeshTunnel3 *t,
1499 const struct GNUNET_MESH_KX_Pong *msg)
1503 LOG (GNUNET_ERROR_TYPE_DEBUG, "PONG received\n");
1504 if (GNUNET_SCHEDULER_NO_TASK == t->rekey_task)
1506 GNUNET_STATISTICS_update (stats, "# duplicate PONG messages", 1, GNUNET_NO);
1509 t_decrypt (t, &challenge, &msg->nonce, sizeof (uint32_t), msg->iv);
1511 if (challenge != t->kx_ctx->challenge)
1513 LOG (GNUNET_ERROR_TYPE_WARNING, "Wrong PONG challenge\n");
1514 LOG (GNUNET_ERROR_TYPE_DEBUG, "PONG: %u (e: %u). Expected: %u.\n",
1515 challenge, msg->nonce, t->kx_ctx->challenge);
1516 GNUNET_break_op (0);
1519 GNUNET_SCHEDULER_cancel (t->rekey_task);
1520 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
1521 GNUNET_free (t->kx_ctx);
1523 GMT_change_estate (t, MESH_TUNNEL3_KEY_OK);
1528 * Demultiplex by message type and call appropriate handler for a message
1529 * towards a channel of a local tunnel.
1531 * @param t Tunnel this message came on.
1532 * @param msgh Message header.
1533 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1534 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1535 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1536 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1539 handle_decrypted (struct MeshTunnel3 *t,
1540 const struct GNUNET_MessageHeader *msgh,
1545 type = ntohs (msgh->type);
1546 LOG (GNUNET_ERROR_TYPE_DEBUG,
1547 "Got a %s message!\n",
1552 case GNUNET_MESSAGE_TYPE_MESH_DATA:
1553 /* Don't send hop ACK, wait for client to ACK */
1554 handle_data (t, (struct GNUNET_MESH_Data *) msgh, fwd);
1557 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1558 handle_data_ack (t, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1561 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1562 handle_ch_create (t,
1563 (struct GNUNET_MESH_ChannelCreate *) msgh);
1566 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1568 (struct GNUNET_MESH_ChannelManage *) msgh);
1571 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1573 (struct GNUNET_MESH_ChannelManage *) msgh,
1577 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1578 handle_ch_destroy (t,
1579 (struct GNUNET_MESH_ChannelManage *) msgh,
1584 GNUNET_break_op (0);
1585 LOG (GNUNET_ERROR_TYPE_DEBUG,
1586 "end-to-end message not known (%u)\n",
1587 ntohs (msgh->type));
1592 /******************************************************************************/
1593 /******************************** API ***********************************/
1594 /******************************************************************************/
1597 * Decrypt and demultiplex by message type. Call appropriate handler
1598 * for every message.
1600 * @param t Tunnel this message came on.
1601 * @param msg Encrypted message.
1604 GMT_handle_encrypted (struct MeshTunnel3 *t,
1605 const struct GNUNET_MESH_Encrypted *msg)
1607 size_t size = ntohs (msg->header.size);
1608 size_t payload_size = size - sizeof (struct GNUNET_MESH_Encrypted);
1609 size_t decrypted_size;
1610 char cbuf [payload_size];
1611 struct GNUNET_MessageHeader *msgh;
1614 decrypted_size = t_decrypt (t, cbuf, &msg[1], payload_size, msg->iv);
1616 while (off < decrypted_size)
1618 msgh = (struct GNUNET_MessageHeader *) &cbuf[off];
1619 handle_decrypted (t, msgh, GNUNET_SYSERR);
1620 off += ntohs (msgh->size);
1626 * Demultiplex an encapsulated KX message by message type.
1628 * @param t Tunnel on which the message came.
1629 * @param message Payload of KX message.
1632 GMT_handle_kx (struct MeshTunnel3 *t,
1633 const struct GNUNET_MessageHeader *message)
1637 type = ntohs (message->type);
1638 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message received\n", type);
1641 case GNUNET_MESSAGE_TYPE_MESH_KX_EPHEMERAL:
1642 handle_ephemeral (t, (struct GNUNET_MESH_KX_Ephemeral *) message);
1645 case GNUNET_MESSAGE_TYPE_MESH_KX_PING:
1646 handle_ping (t, (struct GNUNET_MESH_KX_Ping *) message);
1649 case GNUNET_MESSAGE_TYPE_MESH_KX_PONG:
1650 handle_pong (t, (struct GNUNET_MESH_KX_Pong *) message);
1654 GNUNET_break_op (0);
1655 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx message not known (%u)\n", type);
1661 * Initialize the tunnel subsystem.
1663 * @param c Configuration handle.
1664 * @param key ECC private key, to derive all other keys and do crypto.
1667 GMT_init (const struct GNUNET_CONFIGURATION_Handle *c,
1668 const struct GNUNET_CRYPTO_EddsaPrivateKey *key)
1670 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1672 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DEFAULT_TTL",
1675 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1676 "MESH", "DEFAULT_TTL", "USING DEFAULT");
1680 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REKEY_PERIOD",
1683 rekey_period = GNUNET_TIME_UNIT_DAYS;
1686 my_private_key = key;
1687 kx_msg.header.size = htons (sizeof (kx_msg));
1688 kx_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KX_EPHEMERAL);
1689 kx_msg.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_MESH_KX);
1690 kx_msg.purpose.size = htonl (ephemeral_purpose_size ());
1691 kx_msg.origin_identity = my_full_id;
1692 rekey_task = GNUNET_SCHEDULER_add_now (&rekey, NULL);
1694 tunnels = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
1699 * Shut down the tunnel subsystem.
1704 if (GNUNET_SCHEDULER_NO_TASK != rekey_task)
1706 GNUNET_SCHEDULER_cancel (rekey_task);
1707 rekey_task = GNUNET_SCHEDULER_NO_TASK;
1709 GNUNET_CONTAINER_multipeermap_iterate (tunnels, &destroy_iterator, NULL);
1710 GNUNET_CONTAINER_multipeermap_destroy (tunnels);
1717 * @param destination Peer this tunnel is towards.
1719 struct MeshTunnel3 *
1720 GMT_new (struct MeshPeer *destination)
1722 struct MeshTunnel3 *t;
1724 t = GNUNET_new (struct MeshTunnel3);
1726 t->peer = destination;
1729 GNUNET_CONTAINER_multipeermap_put (tunnels, GMP_get_id (destination), t,
1730 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
1741 * Change the tunnel's connection state.
1743 * @param t Tunnel whose connection state to change.
1744 * @param cstate New connection state.
1747 GMT_change_cstate (struct MeshTunnel3* t, enum MeshTunnel3CState cstate)
1751 LOG (GNUNET_ERROR_TYPE_DEBUG,
1752 "Tunnel %s cstate was %s\n",
1753 GMP_2s (t->peer), cstate2s (t->cstate));
1754 LOG (GNUNET_ERROR_TYPE_DEBUG,
1755 "Tunnel %s cstate is now %s\n",
1756 GMP_2s (t->peer), cstate2s (cstate));
1757 if (myid != GMP_get_short_id (t->peer) &&
1758 MESH_TUNNEL3_READY != t->cstate &&
1759 MESH_TUNNEL3_READY == cstate)
1762 if (MESH_TUNNEL3_KEY_OK == t->estate)
1764 LOG (GNUNET_ERROR_TYPE_DEBUG, " triggered send queued data\n");
1765 send_queued_data (t);
1767 else if (MESH_TUNNEL3_KEY_UNINITIALIZED == t->estate)
1769 LOG (GNUNET_ERROR_TYPE_DEBUG, " triggered rekey\n");
1770 rekey_tunnel (t, NULL);
1775 if (MESH_TUNNEL3_READY == cstate && 3 <= GMT_count_connections (t))
1777 GMP_stop_search (t->peer);
1782 * Change the tunnel encryption state.
1784 * @param t Tunnel whose encryption state to change.
1785 * @param state New encryption state.
1788 GMT_change_estate (struct MeshTunnel3* t, enum MeshTunnel3EState state)
1792 LOG (GNUNET_ERROR_TYPE_DEBUG,
1793 "Tunnel %s estate was %s\n",
1794 GMP_2s (t->peer), estate2s (t->estate));
1795 LOG (GNUNET_ERROR_TYPE_DEBUG,
1796 "Tunnel %s estate is now %s\n",
1797 GMP_2s (t->peer), estate2s (state));
1798 if (myid != GMP_get_short_id (t->peer) &&
1799 MESH_TUNNEL3_KEY_OK != t->estate && MESH_TUNNEL3_KEY_OK == state)
1802 send_queued_data (t);
1810 * Add a connection to a tunnel.
1813 * @param c Connection.
1816 GMT_add_connection (struct MeshTunnel3 *t, struct MeshConnection *c)
1818 struct MeshTConnection *aux;
1820 GNUNET_assert (NULL != c);
1822 for (aux = t->connection_head; aux != NULL; aux = aux->next)
1826 aux = GNUNET_new (struct MeshTConnection);
1828 GNUNET_CONTAINER_DLL_insert_tail (t->connection_head, t->connection_tail, aux);
1833 * Mark a path as no longer valid for this tunnel: has been tried and failed.
1835 * @param t Tunnel to update.
1836 * @param path Invalid path to remove. Is destroyed after removal.
1839 GMT_remove_path (struct MeshTunnel3 *t, struct MeshPeerPath *path)
1841 GMP_remove_path (t->peer, path);
1846 * Remove a connection from a tunnel.
1849 * @param c Connection.
1852 GMT_remove_connection (struct MeshTunnel3 *t,
1853 struct MeshConnection *c)
1855 struct MeshTConnection *aux;
1856 struct MeshTConnection *next;
1858 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing connection %s from tunnel %s\n",
1859 GMC_2s (c), GMT_2s (t));
1860 for (aux = t->connection_head; aux != NULL; aux = next)
1865 GNUNET_CONTAINER_DLL_remove (t->connection_head, t->connection_tail, aux);
1870 /* Start new connections if needed */
1871 if (NULL == t->connection_head
1872 && GNUNET_NO == t->destroy
1873 && GNUNET_NO == shutting_down)
1875 LOG (GNUNET_ERROR_TYPE_DEBUG, " no more connections, getting new ones\n");
1876 GMP_connect (t->peer);
1877 t->cstate = MESH_TUNNEL3_SEARCHING;
1881 /* If not marked as ready, no change is needed */
1882 if (MESH_TUNNEL3_READY != t->cstate)
1885 /* Check if any connection is ready to maintaing cstate */
1886 for (aux = t->connection_head; aux != NULL; aux = aux->next)
1887 if (MESH_CONNECTION_READY == GMC_get_state (aux->c))
1890 t->cstate = MESH_TUNNEL3_WAITING;
1895 * Add a channel to a tunnel.
1898 * @param ch Channel.
1901 GMT_add_channel (struct MeshTunnel3 *t, struct MeshChannel *ch)
1903 struct MeshTChannel *aux;
1905 GNUNET_assert (NULL != ch);
1907 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding channel %p to tunnel %p\n", ch, t);
1909 for (aux = t->channel_head; aux != NULL; aux = aux->next)
1911 LOG (GNUNET_ERROR_TYPE_DEBUG, " already there %p\n", aux->ch);
1916 aux = GNUNET_new (struct MeshTChannel);
1918 LOG (GNUNET_ERROR_TYPE_DEBUG, " adding %p to %p\n", aux, t->channel_head);
1919 GNUNET_CONTAINER_DLL_insert_tail (t->channel_head, t->channel_tail, aux);
1921 if (GNUNET_YES == t->destroy)
1923 t->destroy = GNUNET_NO;
1924 LOG (GNUNET_ERROR_TYPE_DEBUG, " undo destroy!\n");
1930 * Remove a channel from a tunnel.
1933 * @param ch Channel.
1936 GMT_remove_channel (struct MeshTunnel3 *t, struct MeshChannel *ch)
1938 struct MeshTChannel *aux;
1940 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing channel %p from tunnel %p\n", ch, t);
1941 for (aux = t->channel_head; aux != NULL; aux = aux->next)
1945 LOG (GNUNET_ERROR_TYPE_DEBUG, " found! %s\n", GMCH_2s (ch));
1946 GNUNET_CONTAINER_DLL_remove (t->channel_head, t->channel_tail, aux);
1955 * Search for a channel by global ID.
1957 * @param t Tunnel containing the channel.
1958 * @param chid Public channel number.
1960 * @return channel handler, NULL if doesn't exist
1962 struct MeshChannel *
1963 GMT_get_channel (struct MeshTunnel3 *t, MESH_ChannelNumber chid)
1965 struct MeshTChannel *iter;
1970 for (iter = t->channel_head; NULL != iter; iter = iter->next)
1972 if (GMCH_get_id (iter->ch) == chid)
1976 return NULL == iter ? NULL : iter->ch;
1981 * Tunnel is empty: destroy it.
1983 * Notifies all connections about the destruction.
1985 * @param t Tunnel to destroy.
1988 GMT_destroy_empty (struct MeshTunnel3 *t)
1990 struct MeshTConnection *iter;
1992 LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel %s empty: destroying scheduled\n",
1994 for (iter = t->connection_head; NULL != iter; iter = iter->next)
1996 GMC_send_destroy (iter->c);
1999 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
2001 t->estate = MESH_TUNNEL3_KEY_UNINITIALIZED;
2002 GNUNET_SCHEDULER_cancel (t->rekey_task);
2003 t->rekey_task = GNUNET_SCHEDULER_NO_TASK;
2004 GNUNET_free (t->kx_ctx);
2007 t->cstate = MESH_TUNNEL3_NEW;
2008 t->destroy = GNUNET_YES;
2013 * Destroy tunnel if empty (no more channels).
2015 * @param t Tunnel to destroy if empty.
2018 GMT_destroy_if_empty (struct MeshTunnel3 *t)
2020 if (1 < GMT_count_channels (t))
2023 GMT_destroy_empty (t);
2028 * Destroy the tunnel.
2030 * This function does not generate any warning traffic to clients or peers.
2033 * Cancel messages belonging to this tunnel queued to neighbors.
2034 * Free any allocated resources linked to the tunnel.
2036 * @param t The tunnel to destroy.
2039 GMT_destroy (struct MeshTunnel3 *t)
2041 struct MeshTConnection *iter_c;
2042 struct MeshTConnection *next_c;
2043 struct MeshTChannel *iter_ch;
2044 struct MeshTChannel *next_ch;
2051 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying tunnel %s\n", GMP_2s (t->peer));
2053 GNUNET_break (GNUNET_YES ==
2054 GNUNET_CONTAINER_multipeermap_remove (tunnels,
2055 GMP_get_id (t->peer), t));
2057 for (iter_c = t->connection_head; NULL != iter_c; iter_c = next_c)
2059 next_c = iter_c->next;
2060 GMC_destroy (iter_c->c);
2062 for (iter_ch = t->channel_head; NULL != iter_ch; iter_ch = next_ch)
2064 next_ch = iter_ch->next;
2065 GMCH_destroy (iter_ch->ch);
2066 /* Should only happen on shutdown, but it's ok. */
2069 GNUNET_STATISTICS_update (stats, "# tunnels", -1, GNUNET_NO);
2070 GMP_set_tunnel (t->peer, NULL);
2072 if (GNUNET_SCHEDULER_NO_TASK != t->rekey_task)
2073 GNUNET_SCHEDULER_cancel (t->rekey_task);
2080 * @brief Use the given path for the tunnel.
2081 * Update the next and prev hops (and RCs).
2082 * (Re)start the path refresh in case the tunnel is locally owned.
2084 * @param t Tunnel to update.
2085 * @param p Path to use.
2087 * @return Connection created.
2089 struct MeshConnection *
2090 GMT_use_path (struct MeshTunnel3 *t, struct MeshPeerPath *p)
2092 struct MeshConnection *c;
2093 struct GNUNET_HashCode cid;
2094 unsigned int own_pos;
2096 if (NULL == t || NULL == p)
2102 for (own_pos = 0; own_pos < p->length; own_pos++)
2104 if (p->peers[own_pos] == myid)
2107 if (own_pos > p->length - 1)
2109 GNUNET_break_op (0);
2113 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE, &cid);
2114 c = GMC_new (&cid, t, p, own_pos);
2117 /* Path was flawed */
2120 GMT_add_connection (t, c);
2126 * Count established (ready) connections of a tunnel.
2128 * @param t Tunnel on which to count.
2130 * @return Number of connections.
2133 GMT_count_connections (struct MeshTunnel3 *t)
2135 struct MeshTConnection *iter;
2138 for (count = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
2139 if (MESH_CONNECTION_DESTROYED != GMC_get_state (iter->c))
2146 * Count channels of a tunnel.
2148 * @param t Tunnel on which to count.
2150 * @return Number of channels.
2153 GMT_count_channels (struct MeshTunnel3 *t)
2155 struct MeshTChannel *iter;
2158 for (count = 0, iter = t->channel_head;
2160 iter = iter->next, count++) /* skip */;
2167 * Get the connectivity state of a tunnel.
2171 * @return Tunnel's connectivity state.
2173 enum MeshTunnel3CState
2174 GMT_get_cstate (struct MeshTunnel3 *t)
2179 return (enum MeshTunnel3CState) -1;
2186 * Get the maximum buffer space for a tunnel towards a local client.
2190 * @return Biggest buffer space offered by any channel in the tunnel.
2193 GMT_get_channels_buffer (struct MeshTunnel3 *t)
2195 struct MeshTChannel *iter;
2196 unsigned int buffer;
2197 unsigned int ch_buf;
2199 if (NULL == t->channel_head)
2201 /* Probably getting buffer for a channel create/handshake. */
2206 for (iter = t->channel_head; NULL != iter; iter = iter->next)
2208 ch_buf = get_channel_buffer (iter);
2209 if (ch_buf > buffer)
2217 * Get the total buffer space for a tunnel for P2P traffic.
2221 * @return Buffer space offered by all connections in the tunnel.
2224 GMT_get_connections_buffer (struct MeshTunnel3 *t)
2226 struct MeshTConnection *iter;
2227 unsigned int buffer;
2230 for (iter = t->connection_head; NULL != iter; iter = iter->next)
2232 if (GMC_get_state (iter->c) != MESH_CONNECTION_READY)
2236 buffer += get_connection_buffer (iter);
2244 * Get the tunnel's destination.
2248 * @return ID of the destination peer.
2250 const struct GNUNET_PeerIdentity *
2251 GMT_get_destination (struct MeshTunnel3 *t)
2253 return GMP_get_id (t->peer);
2258 * Get the tunnel's next free global channel ID.
2262 * @return GID of a channel free to use.
2265 GMT_get_next_chid (struct MeshTunnel3 *t)
2267 MESH_ChannelNumber chid;
2268 MESH_ChannelNumber mask;
2271 /* Set bit 30 depending on the ID relationship. Bit 31 is always 0 for GID.
2272 * If our ID is bigger or loopback tunnel, start at 0, bit 30 = 0
2273 * If peer's ID is bigger, start at 0x4... bit 30 = 1
2275 result = GNUNET_CRYPTO_cmp_peer_identity (&my_full_id, GMP_get_id (t->peer));
2281 while (NULL != GMT_get_channel (t, t->next_chid))
2283 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists...\n", t->next_chid);
2284 t->next_chid = (t->next_chid + 1) & ~GNUNET_MESH_LOCAL_CHANNEL_ID_CLI;
2285 t->next_chid |= mask;
2287 chid = t->next_chid;
2288 t->next_chid = (t->next_chid + 1) & ~GNUNET_MESH_LOCAL_CHANNEL_ID_CLI;
2289 t->next_chid |= mask;
2296 * Send ACK on one or more channels due to buffer in connections.
2298 * @param t Channel which has some free buffer space.
2301 GMT_unchoke_channels (struct MeshTunnel3 *t)
2303 struct MeshTChannel *iter;
2304 unsigned int buffer;
2305 unsigned int channels = GMT_count_channels (t);
2306 unsigned int choked_n;
2307 struct MeshChannel *choked[channels];
2309 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMT_unchoke_channels on %s\n", GMT_2s (t));
2310 LOG (GNUNET_ERROR_TYPE_DEBUG, " head: %p\n", t->channel_head);
2311 if (NULL != t->channel_head)
2312 LOG (GNUNET_ERROR_TYPE_DEBUG, " head ch: %p\n", t->channel_head->ch);
2314 /* Get buffer space */
2315 buffer = GMT_get_connections_buffer (t);
2321 /* Count and remember choked channels */
2323 for (iter = t->channel_head; NULL != iter; iter = iter->next)
2325 if (GNUNET_NO == get_channel_allowed (iter))
2327 choked[choked_n++] = iter->ch;
2331 /* Unchoke random channels */
2332 while (0 < buffer && 0 < choked_n)
2334 unsigned int r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
2336 GMCH_allow_client (choked[r], GMCH_is_origin (choked[r], GNUNET_YES));
2339 choked[r] = choked[choked_n];
2345 * Send ACK on one or more connections due to buffer space to the client.
2347 * Iterates all connections of the tunnel and sends ACKs appropriately.
2352 GMT_send_connection_acks (struct MeshTunnel3 *t)
2354 struct MeshTConnection *iter;
2357 uint32_t allow_per_connection;
2359 unsigned int buffer;
2361 LOG (GNUNET_ERROR_TYPE_DEBUG, "Tunnel send connection ACKs on %s\n",
2370 buffer = GMT_get_channels_buffer (t);
2371 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer %u\n", buffer);
2373 /* Count connections, how many messages are already allowed */
2374 cs = GMT_count_connections (t);
2375 for (allowed = 0, iter = t->connection_head; NULL != iter; iter = iter->next)
2377 allowed += get_connection_allowed (iter);
2379 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowed %u\n", allowed);
2381 /* Make sure there is no overflow */
2382 if (allowed > buffer)
2387 /* Authorize connections to send more data */
2388 to_allow = buffer; /* - allowed; */
2390 for (iter = t->connection_head; NULL != iter && to_allow > 0; iter = iter->next)
2392 allow_per_connection = to_allow/cs;
2393 to_allow -= allow_per_connection;
2395 if (get_connection_allowed (iter) > 64 / 3)
2399 GMC_allow (iter->c, allow_per_connection,
2400 GMC_is_origin (iter->c, GNUNET_NO));
2403 GNUNET_break (to_allow == 0);
2408 * Cancel a previously sent message while it's in the queue.
2410 * ONLY can be called before the continuation given to the send function
2411 * is called. Once the continuation is called, the message is no longer in the
2414 * @param q Handle to the queue.
2417 GMT_cancel (struct MeshTunnel3Queue *q)
2422 /* message_sent() will be called and free q */
2424 else if (NULL != q->tqd)
2426 unqueue_data (q->tqd);
2428 if (NULL != q->cont)
2429 q->cont (q->cont_cls, NULL, q, 0, 0);
2440 * Sends an already built message on a tunnel, encrypting it and
2441 * choosing the best connection.
2443 * @param message Message to send. Function modifies it.
2444 * @param t Tunnel on which this message is transmitted.
2445 * @param force Force the tunnel to take the message (buffer overfill).
2446 * @param cont Continuation to call once message is really sent.
2447 * @param cont_cls Closure for @c cont.
2449 * @return Handle to cancel message. NULL if @c cont is NULL.
2451 struct MeshTunnel3Queue *
2452 GMT_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2453 struct MeshTunnel3 *t, int force,
2454 GMT_sent cont, void *cont_cls)
2456 return send_prebuilt_message (message, t, force, cont, cont_cls, NULL);
2461 * Is the tunnel directed towards the local peer?
2465 * @return #GNUNET_YES if it is loopback.
2468 GMT_is_loopback (const struct MeshTunnel3 *t)
2470 return (myid == GMP_get_short_id (t->peer));
2475 * Is the tunnel this path already?
2480 * @return #GNUNET_YES a connection uses this path.
2483 GMT_is_path_used (const struct MeshTunnel3 *t, const struct MeshPeerPath *p)
2485 struct MeshTConnection *iter;
2487 for (iter = t->connection_head; NULL != iter; iter = iter->next)
2488 if (GMC_get_path (iter->c) == p)
2496 * Get a cost of a path for a tunnel considering existing connections.
2499 * @param path Candidate path.
2501 * @return Cost of the path (path length + number of overlapping nodes)
2504 GMT_get_path_cost (const struct MeshTunnel3 *t,
2505 const struct MeshPeerPath *path)
2507 struct MeshTConnection *iter;
2508 const struct MeshPeerPath *aux;
2509 unsigned int overlap;
2517 GNUNET_assert (NULL != t);
2519 for (i = 0; i < path->length; i++)
2521 for (iter = t->connection_head; NULL != iter; iter = iter->next)
2523 aux = GMC_get_path (iter->c);
2527 for (j = 0; j < aux->length; j++)
2529 if (path->peers[i] == aux->peers[j])
2537 return (path->length + overlap) * (path->score * -1);
2542 * Get the static string for the peer this tunnel is directed.
2546 * @return Static string the destination peer's ID.
2549 GMT_2s (const struct MeshTunnel3 *t)
2554 return GMP_2s (t->peer);
2558 /******************************************************************************/
2559 /***************************** INFO/DEBUG *******************************/
2560 /******************************************************************************/
2564 * Log all possible info about the tunnel state.
2566 * @param t Tunnel to debug.
2569 GMT_debug (const struct MeshTunnel3 *t)
2571 struct MeshTChannel *iterch;
2572 struct MeshTConnection *iterc;
2574 LOG (GNUNET_ERROR_TYPE_DEBUG, "DEBUG TUNNEL TOWARDS %s\n", GMT_2s (t));
2575 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate %s, estate %s\n",
2576 cstate2s (t->cstate), estate2s (t->estate));
2577 LOG (GNUNET_ERROR_TYPE_DEBUG, " kx_ctx %p, rekey_task %u\n",
2578 t->kx_ctx, t->rekey_task);
2579 LOG (GNUNET_ERROR_TYPE_DEBUG, " tq_head %p, tq_tail %p\n",
2580 t->tq_head, t->tq_tail);
2581 LOG (GNUNET_ERROR_TYPE_DEBUG, " destroy %u\n", t->destroy);
2583 LOG (GNUNET_ERROR_TYPE_DEBUG, " channels:\n");
2584 for (iterch = t->channel_head; NULL != iterch; iterch = iterch->next)
2586 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %s\n", GMCH_2s (iterch->ch));
2589 LOG (GNUNET_ERROR_TYPE_DEBUG, " connections:\n");
2590 for (iterc = t->connection_head; NULL != iterc; iterc = iterc->next)
2592 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %s [%u] buf: %u/%u (qn %u/%u)\n",
2593 GMC_2s (iterc->c), GMC_get_state (iterc->c),
2594 GMC_get_buffer (iterc->c, GNUNET_YES),
2595 GMC_get_buffer (iterc->c, GNUNET_NO),
2596 GMC_get_qn (iterc->c, GNUNET_YES),
2597 GMC_get_qn (iterc->c, GNUNET_NO));
2600 LOG (GNUNET_ERROR_TYPE_DEBUG, "DEBUG TUNNEL END\n");
2605 GMT_iterate_all (void *cls, GNUNET_CONTAINER_PeerMapIterator iter)
2607 GNUNET_CONTAINER_multipeermap_iterate (tunnels, iter, cls);
2611 GMT_count_all (void)
2613 return GNUNET_CONTAINER_multipeermap_size (tunnels);