X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_hello_lib.h;h=867ff686d0d14d785cecc6b253cc678b01165781;hb=6973ade884b8e22e7fcaa51a90d00a8caa2d2fa4;hp=4e8554b52b42f7b0d0c182f6e263331f62c87fb8;hpb=ea3ff01740cdfd4505503bcff9f5d889ce1b4545;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h index 4e8554b52..867ff686d 100644 --- a/src/include/gnunet_hello_lib.h +++ b/src/include/gnunet_hello_lib.h @@ -39,6 +39,12 @@ extern "C" #include "gnunet_crypto_lib.h" +/** + * Prefix that every HELLO URI must start with. + */ +#define GNUNET_HELLO_URI_PREFIX "gnunet://hello/" + + /** * An address for communicating with a peer. We frequently * need this tuple and the components cannot really be @@ -50,7 +56,7 @@ struct GNUNET_HELLO_Address /** * For which peer is this an address? - */ + */ struct GNUNET_PeerIdentity peer; /** @@ -83,14 +89,45 @@ struct GNUNET_HELLO_Address */ 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); + + +/** + * Copy an address struct. + * + * @param address address to copy + * @return a copy of the address struct + */ +struct GNUNET_HELLO_Address * +GNUNET_HELLO_address_copy (const struct GNUNET_HELLO_Address *address); +/** + * Compare two addresses. Does NOT compare the peer identity, + * that is assumed already to match! + * + * @param a1 first address + * @param a2 second address + * @return 0 if the addresses are equal, -1 if a1a2. + */ +int +GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1, + const struct GNUNET_HELLO_Address *a2); + + +/** + * Get the size of an address struct. + * + * @param address address + * @return the size + */ +size_t +GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address); + /** * Free an address. - * + * * @param addr address to free */ #define GNUNET_HELLO_address_free(addr) GNUNET_free(addr) @@ -109,19 +146,16 @@ struct GNUNET_HELLO_Message; * Copy the given address information into * the given buffer using the format of HELLOs. * - * @param tname name of the transport plugin + * @param address address to add * @param expiration expiration for the address - * @param addr the address - * @param addr_len length of the address in bytes * @param target where to copy the address * @param max maximum number of bytes to copy to target * @return number of bytes copied, 0 if * the target buffer was not big enough. */ size_t -GNUNET_HELLO_add_address (const char *tname, - struct GNUNET_TIME_Absolute expiration, - const void *addr, uint16_t addr_len, char *target, +GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address, + struct GNUNET_TIME_Absolute expiration, char *target, size_t max); @@ -149,7 +183,7 @@ typedef size_t (*GNUNET_HELLO_GenerateAddressListCallback) (void *cls, * @return the hello message */ struct GNUNET_HELLO_Message * -GNUNET_HELLO_create (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded +GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded *publicKey, GNUNET_HELLO_GenerateAddressListCallback addrgen, void *addrgen_cls); @@ -204,18 +238,17 @@ GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1, * Iterator callback to go over all addresses. * * @param cls closure - * @param tname name of the transport + * @param address the address * @param expiration expiration time - * @param addr the address - * @param addrlen length of the 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 char *tname, +typedef int (*GNUNET_HELLO_AddressIterator) (void *cls, + const struct GNUNET_HELLO_Address * + address, struct GNUNET_TIME_Absolute - expiration, const void *addr, - uint16_t addrlen); + expiration); /** @@ -277,7 +310,7 @@ GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message */ int GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello, - struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded + struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded *publicKey); @@ -304,6 +337,45 @@ GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello, struct GNUNET_MessageHeader * GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello); + +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_EccPublicKeyBinaryEncoded *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 */