gnunet_gnsrecord_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2012, 2013 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_GNSRECORD_LIB_H
#define GNUNET_GNSRECORD_LIB_H
 
 
#include "gnunet_common.h"
#include "gnunet_identity_service.h"
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
#define GNUNET_GNS_EMPTY_LABEL_AT "@"
 
#define GNUNET_GNSRECORD_MAX_BLOCK_SIZE (63 * 1024)
 
 
#define GNUNET_GNSRECORD_TYPE_ANY 0
 
#include "gnu_name_system_record_types.h"
 
#define GNUNET_GNSRECORD_RF_RCMP_FLAGS (GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION)
 
 
enum GNUNET_GNSRECORD_Flags
{
  GNUNET_GNSRECORD_RF_NONE = 0,
 
 
  GNUNET_GNSRECORD_RF_CRITICAL = 1 << (15 - 15),
 
 
  GNUNET_GNSRECORD_RF_SHADOW = 1 << (15 - 14),
 
 
  GNUNET_GNSRECORD_RF_SUPPLEMENTAL = 1 << (15 - 13),
 
  GNUNET_GNSRECORD_RF_MAINTENANCE = 1 << (15 - 2),
 
  GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION = 1 << (15 - 1),
 
 
  GNUNET_GNSRECORD_RF_PRIVATE = 1 << (15 - 0),
 
};
 
 
enum GNUNET_GNSRECORD_Filter
{
  GNUNET_GNSRECORD_FILTER_NONE = 0,
 
  GNUNET_GNSRECORD_FILTER_INCLUDE_MAINTENANCE = 1,
 
  GNUNET_GNSRECORD_FILTER_OMIT_PRIVATE = 2,
 
  // GNUNET_NAMESTORE_FILTER_OMIT_PUBLIC = 4,
};
 
 
struct GNUNET_GNSRECORD_Data
{
  const void *data;
 
  uint64_t expiration_time;
 
  size_t data_size;
 
  uint32_t record_type;
 
  enum GNUNET_GNSRECORD_Flags flags;
};
 
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_GNSRECORD_PlaceData
{
  struct GNUNET_CRYPTO_EddsaPublicKey place_pub_key;
 
  struct GNUNET_PeerIdentity origin;
 
  uint32_t relay_count GNUNET_PACKED;
 
  /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */
};
 
struct GNUNET_GNSRECORD_EcdsaBlock
{
  struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
 
  struct GNUNET_CRYPTO_EcdsaSignature signature;
 
  struct GNUNET_TIME_AbsoluteNBO expiration_time;
 
  /* followed by encrypted data */
};
 
 
struct GNUNET_GNSRECORD_EddsaBlock
{
  struct GNUNET_CRYPTO_EddsaPublicKey derived_key;
 
  struct GNUNET_CRYPTO_EddsaSignature signature;
 
  struct GNUNET_TIME_AbsoluteNBO expiration_time;
 
 
  /* followed by encrypted data */
};
 
 
struct GNUNET_GNSRECORD_Block
{
  uint32_t size;
 
  uint32_t type;
 
  union
  {
    struct GNUNET_GNSRECORD_EcdsaBlock ecdsa_block;
    struct GNUNET_GNSRECORD_EddsaBlock eddsa_block;
  };
};
 
 
struct GNUNET_GNSRECORD_BoxRecord
{
  uint16_t protocol GNUNET_PACKED;
 
  uint16_t service GNUNET_PACKED;
 
  uint32_t record_type GNUNET_PACKED;
 
  /* followed by the 'original' record */
};
 
 
struct GNUNET_GNSRECORD_SBoxRecord
{
  uint32_t record_type GNUNET_PACKED;
 
  /* followed by the zero terminated hostname prefix */
  /* followed by the 'original' record */
};
 
 
struct GNUNET_GNSRECORD_ReverseRecord
{
  struct GNUNET_CRYPTO_PublicKey pkey;
 
