helper library for handling URI-based HELLOs More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_signatures.h"
#include "gnunet_hello_uri_lib.h"
#include "gnunet_protocols.h"

Include dependency graph for hello-uri.c:

Data Structures
struct	SignedAddress
	Binary block we sign when we sign an address. More...

struct	HelloSignaturePurpose
	Message signed as part of a HELLO block/URL. More...

struct	HelloUriMessage
	Message used when gossiping HELLOs between peers. More...

struct	BlockHeader
	Start of a 'block'. More...

struct	DhtHelloMessage
	Message used when a DHT provides its HELLO to direct neighbours. More...

struct	Address
	Address of a peer. More...

struct	GNUNET_HELLO_Builder
	Context for building (or parsing) HELLO URIs. More...

struct	AddressUriMergeResult
	Struct to wrap data to do the merge of to hello uris. More...

struct	GNUNET_HELLO_Parser
	Context for parsing HELLOs. More...

Functions
static void	hash_addresses (const struct Address a_head, struct GNUNET_HashCode hash)
	Compute hash over addresses in builder. More...

static void	sign_hello (const struct GNUNET_HELLO_Builder builder, struct GNUNET_TIME_Absolute et, const struct GNUNET_CRYPTO_EddsaPrivateKey priv, struct GNUNET_CRYPTO_EddsaSignature *sig)
	Create HELLO signature. More...

static enum GNUNET_GenericReturnValue	verify_hello (const struct GNUNET_HELLO_Parser parser, struct GNUNET_TIME_Absolute et, const struct GNUNET_CRYPTO_EddsaSignature sig)
	Verify HELLO signature. More...

static struct GNUNET_HELLO_Parser *	parser_new (const struct GNUNET_PeerIdentity *pid)

struct GNUNET_HELLO_Builder *	GNUNET_HELLO_builder_new (const struct GNUNET_PeerIdentity *pid)
	Allocate builder. More...

const struct GNUNET_PeerIdentity *	GNUNET_HELLO_parser_get_id (const struct GNUNET_HELLO_Parser *parser)
	Get the PeerIdentity for this builder. More...

struct GNUNET_HELLO_Builder *	GNUNET_HELLO_builder_from_parser (const struct GNUNET_HELLO_Parser *p)
	Allocate builder from parser. More...

void	GNUNET_HELLO_parser_free (struct GNUNET_HELLO_Parser *parser)
	Release resources of a builder. More...

void	GNUNET_HELLO_builder_free (struct GNUNET_HELLO_Builder *builder)
	Release resources of a builder. More...

struct GNUNET_HELLO_Parser *	GNUNET_HELLO_parser_from_msg (const struct GNUNET_MessageHeader *msg)
	Parse msg. More...

static enum GNUNET_GenericReturnValue	check_address (const char *address)

static enum GNUNET_GenericReturnValue	parser_add_address (struct GNUNET_HELLO_Parser parser, const char address)

struct GNUNET_HELLO_Parser *	GNUNET_HELLO_parser_from_block (const void *block, size_t block_size)
	Parse block. More...

struct GNUNET_TIME_Absolute	GNUNET_HELLO_get_expiration_time_from_msg (const struct GNUNET_MessageHeader *msg)
	Get the expiration time for this HELLO. More...

enum GNUNET_GenericReturnValue	GNUNET_HELLO_builder_add_address (struct GNUNET_HELLO_Builder builder, const char address)
	Add individual address to the builder. More...

struct GNUNET_HELLO_Parser *	GNUNET_HELLO_parser_from_url (const char *url)
	Parse GNUnet HELLO url. More...

struct GNUNET_MessageHeader *	GNUNET_HELLO_builder_to_dht_hello_msg (const struct GNUNET_HELLO_Builder builder, const struct GNUNET_CRYPTO_EddsaPrivateKey priv, struct GNUNET_TIME_Relative expiration_time)
	Generate DHT HELLO message (without peer ID) from a builder. More...

char *	GNUNET_HELLO_builder_to_url2 (const struct GNUNET_HELLO_Builder builder, const struct GNUNET_CRYPTO_EddsaPrivateKey priv, struct GNUNET_TIME_Relative validity)
	Generate GNUnet HELLO URI from a builder. More...

