dns_common.h

Go to the documentation of this file.

/**
 * @file dns_common.h
 * @brief Common DNS routines
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2010-2026 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneTCP Open.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * @author Oryx Embedded SARL (www.oryx-embedded.com)
 * @version 2.6.6
 **/
 
#ifndef _DNS_COMMON_H
#define _DNS_COMMON_H
 
//Dependencies
#include "core/net.h"
 
//Maximum recursion limit when parsing domain names
#ifndef DNS_NAME_MAX_RECURSION
   #define DNS_NAME_MAX_RECURSION 4
#elif (DNS_NAME_MAX_RECURSION < 1 || DNS_NAME_MAX_RECURSION > 8)
   #error DNS_NAME_MAX_RECURSION parameter is not valid
#endif
 
//Maximum size of DNS messages
#define DNS_MESSAGE_MAX_SIZE 512
//Maximum size of names
#define DNS_NAME_MAX_SIZE 255
//Maximum size of labels
#define DNS_LABEL_MAX_SIZE 63
 
//Maximum length of reverse DNS names (IPv4)
#define DNS_MAX_IPV4_REVERSE_NAME_LEN 15
//Maximum length of reverse DNS names (IPv6)
#define DNS_MAX_IPV6_REVERSE_NAME_LEN 63
 
//DNS port number
#define DNS_PORT 53
 
//End marker
#define DNS_END_TAG 0x00
//Label compression tag
#define DNS_COMPRESSION_TAG 0xC0
 
//Macro definition
#define DNS_GET_QUESTION(message, offset) (DnsQuestion *) ((uint8_t *) (message) + (offset))
#define DNS_GET_RESOURCE_RECORD(message, offset) (DnsResourceRecord *) ((uint8_t *) (message) + (offset))
 
#define DNS_SET_NSEC_BITMAP(bitmap, type) bitmap[(type) / 8] |= 0x80 >> ((type) % 8)
#define DNS_CLR_NSEC_BITMAP(bitmap, type) bitmap[(type) / 8] &= ~(0x80 >> ((type) % 8))
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * @brief DNS opcodes
 **/
 
typedef enum
{
   DNS_OPCODE_QUERY  = 0, ///<Query
   DNS_OPCODE_IQUERY = 1, ///<Inverse query
   DNS_OPCODE_STATUS = 2, ///<Status
   DNS_OPCODE_NOTIFY = 4, ///<Notify
   DNS_OPCODE_UPDATE = 5  ///<Update
} DnsOpcode;
 
 
/**
 * @brief DNS response codes
 **/
 
typedef enum
{
   DNS_RCODE_NOERROR   = 0,  ///<No error
   DNS_RCODE_FORMERR   = 1,  ///<Format error
   DNS_RCODE_SERVFAIL  = 2,  ///<Server failure
   DNS_RCODE_NXDOMAIN  = 3,  ///<Non-existent domain
   DNS_RCODE_NOTIMP    = 4,  ///<Not implemented
   DNS_RCODE_REFUSED   = 5,  ///<Query refused
   DNS_RCODE_YXDOMAIN  = 6,  ///<Name exists when it should not
   DNS_RCODE_YXRRSET   = 7,  ///<RR set exists when it should not
   DNS_RCODE_NXRRSET   = 8,  ///<RR set that should exist does not
   DNS_RCODE_NOTAUTH   = 9,  ///<Server not authoritative for zone
   DNS_RCODE_NOTZONE   = 10, ///<Name not contained in zone
   DNS_RCODE_BADVERS   = 16, ///<Bad OPT version
   DNS_RCODE_BADSIG    = 16, ///<TSIG signature failure
   DNS_RCODE_BADKEY    = 17, ///<Key not recognized
   DNS_RCODE_BADTIME   = 18, ///<Signature out of time window
   DNS_RCODE_BADMODE   = 19, ///<Bad TKEY mode
   DNS_RCODE_BADNAME   = 20, ///<Duplicate key name
   DNS_RCODE_BADALG    = 21, ///<Algorithm not supported
   DNS_RCODE_BADTRUC   = 22, ///<Bad truncation
   DNS_RCODE_BADCOOKIE = 23  ///<Bad server cookie
} DnsResponseCode;
 
 
/**
 * @brief DNS resource record classes
 **/
 
typedef enum
{
   DNS_RR_CLASS_IN  = 1,  ///<Internet
   DNS_RR_CLASS_CH  = 3,  ///<Chaos
   DNS_RR_CLASS_HS  = 4,  ///<Hesiod
   DNS_RR_CLASS_ANY = 255 ///<Any class
} DnsResourceRecordClass;
 
 
/**
 * @brief DNS resource record types
 **/
 
