This is a clone/fork of https://github.com/miekg/dns
Go to file
Miek Gieben 872dc4fc6b Make the private key reading more natural 2012-04-15 20:55:25 +02:00
ex iets mooier 2012-03-27 09:26:04 +02:00
t Put this in a example test function 2012-02-17 20:37:19 +01:00
.gitignore Tweak gitignore 2012-02-11 17:44:14 +01:00
LICENSE update license date 2012-02-18 15:52:11 +01:00
README.markdown Update the readme 2012-03-04 16:35:21 +01:00
TODO.markdown Update the todo 2012-03-27 09:01:22 +02:00
client.go Allow deregistration of handler 2012-03-26 23:15:15 +02:00
client_test.go Fix the testcases 2012-03-04 22:35:48 +01:00
clientconfig.go gofmt 2011-12-09 21:45:57 +01:00
defaults.go More server side TSIG stuff - does not validate (yet) 2012-03-04 22:32:23 +01:00
dns.go small doc update 2012-03-27 11:02:30 +02:00
dns_test.go Upgrade the definition of domain name 2012-02-28 20:47:25 +01:00
dnssec.go Add symmetry to the reading of public/private keys 2012-04-15 20:50:53 +02:00
dnssec_test.go Make the private key reading more natural 2012-04-15 20:55:25 +02:00
dyn_test.go gofmt 2011-12-09 21:45:57 +01:00
edns.go move tsig to tsig.go just as RR_OPT 2012-03-02 23:07:25 +01:00
keygen.go fix the mnemonic for ecdsa* 2012-04-11 14:37:51 +02:00
kscan.go Add symmetry to the reading of public/private keys 2012-04-15 20:50:53 +02:00
label_test.go Force the root label to have 0 labels 2012-02-14 22:26:18 +01:00
labels.go gofmt 2012-02-23 19:37:08 +01:00
msg.go Always use "." for the root domain. 2012-03-17 23:43:12 -07:00
nsec3_test.go Make all tests fully qualified 2012-01-08 15:34:42 +01:00
nsecx.go prototype nsec cover method 2012-03-08 21:16:51 +01:00
parse_test.go Make the private key reading more natural 2012-04-15 20:55:25 +02:00
rawmsg.go documentation 2012-03-18 22:41:29 +01:00
scanner.go go fmt and line nr tweak 2012-02-21 22:43:24 +01:00
server.go Allow deregistration of handler 2012-03-26 23:15:15 +02:00
server_test.go Fix the testcases 2012-03-04 22:35:48 +01:00
tsig.go Fix the tsig documentation 2012-03-06 19:10:49 +01:00
types.go typecode assigned 2012-04-14 10:44:32 +02:00
update.go Docs 2012-01-26 22:52:29 +01:00
xfr.go Fix the tests, but they now fail 2012-01-11 14:44:54 +01:00
zscan.go Install example right away 2012-03-04 10:41:16 +01:00
zscan_rr.go Test signing with ecdsa 2012-04-11 15:13:17 +02:00

README.markdown

Alternative (more granular) approach to a DNS library.

Less is more.

Complete and usable DNS library. Most 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.

Goals:

  • KISS;
  • Symmetric API: client and server side should be very similar;
  • Small API, if its easy to code in Go, don't make a function for it.

Features:

  • UDP/TCP queries, IPv4 and IPv6;
  • RFC 1035 zone file parsing;
  • Fast:
    • reply speed around 35/40K qps (Faster hardware -> more qps);
    • Parsing RRs (zone files) with 95/100K RR/s, that's 5M records in about 50 seconds;
    • This is expected to be optimized further.
  • Client and server side programming (mimicking the net/http package);
  • Asynchronous queries/replies for client and server;
  • DNSSEC;
  • EDNS0, NSID;
  • AXFR/IXFR;
  • TSIG;
  • DNS name compression.

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 build dns

Sample programs can be found in the ex directory. They can be build with: make -C ex, or also with the go tool.

Building (from scratch)

The development of the language Go is going at a fast pace, hence an updated version of Super-short guide to gettinq.

Get the latest version (called weekly) of Go:

  1. Get Go: hg clone -u release https://go.googlecode.com/hg/ go Note the directory you have downloaded it to and set add its bin directory to your PATH: PATH=$PWD/go/bin.

  2. Update Go to the latest weekly: cd go; hg pull; hg update weekly

  3. Compile Go: cd src, you should now sit in go/src. And compile: ./all.bash

Install missing commands (gcc, sed, bison, etc.) if needed.

The latest Go is now installed. You should now have the go-tool, this is the central interface to all Go program building tasks.

$ go
Go is a tool for managing Go source code.

Usage: go command [arguments]

The commands are:

build       compile packages and dependencies
clean       remove object files
doc         run godoc on package sources
fix         run go tool fix on packages
....
....
lost more

If you can not run go, check your PATH.

Install Go DNS and set GOPATH

The GOPATH variable specifies (among things) where your GO code lives. Using the go tool does bring a few requirement to the table in how to layout the directory structure.

  1. Create toplevel directory (~/g)for your code: mkdir -p ~/g/src
  2. Set GOPATH to this toplevel directory: export GOPATH=~/g
  3. Get dns: cd ~/g/src; git clone git://github.com/miekg/dns.git
  4. Compile it: cd dns; go build
  5. Compile and install the examples, there is a helper Makefile here, but it just calls go multiple times: cd ex; make
  6. Look in $GOPATH/bin for the binaries, in this setup that will be ~/g/bin
  7. Query with q: ~/g/bin/q mx miek.nl (or add ~/g/bin to your $PATH too)
  8. Report bugs

Supported RFCs

All of them:

  • 103{4,5} - DNS standard
  • 1982 - Serial Arithmetic
  • 1876 - LOC record (incomplete)
  • 1995 - IXFR
  • 1996 - DNS notify
  • 2136 - DNS Update (dynamic updates)
  • 2181 - RRset definition
  • 2537 - RSAMD5 DNS keys
  • 2065 - DNSSEC (updated in later RFCs)
  • 2671 - EDNS record
  • 2782 - SRV record
  • 2845 - TSIG record
  • 2915 - NAPTR record
  • 3110 - RSASHA1 DNS keys
  • 3225 - DO bit (DNSSEC OK)
  • 340{1,2,3} - NAPTR record
  • 3445 - Limiting the scope of (DNS)KEY
  • 3597 - Unkown RRs
  • 403{3,4,5} - DNSSEC + validation functions
  • 4255 - SSHFP record
  • 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
  • 5933 - GOST
  • 5936 - AXFR
  • xxxx - ECDSA
  • xxxx - URI record

Loosely based upon:

  • ldns
  • NSD
  • Net::DNS
  • GRONG