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  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_resolver_service.h"
  31
  32
  33 /**
  34  * Handle to a service.
  35  */
  36 struct GNUNET_SERVICE_Handle
  37 {
  38   /**
  39    * Our configuration.
  40    */
  41   const struct GNUNET_CONFIGURATION_Handle *cfg;
  42
  43   /**
  44    * Name of our service.
  45    */
  46   const char *service_name;
  47
  48   /**
  49    * Main service-specific task to run.
  50    */
  51   GNUNET_SERVICE_Main task;
  52
  53   /**
  54    * Closure for @e task.
  55    */
  56   void *task_cls;
  57
  58   /**
  59    * IPv4 addresses that are not allowed to connect.
  60    */
  61   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_denied;
  62
  63   /**
  64    * IPv6 addresses that are not allowed to connect.
  65    */
  66   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_denied;
  67
  68   /**
  69    * IPv4 addresses that are allowed to connect (if not
  70    * set, all are allowed).
  71    */
  72   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_allowed;
  73
  74   /**
  75    * IPv6 addresses that are allowed to connect (if not
  76    * set, all are allowed).
  77    */
  78   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_allowed;
  79
  80   /**
  81    * Do we require a matching UID for UNIX domain socket connections?
  82    * #GNUNET_NO means that the UID does not have to match (however,
  83    * @e match_gid may still impose other access control checks).
  84    */
  85   int match_uid;
  86
  87   /**
  88    * Do we require a matching GID for UNIX domain socket connections?
  89    * Ignored if @e match_uid is #GNUNET_YES.  Note that this is about
  90    * checking that the client's UID is in our group OR that the
  91    * client's GID is our GID.  If both "match_gid" and @e match_uid are
  92    * #GNUNET_NO, all users on the local system have access.
  93    */
  94   int match_gid;
  95
  96   /**
  97    * Our options.
  98    */
  99   enum GNUNET_SERVICE_Options options;
 100
 101 };
 102
 103
 104 /**
 105  * Handle to a client that is connected to a service.
 106  */
 107 struct GNUNET_SERVICE_Client
 108 {
 109
 110   /**
 111    * Server that this client belongs to.
 112    */
 113   struct GNUNET_SERVER_Handle *server;
 114
 115   /**
 116    * Task that warns about missing calls to
 117    * #GNUNET_SERVICE_client_continue().
 118    */
 119   struct GNUNET_SCHEDULER_Task *warn_task;
 120
 121   /**
 122    * User context value, value returned from
 123    * the connect callback.
 124    */
 125   void *user_context;
 126
 127   /**
 128    * Persist the file handle for this client no matter what happens,
 129    * force the OS to close once the process actually dies.  Should only
 130    * be used in special cases!
 131    */
 132   int persist;
 133
 134   /**
 135    * Is this client a 'monitor' client that should not be counted
 136    * when deciding on destroying the server during soft shutdown?
 137    * (see also #GNUNET_SERVICE_start)
 138    */
 139   int is_monitor;
 140
 141   /**
 142    * Type of last message processed (for warn_no_receive_done).
 143    */
 144   uint16_t warn_type;
 145 };
 146
 147
 148 /**
 149  * Creates the "main" function for a GNUnet service.  You
 150  * should almost always use the #GNUNET_SERVICE_MAIN macro
 151  * instead of calling this function directly (except
 152  * for ARM, which should call this function directly).
 153  *
 154  * The function will launch the service with the name @a service_name
 155  * using the @a service_options to configure its shutdown
 156  * behavior. Once the service is ready, the @a init_cb will be called
 157  * for service-specific initialization.  @a init_cb will be given the
 158  * service handler which can be used to control the service's
 159  * availability.  When clients connect or disconnect, the respective
 160  * @a connect_cb or @a disconnect_cb functions will be called. For
 161  * messages received from the clients, the respective @a handlers will
 162  * be invoked; for the closure of the handlers we use the return value
 163  * from the @a connect_cb invocation of the respective client.
 164  *
 165  * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
 166  * message to receive further messages from this client.  If
 167  * #GNUNET_SERVICE_client_continue() is not called within a short
 168  * time, a warning will be logged. If delays are expected, services
 169  * should call #GNUNET_SERVICE_client_disable_continue_warning() to
 170  * disable the warning.
 171  *
 172  * Clients sending invalid messages (based on @a handlers) will be
 173  * dropped. Additionally, clients can be dropped at any time using
 174  * #GNUNET_SERVICE_client_drop().
 175  *
 176  * @param argc number of command-line arguments in @a argv
 177  * @param argv array of command-line arguments
 178  * @param service_name name of the service to run
 179  * @param options options controlling shutdown of the service
 180  * @param service_init_cb function to call once the service is ready
 181  * @param connect_cb function to call whenever a client connects
 182  * @param disconnect_cb function to call whenever a client disconnects
 183  * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
 184  * @param handlers NULL-terminated array of message handlers for the service,
 185  *                 the closure will be set to the value returned by
 186  *                 the @a connect_cb for the respective connection
 187  * @return 0 on success, non-zero on error
 188  */
 189 int
 190 GNUNET_SERVICE_ruN_ (int argc,
 191                      char *const *argv,
 192                      const char *service_name,
 193                      enum GNUNET_SERVICE_Options options,
 194                      GNUNET_SERVICE_InitCallback service_init_cb,
 195                      GNUNET_SERVICE_ConnectHandler connect_cb,
 196                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
 197                      void *cls,
 198                      const struct GNUNET_MQ_MessageHandler *handlers)
 199 {
 200   GNUNET_break (0); // not implemented
 201   return 1;
 202 }
 203
 204
 205 /**
 206  * Suspend accepting connections from the listen socket temporarily.
 207  * Resume activity using #GNUNET_SERVICE_resume.
 208  *
 209  * @param sh service to stop accepting connections.
 210  */
 211 void
 212 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh)
 213 {
 214   GNUNET_break (0); // not implemented
 215 }
 216
 217
 218 /**
 219  * Resume accepting connections from the listen socket.
 220  *
 221  * @param sh service to resume accepting connections.
 222  */
 223 void
 224 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh)
 225 {
 226   GNUNET_break (0); // not implemented
 227 }
 228
 229
 230 /**
 231  * Continue receiving further messages from the given client.
 232  * Must be called after each message received.
 233  *
 234  * @param c the client to continue receiving from
 235  */
 236 void
 237 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c)
 238 {
 239   GNUNET_break (0); // not implemented
 240 }
 241
 242
 243 /**
 244  * Disable the warning the server issues if a message is not
 245  * acknowledged in a timely fashion.  Use this call if a client is
 246  * intentionally delayed for a while.  Only applies to the current
 247  * message.
 248  *
 249  * @param c client for which to disable the warning
 250  */
 251 void
 252 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c)
 253 {
 254   GNUNET_break (NULL != c->warn_task);
 255   if (NULL != c->warn_task)
 256   {
 257     GNUNET_SCHEDULER_cancel (c->warn_task);
 258     c->warn_task = NULL;
 259   }
 260 }
 261
 262
 263 /**
 264  * Ask the server to disconnect from the given client.  This is the
 265  * same as returning #GNUNET_SYSERR within the check procedure when
 266  * handling a message, wexcept that it allows dropping of a client even
 267  * when not handling a message from that client.  The `disconnect_cb`
 268  * will be called on @a c even if the application closes the connection
 269  * using this function.
 270  *
 271  * @param c client to disconnect now
 272  */
 273 void
 274 GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c)
 275 {
 276   GNUNET_break (0); // not implemented
 277 }
 278
 279
 280 /**
 281  * Stop the listen socket and get ready to shutdown the server once
 282  * only clients marked using #GNUNET_SERVER_client_mark_monitor are
 283  * left.
 284  *
 285  * @param sh server to stop listening on
 286  */
 287 void
 288 GNUNET_SERVICE_stop_listening (struct GNUNET_SERVICE_Handle *sh)
 289 {
 290   GNUNET_break (0); // not implemented
 291 }
 292
 293
 294 /**
 295  * Set the 'monitor' flag on this client.  Clients which have been
 296  * marked as 'monitors' won't prevent the server from shutting down
 297  * once #GNUNET_SERVICE_stop_listening() has been invoked.  The idea is
 298  * that for "normal" clients we likely want to allow them to process
 299  * their requests; however, monitor-clients are likely to 'never'
 300  * disconnect during shutdown and thus will not be considered when
 301  * determining if the server should continue to exist after
 302  * shutdown has been triggered.
 303  *
 304  * @param c client to mark as a monitor
 305  */
 306 void
 307 GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c)
 308 {
 309   GNUNET_break (0); // not implemented
 310 }
 311
 312
 313 /**
 314  * Set the persist option on this client.  Indicates that the
 315  * underlying socket or fd should never really be closed.  Used for
 316  * indicating process death.
 317  *
 318  * @param c client to persist the socket (never to be closed)
 319  */
 320 void
 321 GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c)
 322 {
 323   GNUNET_break (0); // not implemented
 324 }
 325
 326
 327
 328 /* end of service_new.c */