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"
35 * Start the validation subsystem.
38 GST_validation_start (void);
42 * Stop the validation subsystem.
45 GST_validation_stop (void);
49 * We've received a PING. If appropriate, generate a PONG.
51 * @param sender peer sending the PING
53 * @param plugin_name name of plugin that received the PING
54 * @param session session we got the PING from
55 * @param sender_address address of the sender as known to the plugin, NULL
56 * if we did not initiate the connection
57 * @param sender_address_len number of bytes in sender_address
60 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
61 const struct GNUNET_MessageHeader *hdr,
62 const char *plugin_name,
63 struct Session *session,
64 const void *sender_address,
65 size_t sender_address_len);
69 * We've received a PONG. Check if it matches a pending PING and
70 * mark the respective address as confirmed.
72 * @param sender peer sending the PONG
74 * @param plugin_name name of plugin that received the PONG
75 * @param sender_address address of the sender as known to the plugin, NULL
76 * if we did not initiate the connection
77 * @param sender_address_len number of bytes in sender_address
80 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
81 const struct GNUNET_MessageHeader *hdr,
82 const char *plugin_name,
83 const void *sender_address,
84 size_t sender_address_len);
88 * We've received a HELLO, check which addresses are new and trigger
91 * @param hello the HELLO we received
94 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
98 * Opaque handle to stop incremental validation address callbacks.
100 struct GST_ValidationIteratorContext;
104 * Function called for each address (or address status change) that
105 * the validation module is aware of (for the given target).
108 * @param public_key public key for the peer, never NULL
109 * @param target peer this change is about, never NULL
110 * @param valid_until is ZERO if we never validated the address,
111 * otherwise a time up to when we consider it (or was) valid
112 * @param validation_block is FOREVER if the address is for an unsupported plugin (from PEERINFO)
113 * is ZERO if the address is considered valid (no validation needed)
114 * otherwise a time in the future if we're currently denying re-validation
115 * @param plugin_name name of the plugin
116 * @param plugin_address binary address
117 * @param plugin_address_len length of address
119 typedef void (*GST_ValidationAddressCallback)(void *cls,
120 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
121 const struct GNUNET_PeerIdentity *target,
122 struct GNUNET_TIME_Absolute valid_until,
123 struct GNUNET_TIME_Absolute validation_block,
124 const char *plugin_name,
125 const void *plugin_address,
126 size_t plugin_address_len);
130 * Call the given function for each address for the given target.
131 * Can either give a snapshot (synchronous API) or be continuous.
133 * @param target peer information is requested for
134 * @param snapshot_only GNUNET_YES to iterate over addresses once, GNUNET_NO to
135 * continue to give information about addresses as it evolves
136 * @param cb function to call; will not be called after this function returns
137 * if snapshot_only is GNUNET_YES
138 * @param cb_cls closure for 'cb'
139 * @return context to cancel, NULL if 'snapshot_only' is GNUNET_YES
141 struct GST_ValidationIteratorContext *
142 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
144 GST_ValidationAddressCallback cb,
149 * Cancel an active validation address iteration.
151 * @param ctx the context of the operation that is cancelled
154 GST_validation_get_addresses_cancel (struct GST_ValidationIteratorContext *ctx);
159 /* end of file gnunet-service-transport_validation.h */