char *	GNUNET_HELLO_parser_to_url (const struct GNUNET_HELLO_Parser *parser)
	Generate GNUnet HELLO URI from a parser. More...

char *	GNUNET_HELLO_builder_to_url (const struct GNUNET_HELLO_Builder builder, const struct GNUNET_CRYPTO_EddsaPrivateKey priv)
	Generate GNUnet HELLO URI from a builder. More...

enum GNUNET_GenericReturnValue	GNUNET_HELLO_builder_to_block (const struct GNUNET_HELLO_Builder builder, const struct GNUNET_CRYPTO_EddsaPrivateKey priv, void block, size_t block_size, struct GNUNET_TIME_Relative expiration_time)
	Generate DHT block from a builder. More...

enum GNUNET_GenericReturnValue	GNUNET_HELLO_parser_to_block (const struct GNUNET_HELLO_Parser parser, void block, size_t *block_size)
	Generate DHT block from a parser. More...

struct GNUNET_MQ_Envelope *	GNUNET_HELLO_parser_to_env (const struct GNUNET_HELLO_Parser *parser)
	Generate envelope with GNUnet HELLO message (including peer ID) from a parser. More...

static struct GNUNET_MQ_Envelope *	GNUNET_HELLO_builder_to_env_ (const struct GNUNET_HELLO_Builder builder, const struct GNUNET_CRYPTO_EddsaPrivateKey priv, struct GNUNET_TIME_Relative expiration_time, const struct GNUNET_CRYPTO_EddsaSignature *sig)

struct GNUNET_MQ_Envelope *	GNUNET_HELLO_builder_to_env (const struct GNUNET_HELLO_Builder builder, const struct GNUNET_CRYPTO_EddsaPrivateKey priv, struct GNUNET_TIME_Relative expiration_time)
	Generate envelope with GNUnet HELLO message (including peer ID) from a builder. More...

enum GNUNET_GenericReturnValue	GNUNET_HELLO_builder_del_address (struct GNUNET_HELLO_Builder builder, const char address)
	Remove individual address from the builder. More...

const struct GNUNET_PeerIdentity *	GNUNET_HELLO_parser_iterate (const struct GNUNET_HELLO_Parser parser, GNUNET_HELLO_UriCallback uc, void uc_cls)
	Iterate over URIs in a parser. More...

enum GNUNET_GenericReturnValue	GNUNET_HELLO_dht_msg_to_block (const struct GNUNET_MessageHeader hello, const struct GNUNET_PeerIdentity pid, void *block, size_t block_size, struct GNUNET_TIME_Absolute *block_expiration)
	Convert a DHT hello message to a HELLO block. More...

char *	GNUNET_HELLO_address_to_prefix (const char *address)
	Given an address as a string, extract the prefix that identifies the communicator offering transmissions to that address. More...

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)
	Build address record by signing raw information with private key. More...

Detailed Description

helper library for handling URI-based HELLOs

Author: Christian Grothoff

Note:

Current API does not support deserializing HELLO of another peer and then serializing it into another format (we always require the private key). Not sure if we need this, but if we do, we need to extend the builder and the API.
Current API does not allow overriding the default HELLO expiration time. We may want to add a function that does this to create bootstrap HELLOs shipped with the TGZ.

Definition in file hello-uri.c.

Function Documentation

◆ hash_addresses()

static void hash_addresses	(	const struct Address *	a_head,
		struct GNUNET_HashCode *	hash
	)

static

Compute hash over addresses in builder.

Parameters

	builder	the builder to hash addresses of
[out]	hash	where to write the hash

Definition at line 297 of file hello-uri.c.

{
  struct GNUNET_HashContext *hc;
 
  hc = GNUNET_CRYPTO_hash_context_start ();
  for (const struct Address *a = a_head;
       NULL != a;
       a = a->next)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Hashing over %.*s\n",
                (int) a->uri_len,
                a->uri);
    GNUNET_CRYPTO_hash_context_read (hc,
                                     a->uri,
                                     a->uri_len);
  }
  GNUNET_CRYPTO_hash_context_finish (hc,
                                     hash);
 
}

