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;
249 get_session_delete_it (void *cls, const GNUNET_HashCode * key, void *value)
251 struct Session *s = value;
252 struct Plugin *plugin = cls;
253 GNUNET_assert (plugin != NULL);
256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Deleting session for peer `%s' `%s' \n", GNUNET_i2s (&s->target), s->addr);
259 plugin->env->session_end (plugin->env->cls, &s->target, s);
261 GNUNET_assert (GNUNET_YES ==
262 GNUNET_CONTAINER_multihashmap_remove(plugin->session_map, &s->target.hashPubKey, s));
270 * Disconnect from a remote node. Clean up session if we have one for this peer
272 * @param cls closure for this call (should be handle to Plugin)
273 * @param target the peeridentity of the peer to disconnect
274 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
277 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
279 struct Plugin *plugin = cls;
280 GNUNET_assert (plugin != NULL);
282 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &target->hashPubKey, &get_session_delete_it, plugin);
287 * Shutdown the server process (stop receiving inbound traffic). Maybe
290 * @param cls Handle to the plugin for this transport
292 * @return returns the number of sockets successfully closed,
293 * should equal the number of sockets successfully opened
296 unix_transport_server_stop (void *cls)
298 struct Plugin *plugin = cls;
300 struct UNIXMessageWrapper * msgw = plugin->msg_head;
302 while (NULL != (msgw = plugin->msg_head))
304 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
305 if (msgw->cont != NULL)
306 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR);
307 GNUNET_free (msgw->msg);
311 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
313 GNUNET_SCHEDULER_cancel (plugin->select_task);
314 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
317 GNUNET_break (GNUNET_OK ==
318 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
319 plugin->unix_sock.desc = NULL;
320 plugin->with_ws = GNUNET_NO;
326 find_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *peer)
328 struct PeerSession *pos;
330 pos = plugin->sessions;
333 if (memcmp (&pos->target, peer, sizeof (struct GNUNET_PeerIdentity)) == 0)
343 * Actually send out the message, assume we've got the address and
344 * send_handle squared away!
347 * @param send_handle which handle to send message on
348 * @param target who should receive this message (ignored by UNIX)
349 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
350 * @param msgbuf_size the size of the msgbuf to send
351 * @param priority how important is the message (ignored by UNIX)
352 * @param timeout when should we time out (give up) if we can not transmit?
353 * @param addr the addr to send the message to, needs to be a sockaddr for us
354 * @param addrlen the len of addr
355 * @param cont continuation to call once the message has
356 * been transmitted (or if the transport is ready
357 * for the next transmission call; or if the
358 * peer disconnected...)
359 * @param cont_cls closure for cont
361 * @return the number of bytes written, -1 on errors
364 unix_real_send (void *cls,
365 struct GNUNET_NETWORK_Handle *send_handle,
366 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
367 size_t msgbuf_size, unsigned int priority,
368 struct GNUNET_TIME_Relative timeout, const void *addr,
369 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
376 struct sockaddr_un un;
380 if (send_handle == NULL)
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
384 "unix_real_send with send_handle NULL!\n");
386 /* failed to open send socket for AF */
388 cont (cont_cls, target, GNUNET_SYSERR);
391 if ((addr == NULL) || (addrlen == 0))
394 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
395 "unix_real_send called without address, returning!\n");
398 cont (cont_cls, target, GNUNET_SYSERR);
399 return 0; /* Can never send if we don't have an address!! */
402 memset (&un, 0, sizeof (un));
403 un.sun_family = AF_UNIX;
404 slen = strlen (addr) + 1;
405 if (slen >= sizeof (un.sun_path))
406 slen = sizeof (un.sun_path) - 1;
408 GNUNET_assert (slen < sizeof (un.sun_path));
409 memcpy (un.sun_path, addr, slen);
410 un.sun_path[slen] = '\0';
411 slen = sizeof (struct sockaddr_un);
413 un.sun_path[0] = '\0';
415 #if HAVE_SOCKADDR_IN_SIN_LEN
416 un.sun_len = (u_char) slen;
418 sb = (struct sockaddr *) &un;
421 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
423 if ((GNUNET_SYSERR == sent) && ((errno == EAGAIN) || (errno == ENOBUFS)))
426 if ((GNUNET_SYSERR == sent) && (errno == EMSGSIZE))
429 socklen_t len = sizeof (size);
431 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
432 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
435 if (size < msgbuf_size)
437 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
438 "Trying to increase socket buffer size from %i to %i for message size %i\n",
439 size, ((msgbuf_size / 1000) + 2) * 1000, msgbuf_size);
440 size = ((msgbuf_size / 1000) + 2) * 1000;
441 if (GNUNET_NETWORK_socket_setsockopt
442 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
443 &size, sizeof (size)) == GNUNET_OK)
446 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
451 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
452 "UNIX transmit %u-byte message to %s (%d: %s)\n",
453 (unsigned int) msgbuf_size, GNUNET_a2s (sb, sbs), (int) sent,
454 (sent < 0) ? STRERROR (errno) : "ok");
456 /* Calling continuation */
459 if ((sent == GNUNET_SYSERR) && (retry == GNUNET_NO))
460 cont (cont_cls, target, GNUNET_SYSERR);
462 cont (cont_cls, target, GNUNET_OK);
465 /* return number of bytes successfully sent */
468 /* failed and retry: return 0 */
469 if ((GNUNET_SYSERR == sent) && (retry == GNUNET_YES))
471 /* failed and no retry: return -1 */
472 if ((GNUNET_SYSERR == sent) && (retry == GNUNET_NO))
486 get_session_it (void *cls, const GNUNET_HashCode * key, void *value)
488 struct gsi_ctx *gsi = cls;
489 struct Session *s = value;
492 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Comparing session %s %s\n", gsi->address, s->addr);
494 if ((gsi->addrlen == s->addrlen) &&
495 (0 == memcmp (gsi->address, s->addr, s->addrlen)))
504 * Creates a new outbound session the transport service will use to send data to the
507 * @param cls the plugin
508 * @param address the address
509 * @return the session or NULL of max connections exceeded
511 static struct Session *
512 unix_plugin_get_session (void *cls,
513 const struct GNUNET_HELLO_Address *address)
515 struct Session * s = NULL;
516 struct Plugin *plugin = cls;
520 GNUNET_assert (plugin != NULL);
521 GNUNET_assert (address != NULL);
523 /* Check if already existing */
524 gsi.address = (char *) address->address;
525 gsi.addrlen = address->address_length;
527 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &address->peer.hashPubKey, &get_session_it, &gsi);
531 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Found existing session\n");
536 /* Create a new session */
538 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
540 s->addrlen = address->address_length;
541 memcpy(s->addr, address->address, s->addrlen);
542 memcpy(&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
544 GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
545 &address->peer.hashPubKey, s,
546 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
548 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating new session\n");
555 * @param cls the plugin handle
556 * @param tc the scheduling context (for rescheduling this function again)
558 * We have been notified that our writeset has something to read. We don't
559 * know which socket needs to be read, so we have to check each one
560 * Then reschedule this function to be called again once more is available.
564 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
567 * Function that can be used by the transport service to transmit
568 * a message using the plugin. Note that in the case of a
569 * peer disconnecting, the continuation MUST be called
570 * prior to the disconnect notification itself. This function
571 * will be called with this peer's HELLO message to initiate
572 * a fresh connection to another peer.
575 * @param session which session must be used
576 * @param msgbuf the message to transmit
577 * @param msgbuf_size number of bytes in 'msgbuf'
578 * @param priority how important is the message (most plugins will
579 * ignore message priority and just FIFO)
580 * @param to how long to wait at most for the transmission (does not
581 * require plugins to discard the message after the timeout,
582 * just advisory for the desired delay; most plugins will ignore
584 * @param cont continuation to call once the message has
585 * been transmitted (or if the transport is ready
586 * for the next transmission call; or if the
587 * peer disconnected...); can be NULL
588 * @param cont_cls closure for cont
589 * @return number of bytes used (on the physical network, with overheads);
590 * -1 on hard errors (i.e. address invalid); 0 is a legal value
591 * and does NOT mean that the message was not transmitted (DV)
594 unix_plugin_send (void *cls,
595 struct Session *session,
596 const char *msgbuf, size_t msgbuf_size,
597 unsigned int priority,
598 struct GNUNET_TIME_Relative to,
599 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
601 struct Plugin *plugin = cls;
602 struct UNIXMessageWrapper *wrapper;
603 struct UNIXMessage *message;
606 GNUNET_assert (plugin != NULL);
607 GNUNET_assert (session != NULL);
609 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_contains_value(plugin->session_map,
610 &session->target.hashPubKey, session))
613 return GNUNET_SYSERR;
616 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
617 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
618 message->header.size = htons (ssize);
619 message->header.type = htons (0);
620 memcpy (&message->sender, plugin->env->my_identity,
621 sizeof (struct GNUNET_PeerIdentity));
622 memcpy (&message[1], msgbuf, msgbuf_size);
624 wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
625 wrapper->msg = message;
626 wrapper->msgsize = ssize;
627 wrapper->priority = priority;
628 wrapper->timeout = to;
629 wrapper->cont = cont;
630 wrapper->cont_cls = cont_cls;
631 wrapper->session = session;
633 GNUNET_CONTAINER_DLL_insert(plugin->msg_head, plugin->msg_tail, wrapper);
636 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", ssize,
637 (char *) session->addr);
640 if (plugin->with_ws == GNUNET_NO)
642 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
643 GNUNET_SCHEDULER_cancel(plugin->select_task);
645 plugin->select_task =
646 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
647 GNUNET_TIME_UNIT_FOREVER_REL,
650 &unix_plugin_select, plugin);
651 plugin->with_ws = GNUNET_YES;
658 * Demultiplexer for UNIX messages
660 * @param plugin the main plugin for this transport
661 * @param sender from which peer the message was received
662 * @param currhdr pointer to the header of the message
663 * @param un the address from which the message was received
664 * @param fromlen the length of the address
667 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
668 const struct GNUNET_MessageHeader *currhdr,
669 const struct sockaddr_un *un, size_t fromlen)
671 struct GNUNET_ATS_Information ats[2];
673 ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
674 ats[0].value = htonl (UNIX_DIRECT_DISTANCE);
675 ats[1] = plugin->ats_network;
676 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
678 GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
681 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
684 plugin->env->receive (plugin->env->cls, sender, currhdr,
685 (const struct GNUNET_ATS_Information *) &ats, 2,
686 NULL, un->sun_path, strlen (un->sun_path) + 1);
691 unix_plugin_select_read (struct Plugin * plugin)
694 struct UNIXMessage *msg;
695 struct GNUNET_PeerIdentity sender;
696 struct sockaddr_un un;
702 const struct GNUNET_MessageHeader *currhdr;
705 addrlen = sizeof (un);
706 memset (&un, 0, sizeof (un));
709 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
710 (struct sockaddr *) &un, &addrlen);
712 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
715 if (ret == GNUNET_SYSERR)
717 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
723 un.sun_path[0] = '/';
726 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
731 GNUNET_assert (AF_UNIX == (un.sun_family));
733 msg = (struct UNIXMessage *) buf;
734 csize = ntohs (msg->header.size);
735 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
740 msgbuf = (char *) &msg[1];
741 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
743 tsize = csize - sizeof (struct UNIXMessage);
744 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
746 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
747 csize = ntohs (currhdr->size);
748 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
749 (csize > tsize - offset))
754 unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
760 unix_plugin_select_write (struct Plugin * plugin)
763 struct UNIXMessageWrapper * msgw = plugin->msg_head;
765 sent = unix_real_send (plugin,
766 plugin->unix_sock.desc,
767 &msgw->session->target,
768 (const char *) msgw->msg,
773 msgw->session->addrlen,
774 msgw->cont, msgw->cont_cls);
776 /* successfully sent bytes */
779 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
780 GNUNET_free (msgw->msg);
785 /* failed and no retry */
788 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
789 GNUNET_free (msgw->msg);
794 /* failed and retry */
800 * @param cls the plugin handle
801 * @param tc the scheduling context (for rescheduling this function again)
803 * We have been notified that our writeset has something to read. We don't
804 * know which socket needs to be read, so we have to check each one
805 * Then reschedule this function to be called again once more is available.
809 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
811 struct Plugin *plugin = cls;
813 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
814 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
817 plugin->with_ws = GNUNET_NO;
818 if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
820 GNUNET_assert (GNUNET_NETWORK_fdset_isset
821 (tc->write_ready, plugin->unix_sock.desc));
822 if (plugin->msg_head != NULL)
823 unix_plugin_select_write (plugin);
826 if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
828 GNUNET_assert (GNUNET_NETWORK_fdset_isset
829 (tc->read_ready, plugin->unix_sock.desc));
830 unix_plugin_select_read (plugin);
833 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
834 GNUNET_SCHEDULER_cancel (plugin->select_task);
835 plugin->select_task =
836 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
837 GNUNET_TIME_UNIT_FOREVER_REL,
839 (plugin->msg_head != NULL) ? plugin->ws : NULL,
840 &unix_plugin_select, plugin);
841 if (plugin->msg_head != NULL)
842 plugin->with_ws = GNUNET_YES;
846 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
848 * @param cls closure for server start, should be a struct Plugin *
849 * @return number of sockets created or GNUNET_SYSERR on error
852 unix_transport_server_start (void *cls)
854 struct Plugin *plugin = cls;
855 struct sockaddr *serverAddr;
857 struct sockaddr_un un;
860 memset (&un, 0, sizeof (un));
861 un.sun_family = AF_UNIX;
862 slen = strlen (plugin->unix_socket_path) + 1;
863 if (slen >= sizeof (un.sun_path))
864 slen = sizeof (un.sun_path) - 1;
866 memcpy (un.sun_path, plugin->unix_socket_path, slen);
867 un.sun_path[slen] = '\0';
868 slen = sizeof (struct sockaddr_un);
869 #if HAVE_SOCKADDR_IN_SIN_LEN
870 un.sun_len = (u_char) slen;
873 serverAddr = (struct sockaddr *) &un;
876 un.sun_path[0] = '\0';
878 plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, serverAddr, addrlen);
879 plugin->unix_sock.desc =
880 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
881 if (NULL == plugin->unix_sock.desc)
883 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
884 return GNUNET_SYSERR;
886 if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
889 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
890 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
891 plugin->unix_sock.desc = NULL;
892 return GNUNET_SYSERR;
895 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "unix", "Bound to `%s'\n",
898 plugin->rs = GNUNET_NETWORK_fdset_create ();
899 plugin->ws = GNUNET_NETWORK_fdset_create ();
900 GNUNET_NETWORK_fdset_zero (plugin->rs);
901 GNUNET_NETWORK_fdset_zero (plugin->ws);
902 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
903 GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
905 plugin->select_task =
906 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
907 GNUNET_TIME_UNIT_FOREVER_REL,
910 &unix_plugin_select, plugin);
911 plugin->with_ws = GNUNET_NO;
918 * Function that will be called to check if a binary address for this
919 * plugin is well-formed and corresponds to an address for THIS peer
920 * (as per our configuration). Naturally, if absolutely necessary,
921 * plugins can be a bit conservative in their answer, but in general
922 * plugins should make sure that the address does not redirect
923 * traffic to a 3rd party that might try to man-in-the-middle our
926 * @param cls closure, should be our handle to the Plugin
927 * @param addr pointer to the address
928 * @param addrlen length of addr
929 * @return GNUNET_OK if this is a plausible address for this peer
930 * and transport, GNUNET_SYSERR if not
934 unix_check_address (void *cls, const void *addr, size_t addrlen)
938 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
939 "Informing transport service about my address `%s'\n",
947 * Convert the transports address to a nice, human-readable
951 * @param type name of the transport that generated the address
952 * @param addr one of the addresses of the host, NULL for the last address
953 * the specific address format depends on the transport
954 * @param addrlen length of the address
955 * @param numeric should (IP) addresses be displayed in numeric form?
956 * @param timeout after how long should we give up?
957 * @param asc function to call on each string
958 * @param asc_cls closure for asc
961 unix_plugin_address_pretty_printer (void *cls, const char *type,
962 const void *addr, size_t addrlen,
964 struct GNUNET_TIME_Relative timeout,
965 GNUNET_TRANSPORT_AddressStringCallback asc,
968 if ((addr != NULL) && (addrlen > 0))
969 asc (asc_cls, (const char *) addr);
973 asc (asc_cls, "Invalid UNIX address");
979 * Function called to convert a string address to
982 * @param cls closure ('struct Plugin*')
983 * @param addr string address
984 * @param addrlen length of the address
985 * @param buf location to store the buffer
986 * If the function returns GNUNET_SYSERR, its contents are undefined.
987 * @param added length of created address
988 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
991 unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
992 void **buf, size_t *added)
994 if ((NULL == addr) || (addrlen == 0))
997 return GNUNET_SYSERR;
1000 if ((strlen (addr) + 1) != addrlen)
1003 return GNUNET_SYSERR;
1006 (*buf) = strdup (addr);
1007 (*added) = strlen (addr) + 1;
1015 * Function called for a quick conversion of the binary address to
1016 * a numeric address. Note that the caller must not free the
1017 * address and that the next call to this function is allowed
1018 * to override the address again.
1020 * @param cls closure
1021 * @param addr binary address
1022 * @param addrlen length of the address
1023 * @return string representing the same address
1026 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1028 if ((addr != NULL) && (addrlen > 0))
1029 return (const char *) addr;
1035 * Notify transport service about address
1037 * @param cls the plugin
1041 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1043 struct Plugin *plugin = cls;
1045 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1046 plugin->unix_socket_path,
1047 strlen (plugin->unix_socket_path) + 1);
1051 * The exported method. Makes the core api available via a global and
1052 * returns the unix transport API.
1055 libgnunet_plugin_transport_unix_init (void *cls)
1057 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1058 unsigned long long port;
1059 struct GNUNET_TRANSPORT_PluginFunctions *api;
1060 struct Plugin *plugin;
1061 int sockets_created;
1063 if (NULL == env->receive)
1065 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1066 initialze the plugin or the API */
1067 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1069 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1070 api->address_to_string = &unix_address_to_string;
1071 api->string_to_address = NULL; // FIXME!
1076 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1078 port = UNIX_NAT_DEFAULT_PORT;
1079 plugin = GNUNET_malloc (sizeof (struct Plugin));
1080 plugin->port = port;
1082 GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1085 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1088 api->get_session = &unix_plugin_get_session;
1089 api->send = &unix_plugin_send;
1090 api->disconnect = &unix_disconnect;
1091 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1092 api->address_to_string = &unix_address_to_string;
1093 api->check_address = &unix_check_address;
1094 api->string_to_address = &unix_string_to_address;
1095 sockets_created = unix_transport_server_start (plugin);
1096 if (sockets_created == 0)
1097 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1099 plugin->session_map = GNUNET_CONTAINER_multihashmap_create(10);
1101 GNUNET_SCHEDULER_add_now (address_notification, plugin);
1106 libgnunet_plugin_transport_unix_done (void *cls)
1108 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1109 struct Plugin *plugin = api->cls;
1116 unix_transport_server_stop (plugin);
1118 GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map, &get_session_delete_it, plugin);
1119 GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1121 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1122 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1123 GNUNET_free (plugin->unix_socket_path);
1124 GNUNET_free (plugin);
1129 /* end of plugin_transport_unix.c */