2 This file is part of GNUnet.
3 (C) 2010,2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file transport/gnunet-service-transport_validation.h
23 * @brief address validation API
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_TRANSPORT_VALIDATION_H
27 #define GNUNET_SERVICE_TRANSPORT_VALIDATION_H
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_transport_plugin.h"
31 #include "gnunet_util_lib.h"
32 #include "gnunet_hello_lib.h"
35 * Function called for each address (or address status change) that
36 * the validation module is aware of (for the given target).
39 * @param public_key public key for the peer, never NULL
40 * @param valid_until is ZERO if we never validated the address,
41 * otherwise a time up to when we consider it (or was) valid
42 * @param validation_block is FOREVER if the address is for an unsupported plugin (from PEERINFO)
43 * is ZERO if the address is considered valid (no validation needed)
44 * otherwise a time in the future if we're currently denying re-validation
45 * @param address the address
47 typedef void (*GST_ValidationChangedCallback) (void *cls,
48 const struct GNUNET_PeerIdentity *peer,
49 const struct GNUNET_HELLO_Address *address,
50 struct GNUNET_TIME_Absolute last_validation,
51 struct GNUNET_TIME_Absolute valid_until,
52 struct GNUNET_TIME_Absolute next_validation,
53 enum GNUNET_TRANSPORT_ValidationState state);
56 * Start the validation subsystem.
58 * @param max_fds maximum number of fds to use
61 GST_validation_start (GST_ValidationChangedCallback cb, void *cb_cls, unsigned int max_fds);
65 * Stop the validation subsystem.
68 GST_validation_stop (void);
72 * Update if we are using an address for a connection actively right now.
73 * Based on this, the validation module will measure latency for the
74 * address more or less often.
76 * @param address the address
77 * @param session the session
78 * @param in_use GNUNET_YES if we are now using the address for a connection,
79 * GNUNET_NO if we are no longer using the address for a connection
82 GST_validation_set_address_use (const struct GNUNET_HELLO_Address *address,
83 struct Session *session,
88 * Query validation about the latest observed latency on a given
92 * @param address the address
93 * @param session session
94 * @return observed latency of the address, FOREVER if the address was
95 * never successfully validated
97 struct GNUNET_TIME_Relative
98 GST_validation_get_address_latency (const struct GNUNET_PeerIdentity *sender,
99 const struct GNUNET_HELLO_Address *address,
100 struct Session *session);
103 * Iterate over all iteration entries
105 * @param cb function to call
106 * @param cb_cls closure for cb
109 GST_validation_iterate (GST_ValidationChangedCallback cb, void *cb_cls);
112 * We've received a PING. If appropriate, generate a PONG.
114 * @param sender peer sending the PING
115 * @param hdr the PING
116 * @param sender_address address of the sender, NULL if we did not initiate
117 * @param session session we got the PING from
118 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
121 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
122 const struct GNUNET_MessageHeader *hdr,
123 const struct GNUNET_HELLO_Address *sender_address,
124 struct Session *session);
128 * We've received a PONG. Check if it matches a pending PING and
129 * mark the respective address as confirmed.
131 * @param sender peer sending the PONG
132 * @param hdr the PONG
133 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
136 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
137 const struct GNUNET_MessageHeader *hdr);
141 * We've received a HELLO, check which addresses are new and trigger
144 * @param hello the HELLO we received
145 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
148 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
152 * Function called for each address (or address status change) that
153 * the validation module is aware of (for the given target).
156 * @param public_key public key for the peer, never NULL
157 * @param valid_until is ZERO if we never validated the address,
158 * otherwise a time up to when we consider it (or was) valid
159 * @param validation_block is FOREVER if the address is for an unsupported plugin (from PEERINFO)
160 * is ZERO if the address is considered valid (no validation needed)
161 * otherwise a time in the future if we're currently denying re-validation
162 * @param address the address
164 typedef void (*GST_ValidationAddressCallback) (void *cls,
166 GNUNET_CRYPTO_EddsaPublicKey *public_key,
167 struct GNUNET_TIME_Absolute
169 struct GNUNET_TIME_Absolute
171 const struct GNUNET_HELLO_Address
176 * Call the given function for each address for the given target.
178 * @param target peer information is requested for
179 * @param cb function to call; will not be called after this function returns
180 * @param cb_cls closure for 'cb'
183 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
184 GST_ValidationAddressCallback cb, void *cb_cls);
188 /* end of file gnunet-service-transport_validation.h */