aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_hello_lib.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_hello_lib.h')
-rw-r--r--src/include/gnunet_hello_lib.h539
1 files changed, 0 insertions, 539 deletions
diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h
deleted file mode 100644
index 74eca999d..000000000
--- a/src/include/gnunet_hello_lib.h
+++ /dev/null
@@ -1,539 +0,0 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010, 2011 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
21/**
22 * @author Christian Grothoff
23 * @file
24 * Helper library for handling HELLOs
25 *
26 * @defgroup hello Hello library
27 * Helper library for handling HELLOs
28 *
29 * @see [Documentation](https://gnunet.org/gnunets-hostlist-subsystem)
30 *
31 * @{
32 */
33
34#ifndef GNUNET_HELLO_LIB_H
35#define GNUNET_HELLO_LIB_H
36
37#ifdef __cplusplus
38extern "C" {
39#if 0 /* keep Emacsens' auto-indent happy */
40}
41#endif
42#endif
43
44#include "gnunet_util_lib.h"
45
46/**
47 * Prefix that every HELLO URI must start with.
48 */
49#define GNUNET_HELLO_URI_PREFIX "gnunet://hello/"
50
51/**
52 * Prefix that every FRIEND HELLO URI must start with.
53 */
54#define GNUNET_FRIEND_HELLO_URI_PREFIX "gnunet://friend-hello/"
55
56/**
57 * Separator used in HELLO URI
58 */
59#define GNUNET_HELLO_URI_SEP '+'
60
61
62/**
63 * Additional local information about an address
64 *
65 * These information are only valid for the local peer and are not serialized
66 * when a #GNUNET_HELLO_Message is created
67 */
68enum GNUNET_HELLO_AddressInfo
69{
70 /**
71 * No additional information
72 */
73 GNUNET_HELLO_ADDRESS_INFO_NONE = 0,
74
75 /**
76 * This is an inbound address and cannot be used to initiate an outbound
77 * connection to another peer
78 */
79 GNUNET_HELLO_ADDRESS_INFO_INBOUND = 1
80};
81
82
83/**
84 * An address for communicating with a peer. We frequently
85 * need this tuple and the components cannot really be
86 * separated. This is NOT the format that would be used
87 * on the wire.
88 */
89struct GNUNET_HELLO_Address
90{
91 /**
92 * For which peer is this an address?
93 */
94 struct GNUNET_PeerIdentity peer;
95
96 /**
97 * Name of the transport plugin enabling the communication using
98 * this address.
99 */
100 const char *transport_name;
101
102 /**
103 * Binary representation of the address (plugin-specific).
104 */
105 const void *address;
106
107 /**
108 * Number of bytes in @e address.
109 */
110 size_t address_length;
111
112 /**
113 * Extended information about address
114 *
115 * This field contains additional #GNUNET_HELLO_AddressInfo flags e.g.
116 * to indicate an address is inbound and cannot be used to initiate an
117 * outbound connection.
118 *
119 * These information are only valid for the local peer and are not serialized
120 * when a #GNUNET_HELLO_Message is created
121 */
122 enum GNUNET_HELLO_AddressInfo local_info;
123};
124
125
126/**
127 * Allocate an address struct.
128 *
129 * @param peer the peer
130 * @param transport_name plugin name
131 * @param address binary address
132 * @param address_length number of bytes in @a address
133 * @param local_info additional local information for the address
134 * @return the address struct
135 */
136struct GNUNET_HELLO_Address *
137GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
138 const char *transport_name,
139 const void *address,
140 size_t address_length,
141 enum GNUNET_HELLO_AddressInfo local_info);
142
143
144/**
145 * Copy an address struct.
146 *
147 * @param address address to copy
148 * @return a copy of the address struct
149 */
150struct GNUNET_HELLO_Address *
151GNUNET_HELLO_address_copy (const struct GNUNET_HELLO_Address *address);
152
153
154/**
155 * Compare two addresses. Does NOT compare the peer identity,
156 * that is assumed already to match!
157 *
158 * @param a1 first address
159 * @param a2 second address
160 * @return 0 if the addresses are equal, -1 if @a a1< @a a2, 1 if @a a1> @a a2.
161 */
162int
163GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
164 const struct GNUNET_HELLO_Address *a2);
165
166
167/**
168 * Get the size of an address struct.
169 *
170 * @param address address
171 * @return the size
172 */
173size_t
174GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address);
175
176
177/**
178 * Check if an address has a local option set
179 *
180 * @param address the address to check
181 * @param option the respective option to check for
182 * @return #GNUNET_YES or #GNUNET_NO
183 */
184int
185GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address *address,
186 enum GNUNET_HELLO_AddressInfo option);
187
188
189/**
190 * Free an address.
191 *
192 * @param addr address to free
193 */
194#define GNUNET_HELLO_address_free(addr) GNUNET_free (addr)
195
196
197GNUNET_NETWORK_STRUCT_BEGIN
198
199/**
200 * A HELLO message is used to exchange information about
201 * transports with other peers. This struct is always
202 * followed by the actual network addresses which have
203 * the format:
204 *
205 * 1) transport-name (0-terminated)
206 * 2) address-length (uint16_t, network byte order; possibly
207 * unaligned!)
208 * 3) address expiration (`struct GNUNET_TIME_AbsoluteNBO`); possibly
209 * unaligned!)
210 * 4) address (address-length bytes; possibly unaligned!)
211 */
212struct GNUNET_HELLO_Message
213{
214 /**
215 * Type will be #GNUNET_MESSAGE_TYPE_HELLO.
216 */
217 struct GNUNET_MessageHeader header;
218
219 /**
220 * Use in F2F mode: Do not gossip this HELLO message
221 */
222 uint32_t friend_only GNUNET_PACKED;
223
224 /**
225 * The public key of the peer.
226 */
227 struct GNUNET_CRYPTO_EddsaPublicKey publicKey;
228};
229GNUNET_NETWORK_STRUCT_END
230
231
232/**
233 * Return HELLO type
234 *
235 * @param h HELLO Message to test
236 * @return #GNUNET_YES for friend-only or #GNUNET_NO otherwise
237 */
238int
239GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h);
240
241
242/**
243 * Copy the given address information into
244 * the given buffer using the format of HELLOs.
245 *
246 * @param address address to add
247 * @param expiration expiration for the address
248 * @param target where to copy the address
249 * @param max maximum number of bytes to copy to @a target
250 * @return number of bytes copied, 0 if
251 * the target buffer was not big enough.
252 */
253size_t
254GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
255 struct GNUNET_TIME_Absolute expiration,
256 char *target,
257 size_t max);
258
259
260/**
261 * Callback function used to fill a buffer of max bytes with a list of
262 * addresses in the format used by HELLOs. Should use
263 * #GNUNET_HELLO_add_address() as a helper function.
264 *
265 * @param cls closure
266 * @param max maximum number of bytes that can be written to @a buf
267 * @param buf where to write the address information
268 * @return number of bytes written or 0, #GNUNET_SYSERR to signal the
269 * end of the iteration.
270 */
271typedef ssize_t
272(*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
273 size_t max,
274 void *buf);
275
276
277/**
278 * Construct a HELLO message given the public key,
279 * expiration time and an iterator that spews the
280 * transport addresses.
281 *
282 * If friend only is set to #GNUNET_YES we create a FRIEND_HELLO which
283 * will not be gossiped to other peers.
284 *
285 * @param public_key public key to include in the HELLO
286 * @param addrgen callback to invoke to get addresses
287 * @param addrgen_cls closure for @a addrgen
288 * @param friend_only should the returned HELLO be only visible to friends?
289 * @return the hello message
290 */
291struct GNUNET_HELLO_Message *
292GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EddsaPublicKey *public_key,
293 GNUNET_HELLO_GenerateAddressListCallback addrgen,
294 void *addrgen_cls,
295 int friend_only);
296
297
298/**
299 * Return the size of the given HELLO message.
300 *
301 * @param hello to inspect
302 * @return the size, 0 if HELLO is invalid
303 */
304uint16_t
305GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello);
306
307
308/**
309 * Construct a HELLO message by merging the
310 * addresses in two existing HELLOs (which
311 * must be for the same peer).
312 *
313 * @param h1 first HELLO message
314 * @param h2 the second HELLO message
315 * @return the combined hello message
316 */
317struct GNUNET_HELLO_Message *
318GNUNET_HELLO_merge (const struct GNUNET_HELLO_Message *h1,
319 const struct GNUNET_HELLO_Message *h2);
320
321
322/**
323 * Test if two HELLO messages contain the same addresses.
324 * If they only differ in expiration time, the lowest
325 * expiration time larger than 'now' where they differ
326 * is returned.
327 *
328 * @param h1 first HELLO message
329 * @param h2 the second HELLO message
330 * @param now time to use for deciding which addresses have
331 * expired and should not be considered at all
332 * @return absolute time forever if the two HELLOs are
333 * totally identical; smallest timestamp >= now if
334 * they only differ in timestamps;
335 * zero if the some addresses with expirations >= now
336 * do not match at all
337 */
338struct GNUNET_TIME_Absolute
339GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1,
340 const struct GNUNET_HELLO_Message *h2,
341 struct GNUNET_TIME_Absolute now);
342
343
344/**
345 * Iterator callback to go over all addresses.
346 *
347 * @param cls closure
348 * @param address the address
349 * @param expiration expiration time
350 * @return #GNUNET_OK to keep the address,
351 * #GNUNET_NO to delete it from the HELLO
352 * #GNUNET_SYSERR to stop iterating (but keep current address)
353 */
354typedef int (*GNUNET_HELLO_AddressIterator) (
355 void *cls,
356 const struct GNUNET_HELLO_Address *address,
357 struct GNUNET_TIME_Absolute expiration);
358
359
360/**
361 * When does the last address in the given HELLO expire?
362 *
363 * @param msg HELLO to inspect
364 * @return time the last address expires, 0 if there are no addresses in the HELLO
365 */
366struct GNUNET_TIME_Absolute
367GNUNET_HELLO_get_last_expiration (const struct GNUNET_HELLO_Message *msg);
368
369
370/**
371 * Iterate over all of the addresses in the HELLO.
372 *
373 * @param msg HELLO to iterate over; client does not need to
374 * have verified that msg is well-formed (beyond starting
375 * with a GNUNET_MessageHeader of the right type).
376 * @param return_modified if a modified copy should be returned,
377 * otherwise NULL will be returned
378 * @param it iterator to call on each address
379 * @param it_cls closure for @a it
380 * @return the modified HELLO or NULL
381 */
382struct GNUNET_HELLO_Message *
383GNUNET_HELLO_iterate_addresses (const struct GNUNET_HELLO_Message *msg,
384 int return_modified,
385 GNUNET_HELLO_AddressIterator it,
386 void *it_cls);
387
388
389/**
390 * Iterate over addresses in @a new_hello that are NOT already present
391 * in @a old_hello. Note that if the address is present in @a old_hello
392 * but the expiration time in @a new_hello is more recent, the
393 * iterator is also called.
394 *
395 * @param new_hello a HELLO message
396 * @param old_hello a HELLO message
397 * @param expiration_limit ignore addresses in old_hello
398 * that expired before the given time stamp
399 * @param it iterator to call on each address
400 * @param it_cls closure for @a it
401 */
402void
403GNUNET_HELLO_iterate_new_addresses (
404 const struct GNUNET_HELLO_Message *new_hello,
405 const struct GNUNET_HELLO_Message *old_hello,
406 struct GNUNET_TIME_Absolute expiration_limit,
407 GNUNET_HELLO_AddressIterator it,
408 void *it_cls);
409
410
411/**
412 * Get the peer identity from a HELLO message.
413 *
414 * @param hello the hello message
415 * @param peer where to store the peer's identity
416 * @return #GNUNET_SYSERR if the HELLO was malformed
417 */
418int
419GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
420 struct GNUNET_PeerIdentity *peer);
421
422
423/**
424 * Get the header from a HELLO message, used so other code
425 * can correctly send HELLO messages.
426 *
427 * @param hello the hello message
428 *
429 * @return header or NULL if the HELLO was malformed
430 */
431struct GNUNET_MessageHeader *
432GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
433
434
435/**
436 * Helper function to load/access transport plugins.
437 * FIXME: pass closure!
438 *
439 * @param name name of the transport plugin to load
440 * @return NULL if a plugin with name @a name is not known/loadable
441 */
442typedef struct GNUNET_TRANSPORT_PluginFunctions *(
443*GNUNET_HELLO_TransportPluginsFind) (const char *name);
444
445
446/**
447 * Compose a hello URI string from a hello message.
448 *
449 * @param hello Hello message
450 * @param plugins_find Function to find transport plugins by name
451 * @return Hello URI string
452 */
453char *
454GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
455 GNUNET_HELLO_TransportPluginsFind plugins_find);
456
457
458/**
459 * Parse a hello URI string to a hello message.
460 *
461 * @param uri URI string to parse
462 * @param pubkey Pointer to struct where public key is parsed
463 * @param hello Pointer to struct where hello message is parsed
464 * @param plugins_find Function to find transport plugins by name
465 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the URI was invalid, #GNUNET_NO on other errors
466 */
467int
468GNUNET_HELLO_parse_uri (const char *uri,
469 struct GNUNET_CRYPTO_EddsaPublicKey *pubkey,
470 struct GNUNET_HELLO_Message **hello,
471 GNUNET_HELLO_TransportPluginsFind plugins_find);
472
473
474/* NG API */
475#include "gnunet_nt_lib.h"
476
477
478/**
479 * Build address record by signing raw information with private key.
480 *
481 * @param address text address to sign
482 * @param nt network type of @a address
483 * @param mono_time when was @a address valid
484 * @param private_key signing key to use
485 * @param result[out] where to write address record (allocated)
486 * @param result_size[out] set to size of @a result
487 */
488void
489GNUNET_HELLO_sign_address (
490 const char *address,
491 enum GNUNET_NetworkType nt,
492 struct GNUNET_TIME_Absolute mono_time,
493 const struct GNUNET_CRYPTO_EddsaPrivateKey *private_key,
494 void **result,
495 size_t *result_size);
496
497
498/**
499 * Check signature and extract address record.
500 *
501 * @param raw raw signed address
502 * @param raw_size size of @a raw
503 * @param pid public key to use for signature verification
504 * @param nt[out] set to network type
505 * @param mono_time[out] when was the address generated
506 * @return NULL on error, otherwise the address
507 */
508char *
509GNUNET_HELLO_extract_address (const void *raw,
510 size_t raw_size,
511 const struct GNUNET_PeerIdentity *pid,
512 enum GNUNET_NetworkType *nt,
513 struct GNUNET_TIME_Absolute *mono_time);
514
515
516/**
517 * Given an address as a string, extract the prefix that identifies
518 * the communicator offering transmissions to that address.
519 *
520 * @param address a peer's address
521 * @return NULL if the address is mal-formed, otherwise the prefix
522 */
523char *
524GNUNET_HELLO_address_to_prefix (const char *address);
525
526
527#if 0 /* keep Emacsens' auto-indent happy */
528{
529#endif
530#ifdef __cplusplus
531}
532#endif
533
534/* ifndef GNUNET_HELLO_LIB_H */
535#endif
536
537/** @} */ /* end of group */
538
539/* end of gnunet_hello_lib.h */