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?
515 * Do we require a matching UID for UNIX domain socket
521 * Do we require a matching GID for UNIX domain socket
529 enum GNUNET_SERVICE_Options options;
534 /* ****************** message handlers ****************** */
537 write_test (void *cls, size_t size, void *buf)
539 struct GNUNET_SERVER_Client *client = cls;
540 struct GNUNET_MessageHeader *msg;
542 if (size < sizeof (struct GNUNET_MessageHeader))
544 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
545 return 0; /* client disconnected */
547 msg = (struct GNUNET_MessageHeader *) buf;
548 msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
549 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
550 GNUNET_SERVER_receive_done (client, GNUNET_OK);
551 return sizeof (struct GNUNET_MessageHeader);
555 * Handler for TEST message.
557 * @param cls closure (refers to service)
558 * @param client identification of the client
559 * @param message the actual message
562 handle_test (void *cls,
563 struct GNUNET_SERVER_Client *client,
564 const struct GNUNET_MessageHeader *message)
566 /* simply bounce message back to acknowledge */
567 if (NULL == GNUNET_SERVER_notify_transmit_ready (client,
569 GNUNET_MessageHeader),
570 GNUNET_TIME_UNIT_FOREVER_REL,
571 &write_test, client))
572 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
577 * Default handlers for all services. Will be copied and the
578 * "callback_cls" fields will be replaced with the specific service
581 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
582 {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
583 sizeof (struct GNUNET_MessageHeader)},
589 /* ****************** service core routines ************** */
593 * Check if access to the service is allowed from the given address.
596 * @param uc credentials, if available, otherwise NULL
597 * @param addr address
598 * @param addrlen length of address
599 * @return GNUNET_YES to allow, GNUNET_NO to deny, GNUNET_SYSERR
600 * for unknown address family (will be denied).
603 check_access (void *cls,
604 const struct GNUNET_CONNECTION_Credentials *uc,
605 const struct sockaddr *addr, socklen_t addrlen)
607 struct GNUNET_SERVICE_Context *sctx = cls;
608 const struct sockaddr_in *i4;
609 const struct sockaddr_in6 *i6;
612 switch (addr->sa_family)
615 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
616 i4 = (const struct sockaddr_in *) addr;
617 ret = ((sctx->v4_allowed == NULL) ||
618 (check_ipv4_listed (sctx->v4_allowed,
620 && ((sctx->v4_denied == NULL) ||
621 (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
624 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
625 i6 = (const struct sockaddr_in6 *) addr;
626 ret = ((sctx->v6_allowed == NULL) ||
627 (check_ipv6_listed (sctx->v6_allowed,
629 && ((sctx->v6_denied == NULL) ||
630 (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
634 ret = GNUNET_OK; /* always OK for now */
635 if ( (sctx->match_uid == GNUNET_YES) ||
636 (sctx->match_gid == GNUNET_YES) )
639 ( (sctx->match_uid != GNUNET_YES) ||
640 (uc->uid == geteuid()) ||
641 (uc->uid == getuid()) ) &&
642 ( (sctx->match_gid != GNUNET_YES) ||
643 (uc->gid == getegid()) ||
644 (uc->gid == getgid())) )
647 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
648 _("Access denied to UID %d / GID %d\n"),
649 (uc == NULL) ? -1 : uc->uid,
650 (uc == NULL) ? -1 : uc->gid);
654 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
655 _("Unknown address family %d\n"), addr->sa_family);
656 return GNUNET_SYSERR;
658 if (ret != GNUNET_OK)
660 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
661 _("Access from `%s' denied to service `%s'\n"),
662 GNUNET_a2s (addr, addrlen), sctx->serviceName);
669 * Get the name of the file where we will
670 * write the PID of the service.
673 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
679 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
688 * Parse an IPv4 access control list.
691 process_acl4 (struct IPv4NetworkSet **ret,
692 struct GNUNET_SERVICE_Context *sctx, const char *option)
696 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
698 GNUNET_break (GNUNET_OK ==
699 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
702 if (NULL == (*ret = parse_ipv4_specification (opt)))
704 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
706 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
707 opt, sctx->serviceName, option);
709 return GNUNET_SYSERR;
717 * Parse an IPv4 access control list.
720 process_acl6 (struct IPv6NetworkSet **ret,
721 struct GNUNET_SERVICE_Context *sctx, const char *option)
724 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
726 GNUNET_break (GNUNET_OK ==
727 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
730 if (NULL == (*ret = parse_ipv6_specification (opt)))
732 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
734 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
735 opt, sctx->serviceName, option);
737 return GNUNET_SYSERR;
744 * Add the given UNIX domain path as an address to the
745 * list (as the first entry).
747 * @param saddrs array to update
748 * @param saddrlens where to store the address length
749 * @param unixpath path to add
752 add_unixpath (struct sockaddr **saddrs,
753 socklen_t *saddrlens,
754 const char *unixpath)
757 struct sockaddr_un *un;
760 un = GNUNET_malloc (sizeof (struct sockaddr_un));
761 un->sun_family = AF_UNIX;
762 slen = strlen (unixpath) + 1;
763 if (slen >= sizeof (un->sun_path))
764 slen = sizeof (un->sun_path) - 1;
765 memcpy (un->sun_path,
768 un->sun_path[slen] = '\0';
770 un->sun_path[0] = '\0';
771 slen = sizeof (struct sockaddr_un);
773 slen += sizeof (sa_family_t);
775 *saddrs = (struct sockaddr*) un;
778 /* this function should never be called
779 unless AF_UNIX is defined! */
786 * Get the list of addresses that a server for the given service
789 * @param serviceName name of the service
790 * @param cfg configuration (which specifies the addresses)
791 * @param addrs set (call by reference) to an array of pointers to the
792 * addresses the server should bind to and listen on; the
793 * array will be NULL-terminated (on success)
794 * @param addr_lens set (call by reference) to an array of the lengths
795 * of the respective 'struct sockaddr' struct in the 'addrs'
797 * @return number of addresses found on success,
798 * GNUNET_SYSERR if the configuration
799 * did not specify reasonable finding information or
800 * if it specified a hostname that could not be resolved;
801 * GNUNET_NO if the number of addresses configured is
802 * zero (in this case, '*addrs' and '*addr_lens' will be
806 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
807 const struct GNUNET_CONFIGURATION_Handle *cfg,
808 struct sockaddr ***addrs,
809 socklen_t **addr_lens)
812 struct GNUNET_NETWORK_Handle *desc;
813 unsigned long long port;
815 struct addrinfo hints;
816 struct addrinfo *res;
817 struct addrinfo *pos;
818 struct addrinfo *next;
822 struct sockaddr **saddrs;
823 socklen_t *saddrlens;
829 if (GNUNET_CONFIGURATION_have_value (cfg,
830 serviceName, "DISABLEV6"))
833 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
836 return GNUNET_SYSERR;
839 disablev6 = GNUNET_NO;
843 /* probe IPv6 support */
844 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
847 if ((errno == ENOBUFS) ||
848 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
850 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
851 return GNUNET_SYSERR;
853 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
855 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
856 serviceName, STRERROR (errno));
857 disablev6 = GNUNET_YES;
861 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
867 if (GNUNET_CONFIGURATION_have_value (cfg,
868 serviceName, "PORT"))
870 GNUNET_break (GNUNET_OK ==
871 GNUNET_CONFIGURATION_get_value_number (cfg,
877 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
879 ("Require valid port number for service `%s' in configuration!\n"),
881 return GNUNET_SYSERR;
885 if (GNUNET_CONFIGURATION_have_value (cfg,
886 serviceName, "BINDTO"))
888 GNUNET_break (GNUNET_OK ==
889 GNUNET_CONFIGURATION_get_value_string (cfg,
899 if ((GNUNET_YES == GNUNET_CONFIGURATION_have_value (cfg,
900 serviceName, "UNIXPATH")) &&
901 (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (cfg,
905 (0 < strlen(unixpath)))
907 /* probe UNIX support */
908 struct sockaddr_un s_un;
909 if (strlen(unixpath) >= sizeof(s_un.sun_path))
911 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
912 _("UNIXPATH `%s' too long, maximum length is %llu\n"),unixpath, sizeof(s_un.sun_path));
913 GNUNET_free_non_null (hostname);
914 GNUNET_free (unixpath);
915 return GNUNET_SYSERR;
918 desc = GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_STREAM, 0);
921 if ((errno == ENOBUFS) ||
922 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
924 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
925 GNUNET_free_non_null (hostname);
926 GNUNET_free (unixpath);
927 return GNUNET_SYSERR;
929 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
931 ("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
932 serviceName, STRERROR (errno));
933 GNUNET_free (unixpath);
938 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
947 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
948 _("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
950 GNUNET_free_non_null(hostname);
951 return GNUNET_SYSERR;
955 saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
956 saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
957 add_unixpath (saddrs, saddrlens, unixpath);
958 GNUNET_free_non_null (unixpath);
959 GNUNET_free_non_null (hostname);
961 *addr_lens = saddrlens;
965 if (hostname != NULL)
968 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
969 "Resolving `%s' since that is where `%s' will bind to.\n",
973 memset (&hints, 0, sizeof (struct addrinfo));
975 hints.ai_family = AF_INET;
976 if ((0 != (ret = getaddrinfo (hostname,
977 NULL, &hints, &res))) || (res == NULL))
979 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
980 _("Failed to resolve `%s': %s\n"),
981 hostname, gai_strerror (ret));
982 GNUNET_free (hostname);
983 GNUNET_free_non_null (unixpath);
984 return GNUNET_SYSERR;
988 while (NULL != (pos = next))
991 if ( (disablev6) && (pos->ai_family == AF_INET6))
997 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
998 _("Failed to find %saddress for `%s'.\n"),
999 disablev6 ? "IPv4 " : "", hostname);
1001 GNUNET_free (hostname);
1002 GNUNET_free_non_null (unixpath);
1003 return GNUNET_SYSERR;
1006 if (NULL != unixpath)
1008 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1009 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1011 if (NULL != unixpath)
1013 add_unixpath (saddrs, saddrlens, unixpath);
1017 while (NULL != (pos = next))
1019 next = pos->ai_next;
1020 if ( (disablev6) && (pos->ai_family == AF_INET6))
1023 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1024 "Service `%s' will bind to `%s'\n",
1026 GNUNET_a2s (pos->ai_addr,
1029 if (pos->ai_family == AF_INET)
1031 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
1032 saddrlens[i] = pos->ai_addrlen;
1033 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1034 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
1035 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1039 GNUNET_assert (pos->ai_family == AF_INET6);
1040 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
1041 saddrlens[i] = pos->ai_addrlen;
1042 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1043 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
1044 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1048 GNUNET_free (hostname);
1053 /* will bind against everything, just set port */
1058 if (NULL != unixpath)
1061 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1062 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1063 if (NULL != unixpath)
1065 add_unixpath (saddrs, saddrlens, unixpath);
1068 saddrlens[i] = sizeof (struct sockaddr_in);
1069 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1070 #if HAVE_SOCKADDR_IN_SIN_LEN
1071 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
1073 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1074 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1080 if (NULL != unixpath)
1082 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1083 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1085 if (NULL != unixpath)
1087 add_unixpath (saddrs, saddrlens, unixpath);
1090 saddrlens[i] = sizeof (struct sockaddr_in6);
1091 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1092 #if HAVE_SOCKADDR_IN_SIN_LEN
1093 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
1095 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
1096 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1098 saddrlens[i] = sizeof (struct sockaddr_in);
1099 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1100 #if HAVE_SOCKADDR_IN_SIN_LEN
1101 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
1103 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1104 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1107 GNUNET_free_non_null (unixpath);
1109 *addr_lens = saddrlens;
1115 * Setup addr, addrlen, idle_timeout
1116 * based on configuration!
1118 * Configuration may specify:
1119 * - PORT (where to bind to for TCP)
1120 * - UNIXPATH (where to bind to for UNIX domain sockets)
1121 * - TIMEOUT (after how many ms does an inactive service timeout);
1122 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1123 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1124 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
1125 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1126 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
1127 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1129 * @return GNUNET_OK if configuration succeeded
1132 setup_service (struct GNUNET_SERVICE_Context *sctx)
1134 struct GNUNET_TIME_Relative idleout;
1144 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1145 sctx->serviceName, "TIMEOUT"))
1148 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
1150 "TIMEOUT", &idleout))
1152 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1153 _("Specified value for `%s' of service `%s' is invalid\n"),
1156 return GNUNET_SYSERR;
1158 sctx->timeout = idleout;
1161 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1163 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1164 sctx->serviceName, "TOLERANT"))
1166 if (GNUNET_SYSERR ==
1167 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1171 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1172 _("Specified value for `%s' of service `%s' is invalid\n"),
1175 return GNUNET_SYSERR;
1179 tolerant = GNUNET_NO;
1183 if ( (NULL != (lpid = getenv ("LISTEN_PID"))) &&
1184 (1 == sscanf (lpid, "%u", &pid)) &&
1185 (getpid () == (pid_t) pid) &&
1186 (NULL != (nfds = getenv ("LISTEN_FDS"))) &&
1187 (1 == sscanf (nfds, "%u", &cnt)) &&
1189 (cnt < FD_SETSIZE) &&
1190 (cnt + 4 < FD_SETSIZE) )
1192 sctx->lsocks = GNUNET_malloc (sizeof(struct GNUNET_NETWORK_Handle*) * (cnt+1));
1195 flags = fcntl (3 + cnt, F_GETFD);
1197 (0 != (flags & FD_CLOEXEC)) ||
1198 (NULL == (sctx->lsocks[cnt] = GNUNET_NETWORK_socket_box_native (3 + cnt))) )
1200 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1201 _("Could not access pre-bound socket %u, will try to bind myself\n"),
1202 (unsigned int) 3 +cnt);
1204 while (sctx->lsocks[cnt] != NULL)
1205 GNUNET_break (0 == GNUNET_NETWORK_socket_close (sctx->lsocks[cnt++]));
1206 GNUNET_free (sctx->lsocks);
1207 sctx->lsocks = NULL;
1211 unsetenv ("LISTEN_PID");
1212 unsetenv ("LISTEN_FDS");
1216 if ( (sctx->lsocks == NULL) &&
1218 GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1222 return GNUNET_SYSERR;
1223 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1224 sctx->match_uid = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1227 sctx->match_gid = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1230 process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1231 process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1232 process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1233 process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1240 * Get the name of the user that'll be used
1241 * to provide the service.
1244 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1250 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1261 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1269 if (NULL == (pif = get_pid_file_name (sctx)))
1270 return GNUNET_OK; /* no file desired */
1271 user = get_user_name (sctx);
1272 rdir = GNUNET_strdup (pif);
1273 len = strlen (rdir);
1274 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1277 if (0 != ACCESS (rdir, F_OK))
1279 /* we get to create a directory -- and claim it
1281 GNUNET_DISK_directory_create (rdir);
1282 if ((user != NULL) && (0 < strlen (user)))
1283 GNUNET_DISK_file_change_owner (rdir, user);
1285 if (0 != ACCESS (rdir, W_OK | X_OK))
1287 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1289 GNUNET_free_non_null (user);
1291 return GNUNET_SYSERR;
1294 pidfd = FOPEN (pif, "w");
1297 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1299 GNUNET_free_non_null (user);
1300 return GNUNET_SYSERR;
1302 if (0 > FPRINTF (pidfd, "%u", pid))
1303 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1304 GNUNET_break (0 == fclose (pidfd));
1305 if ((user != NULL) && (0 < strlen (user)))
1306 GNUNET_DISK_file_change_owner (pif, user);
1307 GNUNET_free_non_null (user);
1314 * Task run during shutdown.
1320 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1322 struct GNUNET_SERVER_Handle *server = cls;
1324 GNUNET_SERVER_destroy (server);
1329 * Initial task for the service.
1332 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1334 struct GNUNET_SERVICE_Context *sctx = cls;
1337 if (sctx->lsocks != NULL)
1338 sctx->server = GNUNET_SERVER_create_with_sockets (&check_access,
1341 sctx->timeout, sctx->require_found);
1343 sctx->server = GNUNET_SERVER_create (&check_access,
1347 sctx->timeout, sctx->require_found);
1348 if (sctx->server == NULL)
1350 if (sctx->addrs != NULL)
1353 while (sctx->addrs[i] != NULL)
1355 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1356 _("Failed to start `%s' at `%s'\n"),
1358 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1362 sctx->ret = GNUNET_SYSERR;
1365 if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1367 /* install a task that will kill the server
1368 process if the scheduler ever gets a shutdown signal */
1369 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1370 &shutdown_task, sctx->server);
1372 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1373 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1375 while ((sctx->my_handlers[i].callback != NULL))
1376 sctx->my_handlers[i++].callback_cls = sctx;
1377 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1378 if (sctx->ready_confirm_fd != -1)
1380 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1381 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1382 sctx->ready_confirm_fd = -1;
1383 write_pid_file (sctx, getpid ());
1385 if (sctx->addrs != NULL)
1388 while (sctx->addrs[i] != NULL)
1390 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1391 _("Service `%s' runs at %s\n"),
1393 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1397 sctx->task (sctx->task_cls, sctx->server, sctx->cfg);
1402 * Detach from terminal.
1405 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1412 if (0 != PIPE (filedes))
1414 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1415 return GNUNET_SYSERR;
1420 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1421 return GNUNET_SYSERR;
1428 GNUNET_break (0 == CLOSE (filedes[1]));
1430 if (1 != READ (filedes[0], &c, sizeof (char)))
1431 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1438 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1439 _("Service process failed to initialize\n"));
1442 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1444 ("Service process could not initialize server function\n"));
1447 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1448 _("Service process failed to report status\n"));
1451 exit (1); /* child reported error */
1453 GNUNET_break (0 == CLOSE (0));
1454 GNUNET_break (0 == CLOSE (1));
1455 GNUNET_break (0 == CLOSE (filedes[0]));
1456 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1458 return GNUNET_SYSERR;
1459 /* set stdin/stdout to /dev/null */
1460 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1462 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1463 (void) CLOSE (nullfd);
1464 return GNUNET_SYSERR;
1466 (void) CLOSE (nullfd);
1467 /* Detach from controlling terminal */
1470 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1471 sctx->ready_confirm_fd = filedes[1];
1473 /* FIXME: we probably need to do something else
1474 elsewhere in order to fork the process itself... */
1485 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1489 if (NULL == (user = get_user_name (sctx)))
1490 return GNUNET_OK; /* keep */
1495 pws = getpwnam (user);
1498 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1499 _("Cannot obtain information about user `%s': %s\n"),
1500 user, errno == 0 ? _("No such user") : STRERROR (errno));
1502 return GNUNET_SYSERR;
1504 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1506 (0 != initgroups (user, pws->pw_gid)) ||
1508 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1510 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1511 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1513 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1514 _("Cannot change user/group to `%s': %s\n"), user,
1517 return GNUNET_SYSERR;
1527 * Delete the PID file that was created by our parent.
1530 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1532 char *pif = get_pid_file_name (sctx);
1534 return; /* no PID file */
1535 if (0 != UNLINK (pif))
1536 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1542 * Run a standard GNUnet service startup sequence (initialize loggers
1543 * and configuration, parse options).
1545 * @param argc number of command line arguments
1546 * @param argv command line arguments
1547 * @param serviceName our service name
1548 * @param opt service options
1549 * @param task main task of the service
1550 * @param task_cls closure for task
1551 * @return GNUNET_SYSERR on error, GNUNET_OK
1552 * if we shutdown nicely
1555 GNUNET_SERVICE_run (int argc,
1557 const char *serviceName,
1558 enum GNUNET_SERVICE_Options opt,
1559 GNUNET_SERVICE_Main task, void *task_cls)
1561 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1569 struct GNUNET_SERVICE_Context sctx;
1570 struct GNUNET_CONFIGURATION_Handle *cfg;
1571 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1572 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1573 {'d', "daemonize", NULL,
1574 gettext_noop ("do daemonize (detach from terminal)"), 0,
1575 GNUNET_GETOPT_set_one, &do_daemonize},
1576 GNUNET_GETOPT_OPTION_HELP (serviceName),
1577 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1578 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1579 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1580 GNUNET_GETOPT_OPTION_END
1585 loglev = GNUNET_strdup ("WARNING");
1586 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
1587 memset (&sctx, 0, sizeof (sctx));
1589 sctx.ready_confirm_fd = -1;
1590 sctx.ret = GNUNET_OK;
1591 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1593 sctx.task_cls = task_cls;
1594 sctx.serviceName = serviceName;
1595 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1596 /* setup subsystems */
1597 if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1600 if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1602 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1604 if (GNUNET_OK != setup_service (&sctx))
1606 if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1608 if (GNUNET_OK != set_user_id (&sctx))
1611 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1612 "Service `%s' runs with configuration from `%s'\n",
1613 serviceName, cfg_fn);
1615 /* actually run service */
1616 GNUNET_SCHEDULER_run (&service_task, &sctx);
1619 if ((do_daemonize == 1) && (sctx.server != NULL))
1620 pid_file_delete (&sctx);
1621 GNUNET_free_non_null (sctx.my_handlers);
1624 if (sctx.ready_confirm_fd != -1)
1626 if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1627 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1628 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1631 GNUNET_CONFIGURATION_destroy (cfg);
1633 if (sctx.addrs != NULL)
1634 while (sctx.addrs[i] != NULL)
1635 GNUNET_free (sctx.addrs[i++]);
1636 GNUNET_free_non_null (sctx.addrs);
1637 GNUNET_free_non_null (sctx.addrlens);
1638 GNUNET_free_non_null (logfile);
1639 GNUNET_free (loglev);
1640 GNUNET_free (cfg_fn);
1641 GNUNET_free_non_null (sctx.v4_denied);
1642 GNUNET_free_non_null (sctx.v6_denied);
1643 GNUNET_free_non_null (sctx.v4_allowed);
1644 GNUNET_free_non_null (sctx.v6_allowed);
1646 return err ? GNUNET_SYSERR : sctx.ret;
1651 * Run a service startup sequence within an existing
1652 * initialized system.
1654 * @param serviceName our service name
1655 * @param cfg configuration to use
1656 * @return NULL on error, service handle
1658 struct GNUNET_SERVICE_Context *
1659 GNUNET_SERVICE_start (const char *serviceName,
1660 const struct GNUNET_CONFIGURATION_Handle *cfg)
1663 struct GNUNET_SERVICE_Context *sctx;
1665 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1666 sctx->ready_confirm_fd = -1; /* no daemonizing */
1667 sctx->ret = GNUNET_OK;
1668 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1669 sctx->serviceName = serviceName;
1672 /* setup subsystems */
1673 if (GNUNET_OK != setup_service (sctx))
1675 GNUNET_SERVICE_stop (sctx);
1678 if (sctx->lsocks != NULL)
1679 sctx->server = GNUNET_SERVER_create_with_sockets (&check_access,
1682 sctx->timeout, sctx->require_found);
1684 sctx->server = GNUNET_SERVER_create (&check_access,
1689 sctx->require_found);
1691 if (NULL == sctx->server)
1693 GNUNET_SERVICE_stop (sctx);
1696 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1697 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1699 while ((sctx->my_handlers[i].callback != NULL))
1700 sctx->my_handlers[i++].callback_cls = sctx;
1701 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1706 * Obtain the server used by a service. Note that the server must NOT
1707 * be destroyed by the caller.
1709 * @param ctx the service context returned from the start function
1710 * @return handle to the server for this service, NULL if there is none
1712 struct GNUNET_SERVER_Handle *
1713 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1720 * Stop a service that was started with "GNUNET_SERVICE_start".
1722 * @param sctx the service context returned from the start function
1725 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1728 if (NULL != sctx->server)
1729 GNUNET_SERVER_destroy (sctx->server);
1730 GNUNET_free_non_null (sctx->my_handlers);
1731 if (sctx->addrs != NULL)
1734 while (sctx->addrs[i] != NULL)
1735 GNUNET_free (sctx->addrs[i++]);
1736 GNUNET_free (sctx->addrs);
1738 GNUNET_free_non_null (sctx->addrlens);
1739 GNUNET_free_non_null (sctx->v4_denied);
1740 GNUNET_free_non_null (sctx->v6_denied);
1741 GNUNET_free_non_null (sctx->v4_allowed);
1742 GNUNET_free_non_null (sctx->v6_allowed);
1747 /* end of service.c */