dns_common.h File Reference

Common DNS routines. More...

#include "core/net.h"

Go to the source code of this file.

Macros
#define	DNS_NAME_MAX_RECURSION   4
#define	DNS_MESSAGE_MAX_SIZE   512
#define	DNS_NAME_MAX_SIZE   255
#define	DNS_LABEL_MAX_SIZE   63
#define	DNS_MAX_IPV4_REVERSE_NAME_LEN   15
#define	DNS_MAX_IPV6_REVERSE_NAME_LEN   63
#define	DNS_PORT   53
#define	DNS_COMPRESSION_TAG   0xC0
#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))

Typedefs
struct {
char_t   type
uint32_t   dataStart
uint32_t   dataLength
uint8_t   nameLength
char_t   name []
uint8_t   tokenLen: 4
uint8_t   type: 2
uint8_t   version: 2
uint8_t   code
uint16_t   mid
uint8_t   token []
union {
uint8_t   b [6]
uint16_t   w [3]
}
uint16_t   srcPort
uint16_t   destPort
uint32_t   seqNum
uint32_t   ackNum
uint8_t   reserved1: 4
uint8_t   dataOffset: 4
uint8_t   flags: 6
uint8_t   reserved2: 2
uint16_t   window
uint16_t   checksum
uint16_t   urgentPointer
uint8_t   options []
uint16_t   length
uint8_t   data []
uint8_t   op
uint8_t   htype
uint8_t   hlen
uint8_t   hops
uint32_t   xid
uint16_t   secs
uint16_t   flags
Ipv4Addr   ciaddr
Ipv4Addr   yiaddr
Ipv4Addr   siaddr
Ipv4Addr   giaddr
MacAddr   chaddr
uint8_t   unused [10]
uint8_t   sname [64]
uint8_t   file [128]
uint32_t   magicCookie
uint16_t   type
uint16_t   hardwareType
uint32_t   time
MacAddr   linkLayerAddr
uint16_t   id
uint8_t   rd: 1
uint8_t   tc: 1
uint8_t   aa: 1
uint8_t   opcode: 4
uint8_t   qr: 1
uint8_t   rcode: 4
uint8_t   z: 3
uint8_t   ra: 1
uint16_t   qdcount
uint16_t   ancount
uint16_t   nscount
uint16_t   arcount
uint8_t   questions []
uint16_t   controlWord
uint16_t   byteCount
uint8_t   bLength
uint8_t   bDescriptorType
uint16_t   bcdUsb
uint8_t   bDeviceClass
uint8_t   bDeviceSubClass
uint8_t   bDeviceProtocol
uint8_t   bMaxPacketSize0
uint16_t   idVendor
uint16_t   idProduct
uint16_t   bcdDevice
uint8_t   iManufacturer
uint8_t   iProduct
uint8_t   iSerialNumber
uint8_t   bNumConfigurations
uint8_t   maxRespTime
Ipv4Addr   groupAddr
uint16_t   hrd
uint16_t   pro
uint8_t   hln
uint8_t   pln
uint16_t   op
MacAddr   sha
Ipv4Addr   spa
MacAddr   tha
Ipv4Addr   tpa
uint8_t   length
uint8_t   value []
uint16_t   first
uint16_t   last
uint16_t   next
union {
uint8_t   b [16]
uint16_t   w [8]
uint32_t   dw [4]
}
uint16_t   maxRespDelay
uint16_t   reserved
Ipv6Addr   multicastAddr
uint32_t   reserved
uint16_t   pvid
uint8_t   autoNegSupportStatus
uint16_t   pmdAutoNegAdvCap
uint16_t   operationalMauType
uint16_t   capabilities
uint8_t   deviceType
uint8_t   lengthH: 1
uint8_t   lengthL
uint8_t   t: 1
uint8_t   c: 1
union {
int32_t   integer
uint8_t   octetString [1]
uint8_t   oid [1]
uint8_t   ipAddr [4]
uint32_t   counter32
uint32_t   gauge32
uint32_t   unsigned32
uint32_t   timeTicks
uint64_t   counter64
}
uint16_t   transactionId
uint16_t   protocolId
uint8_t   unitId
uint8_t   pdu []
uint8_t   retain: 1
uint8_t   qos: 2
uint8_t   dup: 1
union {
uint8_t   all
struct {
uint8_t   topicIdType: 2
uint8_t   cleanSession: 1
uint8_t   will: 1
uint8_t   retain: 1
uint8_t   qos: 2
uint8_t   dup: 1
}
}
uint8_t   b: 1
uint8_t   identifier
uint8_t   valueSize
Ipv4Addr   srcIpAddr
Ipv4Addr   destIpAddr
Eui64   interfaceId
uint16_t   mru
uint8_t   peerIdLength
uint8_t   peerId []
uint32_t   seconds
uint32_t   fraction
uint16_t   opcode
char_t   filename []
uint8_t   reserved: 3
uint8_t   fin: 1
uint8_t   payloadLen: 7
uint8_t   mask: 1
uint8_t   extPayloadLen []
uint32_t   length
uint8_t   payload []
uint8_t   protocolVersionId
uint8_t   bpduType
StpBridgeId   rootId
uint32_t   rootPathCost
StpBridgeId   bridgeId
uint16_t   portId
uint16_t   messageAge
uint16_t   maxAge
uint16_t   helloTime
uint16_t   forwardDelay
uint8_t   version1Length
uint16_t   priority
MacAddr   addr
}	DnsHeader
	DNS message header. More...
