src/util/service.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file util/service.c
  23  * @brief functions related to starting services
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  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"
  37
  38 #define DEBUG_SERVICE GNUNET_NO
  39
  40 /* ******************* access control ******************** */
  41
  42 /**
  43  * @brief IPV4 network in CIDR notation.
  44  */
  45 struct IPv4NetworkSet
  46 {
  47   struct in_addr network;
  48   struct in_addr netmask;
  49 };
  50
  51 /**
  52  * @brief network in CIDR notation for IPV6.
  53  */
  54 struct IPv6NetworkSet
  55 {
  56   struct in6_addr network;
  57   struct in6_addr netmask;
  58 };
  59
  60
  61 /**
  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).
  68  * <p>
  69  * @param routeList a string specifying the forbidden networks
  70  * @return the converted list, NULL if the synatx is flawed
  71  */
  72 static struct IPv4NetworkSet *
  73 parse_ipv4_specification (const char *routeList)
  74 {
  75   unsigned int count;
  76   unsigned int i;
  77   unsigned int j;
  78   unsigned int len;
  79   int cnt;
  80   unsigned int pos;
  81   unsigned int temps[8];
  82   int slash;
  83   struct IPv4NetworkSet *result;
  84
  85   if (routeList == NULL)
  86     return NULL;
  87   len = strlen (routeList);
  88   if (len == 0)
  89     return NULL;
  90   count = 0;
  91   for (i = 0; i < len; i++)
  92     if (routeList[i] == ';')
  93       count++;
  94   result = GNUNET_malloc (sizeof (struct IPv4NetworkSet) * (count + 1));
  95   /* add termination */
  96   memset (result, 0, sizeof (struct IPv4NetworkSet) * (count + 1));
  97   i = 0;
  98   pos = 0;
  99   while (i < count)
 100     {
 101       cnt = sscanf (&routeList[pos],
 102                     "%u.%u.%u.%u/%u.%u.%u.%u;",
 103                     &temps[0],
 104                     &temps[1],
 105                     &temps[2],
 106                     &temps[3], &temps[4], &temps[5], &temps[6], &temps[7]);
 107       if (cnt == 8)
 108         {
 109           for (j = 0; j < 8; j++)
 110             if (temps[j] > 0xFF)
 111               {
 112                 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 113                             _("Invalid format for IP: `%s'\n"),
 114                             &routeList[pos]);
 115                 GNUNET_free (result);
 116                 return NULL;
 117               }
 118           result[i].network.s_addr
 119             =
 120             htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
 121                    temps[3]);
 122           result[i].netmask.s_addr =
 123             htonl ((temps[4] << 24) + (temps[5] << 16) + (temps[6] << 8) +
 124                    temps[7]);
 125           while (routeList[pos] != ';')
 126             pos++;
 127           pos++;
 128           i++;
 129           continue;
 130         }
 131       /* try second notation */
 132       cnt = sscanf (&routeList[pos],
 133                     "%u.%u.%u.%u/%u;",
 134                     &temps[0], &temps[1], &temps[2], &temps[3], &slash);
 135       if (cnt == 5)
 136         {
 137           for (j = 0; j < 4; j++)
 138             if (temps[j] > 0xFF)
 139               {
 140                 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 141                             _("Invalid format for IP: `%s'\n"),
 142                             &routeList[pos]);
 143                 GNUNET_free (result);
 144                 return NULL;
 145               }
 146           result[i].network.s_addr
 147             =
 148             htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
 149                    temps[3]);
 150           if ((slash <= 32) && (slash >= 0))
 151             {
 152               result[i].netmask.s_addr = 0;
 153               while (slash > 0)
 154                 {
 155                   result[i].netmask.s_addr
 156                     = (result[i].netmask.s_addr >> 1) + 0x80000000;
 157                   slash--;
 158                 }
 159               result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
 160               while (routeList[pos] != ';')
 161                 pos++;
 162               pos++;
 163               i++;
 164               continue;
 165             }
 166           else
 167             {
 168               GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 169                           _
 170                           ("Invalid network notation ('/%d' is not legal in IPv4 CIDR)."),
 171                           slash);
 172               GNUNET_free (result);
 173               return NULL;      /* error */
 174             }
 175         }
 176       /* try third notation */
 177       slash = 32;
 178       cnt = sscanf (&routeList[pos],
 179                     "%u.%u.%u.%u;",
 180                     &temps[0], &temps[1], &temps[2], &temps[3]);
 181       if (cnt == 4)
 182         {
 183           for (j = 0; j < 4; j++)
 184             if (temps[j] > 0xFF)
 185               {
 186                 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 187                             _("Invalid format for IP: `%s'\n"),
 188                             &routeList[pos]);
 189                 GNUNET_free (result);
 190                 return NULL;
 191               }
 192           result[i].network.s_addr
 193             =
 194             htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
 195                    temps[3]);
 196           result[i].netmask.s_addr = 0;
 197           while (slash > 0)
 198             {
 199               result[i].netmask.s_addr
 200                 = (result[i].netmask.s_addr >> 1) + 0x80000000;
 201               slash--;
 202             }
 203           result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
 204           while (routeList[pos] != ';')
 205             pos++;
 206           pos++;
 207           i++;
 208           continue;
 209         }
 210       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 211                   _("Invalid format for IP: `%s'\n"), &routeList[pos]);
 212       GNUNET_free (result);
 213       return NULL;              /* error */
 214     }
 215   if (pos < strlen (routeList))
 216     {
 217       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 218                   _("Invalid format for IP: `%s'\n"), &routeList[pos]);
 219       GNUNET_free (result);
 220       return NULL;              /* oops */
 221     }
 222   return result;                /* ok */
 223 }
 224
 225
 226 /**
 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.
 233  * <p>
 234  * @param routeListX a string specifying the forbidden networks
 235  * @return the converted list, NULL if the synatx is flawed
 236  */
 237 static struct IPv6NetworkSet *
 238 parse_ipv6_specification (const char *routeListX)
 239 {
 240   unsigned int count;
 241   unsigned int i;
 242   unsigned int len;
 243   unsigned int pos;
 244   int start;
 245   int slash;
 246   int ret;
 247   char *routeList;
 248   struct IPv6NetworkSet *result;
 249   unsigned int bits;
 250   unsigned int off;
 251   int save;
 252
 253   if (routeListX == NULL)
 254     return NULL;
 255   len = strlen (routeListX);
 256   if (len == 0)
 257     return NULL;
 258   routeList = GNUNET_strdup (routeListX);
 259   count = 0;
 260   for (i = 0; i < len; i++)
 261     if (routeList[i] == ';')
 262       count++;
 263   if (routeList[len - 1] != ';')
 264     {
 265       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 266                   _
 267                   ("Invalid network notation (does not end with ';': `%s')\n"),
 268                   routeList);
 269       GNUNET_free (routeList);
 270       return NULL;
 271     }
 272
 273   result = GNUNET_malloc (sizeof (struct IPv6NetworkSet) * (count + 1));
 274   memset (result, 0, sizeof (struct IPv6NetworkSet) * (count + 1));
 275   i = 0;
 276   pos = 0;
 277   while (i < count)
 278     {
 279       start = pos;
 280       while (routeList[pos] != ';')
 281         pos++;
 282       slash = pos;
 283       while ((slash >= start) && (routeList[slash] != '/'))
 284         slash--;
 285       if (slash < start)
 286         {
 287           memset (&result[i].netmask, 0xFF, sizeof (struct in6_addr));
 288           slash = pos;
 289         }
 290       else
 291         {
 292           routeList[pos] = '\0';
 293           ret = inet_pton (AF_INET6,
 294                            &routeList[slash + 1], &result[i].netmask);
 295           if (ret <= 0)
 296             {
 297               save = errno;
 298               if ((1 != SSCANF (&routeList[slash + 1],
 299                                 "%u", &bits)) || (bits >= 128))
 300                 {
 301                   if (ret == 0)
 302                     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 303                                 _("Wrong format `%s' for netmask\n"),
 304                                 &routeList[slash + 1]);
 305                   else
 306                     {
 307                       errno = save;
 308                       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
 309                                            "inet_pton");
 310                     }
 311                   GNUNET_free (result);
 312                   GNUNET_free (routeList);
 313                   return NULL;
 314                 }
 315               off = 0;
 316               while (bits > 8)
 317                 {
 318                   result[i].netmask.s6_addr[off++] = 0xFF;
 319                   bits -= 8;
 320                 }
 321               while (bits > 0)
 322                 {
 323                   result[i].netmask.s6_addr[off]
 324                     = (result[i].netmask.s6_addr[off] >> 1) + 0x80;
 325                   bits--;
 326                 }
 327             }
 328         }
 329       routeList[slash] = '\0';
 330       ret = inet_pton (AF_INET6, &routeList[start], &result[i].network);
 331       if (ret <= 0)
 332         {
 333           if (ret == 0)
 334             GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 335                         _("Wrong format `%s' for network\n"),
 336                         &routeList[slash + 1]);
 337           else
 338             GNUNET_log_strerror(GNUNET_ERROR_TYPE_ERROR, "inet_pton");
 339           GNUNET_free (result);
 340           GNUNET_free (routeList);
 341           return NULL;
 342         }
 343       pos++;
 344       i++;
 345     }
 346   GNUNET_free (routeList);
 347   return result;
 348 }
 349
 350
 351 /**
 352  * Check if the given IP address is in the list of IP addresses.
 353  *
 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
 357  */
 358 static int
 359 check_ipv4_listed (const struct IPv4NetworkSet *list,
 360                    const struct in_addr *add)
 361 {
 362   int i;
 363
 364   i = 0;
 365   if (list == NULL)
 366     return GNUNET_NO;
 367
 368   while ((list[i].network.s_addr != 0) || (list[i].netmask.s_addr != 0))
 369     {
 370       if ((add->s_addr & list[i].netmask.s_addr) ==
 371           (list[i].network.s_addr & list[i].netmask.s_addr))
 372         return GNUNET_YES;
 373       i++;
 374     }
 375   return GNUNET_NO;
 376 }
 377
 378 /**
 379  * Check if the given IP address is in the list of IP addresses.
 380  *
 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
 384  */
 385 static int
 386 check_ipv6_listed (const struct IPv6NetworkSet *list,
 387                    const struct in6_addr *ip)
 388 {
 389   unsigned int i;
 390   unsigned int j;
 391   struct in6_addr zero;
 392
 393   if (list == NULL)
 394     return GNUNET_NO;
 395
 396   memset (&zero, 0, sizeof (struct in6_addr));
 397   i = 0;
 398 NEXT:
 399   while (memcmp (&zero, &list[i].network, sizeof (struct in6_addr)) != 0)
 400     {
 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]))
 404           {
 405             i++;
 406             goto NEXT;
 407           }
 408       return GNUNET_YES;
 409     }
 410   return GNUNET_NO;
 411 }
 412
 413
 414 /* ****************** service struct ****************** */
 415
 416
 417 /**
 418  * Context for "service_task".
 419  */
 420 struct GNUNET_SERVICE_Context
 421 {
 422   /**
 423    * Our configuration.
 424    */
 425   const struct GNUNET_CONFIGURATION_Handle *cfg;
 426
 427   /**
 428    * Handle for the server.
 429    */
 430   struct GNUNET_SERVER_Handle *server;
 431
 432   /**
 433    * Scheduler for the server.
 434    */
 435   struct GNUNET_SCHEDULER_Handle *sched;
 436
 437   /**
 438    * NULL-terminated array of addresses to bind to.
 439    */
 440   struct sockaddr **addrs;
 441
 442   /**
 443    * Name of our service.
 444    */
 445   const char *serviceName;
 446
 447   /**
 448    * Main service-specific task to run.
 449    */
 450   GNUNET_SERVICE_Main task;
 451
 452   /**
 453    * Closure for task.
 454    */
 455   void *task_cls;
 456
 457   /**
 458    * IPv4 addresses that are not allowed to connect.
 459    */
 460   struct IPv4NetworkSet *v4_denied;
 461
 462   /**
 463    * IPv6 addresses that are not allowed to connect.
 464    */
 465   struct IPv6NetworkSet *v6_denied;
 466
 467   /**
 468    * IPv4 addresses that are allowed to connect (if not
 469    * set, all are allowed).
 470    */
 471   struct IPv4NetworkSet *v4_allowed;
 472
 473   /**
 474    * IPv6 addresses that are allowed to connect (if not
 475    * set, all are allowed).
 476    */
 477   struct IPv6NetworkSet *v6_allowed;
 478
 479   /**
 480    * My (default) message handlers.  Adjusted copy
 481    * of "defhandlers".
 482    */
 483   struct GNUNET_SERVER_MessageHandler *my_handlers;
 484
 485   /**
 486    * Idle timeout for server.
 487    */
 488   struct GNUNET_TIME_Relative timeout;
 489
 490   /**
 491    * Maximum buffer size for the server.
 492    */
 493   size_t maxbuf;
 494
 495   /**
 496    * Overall success/failure of the service start.
 497    */
 498   int ret;
 499
 500   /**
 501    * If we are daemonizing, this FD is set to the
 502    * pipe to the parent.  Send '.' if we started
 503    * ok, '!' if not.  -1 if we are not daemonizing.
 504    */
 505   int ready_confirm_fd;
 506
 507   /**
 508    * Do we close connections if we receive messages
 509    * for which we have no handler?
 510    */
 511   int require_found;
 512
 513   /**
 514    * Our options.
 515    */
 516   enum GNUNET_SERVICE_Options options;
 517
 518   /**
 519    * Array of the lengths of the entries in addrs.
 520    */
 521   socklen_t * addrlens;
 522
 523 };
 524
 525
 526 /* ****************** message handlers ****************** */
 527
 528 static size_t
 529 write_test (void *cls, size_t size, void *buf)
 530 {
 531   struct GNUNET_SERVER_Client *client = cls;
 532   struct GNUNET_MessageHeader *msg;
 533
 534   if (size < sizeof (struct GNUNET_MessageHeader))
 535     {
 536       GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 537       return 0;                 /* client disconnected */
 538     }
 539   msg = (struct GNUNET_MessageHeader *) buf;
 540   msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
 541   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 542   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 543   return sizeof (struct GNUNET_MessageHeader);
 544 }
 545
 546 /**
 547  * Handler for TEST message.
 548  *
 549  * @param cls closure (refers to service)
 550  * @param client identification of the client
 551  * @param message the actual message
 552  */
 553 static void
 554 handle_test (void *cls,
 555              struct GNUNET_SERVER_Client *client,
 556              const struct GNUNET_MessageHeader *message)
 557 {
 558   /* simply bounce message back to acknowledge */
 559   if (NULL == GNUNET_SERVER_notify_transmit_ready (client,
 560                                                    sizeof (struct
 561                                                            GNUNET_MessageHeader),
 562                                                    GNUNET_TIME_UNIT_FOREVER_REL,
 563                                                    &write_test, client))
 564     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 565 }
 566
 567
 568 /**
 569  * Default handlers for all services.  Will be copied and the
 570  * "callback_cls" fields will be replaced with the specific service
 571  * struct.
 572  */
 573 static const struct GNUNET_SERVER_MessageHandler defhandlers[] = {
 574   {&handle_test, NULL, GNUNET_MESSAGE_TYPE_TEST,
 575    sizeof (struct GNUNET_MessageHeader)},
 576   {NULL, NULL, 0, 0}
 577 };
 578
 579
 580
 581 /* ****************** service core routines ************** */
 582
 583
 584 /**
 585  * Check if access to the service is allowed from the given address.
 586  */
 587 static int
 588 check_access (void *cls, const struct sockaddr *addr, socklen_t addrlen)
 589 {
 590   struct GNUNET_SERVICE_Context *sctx = cls;
 591   const struct sockaddr_in *i4;
 592   const struct sockaddr_in6 *i6;
 593   int ret;
 594
 595   switch (addr->sa_family)
 596     {
 597     case AF_INET:
 598       GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
 599       i4 = (const struct sockaddr_in *) addr;
 600       ret = ((sctx->v4_allowed == NULL) ||
 601              (check_ipv4_listed (sctx->v4_allowed,
 602                                  &i4->sin_addr)))
 603         && ((sctx->v4_denied == NULL) ||
 604             (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr)));
 605       break;
 606     case AF_INET6:
 607       GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
 608       i6 = (const struct sockaddr_in6 *) addr;
 609       ret = ((sctx->v6_allowed == NULL) ||
 610              (check_ipv6_listed (sctx->v6_allowed,
 611                                  &i6->sin6_addr)))
 612         && ((sctx->v6_denied == NULL) ||
 613             (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr)));
 614       break;
 615     default:
 616       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 617                   _("Unknown address family %d\n"), addr->sa_family);
 618       return GNUNET_SYSERR;
 619     }
 620   if (ret != GNUNET_OK)
 621     {
 622       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 623                   _("Access from `%s' denied to service `%s'\n"),
 624                   GNUNET_a2s (addr, addrlen), sctx->serviceName);
 625     }
 626   return ret;
 627 }
 628
 629
 630 /**
 631  * Get the name of the file where we will
 632  * write the PID of the service.
 633  */
 634 static char *
 635 get_pid_file_name (struct GNUNET_SERVICE_Context *sctx)
 636 {
 637
 638   char *pif;
 639
 640   if (GNUNET_OK !=
 641       GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
 642                                                sctx->serviceName,
 643                                                "PIDFILE", &pif))
 644     return NULL;
 645   return pif;
 646 }
 647
 648
 649 /**
 650  * Parse an IPv4 access control list.
 651  */
 652 static int
 653 process_acl4 (struct IPv4NetworkSet **ret,
 654               struct GNUNET_SERVICE_Context *sctx, const char *option)
 655 {
 656   char *opt;
 657
 658   if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
 659     return GNUNET_OK;
 660   GNUNET_break (GNUNET_OK ==
 661                 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
 662                                                        sctx->serviceName,
 663                                                        option, &opt));
 664   if (NULL == (*ret = parse_ipv4_specification (opt)))
 665     {
 666       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 667                   _
 668                   ("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
 669                   opt, sctx->serviceName, option);
 670       GNUNET_free (opt);
 671       return GNUNET_SYSERR;
 672     }
 673   GNUNET_free (opt);
 674   return GNUNET_OK;
 675 }
 676
 677
 678 /**
 679  * Parse an IPv4 access control list.
 680  */
 681 static int
 682 process_acl6 (struct IPv6NetworkSet **ret,
 683               struct GNUNET_SERVICE_Context *sctx, const char *option)
 684 {
 685   char *opt;
 686   if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option))
 687     return GNUNET_OK;
 688   GNUNET_break (GNUNET_OK ==
 689                 GNUNET_CONFIGURATION_get_value_string (sctx->cfg,
 690                                                        sctx->serviceName,
 691                                                        option, &opt));
 692   if (NULL == (*ret = parse_ipv6_specification (opt)))
 693     {
 694       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 695                   _
 696                   ("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
 697                   opt, sctx->serviceName, option);
 698       GNUNET_free (opt);
 699       return GNUNET_SYSERR;
 700     }
 701   GNUNET_free (opt);
 702   return GNUNET_OK;
 703 }
 704
 705
 706 /**
 707  * Get the list of addresses that a server for the given service
 708  * should bind to.
 709  *
 710  * @param serviceName name of the service
 711  * @param cfg configuration (which specifies the addresses)
 712  * @param addrs set (call by reference) to an array of pointers to the
 713  *              addresses the server should bind to and listen on; the
 714  *              array will be NULL-terminated (on success)
 715  * @param addr_lens set (call by reference) to an array of the lengths
 716  *              of the respective 'struct sockaddr' struct in the 'addrs'
 717  *              array (on success)
 718  * @return number of addresses found on success,
 719  *              GNUNET_SYSERR if the configuration
 720  *              did not specify reasonable finding information or
 721  *              if it specified a hostname that could not be resolved;
 722  *              GNUNET_NO if the number of addresses configured is
 723  *              zero (in this case, '*addrs' and '*addr_lens' will be
 724  *              set to NULL).
 725  */
 726 int
 727 GNUNET_SERVICE_get_server_addresses (const char *serviceName,
 728                                      const struct GNUNET_CONFIGURATION_Handle *cfg,
 729                                      struct sockaddr ***addrs,
 730                                      socklen_t **addr_lens)
 731 {
 732   int disablev6;
 733   struct GNUNET_NETWORK_Handle *desc;
 734   unsigned long long port;
 735   struct addrinfo hints;
 736   struct addrinfo *res;
 737   struct addrinfo *pos;
 738   struct addrinfo *next;
 739   unsigned int i;
 740   int resi;
 741   int ret;
 742   struct sockaddr **saddrs;
 743   socklen_t *saddrlens;
 744   char *hostname;
 745
 746   *addrs = NULL;
 747   *addr_lens = NULL;
 748   if (GNUNET_CONFIGURATION_have_value (cfg,
 749                                        serviceName, "DISABLEV6"))
 750     {
 751       if (GNUNET_SYSERR ==
 752           (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
 753                                                              serviceName,
 754                                                              "DISABLEV6")))
 755         return GNUNET_SYSERR;
 756     }
 757   else
 758     disablev6 = GNUNET_NO;
 759
 760   if (!disablev6)
 761     {
 762       /* probe IPv6 support */
 763       desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
 764       if (NULL == desc)
 765         {
 766           if ((errno == ENOBUFS) ||
 767               (errno == ENOMEM) || (errno == ENFILE) || (errno == EACCES))
 768             {
 769               GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
 770               return GNUNET_SYSERR;
 771             }
 772           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 773                       _
 774                       ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
 775                       serviceName, STRERROR (errno));
 776           disablev6 = GNUNET_YES;
 777         }
 778       else
 779         {
 780           GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
 781         }
 782     }
 783
 784
 785   if ((GNUNET_OK !=
 786        GNUNET_CONFIGURATION_get_value_number (cfg,
 787                                               serviceName,
 788                                               "PORT",
 789                                               &port)) || (port > 65535))
 790     {
 791       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 792                   _
 793                   ("Require valid port number for service `%s' in configuration!\n"),
 794                   serviceName);
 795       return GNUNET_SYSERR;
 796     }
 797   if (GNUNET_CONFIGURATION_have_value (cfg,
 798                                        serviceName, "BINDTO"))
 799     {
 800       GNUNET_break (GNUNET_OK ==
 801                     GNUNET_CONFIGURATION_get_value_string (cfg,
 802                                                            serviceName,
 803                                                            "BINDTO",
 804                                                            &hostname));
 805     }
 806   else
 807     hostname = NULL;
 808
 809   if (hostname != NULL)
 810     {
 811 #if DEBUG_SERVICE
 812       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 813                   "Resolving `%s' since that is where `%s' will bind to.\n",
 814                   hostname,
 815                   serviceName);
 816 #endif
 817       memset (&hints, 0, sizeof (struct addrinfo));
 818       if (disablev6)
 819         hints.ai_family = AF_INET;
 820       if ((0 != (ret = getaddrinfo (hostname,
 821                                     NULL, &hints, &res))) || (res == NULL))
 822         {
 823           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 824                       _("Failed to resolve `%s': %s\n"),
 825                       hostname, gai_strerror (ret));
 826           GNUNET_free (hostname);
 827           return GNUNET_SYSERR;
 828         }
 829       next = res;
 830       i = 0;
 831       while (NULL != (pos = next))
 832         {
 833           next = pos->ai_next;
 834           if ( (disablev6) && (pos->ai_family == AF_INET6))
 835             continue;
 836           i++;
 837         }
 838       if (0 == i)
 839         {
 840           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 841                       _("Failed to find %saddress for `%s'.\n"),
 842                       disablev6 ? "IPv4 " : "", hostname);
 843           freeaddrinfo (res);
 844           GNUNET_free (hostname);
 845           return GNUNET_SYSERR;
 846         }
 847       resi = i;
 848       saddrs = GNUNET_malloc ((i+1) * sizeof(struct sockaddr*));
 849       saddrlens = GNUNET_malloc ((i+1) * sizeof (socklen_t));
 850       i = 0;
 851       next = res;
 852       while (NULL != (pos = next))
 853         {
 854           next = pos->ai_next;
 855           if ( (disablev6) && (pos->ai_family == AF_INET6))
 856             continue;
 857 #if DEBUG_SERVICE
 858           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 859                       "Service `%s' will bind to `%s'\n",
 860                       serviceName,
 861                       GNUNET_a2s (pos->ai_addr,
 862                                   pos->ai_addrlen));
 863 #endif
 864           if (pos->ai_family == AF_INET)
 865             {
 866               GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in));
 867               saddrlens[i] = pos->ai_addrlen;
 868               saddrs[i] = GNUNET_malloc (saddrlens[i]);
 869               memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
 870               ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
 871             }
 872           else
 873             {
 874               GNUNET_assert (pos->ai_family == AF_INET6);
 875               GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6));
 876               saddrlens[i] = pos->ai_addrlen;
 877               saddrs[i] = GNUNET_malloc (saddrlens[i]);
 878               memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
 879               ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
 880             }
 881           i++;
 882         }
 883       GNUNET_free (hostname);
 884       freeaddrinfo (res);
 885     }
 886   else
 887     {
 888       /* will bind against everything, just set port */
 889       if (disablev6)
 890         {
 891           /* V4-only */
 892           resi = 1;
 893           saddrs = GNUNET_malloc (2 * sizeof(struct sockaddr*));
 894           saddrlens = GNUNET_malloc (2 * sizeof (socklen_t));
 895           saddrlens[0] = sizeof (struct sockaddr_in);
 896           saddrs[0] = GNUNET_malloc (saddrlens[0]);
 897 #if HAVE_SOCKADDR_IN_SIN_LEN
 898           ((struct sockaddr_in *) saddrs[0])->sin_len = saddrlens[0];
 899 #endif
 900           ((struct sockaddr_in *) saddrs[0])->sin_family = AF_INET;
 901           ((struct sockaddr_in *) saddrs[0])->sin_port = htons (port);
 902         }
 903       else
 904         {
 905           /* dual stack */
 906           resi = 2;
 907           saddrs = GNUNET_malloc (3 * sizeof(struct sockaddr*));
 908           saddrlens = GNUNET_malloc (3 * sizeof (socklen_t));
 909
 910           saddrlens[0] = sizeof (struct sockaddr_in6);
 911           saddrs[0] = GNUNET_malloc (saddrlens[0]);
 912 #if HAVE_SOCKADDR_IN_SIN_LEN
 913           ((struct sockaddr_in6 *) saddrs[0])->sin6_len = saddrlens[0];
 914 #endif
 915           ((struct sockaddr_in6 *) saddrs[0])->sin6_family = AF_INET6;
 916           ((struct sockaddr_in6 *) saddrs[0])->sin6_port = htons (port);
 917
 918           saddrlens[1] = sizeof (struct sockaddr_in);
 919           saddrs[1] = GNUNET_malloc (saddrlens[1]);
 920 #if HAVE_SOCKADDR_IN_SIN_LEN
 921           ((struct sockaddr_in *) saddrs[1])->sin_len = saddrlens[1];
 922 #endif
 923           ((struct sockaddr_in *) saddrs[1])->sin_family = AF_INET;
 924           ((struct sockaddr_in *) saddrs[1])->sin_port = htons (port);
 925         }
 926     }
 927   *addrs = saddrs;
 928   *addr_lens = saddrlens;
 929   return resi;
 930 }
 931
 932
 933 /**
 934  * Setup addr, addrlen, maxbuf, idle_timeout
 935  * based on configuration!
 936  *
 937  * Configuration must specify a "PORT".  It may
 938  * specify:
 939  * - TIMEOUT (after how many ms does an inactive service timeout);
 940  * - MAXBUF (maximum incoming message size supported)
 941  * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
 942  * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
 943  * - ACCEPT_FROM  (only allow connections from specified IPv4 subnets)
 944  * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
 945  * - REJECT_FROM  (disallow allow connections from specified IPv4 subnets)
 946  * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
 947  *
 948  * @return GNUNET_OK if configuration succeeded
 949  */
 950 static int
 951 setup_service (struct GNUNET_SERVICE_Context *sctx)
 952 {
 953   unsigned long long maxbuf;
 954   struct GNUNET_TIME_Relative idleout;
 955   int tolerant;
 956
 957   if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
 958                                        sctx->serviceName, "TIMEOUT"))
 959     {
 960       if (GNUNET_OK !=
 961           GNUNET_CONFIGURATION_get_value_time (sctx->cfg,
 962                                                sctx->serviceName,
 963                                                "TIMEOUT", &idleout))
 964         {
 965           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 966                       _("Specified value for `%s' of service `%s' is invalid\n"),
 967                       "TIMEOUT",
 968                       sctx->serviceName);
 969           return GNUNET_SYSERR;
 970         }
 971       sctx->timeout = idleout;
 972     }
 973   else
 974     sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
 975   if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
 976                                        sctx->serviceName, "MAXBUF"))
 977     {
 978       if (GNUNET_OK !=
 979           GNUNET_CONFIGURATION_get_value_number (sctx->cfg,
 980                                                  sctx->serviceName,
 981                                                  "MAXBUF", &maxbuf))
 982         {
 983           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 984                       _("Specified value for `%s' of service `%s' is invalid\n"),
 985                       "MAXBUF",
 986                       sctx->serviceName);
 987           return GNUNET_SYSERR;
 988         }
 989     }
 990   else
 991     maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
 992
 993   if (GNUNET_CONFIGURATION_have_value (sctx->cfg,
 994                                        sctx->serviceName, "TOLERANT"))
 995     {
 996       if (GNUNET_SYSERR ==
 997           (tolerant = GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg,
 998                                                             sctx->serviceName,
 999                                                             "TOLERANT")))
