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 routeList 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 ip 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 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;
623 char buf[INET6_ADDRSTRLEN];
626 switch (addr->sa_family)
629 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
630 i4 = (const struct sockaddr_in *) addr;
631 port = ntohs (i4->sin_port);
632 ret = ((sctx->v4_allowed == NULL) ||
633 (check_ipv4_listed (sctx->v4_allowed,
635 && ((sctx->v4_denied == NULL) ||
636 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
637 if (ret != GNUNET_OK)
638 inet_ntop (AF_INET, &i4->sin_addr, buf, sizeof (buf));
641 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
642 i6 = (const struct sockaddr_in6 *) addr;
643 port = ntohs (i6->sin6_port);
644 ret = ((sctx->v6_allowed == NULL) ||
645 (check_ipv6_listed (sctx->v6_allowed,
647 && ((sctx->v6_denied == NULL) ||
648 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
649 if (ret != GNUNET_OK)
650 inet_ntop (AF_INET6, &i6->sin6_addr, buf, sizeof (buf));
653 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
654 _("Unknown address family %d\n"), addr->sa_family);
655 return GNUNET_SYSERR;
657 if (ret != GNUNET_OK)
659 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
660 _("Access from `%s:%u' denied to service `%s'\n"),
661 buf, port, sctx->serviceName);
668 * Get the name of the file where we will
669 * write the PID of the service.
672 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
678 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
687 * Parse an IPv4 access control list.
690 process_acl4 (struct IPv4NetworkSet **ret,
691 struct GNUNET_SERVICE_Context *sctx, const char *option)
695 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
697 GNUNET_break (GNUNET_OK ==
698 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
701 if (NULL == (*ret = parse_ipv4_specification (opt)))
703 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
705 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
706 opt, sctx->serviceName, option);
708 return GNUNET_SYSERR;
716 * Parse an IPv4 access control list.
719 process_acl6 (struct IPv6NetworkSet **ret,
720 struct GNUNET_SERVICE_Context *sctx, const char *option)
723 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
725 GNUNET_break (GNUNET_OK ==
726 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
729 if (NULL == (*ret = parse_ipv6_specification (opt)))
731 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
733 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
734 opt, sctx->serviceName, option);
736 return GNUNET_SYSERR;
744 * Setup addr, addrlen, maxbuf, idle_timeout
745 * based on configuration!
747 * Configuration must specify a "PORT". It may
749 * - TIMEOUT (after how many ms does an inactive service timeout);
750 * - MAXBUF (maximum incoming message size supported)
751 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
752 * - ALLOW_SHUTDOWN (allow clients to shutdown this service)
753 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
754 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
755 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
756 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
757 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
759 * @return GNUNET_OK if configuration succeeded
762 setup_service (struct GNUNET_SERVICE_Context *sctx)
764 unsigned long long maxbuf;
765 unsigned long long idleout;
767 unsigned long long port;
769 struct addrinfo hints;
770 struct addrinfo *res;
771 struct addrinfo *pos;
775 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
776 sctx->serviceName, "TIMEOUT"))
779 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
781 "TIMEOUT", &idleout))
782 return GNUNET_SYSERR;
784 sctx->timeout.value = idleout;
787 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
788 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
789 sctx->serviceName, "MAXBUF"))
792 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
795 return GNUNET_SYSERR;
798 maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
799 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
800 sctx->serviceName, "DISABLEV6"))
803 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
806 return GNUNET_SYSERR;
809 disablev6 = GNUNET_NO;
810 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
811 sctx->serviceName, "ALLOW_SHUTDOWN"))
814 (sctx->allow_shutdown =
815 GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName,
817 return GNUNET_SYSERR;
820 sctx->allow_shutdown = GNUNET_NO;
824 /* probe IPv6 support */
825 ret = SOCKET (PF_INET6, SOCK_STREAM, 0);
828 if ((errno == ENOBUFS) ||
829 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
831 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
832 return GNUNET_SYSERR;
834 ret = SOCKET (PF_INET, SOCK_STREAM, 0);
837 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
839 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
840 sctx->serviceName, strerror (errno));
841 disablev6 = GNUNET_YES;
845 GNUNET_break (0 == CLOSE (ret));
850 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
851 sctx->serviceName, "TOLERANT"))
854 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
857 return GNUNET_SYSERR;
860 tolerant = GNUNET_NO;
861 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
865 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
868 &port)) || (port > 65535))
870 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
872 ("Require valid port number for service `%s' in configuration!\n"),
874 return GNUNET_SYSERR;
876 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
877 sctx->serviceName, "BINDTO"))
879 GNUNET_break (GNUNET_OK ==
880 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
888 if (hostname != NULL)
890 memset (&hints, 0, sizeof (struct addrinfo));
892 hints.ai_family = AF_INET;
893 if ((0 != (ret = getaddrinfo (hostname,
894 NULL, &hints, &res))) || (res == NULL))
896 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
897 _("Failed to resolve `%s': %s\n"),
898 hostname, gai_strerror (ret));
899 GNUNET_free (hostname);
900 return GNUNET_SYSERR;
903 while ((NULL != pos) &&
905 (pos->ai_family != AF_INET)) ||
906 ((pos->ai_family != AF_INET) && (pos->ai_family != AF_INET6))))
910 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
911 _("Failed to find IPv4 address for `%s'.\n"), hostname);
913 GNUNET_free (hostname);
914 return GNUNET_SYSERR;
916 GNUNET_free (hostname);
917 if (pos->ai_family == AF_INET)
919 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
920 sctx->addrlen = pos->ai_addrlen;
921 sctx->addr = GNUNET_malloc (sctx->addrlen);
922 memcpy (sctx->addr, res->ai_addr, sctx->addrlen);
923 ((struct sockaddr_in *) sctx->addr)->sin_port = htons (port);
924 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
926 ("Configured to bind to %s address; %s connections to this service will fail!\n"),
931 GNUNET_assert (pos->ai_family == AF_INET6);
932 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
933 sctx->addrlen = pos->ai_addrlen;
934 sctx->addr = GNUNET_malloc (sctx->addrlen);
935 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
937 ("Configured to bind to %s address; %s connections to this service will fail!\n"),
939 ((struct sockaddr_in6 *) sctx->addr)->sin6_port = htons (port);
945 /* will bind against everything, just set port */
949 sctx->addrlen = sizeof (struct sockaddr_in6);
950 sctx->addr = GNUNET_malloc (sctx->addrlen);
951 ((struct sockaddr_in *) sctx->addr)->sin_family = AF_INET;
952 ((struct sockaddr_in *) sctx->addr)->sin_port = htons (port);
953 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
955 ("Configured to bind to %s address; %s connections to this service will fail!\n"),
961 sctx->addrlen = sizeof (struct sockaddr_in6);
962 sctx->addr = GNUNET_malloc (sctx->addrlen);
963 ((struct sockaddr_in6 *) sctx->addr)->sin6_family = AF_INET6;
964 ((struct sockaddr_in6 *) sctx->addr)->sin6_port = htons (port);
967 sctx->maxbuf = (size_t) maxbuf;
968 if (sctx->maxbuf != maxbuf)
970 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
972 ("Value in configuration for `%s' and service `%s' too large!\n"),
973 "MAXBUF", sctx->serviceName);
974 return GNUNET_SYSERR;
979 process_acl4 (&sctx->v4_denied,
983 process_acl4 (&sctx->v4_allowed,
987 process_acl6 (&sctx->v6_denied,
990 (GNUNET_OK != process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6")))
991 return GNUNET_SYSERR;
997 * Get the name of the user that'll be used
998 * to provide the service.
1001 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1007 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1018 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1026 if (NULL == (pif = get_pid_file_name (sctx)))
1027 return GNUNET_OK; /* no file desired */
1028 user = get_user_name (sctx);
1029 rdir = GNUNET_strdup (pif);
1030 len = strlen (rdir);
1031 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1034 if (0 != ACCESS (rdir, F_OK))
1036 /* we get to create a directory -- and claim it
1038 GNUNET_DISK_directory_create (rdir);
1039 if ((user != NULL) && (0 < strlen (user)))
1040 GNUNET_DISK_file_change_owner (rdir, user);
1042 if (0 != ACCESS (rdir, W_OK | X_OK))
1044 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1046 GNUNET_free_non_null (user);
1048 return GNUNET_SYSERR;
1051 pidfd = FOPEN (pif, "w");
1054 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1056 GNUNET_free_non_null (user);
1057 return GNUNET_SYSERR;
1059 if (0 > FPRINTF (pidfd, "%u", pid))
1060 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1061 GNUNET_break (0 == fclose (pidfd));
1062 if ((user != NULL) && (0 < strlen (user)))
1063 GNUNET_DISK_file_change_owner (pif, user);
1064 GNUNET_free_non_null (user);
1071 * Initial task for the service.
1074 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1076 struct GNUNET_SERVICE_Context *sctx = cls;
1079 sctx->sched = tc->sched;
1080 sctx->server = GNUNET_SERVER_create (tc->sched,
1086 sctx->timeout, sctx->require_found);
1087 if (sctx->server == NULL)
1089 sctx->ret = GNUNET_SYSERR;
1092 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1093 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1095 while ((sctx->my_handlers[i].callback != NULL))
1096 sctx->my_handlers[i++].callback_cls = sctx;
1097 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1098 if (sctx->ready_confirm_fd != -1)
1100 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1101 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1102 sctx->ready_confirm_fd = -1;
1103 write_pid_file (sctx, getpid ());
1106 sctx->task (sctx->task_cls, tc->sched, sctx->server, sctx->cfg);
1111 * Detach from terminal.
1114 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1121 if (0 != PIPE (filedes))
1123 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1124 return GNUNET_SYSERR;
1129 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1130 return GNUNET_SYSERR;
1137 GNUNET_break (0 == CLOSE (filedes[1]));
1139 if (1 != READ (filedes[0], &c, sizeof (char)))
1140 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1147 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1148 _("Service process failed to initialize\n"));
1151 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1153 ("Service process could not initialize server function\n"));
1156 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1157 _("Service process failed to report status\n"));
1160 exit (1); /* child reported error */
1162 GNUNET_break (0 == CLOSE (0));
1163 GNUNET_break (0 == CLOSE (1));
1164 GNUNET_break (0 == CLOSE (filedes[0]));
1165 nullfd = GNUNET_DISK_file_open ("/dev/null", O_RDWR | O_APPEND);
1167 return GNUNET_SYSERR;
1168 /* set stdin/stdout to /dev/null */
1169 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1171 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1172 return GNUNET_SYSERR;
1174 /* Detach from controlling terminal */
1177 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1178 sctx->ready_confirm_fd = filedes[1];
1180 /* FIXME: we probably need to do something else
1181 elsewhere in order to fork the process itself... */
1192 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1196 if (NULL == (user = get_user_name (sctx)))
1197 return GNUNET_OK; /* keep */
1202 pws = getpwnam (user);
1205 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1206 _("Cannot obtain information about user `%s': %s\n"),
1207 user, errno == 0 ? _("No such user") : STRERROR (errno));
1209 return GNUNET_SYSERR;
1211 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1213 (0 != initgroups (user, pws->pw_gid)) ||
1215 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1217 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1218 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1220 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1221 _("Cannot change user/group to `%s': %s\n"), user,
1224 return GNUNET_SYSERR;
1234 * Delete the PID file that was created by our parent.
1237 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1239 char *pif = get_pid_file_name (sctx);
1241 return; /* no PID file */
1242 if (0 != UNLINK (pif))
1243 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1248 * Run a standard GNUnet service startup sequence (initialize loggers
1249 * and configuration, parse options).
1251 * @param argc number of command line arguments
1252 * @param argv command line arguments
1253 * @param serviceName our service name
1254 * @param task main task of the service
1255 * @param task_cls closure for task
1256 * @param term termination task of the service
1257 * @param term_cls closure for term
1258 * @return GNUNET_SYSERR on error, GNUNET_OK
1259 * if we shutdown nicely
1262 GNUNET_SERVICE_run (int argc,
1264 const char *serviceName,
1265 GNUNET_SERVICE_Main task,
1266 void *task_cls, GNUNET_SERVICE_Term term, void *term_cls)
1272 struct GNUNET_SERVICE_Context sctx;
1273 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1274 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1275 {'d', "daemonize", NULL,
1276 gettext_noop ("do daemonize (detach from terminal)"), 0,
1277 GNUNET_GETOPT_set_one, &do_daemonize},
1278 GNUNET_GETOPT_OPTION_HELP (serviceName),
1279 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1280 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1281 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1282 GNUNET_GETOPT_OPTION_END
1286 loglev = GNUNET_strdup ("WARNING");
1287 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_DAEMON_CONFIG_FILE);
1288 memset (&sctx, 0, sizeof (sctx));
1289 sctx.ready_confirm_fd = -1;
1290 sctx.ret = GNUNET_OK;
1291 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1292 sctx.maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1294 sctx.serviceName = serviceName;
1295 sctx.cfg = GNUNET_CONFIGURATION_create ();
1296 /* setup subsystems */
1297 if ((GNUNET_SYSERR ==
1298 GNUNET_GETOPT_run (serviceName,
1304 GNUNET_log_setup (serviceName, loglev, logfile)) ||
1306 GNUNET_CONFIGURATION_load (sctx.cfg, cfg_fn)) ||
1308 setup_service (&sctx)) ||
1309 ((do_daemonize == 1) &&
1310 (GNUNET_OK != detach_terminal (&sctx))) ||
1311 (GNUNET_OK != set_user_id (&sctx)))
1313 if (sctx.ready_confirm_fd != -1)
1315 if (1 != WRITE (sctx.ready_confirm_fd, "I", 1))
1316 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1317 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1319 GNUNET_CONFIGURATION_destroy (sctx.cfg);
1320 GNUNET_free_non_null (sctx.addr);
1321 GNUNET_free_non_null (logfile);
1322 GNUNET_free (loglev);
1323 GNUNET_free (cfg_fn);
1324 GNUNET_free_non_null (sctx.v4_denied);
1325 GNUNET_free_non_null (sctx.v6_denied);
1326 GNUNET_free_non_null (sctx.v4_allowed);
1327 GNUNET_free_non_null (sctx.v6_allowed);
1328 return GNUNET_SYSERR;
1331 /* actually run service */
1332 GNUNET_SCHEDULER_run (&service_task, &sctx);
1333 if (sctx.ready_confirm_fd != -1)
1335 if (1 != WRITE (sctx.ready_confirm_fd, "S", 1))
1336 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1337 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1342 term (term_cls, sctx.cfg);
1343 if ((do_daemonize == 1) && (sctx.server != NULL))
1344 pid_file_delete (&sctx);
1345 if (sctx.server != NULL)
1346 GNUNET_SERVER_destroy (sctx.server);
1347 GNUNET_free_non_null (sctx.my_handlers);
1348 GNUNET_CONFIGURATION_destroy (sctx.cfg);
1349 GNUNET_free_non_null (sctx.addr);
1350 GNUNET_free_non_null (logfile);
1351 GNUNET_free (loglev);
1352 GNUNET_free (cfg_fn);
1353 GNUNET_free_non_null (sctx.v4_denied);
1354 GNUNET_free_non_null (sctx.v6_denied);
1355 GNUNET_free_non_null (sctx.v4_allowed);
1356 GNUNET_free_non_null (sctx.v6_allowed);
1362 * Run a service startup sequence within an existing
1363 * initialized system.
1365 * @param serviceName our service name
1366 * @param sched scheduler to use
1367 * @param cfg configuration to use
1368 * @return NULL on error, service handle
1370 struct GNUNET_SERVICE_Context *
1371 GNUNET_SERVICE_start (const char *serviceName,
1372 struct GNUNET_SCHEDULER_Handle *sched,
1373 struct GNUNET_CONFIGURATION_Handle *cfg)
1376 struct GNUNET_SERVICE_Context *sctx;
1378 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1379 sctx->ready_confirm_fd = -1; /* no daemonizing */
1380 sctx->ret = GNUNET_OK;
1381 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1382 sctx->maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1383 sctx->serviceName = serviceName;
1385 sctx->sched = sched;
1387 /* setup subsystems */
1388 if ((GNUNET_OK != setup_service (sctx)) ||
1389 (NULL == (sctx->server = GNUNET_SERVER_create (sched,
1396 sctx->require_found))))
1398 GNUNET_SERVICE_stop (sctx);
1401 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1402 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1404 while ((sctx->my_handlers[i].callback != NULL))
1405 sctx->my_handlers[i++].callback_cls = sctx;
1406 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1413 * Obtain the server used by a service. Note that the server must NOT
1414 * be destroyed by the caller.
1416 * @param ctx the service context returned from the start function
1417 * @return handle to the server for this service, NULL if there is none
1419 struct GNUNET_SERVER_Handle *
1420 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1427 * Stop a service that was started with "GNUNET_SERVICE_start".
1429 * @param ctx the service context returned from the start function
1432 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1434 if (NULL != sctx->server)
1435 GNUNET_SERVER_destroy (sctx->server);
1436 GNUNET_free_non_null (sctx->my_handlers);
1437 GNUNET_free_non_null (sctx->addr);
1438 GNUNET_free_non_null (sctx->v4_denied);
1439 GNUNET_free_non_null (sctx->v6_denied);
1440 GNUNET_free_non_null (sctx->v4_allowed);
1441 GNUNET_free_non_null (sctx->v6_allowed);
1446 /* end of service.c */