src/transport/gnunet-service-transport_validation.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 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 transport/gnunet-service-transport_validation.h
  23  * @brief address validation API
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_TRANSPORT_VALIDATION_H
  27 #define GNUNET_SERVICE_TRANSPORT_VALIDATION_H
  28
  29 #include "gnunet_statistics_service.h"
  30 #include "gnunet_transport_plugin.h"
  31 #include "gnunet_util_lib.h"
  32
  33
  34 /**
  35  * Start the validation subsystem.
  36  */
  37 void
  38 GST_validation_start (void);
  39
  40
  41 /**
  42  * Stop the validation subsystem.
  43  */
  44 void
  45 GST_validation_stop (void);
  46
  47
  48 /**
  49  * Update if we are using an address for a connection actively right now.
  50  * Based on this, the validation module will measure latency for the
  51  * address more or less often.
  52  *
  53  * @param sender peer sending the PING
  54  * @param hdr the PING
  55  * @param plugin_name name of plugin that received the PING
  56  * @param session session we got the PING from
  57  * @param sender_address address of the sender as known to the plugin, NULL
  58  *                       if we did not initiate the connection
  59  * @param sender_address_len number of bytes in sender_address
  60  * @param in_use GNUNET_YES if we are now using the address for a connection,
  61  *               GNUNET_NO if we are no longer using the address for a connection
  62  */
  63 void
  64 GST_validation_set_address_use (const struct GNUNET_PeerIdentity *sender,
  65                                 const struct GNUNET_MessageHeader *hdr,
  66                                 const char *plugin_name, struct Session *session,
  67                                 const void *sender_address,
  68                                 size_t sender_address_len,
  69                                 int in_use);
  70
  71
  72 /**
  73  * Query validation about the latest observed latency on a given
  74  * address.
  75  *
  76  * @param sender peer sending the PING
  77  * @param hdr the PING
  78  * @param plugin_name name of plugin that received the PING
  79  * @param session session we got the PING from
  80  * @param sender_address address of the sender as known to the plugin, NULL
  81  *                       if we did not initiate the connection
  82  * @param sender_address_len number of bytes in sender_address
  83  * @return observed latency of the address, FOREVER if the address was
  84  *         never successfully validated
  85  */
  86 struct GNUNET_TIME_Relative
  87 GST_validation_get_address_latency (const struct GNUNET_PeerIdentity *sender,
  88                                     const struct GNUNET_MessageHeader *hdr,
  89                                     const char *plugin_name, struct Session *session,
  90                                     const void *sender_address,
  91                                     size_t sender_address_len);
  92
  93
  94 /**
  95  * We've received a PING.  If appropriate, generate a PONG.
  96  *
  97  * @param sender peer sending the PING
  98  * @param hdr the PING
  99  * @param plugin_name name of plugin that received the PING
 100  * @param session session we got the PING from
 101  * @param sender_address address of the sender as known to the plugin, NULL
 102  *                       if we did not initiate the connection
 103  * @param sender_address_len number of bytes in sender_address
 104  */
 105 void
 106 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
 107                             const struct GNUNET_MessageHeader *hdr,
 108                             const char *plugin_name, struct Session *session,
 109                             const void *sender_address,
 110                             size_t sender_address_len);
 111
 112
 113 /**
 114  * We've received a PONG.  Check if it matches a pending PING and
 115  * mark the respective address as confirmed.
 116  *
 117  * @param sender peer sending the PONG
 118  * @param hdr the PONG
 119  */
 120 void
 121 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
 122                             const struct GNUNET_MessageHeader *hdr);
 123
 124
 125 /**
 126  * We've received a HELLO, check which addresses are new and trigger
 127  * validation.
 128  *
 129  * @param hello the HELLO we received
 130  */
 131 void
 132 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
 133
 134
 135 /**
 136  * Function called for each address (or address status change) that
 137  * the validation module is aware of (for the given target).
 138  *
 139  * @param cls closure
 140  * @param public_key public key for the peer, never NULL
 141  * @param target peer this change is about, never NULL
 142  * @param valid_until is ZERO if we never validated the address,
 143  *                    otherwise a time up to when we consider it (or was) valid
 144  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
 145  *                          is ZERO if the address is considered valid (no validation needed)
 146  *                          otherwise a time in the future if we're currently denying re-validation
 147  * @param plugin_name name of the plugin
 148  * @param plugin_address binary address
 149  * @param plugin_address_len length of address
 150  */
 151 typedef void (*GST_ValidationAddressCallback) (void *cls,
 152                                                const struct
 153                                                GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
 154                                                * public_key,
 155                                                const struct GNUNET_PeerIdentity
 156                                                * target,
 157                                                struct GNUNET_TIME_Absolute
 158                                                valid_until,
 159                                                struct GNUNET_TIME_Absolute
 160                                                validation_block,
 161                                                const char *plugin_name,
 162                                                const void *plugin_address,
 163                                                size_t plugin_address_len);
 164
 165
 166 /**
 167  * Call the given function for each address for the given target.
 168  *
 169  * @param target peer information is requested for
 170  * @param cb function to call; will not be called after this function returns
 171  * @param cb_cls closure for 'cb'
 172  */
 173 void
 174 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
 175                               GST_ValidationAddressCallback cb, void *cb_cls);
 176
 177
 178 #endif
 179 /* end of file gnunet-service-transport_validation.h */