gnunet_dnsparser_lib.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2010-2014 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
 */
 
#if !defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
 
#ifndef GNUNET_DNSPARSER_LIB_H
#define GNUNET_DNSPARSER_LIB_H
 
#define GNUNET_DNSPARSER_MAX_LABEL_LENGTH 63
 
#define GNUNET_DNSPARSER_MAX_NAME_LENGTH 253
 
 
#define GNUNET_DNSPARSER_TYPE_ANY 0
#define GNUNET_DNSPARSER_TYPE_A 1
#define GNUNET_DNSPARSER_TYPE_NS 2
#define GNUNET_DNSPARSER_TYPE_CNAME 5
#define GNUNET_DNSPARSER_TYPE_SOA 6
#define GNUNET_DNSPARSER_TYPE_PTR 12
#define GNUNET_DNSPARSER_TYPE_MX 15
#define GNUNET_DNSPARSER_TYPE_TXT 16
#define GNUNET_DNSPARSER_TYPE_RP 17
#define GNUNET_DNSPARSER_TYPE_AFSDB 18
#define GNUNET_DNSPARSER_TYPE_SIG 24
#define GNUNET_DNSPARSER_TYPE_KEY 25
#define GNUNET_DNSPARSER_TYPE_AAAA 28
#define GNUNET_DNSPARSER_TYPE_LOC 29
#define GNUNET_DNSPARSER_TYPE_SRV 33
#define GNUNET_DNSPARSER_TYPE_NAPTR 35
#define GNUNET_DNSPARSER_TYPE_KX 36
#define GNUNET_DNSPARSER_TYPE_CERT 37
#define GNUNET_DNSPARSER_TYPE_DNAME 39
#define GNUNET_DNSPARSER_TYPE_APL 42
#define GNUNET_DNSPARSER_TYPE_DS 43
#define GNUNET_DNSPARSER_TYPE_SSHFP 44
#define GNUNET_DNSPARSER_TYPE_IPSECKEY 45
#define GNUNET_DNSPARSER_TYPE_RRSIG 46
#define GNUNET_DNSPARSER_TYPE_NSEC 47
#define GNUNET_DNSPARSER_TYPE_DNSKEY 48
#define GNUNET_DNSPARSER_TYPE_DHCID 49
#define GNUNET_DNSPARSER_TYPE_NSEC3 50
#define GNUNET_DNSPARSER_TYPE_NSEC3PARAM 51
#define GNUNET_DNSPARSER_TYPE_TLSA 52
#define GNUNET_DNSPARSER_TYPE_HIP 55
#define GNUNET_DNSPARSER_TYPE_CDS 59
#define GNUNET_DNSPARSER_TYPE_CDNSKEY 60
#define GNUNET_DNSPARSER_TYPE_OPENPGPKEY 61
#define GNUNET_DNSPARSER_TYPE_TKEY 249
#define GNUNET_DNSPARSER_TYPE_TSIG 250
#define GNUNET_DNSPARSER_TYPE_ALL 255
#define GNUNET_DNSPARSER_TYPE_URI 256
#define GNUNET_DNSPARSER_TYPE_CAA 257
#define GNUNET_DNSPARSER_TYPE_TA 32768
 
struct GNUNET_DNSPARSER_Query
{
  char *name;
 
  uint16_t type;
 
  uint16_t dns_traffic_class;
};
 
 
struct GNUNET_DNSPARSER_MxRecord
{
  uint16_t preference;
 
  char *mxhost;
};
 
 
struct GNUNET_DNSPARSER_SrvRecord
{
  char *target;
 
  uint16_t priority;
 
  uint16_t weight;
 
  uint16_t port;
};
 
 
enum GNUNET_DNSPARSER_CertType
{
  GNUNET_DNSPARSER_CERTTYPE_RESERVED = 0,
 
  GNUNET_DNSPARSER_CERTTYPE_PKIX = 1,
 
  GNUNET_DNSPARSER_CERTTYPE_SKPI = 2,
 
  GNUNET_DNSPARSER_CERTTYPE_PGP = 3,
 
  GNUNET_DNSPARSER_CERTTYPE_IPKIX = 4,
 
  GNUNET_DNSPARSER_CERTTYPE_ISKPI = 5,
 
  GNUNET_DNSPARSER_CERTTYPE_IPGP = 6,
 
  GNUNET_DNSPARSER_CERTTYPE_ACPKIX = 7,
 
