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.
440 struct sockaddr **addrs;
443 * Name of our service.
445 const char *serviceName;
448 * Main service-specific task to run.
450 GNUNET_SERVICE_Main task;
458 * IPv4 addresses that are not allowed to connect.
460 struct IPv4NetworkSet *v4_denied;
463 * IPv6 addresses that are not allowed to connect.
465 struct IPv6NetworkSet *v6_denied;
468 * IPv4 addresses that are allowed to connect (if not
469 * set, all are allowed).
471 struct IPv4NetworkSet *v4_allowed;
474 * IPv6 addresses that are allowed to connect (if not
475 * set, all are allowed).
477 struct IPv6NetworkSet *v6_allowed;
480 * My (default) message handlers. Adjusted copy
483 struct GNUNET_SERVER_MessageHandler *my_handlers;
486 * Idle timeout for server.
488 struct GNUNET_TIME_Relative timeout;
491 * Maximum buffer size for the server.
496 * Overall success/failure of the service start.
501 * If we are daemonizing, this FD is set to the
502 * pipe to the parent. Send '.' if we started
503 * ok, '!' if not. -1 if we are not daemonizing.
505 int ready_confirm_fd;
508 * Do we close connections if we receive messages
509 * for which we have no handler?
514 * Can clients ask us to initiate a shutdown?
521 enum GNUNET_SERVICE_Options options;
524 * Array of the lengths of the entries in addrs.
526 socklen_t * addrlens;
531 /* ****************** message handlers ****************** */
534 write_test (void *cls, size_t size, void *buf)
536 struct GNUNET_SERVER_Client *client = cls;
537 struct GNUNET_MessageHeader *msg;
539 if (size < sizeof (struct GNUNET_MessageHeader))
541 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
542 return 0; /* client disconnected */
544 msg = (struct GNUNET_MessageHeader *) buf;
545 msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
546 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
547 GNUNET_SERVER_receive_done (client, GNUNET_OK);
548 return sizeof (struct GNUNET_MessageHeader);
552 * Handler for TEST message.
554 * @param cls closure (refers to service)
555 * @param client identification of the client
556 * @param message the actual message
559 handle_test (void *cls,
560 struct GNUNET_SERVER_Client *client,
561 const struct GNUNET_MessageHeader *message)
563 /* simply bounce message back to acknowledge */
564 if (NULL == GNUNET_SERVER_notify_transmit_ready (client,
566 GNUNET_MessageHeader),
567 GNUNET_TIME_UNIT_FOREVER_REL,
568 &write_test, client))
569 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
574 * Handler for SHUTDOWN message.
576 * @param cls closure (refers to service)
577 * @param client identification of the client
578 * @param message the actual message
581 handle_shutdown (void *cls,
582 struct GNUNET_SERVER_Client *client,
583 const struct GNUNET_MessageHeader *message)
585 struct GNUNET_SERVICE_Context *service = cls;
586 if (!service->allow_shutdown)
588 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
590 ("Received shutdown request, but configured to ignore!\n"));
591 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
594 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
595 _("Initiating shutdown as requested by client.\n"));
596 GNUNET_assert (service->sched != NULL);
597 GNUNET_SCHEDULER_shutdown (service->sched);
598 GNUNET_SERVER_receive_done (client, GNUNET_OK);
603 * Default handlers for all services. Will be copied and the
604 * "callback_cls" fields will be replaced with the specific service
607 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
608 {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
609 sizeof (struct GNUNET_MessageHeader)},
610 {&handle_shutdown, NULL, GNUNET_MESSAGE_TYPE_SHUTDOWN,
611 sizeof (struct GNUNET_MessageHeader)},
617 /* ****************** service core routines ************** */
621 * Check if access to the service is allowed from the given address.
624 check_access (void *cls, const struct sockaddr *addr, socklen_t addrlen)
626 struct GNUNET_SERVICE_Context *sctx = cls;
627 const struct sockaddr_in *i4;
628 const struct sockaddr_in6 *i6;
631 switch (addr->sa_family)
634 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
635 i4 = (const struct sockaddr_in *) addr;
636 ret = ((sctx->v4_allowed == NULL) ||
637 (check_ipv4_listed (sctx->v4_allowed,
639 && ((sctx->v4_denied == NULL) ||
640 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
643 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
644 i6 = (const struct sockaddr_in6 *) addr;
645 ret = ((sctx->v6_allowed == NULL) ||
646 (check_ipv6_listed (sctx->v6_allowed,
648 && ((sctx->v6_denied == NULL) ||
649 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
652 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
653 _("Unknown address family %d\n"), addr->sa_family);
654 return GNUNET_SYSERR;
656 if (ret != GNUNET_OK)
658 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
659 _("Access from `%s' denied to service `%s'\n"),
660 GNUNET_a2s (addr, addrlen), sctx->serviceName);
667 * Get the name of the file where we will
668 * write the PID of the service.
671 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
677 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
686 * Parse an IPv4 access control list.
689 process_acl4 (struct IPv4NetworkSet **ret,
690 struct GNUNET_SERVICE_Context *sctx, const char *option)
694 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
696 GNUNET_break (GNUNET_OK ==
697 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
700 if (NULL == (*ret = parse_ipv4_specification (opt)))
702 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
704 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
705 opt, sctx->serviceName, option);
707 return GNUNET_SYSERR;
715 * Parse an IPv4 access control list.
718 process_acl6 (struct IPv6NetworkSet **ret,
719 struct GNUNET_SERVICE_Context *sctx, const char *option)
722 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
724 GNUNET_break (GNUNET_OK ==
725 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
728 if (NULL == (*ret = parse_ipv6_specification (opt)))
730 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
732 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
733 opt, sctx->serviceName, option);
735 return GNUNET_SYSERR;
743 * Get the list of addresses that a server for the given service
746 * @param serviceName name of the service
747 * @param cfg configuration (which specifies the addresses)
748 * @param addrs set (call by reference) to an array of pointers to the
749 * addresses the server should bind to and listen on; the
750 * array will be NULL-terminated (on success)
751 * @param addr_lens set (call by reference) to an array of the lengths
752 * of the respective 'struct sockaddr' struct in the 'addrs'
754 * @return number of addresses found on success,
755 * GNUNET_SYSERR if the configuration
756 * did not specify reasonable finding information or
757 * if it specified a hostname that could not be resolved;
758 * GNUNET_NO if the number of addresses configured is
759 * zero (in this case, '*addrs' and '*addr_lens' will be
763 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
764 const struct GNUNET_CONFIGURATION_Handle *cfg,
765 struct sockaddr ***addrs,
766 socklen_t **addr_lens)
769 struct GNUNET_NETWORK_Handle *desc;
770 unsigned long long port;
771 struct addrinfo hints;
772 struct addrinfo *res;
773 struct addrinfo *pos;
774 struct addrinfo *next;
778 struct sockaddr **saddrs;
779 socklen_t *saddrlens;
785 if (GNUNET_CONFIGURATION_have_value (cfg,
786 serviceName, "DISABLEV6"))
789 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
792 return GNUNET_SYSERR;
795 disablev6 = GNUNET_NO;
799 /* probe IPv6 support */
800 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
803 if ((errno == ENOBUFS) ||
804 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
806 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
807 return GNUNET_SYSERR;
809 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
811 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
812 serviceName, STRERROR (errno));
813 disablev6 = GNUNET_YES;
817 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
823 GNUNET_CONFIGURATION_get_value_number (cfg,
826 &port)) || (port > 65535))
828 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
830 ("Require valid port number for service `%s' in configuration!\n"),
832 return GNUNET_SYSERR;
834 if (GNUNET_CONFIGURATION_have_value (cfg,
835 serviceName, "BINDTO"))
837 GNUNET_break (GNUNET_OK ==
838 GNUNET_CONFIGURATION_get_value_string (cfg,
846 if (hostname != NULL)
849 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
850 "Resolving `%s' since that is where `%s' will bind to.\n",
854 memset (&hints, 0, sizeof (struct addrinfo));
856 hints.ai_family = AF_INET;
857 if ((0 != (ret = getaddrinfo (hostname,
858 NULL, &hints, &res))) || (res == NULL))
860 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
861 _("Failed to resolve `%s': %s\n"),
862 hostname, gai_strerror (ret));
863 GNUNET_free (hostname);
864 return GNUNET_SYSERR;
868 while (NULL != (pos = next))
871 if ( (disablev6) && (pos->ai_family == AF_INET6))
877 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
878 _("Failed to find %saddress for `%s'.\n"),
879 disablev6 ? "IPv4 " : "", hostname);
881 GNUNET_free (hostname);
882 return GNUNET_SYSERR;
885 saddrs = GNUNET_malloc ((i+1) * sizeof(struct sockaddr*));
886 saddrlens = GNUNET_malloc ((i+1) * sizeof (socklen_t));
889 while (NULL != (pos = next))
892 if ( (disablev6) && (pos->ai_family == AF_INET6))
895 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
896 "Service `%s' will bind to `%s'\n",
898 GNUNET_a2s (pos->ai_addr,
901 if (pos->ai_family == AF_INET)
903 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
904 saddrlens[i] = pos->ai_addrlen;
905 saddrs[i] = GNUNET_malloc (saddrlens[i]);
906 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
907 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
911 GNUNET_assert (pos->ai_family == AF_INET6);
912 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
913 saddrlens[i] = pos->ai_addrlen;
914 saddrs[i] = GNUNET_malloc (saddrlens[i]);
915 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
916 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
920 GNUNET_free (hostname);
925 /* will bind against everything, just set port */
930 saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
931 saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
932 saddrlens[0] = sizeof (struct sockaddr_in);
933 saddrs[0] = GNUNET_malloc (saddrlens[0]);
934 #if HAVE_SOCKADDR_IN_SIN_LEN
935 ((struct sockaddr_in *) saddrs[0])->sin_len = saddrlens[0];
937 ((struct sockaddr_in *) saddrs[0])->sin_family = AF_INET;
938 ((struct sockaddr_in *) saddrs[0])->sin_port = htons (port);
944 saddrs = GNUNET_malloc (3 * sizeof(struct sockaddr*));
945 saddrlens = GNUNET_malloc (3 * sizeof (socklen_t));
947 saddrlens[0] = sizeof (struct sockaddr_in6);
948 saddrs[0] = GNUNET_malloc (saddrlens[0]);
949 #if HAVE_SOCKADDR_IN_SIN_LEN
950 ((struct sockaddr_in6 *) saddrs[0])->sin6_len = saddrlens[0];
952 ((struct sockaddr_in6 *) saddrs[0])->sin6_family = AF_INET6;
953 ((struct sockaddr_in6 *) saddrs[0])->sin6_port = htons (port);
955 saddrlens[1] = sizeof (struct sockaddr_in);
956 saddrs[1] = GNUNET_malloc (saddrlens[1]);
957 #if HAVE_SOCKADDR_IN_SIN_LEN
958 ((struct sockaddr_in *) saddrs[1])->sin_len = saddrlens[1];
960 ((struct sockaddr_in *) saddrs[1])->sin_family = AF_INET;
961 ((struct sockaddr_in *) saddrs[1])->sin_port = htons (port);
966 *addr_lens = saddrlens;
972 * Setup addr, addrlen, maxbuf, idle_timeout
973 * based on configuration!
975 * Configuration must specify a "PORT". It may
977 * - TIMEOUT (after how many ms does an inactive service timeout);
978 * - MAXBUF (maximum incoming message size supported)
979 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
980 * - ALLOW_SHUTDOWN (allow clients to shutdown this service)
981 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
982 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
983 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
984 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
985 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
987 * @return GNUNET_OK if configuration succeeded
990 setup_service (struct GNUNET_SERVICE_Context *sctx)
992 unsigned long long maxbuf;
993 struct GNUNET_TIME_Relative idleout;
996 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
997 sctx->serviceName, "TIMEOUT"))
1000 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
1002 "TIMEOUT", &idleout))
1003 return GNUNET_SYSERR;
1005 sctx->timeout = idleout;
1008 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1009 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1010 sctx->serviceName, "MAXBUF"))
1013 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
1016 return GNUNET_SYSERR;
1019 maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1020 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1021 sctx->serviceName, "ALLOW_SHUTDOWN"))
1023 if (GNUNET_SYSERR ==
1024 (sctx->allow_shutdown =
1025 GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName,
1027 return GNUNET_SYSERR;
1030 sctx->allow_shutdown = GNUNET_NO;
1033 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1034 sctx->serviceName, "TOLERANT"))
1036 if (GNUNET_SYSERR ==
1037 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1040 return GNUNET_SYSERR;
1043 tolerant = GNUNET_NO;
1045 if (GNUNET_SYSERR ==
1046 GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1050 return GNUNET_SYSERR;
1051 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1052 sctx->maxbuf = (size_t) maxbuf;
1053 if (sctx->maxbuf != maxbuf)
1055 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1057 ("Value in configuration for `%s' and service `%s' too large!\n"),
1058 "MAXBUF", sctx->serviceName);
1059 return GNUNET_SYSERR;
1062 process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1063 process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1064 process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1065 process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1072 * Get the name of the user that'll be used
1073 * to provide the service.
1076 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1082 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1093 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1101 if (NULL == (pif = get_pid_file_name (sctx)))
1102 return GNUNET_OK; /* no file desired */
1103 user = get_user_name (sctx);
1104 rdir = GNUNET_strdup (pif);
1105 len = strlen (rdir);
1106 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1109 if (0 != ACCESS (rdir, F_OK))
1111 /* we get to create a directory -- and claim it
1113 GNUNET_DISK_directory_create (rdir);
1114 if ((user != NULL) && (0 < strlen (user)))
1115 GNUNET_DISK_file_change_owner (rdir, user);
1117 if (0 != ACCESS (rdir, W_OK | X_OK))
1119 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1121 GNUNET_free_non_null (user);
1123 return GNUNET_SYSERR;
1126 pidfd = FOPEN (pif, "w");
1129 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1131 GNUNET_free_non_null (user);
1132 return GNUNET_SYSERR;
1134 if (0 > FPRINTF (pidfd, "%u", pid))
1135 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1136 GNUNET_break (0 == fclose (pidfd));
1137 if ((user != NULL) && (0 < strlen (user)))
1138 GNUNET_DISK_file_change_owner (pif, user);
1139 GNUNET_free_non_null (user);
1146 * Task run during shutdown.
1152 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1154 struct GNUNET_SERVER_Handle *server = cls;
1156 GNUNET_SERVER_destroy (server);
1161 * Initial task for the service.
1164 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1166 struct GNUNET_SERVICE_Context *sctx = cls;
1169 sctx->sched = tc->sched;
1170 sctx->server = GNUNET_SERVER_create (tc->sched,
1176 sctx->timeout, sctx->require_found);
1177 if (sctx->server == NULL)
1180 while (sctx->addrs[i] != NULL)
1182 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1183 _("Failed to start `%s' at `%s'\n"),
1185 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1188 sctx->ret = GNUNET_SYSERR;
1191 if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1193 /* install a task that will kill the server
1194 process if the scheduler ever gets a shutdown signal */
1195 GNUNET_SCHEDULER_add_delayed (tc->sched,
1196 GNUNET_TIME_UNIT_FOREVER_REL,
1197 &shutdown_task, sctx->server);
1199 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1200 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1202 while ((sctx->my_handlers[i].callback != NULL))
1203 sctx->my_handlers[i++].callback_cls = sctx;
1204 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1205 if (sctx->ready_confirm_fd != -1)
1207 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1208 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1209 sctx->ready_confirm_fd = -1;
1210 write_pid_file (sctx, getpid ());
1213 while (sctx->addrs[i] != NULL)
1215 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1216 _("Service `%s' runs at %s\n"),
1218 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1221 sctx->task (sctx->task_cls, tc->sched, sctx->server, sctx->cfg);
1226 * Detach from terminal.
1229 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1236 if (0 != PIPE (filedes))
1238 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1239 return GNUNET_SYSERR;
1244 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1245 return GNUNET_SYSERR;
1252 GNUNET_break (0 == CLOSE (filedes[1]));
1254 if (1 != READ (filedes[0], &c, sizeof (char)))
1255 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1262 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1263 _("Service process failed to initialize\n"));
1266 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1268 ("Service process could not initialize server function\n"));
1271 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1272 _("Service process failed to report status\n"));
1275 exit (1); /* child reported error */
1277 GNUNET_break (0 == CLOSE (0));
1278 GNUNET_break (0 == CLOSE (1));
1279 GNUNET_break (0 == CLOSE (filedes[0]));
1280 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1282 return GNUNET_SYSERR;
1283 /* set stdin/stdout to /dev/null */
1284 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1286 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1287 return GNUNET_SYSERR;
1289 /* Detach from controlling terminal */
1292 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1293 sctx->ready_confirm_fd = filedes[1];
1295 /* FIXME: we probably need to do something else
1296 elsewhere in order to fork the process itself... */
1307 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1311 if (NULL == (user = get_user_name (sctx)))
1312 return GNUNET_OK; /* keep */
1317 pws = getpwnam (user);
1320 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1321 _("Cannot obtain information about user `%s': %s\n"),
1322 user, errno == 0 ? _("No such user") : STRERROR (errno));
1324 return GNUNET_SYSERR;
1326 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1328 (0 != initgroups (user, pws->pw_gid)) ||
1330 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1332 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1333 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1335 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1336 _("Cannot change user/group to `%s': %s\n"), user,
1339 return GNUNET_SYSERR;
1349 * Delete the PID file that was created by our parent.
1352 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1354 char *pif = get_pid_file_name (sctx);
1356 return; /* no PID file */
1357 if (0 != UNLINK (pif))
1358 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1364 * Run a standard GNUnet service startup sequence (initialize loggers
1365 * and configuration, parse options).
1367 * @param argc number of command line arguments
1368 * @param argv command line arguments
1369 * @param serviceName our service name
1370 * @param opt service options
1371 * @param task main task of the service
1372 * @param task_cls closure for task
1373 * @return GNUNET_SYSERR on error, GNUNET_OK
1374 * if we shutdown nicely
1377 GNUNET_SERVICE_run (int argc,
1379 const char *serviceName,
1380 enum GNUNET_SERVICE_Options opt,
1381 GNUNET_SERVICE_Main task, void *task_cls)
1383 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1391 struct GNUNET_SERVICE_Context sctx;
1392 struct GNUNET_CONFIGURATION_Handle *cfg;
1393 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1394 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1395 {'d', "daemonize", NULL,
1396 gettext_noop ("do daemonize (detach from terminal)"), 0,
1397 GNUNET_GETOPT_set_one, &do_daemonize},
1398 GNUNET_GETOPT_OPTION_HELP (serviceName),
1399 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1400 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1401 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1402 GNUNET_GETOPT_OPTION_END
1407 loglev = GNUNET_strdup ("WARNING");
1408 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_DAEMON_CONFIG_FILE);
1409 memset (&sctx, 0, sizeof (sctx));
1411 sctx.ready_confirm_fd = -1;
1412 sctx.ret = GNUNET_OK;
1413 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1414 sctx.maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1416 sctx.serviceName = serviceName;
1417 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1418 /* setup subsystems */
1419 if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1422 if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1424 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1426 if (GNUNET_OK != setup_service (&sctx))
1428 if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1430 if (GNUNET_OK != set_user_id (&sctx))
1433 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1434 "Service `%s' runs with configuration from `%s'\n",
1435 serviceName, cfg_fn);
1437 /* actually run service */
1438 GNUNET_SCHEDULER_run (&service_task, &sctx);
1441 if ((do_daemonize == 1) && (sctx.server != NULL))
1442 pid_file_delete (&sctx);
1443 GNUNET_free_non_null (sctx.my_handlers);
1446 if (sctx.ready_confirm_fd != -1)
1448 if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1449 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1450 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1453 GNUNET_CONFIGURATION_destroy (cfg);
1455 while (sctx.addrs[i] != NULL)
1456 GNUNET_free (sctx.addrs[i++]);
1457 GNUNET_free_non_null (sctx.addrs);
1458 GNUNET_free_non_null (sctx.addrlens);
1459 GNUNET_free_non_null (logfile);
1460 GNUNET_free (loglev);
1461 GNUNET_free (cfg_fn);
1462 GNUNET_free_non_null (sctx.v4_denied);
1463 GNUNET_free_non_null (sctx.v6_denied);
1464 GNUNET_free_non_null (sctx.v4_allowed);
1465 GNUNET_free_non_null (sctx.v6_allowed);
1467 return err ? GNUNET_SYSERR : sctx.ret;
1472 * Run a service startup sequence within an existing
1473 * initialized system.
1475 * @param serviceName our service name
1476 * @param sched scheduler to use
1477 * @param cfg configuration to use
1478 * @return NULL on error, service handle
1480 struct GNUNET_SERVICE_Context *
1481 GNUNET_SERVICE_start (const char *serviceName,
1482 struct GNUNET_SCHEDULER_Handle *sched,
1483 const struct GNUNET_CONFIGURATION_Handle *cfg)
1486 struct GNUNET_SERVICE_Context *sctx;
1488 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1489 sctx->ready_confirm_fd = -1; /* no daemonizing */
1490 sctx->ret = GNUNET_OK;
1491 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1492 sctx->maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1493 sctx->serviceName = serviceName;
1495 sctx->sched = sched;
1497 /* setup subsystems */
1498 if ((GNUNET_OK != setup_service (sctx)) ||
1499 (NULL == (sctx->server = GNUNET_SERVER_create (sched,
1506 sctx->require_found))))
1508 GNUNET_SERVICE_stop (sctx);
1511 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1512 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1514 while ((sctx->my_handlers[i].callback != NULL))
1515 sctx->my_handlers[i++].callback_cls = sctx;
1516 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1521 * Obtain the server used by a service. Note that the server must NOT
1522 * be destroyed by the caller.
1524 * @param ctx the service context returned from the start function
1525 * @return handle to the server for this service, NULL if there is none
1527 struct GNUNET_SERVER_Handle *
1528 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1535 * Stop a service that was started with "GNUNET_SERVICE_start".
1537 * @param sctx the service context returned from the start function
1540 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1543 if (NULL != sctx->server)
1544 GNUNET_SERVER_destroy (sctx->server);
1545 GNUNET_free_non_null (sctx->my_handlers);
1547 while (sctx->addrs[i] != NULL)
1548 GNUNET_free (sctx->addrs[i++]);
1549 GNUNET_free_non_null (sctx->addrs);
1550 GNUNET_free_non_null (sctx->addrlens);
1551 GNUNET_free_non_null (sctx->v4_denied);
1552 GNUNET_free_non_null (sctx->v6_denied);
1553 GNUNET_free_non_null (sctx->v4_allowed);
1554 GNUNET_free_non_null (sctx->v6_allowed);
1559 /* end of service.c */