This is a clone/fork of https://github.com/miekg/dns
Go to file
Tom Thorogood 068c7e7c81 Rework and optimise ServeMux (#754)
* Avoid using pointer to sync.RWMutex in ServeMux

* Initialize ServeMux.z only when needed.

This means the zero ServeMux is now valid and empty.

* Add benchmark for ServeMux.match

* Use strings.ToLower once in ServeMux.match

strings.ToLower has a special path for ASCII-only (which q always should
be), and avoids all allocations if the string is already lowercase
(which most DNS labels should be).

* Move NextLabel into for clause in ServeMux.match

* Make ServeMux.ServeDNS easier to read

* Fix the documentation of ServeMux.ServeDNS

* Invoke HandleFailed directly in ServeMux.ServeDNS

* Bail early in ServeMux.match if Handle never called

* Fix typo in ServeMux.match

* Improve documentation of ServeMux

This just splits the massive wall of text up so it's easier to follow.

* Fix typo in ServeMux.HandleRemove documentation

* Replace strings.ToLower with once-allocating version

strings.ToLower allocates twice for uppercase ASCII which causes an
overall regression for this changeset. By writing our own custom version
here we can avoid that allocation.

When https://go-review.googlesource.com/c/go/+/137575 lands in a go
release this can be removed.
2018-09-27 07:48:02 +01:00
dnsutil util.TrimDomainName() fails when origin doesn't end in dot (#559) 2017-11-08 18:19:10 +00:00
vendor/golang.org/x dep ensure -update (#697) 2018-06-07 19:14:42 +01: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
.travis.yml Bump travis to 1.10/1.11 (#731) 2018-08-30 07:41:33 +01:00
AUTHORS add AUTHOR file 2014-02-10 17:15:49 +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
Gopkg.lock dep ensure -update (#697) 2018-06-07 19:14:42 +01:00
Gopkg.toml 458+dep (#591) 2017-11-27 10:49:53 +00:00
LICENSE Update the copy right for the original GO files 2013-05-12 16:07:06 +02: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 dnss to the users list (#723) 2018-08-16 17:06:07 +01:00
client.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
client_test.go Remove redundant parenthesis (#727) 2018-08-16 17:05:27 +01:00
clientconfig.go fix: panicing on options parsing. (#642) 2018-03-01 06:22:09 -08:00
clientconfig_test.go fix: panicing on options parsing. (#642) 2018-03-01 06:22:09 -08:00
compress_generate.go Fixed len computation when size just goes beyond 14 bits (#668) 2018-05-16 07:20:13 +01:00
dane.go Improve performance by addressing some low hanging fruit. (#444) 2017-02-02 07:33:49 +00:00
defaults.go ClassANY: don't convert CLASS255 to ANY (#618) 2018-01-07 17:57:04 +00:00
dns.go copyHeader is redundant (#672) 2018-05-10 14:50:26 +01:00
dns_bench_test.go Tests updates (#556) 2017-11-08 10:01:19 +00:00
dns_test.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
dnssec.go Remove redundant parenthesis (#727) 2018-08-16 17:05:27 +01:00
dnssec_keygen.go 458+dep (#591) 2017-11-27 10:49:53 +00:00
dnssec_keyscan.go Use RFC 8032 functions added to x/crypto/ed25519 (#715) 2018-07-25 13:01:44 +01:00
dnssec_privkey.go Use RFC 8032 functions added to x/crypto/ed25519 (#715) 2018-07-25 13:01:44 +01:00
dnssec_test.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
doc.go ExchangeWithDialer does not exist anymore (#666) 2018-04-06 12:05:09 +01:00
duplicate.go Add IsDuplicate function (#699) 2018-06-23 09:12:31 +01:00
duplicate_generate.go Add IsDuplicate function (#699) 2018-06-23 09:12:31 +01:00
duplicate_test.go Add IsDuplicate function (#699) 2018-06-23 09:12:31 +01:00
dyn_test.go Remove all copyright notices 2014-09-11 20:57:37 +01:00
edns.go Remove redundant parenthesis (#727) 2018-08-16 17:05:27 +01:00
edns_test.go Fix EDNS Extended RCODE (#517) 2017-10-13 17:21:46 +02:00
example_test.go fix a stupid mistake "undefined: zone" 2015-09-30 09:42:47 -07:00
format.go Remove WKS support 2016-06-05 08:23:44 +01:00
fuzz.go Add fuzzing framework (#580) 2017-11-23 09:34:31 +00:00
generate.go Correctly handle $GENERATE modifiers (#703) 2018-06-23 09:12:44 +01:00
generate_test.go Correctly handle $GENERATE modifiers (#703) 2018-06-23 09:12:44 +01:00
issue_test.go Tests updates (#556) 2017-11-08 10:01:19 +00:00
labels.go Remove redundant parenthesis (#727) 2018-08-16 17:05:27 +01:00
labels_test.go Cleanup: gofmt -w -s *.go (#548) 2017-11-03 16:15:35 +00:00
leak_test.go WIP: DNS-over-HTTPS support for Client.Exchange API (#671) 2018-05-16 08:54:01 +01:00
length_test.go Fixed len computation when size just goes beyond 14 bits (#668) 2018-05-16 07:20:13 +01: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 Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
msg_generate.go Lint: use ignore-this on generated files (#596) 2017-12-06 10:02:47 +00:00
msg_helpers.go Fix unpackString bug: 127 DEL is unprintable (#755) 2018-09-27 07:47:48 +01:00
msg_helpers_test.go Fix unpackString bug: 127 DEL is unprintable (#755) 2018-09-27 07:47:48 +01:00
msg_test.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
nsecx.go NSEC/3 Cover+Match cleanup (#479) 2017-04-12 19:47:48 +01:00
nsecx_test.go Handle empty NSEC3 salt in scanner (#677) 2018-05-14 20:07:52 +01:00
parse_test.go Run go fmt on package (#759) 2018-09-27 03:06:02 +09:30
privaterr.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
privaterr_test.go Test: remove all Logf/Log (#547) 2017-11-03 15:50:01 +00:00
rawmsg.go Cleanup and removals (#377) 2016-06-13 19:44:38 +01:00
remote_test.go Add remote test 2015-08-22 10:50:07 +01:00
reverse.go Golint fixes (#456) 2017-02-15 20:40:16 +00:00
rr_test.go Tests updates (#556) 2017-11-08 10:01:19 +00:00
sanitize.go Add IsDuplicate function (#699) 2018-06-23 09:12:31 +01:00
sanitize_test.go Tests updates (#556) 2017-11-08 10:01:19 +00:00
scan.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
scan_rr.go Fix issue #742 (#745) 2018-09-22 18:36:01 +01:00
scan_test.go Fix issue #742 (#745) 2018-09-22 18:36:01 +01:00
scanner.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
serve_mux.go Rework and optimise ServeMux (#754) 2018-09-27 07:48:02 +01:00
serve_mux_test.go Rework and optimise ServeMux (#754) 2018-09-27 07:48:02 +01:00
server.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
server_test.go Replace the trigger type with chan in server_test.go (#760) 2018-09-26 21:04:11 +01:00
sig0.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
sig0_test.go Lowercase all error msg from the tests 2015-11-26 14:12:38 +00:00
singleinflight.go Implement outstanding query detection. 2013-08-24 02:28:58 +00:00
smimea.go Golint fixes (#456) 2017-02-15 20:40:16 +00:00
tlsa.go Fix for miekg/dns issue #289: support the SMIMEA record (#410) 2016-10-17 18:09:52 +01:00
tsig.go Fix TSIG bug releated to ID substitution (#504) 2017-08-12 20:21:44 +01:00
tsig_test.go Fix TSIG bug releated to ID substitution (#504) 2017-08-12 20:21:44 +01:00
types.go Remove redundant parenthesis (#727) 2018-08-16 17:05:27 +01:00
types_generate.go copyHeader is redundant (#672) 2018-05-10 14:50:26 +01:00
types_test.go Tests: add ListenAndServe tests (#562) 2017-11-10 10:11:23 +00:00
udp.go Use ReadMsgUDP and WriteMsgUDP on windows (#738) 2018-09-08 17:33:21 +01:00
udp_test.go Fix dominikh/go-tools nits (#758) 2018-09-27 04:02:05 +09:30
update.go An update msg can have multiple, different prerequests and also multiple, 2016-02-27 12:58:10 +01:00
update_test.go ClassANY: don't convert CLASS255 to ANY (#618) 2018-01-07 17:57:04 +00:00
version.go Release 1.0.10 2018-09-22 18:51:30 +01:00
version_test.go Add semver (#595) 2017-12-06 09:46:54 +00:00
xfr.go TSIG name must be presented in canonical form (#574) 2017-11-17 13:17:47 +00:00
zcompress.go Remove compression from AFSDB (#704) 2018-06-23 09:43:19 +01:00
zduplicate.go Add IsDuplicate function (#699) 2018-06-23 09:12:31 +01:00
zmsg.go Remove compression from AFSDB (#704) 2018-06-23 09:43:19 +01:00
ztypes.go copyHeader is redundant (#672) 2018-05-10 14:50:26 +01: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 widely used 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:
    • Reply speed around ~ 80K qps (faster hardware results in more qps);
    • Parsing RRs ~ 100K RR/s, that's 5M records in about 50 seconds;
  • 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: optional encrypted connection between client and server;
  • DNS name compression;
  • Depends only on the standard library.

Have fun!

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

Building

Building is done with the go tool. If you have setup your GOPATH correctly, 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
  • 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
  • 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 (draft-ietf-dnsop-cookies)
  • 8080 - EdDSA for DNSSEC

Loosely based upon

  • ldns
  • NSD
  • Net::DNS
  • GRONG