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