X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_dnsparser_lib.h;h=9fe3491d672a734611d6dbad6e0f7194b44eacf9;hb=17047b7bcbe3f1756028058a9887416c6afab5d8;hp=68d0a5ebdac52c5485d298590f3d5b00aaa1d812;hpb=7918527acf021ad8753ead08334d6a6ac71084c4;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_dnsparser_lib.h b/src/include/gnunet_dnsparser_lib.h index 68d0a5ebd..9fe3491d6 100644 --- a/src/include/gnunet_dnsparser_lib.h +++ b/src/include/gnunet_dnsparser_lib.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - (C) 2010-2013 Christian Grothoff (and other contributing authors) + 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 General Public License as published @@ -14,15 +14,20 @@ 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. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_dnsparser_lib.h - * @brief API for helper library to parse DNS packets. * @author Philipp Toelke * @author Christian Grothoff + * + * @file + * API for helper library to parse DNS packets. + * + * @defgroup dns-parser DNS parser library + * Helper library to parse DNS packets. + * @{ */ #ifndef GNUNET_DNSPARSER_LIB_H #define GNUNET_DNSPARSER_LIB_H @@ -66,7 +71,7 @@ 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 + * 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. */ @@ -99,7 +104,7 @@ struct GNUNET_DNSPARSER_MxRecord /** * 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 + * 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. */ @@ -109,48 +114,15 @@ struct GNUNET_DNSPARSER_MxRecord /** - * 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. + * Information from SRV records (RFC 2782). */ 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 + * 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. */ @@ -232,7 +204,7 @@ enum GNUNET_DNSPARSER_CertType /** * DNSCERT algorithms as defined in http://www.iana.org/assignments/ - * dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml#dns-sec-alg-numbers-1 + * dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml, under dns-sec-alg-numbers-1 */ enum GNUNET_DNSPARSER_CertAlgorithm { @@ -353,7 +325,7 @@ 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 + * 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. */ @@ -363,7 +335,7 @@ struct GNUNET_DNSPARSER_SoaRecord * 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 + * 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. */ @@ -427,7 +399,7 @@ 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 + * 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. */ @@ -442,7 +414,7 @@ struct GNUNET_DNSPARSER_Record /** * 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 + * 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. */ @@ -834,7 +806,6 @@ GNUNET_DNSPARSER_parse_mx (const char *udp_payload, /** * 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 @@ -842,8 +813,7 @@ GNUNET_DNSPARSER_parse_mx (const char *udp_payload, * @return the parsed SRV record, NULL on error */ struct GNUNET_DNSPARSER_SrvRecord * -GNUNET_DNSPARSER_parse_srv (const char *r_name, - const char *udp_payload, +GNUNET_DNSPARSER_parse_srv (const char *udp_payload, size_t udp_payload_length, size_t *off); @@ -894,4 +864,31 @@ void GNUNET_DNSPARSER_free_cert (struct GNUNET_DNSPARSER_CertRecord *cert); +/** + * Convert a block of binary data to HEX. + * + * @param data binary data to convert + * @param data_size number of bytes in @a data + * @return HEX string (lower case) + */ +char * +GNUNET_DNSPARSER_bin_to_hex (const void *data, + size_t data_size); + + +/** + * Convert a HEX string to block of binary data. + * + * @param hex HEX string to convert (may contain mixed case) + * @param data where to write result, must be + * at least `strlen(hex)/2` bytes long + * @return number of bytes written to data + */ +size_t +GNUNET_DNSPARSER_hex_to_bin (const char *hex, + void *data); + + #endif + +/** @} */ /* end of group */