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 /* ******************* access control ******************** */
41 * @brief IPV4 network in CIDR notation.
45 struct in_addr network;
46 struct in_addr netmask;
50 * @brief network in CIDR notation for IPV6.
54 struct in6_addr network;
55 struct in6_addr netmask;
60 * Parse a network specification. The argument specifies
61 * a list of networks. The format is
62 * <tt>[network/netmask;]*</tt> (no whitespace, must be terminated
63 * with a semicolon). The network must be given in dotted-decimal
64 * notation. The netmask can be given in CIDR notation (/16) or
65 * in dotted-decimal (/255.255.0.0).
67 * @param routeList a string specifying the forbidden networks
68 * @return the converted list, NULL if the synatx is flawed
70 static struct IPv4NetworkSet *
71 parse_ipv4_specification (const char *routeList)
79 unsigned int temps[8];
81 struct IPv4NetworkSet *result;
83 if (routeList == NULL)
85 len = strlen (routeList);
89 for (i = 0; i < len; i++)
90 if (routeList[i] == ';')
92 result = GNUNET_malloc (sizeof (struct IPv4NetworkSet) * (count + 1));
94 memset (result, 0, sizeof (struct IPv4NetworkSet) * (count + 1));
99 cnt = sscanf (&routeList[pos],
100 "%u.%u.%u.%u/%u.%u.%u.%u;",
104 &temps[3], &temps[4], &temps[5], &temps[6], &temps[7]);
107 for (j = 0; j < 8; j++)
110 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
111 _("Invalid format for IP: `%s'\n"),
113 GNUNET_free (result);
116 result[i].network.s_addr
118 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
120 result[i].netmask.s_addr =
121 htonl ((temps[4] << 24) + (temps[5] << 16) + (temps[6] << 8) +
123 while (routeList[pos] != ';')
129 /* try second notation */
130 cnt = sscanf (&routeList[pos],
132 &temps[0], &temps[1], &temps[2], &temps[3], &slash);
135 for (j = 0; j < 4; j++)
138 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
139 _("Invalid format for IP: `%s'\n"),
141 GNUNET_free (result);
144 result[i].network.s_addr
146 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
148 if ((slash <= 32) && (slash >= 0))
150 result[i].netmask.s_addr = 0;
153 result[i].netmask.s_addr
154 = (result[i].netmask.s_addr >> 1) + 0x80000000;
157 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
158 while (routeList[pos] != ';')
166 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
168 ("Invalid network notation ('/%d' is not legal in IPv4 CIDR)."),
170 GNUNET_free (result);
171 return NULL; /* error */
174 /* try third notation */
176 cnt = sscanf (&routeList[pos],
178 &temps[0], &temps[1], &temps[2], &temps[3]);
181 for (j = 0; j < 4; j++)
184 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
185 _("Invalid format for IP: `%s'\n"),
187 GNUNET_free (result);
190 result[i].network.s_addr
192 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
194 result[i].netmask.s_addr = 0;
197 result[i].netmask.s_addr
198 = (result[i].netmask.s_addr >> 1) + 0x80000000;
201 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
202 while (routeList[pos] != ';')
208 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
209 _("Invalid format for IP: `%s'\n"), &routeList[pos]);
210 GNUNET_free (result);
211 return NULL; /* error */
213 if (pos < strlen (routeList))
215 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
216 _("Invalid format for IP: `%s'\n"), &routeList[pos]);
217 GNUNET_free (result);
218 return NULL; /* oops */
220 return result; /* ok */
225 * Parse a network specification. The argument specifies
226 * a list of networks. The format is
227 * <tt>[network/netmask;]*</tt> (no whitespace, must be terminated
228 * with a semicolon). The network must be given in colon-hex
229 * notation. The netmask must be given in CIDR notation (/16) or
230 * can be omitted to specify a single host.
232 * @param routeListX a string specifying the forbidden networks
233 * @return the converted list, NULL if the synatx is flawed
235 static struct IPv6NetworkSet *
236 parse_ipv6_specification (const char *routeListX)
246 struct IPv6NetworkSet *result;
251 if (routeListX == NULL)
253 len = strlen (routeListX);
256 routeList = GNUNET_strdup (routeListX);
258 for (i = 0; i < len; i++)
259 if (routeList[i] == ';')
261 if (routeList[len - 1] != ';')
263 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
265 ("Invalid network notation (does not end with ';': `%s')\n"),
267 GNUNET_free (routeList);
271 result = GNUNET_malloc (sizeof (struct IPv6NetworkSet) * (count + 1));
272 memset (result, 0, sizeof (struct IPv6NetworkSet) * (count + 1));
278 while (routeList[pos] != ';')
281 while ((slash >= start) && (routeList[slash] != '/'))
285 memset (&result[i].netmask, 0xFF, sizeof (struct in6_addr));
290 routeList[pos] = '\0';
291 ret = inet_pton (AF_INET6,
292 &routeList[slash + 1], &result[i].netmask);
296 if ((1 != SSCANF (&routeList[slash + 1],
297 "%u", &bits)) || (bits >= 128))
300 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
301 _("Wrong format `%s' for netmask\n"),
302 &routeList[slash + 1]);
306 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
309 GNUNET_free (result);
310 GNUNET_free (routeList);
316 result[i].netmask.s6_addr[off++] = 0xFF;
321 result[i].netmask.s6_addr[off]
322 = (result[i].netmask.s6_addr[off] >> 1) + 0x80;
327 routeList[slash] = '\0';
328 ret = inet_pton (AF_INET6, &routeList[start], &result[i].network);
332 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
333 _("Wrong format `%s' for network\n"),
334 &routeList[slash + 1]);
336 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "inet_pton");
337 GNUNET_free (result);
338 GNUNET_free (routeList);
344 GNUNET_free (routeList);
350 * Check if the given IP address is in the list of IP addresses.
352 * @param list a list of networks
353 * @param add the IP to check (in network byte order)
354 * @return GNUNET_NO if the IP is not in the list, GNUNET_YES if it it is
357 check_ipv4_listed (const struct IPv4NetworkSet *list,
358 const struct in_addr *add)
366 while ((list[i].network.s_addr != 0) || (list[i].netmask.s_addr != 0))
368 if ((add->s_addr & list[i].netmask.s_addr) ==
369 (list[i].network.s_addr & list[i].netmask.s_addr))
377 * Check if the given IP address is in the list of IP addresses.
379 * @param list a list of networks
380 * @param ip the IP to check (in network byte order)
381 * @return GNUNET_NO if the IP is not in the list, GNUNET_YES if it it is
384 check_ipv6_listed (const struct IPv6NetworkSet *list,
385 const struct in6_addr *ip)
389 struct in6_addr zero;
394 memset (&zero, 0, sizeof (struct in6_addr));
397 while (memcmp (&zero, &list[i].network, sizeof (struct in6_addr)) != 0)
399 for (j = 0; j < sizeof (struct in6_addr) / sizeof (int); j++)
400 if (((((int *) ip)[j] & ((int *) &list[i].netmask)[j])) !=
401 (((int *) &list[i].network)[j] & ((int *) &list[i].netmask)[j]))
412 /* ****************** service struct ****************** */
416 * Context for "service_task".
418 struct GNUNET_SERVICE_Context
423 const struct GNUNET_CONFIGURATION_Handle *cfg;
426 * Handle for the server.
428 struct GNUNET_SERVER_Handle *server;
431 * Scheduler for the server.
433 struct GNUNET_SCHEDULER_Handle *sched;
436 * Address to bind to.
438 struct sockaddr *addr;
441 * Name of our service.
443 const char *serviceName;
446 * Main service-specific task to run.
448 GNUNET_SERVICE_Main task;
456 * IPv4 addresses that are not allowed to connect.
458 struct IPv4NetworkSet *v4_denied;
461 * IPv6 addresses that are not allowed to connect.
463 struct IPv6NetworkSet *v6_denied;
466 * IPv4 addresses that are allowed to connect (if not
467 * set, all are allowed).
469 struct IPv4NetworkSet *v4_allowed;
472 * IPv6 addresses that are allowed to connect (if not
473 * set, all are allowed).
475 struct IPv6NetworkSet *v6_allowed;
478 * My (default) message handlers. Adjusted copy
481 struct GNUNET_SERVER_MessageHandler *my_handlers;
484 * Idle timeout for server.
486 struct GNUNET_TIME_Relative timeout;
489 * Maximum buffer size for the server.
494 * Overall success/failure of the service start.
499 * If we are daemonizing, this FD is set to the
500 * pipe to the parent. Send '.' if we started
501 * ok, '!' if not. -1 if we are not daemonizing.
503 int ready_confirm_fd;
506 * Do we close connections if we receive messages
507 * for which we have no handler?
512 * Can clients ask us to initiate a shutdown?
524 /* ****************** message handlers ****************** */
527 write_test (void *cls, size_t size, void *buf)
529 struct GNUNET_SERVER_Client *client = cls;
530 struct GNUNET_MessageHeader *msg;
532 if (size < sizeof (struct GNUNET_MessageHeader))
534 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
535 return 0; /* client disconnected */
537 msg = (struct GNUNET_MessageHeader *) buf;
538 msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
539 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
540 GNUNET_SERVER_receive_done (client, GNUNET_OK);
541 return sizeof (struct GNUNET_MessageHeader);
545 * Handler for TEST message.
547 * @param cls closure (refers to service)
548 * @param client identification of the client
549 * @param message the actual message
552 handle_test (void *cls,
553 struct GNUNET_SERVER_Client *client,
554 const struct GNUNET_MessageHeader *message)
556 /* simply bounce message back to acknowledge */
557 if (NULL == GNUNET_SERVER_notify_transmit_ready (client,
559 GNUNET_MessageHeader),
560 GNUNET_TIME_UNIT_FOREVER_REL,
561 &write_test, client))
562 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
567 * Handler for SHUTDOWN message.
569 * @param cls closure (refers to service)
570 * @param client identification of the client
571 * @param message the actual message
574 handle_shutdown (void *cls,
575 struct GNUNET_SERVER_Client *client,
576 const struct GNUNET_MessageHeader *message)
578 struct GNUNET_SERVICE_Context *service = cls;
579 if (!service->allow_shutdown)
581 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
583 ("Received shutdown request, but configured to ignore!\n"));
584 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
587 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
588 _("Initiating shutdown as requested by client.\n"));
589 GNUNET_assert (service->sched != NULL);
590 GNUNET_SCHEDULER_shutdown (service->sched);
591 GNUNET_SERVER_receive_done (client, GNUNET_OK);
596 * Default handlers for all services. Will be copied and the
597 * "callback_cls" fields will be replaced with the specific service
600 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
601 {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
602 sizeof (struct GNUNET_MessageHeader)},
603 {&handle_shutdown, NULL, GNUNET_MESSAGE_TYPE_SHUTDOWN,
604 sizeof (struct GNUNET_MessageHeader)},
610 /* ****************** service core routines ************** */
614 * Check if access to the service is allowed from the given address.
617 check_access (void *cls, const struct sockaddr *addr, socklen_t addrlen)
619 struct GNUNET_SERVICE_Context *sctx = cls;
620 const struct sockaddr_in *i4;
621 const struct sockaddr_in6 *i6;
624 switch (addr->sa_family)
627 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
628 i4 = (const struct sockaddr_in *) addr;
629 ret = ((sctx->v4_allowed == NULL) ||
630 (check_ipv4_listed (sctx->v4_allowed,
632 && ((sctx->v4_denied == NULL) ||
633 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
636 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
637 i6 = (const struct sockaddr_in6 *) addr;
638 ret = ((sctx->v6_allowed == NULL) ||
639 (check_ipv6_listed (sctx->v6_allowed,
641 && ((sctx->v6_denied == NULL) ||
642 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
645 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
646 _("Unknown address family %d\n"), addr->sa_family);
647 return GNUNET_SYSERR;
649 if (ret != GNUNET_OK)
651 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
652 _("Access from `%s' denied to service `%s'\n"),
653 GNUNET_a2s(addr, addrlen), sctx->serviceName);
660 * Get the name of the file where we will
661 * write the PID of the service.
664 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
670 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
679 * Parse an IPv4 access control list.
682 process_acl4 (struct IPv4NetworkSet **ret,
683 struct GNUNET_SERVICE_Context *sctx, const char *option)
687 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
689 GNUNET_break (GNUNET_OK ==
690 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
693 if (NULL == (*ret = parse_ipv4_specification (opt)))
695 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
697 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
698 opt, sctx->serviceName, option);
700 return GNUNET_SYSERR;
708 * Parse an IPv4 access control list.
711 process_acl6 (struct IPv6NetworkSet **ret,
712 struct GNUNET_SERVICE_Context *sctx, const char *option)
715 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
717 GNUNET_break (GNUNET_OK ==
718 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
721 if (NULL == (*ret = parse_ipv6_specification (opt)))
723 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
725 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
726 opt, sctx->serviceName, option);
728 return GNUNET_SYSERR;
736 * Setup addr, addrlen, maxbuf, idle_timeout
737 * based on configuration!
739 * Configuration must specify a "PORT". It may
741 * - TIMEOUT (after how many ms does an inactive service timeout);
742 * - MAXBUF (maximum incoming message size supported)
743 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
744 * - ALLOW_SHUTDOWN (allow clients to shutdown this service)
745 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
746 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
747 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
748 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
749 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
751 * @return GNUNET_OK if configuration succeeded
754 setup_service (struct GNUNET_SERVICE_Context *sctx)
756 unsigned long long maxbuf;
757 struct GNUNET_TIME_Relative idleout;
759 unsigned long long port;
761 struct addrinfo hints;
762 struct addrinfo *res;
763 struct addrinfo *pos;
767 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
768 sctx->serviceName, "TIMEOUT"))
771 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
773 "TIMEOUT", &idleout))
774 return GNUNET_SYSERR;
776 sctx->timeout = idleout;
779 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
780 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
781 sctx->serviceName, "MAXBUF"))
784 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
787 return GNUNET_SYSERR;
790 maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
791 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
792 sctx->serviceName, "DISABLEV6"))
795 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
798 return GNUNET_SYSERR;
801 disablev6 = GNUNET_NO;
802 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
803 sctx->serviceName, "ALLOW_SHUTDOWN"))
806 (sctx->allow_shutdown =
807 GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName,
809 return GNUNET_SYSERR;
812 sctx->allow_shutdown = GNUNET_NO;
816 struct GNUNET_NETWORK_Handle *desc;
818 /* probe IPv6 support */
819 desc = GNUNET_NETWORK_socket_socket (PF_INET6, SOCK_STREAM, 0);
822 if ((errno == ENOBUFS) ||
823 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
825 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
826 return GNUNET_SYSERR;
828 desc = GNUNET_NETWORK_socket_socket (PF_INET, SOCK_STREAM, 0);
831 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
833 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
834 sctx->serviceName, STRERROR (errno));
835 disablev6 = GNUNET_YES;
839 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
844 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
845 sctx->serviceName, "TOLERANT"))
848 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
851 return GNUNET_SYSERR;
854 tolerant = GNUNET_NO;
855 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
859 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
862 &port)) || (port > 65535))
864 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
866 ("Require valid port number for service `%s' in configuration!\n"),
868 return GNUNET_SYSERR;
870 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
871 sctx->serviceName, "BINDTO"))
873 GNUNET_break (GNUNET_OK ==
874 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
882 if (hostname != NULL)
884 memset (&hints, 0, sizeof (struct addrinfo));
886 hints.ai_family = AF_INET;
887 if ((0 != (ret = getaddrinfo (hostname,
888 NULL, &hints, &res))) || (res == NULL))
890 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
891 _("Failed to resolve `%s': %s\n"),
892 hostname, gai_strerror (ret));
893 GNUNET_free (hostname);
894 return GNUNET_SYSERR;
897 while ((NULL != pos) &&
899 (pos->ai_family != AF_INET)) ||
900 ((pos->ai_family != AF_INET) && (pos->ai_family != AF_INET6))))
904 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
905 _("Failed to find %saddress for `%s'.\n"),
906 disablev6 ? "IPv4 " : "", hostname);
908 GNUNET_free (hostname);
909 return GNUNET_SYSERR;
911 GNUNET_free (hostname);
912 if (pos->ai_family == AF_INET)
914 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
915 sctx->addrlen = pos->ai_addrlen;
916 sctx->addr = GNUNET_malloc (sctx->addrlen);
917 memcpy (sctx->addr, res->ai_addr, sctx->addrlen);
918 ((struct sockaddr_in *) sctx->addr)->sin_port = htons (port);
919 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
921 ("Configured to bind to %s address; %s connections to this service will fail!\n"),
926 GNUNET_assert (pos->ai_family == AF_INET6);
927 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
928 sctx->addrlen = pos->ai_addrlen;
929 sctx->addr = GNUNET_malloc (sctx->addrlen);
930 memcpy (sctx->addr, res->ai_addr, sctx->addrlen);
931 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
933 ("Configured to bind to %s address; %s connections to this service will fail!\n"),
935 ((struct sockaddr_in6 *) sctx->addr)->sin6_port = htons (port);
941 /* will bind against everything, just set port */
945 sctx->addrlen = sizeof (struct sockaddr_in);
946 sctx->addr = GNUNET_malloc (sctx->addrlen);
947 #if HAVE_SOCKADDR_IN_SIN_LEN
948 ((struct sockaddr_in *) sctx->addr)->sin_len = sctx->addrlen;
950 ((struct sockaddr_in *) sctx->addr)->sin_family = AF_INET;
951 ((struct sockaddr_in *) sctx->addr)->sin_port = htons (port);
952 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
954 ("Configured to bind to %s address; %s connections to this service will fail!\n"),
960 sctx->addrlen = sizeof (struct sockaddr_in6);
961 sctx->addr = GNUNET_malloc (sctx->addrlen);
962 #if HAVE_SOCKADDR_IN_SIN_LEN
963 ((struct sockaddr_in6 *) sctx->addr)->sin6_len = sctx->addrlen;
965 ((struct sockaddr_in6 *) sctx->addr)->sin6_family = AF_INET6;
966 ((struct sockaddr_in6 *) sctx->addr)->sin6_port = htons (port);
969 sctx->maxbuf = (size_t) maxbuf;
970 if (sctx->maxbuf != maxbuf)
972 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
974 ("Value in configuration for `%s' and service `%s' too large!\n"),
975 "MAXBUF", sctx->serviceName);
976 return GNUNET_SYSERR;
981 process_acl4 (&sctx->v4_denied,
985 process_acl4 (&sctx->v4_allowed,
989 process_acl6 (&sctx->v6_denied,
992 (GNUNET_OK != process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6")))
993 return GNUNET_SYSERR;
999 * Get the name of the user that'll be used
1000 * to provide the service.
1003 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1009 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1020 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1028 if (NULL == (pif = get_pid_file_name (sctx)))
1029 return GNUNET_OK; /* no file desired */
1030 user = get_user_name (sctx);
1031 rdir = GNUNET_strdup (pif);
1032 len = strlen (rdir);
1033 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1036 if (0 != ACCESS (rdir, F_OK))
1038 /* we get to create a directory -- and claim it
1040 GNUNET_DISK_directory_create (rdir);
1041 if ((user != NULL) && (0 < strlen (user)))
1042 GNUNET_DISK_file_change_owner (rdir, user);
1044 if (0 != ACCESS (rdir, W_OK | X_OK))
1046 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1048 GNUNET_free_non_null (user);
1050 return GNUNET_SYSERR;
1053 pidfd = FOPEN (pif, "w");
1056 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1058 GNUNET_free_non_null (user);
1059 return GNUNET_SYSERR;
1061 if (0 > FPRINTF (pidfd, "%u", pid))
1062 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1063 GNUNET_break (0 == fclose (pidfd));
1064 if ((user != NULL) && (0 < strlen (user)))
1065 GNUNET_DISK_file_change_owner (pif, user);
1066 GNUNET_free_non_null (user);
1073 * Initial task for the service.
1076 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1078 struct GNUNET_SERVICE_Context *sctx = cls;
1081 sctx->sched = tc->sched;
1082 sctx->server = GNUNET_SERVER_create (tc->sched,
1088 sctx->timeout, sctx->require_found);
1089 if (sctx->server == NULL)
1091 sctx->ret = GNUNET_SYSERR;
1094 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1095 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1097 while ((sctx->my_handlers[i].callback != NULL))
1098 sctx->my_handlers[i++].callback_cls = sctx;
1099 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1100 if (sctx->ready_confirm_fd != -1)
1102 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1103 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1104 sctx->ready_confirm_fd = -1;
1105 write_pid_file (sctx, getpid ());
1108 sctx->task (sctx->task_cls, tc->sched, sctx->server, sctx->cfg);
1113 * Detach from terminal.
1116 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1123 if (0 != PIPE (filedes))
1125 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1126 return GNUNET_SYSERR;
1131 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1132 return GNUNET_SYSERR;
1139 GNUNET_break (0 == CLOSE (filedes[1]));
1141 if (1 != READ (filedes[0], &c, sizeof (char)))
1142 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1149 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1150 _("Service process failed to initialize\n"));
1153 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1155 ("Service process could not initialize server function\n"));
1158 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1159 _("Service process failed to report status\n"));
1162 exit (1); /* child reported error */
1164 GNUNET_break (0 == CLOSE (0));
1165 GNUNET_break (0 == CLOSE (1));
1166 GNUNET_break (0 == CLOSE (filedes[0]));
1167 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1169 return GNUNET_SYSERR;
1170 /* set stdin/stdout to /dev/null */
1171 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1173 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1174 return GNUNET_SYSERR;
1176 /* Detach from controlling terminal */
1179 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1180 sctx->ready_confirm_fd = filedes[1];
1182 /* FIXME: we probably need to do something else
1183 elsewhere in order to fork the process itself... */
1194 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1198 if (NULL == (user = get_user_name (sctx)))
1199 return GNUNET_OK; /* keep */
1204 pws = getpwnam (user);
1207 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1208 _("Cannot obtain information about user `%s': %s\n"),
1209 user, errno == 0 ? _("No such user") : STRERROR (errno));
1211 return GNUNET_SYSERR;
1213 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1215 (0 != initgroups (user, pws->pw_gid)) ||
1217 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1219 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1220 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1222 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1223 _("Cannot change user/group to `%s': %s\n"), user,
1226 return GNUNET_SYSERR;
1236 * Delete the PID file that was created by our parent.
1239 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1241 char *pif = get_pid_file_name (sctx);
1243 return; /* no PID file */
1244 if (0 != UNLINK (pif))
1245 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1250 * Run a standard GNUnet service startup sequence (initialize loggers
1251 * and configuration, parse options).
1253 * @param argc number of command line arguments
1254 * @param argv command line arguments
1255 * @param serviceName our service name
1256 * @param task main task of the service
1257 * @param task_cls closure for task
1258 * @param term termination task of the service
1259 * @param term_cls closure for term
1260 * @return GNUNET_SYSERR on error, GNUNET_OK
1261 * if we shutdown nicely
1264 GNUNET_SERVICE_run (int argc,
1266 const char *serviceName,
1267 GNUNET_SERVICE_Main task,
1268 void *task_cls, GNUNET_SERVICE_Term term, void *term_cls)
1274 struct GNUNET_SERVICE_Context sctx;
1275 struct GNUNET_CONFIGURATION_Handle *cfg;
1276 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1277 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1278 {'d', "daemonize", NULL,
1279 gettext_noop ("do daemonize (detach from terminal)"), 0,
1280 GNUNET_GETOPT_set_one, &do_daemonize},
1281 GNUNET_GETOPT_OPTION_HELP (serviceName),
1282 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1283 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1284 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1285 GNUNET_GETOPT_OPTION_END
1289 loglev = GNUNET_strdup ("WARNING");
1290 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_DAEMON_CONFIG_FILE);
1291 memset (&sctx, 0, sizeof (sctx));
1292 sctx.ready_confirm_fd = -1;
1293 sctx.ret = GNUNET_OK;
1294 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1295 sctx.maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1297 sctx.serviceName = serviceName;
1298 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1299 /* setup subsystems */
1300 if ((GNUNET_SYSERR ==
1301 GNUNET_GETOPT_run (serviceName,
1306 GNUNET_log_setup (serviceName, loglev, logfile)) ||
1308 GNUNET_CONFIGURATION_load (cfg, cfg_fn)) ||
1310 setup_service (&sctx)) ||
1311 ((do_daemonize == 1) &&
1312 (GNUNET_OK != detach_terminal (&sctx))) ||
1313 (GNUNET_OK != set_user_id (&sctx)))
1315 if (sctx.ready_confirm_fd != -1)
1317 if (1 != WRITE (sctx.ready_confirm_fd, "I", 1))
1318 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1319 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1321 GNUNET_CONFIGURATION_destroy (cfg);
1322 GNUNET_free_non_null (sctx.addr);
1323 GNUNET_free_non_null (logfile);
1324 GNUNET_free (loglev);
1325 GNUNET_free (cfg_fn);
1326 GNUNET_free_non_null (sctx.v4_denied);
1327 GNUNET_free_non_null (sctx.v6_denied);
1328 GNUNET_free_non_null (sctx.v4_allowed);
1329 GNUNET_free_non_null (sctx.v6_allowed);
1330 return GNUNET_SYSERR;
1333 /* actually run service */
1334 GNUNET_SCHEDULER_run (&service_task, &sctx);
1335 if (sctx.ready_confirm_fd != -1)
1337 if (1 != WRITE (sctx.ready_confirm_fd, "S", 1))
1338 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1339 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1344 term (term_cls, sctx.cfg);
1345 if ((do_daemonize == 1) && (sctx.server != NULL))
1346 pid_file_delete (&sctx);
1347 if (sctx.server != NULL)
1348 GNUNET_SERVER_destroy (sctx.server);
1349 GNUNET_free_non_null (sctx.my_handlers);
1350 GNUNET_CONFIGURATION_destroy (cfg);
1351 GNUNET_free_non_null (sctx.addr);
1352 GNUNET_free_non_null (logfile);
1353 GNUNET_free (loglev);
1354 GNUNET_free (cfg_fn);
1355 GNUNET_free_non_null (sctx.v4_denied);
1356 GNUNET_free_non_null (sctx.v6_denied);
1357 GNUNET_free_non_null (sctx.v4_allowed);
1358 GNUNET_free_non_null (sctx.v6_allowed);
1364 * Run a service startup sequence within an existing
1365 * initialized system.
1367 * @param serviceName our service name
1368 * @param sched scheduler to use
1369 * @param cfg configuration to use
1370 * @return NULL on error, service handle
1372 struct GNUNET_SERVICE_Context *
1373 GNUNET_SERVICE_start (const char *serviceName,
1374 struct GNUNET_SCHEDULER_Handle *sched,
1375 const struct GNUNET_CONFIGURATION_Handle *cfg)
1378 struct GNUNET_SERVICE_Context *sctx;
1380 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1381 sctx->ready_confirm_fd = -1; /* no daemonizing */
1382 sctx->ret = GNUNET_OK;
1383 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1384 sctx->maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1385 sctx->serviceName = serviceName;
1387 sctx->sched = sched;
1389 /* setup subsystems */
1390 if ((GNUNET_OK != setup_service (sctx)) ||
1391 (NULL == (sctx->server = GNUNET_SERVER_create (sched,
1398 sctx->require_found))))
1400 GNUNET_SERVICE_stop (sctx);
1403 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1404 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1406 while ((sctx->my_handlers[i].callback != NULL))
1407 sctx->my_handlers[i++].callback_cls = sctx;
1408 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1415 * Obtain the server used by a service. Note that the server must NOT
1416 * be destroyed by the caller.
1418 * @param ctx the service context returned from the start function
1419 * @return handle to the server for this service, NULL if there is none
1421 struct GNUNET_SERVER_Handle *
1422 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1429 * Stop a service that was started with "GNUNET_SERVICE_start".
1431 * @param sctx the service context returned from the start function
1434 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1436 if (NULL != sctx->server)
1437 GNUNET_SERVER_destroy (sctx->server);
1438 GNUNET_free_non_null (sctx->my_handlers);
1439 GNUNET_free_non_null (sctx->addr);
1440 GNUNET_free_non_null (sctx->v4_denied);
1441 GNUNET_free_non_null (sctx->v6_denied);
1442 GNUNET_free_non_null (sctx->v4_allowed);
1443 GNUNET_free_non_null (sctx->v6_allowed);
1448 /* end of service.c */