struct {
char_t   type
uint32_t   dataStart
uint32_t   dataLength
uint8_t   nameLength
uint8_t   length: 4
uint8_t   delta: 4
union {
uint8_t   b [8]
uint16_t   w [4]
uint32_t   dw [2]
}
uint8_t   kind
uint8_t   value []
uint8_t   code
uint16_t   type
uint32_t   enterpriseNumber
uint8_t   identifier []
uint16_t   qtype
uint16_t   qclass
uint16_t   statusWord
uint16_t   byteCount
uint8_t   bLength
uint8_t   bDescriptorType
uint16_t   wTotalLength
uint8_t   bNumInterfaces
uint8_t   bConfigurationValue
uint8_t   iConfiguration
uint8_t   bmAttributes
uint8_t   bMaxPower
uint8_t   type
uint16_t   checksum
uint8_t   parameter
uint8_t   unused [3]
uint8_t   data []
uint32_t   parameter
uint8_t   nextHeader
uint8_t   hdrExtLen
uint8_t   options []
uint8_t   curHopLimit
uint8_t   reserved: 2
uint8_t   p: 1
uint8_t   prf: 2
uint8_t   h: 1
uint8_t   o: 1
uint8_t   m: 1
uint16_t   routerLifetime
uint32_t   reachableTime
uint32_t   retransTimer
uint8_t   flags
uint16_t   ppvid
uint8_t   mdiPowerSupport
uint8_t   psePowerPair
uint8_t   powerClass
uint8_t   appType
uint8_t   vlanIdH: 5
uint8_t   x: 1
uint8_t   t: 1
uint8_t   u: 1
uint8_t   l2PriorityH: 1
uint8_t   vlanIdL: 7
uint8_t   dscpValue: 6
uint8_t   l2PriorityL: 2
uint8_t   chassisIdSubtype
uint8_t   chassisId []
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfCoils
uint16_t   length
uint8_t   msgType
uint16_t   flags
Ipv4Addr   addr
uint8_t   valueSize
uint16_t   protocol
uint32_t   accm
uint8_t   msgLength
uint8_t   message []
uint8_t   mode: 3
uint8_t   vn: 3
uint8_t   li: 2
uint8_t   stratum
uint8_t   poll
int8_t   precision
uint32_t   rootDelay
uint32_t   rootDispersion
uint32_t   referenceId
NtpTimestamp   referenceTimestamp
NtpTimestamp   originateTimestamp
NtpTimestamp   receiveTimestamp
NtpTimestamp   transmitTimestamp
uint16_t   opcode
char_t   filename []
uint16_t   value []
uint16_t   group
uint8_t   keyExchange []
uint32_t   id
uint32_t   dataLen
}	DnsQuestion
	Question format. More...
