Go to the documentation of this file.
1 /*
2  * packet.h
3  *
4  * DNS packet definitions
5  *
6  * a Net::DNS like library for C
7  *
8  * (c) NLnet Labs, 2005-2006
9  *
10  * See the file LICENSE for the license
11  */
21 #ifndef LDNS_PACKET_H
22 #define LDNS_PACKET_H
24 #define LDNS_MAX_PACKETLEN 65535
26 /* allow flags to be given to ldns_pkt_query_new */
27 #define LDNS_QR 1 /* Query Response flag */
28 #define LDNS_AA 2 /* Authoritative Answer - server flag */
29 #define LDNS_TC 4 /* TrunCated - server flag */
30 #define LDNS_RD 8 /* Recursion Desired - query flag */
31 #define LDNS_CD 16 /* Checking Disabled - query flag */
32 #define LDNS_RA 32 /* Recursion Available - server flag */
33 #define LDNS_AD 64 /* Authenticated Data - server flag */
35 #include <ldns/error.h>
36 #include <ldns/common.h>
37 #include <ldns/rr.h>
38 #include <sys/time.h>
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
44 /* opcodes for pkt's */
48  LDNS_PACKET_STATUS = 2, /* there is no 3?? DNS is weird */
51 };
54 /* rcodes for pkts */
67 };
193 {
195  uint16_t _id;
197  bool _qr;
199  bool _aa;
201  bool _tc;
203  bool _rd;
205  bool _cd;
207  bool _ra;
209  bool _ad;
211  ldns_pkt_opcode _opcode; /* XXX 8 bits? */
213  uint8_t _rcode;
215  uint16_t _qdcount;
217  uint16_t _ancount;
219  uint16_t _nscount;
221  uint16_t _arcount;
222 };
223 typedef struct ldns_struct_hdr ldns_hdr;
234 {
237  /* extra items needed in a packet */
241  struct timeval timestamp;
243  uint32_t _querytime;
245  size_t _size;
249  uint16_t _edns_udp_size;
253  uint8_t _edns_version;
254  /* OPT pseudo-RR presence flag */
255  uint8_t _edns_present;
257  uint16_t _edns_z;
268 };
269 typedef struct ldns_struct_pkt ldns_pkt;
283 };
296 };
299 /* prototypes */
301 /* read */
308 uint16_t ldns_pkt_id(const ldns_pkt *p);
314 bool ldns_pkt_qr(const ldns_pkt *p);
320 bool ldns_pkt_aa(const ldns_pkt *p);
326 bool ldns_pkt_tc(const ldns_pkt *p);
332 bool ldns_pkt_rd(const ldns_pkt *p);
338 bool ldns_pkt_cd(const ldns_pkt *p);
344 bool ldns_pkt_ra(const ldns_pkt *p);
350 bool ldns_pkt_ad(const ldns_pkt *p);
368 uint16_t ldns_pkt_qdcount(const ldns_pkt *p);
374 uint16_t ldns_pkt_ancount(const ldns_pkt *p);
380 uint16_t ldns_pkt_nscount(const ldns_pkt *p);
386 uint16_t ldns_pkt_arcount(const ldns_pkt *p);
400 struct timeval ldns_pkt_timestamp(const ldns_pkt *p);
406 uint32_t ldns_pkt_querytime(const ldns_pkt *p);
413 size_t ldns_pkt_size(const ldns_pkt *p);
424 uint16_t ldns_pkt_section_count(const ldns_pkt *p, ldns_pkt_section s);
431 ldns_rr *ldns_pkt_tsig(const ldns_pkt *p);
517 bool ldns_pkt_rr(const ldns_pkt *pkt, ldns_pkt_section sec, const ldns_rr *rr);
526 bool ldns_pkt_set_flags(ldns_pkt *pkt, uint16_t flags);
533 void ldns_pkt_set_id(ldns_pkt *p, uint16_t id);
544 void ldns_pkt_set_qr(ldns_pkt *p, bool b);
550 void ldns_pkt_set_aa(ldns_pkt *p, bool b);
556 void ldns_pkt_set_tc(ldns_pkt *p, bool b);
562 void ldns_pkt_set_rd(ldns_pkt *p, bool b);
568 void ldns_pkt_set_cd(ldns_pkt *p, bool b);
574 void ldns_pkt_set_ra(ldns_pkt *p, bool b);
580 void ldns_pkt_set_ad(ldns_pkt *p, bool b);
593 void ldns_pkt_set_rcode(ldns_pkt *p, uint8_t c);
599 void ldns_pkt_set_qdcount(ldns_pkt *p, uint16_t c);
605 void ldns_pkt_set_ancount(ldns_pkt *p, uint16_t c);
611 void ldns_pkt_set_nscount(ldns_pkt *p, uint16_t c);
617 void ldns_pkt_set_arcount(ldns_pkt *p, uint16_t c);
629 void ldns_pkt_set_querytime(ldns_pkt *p, uint32_t t);
635 void ldns_pkt_set_size(ldns_pkt *p, size_t s);
642 void ldns_pkt_set_timestamp(ldns_pkt *p, struct timeval timeval);
655 void ldns_pkt_set_tsig(ldns_pkt *p, ldns_rr *t);
670 uint16_t ldns_pkt_edns_udp_size(const ldns_pkt *packet);
676 uint8_t ldns_pkt_edns_extended_rcode(const ldns_pkt *packet);
682 uint8_t ldns_pkt_edns_version(const ldns_pkt *packet);
688 uint16_t ldns_pkt_edns_z(const ldns_pkt *packet);
694 ldns_rdf *ldns_pkt_edns_data(const ldns_pkt *packet);
701 bool ldns_pkt_edns_do(const ldns_pkt *packet);
707 void ldns_pkt_set_edns_do(ldns_pkt *packet, bool value);
712 uint16_t ldns_pkt_edns_unassigned(const ldns_pkt *packet);
719 void ldns_pkt_set_edns_unassigned(ldns_pkt *packet, uint16_t value);
730 bool ldns_pkt_edns(const ldns_pkt *packet);
737 void ldns_pkt_set_edns_udp_size(ldns_pkt *packet, uint16_t s);
743 void ldns_pkt_set_edns_extended_rcode(ldns_pkt *packet, uint8_t c);
749 void ldns_pkt_set_edns_version(ldns_pkt *packet, uint8_t v);
755 void ldns_pkt_set_edns_z(ldns_pkt *packet, uint16_t z);
761 void ldns_pkt_set_edns_data(ldns_pkt *packet, ldns_rdf *data);
767 ldns_pkt *ldns_pkt_new(void);
774 void ldns_pkt_free(ldns_pkt *packet);
785 ldns_status ldns_pkt_query_new_frm_str(ldns_pkt **p, const char *rr_name, ldns_rr_type rr_type, ldns_rr_class rr_class , uint16_t flags);
797 ldns_status ldns_pkt_ixfr_request_new_frm_str(ldns_pkt **p, const char *rr_name, ldns_rr_class rr_class, uint16_t flags, ldns_rr* soa);
808 ldns_pkt *ldns_pkt_query_new(ldns_rdf *rr_name, ldns_rr_type rr_type, ldns_rr_class rr_class, uint16_t flags);
820 ldns_pkt *ldns_pkt_ixfr_request_new(ldns_rdf *rr_name, ldns_rr_class rr_class, uint16_t flags, ldns_rr* soa);
828 ldns_pkt *ldns_pkt_clone(const ldns_pkt *pkt);
865 bool ldns_pkt_push_rr(ldns_pkt *packet, ldns_pkt_section section, ldns_rr *rr);
883 bool ldns_pkt_push_rr_list(ldns_pkt *packet, ldns_pkt_section section, ldns_rr_list *list);
899 bool ldns_pkt_empty(ldns_pkt *p);
901 #ifdef __cplusplus
902 }
903 #endif
905 #endif /* LDNS_PACKET_H */
ldns_pkt_rcode ldns_pkt_get_rcode(const ldns_pkt *p)
Return the packet's response code.
Definition: packet.c:94
Definition: packet.h:57
Definition: packet.h:45
List or Set of Resource Records.
Definition: rr.h:337
ldns_pkt * ldns_pkt_clone(const ldns_pkt *pkt)
clones the given packet, creating a fully allocated copy
Definition: packet.c:1125
enum ldns_enum_rr_class ldns_rr_class
Definition: rr.h:61
void ldns_pkt_set_answerfrom(ldns_pkt *p, ldns_rdf *r)
Set the packet's answering server.
Definition: packet.c:593
signed char ldns_pkt_set_flags(ldns_pkt *pkt, uint16_t flags)
sets the flags in a packet.
Definition: packet.c:823
struct timeval ldns_pkt_timestamp(const ldns_pkt *p)
Return the packet's timestamp.
Definition: packet.c:201
Definition: packet.h:60
The different types of packets.
Definition: packet.h:289
uint8_t ldns_pkt_edns_extended_rcode(const ldns_pkt *packet)
return the packet's edns extended rcode
Definition: packet.c:213
signed char ldns_pkt_aa(const ldns_pkt *p)
Read the packet's aa bit.
Definition: packet.c:52
void ldns_pkt_set_section_count(ldns_pkt *p, ldns_pkt_section s, uint16_t x)
Set a packet's section count to x.
Definition: packet.c:642
ldns_rr_list * ldns_pkt_additional(const ldns_pkt *p)
Return the packet's additional section.
Definition: packet.c:142
Definition: packet.h:46
void ldns_pkt_set_ra(ldns_pkt *p, signed char b)
Set the packet's ra bit.
void ldns_pkt_set_edns_udp_size(ldns_pkt *packet, uint16_t s)
Set the packet's edns udp size.
Definition: packet.c:612
Definition: packet.h:290
ldns_rdf * ldns_pkt_answerfrom(const ldns_pkt *p)
Return the packet's answerfrom.
Definition: packet.c:195
Definition: packet.h:65
Definition: packet.h:55
uint32_t _querytime
The duration of the query this packet is an answer to.
Definition: packet.h:243
Resource Record.
Definition: rr.h:309
void ldns_pkt_set_edns_extended_rcode(ldns_pkt *packet, uint8_t c)
Set the packet's edns extended rcode.
Definition: packet.c:618
signed char _rd
Recursion desired.
Definition: packet.h:203
uint16_t ldns_pkt_arcount(const ldns_pkt *p)
Return the packet's ar count.
Definition: packet.c:118
void ldns_pkt_set_ancount(ldns_pkt *p, uint16_t c)
Set the packet's an count.
Definition: packet.c:569
ldns_rr * ldns_pkt_tsig(const ldns_pkt *p)
Return the packet's tsig pseudo rr's.
Definition: packet.c:465
signed char ldns_pkt_push_rr_list(ldns_pkt *packet, ldns_pkt_section section, ldns_rr_list *list)
push a rr_list on a packet
Definition: packet.c:717
Definition: packet.h:275
signed char _ra
Recursion available.
Definition: packet.h:207
signed char ldns_pkt_ra(const ldns_pkt *p)
Read the packet's ra bit.
Definition: packet.c:76
ldns_pkt * ldns_pkt_new(void)
allocates and initializes a ldns_pkt structure.
Definition: packet.c:754
Definition: packet.h:59
Definition: packet.h:64
signed char _tc
Packet truncated.
Definition: packet.h:201
ldns_rr_list * ldns_pkt_authority(const ldns_pkt *p)
Return the packet's authority section.
Definition: packet.c:136
void ldns_pkt_set_querytime(ldns_pkt *p, uint32_t t)
Set the packet's query time.
Definition: packet.c:587
ldns_pkt_opcode ldns_pkt_get_opcode(const ldns_pkt *p)
Read the packet's code.
Definition: packet.c:88
uint16_t _arcount
add sec
Definition: packet.h:221
ldns_rr_list * ldns_pkt_answer(const ldns_pkt *p)
Return the packet's answer section.
Definition: packet.c:130
signed char ldns_pkt_cd(const ldns_pkt *p)
Read the packet's cd bit.
Definition: packet.c:70
void ldns_pkt_set_edns_data(ldns_pkt *packet, ldns_rdf *data)
Set the packet's edns data.
Definition: packet.c:636
Definition: packet.h:277
ldns_rdf * _edns_data
Arbitrary EDNS rdata.
Definition: packet.h:259
ldns_pkt * ldns_pkt_query_new(ldns_rdf *rr_name, ldns_rr_type rr_type, ldns_rr_class rr_class, uint16_t flags)
creates a packet with a query in it for the given name, type and class.
Definition: packet.c:1059
uint8_t _edns_present
Definition: packet.h:255
enum ldns_enum_pkt_opcode ldns_pkt_opcode
Definition: packet.h:52
uint16_t ldns_pkt_section_count(const ldns_pkt *p, ldns_pkt_section s)
Return the number of RRs in the given section.
Definition: packet.c:404
void ldns_pkt_set_random_id(ldns_pkt *p)
Set the packet's id to a random value.
Definition: packet.c:477
signed char ldns_pkt_tc(const ldns_pkt *p)
Read the packet's tc bit.
Definition: packet.c:58
void ldns_pkt_set_tsig(ldns_pkt *p, ldns_rr *t)
Set the packet's tsig rr.
Definition: packet.c:663
uint16_t _ancount
answer sec
Definition: packet.h:217
ldns_rr_list * _question
Question section.
Definition: packet.h:261
signed char _cd
Checking disabled.
Definition: packet.h:205
ldns_rr_list * ldns_pkt_get_section_clone(const ldns_pkt *p, ldns_pkt_section s)
return all the rr_list's in the packet.
Definition: packet.c:444
void ldns_pkt_set_qdcount(ldns_pkt *p, uint16_t c)
Set the packet's qd count.
Definition: packet.c:563
ldns_rr_list * _answer
Answer section.
Definition: packet.h:263
ldns_rr * _tsig_rr
Optional tsig rr.
Definition: packet.h:247
uint16_t ldns_pkt_nscount(const ldns_pkt *p)
Return the packet's ns count.
Definition: packet.c:112
ldns_rr_list * ldns_pkt_question(const ldns_pkt *p)
Return the packet's question section.
Definition: packet.c:124
void ldns_pkt_set_arcount(ldns_pkt *p, uint16_t c)
Set the packet's arcount.
Definition: packet.c:581
ldns_pkt_opcode _opcode
Query type.
Definition: packet.h:211
uint16_t ldns_pkt_edns_udp_size(const ldns_pkt *packet)
return the packet's edns udp size
Definition: packet.c:207
size_t _size
The size of the wire format of the packet in octets.
Definition: packet.h:245
void ldns_pkt_set_rd(ldns_pkt *p, signed char b)
Set the packet's rd bit.
signed char ldns_pkt_empty(ldns_pkt *p)
check if a packet is empty
Definition: packet.c:430
Definition: packet.h:295
ldns_rr_list * ldns_pkt_all_noquestion(const ldns_pkt *p)
Return the packet's answer, authority and additional sections concatenated, in a new rr_list clone.
Definition: packet.c:168
uint8_t _edns_version
EDNS Version.
Definition: packet.h:253
signed char _aa
Authoritative answer.
Definition: packet.h:199
signed char ldns_pkt_qr(const ldns_pkt *p)
Read the packet's qr bit.
Definition: packet.c:46
signed char ldns_pkt_rd(const ldns_pkt *p)
Read the packet's rd bit.
Definition: packet.c:64
uint16_t _id
Id of a packet.
Definition: packet.h:195
void ldns_pkt_set_id(ldns_pkt *p, uint16_t id)
Set the packet's id.
Definition: packet.c:471
enum ldns_enum_rr_type ldns_rr_type
Definition: rr.h:243
ldns_rr_list * ldns_pkt_rr_list_by_name(const ldns_pkt *p, const ldns_rdf *r, ldns_pkt_section s)
return all the rr with a specific name from a packet.
Definition: packet.c:267
Definition: packet.h:62
Definition: packet.h:292
Definition: packet.h:58
void ldns_pkt_set_authority(ldns_pkt *p, ldns_rr_list *rr)
directly set the authority section
Definition: packet.c:527
ldns_rdf * ldns_pkt_edns_data(const ldns_pkt *packet)
return the packet's edns data
Definition: packet.c:260
void ldns_pkt_set_cd(ldns_pkt *p, signed char b)
Set the packet's cd bit.
ldns_pkt_type ldns_pkt_reply_type(const ldns_pkt *p)
looks inside the packet to determine what kind of packet it is, AUTH, NXDOMAIN, REFERRAL,...
Definition: packet.c:1079
signed char ldns_pkt_push_rr(ldns_pkt *packet, ldns_pkt_section section, ldns_rr *rr)
push an rr on a packet
Definition: packet.c:669
void ldns_pkt_set_tc(ldns_pkt *p, signed char b)
Set the packet's tc bit.
ldns_rr_list * ldns_pkt_all(const ldns_pkt *p)
Return the packet's question, answer, authority and additional sections concatenated,...
Definition: packet.c:149
struct timeval timestamp
Timestamp of the time the packet was sent or created.
Definition: packet.h:241
void ldns_pkt_set_edns_version(ldns_pkt *packet, uint8_t v)
Set the packet's edns version.
Definition: packet.c:624
void ldns_pkt_set_edns_unassigned(ldns_pkt *packet, uint16_t value)
Set the packet's EDNS header bits that are unassigned.
Definition: packet.c:253
Definition: packet.h:50
Definition: packet.h:56
void ldns_pkt_set_timestamp(ldns_pkt *p, struct timeval timeval)
Set the packet's timestamp.
enum ldns_enum_pkt_type ldns_pkt_type
Definition: packet.h:297
Definition: packet.h:63
uint32_t ldns_pkt_querytime(const ldns_pkt *p)
Return the packet's querytime.
Definition: packet.c:189
enum ldns_enum_status ldns_status
Definition: error.h:146
DNS packet.
Definition: packet.h:233
used to get all non-question rrs from a packet
Definition: packet.h:282
void ldns_pkt_set_ad(ldns_pkt *p, signed char b)
Set the packet's ad bit.
size_t ldns_pkt_size(const ldns_pkt *p)
Return the packet's size in bytes.
Definition: packet.c:183
bogus section, if not interested
Definition: packet.h:280
Definition: packet.h:49
uint16_t ldns_pkt_ancount(const ldns_pkt *p)
Return the packet's an count.
Definition: packet.c:106
signed char _ad
Authentic data.
Definition: packet.h:209
uint16_t _qdcount
question sec
Definition: packet.h:215
uint16_t ldns_pkt_edns_z(const ldns_pkt *packet)
return the packet's edns z value
Definition: packet.c:225
uint16_t ldns_pkt_qdcount(const ldns_pkt *p)
Return the packet's qd count.
Definition: packet.c:100
Resource record data field.
Definition: rdata.h:195
void ldns_pkt_set_aa(ldns_pkt *p, signed char b)
Set the packet's aa bit.
enum ldns_enum_pkt_section ldns_pkt_section
Definition: packet.h:284
uint16_t ldns_pkt_id(const ldns_pkt *p)
Read the packet id.
Definition: packet.c:40
void ldns_pkt_set_edns_do(ldns_pkt *packet, signed char value)
Set the packet's edns do bit.
void ldns_pkt_set_rcode(ldns_pkt *p, uint8_t c)
Set the packet's response code.
Definition: packet.c:557
void ldns_pkt_set_answer(ldns_pkt *p, ldns_rr_list *rr)
directly set the answer section
Definition: packet.c:521
Definition: packet.h:61
ldns_rr_list * _additional
Additional section.
Definition: packet.h:267
void ldns_pkt_set_edns_z(ldns_pkt *packet, uint16_t z)
Set the packet's edns z value.
Definition: packet.c:630
signed char ldns_pkt_safe_push_rr_list(ldns_pkt *pkt, ldns_pkt_section sec, ldns_rr_list *list)
push an rr_list to a packet, provided the RRs are not already there.
Definition: packet.c:729
ldns_hdr * _header
Header section.
Definition: packet.h:236
uint16_t _edns_udp_size
EDNS0 available buffer size, see RFC2671.
Definition: packet.h:249
signed char ldns_pkt_rr(const ldns_pkt *pkt, ldns_pkt_section sec, const ldns_rr *rr)
check to see if an rr exist in the packet
Definition: packet.c:377
uint8_t ldns_pkt_edns_version(const ldns_pkt *packet)
return the packet's edns version
Definition: packet.c:219
Definition: packet.h:48
ldns_status ldns_pkt_ixfr_request_new_frm_str(ldns_pkt **p, const char *rr_name, ldns_rr_class rr_class, uint16_t flags, ldns_rr *soa)
creates an IXFR request packet for the given name, class.
Definition: packet.c:1000
ldns_pkt * ldns_pkt_ixfr_request_new(ldns_rdf *rr_name, ldns_rr_class rr_class, uint16_t flags, ldns_rr *soa)
creates an IXFR request packet for the given name, type and class.
Definition: packet.c:1067
uint16_t _edns_z
Reserved EDNS data bits.
Definition: packet.h:257
void ldns_pkt_set_opcode(ldns_pkt *p, ldns_pkt_opcode c)
Set the packet's opcode.
Definition: packet.c:551
Definition: packet.h:66
Definition: packet.h:293
signed char ldns_pkt_edns_do(const ldns_pkt *packet)
return the packet's edns do bit
Definition: packet.c:231
Definition: packet.h:291
void ldns_pkt_set_qr(ldns_pkt *p, signed char b)
Set the packet's qr bit.
uint16_t _nscount
auth sec
Definition: packet.h:219
void ldns_pkt_set_nscount(ldns_pkt *p, uint16_t c)
Set the packet's ns count.
Definition: packet.c:575
uint8_t _rcode
Response code.
Definition: packet.h:213
signed char _qr
Query bit (0=query, 1=answer)
Definition: packet.h:197
Definition: packet.h:276
Definition: packet.h:294
ldns_rr_list * _authority
Authority section.
Definition: packet.h:265
uint8_t _edns_extended_rcode
EDNS0 Extended rcode.
Definition: packet.h:251
void ldns_pkt_free(ldns_pkt *packet)
frees the packet structure and all data that it contains.
Definition: packet.c:807
enum ldns_enum_pkt_rcode ldns_pkt_rcode
Definition: packet.h:68
signed char ldns_pkt_ad(const ldns_pkt *p)
Read the packet's ad bit.
Definition: packet.c:82
Definition: packet.h:47
void ldns_pkt_set_question(ldns_pkt *p, ldns_rr_list *rr)
directly set the question section
Definition: packet.c:515
signed char ldns_pkt_safe_push_rr(ldns_pkt *pkt, ldns_pkt_section sec, ldns_rr *rr)
push an rr on a packet, provided the RR is not there.
Definition: packet.c:705
Definition: packet.h:278
ldns_rdf * _answerfrom
an rdf (A or AAAA) with the IP address of the server it is from
Definition: packet.h:239
ldns_status ldns_pkt_query_new_frm_str(ldns_pkt **p, const char *rr_name, ldns_rr_type rr_type, ldns_rr_class rr_class, uint16_t flags)
creates a query packet for the given name, type, class.
Definition: packet.c:992
void ldns_pkt_set_additional(ldns_pkt *p, ldns_rr_list *rr)
directly set the additional section
Definition: packet.c:509
uint16_t ldns_pkt_edns_unassigned(const ldns_pkt *packet)
return the packet's EDNS header bits that are unassigned.
Definition: packet.c:247
The sections of a packet.
Definition: packet.h:274
ldns_rr_list * ldns_pkt_rr_list_by_type(const ldns_pkt *p, ldns_rr_type t, ldns_pkt_section s)
return all the rr with a specific type from a packet.
Definition: packet.c:304
void ldns_pkt_set_size(ldns_pkt *p, size_t s)
Set the packet's size.
Definition: packet.c:606
signed char ldns_pkt_edns(const ldns_pkt *packet)
returns true if this packet needs and EDNS rr to be sent.
Definition: packet.c:741
ldns_rr_list * ldns_pkt_rr_list_by_name_and_type(const ldns_pkt *packet, const ldns_rdf *ownername, ldns_rr_type type, ldns_pkt_section sec)
return all the rr with a specific type and type from a packet.
Definition: packet.c:340