  struct GNUNET_TIME_Absolute expiration;
 
  /* followed by the name the delegator uses to refer to our namespace */
};
 
 
typedef void (*GNUNET_GNSRECORD_RecordCallback) (
  void *cls, unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd);
 
 
/* ***************** API related to GNSRECORD plugins ************** */
 
char *
GNUNET_GNSRECORD_value_to_string (uint32_t type, const void *data,
                                  size_t data_size);
 
 
int
GNUNET_GNSRECORD_string_to_value (uint32_t type, const char *s, void **data,
                                  size_t *data_size);
 
 
uint32_t
GNUNET_GNSRECORD_typename_to_number (const char *dns_typename);
 
 
const char *
GNUNET_GNSRECORD_number_to_typename (uint32_t type);
 
 
/* convenience APIs for serializing / deserializing GNS records */
 
ssize_t
GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
                                   const struct GNUNET_GNSRECORD_Data *rd);
 
 
ssize_t
GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
                                    const struct GNUNET_GNSRECORD_Data *rd,
                                    size_t dest_size, char *dest);
 
unsigned int
GNUNET_GNSRECORD_records_deserialize_get_size (size_t len,
                                               const char *src);
 
int
GNUNET_GNSRECORD_records_deserialize (size_t len, const char *src,
                                      unsigned int rd_count,
                                      struct GNUNET_GNSRECORD_Data *dest);
 
 
/* ******* general APIs relating to blocks, records and labels ******** */
 
 
int
GNUNET_GNSRECORD_is_expired (const struct GNUNET_GNSRECORD_Data *rd);
 
 
char *
GNUNET_GNSRECORD_string_normalize (const char *src);
 
 
const char *
GNUNET_GNSRECORD_z2s (const struct GNUNET_CRYPTO_PublicKey *z);
 
 
const char *
GNUNET_GNSRECORD_pkey_to_zkey (const struct GNUNET_CRYPTO_PublicKey *pkey);
 
 
int
GNUNET_GNSRECORD_zkey_to_pkey (const char *zkey,
                               struct GNUNET_CRYPTO_PublicKey *pkey);
 
 
void
GNUNET_GNSRECORD_query_from_private_key (
  const struct GNUNET_CRYPTO_PrivateKey *zone, const char *label,
  struct GNUNET_HashCode *query);
 
 
void
GNUNET_GNSRECORD_query_from_public_key (
  const struct GNUNET_CRYPTO_PublicKey *pub, const char *label,
  struct GNUNET_HashCode *query);
 
 
ssize_t
GNUNET_GNSRECORD_block_calculate_size (const struct
                                       GNUNET_CRYPTO_PrivateKey *key,
                                       const struct GNUNET_GNSRECORD_Data *rd,
                                       unsigned int rd_count);
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_sign (const struct
                             GNUNET_CRYPTO_PrivateKey *key,
                             const char *label,
                             struct GNUNET_GNSRECORD_Block *block);
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_create (const struct GNUNET_CRYPTO_PrivateKey *key,
                               struct GNUNET_TIME_Absolute expire,
                               const char *label,
                               const struct GNUNET_GNSRECORD_Data *rd,
                               unsigned int rd_count,
                               struct GNUNET_GNSRECORD_Block **block);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_create_unsigned (const struct
                                        GNUNET_CRYPTO_PrivateKey *key,
                                        struct GNUNET_TIME_Absolute expire,
                                        const char *label,
                                        const struct GNUNET_GNSRECORD_Data *rd,
                                        unsigned int rd_count,
                                        struct GNUNET_GNSRECORD_Block **result);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_create2 (const struct GNUNET_CRYPTO_PrivateKey *key,
                                struct GNUNET_TIME_Absolute expire,
                                const char *label,
                                const struct GNUNET_GNSRECORD_Data *rd,
                                unsigned int rd_count,
                                struct GNUNET_GNSRECORD_Block **result);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_verify (const struct GNUNET_GNSRECORD_Block *block);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_decrypt (
  const struct GNUNET_GNSRECORD_Block *block,
  const struct GNUNET_CRYPTO_PublicKey *zone_key, const char *label,
  GNUNET_GNSRECORD_RecordCallback proc, void *proc_cls);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_records_cmp (const struct GNUNET_GNSRECORD_Data *a,
                              const struct GNUNET_GNSRECORD_Data *b);
 
 
