2 This file is part of GNUnet.
3 (C) 2009 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 2, 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 util/service.c
23 * @brief functions related to starting services
24 * @author Christian Grothoff
27 #include "gnunet_common.h"
28 #include "gnunet_configuration_lib.h"
29 #include "gnunet_crypto_lib.h"
30 #include "gnunet_directories.h"
31 #include "gnunet_disk_lib.h"
32 #include "gnunet_getopt_lib.h"
33 #include "gnunet_os_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_server_lib.h"
36 #include "gnunet_service_lib.h"
38 #define DEBUG_SERVICE GNUNET_NO
40 /* ******************* access control ******************** */
43 * @brief IPV4 network in CIDR notation.
47 struct in_addr network;
48 struct in_addr netmask;
52 * @brief network in CIDR notation for IPV6.
56 struct in6_addr network;
57 struct in6_addr netmask;
62 * Parse a network specification. The argument specifies
63 * a list of networks. The format is
64 * <tt>[network/netmask;]*</tt> (no whitespace, must be terminated
65 * with a semicolon). The network must be given in dotted-decimal
66 * notation. The netmask can be given in CIDR notation (/16) or
67 * in dotted-decimal (/255.255.0.0).
69 * @param routeList a string specifying the forbidden networks
70 * @return the converted list, NULL if the synatx is flawed
72 static struct IPv4NetworkSet *
73 parse_ipv4_specification (const char *routeList)
81 unsigned int temps[8];
83 struct IPv4NetworkSet *result;
85 if (routeList == NULL)
87 len = strlen (routeList);
91 for (i = 0; i < len; i++)
92 if (routeList[i] == ';')
94 result = GNUNET_malloc (sizeof (struct IPv4NetworkSet) * (count + 1));
96 memset (result, 0, sizeof (struct IPv4NetworkSet) * (count + 1));
101 cnt = sscanf (&routeList[pos],
102 "%u.%u.%u.%u/%u.%u.%u.%u;",
106 &temps[3], &temps[4], &temps[5], &temps[6], &temps[7]);
109 for (j = 0; j < 8; j++)
112 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
113 _("Invalid format for IP: `%s'\n"),
115 GNUNET_free (result);
118 result[i].network.s_addr
120 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
122 result[i].netmask.s_addr =
123 htonl ((temps[4] << 24) + (temps[5] << 16) + (temps[6] << 8) +
125 while (routeList[pos] != ';')
131 /* try second notation */
132 cnt = sscanf (&routeList[pos],
134 &temps[0], &temps[1], &temps[2], &temps[3], &slash);
137 for (j = 0; j < 4; j++)
140 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
141 _("Invalid format for IP: `%s'\n"),
143 GNUNET_free (result);
146 result[i].network.s_addr
148 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
150 if ((slash <= 32) && (slash >= 0))
152 result[i].netmask.s_addr = 0;
155 result[i].netmask.s_addr
156 = (result[i].netmask.s_addr >> 1) + 0x80000000;
159 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
160 while (routeList[pos] != ';')
168 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
170 ("Invalid network notation ('/%d' is not legal in IPv4 CIDR)."),
172 GNUNET_free (result);
173 return NULL; /* error */
176 /* try third notation */
178 cnt = sscanf (&routeList[pos],
180 &temps[0], &temps[1], &temps[2], &temps[3]);
183 for (j = 0; j < 4; j++)
186 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
187 _("Invalid format for IP: `%s'\n"),
189 GNUNET_free (result);
192 result[i].network.s_addr
194 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
196 result[i].netmask.s_addr = 0;
199 result[i].netmask.s_addr
200 = (result[i].netmask.s_addr >> 1) + 0x80000000;
203 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
204 while (routeList[pos] != ';')
210 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
211 _("Invalid format for IP: `%s'\n"), &routeList[pos]);
212 GNUNET_free (result);
213 return NULL; /* error */
215 if (pos < strlen (routeList))
217 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
218 _("Invalid format for IP: `%s'\n"), &routeList[pos]);
219 GNUNET_free (result);
220 return NULL; /* oops */
222 return result; /* ok */
227 * Parse a network specification. The argument specifies
228 * a list of networks. The format is
229 * <tt>[network/netmask;]*</tt> (no whitespace, must be terminated
230 * with a semicolon). The network must be given in colon-hex
231 * notation. The netmask must be given in CIDR notation (/16) or
232 * can be omitted to specify a single host.
234 * @param routeListX a string specifying the forbidden networks
235 * @return the converted list, NULL if the synatx is flawed
237 static struct IPv6NetworkSet *
238 parse_ipv6_specification (const char *routeListX)
248 struct IPv6NetworkSet *result;
253 if (routeListX == NULL)
255 len = strlen (routeListX);
258 routeList = GNUNET_strdup (routeListX);
260 for (i = 0; i < len; i++)
261 if (routeList[i] == ';')
263 if (routeList[len - 1] != ';')
265 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
267 ("Invalid network notation (does not end with ';': `%s')\n"),
269 GNUNET_free (routeList);
273 result = GNUNET_malloc (sizeof (struct IPv6NetworkSet) * (count + 1));
274 memset (result, 0, sizeof (struct IPv6NetworkSet) * (count + 1));
280 while (routeList[pos] != ';')
283 while ((slash >= start) && (routeList[slash] != '/'))
287 memset (&result[i].netmask, 0xFF, sizeof (struct in6_addr));
292 routeList[pos] = '\0';
293 ret = inet_pton (AF_INET6,
294 &routeList[slash + 1], &result[i].netmask);
298 if ((1 != SSCANF (&routeList[slash + 1],
299 "%u", &bits)) || (bits >= 128))
302 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
303 _("Wrong format `%s' for netmask\n"),
304 &routeList[slash + 1]);
308 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
311 GNUNET_free (result);
312 GNUNET_free (routeList);
318 result[i].netmask.s6_addr[off++] = 0xFF;
323 result[i].netmask.s6_addr[off]
324 = (result[i].netmask.s6_addr[off] >> 1) + 0x80;
329 routeList[slash] = '\0';
330 ret = inet_pton (AF_INET6, &routeList[start], &result[i].network);
334 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
335 _("Wrong format `%s' for network\n"),
336 &routeList[slash + 1]);
338 GNUNET_log_strerror(GNUNET_ERROR_TYPE_ERROR, "inet_pton");
339 GNUNET_free (result);
340 GNUNET_free (routeList);
346 GNUNET_free (routeList);
352 * Check if the given IP address is in the list of IP addresses.
354 * @param list a list of networks
355 * @param add the IP to check (in network byte order)
356 * @return GNUNET_NO if the IP is not in the list, GNUNET_YES if it it is
359 check_ipv4_listed (const struct IPv4NetworkSet *list,
360 const struct in_addr *add)
368 while ((list[i].network.s_addr != 0) || (list[i].netmask.s_addr != 0))
370 if ((add->s_addr & list[i].netmask.s_addr) ==
371 (list[i].network.s_addr & list[i].netmask.s_addr))
379 * Check if the given IP address is in the list of IP addresses.
381 * @param list a list of networks
382 * @param ip the IP to check (in network byte order)
383 * @return GNUNET_NO if the IP is not in the list, GNUNET_YES if it it is
386 check_ipv6_listed (const struct IPv6NetworkSet *list,
387 const struct in6_addr *ip)
391 struct in6_addr zero;
396 memset (&zero, 0, sizeof (struct in6_addr));
399 while (memcmp (&zero, &list[i].network, sizeof (struct in6_addr)) != 0)
401 for (j = 0; j < sizeof (struct in6_addr) / sizeof (int); j++)
402 if (((((int *) ip)[j] & ((int *) &list[i].netmask)[j])) !=
403 (((int *) &list[i].network)[j] & ((int *) &list[i].netmask)[j]))
414 /* ****************** service struct ****************** */
418 * Context for "service_task".
420 struct GNUNET_SERVICE_Context
425 const struct GNUNET_CONFIGURATION_Handle *cfg;
428 * Handle for the server.
430 struct GNUNET_SERVER_Handle *server;
433 * Scheduler for the server.
435 struct GNUNET_SCHEDULER_Handle *sched;
438 * NULL-terminated array of addresses to bind to, NULL if we got pre-bound
441 struct sockaddr **addrs;
444 * Name of our service.
446 const char *serviceName;
449 * Main service-specific task to run.
451 GNUNET_SERVICE_Main task;
459 * IPv4 addresses that are not allowed to connect.
461 struct IPv4NetworkSet *v4_denied;
464 * IPv6 addresses that are not allowed to connect.
466 struct IPv6NetworkSet *v6_denied;
469 * IPv4 addresses that are allowed to connect (if not
470 * set, all are allowed).
472 struct IPv4NetworkSet *v4_allowed;
475 * IPv6 addresses that are allowed to connect (if not
476 * set, all are allowed).
478 struct IPv6NetworkSet *v6_allowed;
481 * My (default) message handlers. Adjusted copy
484 struct GNUNET_SERVER_MessageHandler *my_handlers;
487 * Array of the lengths of the entries in addrs.
489 socklen_t * addrlens;
492 * NULL-terminated array of listen sockets we should take over.
494 struct GNUNET_NETWORK_Handle **lsocks;
497 * Idle timeout for server.
499 struct GNUNET_TIME_Relative timeout;
502 * Maximum buffer size for the server.
507 * Overall success/failure of the service start.
512 * If we are daemonizing, this FD is set to the
513 * pipe to the parent. Send '.' if we started
514 * ok, '!' if not. -1 if we are not daemonizing.
516 int ready_confirm_fd;
519 * Do we close connections if we receive messages
520 * for which we have no handler?
527 enum GNUNET_SERVICE_Options options;
532 /* ****************** message handlers ****************** */
535 write_test (void *cls, size_t size, void *buf)
537 struct GNUNET_SERVER_Client *client = cls;
538 struct GNUNET_MessageHeader *msg;
540 if (size < sizeof (struct GNUNET_MessageHeader))
542 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
543 return 0; /* client disconnected */
545 msg = (struct GNUNET_MessageHeader *) buf;
546 msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
547 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
548 GNUNET_SERVER_receive_done (client, GNUNET_OK);
549 return sizeof (struct GNUNET_MessageHeader);
553 * Handler for TEST message.
555 * @param cls closure (refers to service)
556 * @param client identification of the client
557 * @param message the actual message
560 handle_test (void *cls,
561 struct GNUNET_SERVER_Client *client,
562 const struct GNUNET_MessageHeader *message)
564 /* simply bounce message back to acknowledge */
565 if (NULL == GNUNET_SERVER_notify_transmit_ready (client,
567 GNUNET_MessageHeader),
568 GNUNET_TIME_UNIT_FOREVER_REL,
569 &write_test, client))
570 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
575 * Default handlers for all services. Will be copied and the
576 * "callback_cls" fields will be replaced with the specific service
579 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
580 {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
581 sizeof (struct GNUNET_MessageHeader)},
587 /* ****************** service core routines ************** */
591 * Check if access to the service is allowed from the given address.
594 check_access (void *cls, const struct sockaddr *addr, socklen_t addrlen)
596 struct GNUNET_SERVICE_Context *sctx = cls;
597 const struct sockaddr_in *i4;
598 const struct sockaddr_in6 *i6;
601 switch (addr->sa_family)
604 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
605 i4 = (const struct sockaddr_in *) addr;
606 ret = ((sctx->v4_allowed == NULL) ||
607 (check_ipv4_listed (sctx->v4_allowed,
609 && ((sctx->v4_denied == NULL) ||
610 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
613 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
614 i6 = (const struct sockaddr_in6 *) addr;
615 ret = ((sctx->v6_allowed == NULL) ||
616 (check_ipv6_listed (sctx->v6_allowed,
618 && ((sctx->v6_denied == NULL) ||
619 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
622 /* FIXME: support checking UID/GID in the future... */
623 ret = GNUNET_OK; /* always OK for now */
626 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
627 _("Unknown address family %d\n"), addr->sa_family);
628 return GNUNET_SYSERR;
630 if (ret != GNUNET_OK)
632 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
633 _("Access from `%s' denied to service `%s'\n"),
634 GNUNET_a2s (addr, addrlen), sctx->serviceName);
641 * Get the name of the file where we will
642 * write the PID of the service.
645 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
651 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
660 * Parse an IPv4 access control list.
663 process_acl4 (struct IPv4NetworkSet **ret,
664 struct GNUNET_SERVICE_Context *sctx, const char *option)
668 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
670 GNUNET_break (GNUNET_OK ==
671 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
674 if (NULL == (*ret = parse_ipv4_specification (opt)))
676 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
678 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
679 opt, sctx->serviceName, option);
681 return GNUNET_SYSERR;
689 * Parse an IPv4 access control list.
692 process_acl6 (struct IPv6NetworkSet **ret,
693 struct GNUNET_SERVICE_Context *sctx, const char *option)
696 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
698 GNUNET_break (GNUNET_OK ==
699 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
702 if (NULL == (*ret = parse_ipv6_specification (opt)))
704 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
706 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
707 opt, sctx->serviceName, option);
709 return GNUNET_SYSERR;
716 * Add the given UNIX domain path as an address to the
717 * list (as the first entry).
719 * @param saddrs array to update
720 * @param saddrlens where to store the address length
721 * @param unixpath path to add
724 add_unixpath (struct sockaddr **saddrs,
725 socklen_t *saddrlens,
726 const char *unixpath)
729 struct sockaddr_un *un;
732 un = GNUNET_malloc (sizeof (struct sockaddr_un));
733 un->sun_family = AF_UNIX;
734 slen = strlen (unixpath) + 1;
735 if (slen >= sizeof (un->sun_path))
736 slen = sizeof (un->sun_path) - 1;
737 memcpy (un->sun_path,
740 un->sun_path[slen] = '\0';
742 un->sun_path[0] = '\0';
743 slen = sizeof (struct sockaddr_un);
745 slen += sizeof (sa_family_t);
747 *saddrs = (struct sockaddr*) un;
750 /* this function should never be called
751 unless AF_UNIX is defined! */
758 * Get the list of addresses that a server for the given service
761 * @param serviceName name of the service
762 * @param cfg configuration (which specifies the addresses)
763 * @param addrs set (call by reference) to an array of pointers to the
764 * addresses the server should bind to and listen on; the
765 * array will be NULL-terminated (on success)
766 * @param addr_lens set (call by reference) to an array of the lengths
767 * of the respective 'struct sockaddr' struct in the 'addrs'
769 * @return number of addresses found on success,
770 * GNUNET_SYSERR if the configuration
771 * did not specify reasonable finding information or
772 * if it specified a hostname that could not be resolved;
773 * GNUNET_NO if the number of addresses configured is
774 * zero (in this case, '*addrs' and '*addr_lens' will be
778 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
779 const struct GNUNET_CONFIGURATION_Handle *cfg,
780 struct sockaddr ***addrs,
781 socklen_t **addr_lens)
784 struct GNUNET_NETWORK_Handle *desc;
785 unsigned long long port;
787 struct addrinfo hints;
788 struct addrinfo *res;
789 struct addrinfo *pos;
790 struct addrinfo *next;
794 struct sockaddr **saddrs;
795 socklen_t *saddrlens;
801 if (GNUNET_CONFIGURATION_have_value (cfg,
802 serviceName, "DISABLEV6"))
805 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
808 return GNUNET_SYSERR;
811 disablev6 = GNUNET_NO;
815 /* probe IPv6 support */
816 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
819 if ((errno == ENOBUFS) ||
820 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
822 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
823 return GNUNET_SYSERR;
825 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
827 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
828 serviceName, STRERROR (errno));
829 disablev6 = GNUNET_YES;
833 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
839 if (GNUNET_CONFIGURATION_have_value (cfg,
840 serviceName, "PORT"))
842 GNUNET_break (GNUNET_OK ==
843 GNUNET_CONFIGURATION_get_value_number (cfg,
849 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
851 ("Require valid port number for service `%s' in configuration!\n"),
853 return GNUNET_SYSERR;
857 if (GNUNET_CONFIGURATION_have_value (cfg,
858 serviceName, "BINDTO"))
860 GNUNET_break (GNUNET_OK ==
861 GNUNET_CONFIGURATION_get_value_string (cfg,
870 if (GNUNET_CONFIGURATION_have_value (cfg,
871 serviceName, "UNIXPATH"))
873 GNUNET_break (GNUNET_OK ==
874 GNUNET_CONFIGURATION_get_value_string (cfg,
879 /* probe UNIX support */
880 desc = GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_STREAM, 0);
883 if ((errno == ENOBUFS) ||
884 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
886 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
887 GNUNET_free_non_null (hostname);
888 GNUNET_free (unixpath);
889 return GNUNET_SYSERR;
891 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
893 ("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
894 serviceName, STRERROR (errno));
895 GNUNET_free (unixpath);
908 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
909 _("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
912 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
913 GNUNET_free_non_null(hostname);
914 return GNUNET_SYSERR;
918 saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
919 saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
920 add_unixpath (saddrs, saddrlens, unixpath);
921 GNUNET_free_non_null (unixpath);
923 *addr_lens = saddrlens;
927 if (hostname != NULL)
930 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
931 "Resolving `%s' since that is where `%s' will bind to.\n",
935 memset (&hints, 0, sizeof (struct addrinfo));
937 hints.ai_family = AF_INET;
938 if ((0 != (ret = getaddrinfo (hostname,
939 NULL, &hints, &res))) || (res == NULL))
941 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
942 _("Failed to resolve `%s': %s\n"),
943 hostname, gai_strerror (ret));
944 GNUNET_free (hostname);
945 GNUNET_free (unixpath);
947 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
948 return GNUNET_SYSERR;
952 while (NULL != (pos = next))
955 if ( (disablev6) && (pos->ai_family == AF_INET6))
961 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
962 _("Failed to find %saddress for `%s'.\n"),
963 disablev6 ? "IPv4 " : "", hostname);
965 GNUNET_free (hostname);
966 GNUNET_free (unixpath);
967 return GNUNET_SYSERR;
970 if (NULL != unixpath)
972 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
973 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
975 if (NULL != unixpath)
977 add_unixpath (saddrs, saddrlens, unixpath);
981 while (NULL != (pos = next))
984 if ( (disablev6) && (pos->ai_family == AF_INET6))
987 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
988 "Service `%s' will bind to `%s'\n",
990 GNUNET_a2s (pos->ai_addr,
993 if (pos->ai_family == AF_INET)
995 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
996 saddrlens[i] = pos->ai_addrlen;
997 saddrs[i] = GNUNET_malloc (saddrlens[i]);
998 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
999 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1003 GNUNET_assert (pos->ai_family == AF_INET6);
1004 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
1005 saddrlens[i] = pos->ai_addrlen;
1006 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1007 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
1008 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1012 GNUNET_free (hostname);
1017 /* will bind against everything, just set port */
1022 if (NULL != unixpath)
1025 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1026 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1027 if (NULL != unixpath)
1029 add_unixpath (saddrs, saddrlens, unixpath);
1032 saddrlens[i] = sizeof (struct sockaddr_in);
1033 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1034 #if HAVE_SOCKADDR_IN_SIN_LEN
1035 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
1037 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1038 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1044 if (NULL != unixpath)
1046 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1047 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1049 if (NULL != unixpath)
1051 add_unixpath (saddrs, saddrlens, unixpath);
1054 saddrlens[i] = sizeof (struct sockaddr_in6);
1055 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1056 #if HAVE_SOCKADDR_IN_SIN_LEN
1057 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
1059 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
1060 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1062 saddrlens[i] = sizeof (struct sockaddr_in);
1063 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1064 #if HAVE_SOCKADDR_IN_SIN_LEN
1065 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
1067 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1068 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1071 GNUNET_free_non_null (unixpath);
1073 *addr_lens = saddrlens;
1075 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
1081 * Setup addr, addrlen, maxbuf, idle_timeout
1082 * based on configuration!
1084 * Configuration may specify:
1085 * - PORT (where to bind to for TCP)
1086 * - UNIXPATH (where to bind to for UNIX domain sockets)
1087 * - TIMEOUT (after how many ms does an inactive service timeout);
1088 * - MAXBUF (maximum incoming message size supported)
1089 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1090 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1091 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
1092 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1093 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
1094 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1096 * @return GNUNET_OK if configuration succeeded
1099 setup_service (struct GNUNET_SERVICE_Context *sctx)
1101 unsigned long long maxbuf;
1102 struct GNUNET_TIME_Relative idleout;
1110 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1111 sctx->serviceName, "TIMEOUT"))
1114 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
1116 "TIMEOUT", &idleout))
1118 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1119 _("Specified value for `%s' of service `%s' is invalid\n"),
1122 return GNUNET_SYSERR;
1124 sctx->timeout = idleout;
1127 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1128 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1129 sctx->serviceName, "MAXBUF"))
1132 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
1136 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1137 _("Specified value for `%s' of service `%s' is invalid\n"),
1140 return GNUNET_SYSERR;
1144 maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1146 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1147 sctx->serviceName, "TOLERANT"))
1149 if (GNUNET_SYSERR ==
1150 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1154 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1155 _("Specified value for `%s' of service `%s' is invalid\n"),
1158 return GNUNET_SYSERR;
1162 tolerant = GNUNET_NO;
1166 if ( (NULL != (lpid = getenv ("LISTEN_PID"))) &&
1167 (1 == sscanf (lpid, "%u", &pid)) &&
1168 (getpid () == (pid_t) pid) &&
1169 (NULL != (nfds = getenv ("LISTEN_FDS"))) &&
1170 (1 == sscanf (nfds, "%u", &cnt)) &&
1173 sctx->lsocks = GNUNET_malloc (sizeof(struct GNUNET_NETWORK_Handle*) * (cnt+1));
1176 flags = fcntl (3 + cnt, F_GETFD);
1178 (0 != (flags & FD_CLOEXEC)) ||
1179 (NULL == (sctx->lsocks[cnt] = GNUNET_NETWORK_socket_box_native (3 + cnt))) )
1181 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1182 _("Could not access pre-bound socket %u, will try to bind myself\n"),
1183 (unsigned int) 3 +cnt);
1185 while (sctx->lsocks[cnt] != NULL)
1186 GNUNET_break (0 == GNUNET_NETWORK_socket_close (sctx->lsocks[cnt++]));
1187 GNUNET_free (sctx->lsocks);
1188 sctx->lsocks = NULL;
1192 unsetenv ("LISTEN_PID");
1193 unsetenv ("LISTEN_FDS");
1197 if ( (sctx->lsocks == NULL) &&
1199 GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1203 return GNUNET_SYSERR;
1204 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1205 sctx->maxbuf = (size_t) maxbuf;
1206 if (sctx->maxbuf != maxbuf)
1208 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1210 ("Value in configuration for `%s' and service `%s' too large!\n"),
1211 "MAXBUF", sctx->serviceName);
1212 return GNUNET_SYSERR;
1215 process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1216 process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1217 process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1218 process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1225 * Get the name of the user that'll be used
1226 * to provide the service.
1229 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1235 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1246 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1254 if (NULL == (pif = get_pid_file_name (sctx)))
1255 return GNUNET_OK; /* no file desired */
1256 user = get_user_name (sctx);
1257 rdir = GNUNET_strdup (pif);
1258 len = strlen (rdir);
1259 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1262 if (0 != ACCESS (rdir, F_OK))
1264 /* we get to create a directory -- and claim it
1266 GNUNET_DISK_directory_create (rdir);
1267 if ((user != NULL) && (0 < strlen (user)))
1268 GNUNET_DISK_file_change_owner (rdir, user);
1270 if (0 != ACCESS (rdir, W_OK | X_OK))
1272 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1274 GNUNET_free_non_null (user);
1276 return GNUNET_SYSERR;
1279 pidfd = FOPEN (pif, "w");
1282 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1284 GNUNET_free_non_null (user);
1285 return GNUNET_SYSERR;
1287 if (0 > FPRINTF (pidfd, "%u", pid))
1288 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1289 GNUNET_break (0 == fclose (pidfd));
1290 if ((user != NULL) && (0 < strlen (user)))
1291 GNUNET_DISK_file_change_owner (pif, user);
1292 GNUNET_free_non_null (user);
1299 * Task run during shutdown.
1305 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1307 struct GNUNET_SERVER_Handle *server = cls;
1309 GNUNET_SERVER_destroy (server);
1314 * Initial task for the service.
1317 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1319 struct GNUNET_SERVICE_Context *sctx = cls;
1322 sctx->sched = tc->sched;
1323 if (sctx->lsocks != NULL)
1324 sctx->server = GNUNET_SERVER_create_with_sockets (tc->sched,
1329 sctx->timeout, sctx->require_found);
1331 sctx->server = GNUNET_SERVER_create (tc->sched,
1337 sctx->timeout, sctx->require_found);
1338 if (sctx->server == NULL)
1340 if (sctx->addrs != NULL)
1343 while (sctx->addrs[i] != NULL)
1345 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1346 _("Failed to start `%s' at `%s'\n"),
1348 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1352 sctx->ret = GNUNET_SYSERR;
1355 if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1357 /* install a task that will kill the server
1358 process if the scheduler ever gets a shutdown signal */
1359 GNUNET_SCHEDULER_add_delayed (tc->sched,
1360 GNUNET_TIME_UNIT_FOREVER_REL,
1361 &shutdown_task, sctx->server);
1363 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1364 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1366 while ((sctx->my_handlers[i].callback != NULL))
1367 sctx->my_handlers[i++].callback_cls = sctx;
1368 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1369 if (sctx->ready_confirm_fd != -1)
1371 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1372 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1373 sctx->ready_confirm_fd = -1;
1374 write_pid_file (sctx, getpid ());
1376 if (sctx->addrs != NULL)
1379 while (sctx->addrs[i] != NULL)
1381 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1382 _("Service `%s' runs at %s\n"),
1384 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1388 sctx->task (sctx->task_cls, tc->sched, sctx->server, sctx->cfg);
1393 * Detach from terminal.
1396 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1403 if (0 != PIPE (filedes))
1405 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1406 return GNUNET_SYSERR;
1411 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1412 return GNUNET_SYSERR;
1419 GNUNET_break (0 == CLOSE (filedes[1]));
1421 if (1 != READ (filedes[0], &c, sizeof (char)))
1422 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1429 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1430 _("Service process failed to initialize\n"));
1433 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1435 ("Service process could not initialize server function\n"));
1438 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1439 _("Service process failed to report status\n"));
1442 exit (1); /* child reported error */
1444 GNUNET_break (0 == CLOSE (0));
1445 GNUNET_break (0 == CLOSE (1));
1446 GNUNET_break (0 == CLOSE (filedes[0]));
1447 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1449 return GNUNET_SYSERR;
1450 /* set stdin/stdout to /dev/null */
1451 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1453 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1454 return GNUNET_SYSERR;
1456 /* Detach from controlling terminal */
1459 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1460 sctx->ready_confirm_fd = filedes[1];
1462 /* FIXME: we probably need to do something else
1463 elsewhere in order to fork the process itself... */
1474 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1478 if (NULL == (user = get_user_name (sctx)))
1479 return GNUNET_OK; /* keep */
1484 pws = getpwnam (user);
1487 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1488 _("Cannot obtain information about user `%s': %s\n"),
1489 user, errno == 0 ? _("No such user") : STRERROR (errno));
1491 return GNUNET_SYSERR;
1493 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1495 (0 != initgroups (user, pws->pw_gid)) ||
1497 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1499 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1500 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1502 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1503 _("Cannot change user/group to `%s': %s\n"), user,
1506 return GNUNET_SYSERR;
1516 * Delete the PID file that was created by our parent.
1519 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1521 char *pif = get_pid_file_name (sctx);
1523 return; /* no PID file */
1524 if (0 != UNLINK (pif))
1525 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1531 * Run a standard GNUnet service startup sequence (initialize loggers
1532 * and configuration, parse options).
1534 * @param argc number of command line arguments
1535 * @param argv command line arguments
1536 * @param serviceName our service name
1537 * @param opt service options
1538 * @param task main task of the service
1539 * @param task_cls closure for task
1540 * @return GNUNET_SYSERR on error, GNUNET_OK
1541 * if we shutdown nicely
1544 GNUNET_SERVICE_run (int argc,
1546 const char *serviceName,
1547 enum GNUNET_SERVICE_Options opt,
1548 GNUNET_SERVICE_Main task, void *task_cls)
1550 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1558 struct GNUNET_SERVICE_Context sctx;
1559 struct GNUNET_CONFIGURATION_Handle *cfg;
1560 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1561 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1562 {'d', "daemonize", NULL,
1563 gettext_noop ("do daemonize (detach from terminal)"), 0,
1564 GNUNET_GETOPT_set_one, &do_daemonize},
1565 GNUNET_GETOPT_OPTION_HELP (serviceName),
1566 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1567 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1568 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1569 GNUNET_GETOPT_OPTION_END
1574 loglev = GNUNET_strdup ("WARNING");
1575 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
1576 memset (&sctx, 0, sizeof (sctx));
1578 sctx.ready_confirm_fd = -1;
1579 sctx.ret = GNUNET_OK;
1580 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1581 sctx.maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1583 sctx.serviceName = serviceName;
1584 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1585 /* setup subsystems */
1586 if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1589 if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1591 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1593 if (GNUNET_OK != setup_service (&sctx))
1595 if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1597 if (GNUNET_OK != set_user_id (&sctx))
1600 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1601 "Service `%s' runs with configuration from `%s'\n",
1602 serviceName, cfg_fn);
1604 /* actually run service */
1605 GNUNET_SCHEDULER_run (&service_task, &sctx);
1608 if ((do_daemonize == 1) && (sctx.server != NULL))
1609 pid_file_delete (&sctx);
1610 GNUNET_free_non_null (sctx.my_handlers);
1613 if (sctx.ready_confirm_fd != -1)
1615 if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1616 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1617 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1620 GNUNET_CONFIGURATION_destroy (cfg);
1622 if (sctx.addrs != NULL)
1623 while (sctx.addrs[i] != NULL)
1624 GNUNET_free (sctx.addrs[i++]);
1625 GNUNET_free_non_null (sctx.addrs);
1626 GNUNET_free_non_null (sctx.addrlens);
1627 GNUNET_free_non_null (logfile);
1628 GNUNET_free (loglev);
1629 GNUNET_free (cfg_fn);
1630 GNUNET_free_non_null (sctx.v4_denied);
1631 GNUNET_free_non_null (sctx.v6_denied);
1632 GNUNET_free_non_null (sctx.v4_allowed);
1633 GNUNET_free_non_null (sctx.v6_allowed);
1635 return err ? GNUNET_SYSERR : sctx.ret;
1640 * Run a service startup sequence within an existing
1641 * initialized system.
1643 * @param serviceName our service name
1644 * @param sched scheduler to use
1645 * @param cfg configuration to use
1646 * @return NULL on error, service handle
1648 struct GNUNET_SERVICE_Context *
1649 GNUNET_SERVICE_start (const char *serviceName,
1650 struct GNUNET_SCHEDULER_Handle *sched,
1651 const struct GNUNET_CONFIGURATION_Handle *cfg)
1654 struct GNUNET_SERVICE_Context *sctx;
1656 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1657 sctx->ready_confirm_fd = -1; /* no daemonizing */
1658 sctx->ret = GNUNET_OK;
1659 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1660 sctx->maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1661 sctx->serviceName = serviceName;
1663 sctx->sched = sched;
1665 /* setup subsystems */
1666 if (GNUNET_OK != setup_service (sctx))
1668 GNUNET_SERVICE_stop (sctx);
1671 if (sctx->lsocks != NULL)
1672 sctx->server = GNUNET_SERVER_create_with_sockets (sched,
1677 sctx->timeout, sctx->require_found);
1679 sctx->server = GNUNET_SERVER_create (sched,
1686 sctx->require_found);
1688 if (NULL == sctx->server)
1690 GNUNET_SERVICE_stop (sctx);
1693 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1694 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1696 while ((sctx->my_handlers[i].callback != NULL))
1697 sctx->my_handlers[i++].callback_cls = sctx;
1698 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1703 * Obtain the server used by a service. Note that the server must NOT
1704 * be destroyed by the caller.
1706 * @param ctx the service context returned from the start function
1707 * @return handle to the server for this service, NULL if there is none
1709 struct GNUNET_SERVER_Handle *
1710 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1717 * Stop a service that was started with "GNUNET_SERVICE_start".
1719 * @param sctx the service context returned from the start function
1722 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1725 if (NULL != sctx->server)
1726 GNUNET_SERVER_destroy (sctx->server);
1727 GNUNET_free_non_null (sctx->my_handlers);
1728 if (sctx->addrs != NULL)
1731 while (sctx->addrs[i] != NULL)
1732 GNUNET_free (sctx->addrs[i++]);
1733 GNUNET_free (sctx->addrs);
1735 GNUNET_free_non_null (sctx->addrlens);
1736 GNUNET_free_non_null (sctx->v4_denied);
1737 GNUNET_free_non_null (sctx->v6_denied);
1738 GNUNET_free_non_null (sctx->v4_allowed);
1739 GNUNET_free_non_null (sctx->v6_allowed);
1744 /* end of service.c */