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);
264 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
265 "client: message of type %u trying to send with socket %p (MQ: %p\n",
266 ntohs(cstate->msg->type),
271 ret = GNUNET_NETWORK_socket_send (cstate->sock,
272 &pos[cstate->msg_off],
273 len - cstate->msg_off);
276 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
277 "client: error during sending message of type %u\n",
278 ntohs(cstate->msg->type));
280 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
281 "client: retrying message of type %u\n",
282 ntohs(cstate->msg->type));
285 GNUNET_MQ_inject_error (cstate->mq,
286 GNUNET_MQ_ERROR_WRITE);
289 notify_in_flight = (0 == cstate->msg_off);
290 cstate->msg_off += ret;
291 if (cstate->msg_off < len)
293 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
294 "client: rescheduling message of type %u\n",
295 ntohs(cstate->msg->type));
297 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
301 if (notify_in_flight)
302 GNUNET_MQ_impl_send_in_flight (cstate->mq);
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
306 "client: sending message of type %u successful\n",
307 ntohs(cstate->msg->type));
309 GNUNET_MQ_impl_send_continue (cstate->mq);
314 * We have received a full message, pass to the MQ dispatcher.
315 * Called by the tokenizer via #receive_ready().
317 * @param cls the `struct ClientState`
318 * @param msg message we received.
319 * @return #GNUNET_OK on success,
320 * #GNUNET_NO to stop further processing due to disconnect (no error)
321 * #GNUNET_SYSERR to stop further processing due to error
324 recv_message (void *cls,
325 const struct GNUNET_MessageHeader *msg)
327 struct ClientState *cstate = cls;
329 if (GNUNET_YES == cstate->in_destroy)
331 LOG (GNUNET_ERROR_TYPE_DEBUG,
332 "Received message of type %u and size %u from %s\n",
335 cstate->service_name);
336 GNUNET_MQ_inject_message (cstate->mq,
338 if (GNUNET_YES == cstate->in_destroy)
345 * Cancel all remaining connect attempts
347 * @param cstate handle of the client state to process
350 cancel_aps (struct ClientState *cstate)
352 struct AddressProbe *pos;
354 while (NULL != (pos = cstate->ap_head))
356 GNUNET_break (GNUNET_OK ==
357 GNUNET_NETWORK_socket_close (pos->sock));
358 GNUNET_SCHEDULER_cancel (pos->task);
359 GNUNET_CONTAINER_DLL_remove (cstate->ap_head,
368 * Implement the destruction of a message queue. Implementations must
369 * not free @a mq, but should take care of @a impl_state.
371 * @param mq the message queue to destroy
372 * @param impl_state our `struct ClientState`
375 connection_client_destroy_impl (struct GNUNET_MQ_Handle *mq,
378 struct ClientState *cstate = impl_state;
380 if (GNUNET_SYSERR == cstate->in_destroy)
382 /* defer destruction */
383 cstate->in_destroy = GNUNET_YES;
387 if (NULL != cstate->dns_active)
388 GNUNET_RESOLVER_request_cancel (cstate->dns_active);
389 if (NULL != cstate->send_task)
390 GNUNET_SCHEDULER_cancel (cstate->send_task);
391 if (NULL != cstate->recv_task)
392 GNUNET_SCHEDULER_cancel (cstate->recv_task);
393 if (NULL != cstate->retry_task)
394 GNUNET_SCHEDULER_cancel (cstate->retry_task);
395 if (NULL != cstate->sock){
396 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
397 "client: destroying socket: %p\n",
399 GNUNET_NETWORK_socket_close (cstate->sock);
402 GNUNET_free (cstate->service_name);
403 GNUNET_free_non_null (cstate->hostname);
404 GNUNET_MST_destroy (cstate->mst);
405 GNUNET_free (cstate);
410 * This function is called once we have data ready to read.
412 * @param cls `struct ClientState` with connection to read from
415 receive_ready (void *cls)
417 struct ClientState *cstate = cls;
420 cstate->recv_task = NULL;
421 cstate->in_destroy = GNUNET_SYSERR;
422 ret = GNUNET_MST_read (cstate->mst,
426 if (GNUNET_SYSERR == ret)
428 if (NULL != cstate->mq)
429 GNUNET_MQ_inject_error (cstate->mq,
430 GNUNET_MQ_ERROR_READ);
431 if (GNUNET_YES == cstate->in_destroy)
432 connection_client_destroy_impl (cstate->mq,
436 if (GNUNET_YES == cstate->in_destroy)
438 connection_client_destroy_impl (cstate->mq,
442 cstate->in_destroy = GNUNET_NO;
444 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
452 * We've succeeded in establishing a connection.
454 * @param cstate the connection we tried to establish
457 connect_success_continuation (struct ClientState *cstate)
459 GNUNET_assert (NULL == cstate->recv_task);
461 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
465 if (NULL != cstate->msg)
467 GNUNET_assert (NULL == cstate->send_task);
469 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
478 * Try connecting to the server using UNIX domain sockets.
480 * @param service_name name of service to connect to
481 * @param cfg configuration to use
482 * @return NULL on error, socket connected to UNIX otherwise
484 static struct GNUNET_NETWORK_Handle *
485 try_unixpath (const char *service_name,
486 const struct GNUNET_CONFIGURATION_Handle *cfg)
489 struct GNUNET_NETWORK_Handle *sock;
491 struct sockaddr_un s_un;
495 GNUNET_CONFIGURATION_get_value_filename (cfg,
499 (0 < strlen (unixpath)))
501 /* We have a non-NULL unixpath, need to validate it */
502 if (strlen (unixpath) >= sizeof (s_un.sun_path))
504 LOG (GNUNET_ERROR_TYPE_WARNING,
505 _("UNIXPATH `%s' too long, maximum length is %llu\n"),
507 (unsigned long long) sizeof (s_un.sun_path));
508 unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
509 LOG (GNUNET_ERROR_TYPE_INFO,
510 _("Using `%s' instead\n"),
512 if (NULL == unixpath)
518 s_un.sun_family = AF_UNIX;
519 strncpy (s_un.sun_path,
521 sizeof (s_un.sun_path) - 1);
526 abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
528 "USE_ABSTRACT_SOCKETS");
529 if (GNUNET_YES == abstract)
530 s_un.sun_path[0] = '\0';
533 #if HAVE_SOCKADDR_UN_SUN_LEN
534 s_un.sun_len = (u_char) sizeof (struct sockaddr_un);
536 sock = GNUNET_NETWORK_socket_create (AF_UNIX,
539 if ( (NULL != sock) &&
541 GNUNET_NETWORK_socket_connect (sock,
542 (struct sockaddr *) &s_un,
544 (EINPROGRESS == errno) ) )
546 LOG (GNUNET_ERROR_TYPE_DEBUG,
547 "Successfully connected to unixpath `%s'!\n",
549 GNUNET_free (unixpath);
553 GNUNET_NETWORK_socket_close (sock);
555 GNUNET_free_non_null (unixpath);
562 * Scheduler let us know that we're either ready to write on the
563 * socket OR connect timed out. Do the right thing.
565 * @param cls the `struct AddressProbe *` with the address that we are probing
568 connect_probe_continuation (void *cls)
570 struct AddressProbe *ap = cls;
571 struct ClientState *cstate = ap->cstate;
572 const struct GNUNET_SCHEDULER_TaskContext *tc;
577 GNUNET_assert (NULL != ap->sock);
578 GNUNET_CONTAINER_DLL_remove (cstate->ap_head,
581 len = sizeof (error);
583 tc = GNUNET_SCHEDULER_get_task_context ();
584 if ( (0 == (tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) ||
586 GNUNET_NETWORK_socket_getsockopt (ap->sock,
593 GNUNET_break (GNUNET_OK ==
594 GNUNET_NETWORK_socket_close (ap->sock));
596 if ( (NULL == cstate->ap_head) &&
597 // (NULL == cstate->proxy_handshake) &&
598 (NULL == cstate->dns_active) )
599 connect_fail_continuation (cstate);
602 LOG (GNUNET_ERROR_TYPE_DEBUG,
603 "Connection to `%s' succeeded!\n",
604 cstate->service_name);
605 /* trigger jobs that waited for the connection */
606 GNUNET_assert (NULL == cstate->sock);
607 cstate->sock = ap->sock;
610 connect_success_continuation (cstate);
615 * Try to establish a connection given the specified address.
616 * This function is called by the resolver once we have a DNS reply.
618 * @param cls our `struct ClientState *`
619 * @param addr address to try, NULL for "last call"
620 * @param addrlen length of @a addr
623 try_connect_using_address (void *cls,
624 const struct sockaddr *addr,
627 struct ClientState *cstate = cls;
628 struct AddressProbe *ap;
632 cstate->dns_active = NULL;
633 if ( (NULL == cstate->ap_head) &&
634 // (NULL == cstate->proxy_handshake) &&
635 (NULL == cstate->sock) )
636 connect_fail_continuation (cstate);
639 if (NULL != cstate->sock)
640 return; /* already connected */
642 LOG (GNUNET_ERROR_TYPE_DEBUG,
643 "Trying to connect using address `%s:%u'\n",
647 ap = GNUNET_malloc (sizeof (struct AddressProbe) + addrlen);
648 ap->addr = (const struct sockaddr *) &ap[1];
649 GNUNET_memcpy (&ap[1],
652 ap->addrlen = addrlen;
655 switch (ap->addr->sa_family)
658 ((struct sockaddr_in *) ap->addr)->sin_port = htons (cstate->port);
661 ((struct sockaddr_in6 *) ap->addr)->sin6_port = htons (cstate->port);
666 return; /* not supported by us */
668 ap->sock = GNUNET_NETWORK_socket_create (ap->addr->sa_family,
671 if (NULL == ap->sock)
674 return; /* not supported by OS */
677 GNUNET_NETWORK_socket_connect (ap->sock,
680 (EINPROGRESS != errno) )
682 /* maybe refused / unsupported address, try next */
683 GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO,
685 GNUNET_break (GNUNET_OK ==
686 GNUNET_NETWORK_socket_close (ap->sock));
690 GNUNET_CONTAINER_DLL_insert (cstate->ap_head,
693 ap->task = GNUNET_SCHEDULER_add_write_net (CONNECT_RETRY_TIMEOUT,
695 &connect_probe_continuation,
701 * Test whether the configuration has proper values for connection
702 * (UNIXPATH || (PORT && HOSTNAME)).
704 * @param service_name name of service to connect to
705 * @param cfg configuration to use
706 * @return #GNUNET_OK if the configuration is valid, #GNUNET_SYSERR if not
709 test_service_configuration (const char *service_name,
710 const struct GNUNET_CONFIGURATION_Handle *cfg)
712 int ret = GNUNET_SYSERR;
713 char *hostname = NULL;
714 unsigned long long port;
716 char *unixpath = NULL;
719 GNUNET_CONFIGURATION_get_value_filename (cfg,
723 (0 < strlen (unixpath)))
725 GNUNET_free_non_null (unixpath);
729 GNUNET_CONFIGURATION_have_value (cfg,
733 GNUNET_CONFIGURATION_get_value_number (cfg,
740 GNUNET_CONFIGURATION_get_value_string (cfg,
744 (0 != strlen (hostname)) )
746 GNUNET_free_non_null (hostname);
752 * Try to connect to the service.
754 * @param cls the `struct ClientState` to try to connect to the service
757 start_connect (void *cls)
759 struct ClientState *cstate = cls;
761 cstate->retry_task = NULL;
763 /* Never use a local source if a proxy is configured */
765 GNUNET_SOCKS_check_service (cstate->service_name,
768 socks_connect (cstate);
773 if ( (0 == (cstate->attempts++ % 2)) ||
774 (0 == cstate->port) ||
775 (NULL == cstate->hostname) )
777 /* on even rounds, try UNIX first, or always
778 if we do not have a DNS name and TCP port. */
779 cstate->sock = try_unixpath (cstate->service_name,
781 if (NULL != cstate->sock)
783 connect_success_continuation (cstate);
787 if ( (NULL == cstate->hostname) ||
788 (0 == cstate->port) )
790 /* All options failed. Boo! */
791 connect_fail_continuation (cstate);
795 = GNUNET_RESOLVER_ip_get (cstate->hostname,
797 CONNECT_RETRY_TIMEOUT,
798 &try_connect_using_address,
804 * Implements the transmission functionality of a message queue.
806 * @param mq the message queue
807 * @param msg the message to send
808 * @param impl_state our `struct ClientState`
811 connection_client_send_impl (struct GNUNET_MQ_Handle *mq,
812 const struct GNUNET_MessageHeader *msg,
815 struct ClientState *cstate = impl_state;
817 /* only one message at a time allowed */
818 GNUNET_assert (NULL == cstate->msg);
819 GNUNET_assert (NULL == cstate->send_task);
822 if (NULL == cstate->sock){
823 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
824 "client: message of type %u waiting for socket\n",
826 return; /* still waiting for connection */
829 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
837 * Cancel the currently sent message.
839 * @param mq message queue
840 * @param impl_state our `struct ClientState`
843 connection_client_cancel_impl (struct GNUNET_MQ_Handle *mq,
846 struct ClientState *cstate = impl_state;
848 GNUNET_assert (NULL != cstate->msg);
849 GNUNET_assert (0 == cstate->msg_off);
851 if (NULL != cstate->send_task)
853 GNUNET_SCHEDULER_cancel (cstate->send_task);
854 cstate->send_task = NULL;
860 * Create a message queue to connect to a GNUnet service.
861 * If handlers are specfied, receive messages from the connection.
863 * @param cfg our configuration
864 * @param service_name name of the service to connect to
865 * @param handlers handlers for receiving messages, can be NULL
866 * @param error_handler error handler
867 * @param error_handler_cls closure for the @a error_handler
868 * @return the message queue, NULL on error
870 struct GNUNET_MQ_Handle *
871 GNUNET_CLIENT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
872 const char *service_name,
873 const struct GNUNET_MQ_MessageHandler *handlers,
874 GNUNET_MQ_ErrorHandler error_handler,
875 void *error_handler_cls)
877 struct ClientState *cstate;
880 test_service_configuration (service_name,
883 cstate = GNUNET_new (struct ClientState);
884 cstate->service_name = GNUNET_strdup (service_name);
886 cstate->retry_task = GNUNET_SCHEDULER_add_now (&start_connect,
888 cstate->mst = GNUNET_MST_create (&recv_message,
891 GNUNET_CONFIGURATION_have_value (cfg,
895 if (! ( (GNUNET_OK !=
896 GNUNET_CONFIGURATION_get_value_number (cfg,
900 (cstate->port > 65535) ||
902 GNUNET_CONFIGURATION_get_value_string (cfg,
905 &cstate->hostname)) ) &&
906 (0 == strlen (cstate->hostname)) )
908 GNUNET_free (cstate->hostname);
909 cstate->hostname = NULL;
910 LOG (GNUNET_ERROR_TYPE_WARNING,
911 _("Need a non-empty hostname for service `%s'.\n"),
915 cstate->mq = GNUNET_MQ_queue_for_callbacks (&connection_client_send_impl,
916 &connection_client_destroy_impl,
917 &connection_client_cancel_impl,
925 /* end of client.c */