This is a clone/fork of https://github.com/miekg/dns
Go to file
Tom Thorogood 778aa4f83d
Properly calculate compressed message lengths (#833)
* Remove fullSize return from compressionLenSearch

This wasn't used anywhere but TestCompressionLenSearch, and was very
wrong.

* Add generated compressedLen functions and use them

This replaces the confusing and complicated compressionLenSlice
function.

* Use compressedLenWithCompressionMap even for uncompressed

This leaves the len() functions unused and they'll soon be removed.

This also fixes the off-by-one error of compressedLen when a (Q)NAME
is ".".

* Use Len helper instead of RR.len private method

* Merge len and compressedLen functions

* Merge compressedLen helper into Msg.Len

* Remove compress bool from compressedLenWithCompressionMap

* Merge map insertion into compressionLenSearch

This eliminates the need to loop over the domain name twice when we're
compressing the name.

* Use compressedNameLen for NSEC.NextDomain

This was a mistake.

* Remove compress from RR.len

* Add test case for multiple questions length

* Add test case for MINFO and SOA compression

These are the only RRs with multiple compressible names within the same
RR, and they were previously broken.

* Rename compressedNameLen to domainNameLen

It also handles the length of uncompressed domain names.

* Use off directly instead of len(s[:off])

* Move initial maxCompressionOffset check out of compressionLenMapInsert

This should allow us to avoid the call overhead of
compressionLenMapInsert in certain limited cases and may result in a
slight performance increase.

compressionLenMapInsert still has a maxCompressionOffset check inside
the for loop.

* Rename compressedLenWithCompressionMap to msgLenWithCompressionMap

This better reflects that it also calculates the uncompressed length.

* Merge TestMsgCompressMINFO with TestMsgCompressSOA

They're both testing the same thing.

* Remove compressionLenMapInsert

compressionLenSearch does everything compressionLenMapInsert did anyway.

* Only call compressionLenSearch in one place in domainNameLen

* Split if statement in domainNameLen

The last two commits worsened the performance of domainNameLen
noticably, this change restores it's original performance.

name                            old time/op    new time/op    delta
MsgLength-12                       550ns ±13%     510ns ±21%    ~     (p=0.050 n=10+10)
MsgLengthNoCompression-12         26.9ns ± 2%    27.0ns ± 1%    ~     (p=0.198 n=9+10)
MsgLengthPack-12                  2.30µs ±12%    2.26µs ±16%    ~     (p=0.739 n=10+10)
MsgLengthMassive-12               32.9µs ± 7%    32.0µs ±10%    ~     (p=0.243 n=9+10)
MsgLengthOnlyQuestion-12          9.60ns ± 1%    9.20ns ± 1%  -4.16%  (p=0.000 n=9+9)

* Remove stray newline from TestMsgCompressionMultipleQuestions

* Remove stray newline in length_test.go

This was introduced when resolving merge conflicts.
2018-11-30 10:03:41 +10:30
dnsutil util.TrimDomainName() fails when origin doesn't end in dot (#559) 2017-11-08 18:19:10 +00:00
vendor/golang.org/x Run dep ensure -update (#770) 2018-10-05 18:29:45 +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 Test coverage for all packages and merge Travis builds (#781) 2018-10-09 18:46:58 +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 Run dep ensure -update (#770) 2018-10-05 18:29:45 +01:00
Gopkg.toml Run dep ensure -update (#770) 2018-10-05 18:29:45 +01: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 doc: Clean up README and doc.go (#817) 2018-11-27 14:39:19 +00:00
acceptfunc.go fix docs 2018-11-28 18:45:19 +00:00
client.go Revert doh (#800) 2018-11-01 20:16:39 +00:00
client_test.go Remove ErrTruncated from the library (#815) 2018-11-27 14:26:11 +00: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
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 Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
dns_bench_test.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
dns_test.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
dnssec.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
dnssec_keygen.go 458+dep (#591) 2017-11-27 10:49:53 +00:00
dnssec_keyscan.go Add new ZoneParser API (#794) 2018-10-20 11:47:56 +10:30
dnssec_privkey.go Use RFC 8032 functions added to x/crypto/ed25519 (#715) 2018-07-25 13:01:44 +01:00
dnssec_test.go Eliminate lexer goroutines (#792) 2018-10-15 17:42:31 +10:30
doc.go doc: Clean up README and doc.go (#817) 2018-11-27 14:39:19 +00: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 Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
edns_test.go Use copy instead of loop in EDNS0_SUBNET.unpack (#825) 2018-11-27 14:32:41 +00: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 Add new ZoneParser API (#794) 2018-10-20 11:47:56 +10:30
generate_test.go Add new ZoneParser API (#794) 2018-10-20 11:47:56 +10:30
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 Revert doh (#800) 2018-11-01 20:16:39 +00:00
length_test.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
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 Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
msg_generate.go Lint: use ignore-this on generated files (#596) 2017-12-06 10:02:47 +00:00
msg_helpers.go Use a table lookup for escaping unprintable bytes (#846) 2018-11-29 19:57:48 +00:00
msg_helpers_test.go Fix unpackString bug: 127 DEL is unprintable (#755) 2018-09-27 07:47:48 +01:00
msg_test.go Reduce allocations in UnpackDomainName by better sizing slice (#844) 2018-11-29 19:55:51 +00:00
nsecx.go Hoist SHA1 check in HashName 2018-11-29 10:44:01 +10:30
nsecx_test.go Add a HashName benchmark 2018-11-29 10:28:29 +10:30
parse_test.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
privaterr.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10: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 Fix NotImp RCode string (#819) 2018-11-27 14:38:33 +00:00
rr_test.go Eliminate lexer goroutines (#792) 2018-10-15 17:42:31 +10:30
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 Add new ZoneParser API (#794) 2018-10-20 11:47:56 +10:30
scan_rr.go Eliminate lexer goroutines (#792) 2018-10-15 17:42:31 +10:30
scan_test.go Add new ZoneParser API (#794) 2018-10-20 11:47:56 +10: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 remove newlines 2018-11-28 22:32:50 +00:00
server_test.go review 2018-11-28 22:25:28 +00:00
sig0.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10: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 Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
tsig_test.go Fix TSIG bug releated to ID substitution (#504) 2017-08-12 20:21:44 +01:00
types.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
types_generate.go Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30
types_test.go Optimise sprintX functions in types.go (#757) 2018-10-06 02:06:59 +09:30
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 Rollback PR #738 because it breaks compatibility with Windows (#765) 2018-09-29 10:25:59 +01:00
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.1.0 2018-11-28 23:08:28 +00: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
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 Properly calculate compressed message lengths (#833) 2018-11-30 10:03:41 +10:30

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

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