summaryrefslogtreecommitdiff
path: root/README.md
blob: f5e8345920ac9535a4717c09054f40dd71f73c47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# go-nsupdate
Update dynamic DNS records from netlink.

`go-nsupdate` reads interface addresses from netlink, updating on `ip link up/down` and `ip addr add/del` events.

The set of active interface IPv4/IPv6 addresses is used to send DNS `UPDATE` requests to the primary NS for a DNS zone.

The DNS update requests are retried in the background (XXX: currently blocks for 10s on each query attempt).

## Install

    go get github.com/SpComb/go-nsupdate

## Usage

	Usage:
	  go-nsupdate [OPTIONS] [Name]

	Application Options:
	  -v, --verbose
		  --watch                                           Watch for interface changes
	  -i, --interface=IFACE                                 Use address from interface
		  --interface-family=ipv4|ipv6|all                  Limit to interface addreses of given family
		  --server=HOST[:PORT]                              Server for UPDATE query, default is discovered from zone SOA
		  --timeout=DURATION                                Timeout for sever queries (default: 10s)
		  --retry=DURATION                                  Retry interval, increased for each retry attempt (default: 30s)
		  --tsig-name=FQDN
		  --tsig-secret=BASE-64                             base64-encoded shared TSIG secret key [$TSIG_SECRET]
		  --tsig-algorithm=hmac-{md5,sha1,sha256,sha512}
		  --zone=FQDN                                       Zone to update, default is derived from name
		  --ttl=DURATION                                    TTL for updated records (default: 60s)

	Help Options:
	  -h, --help                                            Show this help message

	Arguments:
	  Name:                                                 DNS Name to update


## Example
    
    # Using a generated TSIG key:
    # TSIG_SECRET=$(python -c 'import os; print os.urandom(32).encode("base64")')
    
    TSIG_SECRET=... go-nsupdate --interface=vlan-wan --tsig-algorithm=hmac-sha256 yzzrt.dyn.qmsk.net --watch
    2016/06/19 21:29:33 discover server=zovoweix.qmsk.net.
    2016/06/19 21:29:33 using TSIG: yzzrt.dyn.qmsk.net (algo=hmac-sha256.)
    2016/06/19 21:29:33 AddrSet iface=vlan-wan: up 2001:14ba:400:0:7:1449:a833:f11f
    2016/06/19 21:29:33 update...
    2016/06/19 21:29:33 update query:
    ;; opcode: UPDATE, status: NOERROR, id: 61616
    ;; flags:; QUERY: 1, ANSWER: 0, AUTHORITY: 2, ADDITIONAL: 1

    ;; QUESTION SECTION:
    ;dyn.qmsk.net.  IN       SOA

    ;; AUTHORITY SECTION:
    yzzrt.dyn.qmsk.net.     0       ANY     ANY
    yzzrt.dyn.qmsk.net.     60      IN      AAAA    2001:14ba:400:0:7:1449:a833:f11f

    ;; ADDITIONAL SECTION:

    ;; TSIG PSEUDOSECTION:
    yzzrt.dyn.qmsk.net.     0       ANY     TSIG     hmac-sha256. 20160619182933 300 0  61616 0 0 
    2016/06/19 21:29:33 update answer:
    ;; opcode: UPDATE, status: NOERROR, id: 61616
    ;; flags: qr; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 1

    ;; QUESTION SECTION:
    ;dyn.qmsk.net.  IN       SOA

    ;; ADDITIONAL SECTION:

    ;; TSIG PSEUDOSECTION:
    yzzrt.dyn.qmsk.net.     0       ANY     TSIG     hmac-sha256. 20160619182933 300 32 E083433B2893B2036B24549E3537C6E17B858019B9862DC2EB9EDFB959D03232 61616 0 0 
    2016/06/19 21:46:34 AddrSet iface=vlan-wan: up 213.243.178.191
    2016/06/19 21:46:34 addrs update...
    2016/06/19 21:46:34 update...
    2016/06/19 21:46:34 update query:
    ;; opcode: UPDATE, status: NOERROR, id: 30973
    ;; flags:; QUERY: 1, ANSWER: 0, AUTHORITY: 3, ADDITIONAL: 1

    ;; QUESTION SECTION:
    ;dyn.qmsk.net.  IN       SOA

    ;; AUTHORITY SECTION:
    yzzrt.dyn.qmsk.net.     0       ANY     ANY
    yzzrt.dyn.qmsk.net.     60      IN      AAAA    2001:14ba:400:0:7:1449:a833:f11f
    yzzrt.dyn.qmsk.net.     60      IN      A       213.243.178.191

    ;; ADDITIONAL SECTION:

    ;; TSIG PSEUDOSECTION:
    yzzrt.dyn.qmsk.net.     0       ANY     TSIG     hmac-sha256. 20160619184634 300 0  30973 0 0 
    2016/06/19 21:46:35 update answer:
    ;; opcode: UPDATE, status: NOERROR, id: 30973
    ;; flags: qr; QUERY: 1, ANSWER: 0, AUTHORITY: 0, ADDITIONAL: 1

    ;; QUESTION SECTION:
    ;dyn.qmsk.net.  IN       SOA

    ;; ADDITIONAL SECTION:

    ;; TSIG PSEUDOSECTION:
    yzzrt.dyn.qmsk.net.     0       ANY     TSIG     hmac-sha256. 20160619184635 300 32 1F7F1EB8A3D5213EAAA163AE78388D48911495A0F3E2870688F3338160905EC9 30973 0