This is a clone/fork of https://github.com/miekg/dns
Go to file
Tom Thorogood 13238cb6ad
Support parsing known RR types in RFC 3597 format (#1211)
* Support parsing known RR types in RFC 3597 format

This is the format used for "Unknown DNS Resource Records", but it's
also useful to support parsing known RR types in this way.

RFC 3597 says:

   An implementation MAY also choose to represent some RRs of known type
   using the above generic representations for the type, class and/or
   RDATA, which carries the benefit of making the resulting master file
   portable to servers where these types are unknown.  Using the generic
   representation for the RDATA of an RR of known type can also be
   useful in the case of an RR type where the text format varies
   depending on a version, protocol, or similar field (or several)
   embedded in the RDATA when such a field has a value for which no text
   format is known, e.g., a LOC RR [RFC1876] with a VERSION other than
   0.

   Even though an RR of known type represented in the \# format is
   effectively treated as an unknown type for the purpose of parsing the
   RDATA text representation, all further processing by the server MUST
   treat it as a known type and take into account any applicable type-
   specific rules regarding compression, canonicalization, etc.

* Correct mistakes in TestZoneParserAddressAAAA

This was spotted when writing TestParseKnownRRAsRFC3597.

* Eliminate canParseAsRR

This has the advantage that concrete types will now be returned for
parsed ANY, NULL, OPT and TSIG records.

* Expand TestDynamicUpdateParsing for RFC 3597

This ensures we're properly handling empty RDATA for RFC 3597 parsed
records.
2021-01-30 14:05:25 +01:00
.github/workflows Remove travis (#1193) 2020-11-06 18:30:22 +01:00
dnsutil util.TrimDomainName() fails when origin doesn't end in dot (#559) 2017-11-08 18:19:10 +00:00
.codecov.yml Add codecov yaml to not fail the build (#600) 2017-12-06 10:36:23 +00:00
.gitignore gitignore update 2013-10-15 13:22:35 +00:00
AUTHORS add AUTHOR file 2014-02-10 17:15:49 +00:00
CODEOWNERS Add CODEOWNERS (#1042) 2019-12-09 11:50:19 +00:00
CONTRIBUTORS Correctly set the Source IP to the received Destination IP (#524) 2017-09-29 10:38:26 +01:00
COPYRIGHT Remove all copyright notices 2014-09-11 20:57:37 +01:00
LICENSE Put added license bit at the bottom (#1056) 2019-12-18 06:58:51 +00:00
Makefile.fuzz Add fuzzing framework (#580) 2017-11-23 09:34:31 +00:00
Makefile.release Release: plain push is also needed 2018-01-10 08:17:22 +00:00
README.md Add a link to https://github.com/bodgit/tsig (#1206) 2021-01-09 09:37:20 +01:00
acceptfunc.go Doc fixes (#1060) 2019-12-19 09:28:37 +00:00
acceptfunc_test.go Support generic net.PacketConn's for the Server (#1174) 2020-10-25 02:23:01 +10:30
client.go Add GSS-TSIG support (#1201) 2021-01-07 14:28:20 +00:00
client_test.go Support generic net.PacketConn's for the Server (#1174) 2020-10-25 02:23:01 +10:30
clientconfig.go Use for range loops instead of manual for loops (#937) 2019-03-18 07:06:44 +00:00
clientconfig_test.go fix: panicing on options parsing. (#642) 2018-03-01 06:22:09 -08:00
dane.go Improve performance by addressing some low hanging fruit. (#444) 2017-02-02 07:33:49 +00:00
defaults.go CanonicalName function to return domain name in canonical form (#1073) 2020-03-18 11:21:59 +01:00
dns.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
dns_bench_test.go ZoneParser: error on parsing an IPv6 address in an A record (#923) 2019-03-09 09:02:18 +00:00
dns_test.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
dnssec.go Remove RSAMD5 support from (*RRSIG).Verify (#1185) 2020-10-24 13:55:55 +02:00
dnssec_keygen.go Remove the remnants of DSA support (#1184) 2020-10-24 13:55:21 +02:00
dnssec_keyscan.go Remove the remnants of DSA support (#1184) 2020-10-24 13:55:21 +02:00
dnssec_privkey.go Remove the remnants of DSA support (#1184) 2020-10-24 13:55:21 +02:00
dnssec_test.go tests: reduce timeouts and iterations (#1175) 2020-10-16 09:10:36 +02:00
doc.go Add GSS-TSIG support (#1201) 2021-01-07 14:28:20 +00:00
duplicate.go Doc updates (#1075) 2020-02-14 22:47:21 +01:00
duplicate_generate.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
duplicate_test.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
dyn_test.go Remove all copyright notices 2014-09-11 20:57:37 +01:00
edns.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
edns_test.go Revert "Export EDNS0 interface (#1041)" (#1046) 2019-12-06 21:23:18 +00:00
example_test.go fix a stupid mistake "undefined: zone" 2015-09-30 09:42:47 -07:00
format.go Add checks on data length for A and AAAA records (#919) 2019-03-12 16:31:33 +00:00
format_test.go Add checks on data length for A and AAAA records (#919) 2019-03-12 16:31:33 +00:00
fuzz.go [fuzzer] Avoid fuzzing parser with line that contains "$INCLUDE" (#1026) 2019-10-10 07:12:53 +01:00
fuzz_test.go build: reduce testing output (#1031) 2019-10-20 07:12:43 +01:00
generate.go Fix potentially truncated int casts in $GENERATE code (#1212) 2021-01-30 10:07:06 +01:00
generate_test.go Fix potentially truncated int casts in $GENERATE code (#1212) 2021-01-30 10:07:06 +01:00
go.mod code generation compatible with go modules (#1050) 2019-12-30 12:25:57 +01:00
go.sum code generation compatible with go modules (#1050) 2019-12-30 12:25:57 +01:00
issue_test.go tests: reduce timeouts and iterations (#1175) 2020-10-16 09:10:36 +02:00
labels.go Doc updates (#1075) 2020-02-14 22:47:21 +01:00
labels_test.go CanonicalName function to return domain name in canonical form (#1073) 2020-03-18 11:21:59 +01:00
leak_test.go Revert doh (#800) 2018-11-01 20:16:39 +00:00
length_test.go Make the 900 number lower in this test (#1176) 2020-10-16 11:55:29 +02:00
listen_go111.go Use correct build constraints for listen_*.go files (#750) 2018-09-26 09:12:54 +01:00
listen_go_not111.go Use correct build constraints for listen_*.go files (#750) 2018-09-26 09:12:54 +01:00
msg.go Be consistent about domain name label character escaping (#1122) 2020-07-06 10:07:56 +02:00
msg_generate.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
msg_helpers.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
msg_helpers_test.go make sure removing trailing zero octets in APL AFDPART (#1150) 2020-08-17 19:51:22 +01:00
msg_test.go Add test for forward compression pointer (#1123) 2020-05-27 08:05:25 +00:00
msg_truncate.go Update doc for Truncate (#1173) 2020-10-14 08:42:57 +02:00
msg_truncate_test.go Set the TC bit more aggressively in Truncate (#989) 2019-06-24 16:59:43 +01:00
nsecx.go Doc updates (#1075) 2020-02-14 22:47:21 +01:00
nsecx_test.go Add a HashName benchmark 2018-11-29 10:28:29 +10:30
parse_test.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
privaterr.go Doc updates (#1075) 2020-02-14 22:47:21 +01:00
privaterr_test.go refactor: remove ParseZone and parseZone (#1099) 2020-04-28 09:24:18 +02:00
reverse.go Move all reversed map creation into reverse.go (#889) 2019-01-04 08:10:15 +00:00
rr_test.go Eliminate lexer goroutines (#792) 2018-10-15 17:42:31 +10:30
sanitize.go Avoid calling RR.Header more than once per RR (#891) 2019-01-04 08:12:32 +00:00
sanitize_test.go Tests updates (#556) 2017-11-08 10:01:19 +00:00
scan.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
scan_rr.go validate LOC's lat/long field values not to be out of range (#1149) 2020-08-17 07:07:46 +00:00
scan_test.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
serve_mux.go answer queries with no matching handler with RcodeRefused (#1151) 2020-08-20 08:41:45 +02:00
serve_mux_test.go Rework and optimise ServeMux (#754) 2018-09-27 07:48:02 +01:00
server.go Fix PacketConnReader typo in DecorateReader docs (#1189) 2020-10-25 02:26:19 +10:30
server_test.go Support generic net.PacketConn's for the Server (#1174) 2020-10-25 02:23:01 +10:30
sig0.go Remove the remnants of DSA support (#1184) 2020-10-24 13:55:21 +02:00
sig0_test.go tests: reduce timeouts and iterations (#1175) 2020-10-16 09:10:36 +02:00
singleinflight.go Prevent timeout in TestConcurrentExchanges (#862) 2018-12-04 07:29:08 +00:00
smimea.go Simplify and unify various returns (#893) 2019-01-04 10:19:42 +00:00
svcb.go Fix comment about SVCB values in AliasMode (#1202) 2020-12-18 19:16:09 +00:00
svcb_test.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
tlsa.go Simplify and unify various returns (#893) 2019-01-04 10:19:42 +00:00
tsig.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
tsig_test.go Add GSS-TSIG support (#1201) 2021-01-07 14:28:20 +00:00
types.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
types_generate.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
types_test.go Be consistent about domain name label character escaping (#1122) 2020-07-06 10:07:56 +02:00
udp.go Rollback PR #738 because it breaks compatibility with Windows (#765) 2018-09-29 10:25:59 +01:00
udp_test.go Rollback PR #738 because it breaks compatibility with Windows (#765) 2018-09-29 10:25:59 +01:00
udp_windows.go Simplify and unify various returns (#893) 2019-01-04 10:19:42 +00:00
update.go Avoid calling RR.Header more than once per RR (#891) 2019-01-04 08:12:32 +00:00
update_test.go Support parsing known RR types in RFC 3597 format (#1211) 2021-01-30 14:05:25 +01:00
version.go Release 1.1.35 2020-10-25 09:22:05 +01:00
version_test.go Doc updates (#1075) 2020-02-14 22:47:21 +01:00
xfr.go doc: fix xfr example. (#1062) 2019-12-19 13:11:22 +00:00
xfr_test.go Support generic net.PacketConn's for the Server (#1174) 2020-10-25 02:23:01 +10:30
zduplicate.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
zmsg.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00
ztypes.go Implement SVCB (#1067) 2020-10-11 09:09:36 +02:00

README.md

Build Status Code Coverage Go Report Card

Alternative (more granular) approach to a DNS library

Less is more.

Complete and usable DNS library. All Resource Records are supported, including the DNSSEC types. It follows a lean and mean philosophy. If there is stuff you should know as a DNS programmer there isn't a convenience function for it. Server side and client side programming is supported, i.e. you can build servers and resolvers with it.

We try to keep the "master" branch as sane as possible and at the bleeding edge of standards, avoiding breaking changes wherever reasonable. We support the last two versions of Go.

Goals

  • KISS;
  • Fast;
  • Small API. If it's easy to code in Go, don't make a function for it.

Users

A not-so-up-to-date-list-that-may-be-actually-current:

Send pull request if you want to be listed here.

Features

  • UDP/TCP queries, IPv4 and IPv6
  • RFC 1035 zone file parsing ($INCLUDE, $ORIGIN, $TTL and $GENERATE (for all record types) are supported
  • Fast
  • Server side programming (mimicking the net/http package)
  • Client side programming
  • DNSSEC: signing, validating and key generation for DSA, RSA, ECDSA and Ed25519
  • EDNS0, NSID, Cookies
  • AXFR/IXFR
  • TSIG, SIG(0)
  • DNS over TLS (DoT): encrypted connection between client and server over TCP
  • DNS name compression

Have fun!

Miek Gieben - 2010-2012 - miek@miek.nl DNS Authors 2012-

Building

This library uses Go modules and uses semantic versioning. Building is done with the go tool, so the following should work:

go get github.com/miekg/dns
go build github.com/miekg/dns

Examples

A short "how to use the API" is at the beginning of doc.go (this also will show when you call godoc github.com/miekg/dns).

Example programs can be found in the github.com/miekg/exdns repository.

Supported RFCs

all of them

  • 103{4,5} - DNS standard
  • 1348 - NSAP record (removed the record)
  • 1982 - Serial Arithmetic
  • 1876 - LOC record
  • 1995 - IXFR
  • 1996 - DNS notify
  • 2136 - DNS Update (dynamic updates)
  • 2181 - RRset definition - there is no RRset type though, just []RR
  • 2537 - RSAMD5 DNS keys
  • 2065 - DNSSEC (updated in later RFCs)
  • 2671 - EDNS record
  • 2782 - SRV record
  • 2845 - TSIG record
  • 2915 - NAPTR record
  • 2929 - DNS IANA Considerations
  • 3110 - RSASHA1 DNS keys
  • 3123 - APL record
  • 3225 - DO bit (DNSSEC OK)
  • 340{1,2,3} - NAPTR record
  • 3445 - Limiting the scope of (DNS)KEY
  • 3597 - Unknown RRs
  • 403{3,4,5} - DNSSEC + validation functions
  • 4255 - SSHFP record
  • 4343 - Case insensitivity
  • 4408 - SPF record
  • 4509 - SHA256 Hash in DS
  • 4592 - Wildcards in the DNS
  • 4635 - HMAC SHA TSIG
  • 4701 - DHCID
  • 4892 - id.server
  • 5001 - NSID
  • 5155 - NSEC3 record
  • 5205 - HIP record
  • 5702 - SHA2 in the DNS
  • 5936 - AXFR
  • 5966 - TCP implementation recommendations
  • 6605 - ECDSA
  • 6725 - IANA Registry Update
  • 6742 - ILNP DNS
  • 6840 - Clarifications and Implementation Notes for DNS Security
  • 6844 - CAA record
  • 6891 - EDNS0 update
  • 6895 - DNS IANA considerations
  • 6944 - DNSSEC DNSKEY Algorithm Status
  • 6975 - Algorithm Understanding in DNSSEC
  • 7043 - EUI48/EUI64 records
  • 7314 - DNS (EDNS) EXPIRE Option
  • 7477 - CSYNC RR
  • 7828 - edns-tcp-keepalive EDNS0 Option
  • 7553 - URI record
  • 7858 - DNS over TLS: Initiation and Performance Considerations
  • 7871 - EDNS0 Client Subnet
  • 7873 - Domain Name System (DNS) Cookies
  • 8080 - EdDSA for DNSSEC
  • 8499 - DNS Terminology

Loosely Based Upon