2 This file is part of GNUnet.
3 (C) 2009 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.
23 * @brief helper library for handling HELLOs
24 * @author Christian Grothoff
27 #include "gnunet_hello_lib.h"
28 #include "gnunet_protocols.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_transport_plugin.h"
32 GNUNET_NETWORK_STRUCT_BEGIN
35 * A HELLO message is used to exchange information about
36 * transports with other peers. This struct is always
37 * followed by the actual network addresses which have
40 * 1) transport-name (0-terminated)
41 * 2) address-length (uint16_t, network byte order; possibly
43 * 3) address expiration (GNUNET_TIME_AbsoluteNBO); possibly
45 * 4) address (address-length bytes; possibly unaligned!)
47 struct GNUNET_HELLO_Message
50 * Type will be GNUNET_MESSAGE_TYPE_HELLO.
52 struct GNUNET_MessageHeader header;
55 * Use in F2F mode: Do not gossip this HELLO message
57 uint32_t friend_only GNUNET_PACKED;
60 * The public key of the peer.
62 struct GNUNET_CRYPTO_EccPublicKey publicKey;
65 GNUNET_NETWORK_STRUCT_END
69 * Context used for building our own URI.
71 struct GNUNET_HELLO_ComposeUriContext
79 * Function for finding transport plugins by name.
81 GNUNET_HELLO_TransportPluginsFind plugins_find;
86 * Context for 'add_address_to_hello'.
88 struct GNUNET_HELLO_ParseUriContext
91 * Position in the URI with the next address to parse.
96 * Set to GNUNET_SYSERR to indicate parse errors.
101 * Function for finding transport plugins by name.
103 GNUNET_HELLO_TransportPluginsFind plugins_find;
107 /** Return HELLO type
109 * @param h HELLO Message to test
110 * @return GNUNET_YES or GNUNET_NO
113 GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h)
115 if (GNUNET_YES == ntohl(h->friend_only))
123 * Copy the given address information into
124 * the given buffer using the format of HELLOs.
126 * @param address the address
127 * @param expiration expiration for the address
128 * @param target where to copy the address
129 * @param max maximum number of bytes to copy to target
130 * @return number of bytes copied, 0 if
131 * the target buffer was not big enough.
134 GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
135 struct GNUNET_TIME_Absolute expiration, char *target,
140 struct GNUNET_TIME_AbsoluteNBO exp;
142 slen = strlen (address->transport_name) + 1;
143 if (slen + sizeof (uint16_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO) +
144 address->address_length > max)
146 exp = GNUNET_TIME_absolute_hton (expiration);
147 alen = htons ((uint16_t) address->address_length);
148 memcpy (target, address->transport_name, slen);
149 memcpy (&target[slen], &alen, sizeof (uint16_t));
150 slen += sizeof (uint16_t);
151 memcpy (&target[slen], &exp, sizeof (struct GNUNET_TIME_AbsoluteNBO));
152 slen += sizeof (struct GNUNET_TIME_AbsoluteNBO);
153 memcpy (&target[slen], address->address, address->address_length);
154 slen += address->address_length;
160 * Get the size of an address entry in a HELLO message.
162 * @param buf pointer to the start of the address entry
163 * @param max maximum size of the entry (end of buf)
164 * @param ralen set to the address length
165 * @return size of the entry, or 0 if max is not large enough
168 get_hello_address_size (const char *buf, size_t max, uint16_t * ralen)
178 while ((left > 0) && ('\0' != *pos))
186 /* 0-termination not found */
191 if (left < sizeof (uint16_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO))
193 /* not enough space for addrlen */
197 memcpy (&alen, pos, sizeof (uint16_t));
200 slen += alen + sizeof (uint16_t) + sizeof (struct GNUNET_TIME_AbsoluteNBO);
203 /* not enough space for addr */
212 * Construct a HELLO message given the public key,
213 * expiration time and an iterator that spews the
214 * transport addresses.
216 * @return the hello message
218 struct GNUNET_HELLO_Message *
219 GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EccPublicKey *publicKey,
220 GNUNET_HELLO_GenerateAddressListCallback addrgen,
224 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1 - 256 -
225 sizeof (struct GNUNET_HELLO_Message)];
229 struct GNUNET_HELLO_Message *hello;
231 GNUNET_assert (NULL != publicKey);
232 GNUNET_assert ((GNUNET_YES == friend_only) || (GNUNET_NO == friend_only));
234 max = sizeof (buffer);
238 while (0 != (ret = addrgen (addrgen_cls, max, &buffer[used])))
244 hello = GNUNET_malloc (sizeof (struct GNUNET_HELLO_Message) + used);
245 hello->header.type = htons (GNUNET_MESSAGE_TYPE_HELLO);
246 hello->header.size = htons (sizeof (struct GNUNET_HELLO_Message) + used);
247 hello->friend_only = htonl (friend_only);
249 memcpy (&hello->publicKey, publicKey,
250 sizeof (struct GNUNET_CRYPTO_EccPublicKey));
251 memcpy (&hello[1], buffer, used);
257 * Iterate over all of the addresses in the HELLO.
259 * @param msg HELLO to iterate over
260 * @param return_modified if a modified copy should be returned,
261 * otherwise NULL will be returned
262 * @param it iterator to call on each address
263 * @param it_cls closure for it
264 * @return modified HELLO message
266 struct GNUNET_HELLO_Message *
267 GNUNET_HELLO_iterate_addresses (const struct GNUNET_HELLO_Message *msg,
269 GNUNET_HELLO_AddressIterator it, void *it_cls)
271 struct GNUNET_HELLO_Address address;
273 struct GNUNET_HELLO_Message *ret;
280 struct GNUNET_TIME_AbsoluteNBO expire;
283 msize = GNUNET_HELLO_size (msg);
284 if ((msize < sizeof (struct GNUNET_HELLO_Message)) ||
285 (ntohs (msg->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
290 ret = GNUNET_malloc (msize);
291 memcpy (ret, msg, msize);
293 inptr = (const char *) &msg[1];
294 insize = msize - sizeof (struct GNUNET_HELLO_Message);
296 woff = (ret != NULL) ? (char *) &ret[1] : NULL;
297 GNUNET_CRYPTO_hash (&msg->publicKey,
298 sizeof (struct GNUNET_CRYPTO_EccPublicKey),
299 &address.peer.hashPubKey);
302 esize = get_hello_address_size (inptr, insize, &alen);
306 GNUNET_free_non_null (ret);
310 &inptr[esize - alen - sizeof (struct GNUNET_TIME_AbsoluteNBO)],
311 sizeof (struct GNUNET_TIME_AbsoluteNBO));
312 address.address = &inptr[esize - alen];
313 address.address_length = alen;
314 address.transport_name = inptr;
315 iret = it (it_cls, &address, GNUNET_TIME_absolute_ntoh (expire));
316 if (iret == GNUNET_SYSERR)
319 ret->header.size = ntohs (sizeof (struct GNUNET_HELLO_Message) + wpos);
322 if ((iret == GNUNET_OK) && (ret != NULL))
324 memcpy (woff, inptr, esize);
332 ret->header.size = ntohs (sizeof (struct GNUNET_HELLO_Message) + wpos);
339 const struct GNUNET_HELLO_Address *address;
341 struct GNUNET_TIME_Absolute expiration;
346 get_match_exp (void *cls, const struct GNUNET_HELLO_Address *address,
347 struct GNUNET_TIME_Absolute expiration)
349 struct ExpireContext *ec = cls;
351 if (0 == GNUNET_HELLO_address_cmp (address, ec->address))
353 ec->found = GNUNET_YES;
354 ec->expiration = expiration;
355 return GNUNET_SYSERR; /* done here */
363 const struct GNUNET_HELLO_Message *h1;
364 const struct GNUNET_HELLO_Message *h2;
365 const struct GNUNET_HELLO_Message *other;
375 copy_latest (void *cls, const struct GNUNET_HELLO_Address *address,
376 struct GNUNET_TIME_Absolute expiration)
378 struct MergeContext *mc = cls;
379 struct ExpireContext ec;
381 ec.address = address;
382 ec.found = GNUNET_NO;
383 GNUNET_HELLO_iterate_addresses (mc->other, GNUNET_NO, &get_match_exp, &ec);
384 if ((ec.found == GNUNET_NO) ||
385 (ec.expiration.abs_value_us < expiration.abs_value_us) ||
386 ((ec.expiration.abs_value_us == expiration.abs_value_us) &&
387 (mc->take_equal == GNUNET_YES)))
390 GNUNET_HELLO_add_address (address, expiration, &mc->buf[mc->ret],
398 merge_addr (void *cls, size_t max, void *buf)
400 struct MergeContext *mc = cls;
407 mc->take_equal = GNUNET_NO;
409 GNUNET_HELLO_iterate_addresses (mc->h1, GNUNET_NO, ©_latest, mc);
410 mc->take_equal = GNUNET_YES;
412 GNUNET_HELLO_iterate_addresses (mc->h2, GNUNET_NO, ©_latest, mc);
419 * Construct a HELLO message by merging the
420 * addresses in two existing HELLOs (which
421 * must be for the same peer).
423 * @param h1 first HELLO message
424 * @param h2 the second HELLO message
425 * @return the combined hello message
427 struct GNUNET_HELLO_Message *
428 GNUNET_HELLO_merge (const struct GNUNET_HELLO_Message *h1,
429 const struct GNUNET_HELLO_Message *h2)
431 struct MergeContext mc = { h1, h2, NULL, NULL, 0, 0, 0 };
434 if (h1->friend_only != h2->friend_only)
435 friend_only = GNUNET_YES; /* One of the HELLOs is friend only */
437 friend_only = ntohl (h1->friend_only); /* Both HELLO's have the same type */
439 return GNUNET_HELLO_create (&h1->publicKey, &merge_addr, &mc, friend_only);
445 struct GNUNET_TIME_Absolute expiration_limit;
447 GNUNET_HELLO_AddressIterator it;
451 const struct GNUNET_HELLO_Message *old_hello;
456 delta_match (void *cls, const struct GNUNET_HELLO_Address *address,
457 struct GNUNET_TIME_Absolute expiration)
459 struct DeltaContext *dc = cls;
461 struct ExpireContext ec;
463 ec.address = address;
464 ec.found = GNUNET_NO;
465 GNUNET_HELLO_iterate_addresses (dc->old_hello, GNUNET_NO, &get_match_exp,
467 if ((ec.found == GNUNET_YES) &&
468 ((ec.expiration.abs_value_us > expiration.abs_value_us) ||
469 (ec.expiration.abs_value_us >= dc->expiration_limit.abs_value_us)))
470 return GNUNET_YES; /* skip */
471 ret = dc->it (dc->it_cls, address, expiration);
477 * Iterate over addresses in "new_hello" that
478 * are NOT already present in "old_hello".
480 * @param new_hello a HELLO message
481 * @param old_hello a HELLO message
482 * @param expiration_limit ignore addresses in old_hello
483 * that expired before the given time stamp
484 * @param it iterator to call on each address
485 * @param it_cls closure for it
488 GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message
490 const struct GNUNET_HELLO_Message
492 struct GNUNET_TIME_Absolute
494 GNUNET_HELLO_AddressIterator it,
497 struct DeltaContext dc;
499 dc.expiration_limit = expiration_limit;
502 dc.old_hello = old_hello;
503 GNUNET_HELLO_iterate_addresses (new_hello, GNUNET_NO, &delta_match, &dc);
508 * Return the size of the given HELLO message.
509 * @param hello to inspect
510 * @return the size, 0 if HELLO is invalid
513 GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello)
515 uint16_t ret = ntohs (hello->header.size);
517 if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
518 (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
525 * Get the public key from a HELLO message.
527 * @param hello the hello message
528 * @param publicKey where to copy the public key information, can be NULL
529 * @return GNUNET_SYSERR if the HELLO was malformed
532 GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
533 struct GNUNET_CRYPTO_EccPublicKey *publicKey)
535 uint16_t ret = ntohs (hello->header.size);
537 if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
538 (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
539 return GNUNET_SYSERR;
540 *publicKey = hello->publicKey;
546 * Get the peer identity from a HELLO message.
548 * @param hello the hello message
549 * @param peer where to store the peer's identity
550 * @return GNUNET_SYSERR if the HELLO was malformed
553 GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
554 struct GNUNET_PeerIdentity *peer)
556 uint16_t ret = ntohs (hello->header.size);
558 if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
559 (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
560 return GNUNET_SYSERR;
561 GNUNET_CRYPTO_hash (&hello->publicKey,
562 sizeof (struct GNUNET_CRYPTO_EccPublicKey),
569 * Get the header from a HELLO message, used so other code
570 * can correctly send HELLO messages.
572 * @param hello the hello message
574 * @return header or NULL if the HELLO was malformed
576 struct GNUNET_MessageHeader *
577 GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello)
579 uint16_t ret = ntohs (hello->header.size);
581 if ((ret < sizeof (struct GNUNET_HELLO_Message)) ||
582 (ntohs (hello->header.type) != GNUNET_MESSAGE_TYPE_HELLO))
585 return &hello->header;
591 struct GNUNET_TIME_Absolute expiration_limit;
593 struct GNUNET_TIME_Absolute result;
595 const struct GNUNET_HELLO_Message *h2;
597 const struct GNUNET_HELLO_Address *address;
599 struct GNUNET_TIME_Absolute expiration;
607 find_other_matching (void *cls, const struct GNUNET_HELLO_Address *address,
608 struct GNUNET_TIME_Absolute expiration)
610 struct EqualsContext *ec = cls;
612 if (expiration.abs_value_us < ec->expiration_limit.abs_value_us)
614 if (0 == GNUNET_HELLO_address_cmp (address, ec->address))
616 ec->found = GNUNET_YES;
617 if (expiration.abs_value_us < ec->expiration.abs_value_us)
618 ec->result = GNUNET_TIME_absolute_min (expiration, ec->result);
619 return GNUNET_SYSERR;
626 find_matching (void *cls, const struct GNUNET_HELLO_Address *address,
627 struct GNUNET_TIME_Absolute expiration)
629 struct EqualsContext *ec = cls;
631 if (expiration.abs_value_us < ec->expiration_limit.abs_value_us)
633 ec->address = address;
634 ec->expiration = expiration;
635 ec->found = GNUNET_NO;
636 GNUNET_HELLO_iterate_addresses (ec->h2, GNUNET_NO, &find_other_matching, ec);
637 if (ec->found == GNUNET_NO)
639 ec->result = GNUNET_TIME_UNIT_ZERO_ABS;
640 return GNUNET_SYSERR;
647 * Test if two HELLO messages contain the same addresses.
648 * If they only differ in expiration time, the lowest
649 * expiration time larger than 'now' where they differ
652 * @param h1 first HELLO message
653 * @param h2 the second HELLO message
654 * @param now time to use for deciding which addresses have
655 * expired and should not be considered at all
656 * @return absolute time forever if the two HELLOs are
657 * totally identical; smallest timestamp >= now if
658 * they only differ in timestamps;
659 * zero if the some addresses with expirations >= now
660 * do not match at all
662 struct GNUNET_TIME_Absolute
663 GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1,
664 const struct GNUNET_HELLO_Message *h2,
665 struct GNUNET_TIME_Absolute now)
667 struct EqualsContext ec;
669 if (h1->header.type != h2->header.type)
670 return GNUNET_TIME_UNIT_ZERO_ABS;
673 memcmp (&h1->publicKey, &h2->publicKey,
674 sizeof (struct GNUNET_CRYPTO_EccPublicKey)))
675 return GNUNET_TIME_UNIT_ZERO_ABS;
676 ec.expiration_limit = now;
677 ec.result = GNUNET_TIME_UNIT_FOREVER_ABS;
679 GNUNET_HELLO_iterate_addresses (h1, GNUNET_NO, &find_matching, &ec);
680 if (ec.result.abs_value_us == GNUNET_TIME_UNIT_ZERO.rel_value_us)
683 GNUNET_HELLO_iterate_addresses (h2, GNUNET_NO, &find_matching, &ec);
689 find_min_expire (void *cls, const struct GNUNET_HELLO_Address *address,
690 struct GNUNET_TIME_Absolute expiration)
692 struct GNUNET_TIME_Absolute *min = cls;
694 *min = GNUNET_TIME_absolute_min (*min, expiration);
700 * When does the last address in the given HELLO expire?
702 * @param msg HELLO to inspect
703 * @return time the last address expires, 0 if there are no addresses in the HELLO
705 struct GNUNET_TIME_Absolute
706 GNUNET_HELLO_get_last_expiration (const struct GNUNET_HELLO_Message *msg)
708 struct GNUNET_TIME_Absolute ret;
710 ret.abs_value_us = 0;
711 GNUNET_HELLO_iterate_addresses (msg, GNUNET_NO, &find_min_expire, &ret);
716 * GNUnet URIs are of the general form "gnunet://MODULE/IDENTIFIER".
717 * The specific structure of "IDENTIFIER" depends on the module and
718 * maybe differenciated into additional subcategories if applicable.
719 * This module only deals with hello identifiers (MODULE = "hello").
722 * The concrete URI format is:
724 * "gnunet://hello/PEER[!YYYYMMDDHHMMSS!<TYPE>!<ADDRESS>]...".
725 * These URIs can be used to add a peer record to peerinfo service.
726 * PEER is the string representation of peer's public key.
727 * YYYYMMDDHHMMSS is the expiration date.
728 * TYPE is a transport type.
729 * ADDRESS is the address, its format depends upon the transport type.
730 * The concrete transport types and corresponding address formats are:
734 * <TCP|UDP>!IPADDRESS
735 * IPVDDRESS is either IPV4 .-delimited address in form of XXX.XXX.XXX.XXX:PPPPP
736 * or IPV6 :-delimited address, but with '(' and ')' instead of '[' and ']' (RFC2396 advises against using square brackets in URIs):
737 * (XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX):PPPPP
738 * PPPPP is the port number. May be 0.
742 * [add SMTP, HTTP and other addresses here]
746 * The encoding for hexadecimal values is defined in the crypto_hash.c
747 * module in the gnunetutil library and discussed there.
751 * gnunet://hello/0430205UC7D56PTQK8NV05776671CNN44FK4TL6D0GQ35OMF8MEN4RNMKA5UF6AL3DQO8B1SC5AQF50SQ2MABIRU4HC8H2HAJKJ59JL1JVRJAK308F9GASRFLMGUBB5TQ5AKR94AS5T3MDG8B9O1EMPRKB0HVCG7T6QPP4CDJ913LAEHVJ2DI1TOBB15Q1JIT5ARBOD12U4SIGRFDV3Q7T66G4TBVSJJ90UQF1BG29TGJJKLGEIMSPHHKO544D6EALQ4F2K0416311JC22GVAD48R616I7VK03K7MP7N0RS2MBV1TE9JV8CK1LSQMR7KCDRTLDA6917UGA67DHTGHERIACCGQ54TGSR48RMSGS9BA5HLMOKASFC1I6V4TT09TUGCU8GNDHQF0JF3H7LPV59UL5I38QID040G000!20120302010059!TCP!192.168.0.1:2086!TCP!64.23.8.174:0
752 * gnunet://hello/0430205UC7D56PTQK8NV05776671CNN44FK4TL6D0GQ35OMF8MEN4RNMKA5UF6AL3DQO8B1SC5AQF50SQ2MABIRU4HC8H2HAJKJ59JL1JVRJAK308F9GASRFLMGUBB5TQ5AKR94AS5T3MDG8B9O1EMPRKB0HVCG7T6QPP4CDJ913LAEHVJ2DI1TOBB15Q1JIT5ARBOD12U4SIGRFDV3Q7T66G4TBVSJJ90UQF1BG29TGJJKLGEIMSPHHKO544D6EALQ4F2K0416311JC22GVAD48R616I7VK03K7MP7N0RS2MBV1TE9JV8CK1LSQMR7KCDRTLDA6917UGA67DHTGHERIACCGQ54TGSR48RMSGS9BA5HLMOKASFC1I6V4TT09TUGCU8GNDHQF0JF3H7LPV59UL5I38QID040G000!20120302010059!TCP!(2001:db8:85a3:8d3:1319:8a2e:370:7348):2086
758 /* ************************* Compose HELLO URI ************************** */
762 * Replace all characters in the input 'in' according
763 * to the mapping. The mapping says to map each character
764 * in 'oldchars' to the corresponding character (by offset)
767 * @param in input string to remap
768 * @param oldchars characters to replace
769 * @param newchars replacement characters, must have same length as 'oldchars'
770 * @return copy of string with replacement applied.
773 map_characters (const char *in,
774 const char *oldchars,
775 const char *newchars)
781 GNUNET_assert (strlen (oldchars) == strlen (newchars));
782 ret = GNUNET_strdup (in);
784 while (ret[i] != '\0')
786 off = strchr (oldchars, ret[i]);
788 ret[i] = newchars[off - oldchars];
796 * Function that is called on each address of this peer.
797 * Expands the corresponding URI string.
799 * @param cls the 'GNUNET_HELLO_GetUriContext'
800 * @param address address to add
801 * @param expiration expiration time for the address
802 * @return GNUNET_OK (continue iteration).
805 add_address_to_uri (void *cls, const struct GNUNET_HELLO_Address *address,
806 struct GNUNET_TIME_Absolute expiration)
808 struct GNUNET_HELLO_ComposeUriContext *ctx = cls;
809 struct GNUNET_TRANSPORT_PluginFunctions *papi;
816 char *client_str = "_client";
820 papi = ctx->plugins_find (address->transport_name);
823 /* Not an error - we might just not have the right plugin. */
826 if (NULL == papi->address_to_string)
828 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
829 "URI conversion not implemented for plugin `%s'\n",
830 address->transport_name);
833 addr = papi->address_to_string (papi->cls, address->address, address->address_length);
835 if ( (addr == NULL) || (strlen(addr) == 0) )
838 addr_dup = GNUNET_strdup (addr);
839 if (NULL != (pos = strstr (addr_dup, "_server")))
840 memcpy (pos, client_str, strlen(client_str)); /* Replace all server addresses with client addresses */
842 /* For URIs we use '(' and ')' instead of '[' and ']' as brackets are reserved
843 characters in URIs */
844 uri_addr = map_characters (addr_dup, "[]", "()");
845 GNUNET_free (addr_dup);
846 seconds = expiration.abs_value_us / 1000LL / 1000LL;
847 t = gmtime (&seconds);
849 GNUNET_asprintf (&ret,
852 strftime (tbuf, sizeof (tbuf), "%Y%m%d%H%M%S", t) ? tbuf : "0",
853 address->transport_name,
855 GNUNET_free (uri_addr);
856 GNUNET_free (ctx->uri);
863 * Compose a hello URI string from a hello message.
865 * @param hello Hello message
866 * @param plugins_find Function to find transport plugins by name
867 * @return Hello URI string
870 GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
871 GNUNET_HELLO_TransportPluginsFind plugins_find)
873 struct GNUNET_HELLO_ComposeUriContext ctx;
874 ctx.plugins_find = plugins_find;
876 char *pkey = GNUNET_CRYPTO_ecc_public_key_to_string (&(hello->publicKey));
878 GNUNET_asprintf (&(ctx.uri),
880 (GNUNET_YES == GNUNET_HELLO_is_friend_only (hello)) ? GNUNET_FRIEND_HELLO_URI_PREFIX : GNUNET_HELLO_URI_PREFIX,
884 GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &add_address_to_uri, &ctx);
889 /* ************************* Parse HELLO URI ********************* */
893 * We're building a HELLO. Parse the next address from the
894 * parsing context and append it.
896 * @param cls the 'struct GNUNET_HELLO_AddressParsingContext'
897 * @param max number of bytes available for HELLO construction
898 * @param buffer where to copy the next address (in binary format)
899 * @return number of bytes added to buffer
902 add_address_to_hello (void *cls, size_t max, void *buffer)
904 struct GNUNET_HELLO_ParseUriContext *ctx = cls;
908 char *plugin_address;
911 struct tm expiration_time;
912 time_t expiration_seconds;
913 struct GNUNET_TIME_Absolute expire;
914 struct GNUNET_TRANSPORT_PluginFunctions *papi;
917 struct GNUNET_HELLO_Address haddr;
920 if (NULL == ctx->pos)
922 if ('!' != ctx->pos[0])
924 ctx->ret = GNUNET_SYSERR;
930 if ('0' == ctx->pos[0] && '!' == ctx->pos[1])
932 expire = GNUNET_TIME_UNIT_FOREVER_ABS;
933 tname = ctx->pos + 1;
937 memset (&expiration_time, 0, sizeof (expiration_time));
938 tname = strptime (ctx->pos,
943 ctx->ret = GNUNET_SYSERR;
944 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
945 _("Failed to parse HELLO message: missing expiration time\n"));
950 expiration_seconds = mktime (&expiration_time);
951 if (expiration_seconds == (time_t) -1)
953 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
954 _("Failed to parse HELLO message: invalid expiration time\n"));
955 ctx->ret = GNUNET_SYSERR;
959 expire.abs_value_us = expiration_seconds * 1000LL * 1000LL;
963 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
964 _("Failed to parse HELLO message: malformed\n"));
965 ctx->ret = GNUNET_SYSERR;
970 address = strchr (tname, (int) '!');
973 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
974 _("Failed to parse HELLO message: missing transport plugin\n"));
975 ctx->ret = GNUNET_SYSERR;
980 end = strchr (address, (int) '!');
982 plugin_name = GNUNET_strndup (tname, address - (tname+1));
983 papi = ctx->plugins_find (plugin_name);
986 /* Not an error - we might just not have the right plugin.
987 * Skip this part, advance to the next one and recurse.
988 * But only if this is not the end of string.
990 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
991 _("Plugin `%s' not found\n"),
993 GNUNET_free (plugin_name);
997 if (NULL == papi->string_to_address)
999 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1000 _("Plugin `%s' does not support URIs yet\n"),
1002 GNUNET_free (plugin_name);
1006 uri_address = GNUNET_strndup (address, end - address);
1007 /* For URIs we use '(' and ')' instead of '[' and ']' as brackets are reserved
1008 characters in URIs; need to convert back to '[]' for the plugin */
1009 plugin_address = map_characters (uri_address, "()", "[]");
1010 GNUNET_free (uri_address);
1012 papi->string_to_address (papi->cls,
1014 strlen (plugin_address) + 1,
1018 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1019 _("Failed to parse `%s' as an address for plugin `%s'\n"),
1022 GNUNET_free (plugin_name);
1023 GNUNET_free (plugin_address);
1026 GNUNET_free (plugin_address);
1027 /* address.peer is unset - not used by add_address() */
1028 haddr.address_length = addr_len;
1029 haddr.address = addr;
1030 haddr.transport_name = plugin_name;
1031 ret = GNUNET_HELLO_add_address (&haddr, expire, buffer, max);
1033 GNUNET_free (plugin_name);
1039 * Parse a hello URI string to a hello message.
1041 * @param uri URI string to parse
1042 * @param pubkey Pointer to struct where public key is parsed
1043 * @param hello Pointer to struct where hello message is parsed
1044 * @param plugins_find Function to find transport plugins by name
1045 * @return GNUNET_OK on success, GNUNET_SYSERR if the URI was invalid, GNUNET_NO on other errors
1048 GNUNET_HELLO_parse_uri (const char *uri,
1049 struct GNUNET_CRYPTO_EccPublicKey *pubkey,
1050 struct GNUNET_HELLO_Message **hello,
1051 GNUNET_HELLO_TransportPluginsFind plugins_find)
1056 struct GNUNET_HELLO_ParseUriContext ctx;
1058 if (0 == strncmp (uri,
1059 GNUNET_HELLO_URI_PREFIX,
1060 strlen (GNUNET_HELLO_URI_PREFIX)))
1062 pks = &uri[strlen (GNUNET_HELLO_URI_PREFIX)];
1063 friend_only = GNUNET_NO;
1065 else if (0 == strncmp (uri,
1066 GNUNET_FRIEND_HELLO_URI_PREFIX,
1067 strlen (GNUNET_FRIEND_HELLO_URI_PREFIX)))
1069 pks = &uri[strlen (GNUNET_FRIEND_HELLO_URI_PREFIX)];
1070 friend_only = GNUNET_YES;
1073 return GNUNET_SYSERR;
1074 exc = strstr (pks, "!");
1077 GNUNET_STRINGS_string_to_data (pks,
1078 (NULL == exc) ? strlen (pks) : (exc - pks),
1079 (unsigned char *) pubkey,
1081 return GNUNET_SYSERR;
1084 ctx.ret = GNUNET_OK;
1085 ctx.plugins_find = plugins_find;
1086 *hello = GNUNET_HELLO_create (pubkey, &add_address_to_hello, &ctx, friend_only);
1092 /* end of hello.c */