struct {
uint32_t   totalSize
ResRootEntry   rootEntry
MacAddr   destAddr
MacAddr   srcAddr
uint16_t   type
uint8_t   data []
uint16_t   hardwareType
MacAddr   linkLayerAddr
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint8_t   rdata []
uint8_t   bLength
uint8_t   bDescriptorType
uint8_t   bInterfaceNumber
uint8_t   bAlternateSetting
uint8_t   bNumEndpoints
uint8_t   bInterfaceClass
uint8_t   bInterfaceSubClass
uint8_t   bInterfaceProtocol
uint8_t   iInterface
uint8_t   type
uint8_t   code
uint16_t   checksum
uint32_t   unused
uint8_t   nextHeader
uint8_t   hdrExtLen
uint8_t   options []
uint32_t   reserved
Ipv6Addr   targetAddr
uint16_t   vlanId
uint8_t   vlanNameLen
char_t   vlanName []
uint8_t   aggregationStatus
uint32_t   aggregatedPortId
uint8_t   locationDataFormat
uint8_t   locationId []
uint8_t   portIdSubtype
uint8_t   portId []
uint8_t   functionCode
uint8_t   byteCount
uint8_t   coilStatus []
uint8_t   prefix
uint16_t   length
uint8_t   msgType
uint8_t   identifier
uint8_t   message []
uint8_t   length
Ipv4Addr   ipAddr
uint16_t   protocol
uint8_t   msgLength
uint8_t   rejectedPacket []
uint32_t   keyId
uint8_t   messageDigest [16]
uint16_t   opcode
uint16_t   block
uint16_t   value []
uint8_t   value []
}	DnsResourceRecord
	Resource record format. More...
struct {
uint8_t   dsap
uint8_t   ssap
uint8_t   control
uint8_t   msgType
uint8_t   transactionId [3]
uint8_t   options []
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint8_t   rdata [4]
uint8_t   bLength
uint8_t   bDescriptorType
uint8_t   bEndpointAddress
uint8_t   bmAttributes
uint16_t   wMaxPacketSize
uint8_t   bInterval
uint8_t   type
uint8_t   code
uint16_t   checksum
uint32_t   unused
uint8_t   data []
uint32_t   mtu
uint8_t   nextHeader
uint8_t   hdrExtLen
uint8_t   routingType
uint8_t   segmentsLeft
uint32_t   reserved
Ipv6Addr   address []
uint8_t   reserved1: 5
uint8_t   o: 1
uint8_t   s: 1
uint8_t   r: 1
uint8_t   reserved2 [3]
Ipv6Addr   targetAddr
uint8_t   protocolIdLen
uint8_t   protocolId []
uint16_t   maxFrameSize
uint8_t   powerPriority: 4
uint8_t   powerSource: 2
uint8_t   powerType: 2
uint16_t   powerValue
uint16_t   ttl
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfInputs
uint8_t   gwId
uint16_t   duration
uint8_t   identifier
uint16_t   length
uint8_t   message []
uint8_t   length
Ipv4Addr   ipAddr
uint16_t   protocol
uint16_t   rejectedProtocol
uint8_t   rejectedInfo []
uint16_t   opcode
uint16_t   block
uint16_t   version
uint16_t   epoch
DtlsSequenceNumber   seqNum
uint8_t   hash
uint8_t   signature
uint8_t   value []
}	DnsIpv4AddrResourceRecord
	A resource record format. More...
