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 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 * @file transport/plugin_transport_unix.c
23 * @brief Transport plugin using unix domain sockets (!)
24 * Clearly, can only be used locally on Unix/Linux hosts...
25 * ONLY INTENDED FOR TESTING!!!
26 * @author Christian Grothoff
27 * @author Nathan Evans
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_connection_lib.h"
33 #include "gnunet_container_lib.h"
34 #include "gnunet_os_lib.h"
35 #include "gnunet_peerinfo_service.h"
36 #include "gnunet_protocols.h"
37 #include "gnunet_resolver_service.h"
38 #include "gnunet_server_lib.h"
39 #include "gnunet_signatures.h"
40 #include "gnunet_statistics_service.h"
41 #include "gnunet_transport_service.h"
42 #include "gnunet_transport_plugin.h"
43 #include "transport.h"
45 #define DEBUG_UNIX GNUNET_EXTRA_LOGGING
46 #define DETAILS GNUNET_NO
51 * Transport cost to peer, always 1 for UNIX (direct connection)
53 #define UNIX_DIRECT_DISTANCE 1
55 #define DEFAULT_NAT_PORT 0
58 * How long until we give up on transmitting the welcome message?
60 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
63 * Starting port for listening and sending, eventually a config value
65 #define UNIX_NAT_DEFAULT_PORT 22086
68 * UNIX Message-Packet header.
75 struct GNUNET_MessageHeader header;
78 * What is the identity of the sender (GNUNET_hash of public key)
80 struct GNUNET_PeerIdentity sender;
87 * Pointer to next element.
89 struct RetryList *next;
92 * Pointer to previous element.
94 struct RetryList *prev;
97 * The actual retry context.
99 struct RetrySendContext *retry_ctx;
103 * Network format for IPv4 addresses.
105 struct IPv4UdpAddress
108 * IPv4 address, in network byte order.
110 uint32_t ipv4_addr GNUNET_PACKED;
113 * Port number, in network byte order.
115 uint16_t u_port GNUNET_PACKED;
120 * Network format for IPv6 addresses.
122 struct IPv6UdpAddress
127 struct in6_addr ipv6_addr GNUNET_PACKED;
130 * Port number, in network byte order.
132 uint16_t u6_port GNUNET_PACKED;
135 /* Forward definition */
138 struct PrettyPrinterContext
140 GNUNET_TRANSPORT_AddressStringCallback asc;
145 struct RetrySendContext
149 * Main plugin handle.
151 struct Plugin *plugin;
154 * Address of recipient.
169 * Size of the message.
174 * Handle to send message out on.
176 struct GNUNET_NETWORK_Handle *send_handle;
179 * Continuation to call on success or
182 GNUNET_TRANSPORT_TransmitContinuation cont;
185 * Closure for continuation.
190 * The peer the message is destined for.
192 struct GNUNET_PeerIdentity target;
195 * How long before not retrying any longer.
197 struct GNUNET_TIME_Absolute timeout;
200 * How long the last message was delayed.
202 struct GNUNET_TIME_Relative delay;
205 * The actual retry task.
207 GNUNET_SCHEDULER_TaskIdentifier retry_task;
210 * The priority of the message.
212 unsigned int priority;
215 * Entry in the DLL of retry items.
217 struct RetryList *retry_list_entry;
228 * Stored in a linked list.
230 struct PeerSession *next;
233 * Pointer to the global plugin struct.
235 struct Plugin *plugin;
238 * To whom are we talking to (set to our identity
239 * if we are still waiting for the welcome message)
241 struct GNUNET_PeerIdentity target;
244 * Address of the other peer (either based on our 'connect'
245 * call or on our 'accept' call).
250 * Length of connect_addr.
255 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
257 int expecting_welcome;
260 * From which socket do we need to send to this peer?
262 struct GNUNET_NETWORK_Handle *sock;
265 * Queue of messages for this peer, in the case that
266 * we have to await a connection...
268 struct MessageQueue *messages;
273 * Information we keep for each of our listen sockets.
275 struct UNIX_Sock_Info
280 struct GNUNET_NETWORK_Handle *desc;
283 * The port we bound to
290 * Encapsulation of all of the state of the plugin.
297 struct GNUNET_TRANSPORT_PluginEnvironment *env;
300 * Session of peers with whom we are currently connected
302 struct PeerSession *sessions;
305 * ID of task used to update our addresses when one expires.
307 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
312 GNUNET_SCHEDULER_TaskIdentifier select_task;
315 * Integer to append to unix domain socket.
322 struct GNUNET_NETWORK_FDSet *rs;
325 * socket that we transmit all data with
327 struct UNIX_Sock_Info unix_sock;
330 * Path of our unix domain socket (/tmp/unix-plugin-PORT)
332 char *unix_socket_path;
339 static struct RetryList *retry_list_head;
344 static struct RetryList *retry_list_tail;
348 * Disconnect from a remote node. Clean up session if we have one for this peer
350 * @param cls closure for this call (should be handle to Plugin)
351 * @param target the peeridentity of the peer to disconnect
352 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
355 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
357 /** TODO: Implement! */
362 * Shutdown the server process (stop receiving inbound traffic). Maybe
365 * @param cls Handle to the plugin for this transport
367 * @return returns the number of sockets successfully closed,
368 * should equal the number of sockets successfully opened
371 unix_transport_server_stop (void *cls)
373 struct Plugin *plugin = cls;
374 struct RetryList *pos;
376 pos = retry_list_head;
378 while (NULL != (pos = retry_list_head))
380 GNUNET_CONTAINER_DLL_remove (retry_list_head, retry_list_tail, pos);
381 if (GNUNET_SCHEDULER_NO_TASK != pos->retry_ctx->retry_task)
383 GNUNET_SCHEDULER_cancel (pos->retry_ctx->retry_task);
385 GNUNET_free (pos->retry_ctx->msg);
386 GNUNET_free (pos->retry_ctx->addr);
387 GNUNET_free (pos->retry_ctx);
391 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
393 GNUNET_SCHEDULER_cancel (plugin->select_task);
394 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
397 GNUNET_break (GNUNET_OK ==
398 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
399 plugin->unix_sock.desc = NULL;
406 find_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *peer)
408 struct PeerSession *pos;
410 pos = plugin->sessions;
413 if (memcmp (&pos->target, peer, sizeof (struct GNUNET_PeerIdentity)) == 0)
421 /* Forward Declaration */
423 unix_real_send (void *cls, struct RetrySendContext *incoming_retry_context,
424 struct GNUNET_NETWORK_Handle *send_handle,
425 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
426 size_t msgbuf_size, unsigned int priority,
427 struct GNUNET_TIME_Relative timeout, const void *addr,
428 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
432 * Retry sending a message.
434 * @param cls closure a struct RetrySendContext
435 * @param tc context information
438 retry_send_message (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
440 struct RetrySendContext *retry_ctx = cls;
442 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
444 GNUNET_free (retry_ctx->msg);
445 GNUNET_free (retry_ctx->addr);
446 GNUNET_free (retry_ctx);
450 unix_real_send (retry_ctx->plugin, retry_ctx, retry_ctx->send_handle,
451 &retry_ctx->target, retry_ctx->msg, retry_ctx->msg_size,
453 GNUNET_TIME_absolute_get_remaining (retry_ctx->timeout),
454 retry_ctx->addr, retry_ctx->addrlen, retry_ctx->cont,
455 retry_ctx->cont_cls);
460 * Actually send out the message, assume we've got the address and
461 * send_handle squared away!
464 * @param incoming_retry_context the retry context to use
465 * @param send_handle which handle to send message on
466 * @param target who should receive this message (ignored by UNIX)
467 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
468 * @param msgbuf_size the size of the msgbuf to send
469 * @param priority how important is the message (ignored by UNIX)
470 * @param timeout when should we time out (give up) if we can not transmit?
471 * @param addr the addr to send the message to, needs to be a sockaddr for us
472 * @param addrlen the len of addr
473 * @param cont continuation to call once the message has
474 * been transmitted (or if the transport is ready
475 * for the next transmission call; or if the
476 * peer disconnected...)
477 * @param cont_cls closure for cont
479 * @return the number of bytes written, -1 on errors
482 unix_real_send (void *cls, struct RetrySendContext *incoming_retry_context,
483 struct GNUNET_NETWORK_Handle *send_handle,
484 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
485 size_t msgbuf_size, unsigned int priority,
486 struct GNUNET_TIME_Relative timeout, const void *addr,
487 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
490 struct Plugin *plugin = cls;
491 struct UNIXMessage *message;
492 struct RetrySendContext *retry_ctx;
497 struct sockaddr_un un;
499 struct RetryList *retry_list_entry;
502 if (send_handle == NULL)
505 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
506 "unix_real_send with send_handle NULL!\n");
508 /* failed to open send socket for AF */
510 cont (cont_cls, target, GNUNET_SYSERR);
513 if ((addr == NULL) || (addrlen == 0))
516 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
517 "unix_real_send called without address, returning!\n");
520 cont (cont_cls, target, GNUNET_SYSERR);
521 return 0; /* Can never send if we don't have an address!! */
524 /* Build the message to be sent */
525 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
526 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
528 message->header.size = htons (ssize);
529 message->header.type = htons (0);
530 memcpy (&message->sender, plugin->env->my_identity,
531 sizeof (struct GNUNET_PeerIdentity));
532 memcpy (&message[1], msgbuf, msgbuf_size);
534 memset (&un, 0, sizeof (un));
535 un.sun_family = AF_UNIX;
536 slen = strlen (addr) + 1;
537 if (slen >= sizeof (un.sun_path))
538 slen = sizeof (un.sun_path) - 1;
540 GNUNET_assert (slen < sizeof (un.sun_path));
541 memcpy (un.sun_path, addr, slen);
542 un.sun_path[slen] = '\0';
543 slen = sizeof (struct sockaddr_un);
545 un.sun_path[0] = '\0';
547 #if HAVE_SOCKADDR_IN_SIN_LEN
548 un.sun_len = (u_char) slen;
550 sb = (struct sockaddr *) &un;
554 sent = GNUNET_NETWORK_socket_sendto (send_handle, message, ssize, sb, sbs);
556 if ((GNUNET_SYSERR == sent) && (errno == EAGAIN))
559 if ((GNUNET_SYSERR == sent) && (errno == EMSGSIZE))
562 socklen_t len = sizeof (size);
564 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
565 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
571 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
572 "Trying to increase socket buffer size from %i to %i for message size %i\n",
573 size, ((ssize / 1000) + 2) * 1000, ssize);
575 size = ((ssize / 1000) + 2) * 1000;
576 if (GNUNET_NETWORK_socket_setsockopt
577 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
578 &size, sizeof (size)) == GNUNET_OK)
581 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
585 if (retry == GNUNET_YES)
587 if (incoming_retry_context == NULL)
589 retry_list_entry = GNUNET_malloc (sizeof (struct RetryList));
590 retry_ctx = GNUNET_malloc (sizeof (struct RetrySendContext));
591 retry_ctx->addr = GNUNET_malloc (addrlen);
592 retry_ctx->msg = GNUNET_malloc (msgbuf_size);
593 retry_ctx->plugin = plugin;
594 memcpy (retry_ctx->addr, addr, addrlen);
595 memcpy (retry_ctx->msg, msgbuf, msgbuf_size);
596 retry_ctx->msg_size = msgbuf_size;
597 retry_ctx->addrlen = addrlen;
598 retry_ctx->send_handle = send_handle;
599 retry_ctx->cont = cont;
600 retry_ctx->cont_cls = cont_cls;
601 retry_ctx->priority = priority;
602 retry_ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
603 memcpy (&retry_ctx->target, target, sizeof (struct GNUNET_PeerIdentity));
604 retry_ctx->delay = GNUNET_TIME_UNIT_MILLISECONDS;
605 retry_ctx->retry_list_entry = retry_list_entry;
606 retry_list_entry->retry_ctx = retry_ctx;
607 GNUNET_CONTAINER_DLL_insert (retry_list_head, retry_list_tail,
612 retry_ctx = incoming_retry_context;
613 retry_ctx->delay = GNUNET_TIME_relative_multiply (retry_ctx->delay, 2);
615 retry_ctx->retry_task =
616 GNUNET_SCHEDULER_add_delayed (retry_ctx->delay, &retry_send_message,
619 //GNUNET_log_strerror (GNUNET_ERROR_TYPE_DEBUG, "send");
620 GNUNET_free (message);
624 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
625 "UNIX transmit %u-byte message to %s (%d: %s)\n",
626 (unsigned int) ssize, GNUNET_a2s (sb, sbs), (int) sent,
627 (sent < 0) ? STRERROR (errno) : "ok");
631 if (sent == GNUNET_SYSERR)
632 cont (cont_cls, target, GNUNET_SYSERR);
635 cont (cont_cls, target, GNUNET_OK);
639 if (incoming_retry_context != NULL)
641 GNUNET_CONTAINER_DLL_remove (retry_list_head, retry_list_tail,
642 incoming_retry_context->retry_list_entry);
643 GNUNET_free (incoming_retry_context->retry_list_entry);
644 GNUNET_free (incoming_retry_context->msg);
645 GNUNET_free (incoming_retry_context->addr);
646 GNUNET_free (incoming_retry_context);
649 GNUNET_free (message);
655 * Function that can be used by the transport service to transmit
656 * a message using the plugin.
659 * @param target who should receive this message (ignored by UNIX)
660 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
661 * @param msgbuf_size the size of the msgbuf to send
662 * @param priority how important is the message (ignored by UNIX)
663 * @param timeout when should we time out (give up) if we can not transmit?
664 * @param session identifier used for this session (can be NULL)
665 * @param addr the addr to send the message to, needs to be a sockaddr for us
666 * @param addrlen the len of addr
667 * @param force_address not used, we had better have an address to send to
668 * because we are stateless!!
669 * @param cont continuation to call once the message has
670 * been transmitted (or if the transport is ready
671 * for the next transmission call; or if the
672 * peer disconnected...)
673 * @param cont_cls closure for cont
675 * @return the number of bytes written (may return 0 and the message can
676 * still be transmitted later!)
679 unix_plugin_send (void *cls, const struct GNUNET_PeerIdentity *target,
680 const char *msgbuf, size_t msgbuf_size, unsigned int priority,
681 struct GNUNET_TIME_Relative timeout, struct Session *session,
682 const void *addr, size_t addrlen, int force_address,
683 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
685 struct Plugin *plugin = cls;
688 GNUNET_assert (NULL == session);
691 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Asked to send message to `%s'\n",
695 unix_real_send (cls, NULL, plugin->unix_sock.desc, target, msgbuf,
696 msgbuf_size, priority, timeout, addr, addrlen, cont,
699 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", sent,
702 if (sent == GNUNET_SYSERR)
709 * Demultiplexer for UNIX messages
711 * @param plugin the main plugin for this transport
712 * @param sender from which peer the message was received
713 * @param currhdr pointer to the header of the message
714 * @param un the address from which the message was received
715 * @param fromlen the length of the address
718 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
719 const struct GNUNET_MessageHeader *currhdr,
720 const struct sockaddr_un *un, size_t fromlen)
722 struct GNUNET_ATS_Information distance;
724 distance.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
725 distance.value = htonl (UNIX_DIRECT_DISTANCE);
727 GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
730 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
733 plugin->env->receive (plugin->env->cls, sender, currhdr,
734 (const struct GNUNET_ATS_Information *) &distance, 1,
735 NULL, un->sun_path, strlen (un->sun_path) + 1);
740 * @param cls the plugin handle
741 * @param tc the scheduling context (for rescheduling this function again)
743 * We have been notified that our writeset has something to read. We don't
744 * know which socket needs to be read, so we have to check each one
745 * Then reschedule this function to be called again once more is available.
749 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
751 struct Plugin *plugin = cls;
753 struct UNIXMessage *msg;
754 struct GNUNET_PeerIdentity sender;
755 struct sockaddr_un un;
761 const struct GNUNET_MessageHeader *currhdr;
764 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
765 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
768 addrlen = sizeof (un);
769 memset (&un, 0, sizeof (un));
770 GNUNET_assert (GNUNET_NETWORK_fdset_isset
771 (tc->read_ready, plugin->unix_sock.desc));
773 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
774 (struct sockaddr *) &un, &addrlen);
776 if (ret == GNUNET_SYSERR)
778 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
779 plugin->select_task =
780 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
781 GNUNET_SCHEDULER_NO_TASK,
782 GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
783 NULL, &unix_plugin_select, plugin);
789 un.sun_path[0] = '/';
792 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
797 GNUNET_assert (AF_UNIX == (un.sun_family));
799 msg = (struct UNIXMessage *) buf;
800 csize = ntohs (msg->header.size);
801 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
804 plugin->select_task =
805 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
806 GNUNET_SCHEDULER_NO_TASK,
807 GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
808 NULL, &unix_plugin_select, plugin);
811 msgbuf = (char *) &msg[1];
812 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
814 tsize = csize - sizeof (struct UNIXMessage);
815 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
817 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
818 csize = ntohs (currhdr->size);
819 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
820 (csize > tsize - offset))
825 unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
828 plugin->select_task =
829 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
830 GNUNET_SCHEDULER_NO_TASK,
831 GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
832 NULL, &unix_plugin_select, plugin);
836 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
838 * @param cls closure for server start, should be a struct Plugin *
839 * @return number of sockets created or GNUNET_SYSERR on error
842 unix_transport_server_start (void *cls)
844 struct Plugin *plugin = cls;
845 struct sockaddr *serverAddr;
847 struct sockaddr_un un;
850 memset (&un, 0, sizeof (un));
851 un.sun_family = AF_UNIX;
852 slen = strlen (plugin->unix_socket_path) + 1;
853 if (slen >= sizeof (un.sun_path))
854 slen = sizeof (un.sun_path) - 1;
856 memcpy (un.sun_path, plugin->unix_socket_path, slen);
857 un.sun_path[slen] = '\0';
858 slen = sizeof (struct sockaddr_un);
859 #if HAVE_SOCKADDR_IN_SIN_LEN
860 un.sun_len = (u_char) slen;
863 serverAddr = (struct sockaddr *) &un;
866 un.sun_path[0] = '\0';
869 plugin->unix_sock.desc =
870 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
871 if (NULL == plugin->unix_sock.desc)
873 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
874 return GNUNET_SYSERR;
876 if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
879 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
880 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
881 plugin->unix_sock.desc = NULL;
882 return GNUNET_SYSERR;
885 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "unix", "Bound to `%s'\n",
888 plugin->rs = GNUNET_NETWORK_fdset_create ();
889 GNUNET_NETWORK_fdset_zero (plugin->rs);
890 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
892 plugin->select_task =
893 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
894 GNUNET_SCHEDULER_NO_TASK,
895 GNUNET_TIME_UNIT_FOREVER_REL, plugin->rs,
896 NULL, &unix_plugin_select, plugin);
902 * Function that will be called to check if a binary address for this
903 * plugin is well-formed and corresponds to an address for THIS peer
904 * (as per our configuration). Naturally, if absolutely necessary,
905 * plugins can be a bit conservative in their answer, but in general
906 * plugins should make sure that the address does not redirect
907 * traffic to a 3rd party that might try to man-in-the-middle our
910 * @param cls closure, should be our handle to the Plugin
911 * @param addr pointer to the address
912 * @param addrlen length of addr
913 * @return GNUNET_OK if this is a plausible address for this peer
914 * and transport, GNUNET_SYSERR if not
918 unix_check_address (void *cls, const void *addr, size_t addrlen)
922 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
923 "Informing transport service about my address `%s'\n",
931 * Append our port and forward the result.
934 append_port (void *cls, const char *hostname)
936 struct PrettyPrinterContext *ppc = cls;
939 if (hostname == NULL)
941 ppc->asc (ppc->asc_cls, NULL);
945 GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
946 ppc->asc (ppc->asc_cls, ret);
952 * Convert the transports address to a nice, human-readable
956 * @param type name of the transport that generated the address
957 * @param addr one of the addresses of the host, NULL for the last address
958 * the specific address format depends on the transport
959 * @param addrlen length of the address
960 * @param numeric should (IP) addresses be displayed in numeric form?
961 * @param timeout after how long should we give up?
962 * @param asc function to call on each string
963 * @param asc_cls closure for asc
966 unix_plugin_address_pretty_printer (void *cls, const char *type,
967 const void *addr, size_t addrlen,
969 struct GNUNET_TIME_Relative timeout,
970 GNUNET_TRANSPORT_AddressStringCallback asc,
973 struct PrettyPrinterContext *ppc;
976 struct sockaddr_in a4;
977 struct sockaddr_in6 a6;
978 const struct IPv4UdpAddress *u4;
979 const struct IPv6UdpAddress *u6;
982 if (addrlen == sizeof (struct IPv6UdpAddress))
985 memset (&a6, 0, sizeof (a6));
986 a6.sin6_family = AF_INET6;
987 a6.sin6_port = u6->u6_port;
988 memcpy (&a6.sin6_addr, &u6->ipv6_addr, sizeof (struct in6_addr));
989 port = ntohs (u6->u6_port);
993 else if (addrlen == sizeof (struct IPv4UdpAddress))
996 memset (&a4, 0, sizeof (a4));
997 a4.sin_family = AF_INET;
998 a4.sin_port = u4->u_port;
999 a4.sin_addr.s_addr = u4->ipv4_addr;
1000 port = ntohs (u4->u_port);
1006 /* invalid address */
1007 GNUNET_break_op (0);
1008 asc (asc_cls, NULL);
1011 ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
1013 ppc->asc_cls = asc_cls;
1015 GNUNET_RESOLVER_hostname_get (sb, sbs, !numeric, timeout, &append_port, ppc);
1019 * Function called for a quick conversion of the binary address to
1020 * a numeric address. Note that the caller must not free the
1021 * address and that the next call to this function is allowed
1022 * to override the address again.
1024 * @param cls closure
1025 * @param addr binary address
1026 * @param addrlen length of the address
1027 * @return string representing the same address
1030 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1032 if ((addr != NULL) && (addrlen > 0))
1033 return (const char *) addr;
1039 * Notify transport service about address
1041 * @param cls the plugin
1045 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1047 struct Plugin *plugin = cls;
1049 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1050 plugin->unix_socket_path,
1051 strlen (plugin->unix_socket_path) + 1);
1055 * The exported method. Makes the core api available via a global and
1056 * returns the unix transport API.
1059 libgnunet_plugin_transport_unix_init (void *cls)
1061 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1062 unsigned long long port;
1063 struct GNUNET_TRANSPORT_PluginFunctions *api;
1064 struct Plugin *plugin;
1065 int sockets_created;
1068 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1070 port = UNIX_NAT_DEFAULT_PORT;
1071 plugin = GNUNET_malloc (sizeof (struct Plugin));
1072 plugin->port = port;
1074 GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1077 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1080 api->send = &unix_plugin_send;
1081 api->disconnect = &unix_disconnect;
1082 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1083 api->address_to_string = &unix_address_to_string;
1084 api->check_address = &unix_check_address;
1085 sockets_created = unix_transport_server_start (plugin);
1086 if (sockets_created == 0)
1087 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1089 GNUNET_SCHEDULER_add_now (address_notification, plugin);
1094 libgnunet_plugin_transport_unix_done (void *cls)
1096 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1097 struct Plugin *plugin = api->cls;
1099 unix_transport_server_stop (plugin);
1101 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1102 GNUNET_free (plugin->unix_socket_path);
1103 GNUNET_free (plugin);
1108 /* end of plugin_transport_unix.c */