2014-07-09 00:35:41 +10:00
|
|
|
[![Build Status](https://travis-ci.org/miekg/dns.svg?branch=master)](https://travis-ci.org/miekg/dns)
|
|
|
|
|
2014-01-13 00:47:03 +11:00
|
|
|
# Alternative (more granular) approach to a DNS library
|
2010-12-29 01:44:19 +11:00
|
|
|
|
2012-01-28 11:14:55 +11:00
|
|
|
> Less is more.
|
|
|
|
|
2012-05-03 16:59:02 +10:00
|
|
|
Complete and usable DNS library. All widely used Resource Records are
|
2012-01-27 18:51:24 +11:00
|
|
|
supported, including the DNSSEC types. It follows a lean and mean philosophy.
|
2012-01-12 08:01:40 +11:00
|
|
|
If there is stuff you should know as a DNS programmer there isn't a convenience
|
2012-05-03 16:59:02 +10:00
|
|
|
function for it. Server side and client side programming is supported, i.e. you
|
|
|
|
can build servers and resolvers with it.
|
2011-07-06 03:54:20 +10:00
|
|
|
|
2012-08-10 07:38:47 +10:00
|
|
|
If you like this, you may also be interested in:
|
|
|
|
|
|
|
|
* https://github.com/miekg/unbound -- Go wrapper for the Unbound resolver.
|
|
|
|
|
2012-05-12 07:48:43 +10:00
|
|
|
# Goals
|
2012-02-15 20:34:35 +11:00
|
|
|
|
2012-01-27 09:00:37 +11:00
|
|
|
* KISS;
|
2014-04-11 23:53:48 +10:00
|
|
|
* Fast;
|
2012-02-19 23:38:31 +11:00
|
|
|
* Small API, if its easy to code in Go, don't make a function for it.
|
2012-01-27 09:00:37 +11:00
|
|
|
|
2013-03-15 02:42:35 +11:00
|
|
|
# Users
|
|
|
|
|
|
|
|
A not-so-up-to-date-list-that-may-be-actually-current:
|
|
|
|
|
2015-08-07 03:58:55 +10:00
|
|
|
* https://cloudflare.com
|
2013-03-15 02:42:35 +11:00
|
|
|
* https://github.com/abh/geodns
|
|
|
|
* http://www.statdns.com/
|
|
|
|
* http://www.dnsinspect.com/
|
2013-08-26 14:22:11 +10:00
|
|
|
* https://github.com/chuangbo/jianbing-dictionary-dns
|
2013-07-05 03:09:37 +10:00
|
|
|
* http://www.dns-lg.com/
|
|
|
|
* https://github.com/fcambus/rrda
|
2013-07-27 02:50:20 +10:00
|
|
|
* https://github.com/kenshinx/godns
|
2013-10-16 06:35:24 +11:00
|
|
|
* https://github.com/skynetservices/skydns
|
2014-07-03 09:21:29 +10:00
|
|
|
* https://github.com/DevelopersPL/godnsagent
|
2014-07-04 16:29:35 +10:00
|
|
|
* https://github.com/duedil-ltd/discodns
|
2015-01-26 04:39:30 +11:00
|
|
|
* https://github.com/StalkR/dns-reverse-proxy
|
2015-04-04 11:53:54 +11:00
|
|
|
* https://github.com/tianon/rawdns
|
2015-04-28 16:00:45 +10:00
|
|
|
* https://mesosphere.github.io/mesos-dns/
|
2015-07-18 00:58:41 +10:00
|
|
|
* https://pulse.turbobytes.com/
|
2014-09-21 18:13:29 +10:00
|
|
|
|
|
|
|
Send pull request if you want to be listed here.
|
2013-03-15 02:42:35 +11:00
|
|
|
|
2012-05-12 07:48:43 +10:00
|
|
|
# Features
|
2011-07-06 03:54:20 +10:00
|
|
|
|
2011-09-12 18:13:50 +10:00
|
|
|
* UDP/TCP queries, IPv4 and IPv6;
|
2013-05-16 09:15:36 +10:00
|
|
|
* RFC 1035 zone file parsing ($INCLUDE, $ORIGIN, $TTL and $GENERATE (for all record types) are supported;
|
2013-05-06 05:59:43 +10:00
|
|
|
* Fast:
|
|
|
|
* Reply speed around ~ 80K qps (faster hardware results in more qps);
|
2014-04-11 23:53:48 +10:00
|
|
|
* Parsing RRs ~ 100K RR/s, that's 5M records in about 50 seconds;
|
2012-08-10 07:38:47 +10:00
|
|
|
* Server side programming (mimicking the net/http package);
|
2012-11-20 05:28:49 +11:00
|
|
|
* Client side programming;
|
2012-05-03 16:59:02 +10:00
|
|
|
* DNSSEC: signing, validating and key generation for DSA, RSA and ECDSA;
|
2012-02-14 08:02:36 +11:00
|
|
|
* EDNS0, NSID;
|
2011-09-12 18:13:50 +10:00
|
|
|
* AXFR/IXFR;
|
2014-11-02 22:29:55 +11:00
|
|
|
* TSIG, SIG(0);
|
2014-08-31 01:42:51 +10:00
|
|
|
* DNS name compression;
|
|
|
|
* Depends only on the standard library.
|
2010-12-29 01:44:19 +11:00
|
|
|
|
2012-03-05 02:35:21 +11:00
|
|
|
Have fun!
|
|
|
|
|
2014-08-05 16:43:12 +10:00
|
|
|
Miek Gieben - 2010-2012 - <miek@miek.nl>
|
2012-03-05 02:35:21 +11:00
|
|
|
|
2012-05-12 07:48:43 +10:00
|
|
|
# Building
|
2012-03-05 02:35:21 +11:00
|
|
|
|
2012-02-05 21:04:21 +11:00
|
|
|
Building is done with the `go` tool. If you have setup your GOPATH
|
2012-12-02 18:13:57 +11:00
|
|
|
correctly, the following should work:
|
2011-01-02 08:07:47 +11:00
|
|
|
|
2012-08-10 07:38:47 +10:00
|
|
|
go get github.com/miekg/dns
|
2013-10-08 07:02:55 +11:00
|
|
|
go build github.com/miekg/dns
|
2012-02-05 21:04:21 +11:00
|
|
|
|
2013-10-13 21:23:14 +11:00
|
|
|
## Examples
|
|
|
|
|
2015-03-24 17:56:56 +11:00
|
|
|
A short "how to use the API" is at the beginning of doc.go (this also will show
|
2014-01-28 21:55:31 +11:00
|
|
|
when you call `godoc github.com/miekg/dns`).
|
2013-10-13 21:23:14 +11:00
|
|
|
|
|
|
|
Example programs can be found in the `github.com/miekg/exdns` repository.
|
2013-09-21 01:15:27 +10:00
|
|
|
|
2012-01-16 02:29:01 +11:00
|
|
|
## Supported RFCs
|
2011-01-27 19:29:11 +11:00
|
|
|
|
2012-05-03 16:59:02 +10:00
|
|
|
*all of them*
|
2012-01-27 09:00:37 +11:00
|
|
|
|
2012-08-27 06:32:47 +10:00
|
|
|
* 103{4,5} - DNS standard
|
2013-10-13 22:25:08 +11:00
|
|
|
* 1348 - NSAP record
|
2011-01-27 19:29:11 +11:00
|
|
|
* 1982 - Serial Arithmetic
|
2012-04-30 23:47:37 +10:00
|
|
|
* 1876 - LOC record
|
2011-01-27 19:29:11 +11:00
|
|
|
* 1995 - IXFR
|
|
|
|
* 1996 - DNS notify
|
2011-08-24 23:39:26 +10:00
|
|
|
* 2136 - DNS Update (dynamic updates)
|
2014-01-28 21:56:29 +11:00
|
|
|
* 2181 - RRset definition - there is no RRset type though, just []RR
|
2011-01-27 19:29:11 +11:00
|
|
|
* 2537 - RSAMD5 DNS keys
|
|
|
|
* 2065 - DNSSEC (updated in later RFCs)
|
2012-02-19 07:49:02 +11:00
|
|
|
* 2671 - EDNS record
|
|
|
|
* 2782 - SRV record
|
|
|
|
* 2845 - TSIG record
|
|
|
|
* 2915 - NAPTR record
|
2013-04-18 19:23:53 +10:00
|
|
|
* 2929 - DNS IANA Considerations
|
2011-01-27 19:29:11 +11:00
|
|
|
* 3110 - RSASHA1 DNS keys
|
|
|
|
* 3225 - DO bit (DNSSEC OK)
|
2012-02-19 07:49:02 +11:00
|
|
|
* 340{1,2,3} - NAPTR record
|
2012-02-17 09:34:09 +11:00
|
|
|
* 3445 - Limiting the scope of (DNS)KEY
|
2015-01-25 21:58:30 +11:00
|
|
|
* 3597 - Unknown RRs
|
|
|
|
* 4025 - IPSECKEY
|
2011-03-10 05:41:52 +11:00
|
|
|
* 403{3,4,5} - DNSSEC + validation functions
|
2012-02-19 07:49:02 +11:00
|
|
|
* 4255 - SSHFP record
|
2013-09-21 01:15:27 +10:00
|
|
|
* 4343 - Case insensitivity
|
2012-02-19 07:49:02 +11:00
|
|
|
* 4408 - SPF record
|
2011-03-22 19:44:33 +11:00
|
|
|
* 4509 - SHA256 Hash in DS
|
2012-02-15 20:28:55 +11:00
|
|
|
* 4592 - Wildcards in the DNS
|
2011-03-14 22:28:04 +11:00
|
|
|
* 4635 - HMAC SHA TSIG
|
2012-02-19 07:25:37 +11:00
|
|
|
* 4701 - DHCID
|
2011-07-29 20:24:41 +10:00
|
|
|
* 4892 - id.server
|
2013-09-21 01:15:27 +10:00
|
|
|
* 5001 - NSID
|
2012-02-19 07:49:02 +11:00
|
|
|
* 5155 - NSEC3 record
|
|
|
|
* 5205 - HIP record
|
2012-04-18 22:52:49 +10:00
|
|
|
* 5702 - SHA2 in the DNS
|
2011-01-27 19:29:11 +11:00
|
|
|
* 5936 - AXFR
|
2013-10-19 09:07:48 +11:00
|
|
|
* 5966 - TCP implementation recommendations
|
2012-05-03 16:59:02 +10:00
|
|
|
* 6605 - ECDSA
|
2014-10-23 19:12:02 +11:00
|
|
|
* 6725 - IANA Registry Update
|
2012-11-18 07:26:48 +11:00
|
|
|
* 6742 - ILNP DNS
|
2015-06-16 19:01:28 +10:00
|
|
|
* 6844 - CAA record
|
2013-04-28 01:57:33 +10:00
|
|
|
* 6891 - EDNS0 update
|
2013-10-13 23:28:48 +11:00
|
|
|
* 6895 - DNS IANA considerations
|
2014-08-31 01:46:37 +10:00
|
|
|
* 6975 - Algorithm Understanding in DNSSEC
|
2014-01-28 21:59:12 +11:00
|
|
|
* 7043 - EUI48/EUI64 records
|
2014-07-22 04:31:28 +10:00
|
|
|
* 7314 - DNS (EDNS) EXPIRE Option
|
2015-07-21 16:47:38 +10:00
|
|
|
* 7553 - URI record
|
2012-10-17 18:06:49 +11:00
|
|
|
* xxxx - EDNS0 DNS Update Lease (draft)
|
2010-12-22 00:41:48 +11:00
|
|
|
|
2012-08-27 06:32:47 +10:00
|
|
|
## Loosely based upon
|
2011-02-10 22:26:26 +11:00
|
|
|
|
|
|
|
* `ldns`
|
|
|
|
* `NSD`
|
|
|
|
* `Net::DNS`
|
|
|
|
* `GRONG`
|
2014-02-11 07:42:52 +11:00
|
|
|
|
|
|
|
## TODO
|
|
|
|
|
|
|
|
* privatekey.Precompute() when signing?
|
2015-07-21 16:47:38 +10:00
|
|
|
* Last remaining RRs: APL, ATMA, A6 and NXT.
|
|
|
|
* Missing in parsing: ISDN, UNSPEC, ATMA.
|
|
|
|
* NSEC(3) cover/match/closest enclose.
|
|
|
|
* Replies with TC bit are not parsed to the end.
|