struct {
uint16_t   tci
uint16_t   type
uint8_t   msgType
uint8_t   hopCount
Ipv6Addr   linkAddress
Ipv6Addr   peerAddress
uint8_t   options []
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint8_t   rdata [16]
uint8_t   bLength
uint8_t   bDescriptorType
uint16_t   bString []
uint8_t   type
uint8_t   code
uint16_t   checksum
uint8_t   pointer
uint8_t   unused [3]
uint8_t   data []
uint32_t   unused
uint8_t   nextHeader
uint8_t   payloadLen
uint16_t   reserved
uint32_t   securityParamIndex
uint32_t   sequenceNumber
uint8_t   authData []
uint32_t   reserved
Ipv6Addr   targetAddr
Ipv6Addr   destAddr
uint8_t   measurements [20]
uint16_t   psePowerPriceIndex
uint16_t   supportedCap
uint16_t   enabledCap
uint8_t   functionCode
uint8_t   byteCount
uint8_t   inputStatus []
uint8_t   radius
uint8_t   length
Ipv4Addr   ipAddr
uint32_t   magicNumber
uint8_t   identifier
uint16_t   length
uint16_t   opcode
uint16_t   errorCode
char_t   errorMsg []
uint16_t   msgSeq
uint8_t   fragOffset [3]
uint8_t   fragLength [3]
TlsSignHashAlgo   value []
uint8_t   value []
}	DnsIpv6AddrResourceRecord
	AAAA resource record format. More...
struct {
uint16_t   code
uint16_t   length
uint8_t   value []
uint16_t   rtype
uint16_t   rclass
uint32_t   ttl
uint16_t   rdlength
uint16_t   priority
uint16_t   weight
uint16_t   port
uint8_t   target []
uint8_t   bFunctionLength
uint8_t   bDescriptorType
uint8_t   bDescriptorSubtype
uint16_t   bcdCdc
uint8_t   type
uint8_t   code
uint16_t   checksum
uint16_t   identifier
uint16_t   sequenceNumber
uint8_t   data []
uint32_t   pointer
uint32_t   securityParamIndex
uint32_t   sequenceNumber
uint8_t   payloadData []
uint8_t   length
uint8_t   powerPriority: 2
uint8_t   pd4pid: 1
uint8_t   reserved: 1
uint8_t   powerSource: 2
uint8_t   powerType: 2
uint16_t   pdRequestedPower
uint16_t   pseAllocatedPower
uint8_t   mgmtAddrLen
uint8_t   mgmtAddrSubtype
uint8_t   mgmtAddr []
uint8_t   functionCode
uint16_t   startingAddr
uint16_t   quantityOfRegs
uint8_t   gwId
uint8_t   gwAdd []
Ipv4Addr   ipAddr
uint8_t   identifier
uint32_t   magicNumber
uint16_t   serverVersion
uint8_t   cookieLength
uint8_t   cookie []
}	DnsSrvResourceRecord
	SRV resource record format. More...

Enumerations
enum	DnsOpcode {   DNS_OPCODE_QUERY = 0, DNS_OPCODE_INVERSE_QUERY = 1, DNS_OPCODE_STATUS = 2, DNS_OPCODE_NOTIFY = 4,   DNS_OPCODE_UPDATE = 5 }
	DNS opcodes. More...
enum	DnsReturnCode {   DNS_RCODE_NO_ERROR = 0, DNS_RCODE_FORMAT_ERROR = 1, DNS_RCODE_SERVER_FAILURE = 2, DNS_RCODE_NAME_ERROR = 3,   DNS_RCODE_NOT_IMPLEMENTED = 4, DNS_RCODE_QUERY_REFUSED = 5 }
	DNS return codes. More...
enum	DnsResourceRecordClass { DNS_RR_CLASS_IN = 1, DNS_RR_CLASS_CH = 3, DNS_RR_CLASS_HS = 4, DNS_RR_CLASS_ANY = 255 }
	DNS resource record classes. More...
enum	DnsResourceRecordType {   DNS_RR_TYPE_A = 1, DNS_RR_TYPE_NS = 2, DNS_RR_TYPE_CNAME = 5, DNS_RR_TYPE_SOA = 6,   DNS_RR_TYPE_WKS = 11, DNS_RR_TYPE_PTR = 12, DNS_RR_TYPE_HINFO = 13, DNS_RR_TYPE_MINFO = 14,   DNS_RR_TYPE_MX = 15, DNS_RR_TYPE_TXT = 16, DNS_RR_TYPE_AAAA = 28, DNS_RR_TYPE_NB = 32,   DNS_RR_TYPE_SRV = 33, DNS_RR_TYPE_NAPTR = 35, DNS_RR_TYPE_NSEC = 47, DNS_RR_TYPE_EUI48 = 108,   DNS_RR_TYPE_EUI64 = 109, DNS_RR_TYPE_AXFR = 252, DNS_RR_TYPE_ANY = 255, DNS_RR_TYPE_URI = 256 }
	DNS resource record types. More...

