src/util/service_new.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2016 GNUnet e.V.
   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 3, 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file util/service_new.c
  23  * @brief functions related to starting services (redesign)
  24  * @author Christian Grothoff
  25  * @author Florian Dold
  26  */
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_protocols.h"
  30 #include "gnunet_constants.h"
  31 #include "gnunet_resolver_service.h"
  32 #include "speedup.h"
  33
  34 #if HAVE_MALLINFO
  35 #include <malloc.h>
  36 #include "gauger.h"
  37 #endif
  38
  39
  40 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  41
  42 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
  43
  44 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
  45
  46
  47 /**
  48  * Information the service tracks per listen operation.
  49  */
  50 struct ServiceListenContext
  51 {
  52
  53   /**
  54    * Kept in a DLL.
  55    */
  56   struct ServiceListenContext *next;
  57
  58   /**
  59    * Kept in a DLL.
  60    */
  61   struct ServiceListenContext *prev;
  62
  63   /**
  64    * Service this listen context belongs to.
  65    */
  66   struct GNUNET_SERVICE_Handle *sh;
  67
  68   /**
  69    * Socket we are listening on.
  70    */
  71   struct GNUNET_NETWORK_Handle *listen_socket;
  72
  73   /**
  74    * Task scheduled to do the listening.
  75    */
  76   struct GNUNET_SCHEDULER_Task *listen_task;
  77
  78 };
  79
  80
  81 /**
  82  * Handle to a service.
  83  */
  84 struct GNUNET_SERVICE_Handle
  85 {
  86   /**
  87    * Our configuration.
  88    */
  89   const struct GNUNET_CONFIGURATION_Handle *cfg;
  90
  91   /**
  92    * Name of our service.
  93    */
  94   const char *service_name;
  95
  96   /**
  97    * Main service-specific task to run.
  98    */
  99   GNUNET_SERVICE_InitCallback service_init_cb;
 100
 101   /**
 102    * Function to call when clients connect.
 103    */
 104   GNUNET_SERVICE_ConnectHandler connect_cb;
 105
 106   /**
 107    * Function to call when clients disconnect / are disconnected.
 108    */
 109   GNUNET_SERVICE_DisconnectHandler disconnect_cb;
 110
 111   /**
 112    * Closure for @e service_init_cb, @e connect_cb, @e disconnect_cb.
 113    */
 114   void *cb_cls;
 115
 116   /**
 117    * DLL of listen sockets used to accept new connections.
 118    */
 119   struct ServiceListenContext *slc_head;
 120
 121   /**
 122    * DLL of listen sockets used to accept new connections.
 123    */
 124   struct ServiceListenContext *slc_tail;
 125
 126   /**
 127    * Our clients, kept in a DLL.
 128    */
 129   struct GNUNET_SERVICE_Client *clients_head;
 130
 131   /**
 132    * Our clients, kept in a DLL.
 133    */
 134   struct GNUNET_SERVICE_Client *clients_tail;
 135
 136   /**
 137    * Message handlers to use for all clients.
 138    */
 139   const struct GNUNET_MQ_MessageHandler *handlers;
 140
 141   /**
 142    * Closure for @e task.
 143    */
 144   void *task_cls;
 145
 146   /**
 147    * IPv4 addresses that are not allowed to connect.
 148    */
 149   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_denied;
 150
 151   /**
 152    * IPv6 addresses that are not allowed to connect.
 153    */
 154   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_denied;
 155
 156   /**
 157    * IPv4 addresses that are allowed to connect (if not
 158    * set, all are allowed).
 159    */
 160   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_allowed;
 161
 162   /**
 163    * IPv6 addresses that are allowed to connect (if not
 164    * set, all are allowed).
 165    */
 166   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_allowed;
 167
 168   /**
 169    * Do we require a matching UID for UNIX domain socket connections?
 170    * #GNUNET_NO means that the UID does not have to match (however,
 171    * @e match_gid may still impose other access control checks).
 172    */
 173   int match_uid;
 174
 175   /**
 176    * Do we require a matching GID for UNIX domain socket connections?
 177    * Ignored if @e match_uid is #GNUNET_YES.  Note that this is about
 178    * checking that the client's UID is in our group OR that the
 179    * client's GID is our GID.  If both "match_gid" and @e match_uid are
 180    * #GNUNET_NO, all users on the local system have access.
 181    */
 182   int match_gid;
 183
 184   /**
 185    * Set to #GNUNET_YES if we got a shutdown signal and terminate
 186    * the service if #have_non_monitor_clients() returns #GNUNET_YES.
 187    */
 188   int got_shutdown;
 189
 190   /**
 191    * Our options.
 192    */
 193   enum GNUNET_SERVICE_Options options;
 194
 195   /**
 196    * If we are daemonizing, this FD is set to the
 197    * pipe to the parent.  Send '.' if we started
 198    * ok, '!' if not.  -1 if we are not daemonizing.
 199    */
 200   int ready_confirm_fd;
 201
 202   /**
 203    * Overall success/failure of the service start.
 204    */
 205   int ret;
 206
 207   /**
 208    * If #GNUNET_YES, consider unknown message types an error where the
 209    * client is disconnected.
 210    */
 211   int require_found;
 212 };
 213
 214
 215 /**
 216  * Handle to a client that is connected to a service.
 217  */
 218 struct GNUNET_SERVICE_Client
 219 {
 220
 221   /**
 222    * Kept in a DLL.
 223    */
 224   struct GNUNET_SERVICE_Client *next;
 225
 226   /**
 227    * Kept in a DLL.
 228    */
 229   struct GNUNET_SERVICE_Client *prev;
 230
 231   /**
 232    * Service that this client belongs to.
 233    */
 234   struct GNUNET_SERVICE_Handle *sh;
 235
 236   /**
 237    * Socket of this client.
 238    */
 239   struct GNUNET_NETWORK_Handle *sock;
 240
 241   /**
 242    * Message queue for the client.
 243    */
 244   struct GNUNET_MQ_Handle *mq;
 245
 246   /**
 247    * Tokenizer we use for processing incoming data.
 248    */
 249   struct GNUNET_MessageStreamTokenizer *mst;
 250
 251   /**
 252    * Task that warns about missing calls to
 253    * #GNUNET_SERVICE_client_continue().
 254    */
 255   struct GNUNET_SCHEDULER_Task *warn_task;
 256
 257   /**
 258    * Task run to finish dropping the client after the stack has
 259    * properly unwound.
 260    */
 261   struct GNUNET_SCHEDULER_Task *drop_task;
 262
 263   /**
 264    * Task that receives data from the client to
 265    * pass it to the handlers.
 266    */
 267   struct GNUNET_SCHEDULER_Task *recv_task;
 268
 269   /**
 270    * Task that transmit data to the client.
 271    */
 272   struct GNUNET_SCHEDULER_Task *send_task;
 273
 274   /**
 275    * Pointer to the message to be transmitted by @e send_task.
 276    */
 277   const struct GNUNET_MessageHeader *msg;
 278
 279   /**
 280    * User context value, value returned from
 281    * the connect callback.
 282    */
 283   void *user_context;
 284
 285   /**
 286    * Time when we last gave a message from this client
 287    * to the application.
 288    */
 289   struct GNUNET_TIME_Absolute warn_start;
 290
 291   /**
 292    * Current position in @e msg at which we are transmitting.
 293    */
 294   size_t msg_pos;
 295
 296   /**
 297    * Persist the file handle for this client no matter what happens,
 298    * force the OS to close once the process actually dies.  Should only
 299    * be used in special cases!
 300    */
 301   int persist;
 302
 303   /**
 304    * Is this client a 'monitor' client that should not be counted
 305    * when deciding on destroying the server during soft shutdown?
 306    * (see also #GNUNET_SERVICE_start)
 307    */
 308   int is_monitor;
 309
 310   /**
 311    * Are we waiting for the application to call #GNUNET_SERVICE_client_continue()?
 312    */
 313   int needs_continue;
 314
 315   /**
 316    * Type of last message processed (for warn_no_receive_done).
 317    */
 318   uint16_t warn_type;
 319 };
 320
 321
 322 /**
 323  * Check if any of the clients we have left are unrelated to
 324  * monitoring.
 325  *
 326  * @param sh service to check clients for
 327  * @return #GNUNET_YES if we have non-monitoring clients left
 328  */
 329 static int
 330 have_non_monitor_clients (struct GNUNET_SERVICE_Handle *sh)
 331 {
 332   struct GNUNET_SERVICE_Client *client;
 333
 334   for (client = sh->clients_head;NULL != client; client = client->next)
 335   {
 336     if (client->is_monitor)
 337       continue;
 338     return GNUNET_YES;
 339   }
 340   return GNUNET_NO;
 341 }
 342
 343
 344 /**
 345  * Shutdown task triggered when a service should be terminated.
 346  * This considers active clients and the service options to see
 347  * how this specific service is to be terminated, and depending
 348  * on this proceeds with the shutdown logic.
 349  *
 350  * @param cls our `struct GNUNET_SERVICE_Handle`
 351  */
 352 static void
 353 service_shutdown (void *cls)
 354 {
 355   struct GNUNET_SERVICE_Handle *sh = cls;
 356
 357   switch (sh->options)
 358   {
 359   case GNUNET_SERVICE_OPTION_NONE:
 360     GNUNET_SERVICE_shutdown (sh);
 361     break;
 362   case GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN:
 363     /* This task should never be run if we are using
 364        the manual shutdown. */
 365     GNUNET_assert (0);
 366     break;
 367   case GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN:
 368     sh->got_shutdown = GNUNET_YES;
 369     GNUNET_SERVICE_suspend (sh);
 370     if (GNUNET_NO == have_non_monitor_clients (sh))
 371       GNUNET_SERVICE_shutdown (sh);
 372     break;
 373   }
 374 }
 375
 376
 377 /**
 378  * First task run by any service.  Initializes our shutdown task,
 379  * starts the listening operation on our listen sockets and launches
 380  * the custom logic of the application service.
 381  *
 382  * @param cls our `struct GNUNET_SERVICE_Handle`
 383  */
 384 static void
 385 service_main (void *cls)
 386 {
 387   struct GNUNET_SERVICE_Handle *sh = cls;
 388
 389   if (GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN != sh->options)
 390     GNUNET_SCHEDULER_add_shutdown (&service_shutdown,
 391                                    sh);
 392   GNUNET_SERVICE_resume (sh);
 393   if (NULL != sh->service_init_cb)
 394     sh->service_init_cb (sh->cb_cls,
 395                          sh->cfg,
 396                          sh);
 397 }
 398
 399
 400 /**
 401  * Parse an IPv4 access control list.
 402  *
 403  * @param ret location where to write the ACL (set)
 404  * @param sh service context to use to get the configuration
 405  * @param option name of the ACL option to parse
 406  * @return #GNUNET_SYSERR on parse error, #GNUNET_OK on success (including
 407  *         no ACL configured)
 408  */
 409 static int
 410 process_acl4 (struct GNUNET_STRINGS_IPv4NetworkPolicy **ret,
 411               struct GNUNET_SERVICE_Handle *sh,
 412               const char *option)
 413 {
 414   char *opt;
 415
 416   if (! GNUNET_CONFIGURATION_have_value (sh->cfg,
 417                                          sh->service_name,
 418                                          option))
 419   {
 420     *ret = NULL;
 421     return GNUNET_OK;
 422   }
 423   GNUNET_break (GNUNET_OK ==
 424                 GNUNET_CONFIGURATION_get_value_string (sh->cfg,
 425                                                        sh->service_name,
 426                                                        option,
 427                                                        &opt));
 428   if (NULL == (*ret = GNUNET_STRINGS_parse_ipv4_policy (opt)))
 429   {
 430     LOG (GNUNET_ERROR_TYPE_WARNING,
 431          _("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
 432          opt,
 433          sh->service_name,
 434          option);
 435     GNUNET_free (opt);
 436     return GNUNET_SYSERR;
 437   }
 438   GNUNET_free (opt);
 439   return GNUNET_OK;
 440 }
 441
 442
 443 /**
 444  * Parse an IPv6 access control list.
 445  *
 446  * @param ret location where to write the ACL (set)
 447  * @param sh service context to use to get the configuration
 448  * @param option name of the ACL option to parse
 449  * @return #GNUNET_SYSERR on parse error, #GNUNET_OK on success (including
 450  *         no ACL configured)
 451  */
 452 static int
 453 process_acl6 (struct GNUNET_STRINGS_IPv6NetworkPolicy **ret,
 454               struct GNUNET_SERVICE_Handle *sh,
 455               const char *option)
 456 {
 457   char *opt;
 458
 459   if (! GNUNET_CONFIGURATION_have_value (sh->cfg,
 460                                          sh->service_name,
 461                                          option))
 462   {
 463     *ret = NULL;
 464     return GNUNET_OK;
 465   }
 466   GNUNET_break (GNUNET_OK ==
 467                 GNUNET_CONFIGURATION_get_value_string (sh->cfg,
 468                                                        sh->service_name,
 469                                                        option,
 470                                                        &opt));
 471   if (NULL == (*ret = GNUNET_STRINGS_parse_ipv6_policy (opt)))
 472   {
 473     LOG (GNUNET_ERROR_TYPE_WARNING,
 474          _("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
 475          opt,
 476          sh->service_name,
 477          option);
 478     GNUNET_free (opt);
 479     return GNUNET_SYSERR;
 480   }
 481   GNUNET_free (opt);
 482   return GNUNET_OK;
 483 }
 484
 485
 486 /**
 487  * Add the given UNIX domain path as an address to the
 488  * list (as the first entry).
 489  *
 490  * @param saddrs array to update
 491  * @param saddrlens where to store the address length
 492  * @param unixpath path to add
 493  * @param abstract #GNUNET_YES to add an abstract UNIX domain socket.  This
 494  *          parameter is ignore on systems other than LINUX
 495  */
 496 static void
 497 add_unixpath (struct sockaddr **saddrs,
 498               socklen_t *saddrlens,
 499               const char *unixpath,
 500               int abstract)
 501 {
 502 #ifdef AF_UNIX
 503   struct sockaddr_un *un;
 504
 505   un = GNUNET_new (struct sockaddr_un);
 506   un->sun_family = AF_UNIX;
 507   strncpy (un->sun_path,
 508            unixpath,
 509            sizeof (un->sun_path) - 1);
 510 #ifdef LINUX
 511   if (GNUNET_YES == abstract)
 512     un->sun_path[0] = '\0';
 513 #endif
 514 #if HAVE_SOCKADDR_IN_SIN_LEN
 515   un->sun_len = (u_char) sizeof (struct sockaddr_un);
 516 #endif
 517   *saddrs = (struct sockaddr *) un;
 518   *saddrlens = sizeof (struct sockaddr_un);
 519 #else
 520   /* this function should never be called
 521    * unless AF_UNIX is defined! */
 522   GNUNET_assert (0);
 523 #endif
 524 }
 525
 526
 527 /**
 528  * Get the list of addresses that a server for the given service
 529  * should bind to.
 530  *
 531  * @param service_name name of the service
 532  * @param cfg configuration (which specifies the addresses)
 533  * @param addrs set (call by reference) to an array of pointers to the
 534  *              addresses the server should bind to and listen on; the
 535  *              array will be NULL-terminated (on success)
 536  * @param addr_lens set (call by reference) to an array of the lengths
 537  *              of the respective `struct sockaddr` struct in the @a addrs
 538  *              array (on success)
 539  * @return number of addresses found on success,
 540  *              #GNUNET_SYSERR if the configuration
 541  *              did not specify reasonable finding information or
 542  *              if it specified a hostname that could not be resolved;
 543  *              #GNUNET_NO if the number of addresses configured is
 544  *              zero (in this case, `*addrs` and `*addr_lens` will be
 545  *              set to NULL).
 546  */
 547 static int
 548 get_server_addresses (const char *service_name,
 549                       const struct GNUNET_CONFIGURATION_Handle *cfg,
 550                       struct sockaddr ***addrs,
 551                       socklen_t **addr_lens)
 552 {
 553   int disablev6;
 554   struct GNUNET_NETWORK_Handle *desc;
 555   unsigned long long port;
 556   char *unixpath;
 557   struct addrinfo hints;
 558   struct addrinfo *res;
 559   struct addrinfo *pos;
 560   struct addrinfo *next;
 561   unsigned int i;
 562   int resi;
 563   int ret;
 564   int abstract;
 565   struct sockaddr **saddrs;
 566   socklen_t *saddrlens;
 567   char *hostname;
 568
 569   *addrs = NULL;
 570   *addr_lens = NULL;
 571   desc = NULL;
 572   if (GNUNET_CONFIGURATION_have_value (cfg,
 573                                        service_name,
 574                                        "DISABLEV6"))
 575   {
 576     if (GNUNET_SYSERR ==
 577         (disablev6 =
 578          GNUNET_CONFIGURATION_get_value_yesno (cfg,
 579                                                service_name,
 580                                                "DISABLEV6")))
 581       return GNUNET_SYSERR;
 582   }
 583   else
 584     disablev6 = GNUNET_NO;
 585
 586   if (! disablev6)
 587   {
 588     /* probe IPv6 support */
 589     desc = GNUNET_NETWORK_socket_create (PF_INET6,
 590                                          SOCK_STREAM,
 591                                          0);
 592     if (NULL == desc)
 593     {
 594       if ( (ENOBUFS == errno) ||
 595            (ENOMEM == errno) ||
 596            (ENFILE == errno) ||
 597            (EACCES == errno) )
 598       {
 599         LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
 600                       "socket");
 601         return GNUNET_SYSERR;
 602       }
 603       LOG (GNUNET_ERROR_TYPE_INFO,
 604            _("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
 605            service_name,
 606            STRERROR (errno));
 607       disablev6 = GNUNET_YES;
 608     }
 609     else
 610     {
 611       GNUNET_break (GNUNET_OK ==
 612                     GNUNET_NETWORK_socket_close (desc));
 613       desc = NULL;
 614     }
 615   }
 616
 617   port = 0;
 618   if (GNUNET_CONFIGURATION_have_value (cfg,
 619                                        service_name,
 620                                        "PORT"))
 621   {
 622     if (GNUNET_OK !=
 623         GNUNET_CONFIGURATION_get_value_number (cfg,
 624                                                service_name,
 625                                                "PORT",
 626                                                &port))
 627     {
 628       LOG (GNUNET_ERROR_TYPE_ERROR,
 629            _("Require valid port number for service `%s' in configuration!\n"),
 630            service_name);
 631     }
 632     if (port > 65535)
 633     {
 634       LOG (GNUNET_ERROR_TYPE_ERROR,
 635            _("Require valid port number for service `%s' in configuration!\n"),
 636            service_name);
 637       return GNUNET_SYSERR;
 638     }
 639   }
 640
 641   if (GNUNET_CONFIGURATION_have_value (cfg,
 642                                        service_name,
 643                                        "BINDTO"))
 644   {
 645     GNUNET_break (GNUNET_OK ==
 646                   GNUNET_CONFIGURATION_get_value_string (cfg,
 647                                                          service_name,
 648                                                          "BINDTO",
 649                                                          &hostname));
 650   }
 651   else
 652     hostname = NULL;
 653
 654   unixpath = NULL;
 655   abstract = GNUNET_NO;
 656 #ifdef AF_UNIX
 657   if ((GNUNET_YES ==
 658        GNUNET_CONFIGURATION_have_value (cfg,
 659                                         service_name,
 660                                         "UNIXPATH")) &&
 661       (GNUNET_OK ==
 662        GNUNET_CONFIGURATION_get_value_filename (cfg,
 663                                                 service_name,
 664                                                 "UNIXPATH",
 665                                                 &unixpath)) &&
 666       (0 < strlen (unixpath)))
 667   {
 668     /* probe UNIX support */
 669     struct sockaddr_un s_un;
 670
 671     if (strlen (unixpath) >= sizeof (s_un.sun_path))
 672     {
 673       LOG (GNUNET_ERROR_TYPE_WARNING,
 674            _("UNIXPATH `%s' too long, maximum length is %llu\n"),
 675            unixpath,
 676            (unsigned long long) sizeof (s_un.sun_path));
 677       unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
 678       LOG (GNUNET_ERROR_TYPE_INFO,
 679            _("Using `%s' instead\n"),
 680            unixpath);
 681     }
 682 #ifdef LINUX
 683     abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
 684                                                      "TESTING",
 685                                                      "USE_ABSTRACT_SOCKETS");
 686     if (GNUNET_SYSERR == abstract)
 687       abstract = GNUNET_NO;
 688 #endif
 689     if ( (GNUNET_YES != abstract) &&
 690          (GNUNET_OK !=
 691           GNUNET_DISK_directory_create_for_file (unixpath)) )
 692       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
 693                                 "mkdir",
 694                                 unixpath);
 695   }
 696   if (NULL != unixpath)
 697   {
 698     desc = GNUNET_NETWORK_socket_create (AF_UNIX,
 699                                          SOCK_STREAM,
 700                                          0);
 701     if (NULL == desc)
 702     {
 703       if ((ENOBUFS == errno) ||
 704           (ENOMEM == errno) ||
 705           (ENFILE == errno) ||
 706           (EACCES == errno))
 707       {
 708         LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
 709                       "socket");
 710         GNUNET_free_non_null (hostname);
 711         GNUNET_free (unixpath);
 712         return GNUNET_SYSERR;
 713       }
 714       LOG (GNUNET_ERROR_TYPE_INFO,
 715            _("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
 716            service_name,
 717            STRERROR (errno));
 718       GNUNET_free (unixpath);
 719       unixpath = NULL;
 720     }
 721     else
 722     {
 723       GNUNET_break (GNUNET_OK ==
 724                     GNUNET_NETWORK_socket_close (desc));
 725       desc = NULL;
 726     }
 727   }
 728 #endif
 729
 730   if ((0 == port) && (NULL == unixpath))
 731   {
 732     LOG (GNUNET_ERROR_TYPE_ERROR,
 733          _("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
 734          service_name);
 735     GNUNET_free_non_null (hostname);
 736     return GNUNET_SYSERR;
 737   }
 738   if (0 == port)
 739   {
 740     saddrs = GNUNET_new_array (2,
 741                                struct sockaddr *);
 742     saddrlens = GNUNET_new_array (2,
 743                                   socklen_t);
 744     add_unixpath (saddrs,
 745                   saddrlens,
 746                   unixpath,
 747                   abstract);
 748     GNUNET_free_non_null (unixpath);
 749     GNUNET_free_non_null (hostname);
 750     *addrs = saddrs;
 751     *addr_lens = saddrlens;
 752     return 1;
 753   }
 754
 755   if (NULL != hostname)
 756   {
 757     LOG (GNUNET_ERROR_TYPE_DEBUG,
 758          "Resolving `%s' since that is where `%s' will bind to.\n",
 759          hostname,
 760          service_name);
 761     memset (&hints,
 762             0,
 763             sizeof (struct addrinfo));
 764     if (disablev6)
 765       hints.ai_family = AF_INET;
 766     hints.ai_protocol = IPPROTO_TCP;
 767     if ((0 != (ret = getaddrinfo (hostname,
 768                                   NULL,
 769                                   &hints,
 770                                   &res))) ||
 771         (NULL == res))
 772     {
 773       LOG (GNUNET_ERROR_TYPE_ERROR,
 774            _("Failed to resolve `%s': %s\n"),
 775            hostname,
 776            gai_strerror (ret));
 777       GNUNET_free (hostname);
 778       GNUNET_free_non_null (unixpath);
 779       return GNUNET_SYSERR;
 780     }
 781     next = res;
 782     i = 0;
 783     while (NULL != (pos = next))
 784     {
 785       next = pos->ai_next;
 786       if ( (disablev6) &&
 787            (pos->ai_family == AF_INET6) )
 788         continue;
 789       i++;
 790     }
 791     if (0 == i)
 792     {
 793       LOG (GNUNET_ERROR_TYPE_ERROR,
 794            _("Failed to find %saddress for `%s'.\n"),
 795            disablev6 ? "IPv4 " : "",
 796            hostname);
 797       freeaddrinfo (res);
 798       GNUNET_free (hostname);
 799       GNUNET_free_non_null (unixpath);
 800       return GNUNET_SYSERR;
 801     }
 802     resi = i;
 803     if (NULL != unixpath)
 804       resi++;
 805     saddrs = GNUNET_new_array (resi + 1,
 806                                struct sockaddr *);
 807     saddrlens = GNUNET_new_array (resi + 1,
 808                                   socklen_t);
 809     i = 0;
 810     if (NULL != unixpath)
 811     {
 812       add_unixpath (saddrs,
 813                     saddrlens,
 814                     unixpath,
 815                     abstract);
 816       i++;
 817     }
 818     next = res;
 819     while (NULL != (pos = next))
 820     {
 821       next = pos->ai_next;
 822       if ( (disablev6) &&
 823            (AF_INET6 == pos->ai_family) )
 824         continue;
 825       if ( (IPPROTO_TCP != pos->ai_protocol) &&
 826            (0 != pos->ai_protocol) )
 827         continue;               /* not TCP */
 828       if ( (SOCK_STREAM != pos->ai_socktype) &&
 829            (0 != pos->ai_socktype) )
 830         continue;               /* huh? */
 831       LOG (GNUNET_ERROR_TYPE_DEBUG,
 832            "Service `%s' will bind to `%s'\n",
 833            service_name,
 834            GNUNET_a2s (pos->ai_addr,
 835                        pos->ai_addrlen));
 836       if (AF_INET == pos->ai_family)
 837       {
 838         GNUNET_assert (sizeof (struct sockaddr_in) == pos->ai_addrlen);
 839         saddrlens[i] = pos->ai_addrlen;
 840         saddrs[i] = GNUNET_malloc (saddrlens[i]);
 841         GNUNET_memcpy (saddrs[i],
 842                        pos->ai_addr,
 843                        saddrlens[i]);
 844         ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
 845       }
 846       else
 847       {
 848         GNUNET_assert (AF_INET6 == pos->ai_family);
 849         GNUNET_assert (sizeof (struct sockaddr_in6) == pos->ai_addrlen);
 850         saddrlens[i] = pos->ai_addrlen;
 851         saddrs[i] = GNUNET_malloc (saddrlens[i]);
 852         GNUNET_memcpy (saddrs[i],
 853                        pos->ai_addr,
 854                        saddrlens[i]);
 855         ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
 856       }
 857       i++;
 858     }
 859     GNUNET_free (hostname);
 860     freeaddrinfo (res);
 861     resi = i;
 862   }
 863   else
 864   {
 865     /* will bind against everything, just set port */
 866     if (disablev6)
 867     {
 868       /* V4-only */
 869       resi = 1;
 870       if (NULL != unixpath)
 871         resi++;
 872       i = 0;
 873       saddrs = GNUNET_new_array (resi + 1,
 874                                  struct sockaddr *);
 875       saddrlens = GNUNET_new_array (resi + 1,
 876                                     socklen_t);
 877       if (NULL != unixpath)
 878       {
 879         add_unixpath (saddrs,
 880                       saddrlens,
 881                       unixpath,
 882                       abstract);
 883         i++;
 884       }
 885       saddrlens[i] = sizeof (struct sockaddr_in);
 886       saddrs[i] = GNUNET_malloc (saddrlens[i]);
 887 #if HAVE_SOCKADDR_IN_SIN_LEN
 888       ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
 889 #endif
 890       ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
 891       ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
 892     }
 893     else
 894     {
 895       /* dual stack */
 896       resi = 2;
 897       if (NULL != unixpath)
 898         resi++;
 899       saddrs = GNUNET_new_array (resi + 1,
 900                                  struct sockaddr *);
 901       saddrlens = GNUNET_new_array (resi + 1,
 902                                     socklen_t);
 903       i = 0;
 904       if (NULL != unixpath)
 905       {
 906         add_unixpath (saddrs,
 907                       saddrlens,
 908                       unixpath,
 909                       abstract);
 910         i++;
 911       }
 912       saddrlens[i] = sizeof (struct sockaddr_in6);
 913       saddrs[i] = GNUNET_malloc (saddrlens[i]);
 914 #if HAVE_SOCKADDR_IN_SIN_LEN
 915       ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
 916 #endif
 917       ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
 918       ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
 919       i++;
 920       saddrlens[i] = sizeof (struct sockaddr_in);
 921       saddrs[i] = GNUNET_malloc (saddrlens[i]);
 922 #if HAVE_SOCKADDR_IN_SIN_LEN
 923       ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
 924 #endif
 925       ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
 926       ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
 927     }
 928   }
 929   GNUNET_free_non_null (unixpath);
 930   *addrs = saddrs;
 931   *addr_lens = saddrlens;
 932   return resi;
 933 }
 934
 935
 936 #ifdef MINGW
 937 /**
 938  * Read listen sockets from the parent process (ARM).
 939  *
 940  * @param sh service context to initialize
 941  * @return NULL-terminated array of sockets on success,
 942  *         NULL if not ok (must bind yourself)
 943  */
 944 static struct GNUNET_NETWORK_Handle **
 945 receive_sockets_from_parent (struct GNUNET_SERVICE_Handle *sh)
 946 {
 947   static struct GNUNET_NETWORK_Handle **lsocks;
 948   const char *env_buf;
 949   int fail;
 950   uint64_t count;
 951   uint64_t i;
 952   HANDLE lsocks_pipe;
 953
 954   env_buf = getenv ("GNUNET_OS_READ_LSOCKS");
 955   if ( (NULL == env_buf) ||
 956        (strlen (env_buf) <= 0) )
 957     return NULL;
 958   /* Using W32 API directly here, because this pipe will
 959    * never be used outside of this function, and it's just too much of a bother
 960    * to create a GNUnet API that boxes a HANDLE (the way it is done with socks)
 961    */
 962   lsocks_pipe = (HANDLE) strtoul (env_buf,
 963                                   NULL,
 964                                   10);
 965   if ( (0 == lsocks_pipe) ||
 966        (INVALID_HANDLE_VALUE == lsocks_pipe))
 967     return NULL;
 968   fail = 1;
 969   do
 970   {
 971     int ret;
 972     int fail2;
 973     DWORD rd;
 974
 975     ret = ReadFile (lsocks_pipe,
 976                     &count,
 977                     sizeof (count),
 978                     &rd,
 979                     NULL);
 980     if ( (0 == ret) ||
 981          (sizeof (count) != rd) ||
 982          (0 == count) )
 983       break;
 984     lsocks = GNUNET_new_array (count + 1,
 985                                struct GNUNET_NETWORK_Handle *);
 986
 987     fail2 = 1;
 988     for (i = 0; i < count; i++)
 989     {
 990       WSAPROTOCOL_INFOA pi;
 991       uint64_t size;
 992       SOCKET s;
 993
 994       ret = ReadFile (lsocks_pipe,
 995                       &size,
 996                       sizeof (size),
 997                       &rd,
 998                       NULL);
 999       if ( (0 == ret) ||
1000            (sizeof (size) != rd) ||
1001            (sizeof (pi) != size) )
1002         break;
1003       ret = ReadFile (lsocks_pipe,
1004                       &pi,
1005                       sizeof (pi),
1006                       &rd,
1007                       NULL);
1008       if ( (0 == ret) ||
1009            (sizeof (pi) != rd))
1010         break;
1011       s = WSASocketA (pi.iAddressFamily,
1012                       pi.iSocketType,
1013                       pi.iProtocol,
1014                       &pi,
1015                       0,
1016                       WSA_FLAG_OVERLAPPED);
1017       lsocks[i] = GNUNET_NETWORK_socket_box_native (s);
1018       if (NULL == lsocks[i])
1019         break;
1020       else if (i == count - 1)
1021         fail2 = 0;
1022     }
1023     if (fail2)
1024       break;
1025     lsocks[count] = NULL;
1026     fail = 0;
1027   }
1028   while (fail);
1029   CloseHandle (lsocks_pipe);
1030
1031   if (fail)
1032   {
1033     LOG (GNUNET_ERROR_TYPE_ERROR,
1034          _("Could not access a pre-bound socket, will try to bind myself\n"));
1035     for (i = 0; (i < count) && (NULL != lsocks[i]); i++)
1036       GNUNET_break (GNUNET_OK ==
1037                     GNUNET_NETWORK_socket_close (lsocks[i]));
1038     GNUNET_free (lsocks);
1039     return NULL;
1040   }
1041   return lsocks;
1042 }
1043 #endif
1044
1045
1046 /**
1047  * Create and initialize a listen socket for the server.
1048  *
1049  * @param server_addr address to listen on
1050  * @param socklen length of @a server_addr
1051  * @return NULL on error, otherwise the listen socket
1052  */
1053 static struct GNUNET_NETWORK_Handle *
1054 open_listen_socket (const struct sockaddr *server_addr,
1055                     socklen_t socklen)
1056 {
1057   struct GNUNET_NETWORK_Handle *sock;
1058   uint16_t port;
1059   int eno;
1060
1061   switch (server_addr->sa_family)
1062   {
1063   case AF_INET:
1064     port = ntohs (((const struct sockaddr_in *) server_addr)->sin_port);
1065     break;
1066   case AF_INET6:
1067     port = ntohs (((const struct sockaddr_in6 *) server_addr)->sin6_port);
1068     break;
1069   case AF_UNIX:
1070     port = 0;
1071     break;
1072   default:
1073     GNUNET_break (0);
1074     port = 0;
1075     break;
1076   }
1077   sock = GNUNET_NETWORK_socket_create (server_addr->sa_family,
1078                                        SOCK_STREAM,
1079                                        0);
1080   if (NULL == sock)
1081   {
1082     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1083                   "socket");
1084     errno = 0;
1085     return NULL;
1086   }
1087   /* bind the socket */
1088   if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock,
1089                                                server_addr,
1090                                                socklen))
1091   {
1092     eno = errno;
1093     if (EADDRINUSE != errno)
1094     {
1095       /* we don't log 'EADDRINUSE' here since an IPv4 bind may
1096        * fail if we already took the port on IPv6; if both IPv4 and
1097        * IPv6 binds fail, then our caller will log using the
1098        * errno preserved in 'eno' */
1099       LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1100                     "bind");
1101       if (0 != port)
1102         LOG (GNUNET_ERROR_TYPE_ERROR,
1103              _("`%s' failed for port %d (%s).\n"),
1104              "bind",
1105              port,
1106              (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
1107       eno = 0;
1108     }
1109     else
1110     {
1111       if (0 != port)
1112         LOG (GNUNET_ERROR_TYPE_WARNING,
1113              _("`%s' failed for port %d (%s): address already in use\n"),
1114              "bind", port,
1115              (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
1116       else if (AF_UNIX == server_addr->sa_family)
1117       {
1118         LOG (GNUNET_ERROR_TYPE_WARNING,
1119              _("`%s' failed for `%s': address already in use\n"),
1120              "bind",
1121              GNUNET_a2s (server_addr, socklen));
1122       }
1123     }
1124     GNUNET_break (GNUNET_OK ==
1125                   GNUNET_NETWORK_socket_close (sock));
1126     errno = eno;
1127     return NULL;
1128   }
1129   if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock,
1130                                                  5))
1131   {
1132     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1133                   "listen");
1134     GNUNET_break (GNUNET_OK ==
1135                   GNUNET_NETWORK_socket_close (sock));
1136     errno = 0;
1137     return NULL;
1138   }
1139   if (0 != port)
1140     LOG (GNUNET_ERROR_TYPE_DEBUG,
1141          "Server starts to listen on port %u.\n",
1142          port);
1143   return sock;
1144 }
1145
1146
1147 /**
1148  * Setup service handle
1149  *
1150  * Configuration may specify:
1151  * - PORT (where to bind to for TCP)
1152  * - UNIXPATH (where to bind to for UNIX domain sockets)
1153  * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1154  * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1155  * - ACCEPT_FROM  (only allow connections from specified IPv4 subnets)
1156  * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1157  * - REJECT_FROM  (disallow allow connections from specified IPv4 subnets)
1158  * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1159  *
1160  * @param sh service context to initialize
1161  * @return #GNUNET_OK if configuration succeeded
1162  */
1163 static int
1164 setup_service (struct GNUNET_SERVICE_Handle *sh)
1165 {
1166   int tolerant;
1167   struct GNUNET_NETWORK_Handle **lsocks;
1168 #ifndef MINGW
1169   const char *nfds;
1170   unsigned int cnt;
1171   int flags;
1172 #endif
1173
1174   if (GNUNET_CONFIGURATION_have_value
1175       (sh->cfg,
1176        sh->service_name,
1177        "TOLERANT"))
1178   {
1179     if (GNUNET_SYSERR ==
1180         (tolerant =
1181          GNUNET_CONFIGURATION_get_value_yesno (sh->cfg,
1182                                                sh->service_name,
1183                                                "TOLERANT")))
1184     {
1185       LOG (GNUNET_ERROR_TYPE_ERROR,
1186            _("Specified value for `%s' of service `%s' is invalid\n"),
1187            "TOLERANT",
1188            sh->service_name);
1189       return GNUNET_SYSERR;
1190     }
1191   }
1192   else
1193     tolerant = GNUNET_NO;
1194
1195   lsocks = NULL;
1196 #ifndef MINGW
1197   errno = 0;
1198   if ( (NULL != (nfds = getenv ("LISTEN_FDS"))) &&
1199        (1 == SSCANF (nfds,
1200                      "%u",
1201                      &cnt)) &&
1202        (cnt > 0) &&
1203        (cnt < FD_SETSIZE) &&
1204        (cnt + 4 < FD_SETSIZE) )
1205   {
1206     lsocks = GNUNET_new_array (cnt + 1,
1207                                struct GNUNET_NETWORK_Handle *);
1208     while (0 < cnt--)
1209     {
1210       flags = fcntl (3 + cnt,
1211                      F_GETFD);
1212       if ( (flags < 0) ||
1213            (0 != (flags & FD_CLOEXEC)) ||
1214            (NULL ==
1215             (lsocks[cnt] = GNUNET_NETWORK_socket_box_native (3 + cnt))))
1216       {
1217         LOG (GNUNET_ERROR_TYPE_ERROR,
1218              _("Could not access pre-bound socket %u, will try to bind myself\n"),
1219              (unsigned int) 3 + cnt);
1220         cnt++;
1221         while (NULL != lsocks[cnt])
1222           GNUNET_break (GNUNET_OK ==
1223                         GNUNET_NETWORK_socket_close (lsocks[cnt++]));
1224         GNUNET_free (lsocks);
1225         lsocks = NULL;
1226         break;
1227       }
1228     }
1229     unsetenv ("LISTEN_FDS");
1230   }
1231 #else
1232   if (NULL != getenv ("GNUNET_OS_READ_LSOCKS"))
1233   {
1234     lsocks = receive_sockets_from_parent (sh);
1235     putenv ("GNUNET_OS_READ_LSOCKS=");
1236   }
1237 #endif
1238
1239   if (NULL != lsocks)
1240   {
1241     /* listen only on inherited sockets if we have any */
1242     struct GNUNET_NETWORK_Handle **ls;
1243
1244     for (ls = lsocks; NULL != *ls; ls++)
1245     {
1246       struct ServiceListenContext *slc;
1247
1248       slc = GNUNET_new (struct ServiceListenContext);
1249       slc->sh = sh;
1250       slc->listen_socket = *ls;
1251       GNUNET_CONTAINER_DLL_insert (sh->slc_head,
1252                                    sh->slc_tail,
1253                                    slc);
1254     }
1255     GNUNET_free (lsocks);
1256   }
1257   else
1258   {
1259     struct sockaddr **addrs;
1260     socklen_t *addrlens;
1261     int num;
1262
1263     num = get_server_addresses (sh->service_name,
1264                                 sh->cfg,
1265                                 &addrs,
1266                                 &addrlens);
1267     if (GNUNET_SYSERR == num)
1268       return GNUNET_SYSERR;
1269
1270     for (int i = 0; i < num; i++)
1271     {
1272       struct ServiceListenContext *slc;
1273
1274       slc = GNUNET_new (struct ServiceListenContext);
1275       slc->sh = sh;
1276       slc->listen_socket = open_listen_socket (addrs[i],
1277                                                addrlens[i]);
1278       if (NULL == slc->listen_socket)
1279       {
1280         GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
1281                              "bind");
1282         GNUNET_free (addrs[i++]);
1283         GNUNET_free (slc);
1284         continue;
1285       }
1286       GNUNET_free (addrs[i++]);
1287       GNUNET_CONTAINER_DLL_insert (sh->slc_head,
1288                                    sh->slc_tail,
1289                                    slc);
1290     }
1291     GNUNET_free_non_null (addrlens);
1292     GNUNET_free_non_null (addrs);
1293     if ( (0 != num) &&
1294          (NULL == sh->slc_head) )
1295     {
1296       /* All attempts to bind failed, hard failure */
1297       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1298                   _("Could not bind to any of the ports I was supposed to, refusing to run!\n"));
1299       return GNUNET_SYSERR;
1300     }
1301   }
1302
1303   sh->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1304   sh->match_uid
1305     = GNUNET_CONFIGURATION_get_value_yesno (sh->cfg,
1306                                             sh->service_name,
1307                                             "UNIX_MATCH_UID");
1308   sh->match_gid
1309     = GNUNET_CONFIGURATION_get_value_yesno (sh->cfg,
1310                                             sh->service_name,
1311                                             "UNIX_MATCH_GID");
1312   process_acl4 (&sh->v4_denied,
1313                 sh,
1314                 "REJECT_FROM");
1315   process_acl4 (&sh->v4_allowed,
1316                 sh,
1317                 "ACCEPT_FROM");
1318   process_acl6 (&sh->v6_denied,
1319                 sh,
1320                 "REJECT_FROM6");
1321   process_acl6 (&sh->v6_allowed,
1322                 sh,
1323                 "ACCEPT_FROM6");
1324   return GNUNET_OK;
1325 }
1326
1327
1328 /**
1329  * Get the name of the user that'll be used
1330  * to provide the service.
1331  *
1332  * @param sh service context
1333  * @return value of the 'USERNAME' option
1334  */
1335 static char *
1336 get_user_name (struct GNUNET_SERVICE_Handle *sh)
1337 {
1338   char *un;
1339
1340   if (GNUNET_OK !=
1341       GNUNET_CONFIGURATION_get_value_filename (sh->cfg,
1342                                                sh->service_name,
1343                                                "USERNAME",
1344                                                &un))
1345     return NULL;
1346   return un;
1347 }
1348
1349
1350 /**
1351  * Set user ID.
1352  *
1353  * @param sh service context
1354  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1355  */
1356 static int
1357 set_user_id (struct GNUNET_SERVICE_Handle *sh)
1358 {
1359   char *user;
1360
1361   if (NULL == (user = get_user_name (sh)))
1362     return GNUNET_OK;           /* keep */
1363 #ifndef MINGW
1364   struct passwd *pws;
1365
1366   errno = 0;
1367   pws = getpwnam (user);
1368   if (NULL == pws)
1369   {
1370     LOG (GNUNET_ERROR_TYPE_ERROR,
1371          _("Cannot obtain information about user `%s': %s\n"),
1372          user,
1373          errno == 0 ? _("No such user") : STRERROR (errno));
1374     GNUNET_free (user);
1375     return GNUNET_SYSERR;
1376   }
1377   if ( (0 != setgid (pws->pw_gid)) ||
1378        (0 != setegid (pws->pw_gid)) ||
1379 #if HAVE_INITGROUPS
1380        (0 != initgroups (user,
1381                          pws->pw_gid)) ||
1382 #endif
1383        (0 != setuid (pws->pw_uid)) ||
1384        (0 != seteuid (pws->pw_uid)))
1385   {
1386     if ((0 != setregid (pws->pw_gid,
1387                         pws->pw_gid)) ||
1388         (0 != setreuid (pws->pw_uid,
1389                         pws->pw_uid)))
1390     {
1391       LOG (GNUNET_ERROR_TYPE_ERROR,
1392            _("Cannot change user/group to `%s': %s\n"),
1393            user,
1394            STRERROR (errno));
1395       GNUNET_free (user);
1396       return GNUNET_SYSERR;
1397     }
1398   }
1399 #endif
1400   GNUNET_free (user);
1401   return GNUNET_OK;
1402 }
1403
1404
1405 /**
1406  * Get the name of the file where we will
1407  * write the PID of the service.
1408  *
1409  * @param sh service context
1410  * @return name of the file for the process ID
1411  */
1412 static char *
1413 get_pid_file_name (struct GNUNET_SERVICE_Handle *sh)
1414 {
1415   char *pif;
1416
1417   if (GNUNET_OK !=
1418       GNUNET_CONFIGURATION_get_value_filename (sh->cfg,
1419                                                sh->service_name,
1420                                                "PIDFILE",
1421                                                &pif))
1422     return NULL;
1423   return pif;
1424 }
1425
1426
1427 /**
1428  * Delete the PID file that was created by our parent.
1429  *
1430  * @param sh service context
1431  */
1432 static void
1433 pid_file_delete (struct GNUNET_SERVICE_Handle *sh)
1434 {
1435   char *pif = get_pid_file_name (sh);
1436
1437   if (NULL == pif)
1438     return;                     /* no PID file */
1439   if (0 != UNLINK (pif))
1440     LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
1441                        "unlink",
1442                        pif);
1443   GNUNET_free (pif);
1444 }
1445
1446
1447 /**
1448  * Detach from terminal.
1449  *
1450  * @param sh service context
1451  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1452  */
1453 static int
1454 detach_terminal (struct GNUNET_SERVICE_Handle *sh)
1455 {
1456 #ifndef MINGW
1457   pid_t pid;
1458   int nullfd;
1459   int filedes[2];
1460
1461   if (0 != PIPE (filedes))
1462   {
1463     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1464                   "pipe");
1465     return GNUNET_SYSERR;
1466   }
1467   pid = fork ();
1468   if (pid < 0)
1469   {
1470     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1471                   "fork");
1472     return GNUNET_SYSERR;
1473   }
1474   if (0 != pid)
1475   {
1476     /* Parent */
1477     char c;
1478
1479     GNUNET_break (0 == CLOSE (filedes[1]));
1480     c = 'X';
1481     if (1 != READ (filedes[0],
1482                    &c,
1483                    sizeof (char)))
1484       LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1485                     "read");
1486     fflush (stdout);
1487     switch (c)
1488     {
1489     case '.':
1490       exit (0);
1491     case 'I':
1492       LOG (GNUNET_ERROR_TYPE_INFO,
1493            _("Service process failed to initialize\n"));
1494       break;
1495     case 'S':
1496       LOG (GNUNET_ERROR_TYPE_INFO,
1497            _("Service process could not initialize server function\n"));
1498       break;
1499     case 'X':
1500       LOG (GNUNET_ERROR_TYPE_INFO,
1501            _("Service process failed to report status\n"));
1502       break;
1503     }
1504     exit (1);                   /* child reported error */
1505   }
1506   GNUNET_break (0 == CLOSE (0));
1507   GNUNET_break (0 == CLOSE (1));
1508   GNUNET_break (0 == CLOSE (filedes[0]));
1509   nullfd = OPEN ("/dev/null",
1510                  O_RDWR | O_APPEND);
1511   if (nullfd < 0)
1512     return GNUNET_SYSERR;
1513   /* set stdin/stdout to /dev/null */
1514   if ( (dup2 (nullfd, 0) < 0) ||
1515        (dup2 (nullfd, 1) < 0) )
1516   {
1517     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1518                   "dup2");
1519     (void) CLOSE (nullfd);
1520     return GNUNET_SYSERR;
1521   }
1522   (void) CLOSE (nullfd);
1523   /* Detach from controlling terminal */
1524   pid = setsid ();
1525   if (-1 == pid)
1526     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1527                   "setsid");
1528   sh->ready_confirm_fd = filedes[1];
1529 #else
1530   /* FIXME: we probably need to do something else
1531    * elsewhere in order to fork the process itself... */
1532   FreeConsole ();
1533 #endif
1534   return GNUNET_OK;
1535 }
1536
1537
1538 /**
1539  * Low-level function to start a service if the scheduler
1540  * is already running.  Should only be used directly in
1541  * special cases.
1542  *
1543  * The function will launch the service with the name @a service_name
1544  * using the @a service_options to configure its shutdown
1545  * behavior. When clients connect or disconnect, the respective
1546  * @a connect_cb or @a disconnect_cb functions will be called. For
1547  * messages received from the clients, the respective @a handlers will
1548  * be invoked; for the closure of the handlers we use the return value
1549  * from the @a connect_cb invocation of the respective client.
1550  *
1551  * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
1552  * message to receive further messages from this client.  If
1553  * #GNUNET_SERVICE_client_continue() is not called within a short
1554  * time, a warning will be logged. If delays are expected, services
1555  * should call #GNUNET_SERVICE_client_disable_continue_warning() to
1556  * disable the warning.
1557  *
1558  * Clients sending invalid messages (based on @a handlers) will be
1559  * dropped. Additionally, clients can be dropped at any time using
1560  * #GNUNET_SERVICE_client_drop().
1561  *
1562  * The service must be stopped using #GNUNET_SERVICE_stoP().
1563  *
1564  * @param service_name name of the service to run
1565  * @param cfg configuration to use
1566  * @param connect_cb function to call whenever a client connects
1567  * @param disconnect_cb function to call whenever a client disconnects
1568  * @param cls closure argument for @a connect_cb and @a disconnect_cb
1569  * @param handlers NULL-terminated array of message handlers for the service,
1570  *                 the closure will be set to the value returned by
1571  *                 the @a connect_cb for the respective connection
1572  * @return NULL on error
1573  */
1574 struct GNUNET_SERVICE_Handle *
1575 GNUNET_SERVICE_starT (const char *service_name,
1576                       const struct GNUNET_CONFIGURATION_Handle *cfg,
1577                       GNUNET_SERVICE_ConnectHandler connect_cb,
1578                       GNUNET_SERVICE_DisconnectHandler disconnect_cb,
1579                       void *cls,
1580                       const struct GNUNET_MQ_MessageHandler *handlers)
1581 {
1582   GNUNET_break (0); // FIXME: not implemented
1583   return NULL;
1584 }
1585
1586
1587 /**
1588  * Stops a service that was started with #GNUNET_SERVICE_starT().
1589  *
1590  * @param srv service to stop
1591  */
1592 void
1593 GNUNET_SERVICE_stoP (struct GNUNET_SERVICE_Handle *srv)
1594 {
1595   GNUNET_assert (0); // FIXME: not implemented
1596 }
1597
1598
1599 /**
1600  * Creates the "main" function for a GNUnet service.  You
1601  * should almost always use the #GNUNET_SERVICE_MAIN macro
1602  * instead of calling this function directly (except
1603  * for ARM, which should call this function directly).
1604  *
1605  * The function will launch the service with the name @a service_name
1606  * using the @a service_options to configure its shutdown
1607  * behavior. Once the service is ready, the @a init_cb will be called
1608  * for service-specific initialization.  @a init_cb will be given the
1609  * service handler which can be used to control the service's
1610  * availability.  When clients connect or disconnect, the respective
1611  * @a connect_cb or @a disconnect_cb functions will be called. For
1612  * messages received from the clients, the respective @a handlers will
1613  * be invoked; for the closure of the handlers we use the return value
1614  * from the @a connect_cb invocation of the respective client.
1615  *
1616  * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
1617  * message to receive further messages from this client.  If
1618  * #GNUNET_SERVICE_client_continue() is not called within a short
1619  * time, a warning will be logged. If delays are expected, services
1620  * should call #GNUNET_SERVICE_client_disable_continue_warning() to
1621  * disable the warning.
1622  *
1623  * Clients sending invalid messages (based on @a handlers) will be
1624  * dropped. Additionally, clients can be dropped at any time using
1625  * #GNUNET_SERVICE_client_drop().
1626  *
1627  * @param argc number of command-line arguments in @a argv
1628  * @param argv array of command-line arguments
1629  * @param service_name name of the service to run
1630  * @param options options controlling shutdown of the service
1631  * @param service_init_cb function to call once the service is ready
1632  * @param connect_cb function to call whenever a client connects
1633  * @param disconnect_cb function to call whenever a client disconnects
1634  * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
1635  * @param handlers NULL-terminated array of message handlers for the service,
1636  *                 the closure will be set to the value returned by
1637  *                 the @a connect_cb for the respective connection
1638  * @return 0 on success, non-zero on error
1639  */
1640 int
1641 GNUNET_SERVICE_ruN_ (int argc,
1642                      char *const *argv,
1643                      const char *service_name,
1644                      enum GNUNET_SERVICE_Options options,
1645                      GNUNET_SERVICE_InitCallback service_init_cb,
1646                      GNUNET_SERVICE_ConnectHandler connect_cb,
1647                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
1648                      void *cls,
1649                      const struct GNUNET_MQ_MessageHandler *handlers)
1650 {
1651   struct GNUNET_SERVICE_Handle sh;
1652   char *cfg_filename;
1653   char *opt_cfg_filename;
1654   char *loglev;
1655   const char *xdg;
1656   char *logfile;
1657   int do_daemonize;
1658   unsigned long long skew_offset;
1659   unsigned long long skew_variance;
1660   long long clock_offset;
1661   struct GNUNET_CONFIGURATION_Handle *cfg;
1662   int ret;
1663   int err;
1664
1665   struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1666     GNUNET_GETOPT_OPTION_CFG_FILE (&opt_cfg_filename),
1667     {'d', "daemonize", NULL,
1668      gettext_noop ("do daemonize (detach from terminal)"), 0,
1669      GNUNET_GETOPT_set_one, &do_daemonize},
1670     GNUNET_GETOPT_OPTION_HELP (NULL),
1671     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1672     GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1673     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION " " VCS_VERSION),
1674     GNUNET_GETOPT_OPTION_END
1675   };
1676
1677   memset (&sh,
1678           0,
1679           sizeof (sh));
1680   xdg = getenv ("XDG_CONFIG_HOME");
1681   if (NULL != xdg)
1682     GNUNET_asprintf (&cfg_filename,
1683                      "%s%s%s",
1684                      xdg,
1685                      DIR_SEPARATOR_STR,
1686                      GNUNET_OS_project_data_get ()->config_file);
1687   else
1688     cfg_filename = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
1689   sh.ready_confirm_fd = -1;
1690   sh.options = options;
1691   sh.cfg = cfg = GNUNET_CONFIGURATION_create ();
1692   sh.service_init_cb = service_init_cb;
1693   sh.connect_cb = connect_cb;
1694   sh.disconnect_cb = disconnect_cb;
1695   sh.cb_cls = cls;
1696   sh.handlers = handlers;
1697   sh.service_name = service_name;
1698
1699   /* setup subsystems */
1700   loglev = NULL;
1701   logfile = NULL;
1702   opt_cfg_filename = NULL;
1703   do_daemonize = 0;
1704   ret = GNUNET_GETOPT_run (service_name,
1705                            service_options,
1706                            argc,
1707                            argv);
1708   if (GNUNET_SYSERR == ret)
1709     goto shutdown;
1710   if (GNUNET_NO == ret)
1711   {
1712     err = 0;
1713     goto shutdown;
1714   }
1715   if (GNUNET_OK != GNUNET_log_setup (service_name,
1716                                      loglev,
1717                                      logfile))
1718   {
1719     GNUNET_break (0);
1720     goto shutdown;
1721   }
1722   if (NULL == opt_cfg_filename)
1723     opt_cfg_filename = GNUNET_strdup (cfg_filename);
1724   if (GNUNET_YES == GNUNET_DISK_file_test (opt_cfg_filename))
1725   {
1726     if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg,
1727                                                     opt_cfg_filename))
1728     {
1729       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1730                   _("Malformed configuration file `%s', exit ...\n"),
1731                   opt_cfg_filename);
1732       goto shutdown;
1733     }
1734   }
1735   else
1736   {
1737     if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg,
1738                                                     NULL))
1739     {
1740       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1741                   _("Malformed configuration, exit ...\n"));
1742       goto shutdown;
1743     }
1744     if (0 != strcmp (opt_cfg_filename,
1745                      cfg_filename))
1746       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1747                   _("Could not access configuration file `%s'\n"),
1748                   opt_cfg_filename);
1749   }
1750   if (GNUNET_OK != setup_service (&sh))
1751     goto shutdown;
1752   if ( (1 == do_daemonize) &&
1753        (GNUNET_OK != detach_terminal (&sh)) )
1754   {
1755     GNUNET_break (0);
1756     goto shutdown;
1757   }
1758   if (GNUNET_OK != set_user_id (&sh))
1759     goto shutdown;
1760   LOG (GNUNET_ERROR_TYPE_DEBUG,
1761        "Service `%s' runs with configuration from `%s'\n",
1762        service_name,
1763        opt_cfg_filename);
1764   if ((GNUNET_OK ==
1765        GNUNET_CONFIGURATION_get_value_number (sh.cfg,
1766                                               "TESTING",
1767                                               "SKEW_OFFSET",
1768                                               &skew_offset)) &&
1769       (GNUNET_OK ==
1770        GNUNET_CONFIGURATION_get_value_number (sh.cfg,
1771                                               "TESTING",
1772                                               "SKEW_VARIANCE",
1773                                               &skew_variance)))
1774   {
1775     clock_offset = skew_offset - skew_variance;
1776     GNUNET_TIME_set_offset (clock_offset);
1777     LOG (GNUNET_ERROR_TYPE_DEBUG,
1778          "Skewing clock by %dll ms\n",
1779          clock_offset);
1780   }
1781   GNUNET_RESOLVER_connect (sh.cfg);
1782
1783   /* actually run service */
1784   err = 0;
1785   GNUNET_SCHEDULER_run (&service_main,
1786                         &sh);
1787   /* shutdown */
1788   if (1 == do_daemonize)
1789     pid_file_delete (&sh);
1790
1791 shutdown:
1792   if (-1 != sh.ready_confirm_fd)
1793   {
1794     if (1 != WRITE (sh.ready_confirm_fd,
1795                     err ? "I" : "S",
1796                     1))
1797       LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1798                     "write");
1799     GNUNET_break (0 == CLOSE (sh.ready_confirm_fd));
1800   }
1801 #if HAVE_MALLINFO
1802   {
1803     char *counter;
1804
1805     if ( (GNUNET_YES ==
1806           GNUNET_CONFIGURATION_have_value (sh.cfg,
1807                                            service_name,
1808                                            "GAUGER_HEAP")) &&
1809          (GNUNET_OK ==
1810           GNUNET_CONFIGURATION_get_value_string (sh.cfg,
1811                                                  service_name,
1812                                                  "GAUGER_HEAP",
1813                                                  &counter)) )
1814     {
1815       struct mallinfo mi;
1816
1817       mi = mallinfo ();
1818       GAUGER (service_name,
1819               counter,
1820               mi.usmblks,
1821               "blocks");
1822       GNUNET_free (counter);
1823     }
1824   }
1825 #endif
1826   GNUNET_SPEEDUP_stop_ ();
1827   GNUNET_CONFIGURATION_destroy (cfg);
1828
1829   while (NULL != sh.slc_head)
1830   {
1831     struct ServiceListenContext *slc = sh.slc_head;
1832
1833     sh.slc_head = slc->next;
1834     if (NULL != slc->listen_task)
1835       GNUNET_SCHEDULER_cancel (slc->listen_task);
1836     GNUNET_break (GNUNET_OK ==
1837                   GNUNET_NETWORK_socket_close (slc->listen_socket));
1838     GNUNET_free (slc);
1839   }
1840
1841   GNUNET_free_non_null (logfile);
1842   GNUNET_free_non_null (loglev);
1843   GNUNET_free (cfg_filename);
1844   GNUNET_free_non_null (opt_cfg_filename);
1845   GNUNET_free_non_null (sh.v4_denied);
1846   GNUNET_free_non_null (sh.v6_denied);
1847   GNUNET_free_non_null (sh.v4_allowed);
1848   GNUNET_free_non_null (sh.v6_allowed);
1849
1850   return err ? GNUNET_SYSERR : sh.ret;
1851 }
1852
1853
1854 /**
1855  * Suspend accepting connections from the listen socket temporarily.
1856  * Resume activity using #GNUNET_SERVICE_resume.
1857  *
1858  * @param sh service to stop accepting connections.
1859  */
1860 void
1861 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh)
1862 {
1863   struct ServiceListenContext *slc;
1864
1865   for (slc = sh->slc_head; NULL != slc; slc = slc->next)
1866   {
1867     if (NULL != slc->listen_task)
1868     {
1869       GNUNET_SCHEDULER_cancel (slc->listen_task);
1870       slc->listen_task = NULL;
1871     }
1872   }
1873 }
1874
1875
1876 /**
1877  * Task run when we are ready to transmit data to the
1878  * client.
1879  *
1880  * @param cls the `struct GNUNET_SERVICE_Client *` to send to
1881  */
1882 static void
1883 do_send (void *cls)
1884 {
1885   struct GNUNET_SERVICE_Client *client = cls;
1886   ssize_t ret;
1887   size_t left;
1888   const char *buf;
1889
1890   client->send_task = NULL;
1891   buf = (const char *) client->msg;
1892   left = ntohs (client->msg->size) - client->msg_pos;
1893   ret = GNUNET_NETWORK_socket_send (client->sock,
1894                                     &buf[client->msg_pos],
1895                                     left);
1896   GNUNET_assert (ret <= (ssize_t) left);
1897   if (0 == ret)
1898   {
1899     GNUNET_MQ_inject_error (client->mq,
1900                             GNUNET_MQ_ERROR_WRITE);
1901     return;
1902   }
1903   if (-1 == ret)
1904   {
1905     if ( (EAGAIN == errno) ||
1906          (EINTR == errno) )
1907     {
1908       /* ignore */
1909       ret = 0;
1910     }
1911     else
1912     {
1913       if (EPIPE != errno)
1914         GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
1915                              "send");
1916       GNUNET_MQ_inject_error (client->mq,
1917                               GNUNET_MQ_ERROR_WRITE);
1918       return;
1919     }
1920   }
1921   client->msg_pos += ret;
1922   if (left > ret)
1923   {
1924     client->send_task
1925       = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
1926                                         client->sock,
1927                                         &do_send,
1928                                         client);
1929     return;
1930   }
1931   GNUNET_MQ_impl_send_continue (client->mq);
1932 }
1933
1934
1935 /**
1936  * Signature of functions implementing the sending functionality of a
1937  * message queue.
1938  *
1939  * @param mq the message queue
1940  * @param msg the message to send
1941  * @param impl_state our `struct GNUNET_SERVICE_Client *`
1942  */
1943 static void
1944 service_mq_send (struct GNUNET_MQ_Handle *mq,
1945                  const struct GNUNET_MessageHeader *msg,
1946                  void *impl_state)
1947 {
1948   struct GNUNET_SERVICE_Client *client = impl_state;
1949
1950   GNUNET_assert (NULL == client->send_task);
1951   client->msg = msg;
1952   client->msg_pos = 0;
1953   client->send_task
1954     = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
1955                                       client->sock,
1956                                       &do_send,
1957                                       client);
1958 }
1959
1960
1961 /**
1962  * Implementation function that cancels the currently sent message.
1963  *
1964  * @param mq message queue
1965  * @param impl_state state specific to the implementation
1966  */
1967 static void
1968 service_mq_cancel (struct GNUNET_MQ_Handle *mq,
1969                    void *impl_state)
1970 {
1971   struct GNUNET_SERVICE_Client *client = impl_state;
1972
1973   GNUNET_assert (0); // not implemented
1974   // FIXME: stop transmission! (must be possible, otherwise
1975   // we must have told MQ that the message was sent!)
1976 }
1977
1978
1979 /**
1980  * Generic error handler, called with the appropriate
1981  * error code and the same closure specified at the creation of
1982  * the message queue.
1983  * Not every message queue implementation supports an error handler.
1984  *
1985  * @param cls closure with our `struct GNUNET_SERVICE_Client`
1986  * @param error error code
1987  */
1988 static void
1989 service_mq_error_handler (void *cls,
1990                           enum GNUNET_MQ_Error error)
1991 {
1992   struct GNUNET_SERVICE_Client *client = cls;
1993   struct GNUNET_SERVICE_Handle *sh = client->sh;
1994
1995   if ( (GNUNET_MQ_ERROR_NO_MATCH == error) &&
1996        (GNUNET_NO == sh->require_found) )
1997   {
1998     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1999                 "No handler for message of type %u found\n",
2000                 (unsigned int) client->warn_type);
2001     GNUNET_SERVICE_client_continue (client);
2002     return; /* ignore error */
2003   }
2004   GNUNET_SERVICE_client_drop (client);
2005 }
2006
2007
2008 /**
2009  * Task run to warn about missing calls to #GNUNET_SERVICE_client_continue().
2010  *
2011  * @param cls our `struct GNUNET_SERVICE_Client *` to process more requests from
2012  */
2013 static void
2014 warn_no_client_continue (void *cls)
2015 {
2016   struct GNUNET_SERVICE_Client *client = cls;
2017
2018   GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
2019   client->warn_task
2020     = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
2021                                     &warn_no_client_continue,
2022                                     client);
2023   LOG (GNUNET_ERROR_TYPE_WARNING,
2024        _("Processing code for message of type %u did not call `GNUNET_SERVICE_client_continue' after %s\n"),
2025        (unsigned int) client->warn_type,
2026        GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (client->warn_start),
2027                                                GNUNET_YES));
2028 }
2029
2030
2031 /**
2032  * Functions with this signature are called whenever a
2033  * complete message is received by the tokenizer for a client.
2034  *
2035  * Do not call #GNUNET_MST_destroy() from within
2036  * the scope of this callback.
2037  *
2038  * @param cls closure with the `struct GNUNET_SERVICE_Client *`
2039  * @param message the actual message
2040  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the client was dropped
2041  */
2042 static int
2043 service_client_mst_cb (void *cls,
2044                        const struct GNUNET_MessageHeader *message)
2045 {
2046   struct GNUNET_SERVICE_Client *client = cls;
2047
2048   GNUNET_assert (GNUNET_NO == client->needs_continue);
2049   client->needs_continue = GNUNET_YES;
2050   client->warn_type = ntohs (message->type);
2051   client->warn_start = GNUNET_TIME_absolute_get ();
2052   GNUNET_assert (NULL == client->warn_task);
2053   client->warn_task
2054     = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
2055                                     &warn_no_client_continue,
2056                                     client);
2057   GNUNET_MQ_inject_message (client->mq,
2058                             message);
2059   if (NULL != client->drop_task)
2060     return GNUNET_SYSERR;
2061   return GNUNET_OK;
2062 }
2063
2064
2065 /**
2066  * A client sent us data. Receive and process it.  If we are done,
2067  * reschedule this task.
2068  *
2069  * @param cls the `struct GNUNET_SERVICE_Client` that sent us data.
2070  */
2071 static void
2072 service_client_recv (void *cls)
2073 {
2074   struct GNUNET_SERVICE_Client *client = cls;
2075   int ret;
2076
2077   client->recv_task = NULL;
2078   ret = GNUNET_MST_read (client->mst,
2079                          client->sock,
2080                          GNUNET_NO,
2081                          GNUNET_YES);
2082   if (GNUNET_SYSERR == ret)
2083   {
2084     /* client closed connection (or IO error) */
2085     if (NULL == client->drop_task)
2086     {
2087       GNUNET_assert (GNUNET_NO == client->needs_continue);
2088       GNUNET_SERVICE_client_drop (client);
2089     }
2090     return;
2091   }
2092   if (GNUNET_NO == ret)
2093     return; /* more messages in buffer, wait for application
2094                to be done processing */
2095   GNUNET_assert (GNUNET_OK == ret);
2096   if (GNUNET_YES == client->needs_continue)
2097     return;
2098   if (NULL != client->recv_task)
2099     return;
2100   /* MST needs more data, re-schedule read job */
2101   client->recv_task
2102     = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2103                                      client->sock,
2104                                      &service_client_recv,
2105                                      client);
2106 }
2107
2108
2109 /**
2110  * We have successfully accepted a connection from a client.  Now
2111  * setup the client (with the scheduler) and tell the application.
2112  *
2113  * @param sh service that accepted the client
2114  * @param sock socket associated with the client
2115  */
2116 static void
2117 start_client (struct GNUNET_SERVICE_Handle *sh,
2118               struct GNUNET_NETWORK_Handle *csock)
2119 {
2120   struct GNUNET_SERVICE_Client *client;
2121
2122   client = GNUNET_new (struct GNUNET_SERVICE_Client);
2123   GNUNET_CONTAINER_DLL_insert (sh->clients_head,
2124                                sh->clients_tail,
2125                                client);
2126   client->sh = sh;
2127   client->sock = csock;
2128   client->mq = GNUNET_MQ_queue_for_callbacks (&service_mq_send,
2129                                               NULL,
2130                                               &service_mq_cancel,
2131                                               client,
2132                                               sh->handlers,
2133                                               &service_mq_error_handler,
2134                                               client);
2135   client->mst = GNUNET_MST_create (&service_client_mst_cb,
2136                                    client);
2137   client->user_context = sh->connect_cb (sh->cb_cls,
2138                                          client,
2139                                          client->mq);
2140   GNUNET_MQ_set_handlers_closure (client->mq,
2141                                   client->user_context);
2142   client->recv_task
2143     = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2144                                      client->sock,
2145                                      &service_client_recv,
2146                                      client);
2147 }
2148
2149
2150 /**
2151  * Check if the given IP address is in the list of IP addresses.
2152  *
2153  * @param list a list of networks
2154  * @param add the IP to check (in network byte order)
2155  * @return #GNUNET_NO if the IP is not in the list, #GNUNET_YES if it it is
2156  */
2157 static int
2158 check_ipv4_listed (const struct GNUNET_STRINGS_IPv4NetworkPolicy *list,
2159                    const struct in_addr *add)
2160 {
2161   unsigned int i;
2162
2163   if (NULL == list)
2164     return GNUNET_NO;
2165   i = 0;
2166   while ( (0 != list[i].network.s_addr) ||
2167           (0 != list[i].netmask.s_addr) )
2168   {
2169     if ((add->s_addr & list[i].netmask.s_addr) ==
2170         (list[i].network.s_addr & list[i].netmask.s_addr))
2171       return GNUNET_YES;
2172     i++;
2173   }
2174   return GNUNET_NO;
2175 }
2176
2177
2178 /**
2179  * Check if the given IP address is in the list of IP addresses.
2180  *
2181  * @param list a list of networks
2182  * @param ip the IP to check (in network byte order)
2183  * @return #GNUNET_NO if the IP is not in the list, #GNUNET_YES if it it is
2184  */
2185 static int
2186 check_ipv6_listed (const struct GNUNET_STRINGS_IPv6NetworkPolicy *list,
2187                    const struct in6_addr *ip)
2188 {
2189   unsigned int i;
2190   unsigned int j;
2191   struct in6_addr zero;
2192
2193   if (NULL == list)
2194     return GNUNET_NO;
2195   memset (&zero,
2196           0,
2197           sizeof (struct in6_addr));
2198   i = 0;
2199 NEXT:
2200   while (0 != memcmp (&zero,
2201                       &list[i].network,
2202                       sizeof (struct in6_addr)))
2203   {
2204     for (j = 0; j < sizeof (struct in6_addr) / sizeof (int); j++)
2205       if (((((int *) ip)[j] & ((int *) &list[i].netmask)[j])) !=
2206           (((int *) &list[i].network)[j] & ((int *) &list[i].netmask)[j]))
2207       {
2208         i++;
2209         goto NEXT;
2210       }
2211     return GNUNET_YES;
2212   }
2213   return GNUNET_NO;
2214 }
2215
2216
2217 /**
2218  * We have a client. Accept the incoming socket(s) (and reschedule
2219  * the listen task).
2220  *
2221  * @param cls the `struct ServiceListenContext` of the ready listen socket
2222  */
2223 static void
2224 accept_client (void *cls)
2225 {
2226   struct ServiceListenContext *slc = cls;
2227   struct GNUNET_SERVICE_Handle *sh = slc->sh;
2228
2229   slc->listen_task = NULL;
2230   while (1)
2231   {
2232     struct GNUNET_NETWORK_Handle *sock;
2233     const struct sockaddr_in *v4;
2234     const struct sockaddr_in6 *v6;
2235     struct sockaddr_storage sa;
2236     socklen_t addrlen;
2237     int ok;
2238
2239     addrlen = sizeof (sa);
2240     sock = GNUNET_NETWORK_socket_accept (slc->listen_socket,
2241                                          (struct sockaddr *) &sa,
2242                                          &addrlen);
2243     if (NULL == sock)
2244       break;
2245     switch (sa.ss_family)
2246     {
2247     case AF_INET:
2248       GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
2249       v4 = (const struct sockaddr_in *) &sa;
2250       ok = ( ( (NULL == sh->v4_allowed) ||
2251                (check_ipv4_listed (sh->v4_allowed,
2252                                    &v4->sin_addr))) &&
2253              ( (NULL == sh->v4_denied) ||
2254                (! check_ipv4_listed (sh->v4_denied,
2255                                      &v4->sin_addr)) ) );
2256       break;
2257     case AF_INET6:
2258       GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
2259       v6 = (const struct sockaddr_in6 *) &sa;
2260       ok = ( ( (NULL == sh->v6_allowed) ||
2261                (check_ipv6_listed (sh->v6_allowed,
2262                                    &v6->sin6_addr))) &&
2263              ( (NULL == sh->v6_denied) ||
2264                (! check_ipv6_listed (sh->v6_denied,
2265                                      &v6->sin6_addr)) ) );
2266       break;
2267 #ifndef WINDOWS
2268     case AF_UNIX:
2269       ok = GNUNET_OK;            /* controlled using file-system ACL now */
2270       break;
2271 #endif
2272     default:
2273       LOG (GNUNET_ERROR_TYPE_WARNING,
2274            _("Unknown address family %d\n"),
2275            sa.ss_family);
2276       return;
2277     }
2278     if (! ok)
2279     {
2280       LOG (GNUNET_ERROR_TYPE_DEBUG,
2281            "Service rejected incoming connection from %s due to policy.\n",
2282            GNUNET_a2s ((const struct sockaddr *) &sa,
2283                        addrlen));
2284       GNUNET_break (GNUNET_OK ==
2285                     GNUNET_NETWORK_socket_close (sock));
2286       continue;
2287     }
2288     LOG (GNUNET_ERROR_TYPE_DEBUG,
2289          "Service accepted incoming connection from %s.\n",
2290          GNUNET_a2s ((const struct sockaddr *) &sa,
2291                      addrlen));
2292     start_client (slc->sh,
2293                   sock);
2294   }
2295   slc->listen_task
2296     = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2297                                      slc->listen_socket,
2298                                      &accept_client,
2299                                      slc);
2300 }
2301
2302
2303 /**
2304  * Resume accepting connections from the listen socket.
2305  *
2306  * @param sh service to resume accepting connections.
2307  */
2308 void
2309 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh)
2310 {
2311   struct ServiceListenContext *slc;
2312
2313   for (slc = sh->slc_head; NULL != slc; slc = slc->next)
2314   {
2315     GNUNET_assert (NULL == slc->listen_task);
2316     slc->listen_task
2317       = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2318                                        slc->listen_socket,
2319                                        &accept_client,
2320                                        slc);
2321   }
2322 }
2323
2324
2325 /**
2326  * Task run to resume receiving data from the client after
2327  * the client called #GNUNET_SERVICE_client_continue().
2328  *
2329  * @param cls our `struct GNUNET_SERVICE_Client`
2330  */
2331 static void
2332 resume_client_receive (void *cls)
2333 {
2334   struct GNUNET_SERVICE_Client *c = cls;
2335   int ret;
2336
2337   c->recv_task = NULL;
2338   /* first, check if there is still something in the buffer */
2339   ret = GNUNET_MST_next (c->mst,
2340                          GNUNET_YES);
2341   if (GNUNET_SYSERR == ret)
2342   {
2343     GNUNET_break (0);
2344     GNUNET_SERVICE_client_drop (c);
2345     return;
2346   }
2347   if (GNUNET_NO == ret)
2348     return; /* done processing, wait for more later */
2349   GNUNET_assert (GNUNET_OK == ret);
2350   if (GNUNET_YES == c->needs_continue)
2351     return; /* #GNUNET_MST_next() did give a message to the client */
2352   /* need to receive more data from the network first */
2353   if (NULL != c->recv_task)
2354     return;
2355   c->recv_task
2356     = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2357                                      c->sock,
2358                                      &service_client_recv,
2359                                      c);
2360 }
2361
2362
2363 /**
2364  * Continue receiving further messages from the given client.
2365  * Must be called after each message received.
2366  *
2367  * @param c the client to continue receiving from
2368  */
2369 void
2370 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c)
2371 {
2372   GNUNET_assert (GNUNET_YES == c->needs_continue);
2373   GNUNET_assert (NULL == c->recv_task);
2374   c->needs_continue = GNUNET_NO;
2375   if (NULL != c->warn_task)
2376   {
2377     GNUNET_SCHEDULER_cancel (c->warn_task);
2378     c->warn_task = NULL;
2379   }
2380   c->recv_task
2381     = GNUNET_SCHEDULER_add_now (&resume_client_receive,
2382                                 c);
2383 }
2384
2385
2386 /**
2387  * Disable the warning the server issues if a message is not
2388  * acknowledged in a timely fashion.  Use this call if a client is
2389  * intentionally delayed for a while.  Only applies to the current
2390  * message.
2391  *
2392  * @param c client for which to disable the warning
2393  */
2394 void
2395 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c)
2396 {
2397   GNUNET_break (NULL != c->warn_task);
2398   if (NULL != c->warn_task)
2399   {
2400     GNUNET_SCHEDULER_cancel (c->warn_task);
2401     c->warn_task = NULL;
2402   }
2403 }
2404
2405
2406 /**
2407  * Asynchronously finish dropping the client.
2408  *
2409  * @param cls the `struct GNUNET_SERVICE_Client`.
2410  */
2411 static void
2412 finish_client_drop (void *cls)
2413 {
2414   struct GNUNET_SERVICE_Client *c = cls;
2415   struct GNUNET_SERVICE_Handle *sh = c->sh;
2416
2417   GNUNET_MST_destroy (c->mst);
2418   GNUNET_MQ_destroy (c->mq);
2419   if (GNUNET_NO == c->persist)
2420   {
2421     GNUNET_break (GNUNET_OK ==
2422                   GNUNET_NETWORK_socket_close (c->sock));
2423   }
2424   else
2425   {
2426     GNUNET_NETWORK_socket_free_memory_only_ (c->sock);
2427   }
2428   GNUNET_free (c);
2429   if ( (GNUNET_YES == sh->got_shutdown) &&
2430        (GNUNET_NO == have_non_monitor_clients (sh)) )
2431     GNUNET_SERVICE_shutdown (sh);
2432 }
2433
2434
2435 /**
2436  * Ask the server to disconnect from the given client.  This is the
2437  * same as returning #GNUNET_SYSERR within the check procedure when
2438  * handling a message, wexcept that it allows dropping of a client even
2439  * when not handling a message from that client.  The `disconnect_cb`
2440  * will be called on @a c even if the application closes the connection
2441  * using this function.
2442  *
2443  * @param c client to disconnect now
2444  */
2445 void
2446 GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c)
2447 {
2448   struct GNUNET_SERVICE_Handle *sh = c->sh;
2449
2450   if (NULL != c->drop_task)
2451   {
2452     /* asked to drop twice! */
2453     GNUNET_break (0);
2454     return;
2455   }
2456   GNUNET_CONTAINER_DLL_remove (sh->clients_head,
2457                                sh->clients_tail,
2458                                c);
2459   sh->disconnect_cb (sh->cb_cls,
2460                      c,
2461                      c->user_context);
2462   if (NULL != c->warn_task)
2463   {
2464     GNUNET_SCHEDULER_cancel (c->warn_task);
2465     c->warn_task = NULL;
2466   }
2467   if (NULL != c->recv_task)
2468   {
2469     GNUNET_SCHEDULER_cancel (c->recv_task);
2470     c->recv_task = NULL;
2471   }
2472   if (NULL != c->send_task)
2473   {
2474     GNUNET_SCHEDULER_cancel (c->send_task);
2475     c->send_task = NULL;
2476   }
2477   c->drop_task = GNUNET_SCHEDULER_add_now (&finish_client_drop,
2478                                            c);
2479 }
2480
2481
2482 /**
2483  * Explicitly stops the service.
2484  *
2485  * @param sh server to shutdown
2486  */
2487 void
2488 GNUNET_SERVICE_shutdown (struct GNUNET_SERVICE_Handle *sh)
2489 {
2490   struct GNUNET_SERVICE_Client *client;
2491
2492   GNUNET_SERVICE_suspend (sh);
2493   sh->got_shutdown = GNUNET_NO;
2494   while (NULL != (client = sh->clients_head))
2495     GNUNET_SERVICE_client_drop (client);
2496 }
2497
2498
2499 /**
2500  * Set the 'monitor' flag on this client.  Clients which have been
2501  * marked as 'monitors' won't prevent the server from shutting down
2502  * once #GNUNET_SERVICE_stop_listening() has been invoked.  The idea is
2503  * that for "normal" clients we likely want to allow them to process
2504  * their requests; however, monitor-clients are likely to 'never'
2505  * disconnect during shutdown and thus will not be considered when
2506  * determining if the server should continue to exist after
2507  * shutdown has been triggered.
2508  *
2509  * @param c client to mark as a monitor
2510  */
2511 void
2512 GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c)
2513 {
2514   c->is_monitor = GNUNET_YES;
2515   if ( (GNUNET_YES == c->sh->got_shutdown) &&
2516        (GNUNET_NO == have_non_monitor_clients (c->sh)) )
2517     GNUNET_SERVICE_shutdown (c->sh);
2518 }
2519
2520
2521 /**
2522  * Set the persist option on this client.  Indicates that the
2523  * underlying socket or fd should never really be closed.  Used for
2524  * indicating process death.
2525  *
2526  * @param c client to persist the socket (never to be closed)
2527  */
2528 void
2529 GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c)
2530 {
2531   c->persist = GNUNET_YES;
2532 }
2533
2534
2535 /**
2536  * Obtain the message queue of @a c.  Convenience function.
2537  *
2538  * @param c the client to continue receiving from
2539  * @return the message queue of @a c
2540  */
2541 struct GNUNET_MQ_Handle *
2542 GNUNET_SERVICE_client_get_mq (struct GNUNET_SERVICE_Client *c)
2543 {
2544   return c->mq;
2545 }
2546
2547
2548 /* end of service_new.c */