/usr/include/gnunet/gnunet_dnsparser_lib.h is in gnunet-dev 0.10.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 | /*
This file is part of GNUnet
(C) 2010-2013 Christian Grothoff (and other contributing authors)
GNUnet 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 3, 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
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_dnsparser_lib.h
* @brief API for helper library to parse DNS packets.
* @author Philipp Toelke
* @author Christian Grothoff
*/
#ifndef GNUNET_DNSPARSER_LIB_H
#define GNUNET_DNSPARSER_LIB_H
#include "gnunet_util_lib.h"
#include "gnunet_tun_lib.h"
/**
* Maximum length of a label in DNS.
*/
#define GNUNET_DNSPARSER_MAX_LABEL_LENGTH 63
/**
* Maximum length of a name in DNS.
*/
#define GNUNET_DNSPARSER_MAX_NAME_LENGTH 253
/**
* A few common DNS types.
*/
#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_AAAA 28
#define GNUNET_DNSPARSER_TYPE_SRV 33
#define GNUNET_DNSPARSER_TYPE_CERT 37
#define GNUNET_DNSPARSER_TYPE_TLSA 52
/**
* A DNS query.
*/
struct GNUNET_DNSPARSER_Query
{
/**
* Name of the record that the query is for (0-terminated).
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use 'GNUNET_DNSPARSER_check_label' to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *name;
/**
* See GNUNET_DNSPARSER_TYPE_*.
*/
uint16_t type;
/**
* See GNUNET_TUN_DNS_CLASS_*.
*/
uint16_t dns_traffic_class;
};
/**
* Information from MX records (RFC 1035).
*/
struct GNUNET_DNSPARSER_MxRecord
{
/**
* Preference for this entry (lower value is higher preference).
*/
uint16_t preference;
/**
* Name of the mail server.
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use 'GNUNET_DNSPARSER_check_label' to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *mxhost;
};
/**
* Information from SRV records (RFC 2782). The 'service', 'proto'
* and 'domain_name' fields together give the DNS-name which for SRV
* records is of the form "_$SERVICE._$PROTO.$DOMAIN_NAME". The DNS
* parser provides the full name in 'struct DNSPARSER_Record' and the
* individual components in the respective fields of this struct.
* When serializing, you CAN set the 'name' field of 'struct
* GNUNET_DNSPARSER_Record' to NULL, in which case the DNSPARSER code
* will populate 'name' from the 'service', 'proto' and 'domain_name'
* fields in this struct.
*/
struct GNUNET_DNSPARSER_SrvRecord
{
/**
* Service name without the underscore (!). Note that RFC 6335 clarifies the
* set of legal characters for service names.
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use 'GNUNET_DNSPARSER_check_label' to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *service;
/**
* Transport protocol (typcially "tcp" or "udp", but others might be allowed).
* Without the underscore (!).
*/
char *proto;
/**
* Domain name for which the record is valid
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use 'GNUNET_DNSPARSER_check_label' to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *domain_name;
/**
* Hostname offering the service.
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use 'GNUNET_DNSPARSER_check_label' to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *target;
/**
* Preference for this entry (lower value is higher preference). Clients
* will contact hosts from the lowest-priority group first and fall back
* to higher priorities if the low-priority entries are unavailable.
*/
uint16_t priority;
/**
* Relative weight for records with the same priority. Clients will use
* the hosts of the same (lowest) priority with a probability proportional
* to the weight given.
*/
uint16_t weight;
/**
* TCP or UDP port of the service.
*/
uint16_t port;
};
/**
* DNS CERT types as defined in RFC 4398.
*/
enum GNUNET_DNSPARSER_CertType
{
/**
* Reserved value
*/
GNUNET_DNSPARSER_CERTTYPE_RESERVED = 0,
/**
* An x509 PKIX certificate
*/
GNUNET_DNSPARSER_CERTTYPE_PKIX = 1,
/**
* A SKPI certificate
*/
GNUNET_DNSPARSER_CERTTYPE_SKPI = 2,
/**
* A PGP certificate
*/
GNUNET_DNSPARSER_CERTTYPE_PGP = 3,
/**
* An x509 PKIX cert URL
*/
GNUNET_DNSPARSER_CERTTYPE_IPKIX = 4,
/**
* A SKPI cert URL
*/
GNUNET_DNSPARSER_CERTTYPE_ISKPI = 5,
/**
* A PGP cert fingerprint and URL
*/
GNUNET_DNSPARSER_CERTTYPE_IPGP = 6,
/**
* An attribute Certificate
*/
GNUNET_DNSPARSER_CERTTYPE_ACPKIX = 7,
/**
* An attribute cert URL
*/
GNUNET_DNSPARSER_CERTTYPE_IACKPIX = 8
};
/**
* DNSCERT algorithms as defined in http://www.iana.org/assignments/
* dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml, under dns-sec-alg-numbers-1
*/
enum GNUNET_DNSPARSER_CertAlgorithm
{
/**
* No defined
*/
GNUNET_DNSPARSER_CERTALGO_UNDEFINED = 0,
/**
* RSA/MD5
*/
GNUNET_DNSPARSER_CERTALGO_RSAMD5 = 1,
/**
* Diffie-Hellman
*/
GNUNET_DNSPARSER_CERTALGO_DH = 2,
/**
* DSA/SHA1
*/
GNUNET_DNSPARSER_CERTALGO_DSASHA = 3,
/**
* Reserved
*/
GNUNET_DNSPARSER_CERTALGO_RSRVD4 = 4,
/**
* RSA/SHA1
*/
GNUNET_DNSPARSER_CERTALGO_RSASHA = 5,
/**
* DSA/NSEC3/SHA
*/
GNUNET_DNSPARSER_CERTALGO_DSANSEC3 = 6,
/**
* RSA/NSEC3/SHA
*/
GNUNET_DNSPARSER_CERTALGO_RSANSEC3 = 7,
/**
* RSA/SHA256
*/
GNUNET_DNSPARSER_CERTALGO_RSASHA256 = 8,
/**
* Reserved
*/
GNUNET_DNSPARSER_CERTALGO_RSRVD9 = 9,
/**
* RSA/SHA512
*/
GNUNET_DNSPARSER_CERTALGO_RSASHA512 = 10,
/**
* GOST R 34.10-2001
*/
GNUNET_DNSPARSER_CERTALGO_GOST_R34 = 12,
/**
* ECDSA Curve P-256/SHA256
*/
GNUNET_DNSPARSER_CERTALGO_ECDSA_P256SHA256 = 13,
/**
* ECDSA Curve P-384/SHA384
*/
GNUNET_DNSPARSER_CERTALGO_ECDSA_P384SHA384 = 14
};
/**
* Information from CERT records (RFC 4034).
*/
struct GNUNET_DNSPARSER_CertRecord
{
/**
* Certificate type
*/
enum GNUNET_DNSPARSER_CertType cert_type;
/**
* Certificate KeyTag
*/
uint16_t cert_tag;
/**
* Algorithm
*/
enum GNUNET_DNSPARSER_CertAlgorithm algorithm;
/**
* Number of bytes in @e certificate_data
*/
size_t certificate_size;
/**
* Data of the certificate.
*/
char *certificate_data;
};
/**
* Information from SOA records (RFC 1035).
*/
struct GNUNET_DNSPARSER_SoaRecord
{
/**
* The domainname of the name server that was the
* original or primary source of data for this zone.
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use #GNUNET_DNSPARSER_check_label to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *mname;
/**
* A domainname which specifies the mailbox of the
* person responsible for this zone.
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use 'GNUNET_DNSPARSER_check_label' to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *rname;
/**
* The version number of the original copy of the zone.
*/
uint32_t serial;
/**
* Time interval before the zone should be refreshed.
*/
uint32_t refresh;
/**
* Time interval that should elapse before a failed refresh should
* be retried.
*/
uint32_t retry;
/**
* Time value that specifies the upper limit on the time interval
* that can elapse before the zone is no longer authoritative.
*/
uint32_t expire;
/**
* The bit minimum TTL field that should be exported with any RR
* from this zone.
*/
uint32_t minimum_ttl;
};
/**
* Binary record information (unparsed).
*/
struct GNUNET_DNSPARSER_RawRecord
{
/**
* Binary record data.
*/
void *data;
/**
* Number of bytes in data.
*/
size_t data_len;
};
/**
* A DNS response record.
*/
struct GNUNET_DNSPARSER_Record
{
/**
* Name of the record that the query is for (0-terminated).
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use #GNUNET_DNSPARSER_check_label to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *name;
/**
* Payload of the record (which one of these is valid depends on the 'type').
*/
union
{
/**
* For NS, CNAME and PTR records, this is the uncompressed 0-terminated hostname.
* In UTF-8 format. The library will convert from and to DNS-IDNA
* as necessary. Use #GNUNET_DNSPARSER_check_label to test if an
* individual label is well-formed. If a given name is not well-formed,
* creating the DNS packet will fail.
*/
char *hostname;
/**
* SOA data for SOA records.
*/
struct GNUNET_DNSPARSER_SoaRecord *soa;
/**
* CERT data for CERT records.
*/
struct GNUNET_DNSPARSER_CertRecord *cert;
/**
* MX data for MX records.
*/
struct GNUNET_DNSPARSER_MxRecord *mx;
/**
* SRV data for SRV records.
*/
struct GNUNET_DNSPARSER_SrvRecord *srv;
/**
* Raw data for all other types.
*/
struct GNUNET_DNSPARSER_RawRecord raw;
} data;
/**
* When does the record expire?
*/
struct GNUNET_TIME_Absolute expiration_time;
/**
* See GNUNET_DNSPARSER_TYPE_*.
*/
uint16_t type;
/**
* See GNUNET_TUN_DNS_CLASS_*.
*/
uint16_t dns_traffic_class;
};
/**
* Easy-to-process, parsed version of a DNS packet.
*/
struct GNUNET_DNSPARSER_Packet
{
/**
* Array of all queries in the packet, must contain "num_queries" entries.
*/
struct GNUNET_DNSPARSER_Query *queries;
/**
* Array of all answers in the packet, must contain "num_answers" entries.
*/
struct GNUNET_DNSPARSER_Record *answers;
/**
* Array of all authority records in the packet, must contain "num_authority_records" entries.
*/
struct GNUNET_DNSPARSER_Record *authority_records;
/**
* Array of all additional answers in the packet, must contain "num_additional_records" entries.
*/
struct GNUNET_DNSPARSER_Record *additional_records;
/**
* Number of queries in the packet.
*/
unsigned int num_queries;
/**
* Number of answers in the packet, should be 0 for queries.
*/
unsigned int num_answers;
/**
* Number of authoritative answers in the packet, should be 0 for queries.
*/
unsigned int num_authority_records;
/**
* Number of additional records in the packet, should be 0 for queries.
*/
unsigned int num_additional_records;
/**
* Bitfield of DNS flags.
*/
struct GNUNET_TUN_DnsFlags flags;
/**
* DNS ID (to match replies to requests).
*/
uint16_t id;
};
/**
* Check if a label in UTF-8 format can be coded into valid IDNA.
* This can fail if the ASCII-conversion becomes longer than 63 characters.
*
* @param label label to check (UTF-8 string)
* @return #GNUNET_OK if the label can be converted to IDNA,
* #GNUNET_SYSERR if the label is not valid for DNS names
*/
int
GNUNET_DNSPARSER_check_label (const char *label);
/**
* Check if a hostname in UTF-8 format can be coded into valid IDNA.
* This can fail if a label becomes longer than 63 characters or if
* the entire name exceeds 253 characters.
*
* @param name name to check (UTF-8 string)
* @return #GNUNET_OK if the label can be converted to IDNA,
* #GNUNET_SYSERR if the label is not valid for DNS names
*/
int
GNUNET_DNSPARSER_check_name (const char *name);
/**
* Parse a UDP payload of a DNS packet in to a nice struct for further
* processing and manipulation.
*
* @param udp_payload wire-format of the DNS packet
* @param udp_payload_length number of bytes in @a udp_payload
* @return NULL on error, otherwise the parsed packet
*/
struct GNUNET_DNSPARSER_Packet *
GNUNET_DNSPARSER_parse (const char *udp_payload,
size_t udp_payload_length);
/**
* Free memory taken by a packet.
*
* @param p packet to free
*/
void
GNUNET_DNSPARSER_free_packet (struct GNUNET_DNSPARSER_Packet *p);
/**
* Given a DNS packet @a p, generate the corresponding UDP payload.
* Note that we do not attempt to pack the strings with pointers
* as this would complicate the code and this is about being
* simple and secure, not fast, fancy and broken like bind.
*
* @param p packet to pack
* @param max maximum allowed size for the resulting UDP payload
* @param buf set to a buffer with the packed message
* @param buf_length set to the length of @a buf
* @return #GNUNET_SYSERR if @a p is invalid
* #GNUNET_NO if @a p was truncated (but there is still a result in @a buf)
* #GNUNET_OK if @a p was packed completely into @a buf
*/
int
GNUNET_DNSPARSER_pack (const struct GNUNET_DNSPARSER_Packet *p,
uint16_t max,
char **buf,
size_t *buf_length);
/* ***************** low-level packing API ******************** */
/**
* Add a DNS name to the UDP packet at the given location, converting
* the name to IDNA notation as necessary.
*
* @param dst where to write the name (UDP packet)
* @param dst_len number of bytes in @a dst
* @param off pointer to offset where to write the name (increment by bytes used)
* must not be changed if there is an error
* @param name name to write
* @return #GNUNET_SYSERR if @a name is invalid
* #GNUNET_NO if @a name did not fit
* #GNUNET_OK if @a name was added to @a dst
*/
int
GNUNET_DNSPARSER_builder_add_name (char *dst,
size_t dst_len,
size_t *off,
const char *name);
/**
* Add a DNS query to the UDP packet at the given location.
*
* @param dst where to write the query
* @param dst_len number of bytes in @a dst
* @param off pointer to offset where to write the query (increment by bytes used)
* must not be changed if there is an error
* @param query query to write
* @return #GNUNET_SYSERR if @a query is invalid
* #GNUNET_NO if @a query did not fit
* #GNUNET_OK if @a query was added to @a dst
*/
int
GNUNET_DNSPARSER_builder_add_query (char *dst,
size_t dst_len,
size_t *off,
const struct GNUNET_DNSPARSER_Query *query);
/**
* Add an MX record to the UDP packet at the given location.
*
* @param dst where to write the mx record
* @param dst_len number of bytes in @a dst
* @param off pointer to offset where to write the mx information (increment by bytes used);
* can also change if there was an error
* @param mx mx information to write
* @return #GNUNET_SYSERR if @a mx is invalid
* #GNUNET_NO if @a mx did not fit
* #GNUNET_OK if @a mx was added to @a dst
*/
int
GNUNET_DNSPARSER_builder_add_mx (char *dst,
size_t dst_len,
size_t *off,
const struct GNUNET_DNSPARSER_MxRecord *mx);
/**
* Add an SOA record to the UDP packet at the given location.
*
* @param dst where to write the SOA record
* @param dst_len number of bytes in @a dst
* @param off pointer to offset where to write the SOA information (increment by bytes used)
* can also change if there was an error
* @param soa SOA information to write
* @return #GNUNET_SYSERR if @a soa is invalid
* #GNUNET_NO if @a soa did not fit
* #GNUNET_OK if @a soa was added to @a dst
*/
int
GNUNET_DNSPARSER_builder_add_soa (char *dst,
size_t dst_len,
size_t *off,
const struct GNUNET_DNSPARSER_SoaRecord *soa);
/**
* Add CERT record to the UDP packet at the given location.
*
* @param dst where to write the CERT record
* @param dst_len number of bytes in @a dst
* @param off pointer to offset where to write the CERT information (increment by bytes used)
* can also change if there was an error
* @param cert CERT information to write
* @return #GNUNET_SYSERR if @a soa is invalid
* #GNUNET_NO if @a soa did not fit
* #GNUNET_OK if @a soa was added to @a dst
*/
int
GNUNET_DNSPARSER_builder_add_cert (char *dst,
size_t dst_len,
size_t *off,
const struct GNUNET_DNSPARSER_CertRecord *cert);
/**
* Add an SRV record to the UDP packet at the given location.
*
* @param dst where to write the SRV record
* @param dst_len number of bytes in @a dst
* @param off pointer to offset where to write the SRV information (increment by bytes used)
* can also change if there was an error
* @param srv SRV information to write
* @return #GNUNET_SYSERR if @a srv is invalid
* #GNUNET_NO if @a srv did not fit
* #GNUNET_OK if @a srv was added to @a dst
*/
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 ******************** */
/**
* Parse a DNS record entry.
*
* @param udp_payload entire UDP payload
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the record to parse in the udp_payload (to be
* incremented by the size of the record)
* @param r where to write the record information
* @return #GNUNET_OK on success, #GNUNET_SYSERR if the record is malformed
*/
int
GNUNET_DNSPARSER_parse_record (const char *udp_payload,
size_t udp_payload_length,
size_t *off,
struct GNUNET_DNSPARSER_Record *r);
/**
* Parse name inside of a DNS query or record.
*
* @param udp_payload entire UDP payload
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the name to parse in the udp_payload (to be
* incremented by the size of the name)
* @return name as 0-terminated C string on success, NULL if the payload is malformed
*/
char *
GNUNET_DNSPARSER_parse_name (const char *udp_payload,
size_t udp_payload_length,
size_t *off);
/**
* Parse a DNS query entry.
*
* @param udp_payload entire UDP payload
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the query to parse in the udp_payload (to be
* incremented by the size of the query)
* @param q where to write the query information
* @return #GNUNET_OK on success, #GNUNET_SYSERR if the query is malformed
*/
int
GNUNET_DNSPARSER_parse_query (const char *udp_payload,
size_t udp_payload_length,
size_t *off,
struct GNUNET_DNSPARSER_Query *q);
/**
* Parse a DNS SOA record.
*
* @param udp_payload reference to UDP packet
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the query to parse in the SOA record (to be
* incremented by the size of the record), unchanged on error
* @return the parsed SOA record, NULL on error
*/
struct GNUNET_DNSPARSER_SoaRecord *
GNUNET_DNSPARSER_parse_soa (const char *udp_payload,
size_t udp_payload_length,
size_t *off);
/**
* Parse a DNS CERT record.
*
* @param udp_payload reference to UDP packet
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the query to parse in the CERT record (to be
* incremented by the size of the record), unchanged on error
* @return the parsed CERT record, NULL on error
*/
struct GNUNET_DNSPARSER_CertRecord *
GNUNET_DNSPARSER_parse_cert (const char *udp_payload,
size_t udp_payload_length,
size_t *off);
/**
* Parse a DNS MX record.
*
* @param udp_payload reference to UDP packet
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the query to parse in the MX record (to be
* incremented by the size of the record), unchanged on error
* @return the parsed MX record, NULL on error
*/
struct GNUNET_DNSPARSER_MxRecord *
GNUNET_DNSPARSER_parse_mx (const char *udp_payload,
size_t udp_payload_length,
size_t *off);
/**
* Parse a DNS SRV record.
*
* @param r_name name of the SRV record
* @param udp_payload reference to UDP packet
* @param udp_payload_length length of @a udp_payload
* @param off pointer to the offset of the query to parse in the SRV record (to be
* incremented by the size of the record), unchanged on error
* @return the parsed SRV record, NULL on error
*/
struct GNUNET_DNSPARSER_SrvRecord *
GNUNET_DNSPARSER_parse_srv (const char *r_name,
const char *udp_payload,
size_t udp_payload_length,
size_t *off);
/* ***************** low-level deallocation API ******************** */
/**
* Free the given DNS record.
*
* @param r record to free
*/
void
GNUNET_DNSPARSER_free_record (struct GNUNET_DNSPARSER_Record *r);
/**
* Free MX information record.
*
* @param mx record to free
*/
void
GNUNET_DNSPARSER_free_mx (struct GNUNET_DNSPARSER_MxRecord *mx);
/**
* Free SRV information record.
*
* @param srv record to free
*/
void
GNUNET_DNSPARSER_free_srv (struct GNUNET_DNSPARSER_SrvRecord *srv);
/**
* Free SOA information record.
*
* @param soa record to free
*/
void
GNUNET_DNSPARSER_free_soa (struct GNUNET_DNSPARSER_SoaRecord *soa);
/**
* Free CERT information record.
*
* @param cert record to free
*/
void
GNUNET_DNSPARSER_free_cert (struct GNUNET_DNSPARSER_CertRecord *cert);
#endif
|