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)));
633 ret = GNUNET_OK; /* always OK for now */
634 if ( (sctx->match_uid == GNUNET_YES) ||
635 (sctx->match_gid == GNUNET_YES) )
638 ( (sctx->match_uid != GNUNET_YES) ||
639 (uc->uid == geteuid()) ||
640 (uc->uid == getuid()) ) &&
641 ( (sctx->match_gid != GNUNET_YES) ||
642 (uc->gid == getegid()) ||
643 (uc->gid == getgid())) )
646 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
647 _("Access denied to UID %d / GID %d\n"),
648 (uc == NULL) ? -1 : uc->uid,
649 (uc == NULL) ? -1 : uc->gid);
652 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
653 _("Unknown address family %d\n"), addr->sa_family);
654 return GNUNET_SYSERR;
656 if (ret != GNUNET_OK)
658 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
659 _("Access from `%s' denied to service `%s'\n"),
660 GNUNET_a2s (addr, addrlen), sctx->serviceName);
667 * Get the name of the file where we will
668 * write the PID of the service.
671 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
677 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
686 * Parse an IPv4 access control list.
689 process_acl4 (struct IPv4NetworkSet **ret,
690 struct GNUNET_SERVICE_Context *sctx, const char *option)
694 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
696 GNUNET_break (GNUNET_OK ==
697 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
700 if (NULL == (*ret = parse_ipv4_specification (opt)))
702 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
704 ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
705 opt, sctx->serviceName, option);
707 return GNUNET_SYSERR;
715 * Parse an IPv4 access control list.
718 process_acl6 (struct IPv6NetworkSet **ret,
719 struct GNUNET_SERVICE_Context *sctx, const char *option)
722 if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
724 GNUNET_break (GNUNET_OK ==
725 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
728 if (NULL == (*ret = parse_ipv6_specification (opt)))
730 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
732 ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
733 opt, sctx->serviceName, option);
735 return GNUNET_SYSERR;
742 * Add the given UNIX domain path as an address to the
743 * list (as the first entry).
745 * @param saddrs array to update
746 * @param saddrlens where to store the address length
747 * @param unixpath path to add
750 add_unixpath (struct sockaddr **saddrs,
751 socklen_t *saddrlens,
752 const char *unixpath)
755 struct sockaddr_un *un;
758 un = GNUNET_malloc (sizeof (struct sockaddr_un));
759 un->sun_family = AF_UNIX;
760 slen = strlen (unixpath) + 1;
761 if (slen >= sizeof (un->sun_path))
762 slen = sizeof (un->sun_path) - 1;
763 memcpy (un->sun_path,
766 un->sun_path[slen] = '\0';
768 un->sun_path[0] = '\0';
769 slen = sizeof (struct sockaddr_un);
771 slen += sizeof (sa_family_t);
773 *saddrs = (struct sockaddr*) un;
776 /* this function should never be called
777 unless AF_UNIX is defined! */
784 * Get the list of addresses that a server for the given service
787 * @param serviceName name of the service
788 * @param cfg configuration (which specifies the addresses)
789 * @param addrs set (call by reference) to an array of pointers to the
790 * addresses the server should bind to and listen on; the
791 * array will be NULL-terminated (on success)
792 * @param addr_lens set (call by reference) to an array of the lengths
793 * of the respective 'struct sockaddr' struct in the 'addrs'
795 * @return number of addresses found on success,
796 * GNUNET_SYSERR if the configuration
797 * did not specify reasonable finding information or
798 * if it specified a hostname that could not be resolved;
799 * GNUNET_NO if the number of addresses configured is
800 * zero (in this case, '*addrs' and '*addr_lens' will be
804 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
805 const struct GNUNET_CONFIGURATION_Handle *cfg,
806 struct sockaddr ***addrs,
807 socklen_t **addr_lens)
810 struct GNUNET_NETWORK_Handle *desc;
811 unsigned long long port;
813 struct addrinfo hints;
814 struct addrinfo *res;
815 struct addrinfo *pos;
816 struct addrinfo *next;
820 struct sockaddr **saddrs;
821 socklen_t *saddrlens;
827 if (GNUNET_CONFIGURATION_have_value (cfg,
828 serviceName, "DISABLEV6"))
831 (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
834 return GNUNET_SYSERR;
837 disablev6 = GNUNET_NO;
841 /* probe IPv6 support */
842 desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
845 if ((errno == ENOBUFS) ||
846 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
848 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
849 return GNUNET_SYSERR;
851 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
853 ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
854 serviceName, STRERROR (errno));
855 disablev6 = GNUNET_YES;
859 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
865 if (GNUNET_CONFIGURATION_have_value (cfg,
866 serviceName, "PORT"))
868 GNUNET_break (GNUNET_OK ==
869 GNUNET_CONFIGURATION_get_value_number (cfg,
875 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
877 ("Require valid port number for service `%s' in configuration!\n"),
879 return GNUNET_SYSERR;
883 if (GNUNET_CONFIGURATION_have_value (cfg,
884 serviceName, "BINDTO"))
886 GNUNET_break (GNUNET_OK ==
887 GNUNET_CONFIGURATION_get_value_string (cfg,
896 if (GNUNET_CONFIGURATION_have_value (cfg,
897 serviceName, "UNIXPATH"))
899 GNUNET_assert (GNUNET_OK ==
900 GNUNET_CONFIGURATION_get_value_string (cfg,
905 /* probe UNIX support */
906 struct sockaddr_un s_un;
907 if (strlen(unixpath) >= sizeof(s_un.sun_path))
909 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
910 _("UNIXPATH `%s' too long, maximum length is %llu\n"),unixpath, sizeof(s_un.sun_path));
911 GNUNET_free_non_null (hostname);
912 GNUNET_free (unixpath);
913 return GNUNET_SYSERR;
916 desc = GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_STREAM, 0);
919 if ((errno == ENOBUFS) ||
920 (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
922 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
923 GNUNET_free_non_null (hostname);
924 GNUNET_free (unixpath);
925 return GNUNET_SYSERR;
927 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
929 ("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
930 serviceName, STRERROR (errno));
931 GNUNET_free (unixpath);
936 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
949 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
950 _("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
952 GNUNET_free_non_null(hostname);
953 return GNUNET_SYSERR;
957 saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
958 saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
959 add_unixpath (saddrs, saddrlens, unixpath);
960 GNUNET_free_non_null (unixpath);
961 GNUNET_free_non_null(hostname);
963 *addr_lens = saddrlens;
967 if (hostname != NULL)
970 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
971 "Resolving `%s' since that is where `%s' will bind to.\n",
975 memset (&hints, 0, sizeof (struct addrinfo));
977 hints.ai_family = AF_INET;
978 if ((0 != (ret = getaddrinfo (hostname,
979 NULL, &hints, &res))) || (res == NULL))
981 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
982 _("Failed to resolve `%s': %s\n"),
983 hostname, gai_strerror (ret));
984 GNUNET_free (hostname);
985 GNUNET_free (unixpath);
986 return GNUNET_SYSERR;
990 while (NULL != (pos = next))
993 if ( (disablev6) && (pos->ai_family == AF_INET6))
999 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1000 _("Failed to find %saddress for `%s'.\n"),
1001 disablev6 ? "IPv4 " : "", hostname);
1003 GNUNET_free (hostname);
1004 GNUNET_free (unixpath);
1005 return GNUNET_SYSERR;
1008 if (NULL != unixpath)
1010 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1011 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1013 if (NULL != unixpath)
1015 add_unixpath (saddrs, saddrlens, unixpath);
1019 while (NULL != (pos = next))
1021 next = pos->ai_next;
1022 if ( (disablev6) && (pos->ai_family == AF_INET6))
1025 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1026 "Service `%s' will bind to `%s'\n",
1028 GNUNET_a2s (pos->ai_addr,
1031 if (pos->ai_family == AF_INET)
1033 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
1034 saddrlens[i] = pos->ai_addrlen;
1035 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1036 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
1037 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1041 GNUNET_assert (pos->ai_family == AF_INET6);
1042 GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
1043 saddrlens[i] = pos->ai_addrlen;
1044 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1045 memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
1046 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1050 GNUNET_free (hostname);
1055 /* will bind against everything, just set port */
1060 if (NULL != unixpath)
1063 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1064 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1065 if (NULL != unixpath)
1067 add_unixpath (saddrs, saddrlens, unixpath);
1070 saddrlens[i] = sizeof (struct sockaddr_in);
1071 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1072 #if HAVE_SOCKADDR_IN_SIN_LEN
1073 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
1075 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1076 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1082 if (NULL != unixpath)
1084 saddrs = GNUNET_malloc ((resi+1) * sizeof(struct sockaddr*));
1085 saddrlens = GNUNET_malloc ((resi+1) * sizeof (socklen_t));
1087 if (NULL != unixpath)
1089 add_unixpath (saddrs, saddrlens, unixpath);
1092 saddrlens[i] = sizeof (struct sockaddr_in6);
1093 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1094 #if HAVE_SOCKADDR_IN_SIN_LEN
1095 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
1097 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
1098 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
1100 saddrlens[i] = sizeof (struct sockaddr_in);
1101 saddrs[i] = GNUNET_malloc (saddrlens[i]);
1102 #if HAVE_SOCKADDR_IN_SIN_LEN
1103 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
1105 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
1106 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
1109 GNUNET_free_non_null (unixpath);
1111 *addr_lens = saddrlens;
1117 * Setup addr, addrlen, idle_timeout
1118 * based on configuration!
1120 * Configuration may specify:
1121 * - PORT (where to bind to for TCP)
1122 * - UNIXPATH (where to bind to for UNIX domain sockets)
1123 * - TIMEOUT (after how many ms does an inactive service timeout);
1124 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1125 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1126 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
1127 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1128 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
1129 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1131 * @return GNUNET_OK if configuration succeeded
1134 setup_service (struct GNUNET_SERVICE_Context *sctx)
1136 struct GNUNET_TIME_Relative idleout;
1146 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1147 sctx->serviceName, "TIMEOUT"))
1150 GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
1152 "TIMEOUT", &idleout))
1154 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1155 _("Specified value for `%s' of service `%s' is invalid\n"),
1158 return GNUNET_SYSERR;
1160 sctx->timeout = idleout;
1163 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1165 if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
1166 sctx->serviceName, "TOLERANT"))
1168 if (GNUNET_SYSERR ==
1169 (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1173 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1174 _("Specified value for `%s' of service `%s' is invalid\n"),
1177 return GNUNET_SYSERR;
1181 tolerant = GNUNET_NO;
1185 if ( (NULL != (lpid = getenv ("LISTEN_PID"))) &&
1186 (1 == sscanf (lpid, "%u", &pid)) &&
1187 (getpid () == (pid_t) pid) &&
1188 (NULL != (nfds = getenv ("LISTEN_FDS"))) &&
1189 (1 == sscanf (nfds, "%u", &cnt)) &&
1191 (cnt < FD_SETSIZE) &&
1192 (cnt + 4 < FD_SETSIZE) )
1194 sctx->lsocks = GNUNET_malloc (sizeof(struct GNUNET_NETWORK_Handle*) * (cnt+1));
1197 flags = fcntl (3 + cnt, F_GETFD);
1199 (0 != (flags & FD_CLOEXEC)) ||
1200 (NULL == (sctx->lsocks[cnt] = GNUNET_NETWORK_socket_box_native (3 + cnt))) )
1202 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1203 _("Could not access pre-bound socket %u, will try to bind myself\n"),
1204 (unsigned int) 3 +cnt);
1206 while (sctx->lsocks[cnt] != NULL)
1207 GNUNET_break (0 == GNUNET_NETWORK_socket_close (sctx->lsocks[cnt++]));
1208 GNUNET_free (sctx->lsocks);
1209 sctx->lsocks = NULL;
1213 unsetenv ("LISTEN_PID");
1214 unsetenv ("LISTEN_FDS");
1218 if ( (sctx->lsocks == NULL) &&
1220 GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1224 return GNUNET_SYSERR;
1225 sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1226 sctx->match_uid = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1229 sctx->match_gid = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
1232 process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1233 process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1234 process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1235 process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1242 * Get the name of the user that'll be used
1243 * to provide the service.
1246 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1252 GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1263 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1271 if (NULL == (pif = get_pid_file_name (sctx)))
1272 return GNUNET_OK; /* no file desired */
1273 user = get_user_name (sctx);
1274 rdir = GNUNET_strdup (pif);
1275 len = strlen (rdir);
1276 while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1279 if (0 != ACCESS (rdir, F_OK))
1281 /* we get to create a directory -- and claim it
1283 GNUNET_DISK_directory_create (rdir);
1284 if ((user != NULL) && (0 < strlen (user)))
1285 GNUNET_DISK_file_change_owner (rdir, user);
1287 if (0 != ACCESS (rdir, W_OK | X_OK))
1289 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1291 GNUNET_free_non_null (user);
1293 return GNUNET_SYSERR;
1296 pidfd = FOPEN (pif, "w");
1299 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1301 GNUNET_free_non_null (user);
1302 return GNUNET_SYSERR;
1304 if (0 > FPRINTF (pidfd, "%u", pid))
1305 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1306 GNUNET_break (0 == fclose (pidfd));
1307 if ((user != NULL) && (0 < strlen (user)))
1308 GNUNET_DISK_file_change_owner (pif, user);
1309 GNUNET_free_non_null (user);
1316 * Task run during shutdown.
1322 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1324 struct GNUNET_SERVER_Handle *server = cls;
1326 GNUNET_SERVER_destroy (server);
1331 * Initial task for the service.
1334 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1336 struct GNUNET_SERVICE_Context *sctx = cls;
1339 if (sctx->lsocks != NULL)
1340 sctx->server = GNUNET_SERVER_create_with_sockets (&check_access,
1343 sctx->timeout, sctx->require_found);
1345 sctx->server = GNUNET_SERVER_create (&check_access,
1349 sctx->timeout, sctx->require_found);
1350 if (sctx->server == NULL)
1352 if (sctx->addrs != NULL)
1355 while (sctx->addrs[i] != NULL)
1357 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1358 _("Failed to start `%s' at `%s'\n"),
1360 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1364 sctx->ret = GNUNET_SYSERR;
1367 if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1369 /* install a task that will kill the server
1370 process if the scheduler ever gets a shutdown signal */
1371 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1372 &shutdown_task, sctx->server);
1374 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1375 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1377 while ((sctx->my_handlers[i].callback != NULL))
1378 sctx->my_handlers[i++].callback_cls = sctx;
1379 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1380 if (sctx->ready_confirm_fd != -1)
1382 GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1383 GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1384 sctx->ready_confirm_fd = -1;
1385 write_pid_file (sctx, getpid ());
1387 if (sctx->addrs != NULL)
1390 while (sctx->addrs[i] != NULL)
1392 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1393 _("Service `%s' runs at %s\n"),
1395 GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1399 sctx->task (sctx->task_cls, sctx->server, sctx->cfg);
1404 * Detach from terminal.
1407 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1414 if (0 != PIPE (filedes))
1416 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1417 return GNUNET_SYSERR;
1422 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1423 return GNUNET_SYSERR;
1430 GNUNET_break (0 == CLOSE (filedes[1]));
1432 if (1 != READ (filedes[0], &c, sizeof (char)))
1433 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1440 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1441 _("Service process failed to initialize\n"));
1444 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1446 ("Service process could not initialize server function\n"));
1449 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1450 _("Service process failed to report status\n"));
1453 exit (1); /* child reported error */
1455 GNUNET_break (0 == CLOSE (0));
1456 GNUNET_break (0 == CLOSE (1));
1457 GNUNET_break (0 == CLOSE (filedes[0]));
1458 nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1460 return GNUNET_SYSERR;
1461 /* set stdin/stdout to /dev/null */
1462 if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1464 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1465 (void) CLOSE (nullfd);
1466 return GNUNET_SYSERR;
1468 (void) CLOSE (nullfd);
1469 /* Detach from controlling terminal */
1472 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1473 sctx->ready_confirm_fd = filedes[1];
1475 /* FIXME: we probably need to do something else
1476 elsewhere in order to fork the process itself... */
1487 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1491 if (NULL == (user = get_user_name (sctx)))
1492 return GNUNET_OK; /* keep */
1497 pws = getpwnam (user);
1500 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1501 _("Cannot obtain information about user `%s': %s\n"),
1502 user, errno == 0 ? _("No such user") : STRERROR (errno));
1504 return GNUNET_SYSERR;
1506 if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1508 (0 != initgroups (user, pws->pw_gid)) ||
1510 (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1512 if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1513 (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1515 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1516 _("Cannot change user/group to `%s': %s\n"), user,
1519 return GNUNET_SYSERR;
1529 * Delete the PID file that was created by our parent.
1532 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1534 char *pif = get_pid_file_name (sctx);
1536 return; /* no PID file */
1537 if (0 != UNLINK (pif))
1538 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1544 * Run a standard GNUnet service startup sequence (initialize loggers
1545 * and configuration, parse options).
1547 * @param argc number of command line arguments
1548 * @param argv command line arguments
1549 * @param serviceName our service name
1550 * @param opt service options
1551 * @param task main task of the service
1552 * @param task_cls closure for task
1553 * @return GNUNET_SYSERR on error, GNUNET_OK
1554 * if we shutdown nicely
1557 GNUNET_SERVICE_run (int argc,
1559 const char *serviceName,
1560 enum GNUNET_SERVICE_Options opt,
1561 GNUNET_SERVICE_Main task, void *task_cls)
1563 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1571 struct GNUNET_SERVICE_Context sctx;
1572 struct GNUNET_CONFIGURATION_Handle *cfg;
1573 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1574 GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1575 {'d', "daemonize", NULL,
1576 gettext_noop ("do daemonize (detach from terminal)"), 0,
1577 GNUNET_GETOPT_set_one, &do_daemonize},
1578 GNUNET_GETOPT_OPTION_HELP (serviceName),
1579 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1580 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1581 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1582 GNUNET_GETOPT_OPTION_END
1587 loglev = GNUNET_strdup ("WARNING");
1588 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
1589 memset (&sctx, 0, sizeof (sctx));
1591 sctx.ready_confirm_fd = -1;
1592 sctx.ret = GNUNET_OK;
1593 sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1595 sctx.task_cls = task_cls;
1596 sctx.serviceName = serviceName;
1597 sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1598 /* setup subsystems */
1599 if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1602 if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1604 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1606 if (GNUNET_OK != setup_service (&sctx))
1608 if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1610 if (GNUNET_OK != set_user_id (&sctx))
1613 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1614 "Service `%s' runs with configuration from `%s'\n",
1615 serviceName, cfg_fn);
1617 /* actually run service */
1618 GNUNET_SCHEDULER_run (&service_task, &sctx);
1621 if ((do_daemonize == 1) && (sctx.server != NULL))
1622 pid_file_delete (&sctx);
1623 GNUNET_free_non_null (sctx.my_handlers);
1626 if (sctx.ready_confirm_fd != -1)
1628 if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1629 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1630 GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1633 GNUNET_CONFIGURATION_destroy (cfg);
1635 if (sctx.addrs != NULL)
1636 while (sctx.addrs[i] != NULL)
1637 GNUNET_free (sctx.addrs[i++]);
1638 GNUNET_free_non_null (sctx.addrs);
1639 GNUNET_free_non_null (sctx.addrlens);
1640 GNUNET_free_non_null (logfile);
1641 GNUNET_free (loglev);
1642 GNUNET_free (cfg_fn);
1643 GNUNET_free_non_null (sctx.v4_denied);
1644 GNUNET_free_non_null (sctx.v6_denied);
1645 GNUNET_free_non_null (sctx.v4_allowed);
1646 GNUNET_free_non_null (sctx.v6_allowed);
1648 return err ? GNUNET_SYSERR : sctx.ret;
1653 * Run a service startup sequence within an existing
1654 * initialized system.
1656 * @param serviceName our service name
1657 * @param cfg configuration to use
1658 * @return NULL on error, service handle
1660 struct GNUNET_SERVICE_Context *
1661 GNUNET_SERVICE_start (const char *serviceName,
1662 const struct GNUNET_CONFIGURATION_Handle *cfg)
1665 struct GNUNET_SERVICE_Context *sctx;
1667 sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1668 sctx->ready_confirm_fd = -1; /* no daemonizing */
1669 sctx->ret = GNUNET_OK;
1670 sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1671 sctx->serviceName = serviceName;
1674 /* setup subsystems */
1675 if (GNUNET_OK != setup_service (sctx))
1677 GNUNET_SERVICE_stop (sctx);
1680 if (sctx->lsocks != NULL)
1681 sctx->server = GNUNET_SERVER_create_with_sockets (&check_access,
1684 sctx->timeout, sctx->require_found);
1686 sctx->server = GNUNET_SERVER_create (&check_access,
1691 sctx->require_found);
1693 if (NULL == sctx->server)
1695 GNUNET_SERVICE_stop (sctx);
1698 sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1699 memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1701 while ((sctx->my_handlers[i].callback != NULL))
1702 sctx->my_handlers[i++].callback_cls = sctx;
1703 GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1708 * Obtain the server used by a service. Note that the server must NOT
1709 * be destroyed by the caller.
1711 * @param ctx the service context returned from the start function
1712 * @return handle to the server for this service, NULL if there is none
1714 struct GNUNET_SERVER_Handle *
1715 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1722 * Stop a service that was started with "GNUNET_SERVICE_start".
1724 * @param sctx the service context returned from the start function
1727 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1730 if (NULL != sctx->server)
1731 GNUNET_SERVER_destroy (sctx->server);
1732 GNUNET_free_non_null (sctx->my_handlers);
1733 if (sctx->addrs != NULL)
1736 while (sctx->addrs[i] != NULL)
1737 GNUNET_free (sctx->addrs[i++]);
1738 GNUNET_free (sctx->addrs);
1740 GNUNET_free_non_null (sctx->addrlens);
1741 GNUNET_free_non_null (sctx->v4_denied);
1742 GNUNET_free_non_null (sctx->v6_denied);
1743 GNUNET_free_non_null (sctx->v4_allowed);
1744 GNUNET_free_non_null (sctx->v6_allowed);
1749 /* end of service.c */