Functions
size_t	dnsEncodeName (const char_t *src, uint8_t *dest)
	Encode a domain name using the DNS name notation. More...
size_t	dnsParseName (const DnsHeader *message, size_t length, size_t pos, char_t *dest, uint_t level)
	Decode a domain name that uses the DNS name encoding. More...
int_t	dnsCompareName (const DnsHeader *message, size_t length, size_t pos, const char_t *name, uint_t level)
	Compare domain names. More...
int_t	dnsCompareEncodedName (const DnsHeader *message1, size_t length1, size_t pos1, const DnsHeader *message2, size_t length2, size_t pos2, uint_t level)
	Compare domain names encoded with DNS notation. More...
void	dnsGenerateIpv4ReverseName (Ipv4Addr ipv4Addr, char_t *buffer)
	Generate domain name for reverse DNS lookup (IPv4) More...
void	dnsGenerateIpv6ReverseName (const Ipv6Addr *ipv6Addr, char_t *buffer)
	Generate domain name for reverse DNS lookup (IPv6) More...

Detailed Description

Common DNS routines.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2023 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.2.4

Definition in file dns_common.h.

Macro Definition Documentation

DNS_CLR_NSEC_BITMAP

#define DNS_CLR_NSEC_BITMAP	(		bitmap,
			type
	)		bitmap[(type) / 8] &= ~(0x80 >> ((type) % 8))

Definition at line 67 of file dns_common.h.

DNS_COMPRESSION_TAG

#define DNS_COMPRESSION_TAG   0xC0

Definition at line 60 of file dns_common.h.

DNS_GET_QUESTION

#define DNS_GET_QUESTION	(		message,
			offset
	)		(DnsQuestion *) ((uint8_t *) (message) + (offset))

Definition at line 63 of file dns_common.h.

DNS_GET_RESOURCE_RECORD

#define DNS_GET_RESOURCE_RECORD	(		message,
			offset
	)		(DnsResourceRecord *) ((uint8_t *) (message) + (offset))

Definition at line 64 of file dns_common.h.

DNS_LABEL_MAX_SIZE

#define DNS_LABEL_MAX_SIZE   63

Definition at line 49 of file dns_common.h.

DNS_MAX_IPV4_REVERSE_NAME_LEN

#define DNS_MAX_IPV4_REVERSE_NAME_LEN   15

Definition at line 52 of file dns_common.h.

DNS_MAX_IPV6_REVERSE_NAME_LEN

#define DNS_MAX_IPV6_REVERSE_NAME_LEN   63

Definition at line 54 of file dns_common.h.

DNS_MESSAGE_MAX_SIZE

#define DNS_MESSAGE_MAX_SIZE   512

Definition at line 45 of file dns_common.h.

DNS_NAME_MAX_RECURSION

#define DNS_NAME_MAX_RECURSION   4

Definition at line 39 of file dns_common.h.

DNS_NAME_MAX_SIZE

#define DNS_NAME_MAX_SIZE   255

Definition at line 47 of file dns_common.h.

DNS_PORT

#define DNS_PORT   53

Definition at line 57 of file dns_common.h.

DNS_SET_NSEC_BITMAP

#define DNS_SET_NSEC_BITMAP	(		bitmap,
			type
	)		bitmap[(type) / 8] |= 0x80 >> ((type) % 8)

Definition at line 66 of file dns_common.h.

Typedef Documentation

DnsHeader

typedef { ... } DnsHeader

DNS message header.

DnsIpv4AddrResourceRecord

typedef { ... } DnsIpv4AddrResourceRecord

A resource record format.