typedef enum
{
   DNS_RR_TYPE_A      = 1,   ///<Host address
   DNS_RR_TYPE_NS     = 2,   ///<Authoritative name server
   DNS_RR_TYPE_CNAME  = 5,   ///<Canonical name for an alias
   DNS_RR_TYPE_SOA    = 6,   ///<Start of a zone of authority
   DNS_RR_TYPE_WKS    = 11,  ///<Well known service description
   DNS_RR_TYPE_PTR    = 12,  ///<Domain name pointer
   DNS_RR_TYPE_HINFO  = 13,  ///<Host information
   DNS_RR_TYPE_MINFO  = 14,  ///<Mailbox or mail list information
   DNS_RR_TYPE_MX     = 15,  ///<Mail exchange
   DNS_RR_TYPE_TXT    = 16,  ///<Text strings
   DNS_RR_TYPE_AAAA   = 28,  ///<IPv6 address
   DNS_RR_TYPE_NB     = 32,  ///<NetBIOS name
   DNS_RR_TYPE_NBSTAT = 33,  ///<NetBIOS node status
   DNS_RR_TYPE_SRV    = 33,  ///<Server selection
   DNS_RR_TYPE_NAPTR  = 35,  ///<Naming authority pointer
   DNS_RR_TYPE_RRSIG  = 46,  ///<RRSIG record
   DNS_RR_TYPE_NSEC   = 47,  ///<NSEC record
   DNS_RR_TYPE_DNSKEY = 48,  ///<DNSKEY record
   DNS_RR_TYPE_EUI48  = 108, ///<EUI-48 address
   DNS_RR_TYPE_EUI64  = 109, ///<EUI-64 address
   DNS_RR_TYPE_AXFR   = 252, ///<Transfer of an entire zone
   DNS_RR_TYPE_ANY    = 255, ///<A request for all records
   DNS_RR_TYPE_URI    = 256  ///<Uniform resource identifier
} DnsResourceRecordType;
 
 
//CC-RX, CodeWarrior or Win32 compiler?
#if defined(__CCRX__)
   #pragma pack
#elif defined(__CWCC__) || defined(_WIN32)
   #pragma pack(push, 1)
#endif
 
 
/**
 * @brief DNS message header
 **/
 
typedef __packed_struct
{
   uint16_t id;         //0-1
#if defined(_CPU_BIG_ENDIAN) && !defined(__ICCRX__)
   uint8_t qr : 1;      //2
   uint8_t opcode : 4;
   uint8_t aa : 1;
   uint8_t tc : 1;
   uint8_t rd : 1;
   uint8_t ra : 1;      //3
   uint8_t z : 3;
   uint8_t rcode : 4;
#else
   uint8_t rd : 1;      //2
   uint8_t tc : 1;
   uint8_t aa : 1;
   uint8_t opcode : 4;
   uint8_t qr : 1;
   uint8_t rcode : 4;   //3
   uint8_t z : 3;
   uint8_t ra : 1;
#endif
   uint16_t qdcount;    //4-5
   uint16_t ancount;    //6-7
   uint16_t nscount;    //8-9
   uint16_t arcount;    //10-11
   uint8_t questions[]; //12
} DnsHeader;
 
 
/**
 * @brief Question format
 **/
 
typedef __packed_struct
{
   uint16_t qtype;
   uint16_t qclass;
} DnsQuestion;
 
 
/**
 * @brief Resource record format
 **/
 
typedef __packed_struct
{
   uint16_t rtype;    //0-1
   uint16_t rclass;   //2-3
   uint32_t ttl;      //4-7
   uint16_t rdlength; //8-9
   uint8_t rdata[];   //10
} DnsResourceRecord;
 
 
/**
 * @brief A resource record format
 **/
 
typedef __packed_struct
{
   uint16_t rtype;    //0-1
   uint16_t rclass;   //2-3
   uint32_t ttl;      //4-7
   uint16_t rdlength; //8-9
   uint8_t rdata[4];  //10-13
} DnsIpv4AddrResourceRecord;
 
 
/**
 * @brief AAAA resource record format
 **/
 
typedef __packed_struct
{
   uint16_t rtype;    //0-1
   uint16_t rclass;   //2-3
   uint32_t ttl;      //4-7
   uint16_t rdlength; //8-9
   uint8_t rdata[16]; //10-25
} DnsIpv6AddrResourceRecord;
 
 
/**
 * @brief SRV resource record format
 **/
 
typedef __packed_struct
{
   uint16_t rtype;    //0-1
   uint16_t rclass;   //2-3
   uint32_t ttl;      //4-7
   uint16_t rdlength; //8-9
   uint16_t priority; //10-11
   uint16_t weight;   //12-13
   uint16_t port;     //14-15
   uint8_t target[];  //16
} DnsSrvResourceRecord;
 
 
//CC-RX, CodeWarrior or Win32 compiler?
#if defined(__CCRX__)
   #pragma unpack
#elif defined(__CWCC__) || defined(_WIN32)
   #pragma pack(pop)
#endif
 
//DNS related functions
size_t dnsEncodeName(const char_t *src, uint8_t *dest);
 
size_t dnsParseName(const DnsHeader *message, size_t length, size_t pos,
   uint_t level);
 
int_t dnsCompareName(const DnsHeader *message, size_t length, size_t pos,
   const char_t *name, uint_t level);
 
int_t dnsCompareEncodedName(const DnsHeader *message1, size_t length1,
   size_t pos1, const DnsHeader *message2, size_t length2, size_t pos2,
   uint_t level);
 
void dnsGenerateIpv4ReverseName(Ipv4Addr ipv4Addr, char_t *buffer);
void dnsGenerateIpv6ReverseName(const Ipv6Addr *ipv6Addr, char_t *buffer);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif