gnunet_hello_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010, 2011 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_HELLO_LIB_H
#define GNUNET_HELLO_LIB_H
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
 
#define GNUNET_HELLO_URI_PREFIX "gnunet://hello/"
 
#define GNUNET_FRIEND_HELLO_URI_PREFIX "gnunet://friend-hello/"
 
#define GNUNET_HELLO_URI_SEP '+'
 
 
enum GNUNET_HELLO_AddressInfo
{
  GNUNET_HELLO_ADDRESS_INFO_NONE = 0,
 
  GNUNET_HELLO_ADDRESS_INFO_INBOUND = 1
};
 
 
struct GNUNET_HELLO_Address
{
  struct GNUNET_PeerIdentity peer;
 
  const char *transport_name;
 
  const void *address;
 
  size_t address_length;
 
  enum GNUNET_HELLO_AddressInfo local_info;
};
 
 
struct GNUNET_HELLO_Address *
GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
                               const char *transport_name,
                               const void *address,
                               size_t address_length,
                               enum GNUNET_HELLO_AddressInfo local_info);
 
 
struct GNUNET_HELLO_Address *
GNUNET_HELLO_address_copy (const struct GNUNET_HELLO_Address *address);
 
 
int
GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
                          const struct GNUNET_HELLO_Address *a2);
 
 
size_t
GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address);
 
 
int
GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address *address,
                                   enum GNUNET_HELLO_AddressInfo option);
 
 
#define GNUNET_HELLO_address_free(addr) GNUNET_free (addr)
 
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_HELLO_Message
{
  struct GNUNET_MessageHeader header;
 
  uint32_t friend_only GNUNET_PACKED;
 
  struct GNUNET_CRYPTO_EddsaPublicKey publicKey;
};
GNUNET_NETWORK_STRUCT_END
 
 
int
GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h);
 
 
size_t
GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
                          struct GNUNET_TIME_Absolute expiration,
                          char *target,
                          size_t max);
 
 
typedef ssize_t
(*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
                                             size_t max,
                                             void *buf);
 
 
struct GNUNET_HELLO_Message *
GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EddsaPublicKey *public_key,
                     GNUNET_HELLO_GenerateAddressListCallback addrgen,
                     void *addrgen_cls,
                     int friend_only);
 
 
uint16_t
GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello);
 
 
struct GNUNET_HELLO_Message *
GNUNET_HELLO_merge (const struct GNUNET_HELLO_Message *h1,
                    const struct GNUNET_HELLO_Message *h2);
 
 
struct GNUNET_TIME_Absolute
GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1,
                     const struct GNUNET_HELLO_Message *h2,
                     struct GNUNET_TIME_Absolute now);
 
 
typedef int (*GNUNET_HELLO_AddressIterator) (
  void *cls,
  const struct GNUNET_HELLO_Address *address,
  struct GNUNET_TIME_Absolute expiration);
 
 
struct GNUNET_TIME_Absolute
GNUNET_HELLO_get_last_expiration (const struct GNUNET_HELLO_Message *msg);
 
 
struct GNUNET_HELLO_Message *
GNUNET_HELLO_iterate_addresses (const struct GNUNET_HELLO_Message *msg,
                                int return_modified,
                                GNUNET_HELLO_AddressIterator it,
                                void *it_cls);
 
 
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_AddressIterator it,
  void *it_cls);
 
 
int
GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
                     struct GNUNET_PeerIdentity *peer);
 
 
struct GNUNET_MessageHeader *
GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
 
 
typedef struct GNUNET_TRANSPORT_PluginFunctions *(
*GNUNET_HELLO_TransportPluginsFind) (const char *name);
 
 
char *
GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
                          GNUNET_HELLO_TransportPluginsFind plugins_find);
 
 
int
GNUNET_HELLO_parse_uri (const char *uri,
                        struct GNUNET_CRYPTO_EddsaPublicKey *pubkey,
                        struct GNUNET_HELLO_Message **hello,
                        GNUNET_HELLO_TransportPluginsFind plugins_find);
 
 
/* NG API */
#include "gnunet_nt_lib.h"
 
 
void
GNUNET_HELLO_sign_address (
  const char *address,
  enum GNUNET_NetworkType nt,
  struct GNUNET_TIME_Absolute mono_time,
  const struct GNUNET_CRYPTO_EddsaPrivateKey *private_key,
  void **result,
  size_t *result_size);
 
 
char *
GNUNET_HELLO_extract_address (const void *raw,
                              size_t raw_size,
                              const struct GNUNET_PeerIdentity *pid,
                              enum GNUNET_NetworkType *nt,
                              struct GNUNET_TIME_Absolute *mono_time);
 
 
char *
GNUNET_HELLO_address_to_prefix (const char *address);
 
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_HELLO_LIB_H */
#endif
 /* end of group */
 /* end of group addition */
 
/* end of gnunet_hello_lib.h */