  GNUNET_DNSPARSER_CERTTYPE_IACKPIX = 8
};
 
 
enum GNUNET_DNSPARSER_CertAlgorithm
{
  GNUNET_DNSPARSER_CERTALGO_UNDEFINED = 0,
 
  GNUNET_DNSPARSER_CERTALGO_RSAMD5 = 1,
 
  GNUNET_DNSPARSER_CERTALGO_DH = 2,
 
  GNUNET_DNSPARSER_CERTALGO_DSASHA = 3,
 
  GNUNET_DNSPARSER_CERTALGO_RSRVD4 = 4,
 
  GNUNET_DNSPARSER_CERTALGO_RSASHA = 5,
 
  GNUNET_DNSPARSER_CERTALGO_DSANSEC3 = 6,
 
  GNUNET_DNSPARSER_CERTALGO_RSANSEC3 = 7,
 
  GNUNET_DNSPARSER_CERTALGO_RSASHA256 = 8,
 
  GNUNET_DNSPARSER_CERTALGO_RSRVD9 = 9,
 
  GNUNET_DNSPARSER_CERTALGO_RSASHA512 = 10,
 
  GNUNET_DNSPARSER_CERTALGO_GOST_R34 = 12,
 
  GNUNET_DNSPARSER_CERTALGO_ECDSA_P256SHA256 = 13,
 
  GNUNET_DNSPARSER_CERTALGO_ECDSA_P384SHA384 = 14
};
 
 
struct GNUNET_DNSPARSER_CertRecord
{
  enum GNUNET_DNSPARSER_CertType cert_type;
 
  uint16_t cert_tag;
 
  enum GNUNET_DNSPARSER_CertAlgorithm algorithm;
 
  size_t certificate_size;
 
  char *certificate_data;
};
 
 
struct GNUNET_DNSPARSER_SoaRecord
{
  char *mname;
 
  char *rname;
 
  uint32_t serial;
 
  uint32_t refresh;
 
  uint32_t retry;
 
  uint32_t expire;
 
  uint32_t minimum_ttl;
};
 
 
struct GNUNET_DNSPARSER_CaaRecord
{
  uint8_t flags;
 
  uint8_t tag_len;
};
 
 
struct GNUNET_DNSPARSER_RawRecord
{
  void *data;
 
  size_t data_len;
};
 
 
struct GNUNET_DNSPARSER_Record
{
  char *name;
 
  union
  {
    char *hostname;
 
    struct GNUNET_DNSPARSER_SoaRecord *soa;
 
    struct GNUNET_DNSPARSER_CertRecord *cert;
 
    struct GNUNET_DNSPARSER_MxRecord *mx;
 
    struct GNUNET_DNSPARSER_SrvRecord *srv;
 
    struct GNUNET_DNSPARSER_RawRecord raw;
  } data;
 
 
  struct GNUNET_TIME_Absolute expiration_time;
 
  uint16_t type;
 
  uint16_t dns_traffic_class;
};
 
 
struct GNUNET_DNSPARSER_Packet
{
  struct GNUNET_DNSPARSER_Query *queries;
 
  struct GNUNET_DNSPARSER_Record *answers;
 
  struct GNUNET_DNSPARSER_Record *authority_records;
 
  struct GNUNET_DNSPARSER_Record *additional_records;
 
  unsigned int num_queries;
 
  unsigned int num_answers;
 
  unsigned int num_authority_records;
 
  unsigned int num_additional_records;
 
  struct GNUNET_TUN_DnsFlags flags;
 
  uint16_t id;
};
 
 
int
GNUNET_DNSPARSER_check_label (const char *label);
 
 
int
GNUNET_DNSPARSER_check_name (const char *name);
 
 
struct GNUNET_DNSPARSER_Packet *
GNUNET_DNSPARSER_parse (const char *udp_payload,
                        size_t udp_payload_length);
 
 
void
GNUNET_DNSPARSER_free_packet (struct GNUNET_DNSPARSER_Packet *p);
 
 
int
GNUNET_DNSPARSER_pack (const struct GNUNET_DNSPARSER_Packet *p,
                       uint16_t max,
                       char **buf,
                       size_t *buf_length);
 
/* ***************** low-level packing API ******************** */
 
int
GNUNET_DNSPARSER_builder_add_name (char *dst,
                                   size_t dst_len,
                                   size_t *off,
                                   const char *name);
 
 