1000         {
1001           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1002                       _("Specified value for `%s' of service `%s' is invalid\n"),
1003                       "TOLERANT",
1004                       sctx->serviceName);
1005           return GNUNET_SYSERR;
1006         }
1007     }
1008   else
1009     tolerant = GNUNET_NO;
1010
1011   if (GNUNET_SYSERR ==
1012       GNUNET_SERVICE_get_server_addresses (sctx->serviceName,
1013                                            sctx->cfg,
1014                                            &sctx->addrs,
1015                                            &sctx->addrlens))
1016     return GNUNET_SYSERR;
1017   sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1018   sctx->maxbuf = (size_t) maxbuf;
1019   if (sctx->maxbuf != maxbuf)
1020     {
1021       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1022                   _
1023                   ("Value in configuration for `%s' and service `%s' too large!\n"),
1024                   "MAXBUF", sctx->serviceName);
1025       return GNUNET_SYSERR;
1026     }
1027
1028   process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM");
1029   process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM");
1030   process_acl6 (&sctx->v6_denied, sctx, "REJECT_FROM6");
1031   process_acl6 (&sctx->v6_allowed, sctx, "ACCEPT_FROM6");
1032
1033   return GNUNET_OK;
1034 }
1035
1036
1037 /**
1038  * Get the name of the user that'll be used
1039  * to provide the service.
1040  */
1041 static char *
1042 get_user_name (struct GNUNET_SERVICE_Context *sctx)
1043 {
1044
1045   char *un;
1046
1047   if (GNUNET_OK !=
1048       GNUNET_CONFIGURATION_get_value_filename (sctx->cfg,
1049                                                sctx->serviceName,
1050                                                "USERNAME", &un))
1051     return NULL;
1052   return un;
1053 }
1054
1055 /**
1056  * Write PID file.
1057  */
1058 static int
1059 write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid)
1060 {
1061   FILE *pidfd;
1062   char *pif;
1063   char *user;
1064   char *rdir;
1065   int len;
1066
1067   if (NULL == (pif = get_pid_file_name (sctx)))
1068     return GNUNET_OK;           /* no file desired */
1069   user = get_user_name (sctx);
1070   rdir = GNUNET_strdup (pif);
1071   len = strlen (rdir);
1072   while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
1073     len--;
1074   rdir[len] = '\0';
1075   if (0 != ACCESS (rdir, F_OK))
1076     {
1077       /* we get to create a directory -- and claim it
1078          as ours! */
1079       GNUNET_DISK_directory_create (rdir);
1080       if ((user != NULL) && (0 < strlen (user)))
1081         GNUNET_DISK_file_change_owner (rdir, user);
1082     }
1083   if (0 != ACCESS (rdir, W_OK | X_OK))
1084     {
1085       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "access", rdir);
1086       GNUNET_free (rdir);
1087       GNUNET_free_non_null (user);
1088       GNUNET_free (pif);
1089       return GNUNET_SYSERR;
1090     }
1091   GNUNET_free (rdir);
1092   pidfd = FOPEN (pif, "w");
1093   if (pidfd == NULL)
1094     {
1095       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", pif);
1096       GNUNET_free (pif);
1097       GNUNET_free_non_null (user);
1098       return GNUNET_SYSERR;
1099     }
1100   if (0 > FPRINTF (pidfd, "%u", pid))
1101     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif);
1102   GNUNET_break (0 == fclose (pidfd));
1103   if ((user != NULL) && (0 < strlen (user)))
1104     GNUNET_DISK_file_change_owner (pif, user);
1105   GNUNET_free_non_null (user);
1106   GNUNET_free (pif);
1107   return GNUNET_OK;
1108 }
1109
1110
1111 /**
1112  * Task run during shutdown.
1113  *
1114  * @param cls unused
1115  * @param tc unused
1116  */
1117 static void
1118 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1119 {
1120   struct GNUNET_SERVER_Handle *server = cls;
1121
1122   GNUNET_SERVER_destroy (server);
1123 }
1124
1125
1126 /**
1127  * Initial task for the service.
1128  */
1129 static void
1130 service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1131 {
1132   struct GNUNET_SERVICE_Context *sctx = cls;
1133   unsigned int i;
1134
1135   sctx->sched = tc->sched;
1136   sctx->server = GNUNET_SERVER_create (tc->sched,
1137                                        &check_access,
1138                                        sctx,
1139                                        sctx->addrs,
1140                                        sctx->addrlens,
1141                                        sctx->maxbuf,
1142                                        sctx->timeout, sctx->require_found);
1143   if (sctx->server == NULL)
1144     {
1145       i = 0;
1146       while (sctx->addrs[i] != NULL)
1147         {
1148           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1149                       _("Failed to start `%s' at `%s'\n"),
1150                       sctx->serviceName,
1151                       GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1152           i++;
1153         }
1154       sctx->ret = GNUNET_SYSERR;
1155       return;
1156     }
1157   if (0 == (sctx->options & GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN))
1158     {
1159       /* install a task that will kill the server
1160          process if the scheduler ever gets a shutdown signal */
1161       GNUNET_SCHEDULER_add_delayed (tc->sched,
1162                                     GNUNET_TIME_UNIT_FOREVER_REL,
1163                                     &shutdown_task, sctx->server);
1164     }
1165   sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1166   memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1167   i = 0;
1168   while ((sctx->my_handlers[i].callback != NULL))
1169     sctx->my_handlers[i++].callback_cls = sctx;
1170   GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1171   if (sctx->ready_confirm_fd != -1)
1172     {
1173       GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1));
1174       GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd));
1175       sctx->ready_confirm_fd = -1;
1176       write_pid_file (sctx, getpid ());
1177     }
1178   i = 0;
1179   while (sctx->addrs[i] != NULL)
1180     {
1181       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1182                   _("Service `%s' runs at %s\n"),
1183                   sctx->serviceName,
1184                   GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i]));
1185       i++;
1186     }
1187   sctx->task (sctx->task_cls, tc->sched, sctx->server, sctx->cfg);
1188 }
1189
1190
1191 /**
1192  * Detach from terminal.
1193  */
1194 static int
1195 detach_terminal (struct GNUNET_SERVICE_Context *sctx)
1196 {
1197 #ifndef MINGW
1198   pid_t pid;
1199   int nullfd;
1200   int filedes[2];
1201
1202   if (0 != PIPE (filedes))
1203     {
1204       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "pipe");
1205       return GNUNET_SYSERR;
1206     }
1207   pid = fork ();
1208   if (pid < 0)
1209     {
1210       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
1211       return GNUNET_SYSERR;
1212     }
1213   if (pid != 0)
1214     {
1215       /* Parent */
1216       char c;
1217
1218       GNUNET_break (0 == CLOSE (filedes[1]));
1219       c = 'X';
1220       if (1 != READ (filedes[0], &c, sizeof (char)))
1221         GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "read");
1222       fflush (stdout);
1223       switch (c)
1224         {
1225         case '.':
1226           exit (0);
1227         case 'I':
1228           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1229                       _("Service process failed to initialize\n"));
1230           break;
1231         case 'S':
1232           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1233                       _
1234                       ("Service process could not initialize server function\n"));
1235           break;
1236         case 'X':
1237           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1238                       _("Service process failed to report status\n"));
1239           break;
1240         }
1241       exit (1);                 /* child reported error */
1242     }
1243   GNUNET_break (0 == CLOSE (0));
1244   GNUNET_break (0 == CLOSE (1));
1245   GNUNET_break (0 == CLOSE (filedes[0]));
1246   nullfd = OPEN ("/dev/null", O_RDWR | O_APPEND);
1247   if (nullfd < 0)
1248     return GNUNET_SYSERR;
1249   /* set stdin/stdout to /dev/null */
1250   if ((dup2 (nullfd, 0) < 0) || (dup2 (nullfd, 1) < 0))
1251     {
1252       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "dup2");
1253       return GNUNET_SYSERR;
1254     }
1255   /* Detach from controlling terminal */
1256   pid = setsid ();
1257   if (pid == -1)
1258     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsid");
1259   sctx->ready_confirm_fd = filedes[1];
1260 #else
1261   /* FIXME: we probably need to do something else
1262      elsewhere in order to fork the process itself... */
1263   FreeConsole ();
1264 #endif
1265   return GNUNET_OK;
1266 }
1267
1268
1269 /**
1270  * Set user ID.
1271  */
1272 static int
1273 set_user_id (struct GNUNET_SERVICE_Context *sctx)
1274 {
1275   char *user;
1276
1277   if (NULL == (user = get_user_name (sctx)))
1278     return GNUNET_OK;           /* keep */
1279 #ifndef MINGW
1280   struct passwd *pws;
1281
1282   errno = 0;
1283   pws = getpwnam (user);
1284   if (pws == NULL)
1285     {
1286       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1287                   _("Cannot obtain information about user `%s': %s\n"),
1288                   user, errno == 0 ? _("No such user") : STRERROR (errno));
1289       GNUNET_free (user);
1290       return GNUNET_SYSERR;
1291     }
1292   if ((0 != setgid (pws->pw_gid)) || (0 != setegid (pws->pw_gid)) ||
1293 #if HAVE_INITGROUPS
1294       (0 != initgroups (user, pws->pw_gid)) ||
1295 #endif
1296       (0 != setuid (pws->pw_uid)) || (0 != seteuid (pws->pw_uid)))
1297     {
1298       if ((0 != setregid (pws->pw_gid, pws->pw_gid)) ||
1299           (0 != setreuid (pws->pw_uid, pws->pw_uid)))
1300         {
1301           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1302                       _("Cannot change user/group to `%s': %s\n"), user,
1303                       STRERROR (errno));
1304           GNUNET_free (user);
1305           return GNUNET_SYSERR;
1306         }
1307     }
1308 #endif
1309   GNUNET_free (user);
1310   return GNUNET_OK;
1311 }
1312
1313
1314 /**
1315  * Delete the PID file that was created by our parent.
1316  */
1317 static void
1318 pid_file_delete (struct GNUNET_SERVICE_Context *sctx)
1319 {
1320   char *pif = get_pid_file_name (sctx);
1321   if (pif == NULL)
1322     return;                     /* no PID file */
1323   if (0 != UNLINK (pif))
1324     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", pif);
1325   GNUNET_free (pif);
1326 }
1327
1328
1329 /**
1330  * Run a standard GNUnet service startup sequence (initialize loggers
1331  * and configuration, parse options).
1332  *
1333  * @param argc number of command line arguments
1334  * @param argv command line arguments
1335  * @param serviceName our service name
1336  * @param opt service options
1337  * @param task main task of the service
1338  * @param task_cls closure for task
1339  * @return GNUNET_SYSERR on error, GNUNET_OK
1340  *         if we shutdown nicely
1341  */
1342 int
1343 GNUNET_SERVICE_run (int argc,
1344                     char *const *argv,
1345                     const char *serviceName,
1346                     enum GNUNET_SERVICE_Options opt,
1347                     GNUNET_SERVICE_Main task, void *task_cls)
1348 {
1349 #define HANDLE_ERROR do { err = 1; GNUNET_break (0); goto shutdown; } while (0)
1350
1351   int err;
1352   char *cfg_fn;
1353   char *loglev;
1354   char *logfile;
1355   int do_daemonize;
1356   unsigned int i;
1357   struct GNUNET_SERVICE_Context sctx;
1358   struct GNUNET_CONFIGURATION_Handle *cfg;
1359   struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1360     GNUNET_GETOPT_OPTION_CFG_FILE (&cfg_fn),
1361     {'d', "daemonize", NULL,
1362      gettext_noop ("do daemonize (detach from terminal)"), 0,
1363      GNUNET_GETOPT_set_one, &do_daemonize},
1364     GNUNET_GETOPT_OPTION_HELP (serviceName),
1365     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1366     GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1367     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION),
1368     GNUNET_GETOPT_OPTION_END
1369   };
1370   err = 0;
1371   do_daemonize = 0;
1372   logfile = NULL;
1373   loglev = GNUNET_strdup ("WARNING");
1374   cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
1375   memset (&sctx, 0, sizeof (sctx));
1376   sctx.options = opt;
1377   sctx.ready_confirm_fd = -1;
1378   sctx.ret = GNUNET_OK;
1379   sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1380   sctx.maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1381   sctx.task = task;
1382   sctx.serviceName = serviceName;
1383   sctx.cfg = cfg = GNUNET_CONFIGURATION_create ();
1384   /* setup subsystems */
1385   if (GNUNET_SYSERR == GNUNET_GETOPT_run (serviceName, service_options, argc,
1386       argv))
1387     goto shutdown;
1388   if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile))
1389     HANDLE_ERROR;
1390   if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn))
1391     goto shutdown;
1392   if (GNUNET_OK != setup_service (&sctx))
1393     goto shutdown;
1394   if ( (do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx)))
1395     HANDLE_ERROR;
1396   if (GNUNET_OK != set_user_id (&sctx))
1397     goto shutdown;
1398 #if DEBUG_SERVICE
1399   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1400               "Service `%s' runs with configuration from `%s'\n",
1401               serviceName, cfg_fn);
1402 #endif
1403   /* actually run service */
1404   GNUNET_SCHEDULER_run (&service_task, &sctx);
1405
1406   /* shutdown */
1407   if ((do_daemonize == 1) && (sctx.server != NULL))
1408     pid_file_delete (&sctx);
1409   GNUNET_free_non_null (sctx.my_handlers);
1410
1411 shutdown:
1412   if (sctx.ready_confirm_fd != -1)
1413     {
1414       if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1))
1415         GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "write");
1416       GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd));
1417     }
1418
1419   GNUNET_CONFIGURATION_destroy (cfg);
1420   i = 0;
1421   if (sctx.addrs != NULL)
1422     while (sctx.addrs[i] != NULL)
1423       GNUNET_free (sctx.addrs[i++]);
1424   GNUNET_free_non_null (sctx.addrs);
1425   GNUNET_free_non_null (sctx.addrlens);
1426   GNUNET_free_non_null (logfile);
1427   GNUNET_free (loglev);
1428   GNUNET_free (cfg_fn);
1429   GNUNET_free_non_null (sctx.v4_denied);
1430   GNUNET_free_non_null (sctx.v6_denied);
1431   GNUNET_free_non_null (sctx.v4_allowed);
1432   GNUNET_free_non_null (sctx.v6_allowed);
1433
1434   return err ? GNUNET_SYSERR : sctx.ret;
1435 }
1436
1437
1438 /**
1439  * Run a service startup sequence within an existing
1440  * initialized system.
1441  *
1442  * @param serviceName our service name
1443  * @param sched scheduler to use
1444  * @param cfg configuration to use
1445  * @return NULL on error, service handle
1446  */
1447 struct GNUNET_SERVICE_Context *
1448 GNUNET_SERVICE_start (const char *serviceName,
1449                       struct GNUNET_SCHEDULER_Handle *sched,
1450                       const struct GNUNET_CONFIGURATION_Handle *cfg)
1451 {
1452   int i;
1453   struct GNUNET_SERVICE_Context *sctx;
1454
1455   sctx = GNUNET_malloc (sizeof (struct GNUNET_SERVICE_Context));
1456   sctx->ready_confirm_fd = -1;  /* no daemonizing */
1457   sctx->ret = GNUNET_OK;
1458   sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
1459   sctx->maxbuf = GNUNET_SERVER_MAX_MESSAGE_SIZE;
1460   sctx->serviceName = serviceName;
1461   sctx->cfg = cfg;
1462   sctx->sched = sched;
1463
1464   /* setup subsystems */
1465   if ((GNUNET_OK != setup_service (sctx)) ||
1466       (NULL == (sctx->server = GNUNET_SERVER_create (sched,
1467                                                      &check_access,
1468                                                      sctx,
1469                                                      sctx->addrs,
1470                                                      sctx->addrlens,
1471                                                      sctx->maxbuf,
1472                                                      sctx->timeout,
1473                                                      sctx->require_found))))
1474     {
1475       GNUNET_SERVICE_stop (sctx);
1476       return NULL;
1477     }
1478   sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers));
1479   memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers));
1480   i = 0;
1481   while ((sctx->my_handlers[i].callback != NULL))
1482     sctx->my_handlers[i++].callback_cls = sctx;
1483   GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers);
1484   return sctx;
1485 }
1486
1487 /**
1488  * Obtain the server used by a service.  Note that the server must NOT
1489  * be destroyed by the caller.
1490  *
1491  * @param ctx the service context returned from the start function
1492  * @return handle to the server for this service, NULL if there is none
1493  */
1494 struct GNUNET_SERVER_Handle *
1495 GNUNET_SERVICE_get_server (struct GNUNET_SERVICE_Context *ctx)
1496 {
1497   return ctx->server;
1498 }
1499
1500
1501 /**
1502  * Stop a service that was started with "GNUNET_SERVICE_start".
1503  *
1504  * @param sctx the service context returned from the start function
1505  */
1506 void
1507 GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx)
1508 {
1509   unsigned int i;
1510   if (NULL != sctx->server)
1511     GNUNET_SERVER_destroy (sctx->server);
1512   GNUNET_free_non_null (sctx->my_handlers);
1513   i = 0;
1514   while (sctx->addrs[i] != NULL)
1515     GNUNET_free (sctx->addrs[i++]);
1516   GNUNET_free_non_null (sctx->addrs);
1517   GNUNET_free_non_null (sctx->addrlens);
1518   GNUNET_free_non_null (sctx->v4_denied);
1519   GNUNET_free_non_null (sctx->v6_denied);
1520   GNUNET_free_non_null (sctx->v4_allowed);
1521   GNUNET_free_non_null (sctx->v6_allowed);
1522   GNUNET_free (sctx);
1523 }
1524
1525
1526 /* end of service.c */