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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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 LOG (GNUNET_ERROR_TYPE_DEBUG,
265 "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 LOG (GNUNET_ERROR_TYPE_WARNING,
277 "Error during sending message of type %u\n",
278 ntohs(cstate->msg->type));
280 LOG (GNUNET_ERROR_TYPE_DEBUG,
281 "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 LOG (GNUNET_ERROR_TYPE_DEBUG,
294 "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 LOG (GNUNET_ERROR_TYPE_DEBUG,
306 "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;
381 if (GNUNET_SYSERR == cstate->in_destroy)
383 /* defer destruction */
384 cstate->in_destroy = GNUNET_YES;
388 if (NULL != cstate->dns_active)
389 GNUNET_RESOLVER_request_cancel (cstate->dns_active);
390 if (NULL != cstate->send_task)
391 GNUNET_SCHEDULER_cancel (cstate->send_task);
392 if (NULL != cstate->recv_task)
393 GNUNET_SCHEDULER_cancel (cstate->recv_task);
394 if (NULL != cstate->retry_task)
395 GNUNET_SCHEDULER_cancel (cstate->retry_task);
396 if (NULL != cstate->sock){
397 LOG (GNUNET_ERROR_TYPE_DEBUG,
398 "destroying socket: %p\n",
400 GNUNET_NETWORK_socket_close (cstate->sock);
403 GNUNET_free (cstate->service_name);
404 GNUNET_free_non_null (cstate->hostname);
405 GNUNET_MST_destroy (cstate->mst);
406 GNUNET_free (cstate);
411 * This function is called once we have data ready to read.
413 * @param cls `struct ClientState` with connection to read from
416 receive_ready (void *cls)
418 struct ClientState *cstate = cls;
421 cstate->recv_task = NULL;
422 cstate->in_destroy = GNUNET_SYSERR;
423 ret = GNUNET_MST_read (cstate->mst,
427 if (GNUNET_SYSERR == ret)
429 if (NULL != cstate->mq)
430 GNUNET_MQ_inject_error (cstate->mq,
431 GNUNET_MQ_ERROR_READ);
432 if (GNUNET_YES == cstate->in_destroy)
433 connection_client_destroy_impl (cstate->mq,
437 if (GNUNET_YES == cstate->in_destroy)
439 connection_client_destroy_impl (cstate->mq,
443 cstate->in_destroy = GNUNET_NO;
445 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
453 * We've succeeded in establishing a connection.
455 * @param cstate the connection we tried to establish
458 connect_success_continuation (struct ClientState *cstate)
460 GNUNET_assert (NULL == cstate->recv_task);
462 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
466 if (NULL != cstate->msg)
468 GNUNET_assert (NULL == cstate->send_task);
470 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
479 * Try connecting to the server using UNIX domain sockets.
481 * @param service_name name of service to connect to
482 * @param cfg configuration to use
483 * @return NULL on error, socket connected to UNIX otherwise
485 static struct GNUNET_NETWORK_Handle *
486 try_unixpath (const char *service_name,
487 const struct GNUNET_CONFIGURATION_Handle *cfg)
490 struct GNUNET_NETWORK_Handle *sock;
492 struct sockaddr_un s_un;
496 GNUNET_CONFIGURATION_get_value_filename (cfg,
500 (0 < strlen (unixpath)))
502 /* We have a non-NULL unixpath, need to validate it */
503 if (strlen (unixpath) >= sizeof (s_un.sun_path))
505 LOG (GNUNET_ERROR_TYPE_WARNING,
506 _("UNIXPATH `%s' too long, maximum length is %llu\n"),
508 (unsigned long long) sizeof (s_un.sun_path));
509 unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
510 LOG (GNUNET_ERROR_TYPE_INFO,
511 _("Using `%s' instead\n"),
513 if (NULL == unixpath)
519 s_un.sun_family = AF_UNIX;
520 strncpy (s_un.sun_path,
522 sizeof (s_un.sun_path) - 1);
527 abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
529 "USE_ABSTRACT_SOCKETS");
530 if (GNUNET_YES == abstract)
531 s_un.sun_path[0] = '\0';
534 #if HAVE_SOCKADDR_UN_SUN_LEN
535 s_un.sun_len = (u_char) sizeof (struct sockaddr_un);
537 sock = GNUNET_NETWORK_socket_create (AF_UNIX,
540 if ( (NULL != sock) &&
542 GNUNET_NETWORK_socket_connect (sock,
543 (struct sockaddr *) &s_un,
545 (EINPROGRESS == errno) ) )
547 LOG (GNUNET_ERROR_TYPE_DEBUG,
548 "Successfully connected to unixpath `%s'!\n",
550 GNUNET_free (unixpath);
554 GNUNET_NETWORK_socket_close (sock);
556 GNUNET_free_non_null (unixpath);
563 * Scheduler let us know that we're either ready to write on the
564 * socket OR connect timed out. Do the right thing.
566 * @param cls the `struct AddressProbe *` with the address that we are probing
569 connect_probe_continuation (void *cls)
571 struct AddressProbe *ap = cls;
572 struct ClientState *cstate = ap->cstate;
573 const struct GNUNET_SCHEDULER_TaskContext *tc;
578 GNUNET_assert (NULL != ap->sock);
579 GNUNET_CONTAINER_DLL_remove (cstate->ap_head,
582 len = sizeof (error);
584 tc = GNUNET_SCHEDULER_get_task_context ();
585 if ( (0 == (tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) ||
587 GNUNET_NETWORK_socket_getsockopt (ap->sock,
594 GNUNET_break (GNUNET_OK ==
595 GNUNET_NETWORK_socket_close (ap->sock));
597 if ( (NULL == cstate->ap_head) &&
598 // (NULL == cstate->proxy_handshake) &&
599 (NULL == cstate->dns_active) )
600 connect_fail_continuation (cstate);
603 LOG (GNUNET_ERROR_TYPE_DEBUG,
604 "Connection to `%s' succeeded!\n",
605 cstate->service_name);
606 /* trigger jobs that waited for the connection */
607 GNUNET_assert (NULL == cstate->sock);
608 cstate->sock = ap->sock;
611 connect_success_continuation (cstate);
616 * Try to establish a connection given the specified address.
617 * This function is called by the resolver once we have a DNS reply.
619 * @param cls our `struct ClientState *`
620 * @param addr address to try, NULL for "last call"
621 * @param addrlen length of @a addr
624 try_connect_using_address (void *cls,
625 const struct sockaddr *addr,
628 struct ClientState *cstate = cls;
629 struct AddressProbe *ap;
633 cstate->dns_active = NULL;
634 if ( (NULL == cstate->ap_head) &&
635 // (NULL == cstate->proxy_handshake) &&
636 (NULL == cstate->sock) )
637 connect_fail_continuation (cstate);
640 if (NULL != cstate->sock)
641 return; /* already connected */
643 LOG (GNUNET_ERROR_TYPE_DEBUG,
644 "Trying to connect using address `%s:%u'\n",
648 ap = GNUNET_malloc (sizeof (struct AddressProbe) + addrlen);
649 ap->addr = (const struct sockaddr *) &ap[1];
650 GNUNET_memcpy (&ap[1],
653 ap->addrlen = addrlen;
656 switch (ap->addr->sa_family)
659 ((struct sockaddr_in *) ap->addr)->sin_port = htons (cstate->port);
662 ((struct sockaddr_in6 *) ap->addr)->sin6_port = htons (cstate->port);
667 return; /* not supported by us */
669 ap->sock = GNUNET_NETWORK_socket_create (ap->addr->sa_family,
672 if (NULL == ap->sock)
675 return; /* not supported by OS */
678 GNUNET_NETWORK_socket_connect (ap->sock,
681 (EINPROGRESS != errno) )
683 /* maybe refused / unsupported address, try next */
684 GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO,
686 GNUNET_break (GNUNET_OK ==
687 GNUNET_NETWORK_socket_close (ap->sock));
691 GNUNET_CONTAINER_DLL_insert (cstate->ap_head,
694 ap->task = GNUNET_SCHEDULER_add_write_net (CONNECT_RETRY_TIMEOUT,
696 &connect_probe_continuation,
702 * Test whether the configuration has proper values for connection
703 * (UNIXPATH || (PORT && HOSTNAME)).
705 * @param service_name name of service to connect to
706 * @param cfg configuration to use
707 * @return #GNUNET_OK if the configuration is valid, #GNUNET_SYSERR if not
710 test_service_configuration (const char *service_name,
711 const struct GNUNET_CONFIGURATION_Handle *cfg)
713 int ret = GNUNET_SYSERR;
714 char *hostname = NULL;
715 unsigned long long port;
717 char *unixpath = NULL;
720 GNUNET_CONFIGURATION_get_value_filename (cfg,
724 (0 < strlen (unixpath)))
726 else if ((GNUNET_OK ==
727 GNUNET_CONFIGURATION_have_value (cfg,
731 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
734 _("not a valid filename"));
735 return GNUNET_SYSERR; /* UNIXPATH specified but invalid! */
737 GNUNET_free_non_null (unixpath);
741 GNUNET_CONFIGURATION_have_value (cfg,
745 GNUNET_CONFIGURATION_get_value_number (cfg,
752 GNUNET_CONFIGURATION_get_value_string (cfg,
756 (0 != strlen (hostname)) )
758 GNUNET_free_non_null (hostname);
764 * Try to connect to the service.
766 * @param cls the `struct ClientState` to try to connect to the service
769 start_connect (void *cls)
771 struct ClientState *cstate = cls;
773 cstate->retry_task = NULL;
775 /* Never use a local source if a proxy is configured */
777 GNUNET_SOCKS_check_service (cstate->service_name,
780 socks_connect (cstate);
785 if ( (0 == (cstate->attempts++ % 2)) ||
786 (0 == cstate->port) ||
787 (NULL == cstate->hostname) )
789 /* on even rounds, try UNIX first, or always
790 if we do not have a DNS name and TCP port. */
791 cstate->sock = try_unixpath (cstate->service_name,
793 if (NULL != cstate->sock)
795 connect_success_continuation (cstate);
799 if ( (NULL == cstate->hostname) ||
800 (0 == cstate->port) )
802 /* All options failed. Boo! */
803 connect_fail_continuation (cstate);
807 = GNUNET_RESOLVER_ip_get (cstate->hostname,
809 CONNECT_RETRY_TIMEOUT,
810 &try_connect_using_address,
816 * Implements the transmission functionality of a message queue.
818 * @param mq the message queue
819 * @param msg the message to send
820 * @param impl_state our `struct ClientState`
823 connection_client_send_impl (struct GNUNET_MQ_Handle *mq,
824 const struct GNUNET_MessageHeader *msg,
827 struct ClientState *cstate = impl_state;
830 /* only one message at a time allowed */
831 GNUNET_assert (NULL == cstate->msg);
832 GNUNET_assert (NULL == cstate->send_task);
835 if (NULL == cstate->sock){
836 LOG (GNUNET_ERROR_TYPE_DEBUG,
837 "message of type %u waiting for socket\n",
839 return; /* still waiting for connection */
842 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
850 * Cancel the currently sent message.
852 * @param mq message queue
853 * @param impl_state our `struct ClientState`
856 connection_client_cancel_impl (struct GNUNET_MQ_Handle *mq,
859 struct ClientState *cstate = impl_state;
862 GNUNET_assert (NULL != cstate->msg);
863 GNUNET_assert (0 == cstate->msg_off);
865 if (NULL != cstate->send_task)
867 GNUNET_SCHEDULER_cancel (cstate->send_task);
868 cstate->send_task = NULL;
874 * Create a message queue to connect to a GNUnet service.
875 * If handlers are specfied, receive messages from the connection.
877 * @param cfg our configuration
878 * @param service_name name of the service to connect to
879 * @param handlers handlers for receiving messages, can be NULL
880 * @param error_handler error handler
881 * @param error_handler_cls closure for the @a error_handler
882 * @return the message queue, NULL on error
884 struct GNUNET_MQ_Handle *
885 GNUNET_CLIENT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
886 const char *service_name,
887 const struct GNUNET_MQ_MessageHandler *handlers,
888 GNUNET_MQ_ErrorHandler error_handler,
889 void *error_handler_cls)
891 struct ClientState *cstate;
894 test_service_configuration (service_name,
897 cstate = GNUNET_new (struct ClientState);
898 cstate->service_name = GNUNET_strdup (service_name);
900 cstate->retry_task = GNUNET_SCHEDULER_add_now (&start_connect,
902 cstate->mst = GNUNET_MST_create (&recv_message,
905 GNUNET_CONFIGURATION_have_value (cfg,
909 if (! ( (GNUNET_OK !=
910 GNUNET_CONFIGURATION_get_value_number (cfg,
914 (cstate->port > 65535) ||
916 GNUNET_CONFIGURATION_get_value_string (cfg,
919 &cstate->hostname)) ) &&
920 (0 == strlen (cstate->hostname)) )
922 GNUNET_free (cstate->hostname);
923 cstate->hostname = NULL;
924 LOG (GNUNET_ERROR_TYPE_WARNING,
925 _("Need a non-empty hostname for service `%s'.\n"),
929 cstate->mq = GNUNET_MQ_queue_for_callbacks (&connection_client_send_impl,
930 &connection_client_destroy_impl,
931 &connection_client_cancel_impl,
939 /* end of client.c */