2 This file is part of GNUnet
3 Copyright (C) 2010-2014, 2018, 2019 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file transport/gnunet-communicator-udp.c
23 * @brief Transport plugin using UDP.
24 * @author Christian Grothoff
27 * - consider imposing transmission limits in the absence
28 * of ACKs; or: maybe this should be done at TNG service level?
29 * (at least the receiver might want to enforce limits on
30 * KX/DH operations per sender in here) (#5552)
31 * - overall, we should look more into flow control support
32 * (either in backchannel, or general solution in TNG service)
33 * - handle addresses discovered from broadcasts (#5551)
34 * (think: what was the story again on address validation?
35 * where is the API for that!?!)
36 * - support DNS names in BINDTO option (#5528)
37 * - support NAT connection reversal method (#5529)
38 * - support other UDP-specific NAT traversal methods (#)
41 #include "gnunet_util_lib.h"
42 #include "gnunet_protocols.h"
43 #include "gnunet_signatures.h"
44 #include "gnunet_constants.h"
45 #include "gnunet_nt_lib.h"
46 #include "gnunet_nat_service.h"
47 #include "gnunet_statistics_service.h"
48 #include "gnunet_transport_application_service.h"
49 #include "gnunet_transport_communication_service.h"
52 * How often do we rekey based on time (at least)
54 #define REKEY_TIME_INTERVAL GNUNET_TIME_UNIT_DAYS
57 * How long do we wait until we must have received the initial KX?
59 #define PROTO_QUEUE_TIMEOUT GNUNET_TIME_UNIT_MINUTES
62 * How often do we broadcast our presence on the LAN?
64 #define BROADCAST_FREQUENCY GNUNET_TIME_UNIT_MINUTES
67 * How often do we scan for changes to our network interfaces?
69 #define INTERFACE_SCAN_FREQUENCY \
70 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
73 * How long do we believe our addresses to remain up (before
74 * the other peer should revalidate).
76 #define ADDRESS_VALIDITY_PERIOD GNUNET_TIME_UNIT_HOURS
81 #define AES_KEY_SIZE (256 / 8)
86 #define AES_IV_SIZE (96 / 8)
89 * Size of the GCM tag.
91 #define GCM_TAG_SIZE (128 / 8)
94 * If we fall below this number of available KCNs,
95 * we generate additional ACKs until we reach
97 * Should be large enough that we don't generate ACKs all
98 * the time and still have enough time for the ACK to
99 * arrive before the sender runs out. So really this
100 * should ideally be based on the RTT.
102 #define KCN_THRESHOLD 92
105 * How many KCNs do we keep around *after* we hit
106 * the #KCN_THRESHOLD? Should be larger than
107 * #KCN_THRESHOLD so we do not generate just one
110 #define KCN_TARGET 128
113 * What is the maximum delta between KCN sequence numbers
114 * that we allow. Used to expire 'ancient' KCNs that likely
115 * were dropped by the network. Must be larger than
116 * KCN_TARGET (otherwise we generate new KCNs all the time),
117 * but not too large (otherwise packet loss may cause
118 * sender to fall back to KX needlessly when sender runs
119 * out of ACK'ed KCNs due to losses).
121 #define MAX_SQN_DELTA 160
124 * How many shared master secrets do we keep around
125 * at most per sender? Should be large enough so
126 * that we generally have a chance of sending an ACK
127 * before the sender already rotated out the master
128 * secret. Generally values around #KCN_TARGET make
129 * sense. Might make sense to adapt to RTT if we had
130 * a good measurement...
132 #define MAX_SECRETS 128
135 * How often do we rekey based on number of bytes transmitted?
136 * (additionally randomized).
138 #define REKEY_MAX_BYTES (1024LLU * 1024 * 1024 * 4LLU)
141 * Address prefix used by the communicator.
144 #define COMMUNICATOR_ADDRESS_PREFIX "udp"
147 * Configuration section used by the communicator.
149 #define COMMUNICATOR_CONFIG_SECTION "communicator-udp"
151 GNUNET_NETWORK_STRUCT_BEGIN
155 * Signature we use to verify that the ephemeral key was really chosen by
156 * the specified sender. If possible, the receiver should respond with
157 * a `struct UDPAck` (possibly via backchannel).
159 struct UdpHandshakeSignature
162 * Purpose must be #GNUNET_SIGNATURE_COMMUNICATOR_UDP_HANDSHAKE
164 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
167 * Identity of the inititor of the UDP connection (UDP client).
169 struct GNUNET_PeerIdentity sender;
172 * Presumed identity of the target of the UDP connection (UDP server)
174 struct GNUNET_PeerIdentity receiver;
177 * Ephemeral key used by the @e sender.
179 struct GNUNET_CRYPTO_EcdhePublicKey ephemeral;
182 * Monotonic time of @e sender, to possibly help detect replay attacks
183 * (if receiver persists times by sender).
185 struct GNUNET_TIME_AbsoluteNBO monotonic_time;
190 * "Plaintext" header at beginning of KX message. Followed
191 * by encrypted `struct UDPConfirmation`.
196 * Ephemeral key for KX.
198 struct GNUNET_CRYPTO_EcdhePublicKey ephemeral;
201 * HMAC for the following encrypted message, using GCM. HMAC uses
202 * key derived from the handshake with sequence number zero.
204 char gcm_tag[GCM_TAG_SIZE];
209 * Encrypted continuation of UDP initial handshake, followed
210 * by message header with payload.
212 struct UDPConfirmation
217 struct GNUNET_PeerIdentity sender;
220 * Sender's signature of type #GNUNET_SIGNATURE_COMMUNICATOR_UDP_HANDSHAKE
222 struct GNUNET_CRYPTO_EddsaSignature sender_sig;
225 * Monotonic time of @e sender, to possibly help detect replay attacks
226 * (if receiver persists times by sender).
228 struct GNUNET_TIME_AbsoluteNBO monotonic_time;
230 /* followed by messages */
232 /* padding may follow actual messages */
237 * UDP key acknowledgement. May be sent via backchannel. Allows the
238 * sender to use `struct UDPBox` with the acknowledge key henceforth.
243 * Type is #GNUNET_MESSAGE_TYPE_COMMUNICATOR_UDP_ACK.
245 struct GNUNET_MessageHeader header;
248 * Sequence acknowledgement limit. Specifies current maximum sequence
249 * number supported by receiver.
251 uint32_t sequence_max GNUNET_PACKED;
254 * CMAC of the base key being acknowledged.
256 struct GNUNET_HashCode cmac;
261 * Signature we use to verify that the broadcast was really made by
262 * the peer that claims to have made it. Basically, affirms that the
263 * peer is really using this IP address (albeit possibly not in _our_
264 * LAN). Makes it difficult for peers in the LAN to claim to
265 * be just any global peer -- an attacker must have at least
266 * shared a LAN with the peer they're pretending to be here.
268 struct UdpBroadcastSignature
271 * Purpose must be #GNUNET_SIGNATURE_COMMUNICATOR_UDP_BROADCAST
273 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
276 * Identity of the inititor of the UDP broadcast.
278 struct GNUNET_PeerIdentity sender;
281 * Hash of the sender's UDP address.
283 struct GNUNET_HashCode h_address;
288 * Broadcast by peer in LAN announcing its presence. Unusual in that
289 * we don't pad these to full MTU, as we cannot prevent being
290 * recognized in LAN as GNUnet peers if this feature is enabled
291 * anyway. Also, the entire message is in cleartext.
296 * Sender's peer identity.
298 struct GNUNET_PeerIdentity sender;
301 * Sender's signature of type
302 * #GNUNET_SIGNATURE_COMMUNICATOR_UDP_BROADCAST
304 struct GNUNET_CRYPTO_EddsaSignature sender_sig;
309 * UDP message box. Always sent encrypted, only allowed after
310 * the receiver sent a `struct UDPAck` for the base key!
315 * Key and IV identification code. KDF applied to an acknowledged
316 * base key and a sequence number. Sequence numbers must be used
317 * monotonically increasing up to the maximum specified in
318 * `struct UDPAck`. Without further `struct UDPAck`s, the sender
319 * must fall back to sending handshakes!
321 struct GNUNET_ShortHashCode kid;
324 * 128-bit authentication tag for the following encrypted message,
325 * from GCM. MAC starts at the @e body_start that follows and
326 * extends until the end of the UDP payload. If the @e hmac is
327 * wrong, the receiver should check if the message might be a
328 * `struct UdpHandshakeSignature`.
330 char gcm_tag[GCM_TAG_SIZE];
334 GNUNET_NETWORK_STRUCT_END
337 * Shared secret we generated for a particular sender or receiver.
343 * Pre-generated "kid" code (key and IV identification code) to
344 * quickly derive master key for a `struct UDPBox`.
351 struct KeyCacheEntry *next;
356 struct KeyCacheEntry *prev;
359 * Key and IV identification code. KDF applied to an acknowledged
360 * base key and a sequence number. Sequence numbers must be used
361 * monotonically increasing up to the maximum specified in
362 * `struct UDPAck`. Without further `struct UDPAck`s, the sender
363 * must fall back to sending handshakes!
365 struct GNUNET_ShortHashCode kid;
368 * Corresponding shared secret.
370 struct SharedSecret *ss;
373 * Sequence number used to derive this entry from master key.
375 uint32_t sequence_number;
380 * Information we track per sender address we have recently been
381 * in contact with (decryption from sender).
383 struct SenderAddress;
386 * Information we track per receiving address we have recently been
387 * in contact with (encryption to receiver).
389 struct ReceiverAddress;
392 * Shared secret we generated for a particular sender or receiver.
399 struct SharedSecret *next;
404 struct SharedSecret *prev;
407 * Kept in a DLL, sorted by sequence number. Only if we are decrypting.
409 struct KeyCacheEntry *kce_head;
412 * Kept in a DLL, sorted by sequence number. Only if we are decrypting.
414 struct KeyCacheEntry *kce_tail;
417 * Sender we use this shared secret with, or NULL.
419 struct SenderAddress *sender;
422 * Receiver we use this shared secret with, or NULL.
424 struct ReceiverAddress *receiver;
427 * Master shared secret.
429 struct GNUNET_HashCode master;
432 * CMAC is used to identify @e master in ACKs.
434 struct GNUNET_HashCode cmac;
437 * Up to which sequence number did we use this @e master already?
438 * (for encrypting only)
440 uint32_t sequence_used;
443 * Up to which sequence number did the other peer allow us to use
444 * this key, or up to which number did we allow the other peer to
447 uint32_t sequence_allowed;
450 * Number of active KCN entries.
452 unsigned int active_kce_count;
457 * Information we track per sender address we have recently been
458 * in contact with (we decrypt messages from the sender).
463 * To whom are we talking to.
465 struct GNUNET_PeerIdentity target;
468 * Entry in sender expiration heap.
470 struct GNUNET_CONTAINER_HeapNode *hn;
473 * Shared secrets we used with @e target, first used is head.
475 struct SharedSecret *ss_head;
478 * Shared secrets we used with @e target, last used is tail.
480 struct SharedSecret *ss_tail;
483 * Address of the other peer.
485 struct sockaddr *address;
488 * Length of the address.
490 socklen_t address_len;
493 * Timeout for this sender.
495 struct GNUNET_TIME_Absolute timeout;
498 * Length of the DLL at @a ss_head.
500 unsigned int num_secrets;
503 * Which network type does this queue use?
505 enum GNUNET_NetworkType nt;
510 * Information we track per receiving address we have recently been
511 * in contact with (encryption to receiver).
513 struct ReceiverAddress
516 * To whom are we talking to.
518 struct GNUNET_PeerIdentity target;
521 * Shared secrets we received from @e target, first used is head.
523 struct SharedSecret *ss_head;
526 * Shared secrets we received with @e target, last used is tail.
528 struct SharedSecret *ss_tail;
531 * Address of the receiver in the human-readable format
532 * with the #COMMUNICATOR_ADDRESS_PREFIX.
537 * Address of the other peer.
539 struct sockaddr *address;
542 * Length of the address.
544 socklen_t address_len;
547 * Entry in sender expiration heap.
549 struct GNUNET_CONTAINER_HeapNode *hn;
552 * Message queue we are providing for the #ch.
554 struct GNUNET_MQ_Handle *mq;
557 * handle for this queue with the #ch.
559 struct GNUNET_TRANSPORT_QueueHandle *qh;
562 * Timeout for this receiver address.
564 struct GNUNET_TIME_Absolute timeout;
567 * MTU we allowed transport for this receiver right now.
572 * Length of the DLL at @a ss_head.
574 unsigned int num_secrets;
577 * Number of BOX keys from ACKs we have currently
578 * available for this receiver.
580 unsigned int acks_available;
583 * Which network type does this queue use?
585 enum GNUNET_NetworkType nt;
590 * Interface we broadcast our presence on.
592 struct BroadcastInterface
597 struct BroadcastInterface *next;
602 struct BroadcastInterface *prev;
605 * Task for this broadcast interface.
607 struct GNUNET_SCHEDULER_Task *broadcast_task;
610 * Sender's address of the interface.
615 * Broadcast address to use on the interface.
620 * Message we broadcast on this interface.
622 struct UDPBroadcast bcm;
625 * If this is an IPv6 interface, this is the request
626 * we use to join/leave the group.
628 struct ipv6_mreq mcreq;
631 * Number of bytes in @e sa.
636 * Was this interface found in the last #iface_proc() scan?
643 * Cache of pre-generated key IDs.
645 static struct GNUNET_CONTAINER_MultiShortmap *key_cache;
650 static struct GNUNET_SCHEDULER_Task *read_task;
655 static struct GNUNET_SCHEDULER_Task *timeout_task;
658 * ID of master broadcast task
660 static struct GNUNET_SCHEDULER_Task *broadcast_task;
663 * For logging statistics.
665 static struct GNUNET_STATISTICS_Handle *stats;
670 static struct GNUNET_TRANSPORT_CommunicatorHandle *ch;
673 * Receivers (map from peer identity to `struct ReceiverAddress`)
675 static struct GNUNET_CONTAINER_MultiPeerMap *receivers;
678 * Senders (map from peer identity to `struct SenderAddress`)
680 static struct GNUNET_CONTAINER_MultiPeerMap *senders;
683 * Expiration heap for senders (contains `struct SenderAddress`)
685 static struct GNUNET_CONTAINER_Heap *senders_heap;
688 * Expiration heap for receivers (contains `struct ReceiverAddress`)
690 static struct GNUNET_CONTAINER_Heap *receivers_heap;
693 * Broadcast interface tasks. Kept in a DLL.
695 static struct BroadcastInterface *bi_head;
698 * Broadcast interface tasks. Kept in a DLL.
700 static struct BroadcastInterface *bi_tail;
705 static struct GNUNET_NETWORK_Handle *udp_sock;
708 * #GNUNET_YES if #udp_sock supports IPv6.
710 static int have_v6_socket;
715 static struct GNUNET_PeerIdentity my_identity;
720 static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
725 static const struct GNUNET_CONFIGURATION_Handle *cfg;
728 * Our handle to report addresses for validation to TRANSPORT.
730 static struct GNUNET_TRANSPORT_ApplicationHandle *ah;
733 * Network scanner to determine network types.
735 static struct GNUNET_NT_InterfaceScanner *is;
738 * Connection to NAT service.
740 static struct GNUNET_NAT_Handle *nat;
743 * Port number to which we are actually bound.
745 static uint16_t my_port;
749 * An interface went away, stop broadcasting on it.
751 * @param bi entity to close down
754 bi_destroy (struct BroadcastInterface *bi)
756 if (AF_INET6 == bi->sa->sa_family)
758 /* Leave the multicast group */
759 if (GNUNET_OK != GNUNET_NETWORK_socket_setsockopt (udp_sock,
765 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
768 GNUNET_CONTAINER_DLL_remove (bi_head, bi_tail, bi);
769 GNUNET_SCHEDULER_cancel (bi->broadcast_task);
770 GNUNET_free (bi->sa);
771 GNUNET_free_non_null (bi->ba);
777 * Destroys a receiving state due to timeout or shutdown.
779 * @param receiver entity to close down
782 receiver_destroy (struct ReceiverAddress *receiver)
784 struct GNUNET_MQ_Handle *mq;
786 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
787 "Disconnecting receiver for peer `%s'\n",
788 GNUNET_i2s (&receiver->target));
789 if (NULL != (mq = receiver->mq))
792 GNUNET_MQ_destroy (mq);
794 if (NULL != receiver->qh)
796 GNUNET_TRANSPORT_communicator_mq_del (receiver->qh);
799 GNUNET_assert (GNUNET_YES ==
800 GNUNET_CONTAINER_multipeermap_remove (receivers,
803 GNUNET_assert (receiver == GNUNET_CONTAINER_heap_remove_node (receiver->hn));
804 GNUNET_STATISTICS_set (stats,
805 "# receivers active",
806 GNUNET_CONTAINER_multipeermap_size (receivers),
808 GNUNET_free (receiver->address);
809 GNUNET_free (receiver->foreign_addr);
810 GNUNET_free (receiver);
815 * Free memory used by key cache entry.
817 * @param kce the key cache entry
820 kce_destroy (struct KeyCacheEntry *kce)
822 struct SharedSecret *ss = kce->ss;
824 ss->active_kce_count--;
825 GNUNET_CONTAINER_DLL_remove (ss->kce_head, ss->kce_tail, kce);
826 GNUNET_assert (GNUNET_YES == GNUNET_CONTAINER_multishortmap_remove (key_cache,
836 * @param msec master secret for HMAC calculation
837 * @param serial number for the @a smac calculation
838 * @param kid[out] where to write the key ID
841 get_kid (const struct GNUNET_HashCode *msec,
843 struct GNUNET_ShortHashCode *kid)
845 uint32_t sid = htonl (serial);
847 GNUNET_CRYPTO_hkdf (kid,
863 * Setup key cache entry for sequence number @a seq and shared secret @a ss.
865 * @param ss shared secret
866 * @param seq sequence number for the key cache entry
869 kce_generate (struct SharedSecret *ss, uint32_t seq)
871 struct KeyCacheEntry *kce;
873 GNUNET_assert (0 < seq);
874 kce = GNUNET_new (struct KeyCacheEntry);
876 kce->sequence_number = seq;
877 get_kid (&ss->master, seq, &kce->kid);
878 GNUNET_CONTAINER_DLL_insert (ss->kce_head, ss->kce_tail, kce);
879 ss->active_kce_count++;
880 (void) GNUNET_CONTAINER_multishortmap_put (
884 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
885 GNUNET_STATISTICS_set (stats,
887 GNUNET_CONTAINER_multishortmap_size (key_cache),
893 * Destroy @a ss and associated key cache entries.
895 * @param ss shared secret to destroy
898 secret_destroy (struct SharedSecret *ss)
900 struct SenderAddress *sender;
901 struct ReceiverAddress *receiver;
902 struct KeyCacheEntry *kce;
904 if (NULL != (sender = ss->sender))
906 GNUNET_CONTAINER_DLL_remove (sender->ss_head, sender->ss_tail, ss);
907 sender->num_secrets--;
909 if (NULL != (receiver = ss->receiver))
911 GNUNET_CONTAINER_DLL_remove (receiver->ss_head, receiver->ss_tail, ss);
912 receiver->num_secrets--;
913 receiver->acks_available -= (ss->sequence_allowed - ss->sequence_used);
915 while (NULL != (kce = ss->kce_head))
917 GNUNET_STATISTICS_update (stats, "# Secrets active", -1, GNUNET_NO);
918 GNUNET_STATISTICS_set (stats,
920 GNUNET_CONTAINER_multishortmap_size (key_cache),
927 * Functions with this signature are called whenever we need
928 * to close a sender's state due to timeout.
930 * @param sender entity to close down
933 sender_destroy (struct SenderAddress *sender)
937 GNUNET_CONTAINER_multipeermap_remove (senders, &sender->target, sender));
938 GNUNET_assert (sender == GNUNET_CONTAINER_heap_remove_node (sender->hn));
939 GNUNET_STATISTICS_set (stats,
941 GNUNET_CONTAINER_multipeermap_size (senders),
943 GNUNET_free (sender->address);
944 GNUNET_free (sender);
949 * Compute @a key and @a iv.
951 * @param msec master secret for calculation
952 * @param serial number for the @a smac calculation
953 * @param key[out] where to write the decrption key
954 * @param iv[out] where to write the IV
957 get_iv_key (const struct GNUNET_HashCode *msec,
959 char key[AES_KEY_SIZE],
960 char iv[AES_IV_SIZE])
962 uint32_t sid = htonl (serial);
963 char res[AES_KEY_SIZE + AES_IV_SIZE];
965 GNUNET_CRYPTO_hkdf (res,
974 strlen ("UDP-IV-KEY"),
977 memcpy (key, res, AES_KEY_SIZE);
978 memcpy (iv, &res[AES_KEY_SIZE], AES_IV_SIZE);
983 * Increment sender timeout due to activity.
985 * @param sender address for which the timeout should be rescheduled
988 reschedule_sender_timeout (struct SenderAddress *sender)
991 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
992 GNUNET_CONTAINER_heap_update_cost (sender->hn, sender->timeout.abs_value_us);
997 * Increment receiver timeout due to activity.
999 * @param receiver address for which the timeout should be rescheduled
1002 reschedule_receiver_timeout (struct ReceiverAddress *receiver)
1005 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1006 GNUNET_CONTAINER_heap_update_cost (receiver->hn,
1007 receiver->timeout.abs_value_us);
1012 * Task run to check #receiver_heap and #sender_heap for timeouts.
1014 * @param cls unused, NULL
1017 check_timeouts (void *cls)
1019 struct GNUNET_TIME_Relative st;
1020 struct GNUNET_TIME_Relative rt;
1021 struct GNUNET_TIME_Relative delay;
1022 struct ReceiverAddress *receiver;
1023 struct SenderAddress *sender;
1026 timeout_task = NULL;
1027 rt = GNUNET_TIME_UNIT_FOREVER_REL;
1028 while (NULL != (receiver = GNUNET_CONTAINER_heap_peek (receivers_heap)))
1030 rt = GNUNET_TIME_absolute_get_remaining (receiver->timeout);
1031 if (0 != rt.rel_value_us)
1033 receiver_destroy (receiver);
1035 st = GNUNET_TIME_UNIT_FOREVER_REL;
1036 while (NULL != (sender = GNUNET_CONTAINER_heap_peek (senders_heap)))
1038 st = GNUNET_TIME_absolute_get_remaining (sender->timeout);
1039 if (0 != st.rel_value_us)
1041 sender_destroy (sender);
1043 delay = GNUNET_TIME_relative_min (rt, st);
1044 if (delay.rel_value_us < GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
1045 timeout_task = GNUNET_SCHEDULER_add_delayed (delay, &check_timeouts, NULL);
1050 * Calcualte cmac from master in @a ss.
1052 * @param ss[in,out] data structure to complete
1055 calculate_cmac (struct SharedSecret *ss)
1057 GNUNET_CRYPTO_hkdf (&ss->cmac,
1066 strlen ("UDP-CMAC"),
1073 * We received @a plaintext_len bytes of @a plaintext from a @a sender.
1074 * Pass it on to CORE.
1076 * @param queue the queue that received the plaintext
1077 * @param plaintext the plaintext that was received
1078 * @param plaintext_len number of bytes of plaintext received
1081 pass_plaintext_to_core (struct SenderAddress *sender,
1082 const void *plaintext,
1083 size_t plaintext_len)
1085 const struct GNUNET_MessageHeader *hdr = plaintext;
1087 while (ntohs (hdr->size) < plaintext_len)
1089 GNUNET_STATISTICS_update (stats,
1090 "# bytes given to core",
1094 GNUNET_TRANSPORT_communicator_receive (ch,
1097 ADDRESS_VALIDITY_PERIOD,
1098 NULL /* no flow control possible */
1101 /* move on to next message, if any */
1102 plaintext_len -= ntohs (hdr->size);
1103 if (plaintext_len < sizeof(*hdr))
1105 hdr = plaintext + ntohs (hdr->size);
1107 GNUNET_STATISTICS_update (stats,
1108 "# bytes padding discarded",
1115 * Setup @a cipher based on shared secret @a msec and
1116 * serial number @a serial.
1118 * @param msec master shared secret
1119 * @param serial serial number of cipher to set up
1120 * @param cipher[out] cipher to initialize
1123 setup_cipher (const struct GNUNET_HashCode *msec,
1125 gcry_cipher_hd_t *cipher)
1127 char key[AES_KEY_SIZE];
1128 char iv[AES_IV_SIZE];
1130 gcry_cipher_open (cipher,
1131 GCRY_CIPHER_AES256 /* low level: go for speed */,
1132 GCRY_CIPHER_MODE_GCM,
1134 get_iv_key (msec, serial, key, iv);
1135 gcry_cipher_setkey (*cipher, key, sizeof(key));
1136 gcry_cipher_setiv (*cipher, iv, sizeof(iv));
1141 * Try to decrypt @a buf using shared secret @a ss and key/iv
1142 * derived using @a serial.
1144 * @param ss shared secret
1145 * @param tag GCM authentication tag
1146 * @param serial serial number to use
1147 * @param in_buf input buffer to decrypt
1148 * @param in_buf_size number of bytes in @a in_buf and available in @a out_buf
1149 * @param out_buf where to write the result
1150 * @return #GNUNET_OK on success
1153 try_decrypt (const struct SharedSecret *ss,
1154 const char tag[GCM_TAG_SIZE],
1160 gcry_cipher_hd_t cipher;
1162 setup_cipher (&ss->master, serial, &cipher);
1165 gcry_cipher_decrypt (cipher, out_buf, in_buf_size, in_buf, in_buf_size));
1166 if (0 != gcry_cipher_checktag (cipher, tag, GCM_TAG_SIZE))
1168 gcry_cipher_close (cipher);
1169 GNUNET_STATISTICS_update (stats,
1170 "# AEAD authentication failures",
1173 return GNUNET_SYSERR;
1175 gcry_cipher_close (cipher);
1181 * Setup shared secret for decryption.
1183 * @param ephemeral ephemeral key we received from the other peer
1184 * @return new shared secret
1186 static struct SharedSecret *
1187 setup_shared_secret_dec (const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral)
1189 struct SharedSecret *ss;
1191 ss = GNUNET_new (struct SharedSecret);
1192 GNUNET_CRYPTO_eddsa_ecdh (my_private_key, ephemeral, &ss->master);
1198 * Setup shared secret for encryption.
1200 * @param ephemeral ephemeral key we are sending to the other peer
1201 * @param receiver[in,out] queue to initialize encryption key for
1202 * @return new shared secret
1204 static struct SharedSecret *
1205 setup_shared_secret_enc (const struct GNUNET_CRYPTO_EcdhePrivateKey *ephemeral,
1206 struct ReceiverAddress *receiver)
1208 struct SharedSecret *ss;
1210 ss = GNUNET_new (struct SharedSecret);
1211 GNUNET_CRYPTO_ecdh_eddsa (ephemeral,
1212 &receiver->target.public_key,
1214 calculate_cmac (ss);
1215 ss->receiver = receiver;
1216 GNUNET_CONTAINER_DLL_insert (receiver->ss_head, receiver->ss_tail, ss);
1217 receiver->num_secrets++;
1218 GNUNET_STATISTICS_update (stats, "# Secrets active", 1, GNUNET_NO);
1224 * Setup the MQ for the @a receiver. If a queue exists,
1225 * the existing one is destroyed. Then the MTU is
1226 * recalculated and a fresh queue is initialized.
1228 * @param receiver receiver to setup MQ for
1231 setup_receiver_mq (struct ReceiverAddress *receiver);
1235 * We received an ACK for @a pid. Check if it is for
1236 * the receiver in @a value and if so, handle it and
1237 * return #GNUNET_NO. Otherwise, return #GNUNET_YES.
1239 * @param cls a `const struct UDPAck`
1240 * @param pid peer the ACK is from
1241 * @param value a `struct ReceiverAddress`
1242 * @return #GNUNET_YES to continue to iterate
1245 handle_ack (void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
1247 const struct UDPAck *ack = cls;
1248 struct ReceiverAddress *receiver = value;
1251 for (struct SharedSecret *ss = receiver->ss_head; NULL != ss; ss = ss->next)
1253 if (0 == memcmp (&ack->cmac, &ss->cmac, sizeof(struct GNUNET_HashCode)))
1257 allowed = ntohl (ack->sequence_max);
1259 if (allowed > ss->sequence_allowed)
1261 receiver->acks_available += (allowed - ss->sequence_allowed);
1262 if ((allowed - ss->sequence_allowed) == receiver->acks_available)
1264 /* we just incremented from zero => MTU change! */
1265 setup_receiver_mq (receiver);
1267 ss->sequence_allowed = allowed;
1268 /* move ss to head to avoid discarding it anytime soon! */
1269 GNUNET_CONTAINER_DLL_remove (receiver->ss_head, receiver->ss_tail, ss);
1270 GNUNET_CONTAINER_DLL_insert (receiver->ss_head, receiver->ss_tail, ss);
1280 * Test if we have received a valid message in plaintext.
1283 * @param sender peer to process inbound plaintext for
1284 * @param buf buffer we received
1285 * @param buf_size number of bytes in @a buf
1288 try_handle_plaintext (struct SenderAddress *sender,
1292 const struct GNUNET_MessageHeader *hdr =
1293 (const struct GNUNET_MessageHeader *) buf;
1294 const struct UDPAck *ack = (const struct UDPAck *) buf;
1297 if (sizeof(*hdr) > buf_size)
1298 return; /* not even a header */
1299 if (ntohs (hdr->size) > buf_size)
1300 return; /* not even a header */
1301 type = ntohs (hdr->type);
1304 case GNUNET_MESSAGE_TYPE_COMMUNICATOR_UDP_ACK:
1305 /* lookup master secret by 'cmac', then update sequence_max */
1306 GNUNET_CONTAINER_multipeermap_get_multiple (receivers,
1310 /* There could be more messages after the ACK, handle those as well */
1311 buf += ntohs (hdr->size);
1312 buf_size -= ntohs (hdr->size);
1313 pass_plaintext_to_core (sender, buf, buf_size);
1316 case GNUNET_MESSAGE_TYPE_COMMUNICATOR_UDP_PAD:
1321 pass_plaintext_to_core (sender, buf, buf_size);
1327 * We established a shared secret with a sender. We should try to send
1328 * the sender an `struct UDPAck` at the next opportunity to allow the
1329 * sender to use @a ss longer (assuming we did not yet already
1332 * @param ss shared secret to generate ACKs for
1335 consider_ss_ack (struct SharedSecret *ss)
1337 GNUNET_assert (NULL != ss->sender);
1338 /* drop ancient KeyCacheEntries */
1339 while ((NULL != ss->kce_head) &&
1341 ss->kce_head->sequence_number - ss->kce_tail->sequence_number))
1342 kce_destroy (ss->kce_tail);
1343 if (ss->active_kce_count < KCN_THRESHOLD)
1347 while (ss->active_kce_count < KCN_TARGET)
1348 kce_generate (ss, ++ss->sequence_allowed);
1349 ack.header.type = htons (GNUNET_MESSAGE_TYPE_COMMUNICATOR_UDP_ACK);
1350 ack.header.size = htons (sizeof(ack));
1351 ack.sequence_max = htonl (ss->sequence_allowed);
1352 ack.cmac = ss->cmac;
1353 GNUNET_TRANSPORT_communicator_notify (ch,
1354 &ss->sender->target,
1355 COMMUNICATOR_ADDRESS_PREFIX,
1362 * We received a @a box with matching @a kce. Decrypt and process it.
1364 * @param box the data we received
1365 * @param box_len number of bytes in @a box
1366 * @param kce key index to decrypt @a box
1369 decrypt_box (const struct UDPBox *box,
1371 struct KeyCacheEntry *kce)
1373 struct SharedSecret *ss = kce->ss;
1374 char out_buf[box_len - sizeof(*box)];
1376 GNUNET_assert (NULL != ss->sender);
1377 if (GNUNET_OK != try_decrypt (ss,
1379 kce->sequence_number,
1380 (const char *) &box[1],
1384 GNUNET_STATISTICS_update (stats,
1385 "# Decryption failures with valid KCE",
1392 GNUNET_STATISTICS_update (stats,
1393 "# bytes decrypted with BOX",
1396 try_handle_plaintext (ss->sender, out_buf, sizeof(out_buf));
1397 consider_ss_ack (ss);
1402 * Closure for #find_sender_by_address()
1404 struct SearchContext
1407 * Address we are looking for.
1409 const struct sockaddr *address;
1412 * Number of bytes in @e address.
1414 socklen_t address_len;
1417 * Return value to set if we found a match.
1419 struct SenderAddress *sender;
1424 * Find existing `struct SenderAddress` by matching addresses.
1426 * @param cls a `struct SearchContext`
1427 * @param key ignored, must match already
1428 * @param value a `struct SenderAddress`
1429 * @return #GNUNET_YES if not found (continue to search), #GNUNET_NO if found
1432 find_sender_by_address (void *cls,
1433 const struct GNUNET_PeerIdentity *key,
1436 struct SearchContext *sc = cls;
1437 struct SenderAddress *sender = value;
1439 if ((sender->address_len == sc->address_len) &&
1440 (0 == memcmp (sender->address, sc->address, sender->address_len)))
1442 sc->sender = sender;
1443 return GNUNET_NO; /* stop iterating! */
1450 * Create sender address for @a target. Note that we
1451 * might already have one, so a fresh one is only allocated
1452 * if one does not yet exist for @a address.
1454 * @param target peer to generate address for
1455 * @param address target address
1456 * @param address_len number of bytes in @a address
1457 * @return data structure to keep track of key material for
1458 * decrypting data from @a target
1460 static struct SenderAddress *
1461 setup_sender (const struct GNUNET_PeerIdentity *target,
1462 const struct sockaddr *address,
1463 socklen_t address_len)
1465 struct SenderAddress *sender;
1466 struct SearchContext sc = { .address = address,
1467 .address_len = address_len,
1470 GNUNET_CONTAINER_multipeermap_get_multiple (senders,
1472 &find_sender_by_address,
1474 if (NULL != sc.sender)
1476 reschedule_sender_timeout (sc.sender);
1479 sender = GNUNET_new (struct SenderAddress);
1480 sender->target = *target;
1481 sender->address = GNUNET_memdup (address, address_len);
1482 sender->address_len = address_len;
1483 (void) GNUNET_CONTAINER_multipeermap_put (
1487 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1488 GNUNET_STATISTICS_set (stats,
1490 GNUNET_CONTAINER_multipeermap_size (receivers),
1493 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1494 sender->hn = GNUNET_CONTAINER_heap_insert (senders_heap,
1496 sender->timeout.abs_value_us);
1497 sender->nt = GNUNET_NT_scanner_get_type (is, address, address_len);
1498 if (NULL == timeout_task)
1499 timeout_task = GNUNET_SCHEDULER_add_now (&check_timeouts, NULL);
1505 * Check signature from @a uc against @a ephemeral.
1507 * @param ephermal key that is signed
1508 * @param uc signature of claimant
1509 * @return #GNUNET_OK if signature is valid
1512 verify_confirmation (const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral,
1513 const struct UDPConfirmation *uc)
1515 struct UdpHandshakeSignature uhs;
1517 uhs.purpose.purpose = htonl (GNUNET_SIGNATURE_COMMUNICATOR_UDP_HANDSHAKE);
1518 uhs.purpose.size = htonl (sizeof(uhs));
1519 uhs.sender = uc->sender;
1520 uhs.receiver = my_identity;
1521 uhs.ephemeral = *ephemeral;
1522 uhs.monotonic_time = uc->monotonic_time;
1523 return GNUNET_CRYPTO_eddsa_verify (
1524 GNUNET_SIGNATURE_COMMUNICATOR_UDP_HANDSHAKE,
1527 &uc->sender.public_key);
1532 * Converts @a address to the address string format used by this
1533 * communicator in HELLOs.
1535 * @param address the address to convert, must be AF_INET or AF_INET6.
1536 * @param address_len number of bytes in @a address
1537 * @return string representation of @a address
1540 sockaddr_to_udpaddr_string (const struct sockaddr *address,
1541 socklen_t address_len)
1545 switch (address->sa_family)
1548 GNUNET_asprintf (&ret,
1550 COMMUNICATOR_ADDRESS_PREFIX,
1551 GNUNET_a2s (address, address_len));
1555 GNUNET_asprintf (&ret,
1557 COMMUNICATOR_ADDRESS_PREFIX,
1558 GNUNET_a2s (address, address_len));
1574 sock_read (void *cls)
1576 struct sockaddr_storage sa;
1577 socklen_t salen = sizeof(sa);
1578 char buf[UINT16_MAX];
1582 read_task = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
1586 rcvd = GNUNET_NETWORK_socket_recvfrom (udp_sock,
1589 (struct sockaddr *) &sa,
1593 GNUNET_log_strerror (GNUNET_ERROR_TYPE_DEBUG, "recv");
1597 /* first, see if it is a UDPBox */
1598 if (rcvd > sizeof(struct UDPBox))
1600 const struct UDPBox *box;
1601 struct KeyCacheEntry *kce;
1603 box = (const struct UDPBox *) buf;
1604 kce = GNUNET_CONTAINER_multishortmap_get (key_cache, &box->kid);
1607 decrypt_box (box, (size_t) rcvd, kce);
1612 /* next, check if it is a broadcast */
1613 if (sizeof(struct UDPBroadcast) == rcvd)
1615 const struct UDPBroadcast *ub;
1616 struct UdpBroadcastSignature uhs;
1618 ub = (const struct UDPBroadcast *) buf;
1619 uhs.purpose.purpose = htonl (GNUNET_SIGNATURE_COMMUNICATOR_UDP_BROADCAST);
1620 uhs.purpose.size = htonl (sizeof(uhs));
1621 uhs.sender = ub->sender;
1622 GNUNET_CRYPTO_hash (&sa, salen, &uhs.h_address);
1624 GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_COMMUNICATOR_UDP_BROADCAST,
1627 &ub->sender.public_key))
1630 enum GNUNET_NetworkType nt;
1633 sockaddr_to_udpaddr_string ((const struct sockaddr *) &sa, salen);
1634 GNUNET_STATISTICS_update (stats, "# broadcasts received", 1, GNUNET_NO);
1635 /* use our own mechanism to determine network type */
1637 GNUNET_NT_scanner_get_type (is, (const struct sockaddr *) &sa, salen);
1638 GNUNET_TRANSPORT_application_validate (ah, &ub->sender, nt, addr_s);
1639 GNUNET_free (addr_s);
1642 /* continue with KX, mostly for statistics... */
1646 /* finally, test if it is a KX */
1647 if (rcvd < sizeof(struct UDPConfirmation) + sizeof(struct InitialKX))
1649 GNUNET_STATISTICS_update (stats,
1650 "# messages dropped (no kid, too small for KX)",
1657 const struct InitialKX *kx;
1658 struct SharedSecret *ss;
1659 char pbuf[rcvd - sizeof(struct InitialKX)];
1660 const struct UDPConfirmation *uc;
1661 struct SenderAddress *sender;
1663 kx = (const struct InitialKX *) buf;
1664 ss = setup_shared_secret_dec (&kx->ephemeral);
1665 if (GNUNET_OK != try_decrypt (ss,
1673 GNUNET_STATISTICS_update (
1675 "# messages dropped (no kid, AEAD decryption failed)",
1680 uc = (const struct UDPConfirmation *) pbuf;
1681 if (GNUNET_OK != verify_confirmation (&kx->ephemeral, uc))
1683 GNUNET_break_op (0);
1685 GNUNET_STATISTICS_update (stats,
1686 "# messages dropped (sender signature invalid)",
1691 calculate_cmac (ss);
1692 sender = setup_sender (&uc->sender, (const struct sockaddr *) &sa, salen);
1693 ss->sender = sender;
1694 GNUNET_CONTAINER_DLL_insert (sender->ss_head, sender->ss_tail, ss);
1695 sender->num_secrets++;
1696 GNUNET_STATISTICS_update (stats, "# Secrets active", 1, GNUNET_NO);
1697 GNUNET_STATISTICS_update (stats,
1698 "# messages decrypted without BOX",
1701 try_handle_plaintext (sender, &uc[1], sizeof(pbuf) - sizeof(*uc));
1702 consider_ss_ack (ss);
1703 if (sender->num_secrets > MAX_SECRETS)
1704 secret_destroy (sender->ss_tail);
1710 * Convert UDP bind specification to a `struct sockaddr *`
1712 * @param bindto bind specification to convert
1713 * @param[out] sock_len set to the length of the address
1714 * @return converted bindto specification
1716 static struct sockaddr *
1717 udp_address_to_sockaddr (const char *bindto, socklen_t *sock_len)
1719 struct sockaddr *in;
1725 if (1 == sscanf (bindto, "%u%1s", &port, dummy))
1727 /* interpreting value as just a PORT number */
1728 if (port > UINT16_MAX)
1730 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1731 "BINDTO specification `%s' invalid: value too large for port\n",
1735 if ((GNUNET_NO == GNUNET_NETWORK_test_pf (PF_INET6)) ||
1737 GNUNET_CONFIGURATION_get_value_yesno (cfg,
1738 COMMUNICATOR_CONFIG_SECTION,
1741 struct sockaddr_in *i4;
1743 i4 = GNUNET_malloc (sizeof(struct sockaddr_in));
1744 i4->sin_family = AF_INET;
1745 i4->sin_port = htons ((uint16_t) port);
1746 *sock_len = sizeof(struct sockaddr_in);
1747 in = (struct sockaddr *) i4;
1751 struct sockaddr_in6 *i6;
1753 i6 = GNUNET_malloc (sizeof(struct sockaddr_in6));
1754 i6->sin6_family = AF_INET6;
1755 i6->sin6_port = htons ((uint16_t) port);
1756 *sock_len = sizeof(struct sockaddr_in6);
1757 in = (struct sockaddr *) i6;
1761 cp = GNUNET_strdup (bindto);
1762 colon = strrchr (cp, ':');
1765 /* interpet value after colon as port */
1768 if (1 == sscanf (colon, "%u%1s", &port, dummy))
1770 /* interpreting value as just a PORT number */
1771 if (port > UINT16_MAX)
1773 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1774 "BINDTO specification `%s' invalid: value too large for port\n",
1783 GNUNET_ERROR_TYPE_ERROR,
1784 "BINDTO specification `%s' invalid: last ':' not followed by number\n",
1792 /* interpret missing port as 0, aka pick any free one */
1797 struct sockaddr_in v4;
1799 if (1 == inet_pton (AF_INET, cp, &v4))
1801 v4.sin_port = htons ((uint16_t) port);
1802 in = GNUNET_memdup (&v4, sizeof(v4));
1803 *sock_len = sizeof(v4);
1810 struct sockaddr_in6 v6;
1814 if (('[' == *cp) && (']' == cp[strlen (cp) - 1]))
1816 start++; /* skip over '[' */
1817 cp[strlen (cp) - 1] = '\0'; /* eat ']' */
1819 if (1 == inet_pton (AF_INET6, start, &v6))
1821 v6.sin6_port = htons ((uint16_t) port);
1822 in = GNUNET_memdup (&v6, sizeof(v6));
1823 *sock_len = sizeof(v6);
1828 /* #5528 FIXME (feature!): maybe also try getnameinfo()? */
1835 * Pad @a dgram by @a pad_size using @a out_cipher.
1837 * @param out_cipher cipher to use
1838 * @param dgram datagram to pad
1839 * @param pad_size number of bytes of padding to append
1842 do_pad (gcry_cipher_hd_t out_cipher, char *dgram, size_t pad_size)
1846 GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK, pad, sizeof(pad));
1847 if (sizeof(pad) > sizeof(struct GNUNET_MessageHeader))
1849 struct GNUNET_MessageHeader hdr =
1850 { .size = htons (sizeof(pad)),
1851 .type = htons (GNUNET_MESSAGE_TYPE_COMMUNICATOR_UDP_PAD) };
1853 memcpy (pad, &hdr, sizeof(hdr));
1857 gcry_cipher_encrypt (out_cipher, dgram, sizeof(pad), pad, sizeof(pad)));
1862 * Signature of functions implementing the sending functionality of a
1865 * @param mq the message queue
1866 * @param msg the message to send
1867 * @param impl_state our `struct ReceiverAddress`
1870 mq_send (struct GNUNET_MQ_Handle *mq,
1871 const struct GNUNET_MessageHeader *msg,
1874 struct ReceiverAddress *receiver = impl_state;
1875 uint16_t msize = ntohs (msg->size);
1877 GNUNET_assert (mq == receiver->mq);
1878 if (msize > receiver->mtu)
1881 receiver_destroy (receiver);
1884 reschedule_receiver_timeout (receiver);
1886 if (0 == receiver->acks_available)
1888 /* use KX encryption method */
1889 struct UdpHandshakeSignature uhs;
1890 struct UDPConfirmation uc;
1891 struct InitialKX kx;
1892 struct GNUNET_CRYPTO_EcdhePrivateKey epriv;
1893 char dgram[receiver->mtu + sizeof(uc) + sizeof(kx)];
1895 gcry_cipher_hd_t out_cipher;
1896 struct SharedSecret *ss;
1898 /* setup key material */
1899 GNUNET_assert (GNUNET_OK == GNUNET_CRYPTO_ecdhe_key_create2 (&epriv));
1901 ss = setup_shared_secret_enc (&epriv, receiver);
1902 setup_cipher (&ss->master, 0, &out_cipher);
1904 uc.sender = my_identity;
1906 GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get_monotonic (cfg));
1907 uhs.purpose.purpose = htonl (GNUNET_SIGNATURE_COMMUNICATOR_UDP_HANDSHAKE);
1908 uhs.purpose.size = htonl (sizeof(uhs));
1909 uhs.sender = my_identity;
1910 uhs.receiver = receiver->target;
1911 GNUNET_CRYPTO_ecdhe_key_get_public (&epriv, &uhs.ephemeral);
1912 uhs.monotonic_time = uc.monotonic_time;
1913 GNUNET_assert (GNUNET_OK == GNUNET_CRYPTO_eddsa_sign (my_private_key,
1916 /* Leave space for kx */
1917 dpos = sizeof(struct GNUNET_CRYPTO_EcdhePublicKey);
1918 /* Append encrypted uc to dgram */
1919 GNUNET_assert (0 == gcry_cipher_encrypt (out_cipher,
1925 /* Append encrypted payload to dgram */
1927 0 == gcry_cipher_encrypt (out_cipher, &dgram[dpos], msize, msg, msize));
1929 do_pad (out_cipher, &dgram[dpos], sizeof(dgram) - dpos);
1930 /* Datagram starts with kx */
1931 kx.ephemeral = uhs.ephemeral;
1933 0 == gcry_cipher_gettag (out_cipher, kx.gcm_tag, sizeof(kx.gcm_tag)));
1934 gcry_cipher_close (out_cipher);
1935 memcpy (dgram, &kx, sizeof(kx));
1936 if (-1 == GNUNET_NETWORK_socket_sendto (udp_sock,
1940 receiver->address_len))
1941 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "send");
1942 GNUNET_MQ_impl_send_continue (mq);
1944 } /* End of KX encryption method */
1946 /* begin "BOX" encryption method, scan for ACKs from tail! */
1947 for (struct SharedSecret *ss = receiver->ss_tail; NULL != ss; ss = ss->prev)
1949 if (ss->sequence_used < ss->sequence_allowed)
1951 char dgram[sizeof(struct UDPBox) + receiver->mtu];
1953 gcry_cipher_hd_t out_cipher;
1956 box = (struct UDPBox *) dgram;
1957 ss->sequence_used++;
1958 get_kid (&ss->master, ss->sequence_used, &box->kid);
1959 setup_cipher (&ss->master, ss->sequence_used, &out_cipher);
1960 /* Append encrypted payload to dgram */
1961 dpos = sizeof(struct UDPBox);
1963 0 == gcry_cipher_encrypt (out_cipher, &dgram[dpos], msize, msg, msize));
1965 do_pad (out_cipher, &dgram[dpos], sizeof(dgram) - dpos);
1966 GNUNET_assert (0 == gcry_cipher_gettag (out_cipher,
1968 sizeof(box->gcm_tag)));
1969 gcry_cipher_close (out_cipher);
1970 if (-1 == GNUNET_NETWORK_socket_sendto (udp_sock,
1974 receiver->address_len))
1975 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "send");
1976 GNUNET_MQ_impl_send_continue (mq);
1977 receiver->acks_available--;
1978 if (0 == receiver->acks_available)
1980 /* We have no more ACKs => MTU change! */
1981 setup_receiver_mq (receiver);
1991 * Signature of functions implementing the destruction of a message
1992 * queue. Implementations must not free @a mq, but should take care
1995 * @param mq the message queue to destroy
1996 * @param impl_state our `struct ReceiverAddress`
1999 mq_destroy (struct GNUNET_MQ_Handle *mq, void *impl_state)
2001 struct ReceiverAddress *receiver = impl_state;
2003 if (mq == receiver->mq)
2005 receiver->mq = NULL;
2006 receiver_destroy (receiver);
2012 * Implementation function that cancels the currently sent message.
2014 * @param mq message queue
2015 * @param impl_state our `struct RecvierAddress`
2018 mq_cancel (struct GNUNET_MQ_Handle *mq, void *impl_state)
2020 /* Cancellation is impossible with UDP; bail */
2026 * Generic error handler, called with the appropriate
2027 * error code and the same closure specified at the creation of
2028 * the message queue.
2029 * Not every message queue implementation supports an error handler.
2031 * @param cls our `struct ReceiverAddress`
2032 * @param error error code
2035 mq_error (void *cls, enum GNUNET_MQ_Error error)
2037 struct ReceiverAddress *receiver = cls;
2039 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2040 "MQ error in queue to %s: %d\n",
2041 GNUNET_i2s (&receiver->target),
2043 receiver_destroy (receiver);
2048 * Setup the MQ for the @a receiver. If a queue exists,
2049 * the existing one is destroyed. Then the MTU is
2050 * recalculated and a fresh queue is initialized.
2052 * @param receiver receiver to setup MQ for
2055 setup_receiver_mq (struct ReceiverAddress *receiver)
2059 if (NULL != receiver->qh)
2061 GNUNET_TRANSPORT_communicator_mq_del (receiver->qh);
2062 receiver->qh = NULL;
2064 GNUNET_assert (NULL == receiver->mq);
2065 switch (receiver->address->sa_family)
2068 base_mtu = 1480 /* Ethernet MTU, 1500 - Ethernet header - VLAN tag */
2069 - sizeof(struct GNUNET_TUN_IPv4Header) /* 20 */
2070 - sizeof(struct GNUNET_TUN_UdpHeader) /* 8 */;
2074 base_mtu = 1280 /* Minimum MTU required by IPv6 */
2075 - sizeof(struct GNUNET_TUN_IPv6Header) /* 40 */
2076 - sizeof(struct GNUNET_TUN_UdpHeader) /* 8 */;
2083 if (0 == receiver->acks_available)
2085 /* MTU based on full KX messages */
2086 receiver->mtu = base_mtu - sizeof(struct InitialKX) /* 48 */
2087 - sizeof(struct UDPConfirmation); /* 104 */
2091 /* MTU based on BOXed messages */
2092 receiver->mtu = base_mtu - sizeof(struct UDPBox);
2094 /* => Effective MTU for CORE will range from 1080 (IPv6 + KX) to
2095 1404 (IPv4 + Box) bytes, depending on circumstances... */
2096 if (NULL == receiver->mq)
2097 receiver->mq = GNUNET_MQ_queue_for_callbacks (&mq_send,
2105 GNUNET_TRANSPORT_communicator_mq_add (ch,
2107 receiver->foreign_addr,
2110 GNUNET_TRANSPORT_CS_OUTBOUND,
2116 * Function called by the transport service to initialize a
2117 * message queue given address information about another peer.
2118 * If and when the communication channel is established, the
2119 * communicator must call #GNUNET_TRANSPORT_communicator_mq_add()
2120 * to notify the service that the channel is now up. It is
2121 * the responsibility of the communicator to manage sane
2122 * retries and timeouts for any @a peer/@a address combination
2123 * provided by the transport service. Timeouts and retries
2124 * do not need to be signalled to the transport service.
2126 * @param cls closure
2127 * @param peer identity of the other peer
2128 * @param address where to send the message, human-readable
2129 * communicator-specific format, 0-terminated, UTF-8
2130 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the provided address is
2134 mq_init (void *cls, const struct GNUNET_PeerIdentity *peer, const char *address)
2136 struct ReceiverAddress *receiver;
2138 struct sockaddr *in;
2141 if (0 != strncmp (address,
2142 COMMUNICATOR_ADDRESS_PREFIX "-",
2143 strlen (COMMUNICATOR_ADDRESS_PREFIX "-")))
2145 GNUNET_break_op (0);
2146 return GNUNET_SYSERR;
2148 path = &address[strlen (COMMUNICATOR_ADDRESS_PREFIX "-")];
2149 in = udp_address_to_sockaddr (path, &in_len);
2151 receiver = GNUNET_new (struct ReceiverAddress);
2152 receiver->address = in;
2153 receiver->address_len = in_len;
2154 receiver->target = *peer;
2155 receiver->nt = GNUNET_NT_scanner_get_type (is, in, in_len);
2156 (void) GNUNET_CONTAINER_multipeermap_put (
2160 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2162 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2163 receiver->hn = GNUNET_CONTAINER_heap_insert (receivers_heap,
2165 receiver->timeout.abs_value_us);
2166 GNUNET_STATISTICS_set (stats,
2167 "# receivers active",
2168 GNUNET_CONTAINER_multipeermap_size (receivers),
2170 receiver->foreign_addr =
2171 sockaddr_to_udpaddr_string (receiver->address, receiver->address_len);
2172 setup_receiver_mq (receiver);
2173 if (NULL == timeout_task)
2174 timeout_task = GNUNET_SCHEDULER_add_now (&check_timeouts, NULL);
2180 * Iterator over all receivers to clean up.
2183 * @param target unused
2184 * @param value the queue to destroy
2185 * @return #GNUNET_OK to continue to iterate
2188 get_receiver_delete_it (void *cls,
2189 const struct GNUNET_PeerIdentity *target,
2192 struct ReceiverAddress *receiver = value;
2196 receiver_destroy (receiver);
2202 * Iterator over all senders to clean up.
2205 * @param target unused
2206 * @param value the queue to destroy
2207 * @return #GNUNET_OK to continue to iterate
2210 get_sender_delete_it (void *cls,
2211 const struct GNUNET_PeerIdentity *target,
2214 struct SenderAddress *sender = value;
2218 sender_destroy (sender);
2224 * Shutdown the UNIX communicator.
2226 * @param cls NULL (always)
2229 do_shutdown (void *cls)
2233 GNUNET_NAT_unregister (nat);
2236 while (NULL != bi_head)
2237 bi_destroy (bi_head);
2238 if (NULL != broadcast_task)
2240 GNUNET_SCHEDULER_cancel (broadcast_task);
2241 broadcast_task = NULL;
2243 if (NULL != read_task)
2245 GNUNET_SCHEDULER_cancel (read_task);
2248 if (NULL != udp_sock)
2250 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (udp_sock));
2253 GNUNET_CONTAINER_multipeermap_iterate (receivers,
2254 &get_receiver_delete_it,
2256 GNUNET_CONTAINER_multipeermap_destroy (receivers);
2257 GNUNET_CONTAINER_multipeermap_iterate (senders, &get_sender_delete_it, NULL);
2258 GNUNET_CONTAINER_multipeermap_destroy (senders);
2259 GNUNET_CONTAINER_multishortmap_destroy (key_cache);
2260 GNUNET_CONTAINER_heap_destroy (senders_heap);
2261 GNUNET_CONTAINER_heap_destroy (receivers_heap);
2264 GNUNET_TRANSPORT_communicator_disconnect (ch);
2269 GNUNET_TRANSPORT_application_done (ah);
2274 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
2277 if (NULL != my_private_key)
2279 GNUNET_free (my_private_key);
2280 my_private_key = NULL;
2284 GNUNET_NT_scanner_done (is);
2291 * Function called when the transport service has received a
2292 * backchannel message for this communicator (!) via a different return
2293 * path. Should be an acknowledgement.
2295 * @param cls closure, NULL
2296 * @param sender which peer sent the notification
2297 * @param msg payload
2300 enc_notify_cb (void *cls,
2301 const struct GNUNET_PeerIdentity *sender,
2302 const struct GNUNET_MessageHeader *msg)
2304 const struct UDPAck *ack;
2307 if ((ntohs (msg->type) != GNUNET_MESSAGE_TYPE_COMMUNICATOR_UDP_ACK) ||
2308 (ntohs (msg->size) != sizeof(struct UDPAck)))
2310 GNUNET_break_op (0);
2313 ack = (const struct UDPAck *) msg;
2314 GNUNET_CONTAINER_multipeermap_get_multiple (receivers,
2322 * Signature of the callback passed to #GNUNET_NAT_register() for
2323 * a function to call whenever our set of 'valid' addresses changes.
2325 * @param cls closure
2326 * @param app_ctx[in,out] location where the app can store stuff
2327 * on add and retrieve it on remove
2328 * @param add_remove #GNUNET_YES to add a new public IP address,
2329 * #GNUNET_NO to remove a previous (now invalid) one
2330 * @param ac address class the address belongs to
2331 * @param addr either the previous or the new public IP address
2332 * @param addrlen actual length of the @a addr
2335 nat_address_cb (void *cls,
2338 enum GNUNET_NAT_AddressClass ac,
2339 const struct sockaddr *addr,
2343 struct GNUNET_TRANSPORT_AddressIdentifier *ai;
2345 if (GNUNET_YES == add_remove)
2347 enum GNUNET_NetworkType nt;
2349 GNUNET_asprintf (&my_addr,
2351 COMMUNICATOR_ADDRESS_PREFIX,
2352 GNUNET_a2s (addr, addrlen));
2353 nt = GNUNET_NT_scanner_get_type (is, addr, addrlen);
2355 GNUNET_TRANSPORT_communicator_address_add (ch,
2358 GNUNET_TIME_UNIT_FOREVER_REL);
2359 GNUNET_free (my_addr);
2365 GNUNET_TRANSPORT_communicator_address_remove (ai);
2372 * Broadcast our presence on one of our interfaces.
2374 * @param cls a `struct BroadcastInterface`
2377 ifc_broadcast (void *cls)
2379 struct BroadcastInterface *bi = cls;
2380 struct GNUNET_TIME_Relative delay;
2382 delay = BROADCAST_FREQUENCY;
2383 delay.rel_value_us =
2384 GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, delay.rel_value_us);
2385 bi->broadcast_task =
2386 GNUNET_SCHEDULER_add_delayed (INTERFACE_SCAN_FREQUENCY, &ifc_broadcast, bi);
2388 switch (bi->sa->sa_family)
2395 if (GNUNET_OK != GNUNET_NETWORK_socket_setsockopt (udp_sock,
2400 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
2401 sent = GNUNET_NETWORK_socket_sendto (udp_sock,
2407 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "sendto");
2408 if (GNUNET_OK != GNUNET_NETWORK_socket_setsockopt (udp_sock,
2413 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
2419 struct sockaddr_in6 dst;
2421 dst.sin6_family = AF_INET6;
2422 dst.sin6_port = htons (my_port);
2423 dst.sin6_addr = bi->mcreq.ipv6mr_multiaddr;
2424 dst.sin6_scope_id = ((struct sockaddr_in6 *) bi->ba)->sin6_scope_id;
2426 sent = GNUNET_NETWORK_socket_sendto (udp_sock,
2429 (const struct sockaddr *) &dst,
2432 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "sendto");
2444 * Callback function invoked for each interface found.
2445 * Activates/deactivates broadcast interfaces.
2448 * @param name name of the interface (can be NULL for unknown)
2449 * @param isDefault is this presumably the default interface
2450 * @param addr address of this interface (can be NULL for unknown or unassigned)
2451 * @param broadcast_addr the broadcast address (can be NULL for unknown or
2453 * @param netmask the network mask (can be NULL for unknown or unassigned)
2454 * @param addrlen length of the address
2455 * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
2458 iface_proc (void *cls,
2461 const struct sockaddr *addr,
2462 const struct sockaddr *broadcast_addr,
2463 const struct sockaddr *netmask,
2466 struct BroadcastInterface *bi;
2467 enum GNUNET_NetworkType network;
2468 struct UdpBroadcastSignature ubs;
2473 return GNUNET_YES; /* need to know our address! */
2474 network = GNUNET_NT_scanner_get_type (is, addr, addrlen);
2475 if (GNUNET_NT_LOOPBACK == network)
2477 /* Broadcasting on loopback does not make sense */
2480 for (bi = bi_head; NULL != bi; bi = bi->next)
2482 if ((bi->salen == addrlen) && (0 == memcmp (addr, bi->sa, addrlen)))
2484 bi->found = GNUNET_YES;
2489 if ((AF_INET6 == addr->sa_family) && (NULL == broadcast_addr))
2490 return GNUNET_OK; /* broadcast_addr is required for IPv6! */
2491 if ((AF_INET6 == addr->sa_family) && (GNUNET_YES != have_v6_socket))
2492 return GNUNET_OK; /* not using IPv6 */
2494 bi = GNUNET_new (struct BroadcastInterface);
2495 bi->sa = GNUNET_memdup (addr, addrlen);
2496 if (NULL != broadcast_addr)
2497 bi->ba = GNUNET_memdup (broadcast_addr, addrlen);
2498 bi->salen = addrlen;
2499 bi->found = GNUNET_YES;
2500 bi->bcm.sender = my_identity;
2501 ubs.purpose.purpose = htonl (GNUNET_SIGNATURE_COMMUNICATOR_UDP_BROADCAST);
2502 ubs.purpose.size = htonl (sizeof(ubs));
2503 ubs.sender = my_identity;
2504 GNUNET_CRYPTO_hash (addr, addrlen, &ubs.h_address);
2505 GNUNET_assert (GNUNET_OK == GNUNET_CRYPTO_eddsa_sign (my_private_key,
2507 &bi->bcm.sender_sig));
2508 bi->broadcast_task = GNUNET_SCHEDULER_add_now (&ifc_broadcast, bi);
2509 GNUNET_CONTAINER_DLL_insert (bi_head, bi_tail, bi);
2510 if ((AF_INET6 == addr->sa_family) && (NULL != broadcast_addr))
2512 /* Create IPv6 multicast request */
2513 const struct sockaddr_in6 *s6 =
2514 (const struct sockaddr_in6 *) broadcast_addr;
2517 1 == inet_pton (AF_INET6, "FF05::13B", &bi->mcreq.ipv6mr_multiaddr));
2519 /* http://tools.ietf.org/html/rfc2553#section-5.2:
2523 * Join a multicast group on a specified local interface. If the
2524 * interface index is specified as 0, the kernel chooses the local
2525 * interface. For example, some kernels look up the multicast
2526 * group in the normal IPv6 routing table and using the resulting
2527 * interface; we do this for each interface, so no need to use
2528 * zero (anymore...).
2530 bi->mcreq.ipv6mr_interface = s6->sin6_scope_id;
2532 /* Join the multicast group */
2533 if (GNUNET_OK != GNUNET_NETWORK_socket_setsockopt (udp_sock,
2539 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
2547 * Scan interfaces to broadcast our presence on the LAN.
2549 * @param cls NULL, unused
2552 do_broadcast (void *cls)
2554 struct BroadcastInterface *bin;
2557 for (struct BroadcastInterface *bi = bi_head; NULL != bi; bi = bi->next)
2558 bi->found = GNUNET_NO;
2559 GNUNET_OS_network_interfaces_list (&iface_proc, NULL);
2560 for (struct BroadcastInterface *bi = bi_head; NULL != bi; bi = bin)
2563 if (GNUNET_NO == bi->found)
2566 broadcast_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_SCAN_FREQUENCY,
2573 * Setup communicator and launch network interactions.
2575 * @param cls NULL (always)
2576 * @param args remaining command-line arguments
2577 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
2578 * @param c configuration
2583 const char *cfgfile,
2584 const struct GNUNET_CONFIGURATION_Handle *c)
2587 struct sockaddr *in;
2589 struct sockaddr_storage in_sto;
2595 GNUNET_CONFIGURATION_get_value_filename (cfg,
2596 COMMUNICATOR_CONFIG_SECTION,
2600 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
2601 COMMUNICATOR_CONFIG_SECTION,
2606 in = udp_address_to_sockaddr (bindto, &in_len);
2609 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2610 "Failed to setup UDP socket address with path `%s'\n",
2612 GNUNET_free (bindto);
2616 GNUNET_NETWORK_socket_create (in->sa_family, SOCK_DGRAM, IPPROTO_UDP);
2617 if (NULL == udp_sock)
2619 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
2621 GNUNET_free (bindto);
2624 if (AF_INET6 == in->sa_family)
2625 have_v6_socket = GNUNET_YES;
2626 if (GNUNET_OK != GNUNET_NETWORK_socket_bind (udp_sock, in, in_len))
2628 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "bind", bindto);
2629 GNUNET_NETWORK_socket_close (udp_sock);
2632 GNUNET_free (bindto);
2635 /* We might have bound to port 0, allowing the OS to figure it out;
2636 thus, get the real IN-address from the socket */
2637 sto_len = sizeof(in_sto);
2638 if (0 != getsockname (GNUNET_NETWORK_get_fd (udp_sock),
2639 (struct sockaddr *) &in_sto,
2642 memcpy (&in_sto, in, in_len);
2646 GNUNET_free (bindto);
2647 in = (struct sockaddr *) &in_sto;
2649 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2651 GNUNET_a2s ((const struct sockaddr *) &in_sto, sto_len));
2652 switch (in->sa_family)
2655 my_port = ntohs (((struct sockaddr_in *) in)->sin_port);
2659 my_port = ntohs (((struct sockaddr_in6 *) in)->sin6_port);
2666 stats = GNUNET_STATISTICS_create ("C-UDP", cfg);
2667 senders = GNUNET_CONTAINER_multipeermap_create (32, GNUNET_YES);
2668 receivers = GNUNET_CONTAINER_multipeermap_create (32, GNUNET_YES);
2669 senders_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
2671 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
2672 key_cache = GNUNET_CONTAINER_multishortmap_create (1024, GNUNET_YES);
2673 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
2674 is = GNUNET_NT_scanner_init ();
2675 my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_configuration (cfg);
2676 if (NULL == my_private_key)
2679 GNUNET_ERROR_TYPE_ERROR,
2681 "Transport service is lacking key configuration settings. Exiting.\n"));
2682 GNUNET_SCHEDULER_shutdown ();
2685 GNUNET_CRYPTO_eddsa_key_get_public (my_private_key, &my_identity.public_key);
2687 read_task = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2691 ch = GNUNET_TRANSPORT_communicator_connect (cfg,
2692 COMMUNICATOR_CONFIG_SECTION,
2693 COMMUNICATOR_ADDRESS_PREFIX,
2694 GNUNET_TRANSPORT_CC_UNRELIABLE,
2702 GNUNET_SCHEDULER_shutdown ();
2705 ah = GNUNET_TRANSPORT_application_init (cfg);
2709 GNUNET_SCHEDULER_shutdown ();
2712 /* start broadcasting */
2714 GNUNET_CONFIGURATION_get_value_yesno (cfg,
2715 COMMUNICATOR_CONFIG_SECTION,
2716 "DISABLE_BROADCAST"))
2718 broadcast_task = GNUNET_SCHEDULER_add_now (&do_broadcast, NULL);
2720 nat = GNUNET_NAT_register (cfg,
2721 COMMUNICATOR_CONFIG_SECTION,
2723 1 /* one address */,
2724 (const struct sockaddr **) &in,
2727 NULL /* FIXME: support reversal: #5529 */,
2728 NULL /* closure */);
2733 * The main function for the UNIX communicator.
2735 * @param argc number of arguments from the command line
2736 * @param argv command line arguments
2737 * @return 0 ok, 1 on error
2740 main (int argc, char *const *argv)
2742 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
2743 GNUNET_GETOPT_OPTION_END
2747 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
2750 ret = (GNUNET_OK == GNUNET_PROGRAM_run (argc,
2752 "gnunet-communicator-udp",
2753 _ ("GNUnet UDP communicator"),
2759 GNUNET_free ((void *) argv);
2764 /* end of gnunet-communicator-udp.c */