2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010 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 2, 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 include/gnunet_hello_lib.h
23 * @brief helper library for handling HELLOs
24 * @author Christian Grothoff
27 #ifndef GNUNET_HELLO_LIB_H
28 #define GNUNET_HELLO_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_common.h"
39 #include "gnunet_crypto_lib.h"
42 * A HELLO message is used to exchange information about
43 * transports with other peers. This struct is guaranteed
44 * to start with a "GNUNET_MessageHeader", everything else
45 * should be internal to the HELLO library.
47 struct GNUNET_HELLO_Message;
51 * Copy the given address information into
52 * the given buffer using the format of HELLOs.
54 * @param tname name of the transport plugin
55 * @param expiration expiration for the address
56 * @param addr the address
57 * @param addr_len length of the address in bytes
58 * @param target where to copy the address
59 * @param max maximum number of bytes to copy to target
60 * @return number of bytes copied, 0 if
61 * the target buffer was not big enough.
64 GNUNET_HELLO_add_address (const char *tname,
65 struct GNUNET_TIME_Absolute expiration,
67 size_t addr_len, char *target, size_t max);
71 * Callback function used to fill a buffer of max bytes with a list of
72 * addresses in the format used by HELLOs. Should use
73 * "GNUNET_HELLO_add_address" as a helper function.
76 * @param max maximum number of bytes that can be written to buf
77 * @param buf where to write the address information
78 * @return number of bytes written, 0 to signal the
79 * end of the iteration.
82 (*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
83 size_t max, void *buf);
87 * Construct a HELLO message given the public key,
88 * expiration time and an iterator that spews the
89 * transport addresses.
91 * @return the hello message
93 struct GNUNET_HELLO_Message *GNUNET_HELLO_create (const struct
94 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
96 GNUNET_HELLO_GenerateAddressListCallback
97 addrgen, void *addrgen_cls);
101 * Return the size of the given HELLO message.
102 * @param hello to inspect
103 * @return the size, 0 if HELLO is invalid
105 uint16_t GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello);
109 * Construct a HELLO message by merging the
110 * addresses in two existing HELLOs (which
111 * must be for the same peer).
113 * @param h1 first HELLO message
114 * @param h2 the second HELLO message
115 * @return the combined hello message
117 struct GNUNET_HELLO_Message *GNUNET_HELLO_merge (const struct
118 GNUNET_HELLO_Message *h1,
120 GNUNET_HELLO_Message *h2);
124 * Test if two HELLO messages contain the same addresses.
125 * If they only differ in expiration time, the lowest
126 * expiration time larger than 'now' where they differ
129 * @param h1 first HELLO message
130 * @param h2 the second HELLO message
131 * @param now time to use for deciding which addresses have
132 * expired and should not be considered at all
133 * @return absolute time forever if the two HELLOs are
134 * totally identical; smallest timestamp >= now if
135 * they only differ in timestamps;
136 * zero if the some addresses with expirations >= now
137 * do not match at all
139 struct GNUNET_TIME_Absolute
140 GNUNET_HELLO_equals (const struct
141 GNUNET_HELLO_Message *h1,
143 GNUNET_HELLO_Message *h2,
144 struct GNUNET_TIME_Absolute now);
148 * Iterator callback to go over all addresses.
151 * @param tname name of the transport
152 * @param expiration expiration time
153 * @param addr the address
154 * @param addrlen length of the address
155 * @return GNUNET_OK to keep the address,
156 * GNUNET_NO to delete it from the HELLO
157 * GNUNET_SYSERR to stop iterating (but keep current address)
160 (*GNUNET_HELLO_AddressIterator) (void *cls,
162 struct GNUNET_TIME_Absolute expiration,
163 const void *addr, size_t addrlen);
167 * Iterate over all of the addresses in the HELLO.
169 * @param msg HELLO to iterate over; client does not need to
170 * have verified that msg is well-formed (beyond starting
171 * with a GNUNET_MessageHeader of the right type).
172 * @param return_modified if a modified copy should be returned,
173 * otherwise NULL will be returned
174 * @param it iterator to call on each address
175 * @param it_cls closure for it
177 struct GNUNET_HELLO_Message *GNUNET_HELLO_iterate_addresses (const struct
182 GNUNET_HELLO_AddressIterator
188 * Iterate over addresses in "new_hello" that
189 * are NOT already present in "old_hello".
191 * @param new_hello a HELLO message
192 * @param old_hello a HELLO message
193 * @param expiration_limit ignore addresses in old_hello
194 * that expired before the given time stamp
195 * @param it iterator to call on each address
196 * @param it_cls closure for it
199 GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message
201 const struct GNUNET_HELLO_Message
203 struct GNUNET_TIME_Absolute
205 GNUNET_HELLO_AddressIterator it,
210 * Get the public key from a HELLO message.
212 * @param hello the hello message
213 * @param publicKey where to copy the public key information, can be NULL
214 * @return GNUNET_SYSERR if the HELLO was malformed
217 GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
218 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
223 * Get the peer identity from a HELLO message.
225 * @param hello the hello message
226 * @param peer where to store the peer's identity
227 * @return GNUNET_SYSERR if the HELLO was malformed
230 GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
231 struct GNUNET_PeerIdentity *peer);
235 * Get the header from a HELLO message, used so other code
236 * can correctly send HELLO messages.
238 * @param hello the hello message
240 * @return header or NULL if the HELLO was malformed
242 struct GNUNET_MessageHeader *
243 GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
245 /* ifndef GNUNET_HELLO_LIB_H */
247 /* end of gnunet_hello_lib.h */