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_EXTRALOGGING
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
67 GNUNET_NETWORK_STRUCT_BEGIN
70 * UNIX Message-Packet header.
77 struct GNUNET_MessageHeader header;
80 * What is the identity of the sender (GNUNET_hash of public key)
82 struct GNUNET_PeerIdentity sender;
90 struct GNUNET_PeerIdentity target;
93 struct UNIXMessageWrapper
95 struct UNIXMessageWrapper *next;
96 struct UNIXMessageWrapper *prev;
98 struct UNIXMessage * msg;
101 struct GNUNET_TIME_Relative timeout;
102 unsigned int priority;
104 struct Session *session;
105 GNUNET_TRANSPORT_TransmitContinuation cont;
109 /* Forward definition */
120 * Stored in a linked list.
122 struct PeerSession *next;
125 * Pointer to the global plugin struct.
127 struct Plugin *plugin;
130 * To whom are we talking to (set to our identity
131 * if we are still waiting for the welcome message)
133 struct GNUNET_PeerIdentity target;
136 * Address of the other peer (either based on our 'connect'
137 * call or on our 'accept' call).
142 * Length of connect_addr.
147 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
149 int expecting_welcome;
152 * From which socket do we need to send to this peer?
154 struct GNUNET_NETWORK_Handle *sock;
157 * Queue of messages for this peer, in the case that
158 * we have to await a connection...
160 struct MessageQueue *messages;
165 * Information we keep for each of our listen sockets.
167 struct UNIX_Sock_Info
172 struct GNUNET_NETWORK_Handle *desc;
175 * The port we bound to
182 * Encapsulation of all of the state of the plugin.
189 struct GNUNET_TRANSPORT_PluginEnvironment *env;
192 * Session of peers with whom we are currently connected
194 struct PeerSession *sessions;
199 struct GNUNET_CONTAINER_MultiHashMap *session_map;
202 * ID of task used to update our addresses when one expires.
204 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
209 GNUNET_SCHEDULER_TaskIdentifier select_task;
212 * Integer to append to unix domain socket.
219 struct GNUNET_NETWORK_FDSet *rs;
224 struct GNUNET_NETWORK_FDSet *ws;
229 * socket that we transmit all data with
231 struct UNIX_Sock_Info unix_sock;
234 * Path of our unix domain socket (/tmp/unix-plugin-PORT)
236 char *unix_socket_path;
238 struct UNIXMessageWrapper *msg_head;
239 struct UNIXMessageWrapper *msg_tail;
244 struct GNUNET_ATS_Information ats_network;
246 unsigned int bytes_in_queue;
251 get_session_delete_it (void *cls, const GNUNET_HashCode * key, void *value)
253 struct Session *s = value;
254 struct Plugin *plugin = cls;
255 GNUNET_assert (plugin != NULL);
258 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Deleting session for peer `%s' `%s' \n", GNUNET_i2s (&s->target), s->addr);
261 plugin->env->session_end (plugin->env->cls, &s->target, s);
263 GNUNET_assert (GNUNET_YES ==
264 GNUNET_CONTAINER_multihashmap_remove(plugin->session_map, &s->target.hashPubKey, s));
266 GNUNET_STATISTICS_set(plugin->env->stats,
267 "# UNIX sessions active",
268 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
277 * Disconnect from a remote node. Clean up session if we have one for this peer
279 * @param cls closure for this call (should be handle to Plugin)
280 * @param target the peeridentity of the peer to disconnect
281 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
284 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
286 struct Plugin *plugin = cls;
287 GNUNET_assert (plugin != NULL);
289 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &target->hashPubKey, &get_session_delete_it, plugin);
294 * Shutdown the server process (stop receiving inbound traffic). Maybe
297 * @param cls Handle to the plugin for this transport
299 * @return returns the number of sockets successfully closed,
300 * should equal the number of sockets successfully opened
303 unix_transport_server_stop (void *cls)
305 struct Plugin *plugin = cls;
307 struct UNIXMessageWrapper * msgw = plugin->msg_head;
309 while (NULL != (msgw = plugin->msg_head))
311 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
312 if (msgw->cont != NULL)
313 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR);
314 GNUNET_free (msgw->msg);
318 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
320 GNUNET_SCHEDULER_cancel (plugin->select_task);
321 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
324 if (NULL != plugin->unix_sock.desc)
326 GNUNET_break (GNUNET_OK ==
327 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
328 plugin->unix_sock.desc = NULL;
329 plugin->with_ws = GNUNET_NO;
336 find_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *peer)
338 struct PeerSession *pos;
340 pos = plugin->sessions;
343 if (memcmp (&pos->target, peer, sizeof (struct GNUNET_PeerIdentity)) == 0)
353 * Actually send out the message, assume we've got the address and
354 * send_handle squared away!
357 * @param send_handle which handle to send message on
358 * @param target who should receive this message (ignored by UNIX)
359 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
360 * @param msgbuf_size the size of the msgbuf to send
361 * @param priority how important is the message (ignored by UNIX)
362 * @param timeout when should we time out (give up) if we can not transmit?
363 * @param addr the addr to send the message to, needs to be a sockaddr for us
364 * @param addrlen the len of addr
365 * @param cont continuation to call once the message has
366 * been transmitted (or if the transport is ready
367 * for the next transmission call; or if the
368 * peer disconnected...)
369 * @param cont_cls closure for cont
371 * @return the number of bytes written, -1 on errors
374 unix_real_send (void *cls,
375 struct GNUNET_NETWORK_Handle *send_handle,
376 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
377 size_t msgbuf_size, unsigned int priority,
378 struct GNUNET_TIME_Relative timeout, const void *addr,
379 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
386 struct sockaddr_un un;
390 if (send_handle == NULL)
393 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
394 "unix_real_send with send_handle NULL!\n");
396 /* failed to open send socket for AF */
398 cont (cont_cls, target, GNUNET_SYSERR);
401 if ((addr == NULL) || (addrlen == 0))
404 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
405 "unix_real_send called without address, returning!\n");
408 cont (cont_cls, target, GNUNET_SYSERR);
409 return 0; /* Can never send if we don't have an address!! */
412 memset (&un, 0, sizeof (un));
413 un.sun_family = AF_UNIX;
414 slen = strlen (addr) + 1;
415 if (slen >= sizeof (un.sun_path))
416 slen = sizeof (un.sun_path) - 1;
418 GNUNET_assert (slen < sizeof (un.sun_path));
419 memcpy (un.sun_path, addr, slen);
420 un.sun_path[slen] = '\0';
421 slen = sizeof (struct sockaddr_un);
423 un.sun_path[0] = '\0';
425 #if HAVE_SOCKADDR_IN_SIN_LEN
426 un.sun_len = (u_char) slen;
428 sb = (struct sockaddr *) &un;
431 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
433 if ((GNUNET_SYSERR == sent) && ((errno == EAGAIN) || (errno == ENOBUFS)))
436 if ((GNUNET_SYSERR == sent) && (errno == EMSGSIZE))
439 socklen_t len = sizeof (size);
441 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
442 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
445 if (size < msgbuf_size)
447 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
448 "Trying to increase socket buffer size from %i to %i for message size %i\n",
449 size, ((msgbuf_size / 1000) + 2) * 1000, msgbuf_size);
450 size = ((msgbuf_size / 1000) + 2) * 1000;
451 if (GNUNET_NETWORK_socket_setsockopt
452 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
453 &size, sizeof (size)) == GNUNET_OK)
455 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
459 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
465 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
466 "UNIX transmit %u-byte message to %s (%d: %s)\n",
467 (unsigned int) msgbuf_size, GNUNET_a2s (sb, sbs), (int) sent,
468 (sent < 0) ? STRERROR (errno) : "ok");
470 /* Calling continuation */
473 if ((sent == GNUNET_SYSERR) && (retry == GNUNET_NO))
474 cont (cont_cls, target, GNUNET_SYSERR);
476 cont (cont_cls, target, GNUNET_OK);
479 /* return number of bytes successfully sent */
482 /* failed and retry: return 0 */
483 if ((GNUNET_SYSERR == sent) && (retry == GNUNET_YES))
485 /* failed and no retry: return -1 */
486 if ((GNUNET_SYSERR == sent) && (retry == GNUNET_NO))
500 get_session_it (void *cls, const GNUNET_HashCode * key, void *value)
502 struct gsi_ctx *gsi = cls;
503 struct Session *s = value;
506 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Comparing session %s %s\n", gsi->address, s->addr);
508 if ((gsi->addrlen == s->addrlen) &&
509 (0 == memcmp (gsi->address, s->addr, s->addrlen)))
518 * Creates a new outbound session the transport service will use to send data to the
521 * @param cls the plugin
522 * @param address the address
523 * @return the session or NULL of max connections exceeded
525 static struct Session *
526 unix_plugin_get_session (void *cls,
527 const struct GNUNET_HELLO_Address *address)
529 struct Session * s = NULL;
530 struct Plugin *plugin = cls;
534 GNUNET_assert (plugin != NULL);
535 GNUNET_assert (address != NULL);
537 /* Check if already existing */
538 gsi.address = (char *) address->address;
539 gsi.addrlen = address->address_length;
541 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &address->peer.hashPubKey, &get_session_it, &gsi);
545 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Found existing session\n");
550 /* Create a new session */
552 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
554 s->addrlen = address->address_length;
555 memcpy(s->addr, address->address, s->addrlen);
556 memcpy(&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
558 GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
559 &address->peer.hashPubKey, s,
560 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
562 GNUNET_STATISTICS_set(plugin->env->stats,
563 "# UNIX sessions active",
564 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
568 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating new session\n");
575 * @param cls the plugin handle
576 * @param tc the scheduling context (for rescheduling this function again)
578 * We have been notified that our writeset has something to read. We don't
579 * know which socket needs to be read, so we have to check each one
580 * Then reschedule this function to be called again once more is available.
584 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
587 * Function that can be used by the transport service to transmit
588 * a message using the plugin. Note that in the case of a
589 * peer disconnecting, the continuation MUST be called
590 * prior to the disconnect notification itself. This function
591 * will be called with this peer's HELLO message to initiate
592 * a fresh connection to another peer.
595 * @param session which session must be used
596 * @param msgbuf the message to transmit
597 * @param msgbuf_size number of bytes in 'msgbuf'
598 * @param priority how important is the message (most plugins will
599 * ignore message priority and just FIFO)
600 * @param to how long to wait at most for the transmission (does not
601 * require plugins to discard the message after the timeout,
602 * just advisory for the desired delay; most plugins will ignore
604 * @param cont continuation to call once the message has
605 * been transmitted (or if the transport is ready
606 * for the next transmission call; or if the
607 * peer disconnected...); can be NULL
608 * @param cont_cls closure for cont
609 * @return number of bytes used (on the physical network, with overheads);
610 * -1 on hard errors (i.e. address invalid); 0 is a legal value
611 * and does NOT mean that the message was not transmitted (DV)
614 unix_plugin_send (void *cls,
615 struct Session *session,
616 const char *msgbuf, size_t msgbuf_size,
617 unsigned int priority,
618 struct GNUNET_TIME_Relative to,
619 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
621 struct Plugin *plugin = cls;
622 struct UNIXMessageWrapper *wrapper;
623 struct UNIXMessage *message;
626 GNUNET_assert (plugin != NULL);
627 GNUNET_assert (session != NULL);
629 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_contains_value(plugin->session_map,
630 &session->target.hashPubKey, session))
633 return GNUNET_SYSERR;
636 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
637 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
638 message->header.size = htons (ssize);
639 message->header.type = htons (0);
640 memcpy (&message->sender, plugin->env->my_identity,
641 sizeof (struct GNUNET_PeerIdentity));
642 memcpy (&message[1], msgbuf, msgbuf_size);
645 wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
646 wrapper->msg = message;
647 wrapper->msgsize = ssize;
648 wrapper->priority = priority;
649 wrapper->timeout = to;
650 wrapper->cont = cont;
651 wrapper->cont_cls = cont_cls;
652 wrapper->session = session;
654 GNUNET_CONTAINER_DLL_insert(plugin->msg_head, plugin->msg_tail, wrapper);
656 plugin->bytes_in_queue += ssize;
657 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes in send queue",
658 plugin->bytes_in_queue, GNUNET_NO);
661 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", ssize,
662 (char *) session->addr);
665 if (plugin->with_ws == GNUNET_NO)
667 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
668 GNUNET_SCHEDULER_cancel(plugin->select_task);
670 plugin->select_task =
671 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
672 GNUNET_TIME_UNIT_FOREVER_REL,
675 &unix_plugin_select, plugin);
676 plugin->with_ws = GNUNET_YES;
683 * Demultiplexer for UNIX messages
685 * @param plugin the main plugin for this transport
686 * @param sender from which peer the message was received
687 * @param currhdr pointer to the header of the message
688 * @param un the address from which the message was received
689 * @param fromlen the length of the address
692 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
693 const struct GNUNET_MessageHeader *currhdr,
694 const struct sockaddr_un *un, size_t fromlen)
696 struct GNUNET_ATS_Information ats[2];
698 ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
699 ats[0].value = htonl (UNIX_DIRECT_DISTANCE);
700 ats[1] = plugin->ats_network;
701 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
703 GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
706 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
709 plugin->env->receive (plugin->env->cls, sender, currhdr,
710 (const struct GNUNET_ATS_Information *) &ats, 2,
711 NULL, un->sun_path, strlen (un->sun_path) + 1);
716 unix_plugin_select_read (struct Plugin * plugin)
718 char buf[65536] GNUNET_ALIGN;
719 struct UNIXMessage *msg;
720 struct GNUNET_PeerIdentity sender;
721 struct sockaddr_un un;
727 const struct GNUNET_MessageHeader *currhdr;
730 addrlen = sizeof (un);
731 memset (&un, 0, sizeof (un));
734 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
735 (struct sockaddr *) &un, &addrlen);
737 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
740 if (ret == GNUNET_SYSERR)
742 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
748 un.sun_path[0] = '/';
751 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
756 GNUNET_assert (AF_UNIX == (un.sun_family));
758 msg = (struct UNIXMessage *) buf;
759 csize = ntohs (msg->header.size);
760 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
765 msgbuf = (char *) &msg[1];
766 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
768 tsize = csize - sizeof (struct UNIXMessage);
769 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
771 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
772 csize = ntohs (currhdr->size);
773 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
774 (csize > tsize - offset))
779 unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
785 unix_plugin_select_write (struct Plugin * plugin)
788 struct UNIXMessageWrapper * msgw = plugin->msg_head;
790 sent = unix_real_send (plugin,
791 plugin->unix_sock.desc,
792 &msgw->session->target,
793 (const char *) msgw->msg,
798 msgw->session->addrlen,
799 msgw->cont, msgw->cont_cls);
801 /* successfully sent bytes */
804 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
806 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
807 plugin->bytes_in_queue -= msgw->msgsize;
808 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes in send queue",
809 plugin->bytes_in_queue, GNUNET_NO);
811 GNUNET_free (msgw->msg);
816 /* failed and no retry */
819 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
821 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
822 plugin->bytes_in_queue -= msgw->msgsize;
823 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes in send queue",
824 plugin->bytes_in_queue, GNUNET_NO);
826 GNUNET_free (msgw->msg);
831 /* failed and retry */
837 * @param cls the plugin handle
838 * @param tc the scheduling context (for rescheduling this function again)
840 * We have been notified that our writeset has something to read. We don't
841 * know which socket needs to be read, so we have to check each one
842 * Then reschedule this function to be called again once more is available.
846 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
848 struct Plugin *plugin = cls;
850 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
851 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
854 plugin->with_ws = GNUNET_NO;
855 if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
857 GNUNET_assert (GNUNET_NETWORK_fdset_isset
858 (tc->write_ready, plugin->unix_sock.desc));
859 if (plugin->msg_head != NULL)
860 unix_plugin_select_write (plugin);
863 if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
865 GNUNET_assert (GNUNET_NETWORK_fdset_isset
866 (tc->read_ready, plugin->unix_sock.desc));
867 unix_plugin_select_read (plugin);
870 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
871 GNUNET_SCHEDULER_cancel (plugin->select_task);
872 plugin->select_task =
873 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
874 GNUNET_TIME_UNIT_FOREVER_REL,
876 (plugin->msg_head != NULL) ? plugin->ws : NULL,
877 &unix_plugin_select, plugin);
878 if (plugin->msg_head != NULL)
879 plugin->with_ws = GNUNET_YES;
883 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
885 * @param cls closure for server start, should be a struct Plugin *
886 * @return number of sockets created or GNUNET_SYSERR on error
889 unix_transport_server_start (void *cls)
891 struct Plugin *plugin = cls;
892 struct sockaddr *serverAddr;
894 struct sockaddr_un un;
897 memset (&un, 0, sizeof (un));
898 un.sun_family = AF_UNIX;
899 slen = strlen (plugin->unix_socket_path) + 1;
900 if (slen >= sizeof (un.sun_path))
901 slen = sizeof (un.sun_path) - 1;
903 memcpy (un.sun_path, plugin->unix_socket_path, slen);
904 un.sun_path[slen] = '\0';
905 slen = sizeof (struct sockaddr_un);
906 #if HAVE_SOCKADDR_IN_SIN_LEN
907 un.sun_len = (u_char) slen;
910 serverAddr = (struct sockaddr *) &un;
913 un.sun_path[0] = '\0';
915 plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, serverAddr, addrlen);
916 plugin->unix_sock.desc =
917 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
918 if (NULL == plugin->unix_sock.desc)
920 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
921 return GNUNET_SYSERR;
923 if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
926 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
927 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
928 plugin->unix_sock.desc = NULL;
929 return GNUNET_SYSERR;
932 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "unix", "Bound to `%s'\n",
935 plugin->rs = GNUNET_NETWORK_fdset_create ();
936 plugin->ws = GNUNET_NETWORK_fdset_create ();
937 GNUNET_NETWORK_fdset_zero (plugin->rs);
938 GNUNET_NETWORK_fdset_zero (plugin->ws);
939 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
940 GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
942 plugin->select_task =
943 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
944 GNUNET_TIME_UNIT_FOREVER_REL,
947 &unix_plugin_select, plugin);
948 plugin->with_ws = GNUNET_NO;
955 * Function that will be called to check if a binary address for this
956 * plugin is well-formed and corresponds to an address for THIS peer
957 * (as per our configuration). Naturally, if absolutely necessary,
958 * plugins can be a bit conservative in their answer, but in general
959 * plugins should make sure that the address does not redirect
960 * traffic to a 3rd party that might try to man-in-the-middle our
963 * @param cls closure, should be our handle to the Plugin
964 * @param addr pointer to the address
965 * @param addrlen length of addr
966 * @return GNUNET_OK if this is a plausible address for this peer
967 * and transport, GNUNET_SYSERR if not
971 unix_check_address (void *cls, const void *addr, size_t addrlen)
975 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
976 "Informing transport service about my address `%s'\n",
984 * Convert the transports address to a nice, human-readable
988 * @param type name of the transport that generated the address
989 * @param addr one of the addresses of the host, NULL for the last address
990 * the specific address format depends on the transport
991 * @param addrlen length of the address
992 * @param numeric should (IP) addresses be displayed in numeric form?
993 * @param timeout after how long should we give up?
994 * @param asc function to call on each string
995 * @param asc_cls closure for asc
998 unix_plugin_address_pretty_printer (void *cls, const char *type,
999 const void *addr, size_t addrlen,
1001 struct GNUNET_TIME_Relative timeout,
1002 GNUNET_TRANSPORT_AddressStringCallback asc,
1005 if ((addr != NULL) && (addrlen > 0))
1006 asc (asc_cls, (const char *) addr);
1010 asc (asc_cls, "Invalid UNIX address");
1016 * Function called to convert a string address to
1019 * @param cls closure ('struct Plugin*')
1020 * @param addr string address
1021 * @param addrlen length of the address
1022 * @param buf location to store the buffer
1023 * If the function returns GNUNET_SYSERR, its contents are undefined.
1024 * @param added length of created address
1025 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1028 unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
1029 void **buf, size_t *added)
1031 if ((NULL == addr) || (addrlen == 0))
1034 return GNUNET_SYSERR;
1037 char * tmp = GNUNET_malloc (addrlen + 1);
1038 memcpy (tmp, addr, addrlen);
1039 tmp[addrlen] = '\0';
1041 //GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "`%s'\n", tmp);
1044 (*added) = strlen (tmp);
1052 * Function called for a quick conversion of the binary address to
1053 * a numeric address. Note that the caller must not free the
1054 * address and that the next call to this function is allowed
1055 * to override the address again.
1057 * @param cls closure
1058 * @param addr binary address
1059 * @param addrlen length of the address
1060 * @return string representing the same address
1063 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1065 if ((addr != NULL) && (addrlen > 0))
1066 return (const char *) addr;
1072 * Notify transport service about address
1074 * @param cls the plugin
1078 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1080 struct Plugin *plugin = cls;
1082 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1083 plugin->unix_socket_path,
1084 strlen (plugin->unix_socket_path) + 1);
1088 * The exported method. Makes the core api available via a global and
1089 * returns the unix transport API.
1092 libgnunet_plugin_transport_unix_init (void *cls)
1094 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1095 unsigned long long port;
1096 struct GNUNET_TRANSPORT_PluginFunctions *api;
1097 struct Plugin *plugin;
1098 int sockets_created;
1100 if (NULL == env->receive)
1102 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1103 initialze the plugin or the API */
1104 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1106 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1107 api->address_to_string = &unix_address_to_string;
1108 api->string_to_address = &unix_string_to_address;
1111 GNUNET_assert( NULL != env->stats);
1114 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1116 port = UNIX_NAT_DEFAULT_PORT;
1117 plugin = GNUNET_malloc (sizeof (struct Plugin));
1118 plugin->port = port;
1120 GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1123 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1126 api->get_session = &unix_plugin_get_session;
1127 api->send = &unix_plugin_send;
1128 api->disconnect = &unix_disconnect;
1129 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1130 api->address_to_string = &unix_address_to_string;
1131 api->check_address = &unix_check_address;
1132 api->string_to_address = &unix_string_to_address;
1133 sockets_created = unix_transport_server_start (plugin);
1134 if (sockets_created == 0)
1135 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1137 plugin->session_map = GNUNET_CONTAINER_multihashmap_create(10);
1139 GNUNET_SCHEDULER_add_now (address_notification, plugin);
1144 libgnunet_plugin_transport_unix_done (void *cls)
1146 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1147 struct Plugin *plugin = api->cls;
1154 unix_transport_server_stop (plugin);
1156 GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map, &get_session_delete_it, plugin);
1157 GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1159 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1160 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1161 GNUNET_free (plugin->unix_socket_path);
1162 GNUNET_free (plugin);
1167 /* end of plugin_transport_unix.c */