src/include/gnunet_core_service.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009-2014, 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  * @author Christian Grothoff
  22  *
  23  * @file include/gnunet_core_service.h
  24  * Core service; the main API for encrypted P2P communications
  25  *
  26  * @defgroup core  Core service
  27  * Encrypted direct communication between peers
  28  *
  29  * @see [Documentation](https://gnunet.org/gnunet-core-subsystem)
  30  *
  31  * @{
  32  */
  33 #ifndef GNUNET_CORE_SERVICE_H
  34 #define GNUNET_CORE_SERVICE_H
  35
  36 #ifdef __cplusplus
  37 extern "C"
  38 {
  39 #if 0                           /* keep Emacsens' auto-indent happy */
  40 }
  41 #endif
  42 #endif
  43
  44 #include "gnunet_util_lib.h"
  45 #include "gnunet_transport_service.h"
  46
  47 /**
  48  * Version number of GNUnet-core API.
  49  */
  50 #define GNUNET_CORE_VERSION 0x00000001
  51
  52 /**
  53  * Traffic priorities.
  54  */
  55 enum GNUNET_CORE_Priority
  56 {
  57
  58   /**
  59    * Lowest priority, i.e. background traffic (i.e. fs)
  60    */
  61   GNUNET_CORE_PRIO_BACKGROUND = 0,
  62
  63   /**
  64    * Normal traffic (i.e. cadet/dv relay, DHT)
  65    */
  66   GNUNET_CORE_PRIO_BEST_EFFORT = 1,
  67
  68   /**
  69    * Urgent traffic (local peer, i.e. conversation).
  70    */
  71   GNUNET_CORE_PRIO_URGENT = 2,
  72
  73   /**
  74    * Highest priority, control traffic (i.e. NSE, Core/Cadet KX).
  75    */
  76   GNUNET_CORE_PRIO_CRITICAL_CONTROL = 3
  77
  78
  79 };
  80
  81
  82 /**
  83  * Opaque handle to the service.
  84  */
  85 struct GNUNET_CORE_Handle;
  86
  87
  88 /**
  89  * Method called whenever a given peer connects.
  90  *
  91  * @param cls closure
  92  * @param peer peer identity this notification is about
  93  */
  94 typedef void *
  95 (*GNUNET_CORE_ConnectEventHandler) (void *cls,
  96                                     const struct GNUNET_PeerIdentity *peer,
  97                                     struct GNUNET_MQ_Handle *mq);
  98
  99
 100 /**
 101  * Method called whenever a peer disconnects.
 102  *
 103  * @param cls closure
 104  * @param peer peer identity this notification is about
 105  */
 106 typedef void
 107 (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
 108                                        const struct GNUNET_PeerIdentity *peer,
 109                                        void *peer_cls);
 110
 111
 112 /**
 113  * Function called after #GNUNET_CORE_connect has succeeded (or failed
 114  * for good).  Note that the private key of the peer is intentionally
 115  * not exposed here; if you need it, your process should try to read
 116  * the private key file directly (which should work if you are
 117  * authorized...).  Implementations of this function must not call
 118  * #GNUNET_CORE_disconnect (other than by scheduling a new task to
 119  * do this later).
 120  *
 121  * @param cls closure
 122  * @param my_identity ID of this peer, NULL if we failed
 123  */
 124 typedef void
 125 (*GNUNET_CORE_StartupCallback) (void *cls,
 126                                 const struct GNUNET_PeerIdentity *my_identity);
 127
 128
 129 /**
 130  * Connect to the core service.  Note that the connection may complete
 131  * (or fail) asynchronously.  This function primarily causes the given
 132  * callback notification functions to be invoked whenever the
 133  * specified event happens.  The maximum number of queued
 134  * notifications (queue length) is per client; the queue is shared
 135  * across all types of notifications.  So a slow client that registers
 136  * for @a outbound_notify also risks missing @a inbound_notify messages.
 137  * Certain events (such as connect/disconnect notifications) are not
 138  * subject to queue size limitations.
 139  *
 140  * @param cfg configuration to use
 141  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
 142  * @param init callback to call once we have successfully
 143  *        connected to the core service
 144  * @param connects function to call on peer connect, can be NULL
 145  * @param disconnects function to call on peer disconnect / timeout, can be NULL
 146  * @param handlers callbacks for messages we care about, NULL-terminated
 147  *                note that the core is allowed to drop notifications about inbound
 148  *                messages if the client does not process them fast enough (for this
 149  *                notification type, a bounded queue is used)
 150  * @return handle to the core service (only useful for disconnect until @a init is called),
 151  *           NULL on error (in this case, init is never called)
 152  */
 153 struct GNUNET_CORE_Handle *
 154 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 155                      void *cls,
 156                      GNUNET_CORE_StartupCallback init,
 157                      GNUNET_CORE_ConnectEventHandler connects,
 158                      GNUNET_CORE_DisconnectEventHandler disconnects,
 159                      const struct GNUNET_MQ_MessageHandler *handlers);
 160
 161
 162 /**
 163  * Disconnect from the core service.
 164  *
 165  * @param handle connection to core to disconnect
 166  */
 167 void
 168 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
 169
 170
 171 /**
 172  * Inquire with CORE what options should be set for a message
 173  * so that it is transmitted with the given @a priority and
 174  * the given @a cork value.
 175  *
 176  * @param cork desired corking
 177  * @param priority desired message priority
 178  * @param[out] flags set to `flags` value for #GNUNET_MQ_set_options()
 179  * @return `extra` argument to give to #GNUNET_MQ_set_options()
 180  */
 181 const void *
 182 GNUNET_CORE_get_mq_options (int cork,
 183                             enum GNUNET_CORE_Priority priority,
 184                             uint64_t *flags);
 185
 186
 187 /**
 188  * Obtain the message queue for a connected peer.
 189  *
 190  * @param h the core handle
 191  * @param pid the identity of the peer
 192  * @return NULL if @a pid is not connected
 193  */
 194 struct GNUNET_MQ_Handle *
 195 GNUNET_CORE_get_mq (const struct GNUNET_CORE_Handle *h,
 196                     const struct GNUNET_PeerIdentity *pid);
 197
 198
 199 /**
 200  * Handle for a transmission request.
 201  */
 202 struct GNUNET_CORE_TransmitHandle;
 203
 204
 205 /**
 206  * Ask the core to call @a notify once it is ready to transmit the
 207  * given number of bytes to the specified @a target.  Must only be
 208  * called after a connection to the respective peer has been
 209  * established (and the client has been informed about this).  You may
 210  * have one request of this type pending for each connected peer at
 211  * any time.  If a peer disconnects, the application MUST call
 212  * #GNUNET_CORE_notify_transmit_ready_cancel() on the respective
 213  * transmission request, if one such request is pending.
 214  *
 215  * @param handle connection to core service
 216  * @param cork is corking allowed for this transmission?
 217  * @param priority how important is the message?
 218  * @param maxdelay how long can the message wait? Only effective if @a cork is #GNUNET_YES
 219  * @param target who should receive the message, never NULL (can be this peer's identity for loopback)
 220  * @param notify_size how many bytes of buffer space does @a notify want?
 221  * @param notify function to call when buffer space is available;
 222  *        will be called with NULL on timeout; clients MUST cancel
 223  *        all pending transmission requests DURING the disconnect
 224  *        handler
 225  * @param notify_cls closure for @a notify
 226  * @return non-NULL if the notify callback was queued,
 227  *         NULL if we can not even queue the request (request already pending);
 228  *         if NULL is returned, @a notify will NOT be called.
 229  */
 230 struct GNUNET_CORE_TransmitHandle *
 231 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
 232                                    int cork,
 233                                    enum GNUNET_CORE_Priority priority,
 234                                    struct GNUNET_TIME_Relative maxdelay,
 235                                    const struct GNUNET_PeerIdentity *target,
 236                                    size_t notify_size,
 237                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 238                                    void *notify_cls);
 239
 240
 241 /**
 242  * Cancel the specified transmission-ready notification.
 243  *
 244  * @param th handle that was returned by #GNUNET_CORE_notify_transmit_ready().
 245  */
 246 void
 247 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle *th);
 248
 249
 250 /**
 251  * Handle to a CORE monitoring operation.
 252  */
 253 struct GNUNET_CORE_MonitorHandle;
 254
 255
 256 /**
 257  * State machine for our P2P encryption handshake.  Everyone starts in
 258  * #GNUNET_CORE_KX_STATE_DOWN, if we receive the other peer's key
 259  * (other peer initiated) we start in state
 260  * #GNUNET_CORE_KX_STATE_KEY_RECEIVED (since we will immediately send
 261  * our own); otherwise we start in #GNUNET_CORE_KX_STATE_KEY_SENT.  If
 262  * we get back a PONG from within either state, we move up to
 263  * #GNUNET_CORE_KX_STATE_UP (the PONG will always be sent back
 264  * encrypted with the key we sent to the other peer).  Eventually,
 265  * we will try to rekey, for this we will enter
 266  * #GNUNET_CORE_KX_STATE_REKEY_SENT until the rekey operation is
 267  * confirmed by a PONG from the other peer.
 268  */
 269 enum GNUNET_CORE_KxState
 270 {
 271   /**
 272    * No handshake yet.
 273    */
 274   GNUNET_CORE_KX_STATE_DOWN,
 275
 276   /**
 277    * We've sent our session key.
 278    */
 279   GNUNET_CORE_KX_STATE_KEY_SENT,
 280
 281   /**
 282    * We've received the other peers session key.
 283    */
 284   GNUNET_CORE_KX_STATE_KEY_RECEIVED,
 285
 286   /**
 287    * The other peer has confirmed our session key + PING with a PONG
 288    * message encrypted with his session key (which we got).  Key
 289    * exchange is done.
 290    */
 291   GNUNET_CORE_KX_STATE_UP,
 292
 293   /**
 294    * We're rekeying (or had a timeout), so we have sent the other peer
 295    * our new ephemeral key, but we did not get a matching PONG yet.
 296    * This is equivalent to being #GNUNET_CORE_KX_STATE_KEY_RECEIVED,
 297    * except that the session is marked as 'up' with sessions (as we
 298    * don't want to drop and re-establish P2P connections simply due to
 299    * rekeying).
 300    */
 301   GNUNET_CORE_KX_STATE_REKEY_SENT,
 302
 303   /**
 304    * Last state of a KX (when it is being terminated).  Set
 305    * just before CORE frees the internal state for this peer.
 306    */
 307   GNUNET_CORE_KX_PEER_DISCONNECT,
 308
 309   /**
 310    * This is not a state in a peer's state machine, but a special
 311    * value used with the #GNUNET_CORE_MonitorCallback to indicate
 312    * that we finished the initial iteration over the peers.
 313    */
 314   GNUNET_CORE_KX_ITERATION_FINISHED,
 315
 316   /**
 317    * This is not a state in a peer's state machine, but a special
 318    * value used with the #GNUNET_CORE_MonitorCallback to indicate
 319    * that we lost the connection to the CORE service (and will try
 320    * to reconnect).  If this happens, most likely the CORE service
 321    * crashed and thus all connection state should be assumed lost.
 322    */
 323   GNUNET_CORE_KX_CORE_DISCONNECT
 324
 325 };
 326
 327
 328 /**
 329  * Function called by the monitor callback whenever
 330  * a peer's connection status changes.
 331  *
 332  * @param cls closure
 333  * @param pid identity of the peer this update is about
 334  * @param state current key exchange state of the peer
 335  * @param timeout when does the current state expire
 336  */
 337 typedef void
 338 (*GNUNET_CORE_MonitorCallback)(void *cls,
 339                                const struct GNUNET_PeerIdentity *pid,
 340                                enum GNUNET_CORE_KxState state,
 341                                struct GNUNET_TIME_Absolute timeout);
 342
 343
 344 /**
 345  * Monitor connectivity and KX status of all peers known to CORE.
 346  * Calls @a peer_cb with the current status for each connected peer,
 347  * and then once with NULL to indicate that all peers that are
 348  * currently active have been handled.  After that, the iteration
 349  * continues until it is cancelled.  Normal users of the CORE API are
 350  * not expected to use this function.  It is different in that it
 351  * truly lists all connections (including those where the KX is in
 352  * progress), not just those relevant to the application.  This
 353  * function is used by special applications for diagnostics.
 354  *
 355  * @param cfg configuration handle
 356  * @param peer_cb function to call with the peer information
 357  * @param peer_cb_cls closure for @a peer_cb
 358  * @return NULL on error
 359  */
 360 struct GNUNET_CORE_MonitorHandle *
 361 GNUNET_CORE_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 362                            GNUNET_CORE_MonitorCallback peer_cb,
 363                            void *peer_cb_cls);
 364
 365
 366 /**
 367  * Stop monitoring CORE activity.
 368  *
 369  * @param mh monitor to stop
 370  */
 371 void
 372 GNUNET_CORE_monitor_stop (struct GNUNET_CORE_MonitorHandle *mh);
 373
 374
 375 /**
 376  * Check if the given peer is currently connected. This function is for special
 377  * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
 378  * expected to track which peers are connected based on the connect/disconnect
 379  * callbacks from #GNUNET_CORE_connect.  This function is NOT part of the
 380  * 'versioned', 'official' API.  This function returns
 381  * synchronously after looking in the CORE API cache.
 382  *
 383  * @param h the core handle
 384  * @param pid the identity of the peer to check if it has been connected to us
 385  * @return #GNUNET_YES if the peer is connected to us; #GNUNET_NO if not
 386  */
 387 int
 388 GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,
 389                                     const struct GNUNET_PeerIdentity *pid);
 390
 391
 392 /**
 393  * Create a message queue for sending messages to a peer with CORE.
 394  * Messages may only be queued with #GNUNET_MQ_send once the init callback has
 395  * been called for the given handle.
 396  * There must only be one queue per peer for each core handle.
 397  * The message queue can only be used to transmit messages,
 398  * not to receive them.
 399  *
 400  * @param h the core handle
 401  * @param target the target peer for this queue, may not be NULL
 402  * @return a message queue for sending messages over the core handle
 403  *         to the target peer
 404  */
 405 struct GNUNET_MQ_Handle *
 406 GNUNET_CORE_mq_create (struct GNUNET_CORE_Handle *h,
 407                        const struct GNUNET_PeerIdentity *target);
 408
 409
 410 #if 0                           /* keep Emacsens' auto-indent happy */
 411 {
 412 #endif
 413 #ifdef __cplusplus
 414 }
 415 #endif
 416
 417 /* ifndef GNUNET_CORE_SERVICE_H */
 418 #endif
 419
 420 /** @} */  /* end of group core */
 421
 422 /* end of gnunet_core_service.h */