/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010, 2011 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
#endif
#endif
-#include "gnunet_common.h"
-#include "gnunet_crypto_lib.h"
+#include "gnunet_util_lib.h"
+
+
+/**
+ * Prefix that every HELLO URI must start with.
+ */
+#define GNUNET_HELLO_URI_PREFIX "gnunet://hello/"
+
+/**
+ * Prefix that every FRIEND HELLO URI must start with.
+ */
+#define GNUNET_FRIEND_HELLO_URI_PREFIX "gnunet://friend-hello/"
+
+/**
+ * Separator used in HELLO URI
+ */
+#define GNUNET_HELLO_URI_SEP '+'
+
+
+/**
+ * Additional local information about an address
+ *
+ * These information are only valid for the local peer and are not serialized
+ * when a #GNUNET_HELLO_Message is created
+ */
+enum GNUNET_HELLO_AddressInfo
+{
+ /**
+ * No additional information
+ */
+ GNUNET_HELLO_ADDRESS_INFO_NONE = 0,
+
+ /**
+ * This is an inbound address and cannot be used to initiate an outbound
+ * connection to another peer
+ */
+ GNUNET_HELLO_ADDRESS_INFO_INBOUND = 1
+};
/**
/**
* For which peer is this an address?
- */
+ */
struct GNUNET_PeerIdentity peer;
/**
const void *address;
/**
- * Number of bytes in 'address'.
+ * Number of bytes in @e address.
*/
size_t address_length;
+ /**
+ * Extended information about address
+ *
+ * This field contains additional #GNUNET_HELLO_AddressInfo flags e.g.
+ * to indicate an address is inbound and cannot be used to initiate an
+ * outbound connection.
+ *
+ * These information are only valid for the local peer and are not serialized
+ * when a #GNUNET_HELLO_Message is created
+ */
+ enum GNUNET_HELLO_AddressInfo local_info;
+
};
* @param peer the peer
* @param transport_name plugin name
* @param address binary address
- * @param address_length number of bytes in 'address'
+ * @param address_length number of bytes in @a address
+ * @param local_info additional local information for the address
* @return the address struct
*/
struct GNUNET_HELLO_Address *
GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
- const char *transport_name,
- const void *address,
- size_t address_length);
+ const char *transport_name,
+ const void *address,
+ size_t address_length,
+ enum GNUNET_HELLO_AddressInfo local_info);
/**
*
* @param a1 first address
* @param a2 second address
- * @return 0 if the addresses are equal, -1 if a1<a2, 1 if a1>a2.
+ * @return 0 if the addresses are equal, -1 if @a a1< @a a2, 1 if @a a1> @a a2.
*/
int
GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
- const struct GNUNET_HELLO_Address *a2);
+ const struct GNUNET_HELLO_Address *a2);
/**
size_t
GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address);
+
+/**
+ * Check if an address has a local option set
+ *
+ * @param address the address to check
+ * @param option the respective option to check for
+ * @return #GNUNET_YES or #GNUNET_NO
+ */
+int
+GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address *address,
+ enum GNUNET_HELLO_AddressInfo option);
+
+
/**
* Free an address.
- *
+ *
* @param addr address to free
*/
#define GNUNET_HELLO_address_free(addr) GNUNET_free(addr)
/**
* A HELLO message is used to exchange information about
* transports with other peers. This struct is guaranteed
- * to start with a "GNUNET_MessageHeader", everything else
+ * to start with a `struct GNUNET_MessageHeader`, everything else
* should be internal to the HELLO library.
*/
struct GNUNET_HELLO_Message;
+/**
+ * Return HELLO type
+ *
+ * @param h HELLO Message to test
+ * @return #GNUNET_YES or #GNUNET_NO
+ */
+int
+GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h);
+
+
/**
* Copy the given address information into
* the given buffer using the format of HELLOs.
* @param address address to add
* @param expiration expiration for the address
* @param target where to copy the address
- * @param max maximum number of bytes to copy to target
+ * @param max maximum number of bytes to copy to @a target
* @return number of bytes copied, 0 if
* the target buffer was not big enough.
*/
/**
* Callback function used to fill a buffer of max bytes with a list of
* addresses in the format used by HELLOs. Should use
- * "GNUNET_HELLO_add_address" as a helper function.
+ * #GNUNET_HELLO_add_address() as a helper function.
*
* @param cls closure
- * @param max maximum number of bytes that can be written to buf
+ * @param max maximum number of bytes that can be written to @a buf
* @param buf where to write the address information
- * @return number of bytes written, 0 to signal the
+ * @return number of bytes written or 0, #GNUNET_SYSERR to signal the
* end of the iteration.
*/
-typedef size_t (*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
- size_t max,
- void *buf);
+typedef ssize_t
+(*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
+ size_t max,
+ void *buf);
/**
* expiration time and an iterator that spews the
* transport addresses.
*
+ * If friend only is set to #GNUNET_YES we create a FRIEND_HELLO which
+ * will not be gossiped to other peers.
+ *
+ * @param publicKey public key to include in the HELLO
+ * @param addrgen callback to invoke to get addresses
+ * @param addrgen_cls closure for @a addrgen
+ * @param friend_only should the returned HELLO be only visible to friends?
* @return the hello message
*/
struct GNUNET_HELLO_Message *
-GNUNET_HELLO_create (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
- *publicKey,
+GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EddsaPublicKey *publicKey,
GNUNET_HELLO_GenerateAddressListCallback addrgen,
- void *addrgen_cls);
+ void *addrgen_cls,
+ int friend_only);
/**
* Return the size of the given HELLO message.
+ *
* @param hello to inspect
* @return the size, 0 if HELLO is invalid
*/
* @param cls closure
* @param address the address
* @param expiration expiration time
- * @return GNUNET_OK to keep the address,
- * GNUNET_NO to delete it from the HELLO
- * GNUNET_SYSERR to stop iterating (but keep current address)
+ * @return #GNUNET_OK to keep the address,
+ * #GNUNET_NO to delete it from the HELLO
+ * #GNUNET_SYSERR to stop iterating (but keep current address)
*/
-typedef int (*GNUNET_HELLO_AddressIterator) (void *cls,
- const struct GNUNET_HELLO_Address *address,
- struct GNUNET_TIME_Absolute expiration);
+typedef int
+(*GNUNET_HELLO_AddressIterator) (void *cls,
+ const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_TIME_Absolute expiration);
/**
* @param return_modified if a modified copy should be returned,
* otherwise NULL will be returned
* @param it iterator to call on each address
- * @param it_cls closure for it
+ * @param it_cls closure for @a it
* @return the modified HELLO or NULL
*/
struct GNUNET_HELLO_Message *
* @param expiration_limit ignore addresses in old_hello
* that expired before the given time stamp
* @param it iterator to call on each address
- * @param it_cls closure for it
+ * @param it_cls closure for @a it
*/
void
-GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message
- *new_hello,
- const struct GNUNET_HELLO_Message
- *old_hello,
- struct GNUNET_TIME_Absolute
- expiration_limit,
+GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message *new_hello,
+ const struct GNUNET_HELLO_Message *old_hello,
+ struct GNUNET_TIME_Absolute expiration_limit,
GNUNET_HELLO_AddressIterator it,
void *it_cls);
*
* @param hello the hello message
* @param publicKey where to copy the public key information, can be NULL
- * @return GNUNET_SYSERR if the HELLO was malformed
+ * @return #GNUNET_SYSERR if the HELLO was malformed
*/
int
GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
- *publicKey);
+ struct GNUNET_CRYPTO_EddsaPublicKey *publicKey);
/**
*
* @param hello the hello message
* @param peer where to store the peer's identity
- * @return GNUNET_SYSERR if the HELLO was malformed
+ * @return #GNUNET_SYSERR if the HELLO was malformed
*/
int
GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
struct GNUNET_MessageHeader *
GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
+
+/**
+ * FIXME.
+ *
+ * @param name
+ */
+typedef struct GNUNET_TRANSPORT_PluginFunctions *
+(*GNUNET_HELLO_TransportPluginsFind) (const char *name);
+
+
+/**
+ * Compose a hello URI string from a hello message.
+ *
+ * @param hello Hello message
+ * @param plugins_find Function to find transport plugins by name
+ * @return Hello URI string
+ */
+char *
+GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
+ GNUNET_HELLO_TransportPluginsFind plugins_find);
+
+
+/**
+ * Parse a hello URI string to a hello message.
+ *
+ * @param uri URI string to parse
+ * @param pubkey Pointer to struct where public key is parsed
+ * @param hello Pointer to struct where hello message is parsed
+ * @param plugins_find Function to find transport plugins by name
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the URI was invalid, #GNUNET_NO on other errors
+ */
+int
+GNUNET_HELLO_parse_uri (const char *uri,
+ struct GNUNET_CRYPTO_EddsaPublicKey *pubkey,
+ struct GNUNET_HELLO_Message **hello,
+ GNUNET_HELLO_TransportPluginsFind plugins_find);
+
+#if 0 /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+
/* ifndef GNUNET_HELLO_LIB_H */
#endif
/* end of gnunet_hello_lib.h */
projects / oweals / gnunet.git / blobdiff