2 This file is part of GNUnet.
3 Copyright (C) 2001-2016 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
23 * @brief code for access to services
24 * @author Christian Grothoff
26 * Generic TCP code for reliable, record-oriented TCP
27 * connections between clients and service providers.
30 #include "gnunet_protocols.h"
31 #include "gnunet_util_lib.h"
32 #include "gnunet_resolver_service.h"
33 #include "gnunet_socks.h"
36 #define LOG(kind,...) GNUNET_log_from (kind, "util-client",__VA_ARGS__)
39 * Timeout we use on TCP connect before trying another
40 * result from the DNS resolver. Actual value used
41 * is this value divided by the number of address families.
44 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
49 * Internal state for a client connected to a GNUnet service.
55 * During connect, we try multiple possible IP addresses
56 * to find out which one might work.
62 * This is a linked list.
64 struct AddressProbe *next;
67 * This is a doubly-linked list.
69 struct AddressProbe *prev;
72 * The address; do not free (allocated at the end of this struct).
74 const struct sockaddr *addr;
77 * Underlying OS's socket.
79 struct GNUNET_NETWORK_Handle *sock;
82 * Connection for which we are probing.
84 struct ClientState *cstate;
92 * Task waiting for the connection to finish connecting.
94 struct GNUNET_SCHEDULER_Task *task;
99 * Internal state for a client connected to a GNUnet service.
105 * The connection handle, NULL if not live
107 struct GNUNET_NETWORK_Handle *sock;
110 * Handle to a pending DNS lookup request, NULL if DNS is finished.
112 struct GNUNET_RESOLVER_RequestHandle *dns_active;
117 const struct GNUNET_CONFIGURATION_Handle *cfg;
120 * Linked list of sockets we are currently trying out
123 struct AddressProbe *ap_head;
126 * Linked list of sockets we are currently trying out
129 struct AddressProbe *ap_tail;
132 * Name of the service we interact with.
142 * Next message to transmit to the service. NULL for none.
144 const struct GNUNET_MessageHeader *msg;
147 * Task for trying to connect to the service.
149 struct GNUNET_SCHEDULER_Task *retry_task;
152 * Task for sending messages to the service.
154 struct GNUNET_SCHEDULER_Task *send_task;
157 * Task for sending messages to the service.
159 struct GNUNET_SCHEDULER_Task *recv_task;
162 * Tokenizer for inbound messages.
164 struct GNUNET_MessageStreamTokenizer *mst;
167 * Message queue under our control.
169 struct GNUNET_MQ_Handle *mq;
172 * Timeout for receiving a response (absolute time).
174 struct GNUNET_TIME_Absolute receive_timeout;
177 * Current value for our incremental back-off (for
180 struct GNUNET_TIME_Relative back_off;
183 * TCP port (0 for disabled).
185 unsigned long long port;
188 * Offset in the message where we are for transmission.
193 * How often have we tried to connect?
195 unsigned int attempts;
198 * Are we supposed to die? #GNUNET_SYSERR if destruction must be
199 * deferred, #GNUNET_NO by default, #GNUNET_YES if destruction was
208 * Try to connect to the service.
210 * @param cls the `struct ClientState` to try to connect to the service
213 start_connect (void *cls);
217 * We've failed for good to establish a connection (timeout or
218 * no more addresses to try).
220 * @param cstate the connection we tried to establish
223 connect_fail_continuation (struct ClientState *cstate)
225 GNUNET_break (NULL == cstate->ap_head);
226 GNUNET_break (NULL == cstate->ap_tail);
227 GNUNET_break (NULL == cstate->dns_active);
228 GNUNET_break (NULL == cstate->sock);
229 GNUNET_assert (NULL == cstate->send_task);
230 GNUNET_assert (NULL == cstate->recv_task);
231 // GNUNET_assert (NULL == cstate->proxy_handshake);
233 cstate->back_off = GNUNET_TIME_STD_BACKOFF (cstate->back_off);
234 LOG (GNUNET_ERROR_TYPE_DEBUG,
235 "Failed to establish connection to `%s', no further addresses to try, will try again in %s.\n",
236 cstate->service_name,
237 GNUNET_STRINGS_relative_time_to_string (cstate->back_off,
240 = GNUNET_SCHEDULER_add_delayed (cstate->back_off,
247 * We are ready to send a message to the service.
249 * @param cls the `struct ClientState` with the `msg` to transmit
252 transmit_ready (void *cls)
254 struct ClientState *cstate = cls;
258 int notify_in_flight;
260 cstate->send_task = NULL;
261 pos = (const char *) cstate->msg;
262 len = ntohs (cstate->msg->size);
263 GNUNET_assert (cstate->msg_off < len);
265 ret = GNUNET_NETWORK_socket_send (cstate->sock,
266 &pos[cstate->msg_off],
267 len - cstate->msg_off);
270 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
271 "client: error during sending message of type %u\n", ntohs(cstate->msg->type));
273 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
274 "client: retrying message of type %u\n", ntohs(cstate->msg->type));
277 GNUNET_MQ_inject_error (cstate->mq,
278 GNUNET_MQ_ERROR_WRITE);
281 notify_in_flight = (0 == cstate->msg_off);
282 cstate->msg_off += ret;
283 if (cstate->msg_off < len)
285 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
286 "client: rescheduling message of type %u\n", ntohs(cstate->msg->type));
288 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
292 if (notify_in_flight)
293 GNUNET_MQ_impl_send_in_flight (cstate->mq);
296 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
297 "client: sending message of type %u successful\n", ntohs(cstate->msg->type));
299 GNUNET_MQ_impl_send_continue (cstate->mq);
304 * We have received a full message, pass to the MQ dispatcher.
305 * Called by the tokenizer via #receive_ready().
307 * @param cls the `struct ClientState`
308 * @param msg message we received.
309 * @return #GNUNET_OK on success,
310 * #GNUNET_NO to stop further processing due to disconnect (no error)
311 * #GNUNET_SYSERR to stop further processing due to error
314 recv_message (void *cls,
315 const struct GNUNET_MessageHeader *msg)
317 struct ClientState *cstate = cls;
319 if (GNUNET_YES == cstate->in_destroy)
321 LOG (GNUNET_ERROR_TYPE_DEBUG,
322 "Received message of type %u and size %u from %s\n",
325 cstate->service_name);
326 GNUNET_MQ_inject_message (cstate->mq,
328 if (GNUNET_YES == cstate->in_destroy)
335 * Cancel all remaining connect attempts
337 * @param cstate handle of the client state to process
340 cancel_aps (struct ClientState *cstate)
342 struct AddressProbe *pos;
344 while (NULL != (pos = cstate->ap_head))
346 GNUNET_break (GNUNET_OK ==
347 GNUNET_NETWORK_socket_close (pos->sock));
348 GNUNET_SCHEDULER_cancel (pos->task);
349 GNUNET_CONTAINER_DLL_remove (cstate->ap_head,
358 * Implement the destruction of a message queue. Implementations must
359 * not free @a mq, but should take care of @a impl_state.
361 * @param mq the message queue to destroy
362 * @param impl_state our `struct ClientState`
365 connection_client_destroy_impl (struct GNUNET_MQ_Handle *mq,
368 struct ClientState *cstate = impl_state;
370 if (GNUNET_SYSERR == cstate->in_destroy)
372 /* defer destruction */
373 cstate->in_destroy = GNUNET_YES;
377 if (NULL != cstate->dns_active)
378 GNUNET_RESOLVER_request_cancel (cstate->dns_active);
379 if (NULL != cstate->send_task)
380 GNUNET_SCHEDULER_cancel (cstate->send_task);
381 if (NULL != cstate->recv_task)
382 GNUNET_SCHEDULER_cancel (cstate->recv_task);
383 if (NULL != cstate->retry_task)
384 GNUNET_SCHEDULER_cancel (cstate->retry_task);
385 if (NULL != cstate->sock)
386 GNUNET_NETWORK_socket_close (cstate->sock);
388 GNUNET_free (cstate->service_name);
389 GNUNET_free_non_null (cstate->hostname);
390 GNUNET_MST_destroy (cstate->mst);
391 GNUNET_free (cstate);
396 * This function is called once we have data ready to read.
398 * @param cls `struct ClientState` with connection to read from
401 receive_ready (void *cls)
403 struct ClientState *cstate = cls;
406 cstate->recv_task = NULL;
407 cstate->in_destroy = GNUNET_SYSERR;
408 ret = GNUNET_MST_read (cstate->mst,
412 if (GNUNET_SYSERR == ret)
414 if (NULL != cstate->mq)
415 GNUNET_MQ_inject_error (cstate->mq,
416 GNUNET_MQ_ERROR_READ);
417 if (GNUNET_YES == cstate->in_destroy)
418 connection_client_destroy_impl (cstate->mq,
422 if (GNUNET_YES == cstate->in_destroy)
424 connection_client_destroy_impl (cstate->mq,
428 cstate->in_destroy = GNUNET_NO;
430 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
438 * We've succeeded in establishing a connection.
440 * @param cstate the connection we tried to establish
443 connect_success_continuation (struct ClientState *cstate)
445 GNUNET_assert (NULL == cstate->recv_task);
447 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
451 if (NULL != cstate->msg)
453 GNUNET_assert (NULL == cstate->send_task);
455 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
464 * Try connecting to the server using UNIX domain sockets.
466 * @param service_name name of service to connect to
467 * @param cfg configuration to use
468 * @return NULL on error, socket connected to UNIX otherwise
470 static struct GNUNET_NETWORK_Handle *
471 try_unixpath (const char *service_name,
472 const struct GNUNET_CONFIGURATION_Handle *cfg)
475 struct GNUNET_NETWORK_Handle *sock;
477 struct sockaddr_un s_un;
481 GNUNET_CONFIGURATION_get_value_filename (cfg,
485 (0 < strlen (unixpath)))
487 /* We have a non-NULL unixpath, need to validate it */
488 if (strlen (unixpath) >= sizeof (s_un.sun_path))
490 LOG (GNUNET_ERROR_TYPE_WARNING,
491 _("UNIXPATH `%s' too long, maximum length is %llu\n"),
493 (unsigned long long) sizeof (s_un.sun_path));
494 unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
495 LOG (GNUNET_ERROR_TYPE_INFO,
496 _("Using `%s' instead\n"),
498 if (NULL == unixpath)
504 s_un.sun_family = AF_UNIX;
505 strncpy (s_un.sun_path,
507 sizeof (s_un.sun_path) - 1);
512 abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
514 "USE_ABSTRACT_SOCKETS");
515 if (GNUNET_YES == abstract)
516 s_un.sun_path[0] = '\0';
519 #if HAVE_SOCKADDR_UN_SUN_LEN
520 s_un.sun_len = (u_char) sizeof (struct sockaddr_un);
522 sock = GNUNET_NETWORK_socket_create (AF_UNIX,
525 if ( (NULL != sock) &&
527 GNUNET_NETWORK_socket_connect (sock,
528 (struct sockaddr *) &s_un,
530 (EINPROGRESS == errno) ) )
532 LOG (GNUNET_ERROR_TYPE_DEBUG,
533 "Successfully connected to unixpath `%s'!\n",
535 GNUNET_free (unixpath);
539 GNUNET_NETWORK_socket_close (sock);
541 GNUNET_free_non_null (unixpath);
548 * Scheduler let us know that we're either ready to write on the
549 * socket OR connect timed out. Do the right thing.
551 * @param cls the `struct AddressProbe *` with the address that we are probing
554 connect_probe_continuation (void *cls)
556 struct AddressProbe *ap = cls;
557 struct ClientState *cstate = ap->cstate;
558 const struct GNUNET_SCHEDULER_TaskContext *tc;
563 GNUNET_assert (NULL != ap->sock);
564 GNUNET_CONTAINER_DLL_remove (cstate->ap_head,
567 len = sizeof (error);
569 tc = GNUNET_SCHEDULER_get_task_context ();
570 if ( (0 == (tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) ||
572 GNUNET_NETWORK_socket_getsockopt (ap->sock,
579 GNUNET_break (GNUNET_OK ==
580 GNUNET_NETWORK_socket_close (ap->sock));
582 if ( (NULL == cstate->ap_head) &&
583 // (NULL == cstate->proxy_handshake) &&
584 (NULL == cstate->dns_active) )
585 connect_fail_continuation (cstate);
588 LOG (GNUNET_ERROR_TYPE_DEBUG,
589 "Connection to `%s' succeeded!\n",
590 cstate->service_name);
591 /* trigger jobs that waited for the connection */
592 GNUNET_assert (NULL == cstate->sock);
593 cstate->sock = ap->sock;
596 connect_success_continuation (cstate);
601 * Try to establish a connection given the specified address.
602 * This function is called by the resolver once we have a DNS reply.
604 * @param cls our `struct ClientState *`
605 * @param addr address to try, NULL for "last call"
606 * @param addrlen length of @a addr
609 try_connect_using_address (void *cls,
610 const struct sockaddr *addr,
613 struct ClientState *cstate = cls;
614 struct AddressProbe *ap;
618 cstate->dns_active = NULL;
619 if ( (NULL == cstate->ap_head) &&
620 // (NULL == cstate->proxy_handshake) &&
621 (NULL == cstate->sock) )
622 connect_fail_continuation (cstate);
625 if (NULL != cstate->sock)
626 return; /* already connected */
628 LOG (GNUNET_ERROR_TYPE_DEBUG,
629 "Trying to connect using address `%s:%u'\n",
633 ap = GNUNET_malloc (sizeof (struct AddressProbe) + addrlen);
634 ap->addr = (const struct sockaddr *) &ap[1];
635 GNUNET_memcpy (&ap[1],
638 ap->addrlen = addrlen;
641 switch (ap->addr->sa_family)
644 ((struct sockaddr_in *) ap->addr)->sin_port = htons (cstate->port);
647 ((struct sockaddr_in6 *) ap->addr)->sin6_port = htons (cstate->port);
652 return; /* not supported by us */
654 ap->sock = GNUNET_NETWORK_socket_create (ap->addr->sa_family,
657 if (NULL == ap->sock)
660 return; /* not supported by OS */
663 GNUNET_NETWORK_socket_connect (ap->sock,
666 (EINPROGRESS != errno) )
668 /* maybe refused / unsupported address, try next */
669 GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO,
671 GNUNET_break (GNUNET_OK ==
672 GNUNET_NETWORK_socket_close (ap->sock));
676 GNUNET_CONTAINER_DLL_insert (cstate->ap_head,
679 ap->task = GNUNET_SCHEDULER_add_write_net (CONNECT_RETRY_TIMEOUT,
681 &connect_probe_continuation,
687 * Test whether the configuration has proper values for connection
688 * (UNIXPATH || (PORT && HOSTNAME)).
690 * @param service_name name of service to connect to
691 * @param cfg configuration to use
692 * @return #GNUNET_OK if the configuration is valid, #GNUNET_SYSERR if not
695 test_service_configuration (const char *service_name,
696 const struct GNUNET_CONFIGURATION_Handle *cfg)
698 int ret = GNUNET_SYSERR;
699 char *hostname = NULL;
700 unsigned long long port;
702 char *unixpath = NULL;
705 GNUNET_CONFIGURATION_get_value_filename (cfg,
709 (0 < strlen (unixpath)))
711 GNUNET_free_non_null (unixpath);
715 GNUNET_CONFIGURATION_have_value (cfg,
719 GNUNET_CONFIGURATION_get_value_number (cfg,
726 GNUNET_CONFIGURATION_get_value_string (cfg,
730 (0 != strlen (hostname)) )
732 GNUNET_free_non_null (hostname);
738 * Try to connect to the service.
740 * @param cls the `struct ClientState` to try to connect to the service
743 start_connect (void *cls)
745 struct ClientState *cstate = cls;
747 cstate->retry_task = NULL;
749 /* Never use a local source if a proxy is configured */
751 GNUNET_SOCKS_check_service (cstate->service_name,
754 socks_connect (cstate);
759 if ( (0 == (cstate->attempts++ % 2)) ||
760 (0 == cstate->port) ||
761 (NULL == cstate->hostname) )
763 /* on even rounds, try UNIX first, or always
764 if we do not have a DNS name and TCP port. */
765 cstate->sock = try_unixpath (cstate->service_name,
767 if (NULL != cstate->sock)
769 connect_success_continuation (cstate);
773 if ( (NULL == cstate->hostname) ||
774 (0 == cstate->port) )
776 /* All options failed. Boo! */
777 connect_fail_continuation (cstate);
781 = GNUNET_RESOLVER_ip_get (cstate->hostname,
783 CONNECT_RETRY_TIMEOUT,
784 &try_connect_using_address,
790 * Implements the transmission functionality of a message queue.
792 * @param mq the message queue
793 * @param msg the message to send
794 * @param impl_state our `struct ClientState`
797 connection_client_send_impl (struct GNUNET_MQ_Handle *mq,
798 const struct GNUNET_MessageHeader *msg,
801 struct ClientState *cstate = impl_state;
803 /* only one message at a time allowed */
804 GNUNET_assert (NULL == cstate->msg);
805 GNUNET_assert (NULL == cstate->send_task);
808 if (NULL == cstate->sock){
809 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
810 "client: waiting for socket\n");
811 return; /* still waiting for connection */
814 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
822 * Cancel the currently sent message.
824 * @param mq message queue
825 * @param impl_state our `struct ClientState`
828 connection_client_cancel_impl (struct GNUNET_MQ_Handle *mq,
831 struct ClientState *cstate = impl_state;
833 GNUNET_assert (NULL != cstate->msg);
834 GNUNET_assert (0 == cstate->msg_off);
836 if (NULL != cstate->send_task)
838 GNUNET_SCHEDULER_cancel (cstate->send_task);
839 cstate->send_task = NULL;
845 * Create a message queue to connect to a GNUnet service.
846 * If handlers are specfied, receive messages from the connection.
848 * @param cfg our configuration
849 * @param service_name name of the service to connect to
850 * @param handlers handlers for receiving messages, can be NULL
851 * @param error_handler error handler
852 * @param error_handler_cls closure for the @a error_handler
853 * @return the message queue, NULL on error
855 struct GNUNET_MQ_Handle *
856 GNUNET_CLIENT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
857 const char *service_name,
858 const struct GNUNET_MQ_MessageHandler *handlers,
859 GNUNET_MQ_ErrorHandler error_handler,
860 void *error_handler_cls)
862 struct ClientState *cstate;
865 test_service_configuration (service_name,
868 cstate = GNUNET_new (struct ClientState);
869 cstate->service_name = GNUNET_strdup (service_name);
871 cstate->retry_task = GNUNET_SCHEDULER_add_now (&start_connect,
873 cstate->mst = GNUNET_MST_create (&recv_message,
876 GNUNET_CONFIGURATION_have_value (cfg,
880 if (! ( (GNUNET_OK !=
881 GNUNET_CONFIGURATION_get_value_number (cfg,
885 (cstate->port > 65535) ||
887 GNUNET_CONFIGURATION_get_value_string (cfg,
890 &cstate->hostname)) ) &&
891 (0 == strlen (cstate->hostname)) )
893 GNUNET_free (cstate->hostname);
894 cstate->hostname = NULL;
895 LOG (GNUNET_ERROR_TYPE_WARNING,
896 _("Need a non-empty hostname for service `%s'.\n"),
900 cstate->mq = GNUNET_MQ_queue_for_callbacks (&connection_client_send_impl,
901 &connection_client_destroy_impl,
902 &connection_client_cancel_impl,
910 /* end of client.c */