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 transmit_shutdown_deny (void *cls, size_t size, void *buf)
576 struct GNUNET_SERVER_Client *client = cls;
577 struct GNUNET_MessageHeader *msg;
579 if (size < sizeof (struct GNUNET_MessageHeader))
581 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
582 return 0; /* client disconnected */
584 msg = (struct GNUNET_MessageHeader *) buf;
585 msg->type = htons (GNUNET_MESSAGE_TYPE_SHUTDOWN_REFUSE);
586 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
587 GNUNET_SERVER_receive_done (client, GNUNET_OK);
588 GNUNET_SERVER_client_drop(client);
589 return sizeof (struct GNUNET_MessageHeader);
593 transmit_shutdown_ack (void *cls, size_t size, void *buf)
595 struct GNUNET_SERVER_Client *client = cls;
596 struct GNUNET_MessageHeader *msg;
598 if (size < sizeof (struct GNUNET_MessageHeader))
600 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
601 _("Failed to transmit shutdown ACK.\n"));
602 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
603 return 0; /* client disconnected */
606 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
607 _("Transmitting shutdown ACK.\n"));
609 msg = (struct GNUNET_MessageHeader *) buf;
610 msg->type = htons (GNUNET_MESSAGE_TYPE_SHUTDOWN_ACK);
611 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
612 GNUNET_SERVER_receive_done (client, GNUNET_OK);
613 GNUNET_SERVER_client_drop(client);
614 return sizeof (struct GNUNET_MessageHeader);
618 * Handler for SHUTDOWN message.
620 * @param cls closure (refers to service)
621 * @param client identification of the client
622 * @param message the actual message
625 handle_shutdown (void *cls,
626 struct GNUNET_SERVER_Client *client,
627 const struct GNUNET_MessageHeader *message)
629 struct GNUNET_SERVICE_Context *service = cls;
631 GNUNET_SERVER_client_keep(client);
632 if (!service->allow_shutdown)
634 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
636 ("Received shutdown request, but configured to ignore!\n"));
637 GNUNET_SERVER_notify_transmit_ready (client,
638 sizeof(struct GNUNET_MessageHeader),
639 GNUNET_TIME_UNIT_FOREVER_REL,
640 &transmit_shutdown_deny, client);
643 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
644 _("Initiating shutdown as requested by client.\n"));
646 GNUNET_SERVER_notify_transmit_ready (client,
647 sizeof(struct GNUNET_MessageHeader),
648 GNUNET_TIME_UNIT_FOREVER_REL,
649 &transmit_shutdown_ack, client);
651 GNUNET_assert (service->sched != NULL);
652 GNUNET_SERVER_client_persist_ (client);
653 GNUNET_SCHEDULER_shutdown (service->sched);
658 * Default handlers for all services. Will be copied and the
659 * "callback_cls" fields will be replaced with the specific service
662 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
663 {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
664 sizeof (struct GNUNET_MessageHeader)},
665 {&handle_shutdown, NULL, GNUNET_MESSAGE_TYPE_SHUTDOWN,
666 sizeof (struct GNUNET_MessageHeader)},
672 /* ****************** service core routines ************** */
676 * Check if access to the service is allowed from the given address.
679 check_access (void *cls, const struct sockaddr *addr, socklen_t addrlen)
681 struct GNUNET_SERVICE_Context *sctx = cls;
682 const struct sockaddr_in *i4;
683 const struct sockaddr_in6 *i6;
686 switch (addr->sa_family)
689 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
690 i4 = (const struct sockaddr_in *) addr;
691 ret = ((sctx->v4_allowed == NULL) ||
692 (check_ipv4_listed (sctx->v4_allowed,
694 && ((sctx->v4_denied == NULL) ||
695 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
698 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
699 i6 = (const struct sockaddr_in6 *) addr;
700 ret = ((sctx->v6_allowed == NULL) ||
701 (check_ipv6_listed (sctx->v6_allowed,
703 && ((sctx->v6_denied == NULL) ||
704 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
707 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
708 _("Unknown address family %d\n"), addr->sa_family);
709 return GNUNET_SYSERR;
711 if (ret != GNUNET_OK)
713 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
714 _("Access from `%s' denied to service `%s'\n"),
715 GNUNET_a2s (addr, addrlen), sctx->serviceName);
722 * Get the name of the file where we will
723 * write the PID of the service.
726 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
732 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
741 * Parse an IPv4 access control list.
744 process_acl4 (struct IPv4NetworkSet **ret,
745 struct GNUNET_SERVICE_Context *sctx, const char *option)
749 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
751 GNUNET_break (GNUNET_OK ==
752 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
755 if (NULL == (*ret = parse_ipv4_specification (opt)))
757 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
759 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
760 opt, sctx->serviceName, option);
762 return GNUNET_SYSERR;
770 * Parse an IPv4 access control list.
773 process_acl6 (struct IPv6NetworkSet **ret,
774 struct GNUNET_SERVICE_Context *sctx, const char *option)
777 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
779 GNUNET_break (GNUNET_OK ==
780 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
783 if (NULL == (*ret = parse_ipv6_specification (opt)))
785 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
787 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
788 opt, sctx->serviceName, option);
790 return GNUNET_SYSERR;
798 * Get the list of addresses that a server for the given service
801 * @param serviceName name of the service
802 * @param cfg configuration (which specifies the addresses)
803 * @param addrs set (call by reference) to an array of pointers to the
804 * addresses the server should bind to and listen on; the
805 * array will be NULL-terminated (on success)
806 * @param addr_lens set (call by reference) to an array of the lengths
807 * of the respective 'struct sockaddr' struct in the 'addrs'
809 * @return number of addresses found on success,
810 * GNUNET_SYSERR if the configuration
811 * did not specify reasonable finding information or
812 * if it specified a hostname that could not be resolved;
813 * GNUNET_NO if the number of addresses configured is
814 * zero (in this case, '*addrs' and '*addr_lens' will be
818 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
819 const struct GNUNET_CONFIGURATION_Handle *cfg,
820 struct sockaddr ***addrs,
821 socklen_t **addr_lens)
824 struct GNUNET_NETWORK_Handle *desc;
825 unsigned long long port;
826 struct addrinfo hints;
827 struct addrinfo *res;
828 struct addrinfo *pos;
829 struct addrinfo *next;
833 struct sockaddr **saddrs;
834 socklen_t *saddrlens;
839 if (GNUNET_CONFIGURATION_have_value (cfg,
840 serviceName, "DISABLEV6"))
843 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
846 return GNUNET_SYSERR;
849 disablev6 = GNUNET_NO;
853 /* probe IPv6 support */
854 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
857 if ((errno == ENOBUFS) ||
858 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
860 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
861 return GNUNET_SYSERR;
863 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
865 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
866 serviceName, STRERROR (errno));
867 disablev6 = GNUNET_YES;
871 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
877 GNUNET_CONFIGURATION_get_value_number (cfg,
880 &port)) || (port > 65535))
882 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
884 ("Require valid port number for service `%s' in configuration!\n"),
886 return GNUNET_SYSERR;
888 if (GNUNET_CONFIGURATION_have_value (cfg,
889 serviceName, "BINDTO"))
891 GNUNET_break (GNUNET_OK ==
892 GNUNET_CONFIGURATION_get_value_string (cfg,
900 if (hostname != NULL)
903 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
904 "Resolving `%s' since that is where `%s' will bind to.\n",
908 memset (&hints, 0, sizeof (struct addrinfo));
910 hints.ai_family = AF_INET;
911 if ((0 != (ret = getaddrinfo (hostname,
912 NULL, &hints, &res))) || (res == NULL))
914 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
915 _("Failed to resolve `%s': %s\n"),
916 hostname, gai_strerror (ret));
917 GNUNET_free (hostname);
918 return GNUNET_SYSERR;
922 while (NULL != (pos = next))
925 if ( (disablev6) && (pos->ai_family == AF_INET6))
931 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
932 _("Failed to find %saddress for `%s'.\n"),
933 disablev6 ? "IPv4 " : "", hostname);
935 GNUNET_free (hostname);
936 return GNUNET_SYSERR;
939 saddrs = GNUNET_malloc ((i+1) * sizeof(struct sockaddr*));
940 saddrlens = GNUNET_malloc ((i+1) * sizeof (socklen_t));
943 while (NULL != (pos = next))
946 if ( (disablev6) && (pos->ai_family == AF_INET6))
949 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
950 "Service `%s' will bind to `%s'\n",
952 GNUNET_a2s (pos->ai_addr,
955 if (pos->ai_family == AF_INET)
957 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
958 saddrlens[i] = pos->ai_addrlen;
959 saddrs[i] = GNUNET_malloc (saddrlens[i]);
960 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
961 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
965 GNUNET_assert (pos->ai_family == AF_INET6);
966 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
967 saddrlens[i] = pos->ai_addrlen;
968 saddrs[i] = GNUNET_malloc (saddrlens[i]);
969 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
970 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
974 GNUNET_free (hostname);
979 /* will bind against everything, just set port */
984 saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
985 saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
986 saddrlens[0] = sizeof (struct sockaddr_in);
987 saddrs[0] = GNUNET_malloc (saddrlens[0]);
988 #if HAVE_SOCKADDR_IN_SIN_LEN
989 ((struct sockaddr_in *) saddrs[0])->sin_len = saddrlens[0];
991 ((struct sockaddr_in *) saddrs[0])->sin_family = AF_INET;
992 ((struct sockaddr_in *) saddrs[0])->sin_port = htons (port);
998 saddrs = GNUNET_malloc (3 * sizeof(struct sockaddr*));
999 saddrlens = GNUNET_malloc (3 * sizeof (socklen_t));
1001 saddrlens[0] = sizeof (struct sockaddr_in6);
1002 saddrs[0] = GNUNET_malloc (saddrlens[0]);
1003 #if HAVE_SOCKADDR_IN_SIN_LEN
1004 ((struct sockaddr_in6 *) saddrs[0])->sin6_len = saddrlens[0];
1006 ((struct sockaddr_in6 *) saddrs[0])->sin6_family = AF_INET6;
1007 ((struct sockaddr_in6 *) saddrs[0])->sin6_port = htons (port);
1009 saddrlens[1] = sizeof (struct sockaddr_in);
1010 saddrs[1] = GNUNET_malloc (saddrlens[1]);
1011 #if HAVE_SOCKADDR_IN_SIN_LEN
1012 ((struct sockaddr_in *) saddrs[1])->sin_len = saddrlens[1];
1014 ((struct sockaddr_in *) saddrs[1])->sin_family = AF_INET;
1015 ((struct sockaddr_in *) saddrs[1])->sin_port = htons (port);
1019 *addr_lens = saddrlens;
1025 * Setup addr, addrlen, maxbuf, idle_timeout
1026 * based on configuration!
1028 * Configuration must specify a "PORT". It may
1030 * - TIMEOUT (after how many ms does an inactive service timeout);
1031 * - MAXBUF (maximum incoming message size supported)
1032 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1033 * - ALLOW_SHUTDOWN (allow clients to shutdown this service)
1034 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1035 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
1036 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1037 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
1038 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1040 * @return GNUNET_OK if configuration succeeded
1043 setup_service (struct GNUNET_SERVICE_Context *sctx)
1045 unsigned long long maxbuf;
1046 struct GNUNET_TIME_Relative idleout;
1049 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1050 sctx->serviceName, "TIMEOUT"))
1053 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
1055 "TIMEOUT", &idleout))
1057 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1058 _("Specified value for `%s' of service `%s' is invalid\n"),
1061 return GNUNET_SYSERR;
1063 sctx->timeout = idleout;
1066 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1067 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1068 sctx->serviceName, "MAXBUF"))
1071 GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
1075 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1076 _("Specified value for `%s' of service `%s' is invalid\n"),
1079 return GNUNET_SYSERR;
1083 maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1084 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1085 sctx->serviceName, "ALLOW_SHUTDOWN"))
1087 if (GNUNET_SYSERR ==
1088 (sctx->allow_shutdown =
1089 GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName,
1092 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1093 _("Specified value for `%s' of service `%s' is invalid\n"),
1096 return GNUNET_SYSERR;
1100 sctx->allow_shutdown = GNUNET_NO;
1103 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1104 sctx->serviceName, "TOLERANT"))
1106 if (GNUNET_SYSERR ==
1107 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1111 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1112 _("Specified value for `%s' of service `%s' is invalid\n"),
1115 return GNUNET_SYSERR;
1119 tolerant = GNUNET_NO;
1121 if (GNUNET_SYSERR ==
1122 GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1126 return GNUNET_SYSERR;
1127 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1128 sctx->maxbuf = (size_t) maxbuf;
1129 if (sctx->maxbuf != maxbuf)
1131 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1133 ("Value in configuration for `%s' and service `%s' too large!\n"),
1134 "MAXBUF", sctx->serviceName);
1135 return GNUNET_SYSERR;
1138 process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1139 process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1140 process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1141 process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1148 * Get the name of the user that'll be used
1149 * to provide the service.
1152 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1158 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1169 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1177 if (NULL == (pif = get_pid_file_name (sctx)))
1178 return GNUNET_OK; /* no file desired */
1179 user = get_user_name (sctx);
1180 rdir = GNUNET_strdup (pif);
1181 len = strlen (rdir);
1182 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1185 if (0 != ACCESS (rdir, F_OK))
1187 /* we get to create a directory -- and claim it
1189 GNUNET_DISK_directory_create (rdir);
1190 if ((user != NULL) && (0 < strlen (user)))
1191 GNUNET_DISK_file_change_owner (rdir, user);
1193 if (0 != ACCESS (rdir, W_OK | X_OK))
1195 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1197 GNUNET_free_non_null (user);
1199 return GNUNET_SYSERR;
1202 pidfd = FOPEN (pif, "w");
1205 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1207 GNUNET_free_non_null (user);
1208 return GNUNET_SYSERR;
1210 if (0 > FPRINTF (pidfd, "%u", pid))
1211 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1212 GNUNET_break (0 == fclose (pidfd));
1213 if ((user != NULL) && (0 < strlen (user)))
1214 GNUNET_DISK_file_change_owner (pif, user);
1215 GNUNET_free_non_null (user);
1222 * Task run during shutdown.
1228 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1230 struct GNUNET_SERVER_Handle *server = cls;
1232 GNUNET_SERVER_destroy (server);
1237 * Initial task for the service.
1240 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1242 struct GNUNET_SERVICE_Context *sctx = cls;
1245 sctx->sched = tc->sched;
1246 sctx->server = GNUNET_SERVER_create (tc->sched,
1252 sctx->timeout, sctx->require_found);
1253 if (sctx->server == NULL)
1256 while (sctx->addrs[i] != NULL)
1258 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1259 _("Failed to start `%s' at `%s'\n"),
1261 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1264 sctx->ret = GNUNET_SYSERR;
1267 if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1269 /* install a task that will kill the server
1270 process if the scheduler ever gets a shutdown signal */
1271 GNUNET_SCHEDULER_add_delayed (tc->sched,
1272 GNUNET_TIME_UNIT_FOREVER_REL,
1273 &shutdown_task, sctx->server);
1275 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1276 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1278 while ((sctx->my_handlers[i].callback != NULL))
1279 sctx->my_handlers[i++].callback_cls = sctx;
1280 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1281 if (sctx->ready_confirm_fd != -1)
1283 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1284 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1285 sctx->ready_confirm_fd = -1;
1286 write_pid_file (sctx, getpid ());
1289 while (sctx->addrs[i] != NULL)
1291 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1292 _("Service `%s' runs at %s\n"),
1294 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1297 sctx->task (sctx->task_cls, tc->sched, sctx->server, sctx->cfg);
1302 * Detach from terminal.
1305 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1312 if (0 != PIPE (filedes))
1314 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1315 return GNUNET_SYSERR;
1320 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1321 return GNUNET_SYSERR;
1328 GNUNET_break (0 == CLOSE (filedes[1]));
1330 if (1 != READ (filedes[0], &c, sizeof (char)))
1331 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1338 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1339 _("Service process failed to initialize\n"));
1342 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1344 ("Service process could not initialize server function\n"));
1347 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1348 _("Service process failed to report status\n"));
1351 exit (1); /* child reported error */
1353 GNUNET_break (0 == CLOSE (0));
1354 GNUNET_break (0 == CLOSE (1));
1355 GNUNET_break (0 == CLOSE (filedes[0]));
1356 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1358 return GNUNET_SYSERR;
1359 /* set stdin/stdout to /dev/null */
1360 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1362 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1363 return GNUNET_SYSERR;
1365 /* Detach from controlling terminal */
1368 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1369 sctx->ready_confirm_fd = filedes[1];
1371 /* FIXME: we probably need to do something else
1372 elsewhere in order to fork the process itself... */
1383 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1387 if (NULL == (user = get_user_name (sctx)))
1388 return GNUNET_OK; /* keep */
1393 pws = getpwnam (user);
1396 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1397 _("Cannot obtain information about user `%s': %s\n"),
1398 user, errno == 0 ? _("No such user") : STRERROR (errno));
1400 return GNUNET_SYSERR;
1402 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1404 (0 != initgroups (user, pws->pw_gid)) ||
1406 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1408 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1409 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1411 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1412 _("Cannot change user/group to `%s': %s\n"), user,
1415 return GNUNET_SYSERR;
1425 * Delete the PID file that was created by our parent.
1428 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1430 char *pif = get_pid_file_name (sctx);
1432 return; /* no PID file */
1433 if (0 != UNLINK (pif))
1434 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1440 * Run a standard GNUnet service startup sequence (initialize loggers
1441 * and configuration, parse options).
1443 * @param argc number of command line arguments
1444 * @param argv command line arguments
1445 * @param serviceName our service name
1446 * @param opt service options
1447 * @param task main task of the service
1448 * @param task_cls closure for task
1449 * @return GNUNET_SYSERR on error, GNUNET_OK
1450 * if we shutdown nicely
1453 GNUNET_SERVICE_run (int argc,
1455 const char *serviceName,
1456 enum GNUNET_SERVICE_Options opt,
1457 GNUNET_SERVICE_Main task, void *task_cls)
1459 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1467 struct GNUNET_SERVICE_Context sctx;
1468 struct GNUNET_CONFIGURATION_Handle *cfg;
1469 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1470 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1471 {'d', "daemonize", NULL,
1472 gettext_noop ("do daemonize (detach from terminal)"), 0,
1473 GNUNET_GETOPT_set_one, &do_daemonize},
1474 GNUNET_GETOPT_OPTION_HELP (serviceName),
1475 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1476 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1477 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1478 GNUNET_GETOPT_OPTION_END
1483 loglev = GNUNET_strdup ("WARNING");
1484 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
1485 memset (&sctx, 0, sizeof (sctx));
1487 sctx.ready_confirm_fd = -1;
1488 sctx.ret = GNUNET_OK;
1489 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1490 sctx.maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1492 sctx.serviceName = serviceName;
1493 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1494 /* setup subsystems */
1495 if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1498 if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1500 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1502 if (GNUNET_OK != setup_service (&sctx))
1504 if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1506 if (GNUNET_OK != set_user_id (&sctx))
1509 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1510 "Service `%s' runs with configuration from `%s'\n",
1511 serviceName, cfg_fn);
1513 /* actually run service */
1514 GNUNET_SCHEDULER_run (&service_task, &sctx);
1517 if ((do_daemonize == 1) && (sctx.server != NULL))
1518 pid_file_delete (&sctx);
1519 GNUNET_free_non_null (sctx.my_handlers);
1522 if (sctx.ready_confirm_fd != -1)
1524 if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1525 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1526 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1529 GNUNET_CONFIGURATION_destroy (cfg);
1531 if (sctx.addrs != NULL)
1532 while (sctx.addrs[i] != NULL)
1533 GNUNET_free (sctx.addrs[i++]);
1534 GNUNET_free_non_null (sctx.addrs);
1535 GNUNET_free_non_null (sctx.addrlens);
1536 GNUNET_free_non_null (logfile);
1537 GNUNET_free (loglev);
1538 GNUNET_free (cfg_fn);
1539 GNUNET_free_non_null (sctx.v4_denied);
1540 GNUNET_free_non_null (sctx.v6_denied);
1541 GNUNET_free_non_null (sctx.v4_allowed);
1542 GNUNET_free_non_null (sctx.v6_allowed);
1544 return err ? GNUNET_SYSERR : sctx.ret;
1549 * Run a service startup sequence within an existing
1550 * initialized system.
1552 * @param serviceName our service name
1553 * @param sched scheduler to use
1554 * @param cfg configuration to use
1555 * @return NULL on error, service handle
1557 struct GNUNET_SERVICE_Context *
1558 GNUNET_SERVICE_start (const char *serviceName,
1559 struct GNUNET_SCHEDULER_Handle *sched,
1560 const struct GNUNET_CONFIGURATION_Handle *cfg)
1563 struct GNUNET_SERVICE_Context *sctx;
1565 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1566 sctx->ready_confirm_fd = -1; /* no daemonizing */
1567 sctx->ret = GNUNET_OK;
1568 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1569 sctx->maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1570 sctx->serviceName = serviceName;
1572 sctx->sched = sched;
1574 /* setup subsystems */
1575 if ((GNUNET_OK != setup_service (sctx)) ||
1576 (NULL == (sctx->server = GNUNET_SERVER_create (sched,
1583 sctx->require_found))))
1585 GNUNET_SERVICE_stop (sctx);
1588 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1589 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1591 while ((sctx->my_handlers[i].callback != NULL))
1592 sctx->my_handlers[i++].callback_cls = sctx;
1593 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1598 * Obtain the server used by a service. Note that the server must NOT
1599 * be destroyed by the caller.
1601 * @param ctx the service context returned from the start function
1602 * @return handle to the server for this service, NULL if there is none
1604 struct GNUNET_SERVER_Handle *
1605 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1612 * Stop a service that was started with "GNUNET_SERVICE_start".
1614 * @param sctx the service context returned from the start function
1617 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1620 if (NULL != sctx->server)
1621 GNUNET_SERVER_destroy (sctx->server);
1622 GNUNET_free_non_null (sctx->my_handlers);
1624 while (sctx->addrs[i] != NULL)
1625 GNUNET_free (sctx->addrs[i++]);
1626 GNUNET_free_non_null (sctx->addrs);
1627 GNUNET_free_non_null (sctx->addrlens);
1628 GNUNET_free_non_null (sctx->v4_denied);
1629 GNUNET_free_non_null (sctx->v6_denied);
1630 GNUNET_free_non_null (sctx->v4_allowed);
1631 GNUNET_free_non_null (sctx->v6_allowed);
1636 /* end of service.c */