References a_head, GNUNET_CRYPTO_hash_context_finish(), GNUNET_CRYPTO_hash_context_read(), GNUNET_CRYPTO_hash_context_start(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, and MyAddress::next.

Referenced by sign_hello(), and verify_hello().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sign_hello()

static void sign_hello	(	const struct GNUNET_HELLO_Builder *	builder,
		struct GNUNET_TIME_Absolute	et,
		const struct GNUNET_CRYPTO_EddsaPrivateKey *	priv,
		struct GNUNET_CRYPTO_EddsaSignature *	sig
	)

static

Create HELLO signature.

Parameters

	builder	the builder to use
	et	expiration time to sign
	priv	key to sign with
[out]	sig	where to write the signature

Definition at line 330 of file hello-uri.c.

{
  struct HelloSignaturePurpose hsp = {
    .purpose.size = htonl (sizeof (hsp)),
    .purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_HELLO),
    .expiration_time = GNUNET_TIME_absolute_hton (et)
  };
 
  hash_addresses (builder->a_head,
                  &hsp.h_addrs);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Address hash is %s\n",
              GNUNET_h2s_full (&hsp.h_addrs));
  GNUNET_CRYPTO_eddsa_sign (priv,
                            &hsp,
                            sig);
}

References builder, GNUNET_CRYPTO_eddsa_sign, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s_full(), GNUNET_log, GNUNET_SIGNATURE_PURPOSE_HELLO, GNUNET_TIME_absolute_hton(), HelloSignaturePurpose::h_addrs, hash_addresses(), HelloSignaturePurpose::purpose, and GNUNET_CRYPTO_EccSignaturePurpose::size.

Referenced by GNUNET_HELLO_builder_to_block(), and GNUNET_HELLO_builder_to_url2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ verify_hello()

static enum GNUNET_GenericReturnValue verify_hello	(	const struct GNUNET_HELLO_Parser *	parser,
		struct GNUNET_TIME_Absolute	et,
		const struct GNUNET_CRYPTO_EddsaSignature *	sig
	)

static

Verify HELLO signature.

Parameters

builder	the builder to use
et	expiration time to verify
sig	signature to verify

Returns: GNUNET_OK if everything is ok, GNUNET_NO if the HELLO expired, GNUNET_SYSERR if the signature is wrong

Definition at line 362 of file hello-uri.c.

{
  struct HelloSignaturePurpose hsp = {
    .purpose.size = htonl (sizeof (hsp)),
    .purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_HELLO),
    .expiration_time = GNUNET_TIME_absolute_hton (et)
  };
 
  hash_addresses (parser->a_head,
                  &hsp.h_addrs);
  if (GNUNET_OK !=
      GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_HELLO,
                                  &hsp,
                                  sig,
                                  &parser->pid.public_key))
  {
    GNUNET_break_op (0);
    return GNUNET_SYSERR;
  }
  if (GNUNET_TIME_absolute_is_past (et))
    return GNUNET_NO;
  return GNUNET_OK;
}

References GNUNET_break_op, GNUNET_CRYPTO_eddsa_verify, GNUNET_NO, GNUNET_OK, GNUNET_SIGNATURE_PURPOSE_HELLO, GNUNET_SYSERR, GNUNET_TIME_absolute_hton(), GNUNET_TIME_absolute_is_past(), HelloSignaturePurpose::h_addrs, hash_addresses(), consensus-simulation::parser, HelloSignaturePurpose::purpose, and GNUNET_CRYPTO_EccSignaturePurpose::size.

Referenced by GNUNET_HELLO_dht_msg_to_block(), GNUNET_HELLO_parser_from_block(), and GNUNET_HELLO_parser_from_url().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parser_new()

static struct GNUNET_HELLO_Parser * parser_new ( const struct GNUNET_PeerIdentity * pid )

static

Definition at line 390 of file hello-uri.c.

{
  struct GNUNET_HELLO_Parser *p;
 
  p = GNUNET_new (struct GNUNET_HELLO_Parser);
  p->pid = *pid;
  return p;
}

References GNUNET_new, p, GNUNET_OS_Process::pid, and pid.

Referenced by GNUNET_HELLO_parser_from_block(), and GNUNET_HELLO_parser_from_url().

Here is the caller graph for this function:

