src/include/gnunet_transport_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_transport_plugin.h
  23  * @brief API for the transport services.  This header
  24  *        specifies the struct that is given to the plugin's entry
  25  *        method and the other struct that must be returned.
  26  *        Note that the destructors of transport plugins will
  27  *        be given the value returned by the constructor
  28  *        and is expected to return a NULL pointer.
  29  * @author Christian Grothoff
  30  */
  31 #ifndef PLUGIN_TRANSPORT_H
  32 #define PLUGIN_TRANSPORT_H
  33
  34 #include "gnunet_configuration_lib.h"
  35 #include "gnunet_scheduler_lib.h"
  36 #include "gnunet_statistics_service.h"
  37 #include "gnunet_transport_service.h"
  38
  39 /**
  40  * Opaque pointer that plugins can use to distinguish specific
  41  * connections to a given peer.  Typically used by stateful plugins to
  42  * allow the service to refer to specific streams instead of a more
  43  * general notion of "some connection" to the given peer.  This is
  44  * useful since sometimes (i.e. for inbound TCP connections) a
  45  * connection may not have an address that can be used for meaningful
  46  * distinction between sessions to the same peer.
  47  *
  48  * Each 'struct Session' MUST start with the 'struct GNUNET_PeerIdentity'
  49  * of the peer the session is for (which will be used for some error
  50  * checking by the ATS code).
  51  */
  52 struct Session;
  53
  54 /**
  55  * Every 'struct Session' must begin with this header.
  56  */
  57 struct SessionHeader
  58 {
  59
  60   /**
  61    * Cached signature for PONG generation for the session.  Do not use
  62    * in the plugin!
  63    */
  64   struct GNUNET_CRYPTO_RsaSignature pong_signature;
  65
  66   /**
  67    * Expiration time for signature.  Do not use in the plugin!
  68    */
  69   struct GNUNET_TIME_Absolute pong_sig_expires;
  70
  71 };
  72
  73 /**
  74  * Function that will be called whenever the plugin internally
  75  * cleans up a session pointer and hence the service needs to
  76  * discard all of those sessions as well.  Plugins that do not
  77  * use sessions can simply omit calling this function and always
  78  * use NULL wherever a session pointer is needed.  This function
  79  * should be called BEFORE a potential "TransmitContinuation"
  80  * from the "TransmitFunction".
  81  *
  82  * @param cls closure
  83  * @param peer which peer was the session for
  84  * @param session which session is being destoyed
  85  */
  86 typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
  87                                              const struct GNUNET_PeerIdentity *
  88                                              peer, struct Session * session);
  89
  90
  91 /**
  92  * Function called by the transport for each received message.
  93  * This function should also be called with "NULL" for the
  94  * message to signal that the other peer disconnected.
  95  *
  96  * @param cls closure
  97  * @param peer (claimed) identity of the other peer
  98  * @param message the message, NULL if we only care about
  99  *                learning about the delay until we should receive again
 100  * @param session identifier used for this session (NULL for plugins
 101  *                that do not offer bi-directional communication to the sender
 102  *                using the same "connection")
 103  * @param sender_address binary address of the sender (if we established the
 104  *                connection or are otherwise sure of it; should be NULL
 105  *                for inbound TCP/UDP connections since it it not clear
 106  *                that we could establish ourselves a connection to that
 107  *                IP address and get the same system)
 108  * @param sender_address_len number of bytes in sender_address
 109  * @return how long the plugin should wait until receiving more data
 110  *         (plugins that do not support this, can ignore the return value)
 111  */
 112 typedef struct
 113     GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
 114                                                                     const struct
 115                                                                     GNUNET_PeerIdentity
 116                                                                     * peer,
 117                                                                     const struct
 118                                                                     GNUNET_MessageHeader
 119                                                                     * message,
 120                                                                     const struct
 121                                                                     GNUNET_ATS_Information
 122                                                                     * ats,
 123                                                                     uint32_t
 124                                                                     ats_count,
 125                                                                     struct
 126                                                                     Session *
 127                                                                     session,
 128                                                                     const char
 129                                                                     *sender_address,
 130                                                                     uint16_t
 131                                                                     sender_address_len);
 132
 133
 134 /**
 135  * Function that will be called to figure if an address is an loopback,
 136  * LAN, WAN etc. address
 137  *
 138  * @param cls closure
 139  * @param addr binary address
 140  * @param addrlen length of the address
 141  * @return ATS Information containing the network type
 142  */
 143 typedef struct GNUNET_ATS_Information
 144 (*GNUNET_TRANSPORT_AddressToType) (void *cls,
 145                                    const struct sockaddr *addr,
 146                                    size_t addrlen);
 147
 148 /**
 149  * Function that will be called for each address the transport
 150  * is aware that it might be reachable under.
 151  *
 152  * @param cls closure
 153  * @param add_remove should the address added (YES) or removed (NO) from the
 154  *                   set of valid addresses?
 155  * @param addr one of the addresses of the host
 156  *        the specific address format depends on the transport
 157  * @param addrlen length of the address
 158  * @pararm pluginname name of the plugin
 159  */
 160 typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls, int add_remove,
 161                                                       const void *addr,
 162                                                       size_t addrlen,
 163                                                       const char *pluginname);
 164
 165
 166 /**
 167  * Function that will be called whenever the plugin receives data over
 168  * the network and wants to determine how long it should wait until
 169  * the next time it reads from the given peer.  Note that some plugins
 170  * (such as UDP) may not be able to wait (for a particular peer), so
 171  * the waiting part is optional.  Plugins that can wait should call
 172  * this function, sleep the given amount of time, and call it again
 173  * (with zero bytes read) UNTIL it returns zero and only then read.
 174  *
 175  * @param cls closure
 176  * @param peer which peer did we read data from
 177  * @param amount_recved number of bytes read (can be zero)
 178  * @return how long to wait until reading more from this peer
 179  *         (to enforce inbound quotas)
 180  */
 181 typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_TrafficReport) (void
 182                                                                        *cls,
 183                                                                        const
 184                                                                        struct
 185                                                                        GNUNET_PeerIdentity
 186                                                                        * peer,
 187                                                                        size_t
 188                                                                        amount_recved);
 189
 190
 191 /**
 192  * Function that returns a HELLO message.
 193  */
 194 typedef const struct GNUNET_MessageHeader *
 195     (*GNUNET_TRANSPORT_GetHelloCallback) (void);
 196
 197
 198 /**
 199  * The transport service will pass a pointer to a struct
 200  * of this type as the first and only argument to the
 201  * entry point of each transport plugin.
 202  */
 203 struct GNUNET_TRANSPORT_PluginEnvironment
 204 {
 205   /**
 206    * Configuration to use.
 207    */
 208   const struct GNUNET_CONFIGURATION_Handle *cfg;
 209
 210   /**
 211    * Identity of this peer.
 212    */
 213   const struct GNUNET_PeerIdentity *my_identity;
 214
 215   /**
 216    * Closure for the various callbacks.
 217    */
 218   void *cls;
 219
 220   /**
 221    * Handle for reporting statistics.
 222    */
 223   struct GNUNET_STATISTICS_Handle *stats;
 224
 225   /**
 226    * Function that should be called by the transport plugin
 227    * whenever a message is received.  If this field is "NULL",
 228    * the plugin should load in 'stub' mode and NOT fully
 229    * initialize and instead only return an API with the
 230    * 'address_pretty_printer', 'address_to_string' and
 231    * 'string_to_address' functions.
 232    */
 233   GNUNET_TRANSPORT_PluginReceiveCallback receive;
 234
 235
 236   /**
 237    * Function that returns our HELLO.
 238    */
 239   GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
 240
 241   /**
 242    * Function that must be called by each plugin to notify the
 243    * transport service about the addresses under which the transport
 244    * provided by the plugin can be reached.
 245    */
 246   GNUNET_TRANSPORT_AddressNotification notify_address;
 247
 248   /**
 249    * Function that must be called by the plugin when a non-NULL
 250    * session handle stops being valid (is destroyed).
 251    */
 252   GNUNET_TRANSPORT_SessionEnd session_end;
 253
 254   /**
 255    * Function that will be called to figure if an address is an loopback,
 256    * LAN, WAN etc. address
 257    */
 258   GNUNET_TRANSPORT_AddressToType get_address_type;
 259
 260
 261   /**
 262    * What is the maximum number of connections that this transport
 263    * should allow?  Transports that do not have sessions (such as
 264    * UDP) can ignore this value.
 265    */
 266   uint32_t max_connections;
 267
 268 };
 269
 270
 271 /**
 272  * Function called by the GNUNET_TRANSPORT_TransmitFunction
 273  * upon "completion".  In the case that a peer disconnects,
 274  * this function must be called for each pending request
 275  * (with a 'failure' indication) AFTER notifying the service
 276  * about the disconnect event (so that the service won't try
 277  * to transmit more messages, believing the connection still
 278  * exists...).
 279  *
 280  * @param cls closure
 281  * @param target who was the recipient of the message?
 282  * @param result GNUNET_OK on success
 283  *               GNUNET_SYSERR if the target disconnected;
 284  *               disconnect will ALSO be signalled using
 285  *               the ReceiveCallback.
 286  */
 287 typedef void (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
 288                                                        const struct
 289                                                        GNUNET_PeerIdentity *
 290                                                        target, int result);
 291
 292 /**
 293  * The new send function with just the session and no address
 294  *
 295  * Function that can be used by the transport service to transmit
 296  * a message using the plugin.   Note that in the case of a
 297  * peer disconnecting, the continuation MUST be called
 298  * prior to the disconnect notification itself.  This function
 299  * will be called with this peer's HELLO message to initiate
 300  * a fresh connection to another peer.
 301  *
 302  * @param cls closure
 303  * @param session which session must be used
 304  * @param msgbuf the message to transmit
 305  * @param msgbuf_size number of bytes in 'msgbuf'
 306  * @param priority how important is the message (most plugins will
 307  *                 ignore message priority and just FIFO)
 308  * @param timeout how long to wait at most for the transmission (does not
 309  *                require plugins to discard the message after the timeout,
 310  *                just advisory for the desired delay; most plugins will ignore
 311  *                this as well)
 312  * @param cont continuation to call once the message has
 313  *        been transmitted (or if the transport is ready
 314  *        for the next transmission call; or if the
 315  *        peer disconnected...); can be NULL
 316  * @param cont_cls closure for cont
 317  * @return number of bytes used (on the physical network, with overheads);
 318  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 319  *         and does NOT mean that the message was not transmitted (DV)
 320  */
 321 typedef ssize_t (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
 322                                                       struct Session *session,
 323                                                       const char *msgbuf, size_t msgbuf_size,
 324                                                       unsigned int priority,
 325                                                       struct GNUNET_TIME_Relative to,
 326                                                       GNUNET_TRANSPORT_TransmitContinuation cont,
 327                                                       void *cont_cls);
 328
 329
 330 /**
 331  * Function that can be called to force a disconnect from the
 332  * specified neighbour.  This should also cancel all previously
 333  * scheduled transmissions.  Obviously the transmission may have been
 334  * partially completed already, which is OK.  The plugin is supposed
 335  * to close the connection (if applicable) and no longer call the
 336  * transmit continuation(s).
 337  *
 338  * Finally, plugin MUST NOT call the services's receive function to
 339  * notify the service that the connection to the specified target was
 340  * closed after a getting this call.
 341  *
 342  * @param cls closure
 343  * @param target peer for which the last transmission is
 344  *        to be cancelled
 345  */
 346 typedef void (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
 347                                                      const struct
 348                                                      GNUNET_PeerIdentity *
 349                                                      target);
 350
 351
 352 /**
 353  * Function called by the pretty printer for the resolved address for
 354  * each human-readable address obtained.
 355  *
 356  * @param cls closure
 357  * @param hostname one of the names for the host, NULL
 358  *        on the last call to the callback
 359  */
 360 typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
 361                                                         const char *address);
 362
 363
 364 /**
 365  * Convert the transports address to a nice, human-readable
 366  * format.
 367  *
 368  * @param cls closure
 369  * @param name name of the transport that generated the address
 370  * @param addr one of the addresses of the host, NULL for the last address
 371  *        the specific address format depends on the transport
 372  * @param addrlen length of the address
 373  * @param numeric should (IP) addresses be displayed in numeric form?
 374  * @param timeout after how long should we give up?
 375  * @param asc function to call on each string
 376  * @param asc_cls closure for asc
 377  */
 378 typedef void (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
 379                                                        const char *type,
 380                                                        const void *addr,
 381                                                        size_t addrlen,
 382                                                        int numeric,
 383                                                        struct
 384                                                        GNUNET_TIME_Relative
 385                                                        timeout,
 386                                                        GNUNET_TRANSPORT_AddressStringCallback
 387                                                        asc, void *asc_cls);
 388
 389
 390 /**
 391  * Another peer has suggested an address for this peer and transport
 392  * plugin.  Check that this could be a valid address.  This function
 393  * is not expected to 'validate' the address in the sense of trying to
 394  * connect to it but simply to see if the binary format is technically
 395  * legal for establishing a connection to this peer (and make sure that
 396  * the address really corresponds to our network connection/settings
 397  * and not some potential man-in-the-middle).
 398  *
 399  * @param addr pointer to the address
 400  * @param addrlen length of addr
 401  * @return GNUNET_OK if this is a plausible address for this peer
 402  *         and transport, GNUNET_SYSERR if not
 403  */
 404 typedef int (*GNUNET_TRANSPORT_CheckAddress) (void *cls, const void *addr,
 405                                               size_t addrlen);
 406
 407 /**
 408  * Create a new session to transmit data to the target
 409  * This session will used to send data to this peer and the plugin will
 410  * notify us by calling the env->session_end function
 411  *
 412  * @param cls the plugin
 413  * @param target the neighbour id
 414  * @param addr pointer to the address
 415  * @param addrlen length of addr
 416  * @return the session if the address is valid, NULL otherwise
 417  */
 418 typedef struct Session * (*GNUNET_TRANSPORT_CreateSession) (void *cls,
 419                       const struct GNUNET_HELLO_Address *address);
 420
 421
 422 /**
 423  * Function called for a quick conversion of the binary address to
 424  * a numeric address.  Note that the caller must not free the
 425  * address and that the next call to this function is allowed
 426  * to override the address again.
 427  *
 428  * @param cls closure
 429  * @param addr binary address
 430  * @param addr_len length of the address
 431  * @return string representing the same address
 432  */
 433 typedef const char *(*GNUNET_TRANSPORT_AddressToString) (void *cls,
 434                                                          const void *addr,
 435                                                          size_t addrlen);
 436
 437 /**
 438  * Function called to convert a string address to
 439  * a binary address.
 440  *
 441  * @param cls closure ('struct Plugin*')
 442  * @param addr string address
 443  * @param addrlen length of the address including \0 termination
 444  * @param buf location to store the buffer
 445  *        If the function returns GNUNET_SYSERR, its contents are undefined.
 446  * @param added length of created address
 447  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 448  */
 449 typedef int (*GNUNET_TRANSPORT_StringToAddress) (void *cls,
 450                                                  const char *addr,
 451                                                  uint16_t addrlen,
 452                                                  void **buf,
 453                                                  size_t *added);
 454
 455
 456 /**
 457  * Each plugin is required to return a pointer to a struct of this
 458  * type as the return value from its entry point.
 459  */
 460 struct GNUNET_TRANSPORT_PluginFunctions
 461 {
 462
 463   /**
 464    * Closure for all of the callbacks.
 465    */
 466   void *cls;
 467
 468   /**
 469    * Function that the transport service will use to transmit data to
 470    * another peer.  May be NULL for plugins that only support
 471    * receiving data.  After this call, the plugin call the specified
 472    * continuation with success or error before notifying us about the
 473    * target having disconnected.
 474    */
 475   GNUNET_TRANSPORT_TransmitFunction send;
 476
 477   /**
 478    * Function that can be used to force the plugin to disconnect from
 479    * the given peer and cancel all previous transmissions (and their
 480    * continuations).
 481    */
 482   GNUNET_TRANSPORT_DisconnectFunction disconnect;
 483
 484   /**
 485    * Function to pretty-print addresses.  NOTE: this function is not
 486    * yet used by transport-service, but will be used in the future
 487    * once the transport-API has been completed.
 488    */
 489   GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
 490
 491   /**
 492    * Function that will be called to check if a binary address
 493    * for this plugin is well-formed and corresponds to an
 494    * address for THIS peer (as per our configuration).  Naturally,
 495    * if absolutely necessary, plugins can be a bit conservative in
 496    * their answer, but in general plugins should make sure that the
 497    * address does not redirect traffic to a 3rd party that might
 498    * try to man-in-the-middle our traffic.
 499    */
 500   GNUNET_TRANSPORT_CheckAddress check_address;
 501
 502   /**
 503    * Function that will be called to convert a binary address
 504    * to a string (numeric conversion only).
 505    */
 506   GNUNET_TRANSPORT_AddressToString address_to_string;
 507
 508   /**
 509    * Function that will be called to convert a string address
 510    * to binary (numeric conversion only).
 511    */
 512   GNUNET_TRANSPORT_StringToAddress string_to_address;
 513
 514   /**
 515    * Function that will be called tell the plugin to create a session
 516    * object
 517    */
 518   GNUNET_TRANSPORT_CreateSession get_session;
 519 };
 520
 521
 522 #endif