DnsIpv6AddrResourceRecord

typedef { ... } DnsIpv6AddrResourceRecord

AAAA resource record format.

DnsQuestion

typedef { ... } DnsQuestion

Question format.

DnsResourceRecord

typedef { ... } DnsResourceRecord

Resource record format.

DnsSrvResourceRecord

typedef { ... } DnsSrvResourceRecord

SRV resource record format.

Enumeration Type Documentation

DnsOpcode

enum DnsOpcode

DNS opcodes.

Enumerator
DNS_OPCODE_QUERY
DNS_OPCODE_INVERSE_QUERY
DNS_OPCODE_STATUS
DNS_OPCODE_NOTIFY
DNS_OPCODE_UPDATE

Definition at line 79 of file dns_common.h.

DnsResourceRecordClass

enum DnsResourceRecordClass

DNS resource record classes.

Enumerator
DNS_RR_CLASS_IN	Internet.
DNS_RR_CLASS_CH	Chaos.
DNS_RR_CLASS_HS	Hesiod.
DNS_RR_CLASS_ANY	Any class.

Definition at line 108 of file dns_common.h.

DnsResourceRecordType

enum DnsResourceRecordType

DNS resource record types.

Enumerator
DNS_RR_TYPE_A	Host address.
DNS_RR_TYPE_NS	Authoritative name server.
DNS_RR_TYPE_CNAME	Canonical name for an alias.
DNS_RR_TYPE_SOA	Start of a zone of authority.
DNS_RR_TYPE_WKS	Well known service description.
DNS_RR_TYPE_PTR	Domain name pointer.
DNS_RR_TYPE_HINFO	Host information.
DNS_RR_TYPE_MINFO	Mailbox or mail list information.
DNS_RR_TYPE_MX	Mail exchange.
DNS_RR_TYPE_TXT	Text strings.
DNS_RR_TYPE_AAAA	IPv6 address.
DNS_RR_TYPE_NB	NetBIOS name service.
DNS_RR_TYPE_SRV	Server selection.
DNS_RR_TYPE_NAPTR	Naming authority pointer.
DNS_RR_TYPE_NSEC	NSEC record.
DNS_RR_TYPE_EUI48	EUI-48 address.
DNS_RR_TYPE_EUI64	EUI-64 address.
DNS_RR_TYPE_AXFR	Transfer of an entire zone.
DNS_RR_TYPE_ANY	A request for all records.
DNS_RR_TYPE_URI	Uniform resource identifier.

Definition at line 121 of file dns_common.h.

DnsReturnCode

enum DnsReturnCode

DNS return codes.

Enumerator
DNS_RCODE_NO_ERROR
DNS_RCODE_FORMAT_ERROR
DNS_RCODE_SERVER_FAILURE
DNS_RCODE_NAME_ERROR
DNS_RCODE_NOT_IMPLEMENTED
DNS_RCODE_QUERY_REFUSED

Definition at line 93 of file dns_common.h.

Function Documentation

dnsCompareEncodedName()

int_t dnsCompareEncodedName	(	const DnsHeader *	message1,
		size_t	length1,
		size_t	pos1,
		const DnsHeader *	message2,
		size_t	length2,
		size_t	pos2,
		uint_t	level
	)

Compare domain names encoded with DNS notation.

Parameters

[in]	message1	Pointer to the first DNS message
[in]	length1	Length of the first DNS message
[in]	pos1	Offset of the encoded domain name within the first message
[in]	message2	Pointer to the second DNS message
[in]	length2	Length of the second DNS message
[in]	pos2	Offset of the encoded domain name within the second message
[in]	level	Current level of recursion

Returns

The function returns 0 if the domain names match, -1 if the first domain name lexicographically precedes the second name, or 1 if the second domain name lexicographically precedes the first name

Definition at line 342 of file dns_common.c.

dnsCompareName()

int_t dnsCompareName	(	const DnsHeader *	message,
		size_t	length,
		size_t	pos,
		const char_t *	name,
		uint_t	level
	)

Compare domain names.

Parameters