struct GNUNET_TIME_Absolute
GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count,
                                             const struct
                                             GNUNET_GNSRECORD_Data *rd,
                                             struct GNUNET_TIME_Absolute min);
 
 
size_t
GNUNET_GNSRECORD_block_get_size (const struct GNUNET_GNSRECORD_Block *block);
 
struct GNUNET_TIME_Absolute
GNUNET_GNSRECORD_block_get_expiration (const struct
                                       GNUNET_GNSRECORD_Block *block);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_query_from_block (const struct GNUNET_GNSRECORD_Block *block,
                                   struct GNUNET_HashCode *query);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_identity_from_data (const char *data,
                                     size_t data_size,
                                     uint32_t type,
                                     struct GNUNET_CRYPTO_PublicKey *key);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_data_from_identity (const struct
                                     GNUNET_CRYPTO_PublicKey *key,
                                     char **data,
                                     size_t *data_size,
                                     uint32_t *type);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_is_zonekey_type (uint32_t type);
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_is_critical (uint32_t type);
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_normalize_record_set (const char *label,
                                       const struct GNUNET_GNSRECORD_Data *rd,
                                       unsigned int rd_count,
                                       struct GNUNET_GNSRECORD_Data *rd_public,
                                       unsigned int *rd_count_public,
                                       struct GNUNET_TIME_Absolute *min_expiry,
                                       enum GNUNET_GNSRECORD_Filter filter,
                                       char **emsg);
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_label_check (const char*label, char **emsg);
 
#define GNUNET_MAX_POW_SIZE sizeof(struct GNUNET_GNSRECORD_PowP)  \
  + sizeof(struct GNUNET_CRYPTO_PublicKey)  \
  + 1024                                      // FIXME max sig_len
 
#define POW_COUNT 32
 
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_GNSRECORD_PowP
{
  struct GNUNET_TIME_AbsoluteNBO timestamp;
 
  struct GNUNET_TIME_RelativeNBO ttl;
 
  uint64_t pow[POW_COUNT] GNUNET_PACKED;
 
};
 
 
struct GNUNET_GNSRECORD_SignaturePurposePS
{
  struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 
  struct GNUNET_TIME_AbsoluteNBO timestamp;
 
};
 
GNUNET_NETWORK_STRUCT_END
 
 
struct GNUNET_GNSRECORD_PowCalculationHandle;
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_check_pow (const struct GNUNET_GNSRECORD_PowP *pow,
                            unsigned int matching_bits,
                            struct GNUNET_TIME_Relative epoch_duration);
 
 
void
GNUNET_GNSRECORD_pow_init (const struct GNUNET_CRYPTO_PrivateKey *key,
                           struct GNUNET_GNSRECORD_PowP *pow);
 
 
struct GNUNET_GNSRECORD_PowCalculationHandle*
GNUNET_GNSRECORD_pow_start (struct GNUNET_GNSRECORD_PowP *pow,
                            int epochs,
                            unsigned int difficulty);
 
 
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_pow_round (struct GNUNET_GNSRECORD_PowCalculationHandle *pc);
 
size_t
GNUNET_GNSRECORD_proof_get_size (const struct GNUNET_GNSRECORD_PowP *pow);
 
void
GNUNET_GNSRECORD_pow_stop (struct GNUNET_GNSRECORD_PowCalculationHandle *pc);
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
 /* end of group */
 /* end of group addition */