2 This file is part of GNUnet
3 (C) 2010 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 2, 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 * @file transport/plugin_transport_udp.c
23 * @brief Implementation of the UDP transport service
24 * @author Christian Grothoff
25 * @author Nathan Evans
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_connection_lib.h"
31 #include "gnunet_os_lib.h"
32 #include "gnunet_peerinfo_service.h"
33 #include "gnunet_protocols.h"
34 #include "gnunet_resolver_service.h"
35 #include "gnunet_server_lib.h"
36 #include "gnunet_service_lib.h"
37 #include "gnunet_signatures.h"
38 #include "gnunet_statistics_service.h"
39 #include "gnunet_transport_service.h"
40 #include "plugin_transport.h"
41 #include "transport.h"
43 #define DEBUG_UDP GNUNET_NO
46 * Transport cost to peer, always 1 for UDP (direct connection)
48 #define UDP_DIRECT_DISTANCE 1
51 * How long until we give up on transmitting the welcome message?
53 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
57 * Message-Packet header.
62 * size of the message, in bytes, including this header.
64 struct GNUNET_MessageHeader header;
67 * What is the identity of the sender (GNUNET_hash of public key)
69 struct GNUNET_PeerIdentity sender;
74 struct PrettyPrinterContext
76 GNUNET_TRANSPORT_AddressStringCallback asc;
82 * Encapsulation of all of the state of the plugin.
89 struct GNUNET_TRANSPORT_PluginEnvironment *env;
92 * Handle for the statistics service.
94 struct GNUNET_STATISTICS_Handle *statistics;
97 * Handle to the network service.
99 struct GNUNET_SERVICE_Context *service;
102 * Handle for request of hostname resolution, non-NULL if pending.
104 struct GNUNET_RESOLVER_RequestHandle *hostname_dns;
109 struct GNUNET_NETWORK_FDSet *rs;
112 * ID of task used to update our addresses when one expires.
114 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
119 GNUNET_SCHEDULER_TaskIdentifier select_task;
122 * Port that we are actually listening on.
127 * Port that the user said we would have visible to the
134 /* *********** globals ************* */
137 * the socket that we transmit all data with
139 static struct GNUNET_NETWORK_Handle *udp_sock;
142 * Disconnect from a remote node.
144 * @param cls closure ('struct Plugin'), unused
145 * @param target peer do disconnect
146 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
149 udp_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
151 /* nothing to do, UDP is stateless */
155 * Shutdown the server process (stop receiving inbound traffic). Maybe
159 udp_transport_server_stop (void *cls)
161 struct Plugin *plugin = cls;
164 GNUNET_assert (udp_sock != NULL);
165 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
167 GNUNET_SCHEDULER_cancel (plugin->env->sched, plugin->select_task);
168 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
171 ret = GNUNET_NETWORK_socket_close (udp_sock);
172 if (ret != GNUNET_SYSERR)
178 * Function that can be used by the transport service to transmit
179 * a message using the plugin.
182 * @param target who should receive this message (ignored by UDP)
183 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
184 * @param msgbuf_size the size of the msgbuf to send
185 * @param priority how important is the message (ignored by UDP)
186 * @param timeout when should we time out (give up) if we can not transmit?
187 * @param addr the addr to send the message to, needs to be a sockaddr for us
188 * @param addrlen the len of addr
189 * @param force_address GNUNET_YES if the plugin MUST use the given address,
190 * GNUNET_NO means the plugin may use any other address and
191 * GNUNET_SYSERR means that only reliable existing
192 * bi-directional connections should be used (regardless
194 * @param cont continuation to call once the message has
195 * been transmitted (or if the transport is ready
196 * for the next transmission call; or if the
197 * peer disconnected...)
198 * @param cont_cls closure for cont
200 * @return the number of bytes written, -1 on error (in this case, cont is not called)
203 udp_plugin_send (void *cls,
204 const struct GNUNET_PeerIdentity *target,
207 unsigned int priority,
208 struct GNUNET_TIME_Relative timeout,
212 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
214 struct Plugin *plugin = cls;
215 struct UDPMessage *message;
219 GNUNET_assert(udp_sock != NULL);
220 if ( (addr == NULL) || (addrlen == 0) )
223 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
224 ("udp_plugin_send called without address, returning!\n"));
226 return -1; /* Can never send if we don't have an address!! */
228 if (force_address == GNUNET_SYSERR)
229 return -1; /* never reliable */
231 /* Build the message to be sent */
232 message = GNUNET_malloc (sizeof (struct UDPMessage) + msgbuf_size);
233 ssize = sizeof (struct UDPMessage) + msgbuf_size;
236 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
237 ("In udp_send, ssize is %d, sending message to %s\n"), ssize, GNUNET_a2s((const struct sockaddr *)addr, addrlen));
239 message->header.size = htons (ssize);
240 message->header.type = htons (0);
241 memcpy (&message->sender, plugin->env->my_identity,
242 sizeof (struct GNUNET_PeerIdentity));
243 memcpy (&message[1], msgbuf, msgbuf_size);
245 GNUNET_NETWORK_socket_sendto (udp_sock, message, ssize,
248 if ( (cont != NULL) &&
250 cont (cont_cls, target, GNUNET_OK);
251 GNUNET_free (message);
257 * Add the IP of our network interface to the list of
258 * our external IP addresses.
261 process_interfaces (void *cls,
264 const struct sockaddr *addr, socklen_t addrlen)
266 struct Plugin *plugin = cls;
268 struct sockaddr_in *v4;
269 struct sockaddr_in6 *v6;
271 af = addr->sa_family;
274 v4 = (struct sockaddr_in *) addr;
275 v4->sin_port = htons (plugin->adv_port);
279 GNUNET_assert (af == AF_INET6);
280 v6 = (struct sockaddr_in6 *) addr;
281 v6->sin6_port = htons (plugin->adv_port);
283 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO |
284 GNUNET_ERROR_TYPE_BULK,
285 "udp", _("Found address `%s' (%s)\n"),
286 GNUNET_a2s (addr, addrlen), name);
287 plugin->env->notify_address (plugin->env->cls,
289 addr, addrlen, GNUNET_TIME_UNIT_FOREVER_REL);
296 * Function called by the resolver for each address obtained from DNS
297 * for our own hostname. Add the addresses to the list of our
298 * external IP addresses.
301 * @param addr one of the addresses of the host, NULL for the last address
302 * @param addrlen length of the address
305 process_hostname_ips (void *cls,
306 const struct sockaddr *addr, socklen_t addrlen)
308 struct Plugin *plugin = cls;
312 plugin->hostname_dns = NULL;
315 process_interfaces (plugin, "<hostname>", GNUNET_YES, addr, addrlen);
320 * @param cls the plugin handle
321 * @param tc the scheduling context (for rescheduling this function again)
323 * We have been notified that our writeset has something to read. Presumably
324 * select has been called already, so we can go ahead and start reading from
325 * the socket immediately. Then we check if there is more to be read by
326 * calling select ourselves while there is stuff on the wire. Then reschedule
327 * this function to be called again once more is available.
331 udp_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
333 struct Plugin *plugin = cls;
335 struct UDPMessage *msg;
336 struct GNUNET_PeerIdentity *sender;
339 struct sockaddr_storage addr;
345 const struct GNUNET_MessageHeader *currhdr;
348 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
349 ("entered select...\n"));
352 buflen = GNUNET_NETWORK_socket_recvfrom_amount (udp_sock);
355 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
356 ("we expect to read %u bytes\n"), buflen);
359 if (buflen == GNUNET_NO)
362 buf = GNUNET_malloc (buflen);
363 fromlen = sizeof (addr);
365 memset (&addr, 0, fromlen);
367 GNUNET_NETWORK_socket_recvfrom (udp_sock, buf, buflen,
368 (struct sockaddr *) &addr, &fromlen);
371 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
372 ("socket_recv returned %u, src_addr_len is %u\n"), ret,
381 msg = (struct UDPMessage *) buf;
384 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
385 ("header reports message size of %d\n"),
386 ntohs (msg->header.size));
388 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
389 ("header reports message type of %d\n"),
390 ntohs (msg->header.type));
392 if (ntohs (msg->header.size) < sizeof (struct UDPMessage))
395 GNUNET_NETWORK_fdset_zero (plugin->rs);
396 GNUNET_NETWORK_fdset_set (plugin->rs, udp_sock);
399 msgbuf = (char *)&msg[1];
400 sender = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
401 memcpy (sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
405 tsize = ntohs (msg->header.size) - sizeof(struct UDPMessage);
407 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "UDP", _
408 ("offset is %d, tsize is %d (UDPMessage size is %d)\n"),
409 offset, tsize, sizeof(struct UDPMessage));
411 while (offset < tsize)
413 currhdr = (struct GNUNET_MessageHeader *)&msgbuf[offset];
415 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
416 ("processing msg %d: type %d, size %d at offset %d\n"),
417 count, ntohs(currhdr->type), ntohs(currhdr->size), offset);
419 plugin->env->receive (plugin->env->cls,
420 sender, currhdr, UDP_DIRECT_DISTANCE, (char *)&addr, fromlen);
421 offset += ntohs(currhdr->size);
423 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "udp", _
424 ("offset now %d, tsize %d\n"),
430 GNUNET_free (sender);
433 plugin->select_task =
434 GNUNET_SCHEDULER_add_select (plugin->env->sched,
435 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
436 GNUNET_SCHEDULER_NO_TASK,
437 GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
438 NULL, &udp_plugin_select, plugin);
443 * Create a UDP socket. If possible, use IPv6, otherwise
446 static struct GNUNET_NETWORK_Handle *
447 udp_transport_server_start (void *cls)
449 struct Plugin *plugin = cls;
450 struct GNUNET_NETWORK_Handle *desc;
451 struct sockaddr_in serverAddrv4;
452 struct sockaddr_in6 serverAddrv6;
453 struct sockaddr *serverAddr;
458 GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg, "GNUNETD",
461 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_DGRAM, 17);
464 memset (&serverAddrv6, 0, sizeof (serverAddrv6));
465 #if HAVE_SOCKADDR_IN_SIN_LEN
466 serverAddrv6.sin6_len = sizeof (serverAddrv6);
468 serverAddrv6.sin6_family = AF_INET6;
469 serverAddrv6.sin6_addr = in6addr_any;
470 serverAddrv6.sin6_port = htons (plugin->open_port);
471 addrlen = sizeof (serverAddrv6);
472 serverAddr = (struct sockaddr *) &serverAddrv6;
477 desc = GNUNET_NETWORK_socket_create (PF_INET, SOCK_DGRAM, 17);
480 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "udp", "socket");
485 memset (&serverAddrv4, 0, sizeof (serverAddrv4));
486 #if HAVE_SOCKADDR_IN_SIN_LEN
487 serverAddrv4.sin_len = sizeof (serverAddrv4);
489 serverAddrv4.sin_family = AF_INET;
490 serverAddrv4.sin_addr.s_addr = INADDR_ANY;
491 serverAddrv4.sin_port = htons (plugin->open_port);
492 addrlen = sizeof (serverAddrv4);
493 serverAddr = (struct sockaddr *) &serverAddrv4;
499 GNUNET_assert (GNUNET_NETWORK_socket_bind (desc, serverAddr, addrlen) ==
503 plugin->rs = GNUNET_NETWORK_fdset_create ();
505 GNUNET_NETWORK_fdset_zero (plugin->rs);
506 GNUNET_NETWORK_fdset_set (plugin->rs, desc);
508 plugin->select_task =
509 GNUNET_SCHEDULER_add_select (plugin->env->sched,
510 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
511 GNUNET_SCHEDULER_NO_TASK,
512 GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
513 NULL, &udp_plugin_select, plugin);
520 * Check if the given port is plausible (must be either
521 * our listen port or our advertised port). If it is
522 * neither, we return one of these two ports at random.
524 * @return either in_port or a more plausible port
527 check_port (struct Plugin *plugin, uint16_t in_port)
529 if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
531 return (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
533 ? plugin->open_port : plugin->adv_port;
538 * Another peer has suggested an address for this peer and transport
539 * plugin. Check that this could be a valid address. This function
540 * is not expected to 'validate' the address in the sense of trying to
541 * connect to it but simply to see if the binary format is technically
542 * legal for establishing a connection.
544 * @param cls handle to Plugin
545 * @param addr address to check
546 * @param addrlen length of addr
547 * @return GNUNET_OK if this is a plausible address for this peer
548 * and transport, GNUNET_SYSERR if not
550 * TODO: perhaps make everything work with sockaddr_storage, it may
551 * be a cleaner way to handle addresses in UDP
554 udp_check_address (void *cls, void *addr, size_t addrlen)
556 struct Plugin *plugin = cls;
557 char buf[sizeof (struct sockaddr_in6)];
559 struct sockaddr_in *v4;
560 struct sockaddr_in6 *v6;
562 if ((addrlen != sizeof (struct sockaddr_in)) &&
563 (addrlen != sizeof (struct sockaddr_in6)))
566 return GNUNET_SYSERR;
568 memcpy (buf, addr, sizeof (struct sockaddr_in6));
569 if (addrlen == sizeof (struct sockaddr_in))
571 v4 = (struct sockaddr_in *) buf;
572 v4->sin_port = htons (check_port (plugin, ntohs (v4->sin_port)));
576 v6 = (struct sockaddr_in6 *) buf;
577 v6->sin6_port = htons (check_port (plugin, ntohs (v6->sin6_port)));
580 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
582 "Informing transport service about my address `%s'.\n",
583 GNUNET_a2s (addr, addrlen));
591 * Append our port and forward the result.
594 append_port (void *cls, const char *hostname)
596 struct PrettyPrinterContext *ppc = cls;
599 if (hostname == NULL)
601 ppc->asc (ppc->asc_cls, NULL);
605 GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
606 ppc->asc (ppc->asc_cls, ret);
612 * Convert the transports address to a nice, human-readable
616 * @param type name of the transport that generated the address
617 * @param addr one of the addresses of the host, NULL for the last address
618 * the specific address format depends on the transport
619 * @param addrlen length of the address
620 * @param numeric should (IP) addresses be displayed in numeric form?
621 * @param timeout after how long should we give up?
622 * @param asc function to call on each string
623 * @param asc_cls closure for asc
626 udp_plugin_address_pretty_printer (void *cls,
631 struct GNUNET_TIME_Relative timeout,
632 GNUNET_TRANSPORT_AddressStringCallback asc,
635 struct Plugin *plugin = cls;
636 const struct sockaddr_in *v4;
637 const struct sockaddr_in6 *v6;
638 struct PrettyPrinterContext *ppc;
640 if ((addrlen != sizeof (struct sockaddr_in)) &&
641 (addrlen != sizeof (struct sockaddr_in6)))
643 /* invalid address */
648 ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
650 ppc->asc_cls = asc_cls;
651 if (addrlen == sizeof (struct sockaddr_in))
653 v4 = (const struct sockaddr_in *) addr;
654 ppc->port = ntohs (v4->sin_port);
658 v6 = (const struct sockaddr_in6 *) addr;
659 ppc->port = ntohs (v6->sin6_port);
662 GNUNET_RESOLVER_hostname_get (plugin->env->sched,
666 !numeric, timeout, &append_port, ppc);
671 * The exported method. Makes the core api available via a global and
672 * returns the udp transport API.
675 libgnunet_plugin_transport_udp_init (void *cls)
677 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
678 struct GNUNET_TRANSPORT_PluginFunctions *api;
679 struct Plugin *plugin;
680 struct GNUNET_SERVICE_Context *service;
681 unsigned long long aport;
682 unsigned long long bport;
683 unsigned long long mtu;
685 service = GNUNET_SERVICE_start ("transport-udp", env->sched, env->cfg);
688 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "udp", _
689 ("Failed to start service for `%s' transport plugin.\n"),
695 GNUNET_CONFIGURATION_get_value_number (env->cfg,
701 GNUNET_CONFIGURATION_get_value_number (env->cfg,
704 &aport)) && (aport > 65535)))
706 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
709 ("Require valid port number for service `%s' in configuration!\n"),
711 GNUNET_SERVICE_stop (service);
719 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
721 _("MTU %llu for `%s' is probably too low!\n"), mtu,
724 plugin = GNUNET_malloc (sizeof (struct Plugin));
725 plugin->open_port = bport;
726 plugin->adv_port = aport;
728 plugin->statistics = NULL;
729 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
732 api->send = &udp_plugin_send;
733 api->disconnect = &udp_disconnect;
734 api->address_pretty_printer = &udp_plugin_address_pretty_printer;
735 api->check_address = &udp_check_address;
737 plugin->service = service;
739 /* FIXME: do the two calls below periodically again and
740 not just once (since the info we get might change...) */
741 GNUNET_OS_network_interfaces_list (&process_interfaces, plugin);
742 plugin->hostname_dns = GNUNET_RESOLVER_hostname_resolve (env->sched,
745 HOSTNAME_RESOLVE_TIMEOUT,
746 &process_hostname_ips,
749 udp_sock = udp_transport_server_start (plugin);
751 GNUNET_assert (udp_sock != NULL);
757 libgnunet_plugin_transport_udp_done (void *cls)
759 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
760 struct Plugin *plugin = api->cls;
762 udp_transport_server_stop (plugin);
763 if (NULL != plugin->hostname_dns)
765 GNUNET_RESOLVER_request_cancel (plugin->hostname_dns);
766 plugin->hostname_dns = NULL;
768 GNUNET_SERVICE_stop (plugin->service);
770 GNUNET_NETWORK_fdset_destroy (plugin->rs);
771 GNUNET_free (plugin);
776 /* end of plugin_transport_udp.c */