[in]	message	Pointer to the DNS message
[in]	length	Length of the DNS message
[in]	pos	Offset of the encoded domain name
[in]	name	NULL-terminated string that holds a domain name
[in]	level	Current level of recursion

Returns

The function returns 0 if the domain names match, -1 if the first domain name lexicographically precedes the second name, or 1 if the second domain name lexicographically precedes the first name

Definition at line 243 of file dns_common.c.

dnsEncodeName()

size_t dnsEncodeName	(	const char_t *	src,
		uint8_t *	dest
	)

Encode a domain name using the DNS name notation.

Parameters

[in]	src	Pointer to the domain name to encode
[out]	dest	Pointer to the encoded domain name (optional parameter)

Returns

Length of the encoded domain name

Definition at line 59 of file dns_common.c.

dnsGenerateIpv4ReverseName()

void dnsGenerateIpv4ReverseName	(	Ipv4Addr	ipv4Addr,
		char_t *	buffer
	)

Generate domain name for reverse DNS lookup (IPv4)

Parameters

[in]	ipv4Addr	IPv4 address
[out]	buffer	Output buffer where to store the resulting domain name

Definition at line 471 of file dns_common.c.

dnsGenerateIpv6ReverseName()

void dnsGenerateIpv6ReverseName	(	const Ipv6Addr *	ipv6Addr,
		char_t *	buffer
	)

Generate domain name for reverse DNS lookup (IPv6)

Parameters

[in]	ipv6Addr	IPv6 address
[out]	buffer	Output buffer where to store the resulting domain name

Definition at line 490 of file dns_common.c.

dnsParseName()

size_t dnsParseName	(	const DnsHeader *	message,
		size_t	length,
		size_t	pos,
		char_t *	dest,
		uint_t	level
	)

Decode a domain name that uses the DNS name encoding.

Parameters

[in]	message	Pointer to the DNS message
[in]	length	Length of the DNS message
[in]	pos	Offset of the name to decode
[out]	dest	Pointer to the decoded name (optional)
[in]	level	Current level of recursion

Returns

The position of the resource record that immediately follows the domain name

Definition at line 133 of file dns_common.c.

Variable Documentation

aa

uint8_t aa

Definition at line 171 of file dns_common.h.

ancount

uint16_t ancount

Definition at line 179 of file dns_common.h.

arcount

uint16_t arcount

Definition at line 181 of file dns_common.h.

id

uint16_t id

Definition at line 158 of file dns_common.h.

nscount

uint16_t nscount

Definition at line 180 of file dns_common.h.

opcode

uint8_t opcode

Definition at line 172 of file dns_common.h.

port

uint16_t port

Definition at line 251 of file dns_common.h.

priority

uint16_t priority

Definition at line 249 of file dns_common.h.

qclass

uint16_t qclass

Definition at line 193 of file dns_common.h.

qdcount

uint16_t qdcount

Definition at line 178 of file dns_common.h.

qr

uint8_t qr

Definition at line 173 of file dns_common.h.

qtype

uint16_t qtype

Definition at line 192 of file dns_common.h.

questions

uint8_t questions[]

Definition at line 182 of file dns_common.h.

ra

uint8_t ra

Definition at line 176 of file dns_common.h.

rclass

uint16_t rclass

Definition at line 204 of file dns_common.h.

rcode

uint8_t rcode

Definition at line 174 of file dns_common.h.

rd

uint8_t rd

Definition at line 169 of file dns_common.h.

rdata

uint8_t rdata[16]

Definition at line 207 of file dns_common.h.

rdlength

uint16_t rdlength

Definition at line 206 of file dns_common.h.

rtype

uint16_t rtype

Definition at line 203 of file dns_common.h.

target

uint8_t target[]

Definition at line 252 of file dns_common.h.

tc

uint8_t tc

Definition at line 170 of file dns_common.h.

ttl

uint32_t ttl

Definition at line 205 of file dns_common.h.

weight

uint16_t weight

Definition at line 250 of file dns_common.h.

z

uint8_t z

Definition at line 175 of file dns_common.h.