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