int
GNUNET_DNSPARSER_builder_add_query (char *dst,
                                    size_t dst_len,
                                    size_t *off,
                                    const struct GNUNET_DNSPARSER_Query *query);
 
 
int
GNUNET_DNSPARSER_builder_add_mx (char *dst,
                                 size_t dst_len,
                                 size_t *off,
                                 const struct GNUNET_DNSPARSER_MxRecord *mx);
 
 
int
GNUNET_DNSPARSER_builder_add_soa (char *dst,
                                  size_t dst_len,
                                  size_t *off,
                                  const struct GNUNET_DNSPARSER_SoaRecord *soa);
 
 
int
GNUNET_DNSPARSER_builder_add_cert (char *dst,
                                   size_t dst_len,
                                   size_t *off,
                                   const struct
                                   GNUNET_DNSPARSER_CertRecord *cert);
 
 
int
GNUNET_DNSPARSER_builder_add_srv (char *dst,
                                  size_t dst_len,
                                  size_t *off,
                                  const struct GNUNET_DNSPARSER_SrvRecord *srv);
 
/* ***************** low-level parsing API ******************** */
 
int
GNUNET_DNSPARSER_parse_record (const char *udp_payload,
                               size_t udp_payload_length,
                               size_t *off,
                               struct GNUNET_DNSPARSER_Record *r);
 
 
char *
GNUNET_DNSPARSER_parse_name (const char *udp_payload,
                             size_t udp_payload_length,
                             size_t *off);
 
 
int
GNUNET_DNSPARSER_parse_query (const char *udp_payload,
                              size_t udp_payload_length,
                              size_t *off,
                              struct GNUNET_DNSPARSER_Query *q);
 
 
struct GNUNET_DNSPARSER_SoaRecord *
GNUNET_DNSPARSER_parse_soa (const char *udp_payload,
                            size_t udp_payload_length,
                            size_t *off);
 
 
struct GNUNET_DNSPARSER_CertRecord *
GNUNET_DNSPARSER_parse_cert (const char *udp_payload,
                             size_t udp_payload_length,
                             size_t *off);
 
 
struct GNUNET_DNSPARSER_MxRecord *
GNUNET_DNSPARSER_parse_mx (const char *udp_payload,
                           size_t udp_payload_length,
                           size_t *off);
 
 
struct GNUNET_DNSPARSER_SrvRecord *
GNUNET_DNSPARSER_parse_srv (const char *udp_payload,
                            size_t udp_payload_length,
                            size_t *off);
 
/* ***************** low-level duplication API ******************** */
 
struct GNUNET_DNSPARSER_Record *
GNUNET_DNSPARSER_duplicate_record (const struct GNUNET_DNSPARSER_Record *r);
 
 
struct GNUNET_DNSPARSER_SoaRecord *
GNUNET_DNSPARSER_duplicate_soa_record (const struct
                                       GNUNET_DNSPARSER_SoaRecord *r);
 
 
struct GNUNET_DNSPARSER_CertRecord *
GNUNET_DNSPARSER_duplicate_cert_record (const struct
                                        GNUNET_DNSPARSER_CertRecord *r);
 
 
struct GNUNET_DNSPARSER_MxRecord *
GNUNET_DNSPARSER_duplicate_mx_record (const struct
                                      GNUNET_DNSPARSER_MxRecord *r);
 
 
struct GNUNET_DNSPARSER_SrvRecord *
GNUNET_DNSPARSER_duplicate_srv_record (const struct
                                       GNUNET_DNSPARSER_SrvRecord *r);
 
 
/* ***************** low-level deallocation API ******************** */
 
void
GNUNET_DNSPARSER_free_record (struct GNUNET_DNSPARSER_Record *r);
 
 
void
GNUNET_DNSPARSER_free_mx (struct GNUNET_DNSPARSER_MxRecord *mx);
 
 
void
GNUNET_DNSPARSER_free_srv (struct GNUNET_DNSPARSER_SrvRecord *srv);
 
 
void
GNUNET_DNSPARSER_free_soa (struct GNUNET_DNSPARSER_SoaRecord *soa);
 
 
void
GNUNET_DNSPARSER_free_cert (struct GNUNET_DNSPARSER_CertRecord *cert);
 
 
char *
GNUNET_DNSPARSER_bin_to_hex (const void *data,
                             size_t data_size);
 
 
size_t
GNUNET_DNSPARSER_hex_to_bin (const char *hex,
                             void *data);
 
 
#endif
  /* end of group */
 /* end of group addition */