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