dns/README.md

161 lines
4.9 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/miekg/dns.svg?branch=master)](https://travis-ci.org/miekg/dns)
[![](https://godoc.org/github.com/miekg/dns?status.svg)](https://godoc.org/github.com/miekg/dns)
2014-07-08 14:35:41 +00:00
2014-01-12 13:47:03 +00:00
# Alternative (more granular) approach to a DNS library
2010-12-28 14:44:19 +00:00
2012-01-28 00:14:55 +00:00
> Less is more.
2012-05-03 06:59:02 +00:00
Complete and usable DNS library. All widely used Resource Records are
2012-01-27 07:51:24 +00:00
supported, including the DNSSEC types. It follows a lean and mean philosophy.
2012-01-11 21:01:40 +00:00
If there is stuff you should know as a DNS programmer there isn't a convenience
2012-05-03 06:59:02 +00:00
function for it. Server side and client side programming is supported, i.e. you
can build servers and resolvers with it.
2011-07-05 17:54:20 +00:00
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, currently: 1.7 and 1.8.
2012-08-09 21:38:47 +00:00
2012-05-11 21:48:43 +00:00
# Goals
2012-02-15 09:34:35 +00:00
2012-01-26 22:00:37 +00:00
* KISS;
2014-04-11 13:53:48 +00:00
* Fast;
2017-03-31 06:08:51 +00:00
* Small API. If it's easy to code in Go, don't make a function for it.
2012-01-26 22:00:37 +00:00
2013-03-14 15:42:35 +00:00
# Users
A not-so-up-to-date-list-that-may-be-actually-current:
2017-03-08 07:08:31 +00:00
* https://github.com/coredns/coredns
* https://cloudflare.com
2013-03-14 15:42:35 +00:00
* https://github.com/abh/geodns
* http://www.statdns.com/
* http://www.dnsinspect.com/
2013-08-26 04:22:11 +00:00
* https://github.com/chuangbo/jianbing-dictionary-dns
* http://www.dns-lg.com/
* https://github.com/fcambus/rrda
2013-07-26 16:50:20 +00:00
* https://github.com/kenshinx/godns
2013-10-15 19:35:24 +00:00
* https://github.com/skynetservices/skydns
* https://github.com/hashicorp/consul
2014-07-02 23:21:29 +00:00
* https://github.com/DevelopersPL/godnsagent
2014-07-04 06:29:35 +00:00
* https://github.com/duedil-ltd/discodns
* https://github.com/StalkR/dns-reverse-proxy
* https://github.com/tianon/rawdns
2015-04-28 06:00:45 +00:00
* https://mesosphere.github.io/mesos-dns/
2015-07-17 14:58:41 +00:00
* https://pulse.turbobytes.com/
2015-08-07 10:09:15 +00:00
* https://play.google.com/store/apps/details?id=com.turbobytes.dig
* https://github.com/fcambus/statzone
* https://github.com/benschw/dns-clb-go
2016-02-03 18:53:21 +00:00
* https://github.com/corny/dnscheck for http://public-dns.info/
* https://namesmith.io
* https://github.com/miekg/unbound
* https://github.com/miekg/exdns
2016-01-29 16:26:44 +00:00
* https://dnslookup.org
2016-05-03 08:16:38 +00:00
* https://github.com/looterz/grimd
2016-05-07 13:17:04 +00:00
* https://github.com/phamhongviet/serf-dns
2016-10-03 14:37:16 +00:00
* https://github.com/mehrdadrad/mylg
* https://github.com/bamarni/dockness
2016-10-04 17:15:48 +00:00
* https://github.com/fffaraz/microdns
* http://quilt.io
2017-02-27 10:24:07 +00:00
* https://github.com/ipdcode/hades (JD.COM)
* https://github.com/StackExchange/dnscontrol/
2014-09-21 08:13:29 +00:00
Send pull request if you want to be listed here.
2013-03-14 15:42:35 +00:00
2012-05-11 21:48:43 +00:00
# Features
2011-07-05 17:54:20 +00:00
* UDP/TCP queries, IPv4 and IPv6;
2013-05-15 23:15:36 +00:00
* RFC 1035 zone file parsing ($INCLUDE, $ORIGIN, $TTL and $GENERATE (for all record types) are supported;
2013-05-05 19:59:43 +00:00
* Fast:
* Reply speed around ~ 80K qps (faster hardware results in more qps);
2014-04-11 13:53:48 +00:00
* Parsing RRs ~ 100K RR/s, that's 5M records in about 50 seconds;
2012-08-09 21:38:47 +00:00
* Server side programming (mimicking the net/http package);
2012-11-19 18:28:49 +00:00
* Client side programming;
2012-05-03 06:59:02 +00:00
* DNSSEC: signing, validating and key generation for DSA, RSA and ECDSA;
* EDNS0, NSID, Cookies;
* AXFR/IXFR;
* TSIG, SIG(0);
* DNS over TLS: optional encrypted connection between client and server;
2014-08-30 15:42:51 +00:00
* DNS name compression;
* Depends only on the standard library.
2010-12-28 14:44:19 +00:00
2012-03-04 15:35:21 +00:00
Have fun!
2014-08-05 06:43:12 +00:00
Miek Gieben - 2010-2012 - <miek@miek.nl>
2012-03-04 15:35:21 +00:00
2012-05-11 21:48:43 +00:00
# Building
2012-03-04 15:35:21 +00:00
Building is done with the `go` tool. If you have setup your GOPATH
2012-12-02 07:13:57 +00:00
correctly, the following should work:
2011-01-01 21:07:47 +00:00
2012-08-09 21:38:47 +00:00
go get github.com/miekg/dns
2013-10-07 20:02:55 +00:00
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
2014-01-28 10:55:31 +00:00
when you call `godoc github.com/miekg/dns`).
Example programs can be found in the `github.com/miekg/exdns` repository.
2013-09-20 15:15:27 +00:00
2012-01-15 15:29:01 +00:00
## Supported RFCs
2011-01-27 08:29:11 +00:00
2012-05-03 06:59:02 +00:00
*all of them*
2012-01-26 22:00:37 +00:00
2012-08-26 20:32:47 +00:00
* 103{4,5} - DNS standard
2015-08-10 06:30:50 +00:00
* 1348 - NSAP record (removed the record)
2011-01-27 08:29:11 +00:00
* 1982 - Serial Arithmetic
2012-04-30 13:47:37 +00:00
* 1876 - LOC record
2011-01-27 08:29:11 +00:00
* 1995 - IXFR
* 1996 - DNS notify
* 2136 - DNS Update (dynamic updates)
2014-01-28 10:56:29 +00:00
* 2181 - RRset definition - there is no RRset type though, just []RR
2011-01-27 08:29:11 +00:00
* 2537 - RSAMD5 DNS keys
* 2065 - DNSSEC (updated in later RFCs)
2012-02-18 20:49:02 +00:00
* 2671 - EDNS record
* 2782 - SRV record
* 2845 - TSIG record
* 2915 - NAPTR record
2013-04-18 09:23:53 +00:00
* 2929 - DNS IANA Considerations
2011-01-27 08:29:11 +00:00
* 3110 - RSASHA1 DNS keys
* 3225 - DO bit (DNSSEC OK)
2012-02-18 20:49:02 +00:00
* 340{1,2,3} - NAPTR record
2012-02-16 22:34:09 +00:00
* 3445 - Limiting the scope of (DNS)KEY
* 3597 - Unknown RRs
* 403{3,4,5} - DNSSEC + validation functions
2012-02-18 20:49:02 +00:00
* 4255 - SSHFP record
2013-09-20 15:15:27 +00:00
* 4343 - Case insensitivity
2012-02-18 20:49:02 +00:00
* 4408 - SPF record
2011-03-22 08:44:33 +00:00
* 4509 - SHA256 Hash in DS
2012-02-15 09:28:55 +00:00
* 4592 - Wildcards in the DNS
* 4635 - HMAC SHA TSIG
2012-02-18 20:25:37 +00:00
* 4701 - DHCID
2011-07-29 10:24:41 +00:00
* 4892 - id.server
2013-09-20 15:15:27 +00:00
* 5001 - NSID
2012-02-18 20:49:02 +00:00
* 5155 - NSEC3 record
* 5205 - HIP record
2012-04-18 12:52:49 +00:00
* 5702 - SHA2 in the DNS
2011-01-27 08:29:11 +00:00
* 5936 - AXFR
2013-10-18 22:07:48 +00:00
* 5966 - TCP implementation recommendations
2012-05-03 06:59:02 +00:00
* 6605 - ECDSA
* 6725 - IANA Registry Update
2012-11-17 20:26:48 +00:00
* 6742 - ILNP DNS
* 6840 - Clarifications and Implementation Notes for DNS Security
2015-06-16 09:01:28 +00:00
* 6844 - CAA record
2013-04-27 15:57:33 +00:00
* 6891 - EDNS0 update
2013-10-13 12:28:48 +00:00
* 6895 - DNS IANA considerations
2014-08-30 15:46:37 +00:00
* 6975 - Algorithm Understanding in DNSSEC
2014-01-28 10:59:12 +00:00
* 7043 - EUI48/EUI64 records
* 7314 - DNS (EDNS) EXPIRE Option
2017-02-15 20:40:16 +00:00
* 7828 - edns-tcp-keepalive EDNS0 Option
* 7553 - URI record
2016-06-11 08:21:11 +00:00
* 7858 - DNS over TLS: Initiation and Performance Considerations (draft)
* 7873 - Domain Name System (DNS) Cookies (draft-ietf-dnsop-cookies)
2012-10-17 07:06:49 +00:00
* xxxx - EDNS0 DNS Update Lease (draft)
2012-08-26 20:32:47 +00:00
## Loosely based upon
* `ldns`
* `NSD`
* `Net::DNS`
* `GRONG`