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 * NULL-terminated array of addresses to bind to, NULL if we got pre-bound
436 struct sockaddr **addrs;
439 * Name of our service.
441 const char *serviceName;
444 * Main service-specific task to run.
446 GNUNET_SERVICE_Main task;
454 * IPv4 addresses that are not allowed to connect.
456 struct IPv4NetworkSet *v4_denied;
459 * IPv6 addresses that are not allowed to connect.
461 struct IPv6NetworkSet *v6_denied;
464 * IPv4 addresses that are allowed to connect (if not
465 * set, all are allowed).
467 struct IPv4NetworkSet *v4_allowed;
470 * IPv6 addresses that are allowed to connect (if not
471 * set, all are allowed).
473 struct IPv6NetworkSet *v6_allowed;
476 * My (default) message handlers. Adjusted copy
479 struct GNUNET_SERVER_MessageHandler *my_handlers;
482 * Array of the lengths of the entries in addrs.
484 socklen_t * addrlens;
487 * NULL-terminated array of listen sockets we should take over.
489 struct GNUNET_NETWORK_Handle **lsocks;
492 * Idle timeout for server.
494 struct GNUNET_TIME_Relative timeout;
497 * Overall success/failure of the service start.
502 * If we are daemonizing, this FD is set to the
503 * pipe to the parent. Send '.' if we started
504 * ok, '!' if not. -1 if we are not daemonizing.
506 int ready_confirm_fd;
509 * Do we close connections if we receive messages
510 * for which we have no handler?
517 enum GNUNET_SERVICE_Options options;
522 /* ****************** message handlers ****************** */
525 write_test (void *cls, size_t size, void *buf)
527 struct GNUNET_SERVER_Client *client = cls;
528 struct GNUNET_MessageHeader *msg;
530 if (size < sizeof (struct GNUNET_MessageHeader))
532 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
533 return 0; /* client disconnected */
535 msg = (struct GNUNET_MessageHeader *) buf;
536 msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
537 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
538 GNUNET_SERVER_receive_done (client, GNUNET_OK);
539 return sizeof (struct GNUNET_MessageHeader);
543 * Handler for TEST message.
545 * @param cls closure (refers to service)
546 * @param client identification of the client
547 * @param message the actual message
550 handle_test (void *cls,
551 struct GNUNET_SERVER_Client *client,
552 const struct GNUNET_MessageHeader *message)
554 /* simply bounce message back to acknowledge */
555 if (NULL == GNUNET_SERVER_notify_transmit_ready (client,
557 GNUNET_MessageHeader),
558 GNUNET_TIME_UNIT_FOREVER_REL,
559 &write_test, client))
560 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
565 * Default handlers for all services. Will be copied and the
566 * "callback_cls" fields will be replaced with the specific service
569 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
570 {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
571 sizeof (struct GNUNET_MessageHeader)},
577 /* ****************** service core routines ************** */
581 * Check if access to the service is allowed from the given address.
584 check_access (void *cls, const struct sockaddr *addr, socklen_t addrlen)
586 struct GNUNET_SERVICE_Context *sctx = cls;
587 const struct sockaddr_in *i4;
588 const struct sockaddr_in6 *i6;
591 switch (addr->sa_family)
594 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
595 i4 = (const struct sockaddr_in *) addr;
596 ret = ((sctx->v4_allowed == NULL) ||
597 (check_ipv4_listed (sctx->v4_allowed,
599 && ((sctx->v4_denied == NULL) ||
600 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
603 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
604 i6 = (const struct sockaddr_in6 *) addr;
605 ret = ((sctx->v6_allowed == NULL) ||
606 (check_ipv6_listed (sctx->v6_allowed,
608 && ((sctx->v6_denied == NULL) ||
609 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
612 /* FIXME: support checking UID/GID in the future... */
613 ret = GNUNET_OK; /* always OK for now */
616 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
617 _("Unknown address family %d\n"), addr->sa_family);
618 return GNUNET_SYSERR;
620 if (ret != GNUNET_OK)
622 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
623 _("Access from `%s' denied to service `%s'\n"),
624 GNUNET_a2s (addr, addrlen), sctx->serviceName);
631 * Get the name of the file where we will
632 * write the PID of the service.
635 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
641 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
650 * Parse an IPv4 access control list.
653 process_acl4 (struct IPv4NetworkSet **ret,
654 struct GNUNET_SERVICE_Context *sctx, const char *option)
658 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
660 GNUNET_break (GNUNET_OK ==
661 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
664 if (NULL == (*ret = parse_ipv4_specification (opt)))
666 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
668 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
669 opt, sctx->serviceName, option);
671 return GNUNET_SYSERR;
679 * Parse an IPv4 access control list.
682 process_acl6 (struct IPv6NetworkSet **ret,
683 struct GNUNET_SERVICE_Context *sctx, const char *option)
686 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
688 GNUNET_break (GNUNET_OK ==
689 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
692 if (NULL == (*ret = parse_ipv6_specification (opt)))
694 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
696 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
697 opt, sctx->serviceName, option);
699 return GNUNET_SYSERR;
706 * Add the given UNIX domain path as an address to the
707 * list (as the first entry).
709 * @param saddrs array to update
710 * @param saddrlens where to store the address length
711 * @param unixpath path to add
714 add_unixpath (struct sockaddr **saddrs,
715 socklen_t *saddrlens,
716 const char *unixpath)
719 struct sockaddr_un *un;
722 un = GNUNET_malloc (sizeof (struct sockaddr_un));
723 un->sun_family = AF_UNIX;
724 slen = strlen (unixpath) + 1;
725 if (slen >= sizeof (un->sun_path))
726 slen = sizeof (un->sun_path) - 1;
727 memcpy (un->sun_path,
730 un->sun_path[slen] = '\0';
732 un->sun_path[0] = '\0';
733 slen = sizeof (struct sockaddr_un);
735 slen += sizeof (sa_family_t);
737 *saddrs = (struct sockaddr*) un;
740 /* this function should never be called
741 unless AF_UNIX is defined! */
748 * Get the list of addresses that a server for the given service
751 * @param serviceName name of the service
752 * @param cfg configuration (which specifies the addresses)
753 * @param addrs set (call by reference) to an array of pointers to the
754 * addresses the server should bind to and listen on; the
755 * array will be NULL-terminated (on success)
756 * @param addr_lens set (call by reference) to an array of the lengths
757 * of the respective 'struct sockaddr' struct in the 'addrs'
759 * @return number of addresses found on success,
760 * GNUNET_SYSERR if the configuration
761 * did not specify reasonable finding information or
762 * if it specified a hostname that could not be resolved;
763 * GNUNET_NO if the number of addresses configured is
764 * zero (in this case, '*addrs' and '*addr_lens' will be
768 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
769 const struct GNUNET_CONFIGURATION_Handle *cfg,
770 struct sockaddr ***addrs,
771 socklen_t **addr_lens)
774 struct GNUNET_NETWORK_Handle *desc;
775 unsigned long long port;
777 struct addrinfo hints;
778 struct addrinfo *res;
779 struct addrinfo *pos;
780 struct addrinfo *next;
784 struct sockaddr **saddrs;
785 socklen_t *saddrlens;
791 if (GNUNET_CONFIGURATION_have_value (cfg,
792 serviceName, "DISABLEV6"))
795 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
798 return GNUNET_SYSERR;
801 disablev6 = GNUNET_NO;
805 /* probe IPv6 support */
806 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
809 if ((errno == ENOBUFS) ||
810 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
812 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
813 return GNUNET_SYSERR;
815 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
817 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
818 serviceName, STRERROR (errno));
819 disablev6 = GNUNET_YES;
823 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
829 if (GNUNET_CONFIGURATION_have_value (cfg,
830 serviceName, "PORT"))
832 GNUNET_break (GNUNET_OK ==
833 GNUNET_CONFIGURATION_get_value_number (cfg,
839 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
841 ("Require valid port number for service `%s' in configuration!\n"),
843 return GNUNET_SYSERR;
847 if (GNUNET_CONFIGURATION_have_value (cfg,
848 serviceName, "BINDTO"))
850 GNUNET_break (GNUNET_OK ==
851 GNUNET_CONFIGURATION_get_value_string (cfg,
860 if (GNUNET_CONFIGURATION_have_value (cfg,
861 serviceName, "UNIXPATH"))
863 GNUNET_break (GNUNET_OK ==
864 GNUNET_CONFIGURATION_get_value_string (cfg,
869 /* probe UNIX support */
870 desc = GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_STREAM, 0);
873 if ((errno == ENOBUFS) ||
874 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
876 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
877 GNUNET_free_non_null (hostname);
878 GNUNET_free (unixpath);
879 return GNUNET_SYSERR;
881 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
883 ("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
884 serviceName, STRERROR (errno));
885 GNUNET_free (unixpath);
890 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
903 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
904 _("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
906 GNUNET_free_non_null(hostname);
907 return GNUNET_SYSERR;
911 saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
912 saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
913 add_unixpath (saddrs, saddrlens, unixpath);
914 GNUNET_free_non_null (unixpath);
915 GNUNET_free_non_null(hostname);
917 *addr_lens = saddrlens;
921 if (hostname != NULL)
924 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
925 "Resolving `%s' since that is where `%s' will bind to.\n",
929 memset (&hints, 0, sizeof (struct addrinfo));
931 hints.ai_family = AF_INET;
932 if ((0 != (ret = getaddrinfo (hostname,
933 NULL, &hints, &res))) || (res == NULL))
935 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
936 _("Failed to resolve `%s': %s\n"),
937 hostname, gai_strerror (ret));
938 GNUNET_free (hostname);
939 GNUNET_free (unixpath);
940 return GNUNET_SYSERR;
944 while (NULL != (pos = next))
947 if ( (disablev6) && (pos->ai_family == AF_INET6))
953 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
954 _("Failed to find %saddress for `%s'.\n"),
955 disablev6 ? "IPv4 " : "", hostname);
957 GNUNET_free (hostname);
958 GNUNET_free (unixpath);
959 return GNUNET_SYSERR;
962 if (NULL != unixpath)
964 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
965 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
967 if (NULL != unixpath)
969 add_unixpath (saddrs, saddrlens, unixpath);
973 while (NULL != (pos = next))
976 if ( (disablev6) && (pos->ai_family == AF_INET6))
979 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
980 "Service `%s' will bind to `%s'\n",
982 GNUNET_a2s (pos->ai_addr,
985 if (pos->ai_family == AF_INET)
987 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
988 saddrlens[i] = pos->ai_addrlen;
989 saddrs[i] = GNUNET_malloc (saddrlens[i]);
990 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
991 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
995 GNUNET_assert (pos->ai_family == AF_INET6);
996 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
997 saddrlens[i] = pos->ai_addrlen;
998 saddrs[i] = GNUNET_malloc (saddrlens[i]);
999 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
1000 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1004 GNUNET_free (hostname);
1009 /* will bind against everything, just set port */
1014 if (NULL != unixpath)
1017 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1018 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1019 if (NULL != unixpath)
1021 add_unixpath (saddrs, saddrlens, unixpath);
1024 saddrlens[i] = sizeof (struct sockaddr_in);
1025 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1026 #if HAVE_SOCKADDR_IN_SIN_LEN
1027 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
1029 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1030 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1036 if (NULL != unixpath)
1038 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1039 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1041 if (NULL != unixpath)
1043 add_unixpath (saddrs, saddrlens, unixpath);
1046 saddrlens[i] = sizeof (struct sockaddr_in6);
1047 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1048 #if HAVE_SOCKADDR_IN_SIN_LEN
1049 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
1051 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
1052 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1054 saddrlens[i] = sizeof (struct sockaddr_in);
1055 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1056 #if HAVE_SOCKADDR_IN_SIN_LEN
1057 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
1059 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1060 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1063 GNUNET_free_non_null (unixpath);
1065 *addr_lens = saddrlens;
1071 * Setup addr, addrlen, idle_timeout
1072 * based on configuration!
1074 * Configuration may specify:
1075 * - PORT (where to bind to for TCP)
1076 * - UNIXPATH (where to bind to for UNIX domain sockets)
1077 * - TIMEOUT (after how many ms does an inactive service timeout);
1078 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1079 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1080 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
1081 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1082 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
1083 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1085 * @return GNUNET_OK if configuration succeeded
1088 setup_service (struct GNUNET_SERVICE_Context *sctx)
1090 struct GNUNET_TIME_Relative idleout;
1100 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1101 sctx->serviceName, "TIMEOUT"))
1104 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
1106 "TIMEOUT", &idleout))
1108 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1109 _("Specified value for `%s' of service `%s' is invalid\n"),
1112 return GNUNET_SYSERR;
1114 sctx->timeout = idleout;
1117 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1119 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1120 sctx->serviceName, "TOLERANT"))
1122 if (GNUNET_SYSERR ==
1123 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1127 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1128 _("Specified value for `%s' of service `%s' is invalid\n"),
1131 return GNUNET_SYSERR;
1135 tolerant = GNUNET_NO;
1139 if ( (NULL != (lpid = getenv ("LISTEN_PID"))) &&
1140 (1 == sscanf (lpid, "%u", &pid)) &&
1141 (getpid () == (pid_t) pid) &&
1142 (NULL != (nfds = getenv ("LISTEN_FDS"))) &&
1143 (1 == sscanf (nfds, "%u", &cnt)) &&
1145 (cnt < FD_SETSIZE) &&
1146 (cnt + 4 < FD_SETSIZE) )
1148 sctx->lsocks = GNUNET_malloc (sizeof(struct GNUNET_NETWORK_Handle*) * (cnt+1));
1151 flags = fcntl (3 + cnt, F_GETFD);
1153 (0 != (flags & FD_CLOEXEC)) ||
1154 (NULL == (sctx->lsocks[cnt] = GNUNET_NETWORK_socket_box_native (3 + cnt))) )
1156 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1157 _("Could not access pre-bound socket %u, will try to bind myself\n"),
1158 (unsigned int) 3 +cnt);
1160 while (sctx->lsocks[cnt] != NULL)
1161 GNUNET_break (0 == GNUNET_NETWORK_socket_close (sctx->lsocks[cnt++]));
1162 GNUNET_free (sctx->lsocks);
1163 sctx->lsocks = NULL;
1167 unsetenv ("LISTEN_PID");
1168 unsetenv ("LISTEN_FDS");
1172 if ( (sctx->lsocks == NULL) &&
1174 GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1178 return GNUNET_SYSERR;
1179 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1181 process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1182 process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1183 process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1184 process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1191 * Get the name of the user that'll be used
1192 * to provide the service.
1195 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1201 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1212 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1220 if (NULL == (pif = get_pid_file_name (sctx)))
1221 return GNUNET_OK; /* no file desired */
1222 user = get_user_name (sctx);
1223 rdir = GNUNET_strdup (pif);
1224 len = strlen (rdir);
1225 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1228 if (0 != ACCESS (rdir, F_OK))
1230 /* we get to create a directory -- and claim it
1232 GNUNET_DISK_directory_create (rdir);
1233 if ((user != NULL) && (0 < strlen (user)))
1234 GNUNET_DISK_file_change_owner (rdir, user);
1236 if (0 != ACCESS (rdir, W_OK | X_OK))
1238 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1240 GNUNET_free_non_null (user);
1242 return GNUNET_SYSERR;
1245 pidfd = FOPEN (pif, "w");
1248 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1250 GNUNET_free_non_null (user);
1251 return GNUNET_SYSERR;
1253 if (0 > FPRINTF (pidfd, "%u", pid))
1254 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1255 GNUNET_break (0 == fclose (pidfd));
1256 if ((user != NULL) && (0 < strlen (user)))
1257 GNUNET_DISK_file_change_owner (pif, user);
1258 GNUNET_free_non_null (user);
1265 * Task run during shutdown.
1271 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1273 struct GNUNET_SERVER_Handle *server = cls;
1275 GNUNET_SERVER_destroy (server);
1280 * Initial task for the service.
1283 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1285 struct GNUNET_SERVICE_Context *sctx = cls;
1288 if (sctx->lsocks != NULL)
1289 sctx->server = GNUNET_SERVER_create_with_sockets (&check_access,
1292 sctx->timeout, sctx->require_found);
1294 sctx->server = GNUNET_SERVER_create (&check_access,
1298 sctx->timeout, sctx->require_found);
1299 if (sctx->server == NULL)
1301 if (sctx->addrs != NULL)
1304 while (sctx->addrs[i] != NULL)
1306 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1307 _("Failed to start `%s' at `%s'\n"),
1309 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1313 sctx->ret = GNUNET_SYSERR;
1316 if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1318 /* install a task that will kill the server
1319 process if the scheduler ever gets a shutdown signal */
1320 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1321 &shutdown_task, sctx->server);
1323 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1324 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1326 while ((sctx->my_handlers[i].callback != NULL))
1327 sctx->my_handlers[i++].callback_cls = sctx;
1328 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1329 if (sctx->ready_confirm_fd != -1)
1331 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1332 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1333 sctx->ready_confirm_fd = -1;
1334 write_pid_file (sctx, getpid ());
1336 if (sctx->addrs != NULL)
1339 while (sctx->addrs[i] != NULL)
1341 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1342 _("Service `%s' runs at %s\n"),
1344 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1348 sctx->task (sctx->task_cls, sctx->server, sctx->cfg);
1353 * Detach from terminal.
1356 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1363 if (0 != PIPE (filedes))
1365 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1366 return GNUNET_SYSERR;
1371 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1372 return GNUNET_SYSERR;
1379 GNUNET_break (0 == CLOSE (filedes[1]));
1381 if (1 != READ (filedes[0], &c, sizeof (char)))
1382 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1389 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1390 _("Service process failed to initialize\n"));
1393 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1395 ("Service process could not initialize server function\n"));
1398 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1399 _("Service process failed to report status\n"));
1402 exit (1); /* child reported error */
1404 GNUNET_break (0 == CLOSE (0));
1405 GNUNET_break (0 == CLOSE (1));
1406 GNUNET_break (0 == CLOSE (filedes[0]));
1407 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1409 return GNUNET_SYSERR;
1410 /* set stdin/stdout to /dev/null */
1411 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1413 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1414 (void) CLOSE (nullfd);
1415 return GNUNET_SYSERR;
1417 (void) CLOSE (nullfd);
1418 /* Detach from controlling terminal */
1421 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1422 sctx->ready_confirm_fd = filedes[1];
1424 /* FIXME: we probably need to do something else
1425 elsewhere in order to fork the process itself... */
1436 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1440 if (NULL == (user = get_user_name (sctx)))
1441 return GNUNET_OK; /* keep */
1446 pws = getpwnam (user);
1449 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1450 _("Cannot obtain information about user `%s': %s\n"),
1451 user, errno == 0 ? _("No such user") : STRERROR (errno));
1453 return GNUNET_SYSERR;
1455 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1457 (0 != initgroups (user, pws->pw_gid)) ||
1459 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1461 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1462 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1464 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1465 _("Cannot change user/group to `%s': %s\n"), user,
1468 return GNUNET_SYSERR;
1478 * Delete the PID file that was created by our parent.
1481 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1483 char *pif = get_pid_file_name (sctx);
1485 return; /* no PID file */
1486 if (0 != UNLINK (pif))
1487 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1493 * Run a standard GNUnet service startup sequence (initialize loggers
1494 * and configuration, parse options).
1496 * @param argc number of command line arguments
1497 * @param argv command line arguments
1498 * @param serviceName our service name
1499 * @param opt service options
1500 * @param task main task of the service
1501 * @param task_cls closure for task
1502 * @return GNUNET_SYSERR on error, GNUNET_OK
1503 * if we shutdown nicely
1506 GNUNET_SERVICE_run (int argc,
1508 const char *serviceName,
1509 enum GNUNET_SERVICE_Options opt,
1510 GNUNET_SERVICE_Main task, void *task_cls)
1512 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1520 struct GNUNET_SERVICE_Context sctx;
1521 struct GNUNET_CONFIGURATION_Handle *cfg;
1522 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1523 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1524 {'d', "daemonize", NULL,
1525 gettext_noop ("do daemonize (detach from terminal)"), 0,
1526 GNUNET_GETOPT_set_one, &do_daemonize},
1527 GNUNET_GETOPT_OPTION_HELP (serviceName),
1528 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1529 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1530 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1531 GNUNET_GETOPT_OPTION_END
1536 loglev = GNUNET_strdup ("WARNING");
1537 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
1538 memset (&sctx, 0, sizeof (sctx));
1540 sctx.ready_confirm_fd = -1;
1541 sctx.ret = GNUNET_OK;
1542 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1544 sctx.task_cls = task_cls;
1545 sctx.serviceName = serviceName;
1546 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1547 /* setup subsystems */
1548 if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1551 if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1553 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1555 if (GNUNET_OK != setup_service (&sctx))
1557 if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1559 if (GNUNET_OK != set_user_id (&sctx))
1562 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1563 "Service `%s' runs with configuration from `%s'\n",
1564 serviceName, cfg_fn);
1566 /* actually run service */
1567 GNUNET_SCHEDULER_run (&service_task, &sctx);
1570 if ((do_daemonize == 1) && (sctx.server != NULL))
1571 pid_file_delete (&sctx);
1572 GNUNET_free_non_null (sctx.my_handlers);
1575 if (sctx.ready_confirm_fd != -1)
1577 if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1578 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1579 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1582 GNUNET_CONFIGURATION_destroy (cfg);
1584 if (sctx.addrs != NULL)
1585 while (sctx.addrs[i] != NULL)
1586 GNUNET_free (sctx.addrs[i++]);
1587 GNUNET_free_non_null (sctx.addrs);
1588 GNUNET_free_non_null (sctx.addrlens);
1589 GNUNET_free_non_null (logfile);
1590 GNUNET_free (loglev);
1591 GNUNET_free (cfg_fn);
1592 GNUNET_free_non_null (sctx.v4_denied);
1593 GNUNET_free_non_null (sctx.v6_denied);
1594 GNUNET_free_non_null (sctx.v4_allowed);
1595 GNUNET_free_non_null (sctx.v6_allowed);
1597 return err ? GNUNET_SYSERR : sctx.ret;
1602 * Run a service startup sequence within an existing
1603 * initialized system.
1605 * @param serviceName our service name
1606 * @param cfg configuration to use
1607 * @return NULL on error, service handle
1609 struct GNUNET_SERVICE_Context *
1610 GNUNET_SERVICE_start (const char *serviceName,
1611 const struct GNUNET_CONFIGURATION_Handle *cfg)
1614 struct GNUNET_SERVICE_Context *sctx;
1616 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1617 sctx->ready_confirm_fd = -1; /* no daemonizing */
1618 sctx->ret = GNUNET_OK;
1619 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1620 sctx->serviceName = serviceName;
1623 /* setup subsystems */
1624 if (GNUNET_OK != setup_service (sctx))
1626 GNUNET_SERVICE_stop (sctx);
1629 if (sctx->lsocks != NULL)
1630 sctx->server = GNUNET_SERVER_create_with_sockets (&check_access,
1633 sctx->timeout, sctx->require_found);
1635 sctx->server = GNUNET_SERVER_create (&check_access,
1640 sctx->require_found);
1642 if (NULL == sctx->server)
1644 GNUNET_SERVICE_stop (sctx);
1647 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1648 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1650 while ((sctx->my_handlers[i].callback != NULL))
1651 sctx->my_handlers[i++].callback_cls = sctx;
1652 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1657 * Obtain the server used by a service. Note that the server must NOT
1658 * be destroyed by the caller.
1660 * @param ctx the service context returned from the start function
1661 * @return handle to the server for this service, NULL if there is none
1663 struct GNUNET_SERVER_Handle *
1664 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1671 * Stop a service that was started with "GNUNET_SERVICE_start".
1673 * @param sctx the service context returned from the start function
1676 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1679 if (NULL != sctx->server)
1680 GNUNET_SERVER_destroy (sctx->server);
1681 GNUNET_free_non_null (sctx->my_handlers);
1682 if (sctx->addrs != NULL)
1685 while (sctx->addrs[i] != NULL)
1686 GNUNET_free (sctx->addrs[i++]);
1687 GNUNET_free (sctx->addrs);
1689 GNUNET_free_non_null (sctx->addrlens);
1690 GNUNET_free_non_null (sctx->v4_denied);
1691 GNUNET_free_non_null (sctx->v6_denied);
1692 GNUNET_free_non_null (sctx->v4_allowed);
1693 GNUNET_free_non_null (sctx->v6_allowed);
1698 /* end of service.c */