◆ check_address()

static enum GNUNET_GenericReturnValue check_address ( const char * address )

static

Definition at line 494 of file hello-uri.c.

{
  const char *e;
 
  if (NULL == (e = strstr (address,
                           "://")))
  {
    GNUNET_break_op (0);
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Invalid address `%s'\n",
                address);
    return GNUNET_SYSERR;
  }
  if (e == address)
  {
    GNUNET_break_op (0);
    return GNUNET_SYSERR;
  }
  for (const char *p = address; p != e; p++)
    if ( (! isalpha ((unsigned char) *p)) &&
         ('+' != *p) )
    {
      GNUNET_break_op (0);
      return GNUNET_SYSERR;
    }
  return GNUNET_OK;
}

References address, GNUNET_break_op, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_OK, GNUNET_SYSERR, and p.

Referenced by GNUNET_HELLO_builder_add_address(), and parser_add_address().

Here is the caller graph for this function:

◆ parser_add_address()

static enum GNUNET_GenericReturnValue parser_add_address	(	struct GNUNET_HELLO_Parser *	parser,
		const char *	address
	)

static

Definition at line 523 of file hello-uri.c.

{
  struct Address *a;
  enum GNUNET_GenericReturnValue ret;
  size_t alen = strlen (address) + 1;
 
  ret = check_address (address);
  if (GNUNET_OK != ret)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Failed to add address to builder\n");
    return ret;
  }
  /* check for duplicates */
  for (a = parser->a_head;
       NULL != a;
       a = a->next)
    if (0 == strcmp (address,
                     a->uri))
      return GNUNET_NO;
  a = GNUNET_malloc (sizeof (struct Address) + alen);
  a->uri_len = alen;
  memcpy (&a[1],
          address,
          alen);
  a->uri = (const char *) &a[1];
  GNUNET_CONTAINER_DLL_insert_tail (parser->a_head,
                                    parser->a_tail,
                                    a);
  parser->a_length++;
  return GNUNET_OK;
}

References address, check_address(), GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_malloc, GNUNET_NO, GNUNET_OK, Address::next, consensus-simulation::parser, ret, Address::uri, and Address::uri_len.

Referenced by GNUNET_HELLO_parser_from_block(), and GNUNET_HELLO_parser_from_url().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_HELLO_builder_to_env_()

static struct GNUNET_MQ_Envelope * GNUNET_HELLO_builder_to_env_	(	const struct GNUNET_HELLO_Builder *	builder,
		const struct GNUNET_CRYPTO_EddsaPrivateKey *	priv,
		struct GNUNET_TIME_Relative	expiration_time,
		const struct GNUNET_CRYPTO_EddsaSignature *	sig
	)

static

Definition at line 1132 of file hello-uri.c.

{
  struct GNUNET_MQ_Envelope *env;
  struct HelloUriMessage *msg;
  size_t blen;
 
  if (builder->a_length > UINT16_MAX)
  {
    GNUNET_break (0);
    return NULL;
  }
  blen = 0;
  GNUNET_assert (GNUNET_NO ==
                 GNUNET_HELLO_builder_to_block (builder,
                                                priv,
                                                NULL,
                                                &blen,
                                                expiration_time));
  env = GNUNET_MQ_msg_extra (msg,
                             blen,
                             GNUNET_MESSAGE_TYPE_HELLO_URI);
  msg->url_counter = htons ((uint16_t) builder->a_length);
  GNUNET_assert (GNUNET_OK ==
                 GNUNET_HELLO_builder_to_block (builder,
                                                priv,
                                                &msg[1],
                                                &blen,
                                                expiration_time));
  return env;
}

References builder, env, GNUNET_assert, GNUNET_break, GNUNET_HELLO_builder_to_block(), GNUNET_MESSAGE_TYPE_HELLO_URI, GNUNET_MQ_msg_extra, GNUNET_NO, GNUNET_OK, and msg.

Referenced by GNUNET_HELLO_builder_to_env().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Functions

Detailed Description

Function Documentation

◆ hash_addresses()

◆ sign_hello()

◆ verify_hello()

◆ parser_new()

◆ check_address()

◆ parser_add_address()

◆ GNUNET_HELLO_builder_to_env_()