Recent changes to protocols

protocols modified by Nicholas Williams

Nicholas Williams — Wed, 27 Jan 2016 17:14:42 -0000

--- v16
+++ v17
@@ -315,6 +315,56 @@

 DuckDNS is supported since [r179] based on a patch provided by by gkranis on github.

+# nsupdate
+The 'nsupdate' protocol (added in ddclient version 3.8.3) is a wrapper around the `nsupdate` command-line tool. It uses the [RFC 2136 DNS Update protocol](https://www.ietf.org/rfc/rfc2136.txt) to push changes to a zone using the standard DNS communication protocols directly to a DNS server, instead of to a web service operated by a DNS vendor (like most other ddclient protocols do).
+
+To use 'nsupdate', your DNS server or servers must be configured to accept RFC 2136 DNS Update requests (consult the documentation for your DNS server, or its hosting provider, on how to do this). While it is allowed in RFC 2136 to configure DNS updates without authentication, it is strongly discouraged, and ddclient does not support it. You must generate a TSIG key (with, for example, a tool like `dnssec-keygen`), configure your DNS server to accept only those DNS updates signed by that key, and then create a key file for ddclient+nsupdate to use.
+
+There are two supported key file formats. The first is a pair of symmetric key files output by `dnssec-keygen` (or similar tools) with the same name but different extensions (one ends in `.key` and the other in `.private`). When specifying the key file in your ddclient configuration options, you use the path to the file with the `.key` extension, and `nsupdate` uses it and replaces the extension with `.private` to obtain the second key file. However, newer versions of `dnssec-keygen` generate newer key file formats that `nsupdate` might not understand. A more reliable option is to create a key file containing a `named`-compatible key statement and specify the full path to that (with extension) in your ddclient configuration. See the examples below for more information.
+
+Configuration variables applicable to the 'nsupdate' protocol are:
+
+configuration          | information 
+-----------------------|-------------
+protocol=nsupdate       |
+server=fqdn.of.name.server OR server="fqdn.of.name.server port-number"   | Server name defaults to members.dyndns.org, server port defaults to 53. If you need to specify a port number, you must put quotes around the space-separated server address and port number. The server name can also be specified as an IPv4 or IPv6 address instead of a host name.
+login=/usr/bin/nsupdate   | Defaults to /usr/bin/nsupdate. Change to the full path to nsupdate on your system if it differs.
+password=/path/to/key       | The path to the symmetric HMAC key file with the `.key` extension, or the path to the `named`-compatible key file.
+zone=domain.name       | The domain name of the DNS zone under which the host to be updated resides.
+ttl=600       | The time to live that should be used for the host record. Defaults to 600 seconds.
+tcp=no|yes       | `nsupdate` uses UDP by default, and switches to TCP if the update is too large to fit in a UDP datagram. This setting forces `nsupdate` to always use TCP. Defaults to no (default automatic operation). (This option was added in ddclient version 3.8.next / 3.next.0).
+full.qualified.host       | The host whose IP address should be updated.
+
+The following is an example `named`-compatible key file. You can get the algorithm and secret from the HMAC key file with the `.private` extension. If the algorithm in the file contains an underscore, replace it with a hyphen. If the secret is longer than 56 characters, you must insert a space every 56 characters.
+
+~~~~
+key my.key.name {
+algorithm HMAC-MD5;
+secret "SAdhkjhkjashdkjhasdkjbasdkbk8768/+sadfnasdasdkjahsdasdhk jhasdasd/+oeurc8234==";
+};
+~~~~
+
+Example ddclient.conf file entries:
+
+~~~~
+## Single host update with default port, nsupdate path, TTL, and TCP options
+protocol=nsupdate
+server=ns1.mydomain.com
+password=/secure/folder/key-file.key
+zone=mydomain.com
+dynamic-domain.mydomain.com
+
+## Multiple hosts with nonstandard port and no defaults
+protocol=nsupdate
+server="ns1.mydomain.com 54"
+login=/custom/sbin/nsupdate
+password=/secure/folder/key-file.key
+zone=mydomain.com
+ttl=1800
+tcp=yes
+dynamic-domain1.mydomain.com,dynamic-domain2.mydomain.com
+~~~~
+
 # Your-favorite-provider here
 If you want your favorite provider, please don't just ask.  You can provide your own patch against the latest version of ddclient.  It will probably be accepted if:

protocols modified by wimpunk

wimpunk — Mon, 23 Mar 2015 19:22:42 -0000

--- v15
+++ v16
@@ -291,6 +291,30 @@

 Googledomains are supported since [r171] based on a pull request from nelsonjr on github.

+# duckdns
+
+The 'duckdns' protocol is used by the free
+dynamic DNS service offered by www.duckdns.org.
+Check http://www.duckdns.org/install.jsp?tab=linux-cron for API
+
+Configuration variables applicable to the 'duckdns' protocol are:
+
+configuration          | information 
+-----------------------|-------------
+protocol=duckdns             |
+server=www.fqdn.of.service   | defaults to www.duckdns.org
+password=service-password    | password (token) registered with the service
+non-fully.qualified.host     | the host registered with the service.
+
+Example ddclient.conf file entries:
+
+    ## single host update
+    protocol=duckdns,                \
+    password=z0mgs3cjur3p4ss         \
+    myhost
+
+DuckDNS is supported since [r179] based on a patch provided by by gkranis on github.
+
 # Your-favorite-provider here
 If you want your favorite provider, please don't just ask.  You can provide your own patch against the latest version of ddclient.  It will probably be accepted if:

protocols modified by wimpunk

wimpunk — Mon, 23 Mar 2015 19:17:39 -0000

--- v14
+++ v15
@@ -262,6 +262,35 @@

 ChangeIP is supported since [r150] based on a patch submitted by Michele Giorato in [e85661ad]

+# googledomains
+
+The 'googledomains' protocol is used by DNS service offered by www.google.com/domains.
+
+Configuration variables applicable to the 'googledomains' protocol are:
+
+configuration          | information 
+-----------------------|-------------
+protocol=googledomains       |
+login=service-login          | the user name provided by the admin interface
+password=service-password    | the password provided by the admin interface
+fully.qualified.host         | the host registered with the service.
+
+Example ddclient.conf file entries:
+
+    ## single host update
+    protocol=googledomains,                                      \
+    login=my-generated-user-name,                                \
+    password=my-genereated-password                              \
+    myhost.com
+
+    ## multiple host update to the custom DNS service
+    protocol=googledomains,                                      \
+    login=my-generated-user-name,                                \
+    password=my-genereated-password                              \
+    my-toplevel-domain.com,my-other-domain.com
+
+Googledomains are supported since [r171] based on a pull request from nelsonjr on github.
+
 # Your-favorite-provider here
 If you want your favorite provider, please don't just ask.  You can provide your own patch against the latest version of ddclient.  It will probably be accepted if:

protocols modified by wimpunk

wimpunk — Tue, 20 May 2014 21:21:05 -0000

--- v13
+++ v14
@@ -264,8 +264,13 @@

 # Your-favorite-provider here
 If you want your favorite provider, please don't just ask.  You can provide your own patch against the latest version of ddclient.  It will probably be accepted if:
-* it's a free dynamic DNS provider.
-* if the provider support SSL please add it to the readme.ssl file.
-* if you provide a nice example in the sample-etc_ddclient.conf file.
-* and if you provide a link to the API.
+
+ * it's a free dynamic DNS provider.
+ * if the provider support SSL please add it to the readme.ssl file.
+ * if you provide a nice example in the sample-etc_ddclient.conf file.
+ * if you don't forget to edit the README.md
+ * if your patch applies nicely
+ * and if you provide a link to the API.
+
 As we don't use all the possible options, we also like it if you could give support if people are having problems with your provider.
+You can also provide a pull request on [github](https://github.com/wimpunk/ddclient/)

protocols modified by wimpunk

wimpunk — Tue, 29 Apr 2014 18:12:58 -0000

--- v12
+++ v13
@@ -261,3 +261,11 @@
     myhost.changeip.org

 ChangeIP is supported since [r150] based on a patch submitted by Michele Giorato in [e85661ad]
+
+# Your-favorite-provider here
+If you want your favorite provider, please don't just ask.  You can provide your own patch against the latest version of ddclient.  It will probably be accepted if:
+* it's a free dynamic DNS provider.
+* if the provider support SSL please add it to the readme.ssl file.
+* if you provide a nice example in the sample-etc_ddclient.conf file.
+* and if you provide a link to the API.
+As we don't use all the possible options, we also like it if you could give support if people are having problems with your provider.

protocols modified by wimpunk

wimpunk — Mon, 28 Oct 2013 21:50:12 -0000

--- v11
+++ v12
@@ -7,7 +7,7 @@
 [TOC]

 # dnspark protocol
-The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.  According to [bugs:#54] you have to use ssl and set the server to www.dnspark.org to get it working but that bug isn't confirmed yet. 
+The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.  According to [bugs:#54] you have to use ssl and set the server to www.dnspark.org to get it working but that bug isn't confirmed yet. A possible fix for it can be found on [bugs:#36].

 Configuration variables applicable to the 'dsnpark' protocol are:

protocols modified by wimpunk

wimpunk — Mon, 28 Oct 2013 21:12:35 -0000

--- v10
+++ v11
@@ -7,7 +7,7 @@
 [TOC]

 # dnspark protocol
-The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.  According to [#54] you have to use ssl and set the server to www.dnspark.org to get it working but that bug isn't confirmed yet. 
+The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.  According to [bugs:#54] you have to use ssl and set the server to www.dnspark.org to get it working but that bug isn't confirmed yet. 

 Configuration variables applicable to the 'dsnpark' protocol are:

protocols modified by wimpunk

wimpunk — Mon, 28 Oct 2013 21:11:38 -0000

--- v9
+++ v10
@@ -7,7 +7,7 @@
 [TOC]

 # dnspark protocol
-The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.
+The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.  According to [#54] you have to use ssl and set the server to www.dnspark.org to get it working but that bug isn't confirmed yet. 

 Configuration variables applicable to the 'dsnpark' protocol are:

protocols modified by wimpunk

wimpunk — Mon, 28 Oct 2013 21:09:29 -0000

--- v8
+++ v9
@@ -1,11 +1,12 @@
 # Introduction about the supported protocols
-
 This is an incomplete list of the services supported by ddclient. If your favourite dynamic dns provider isn't here, check the result ddclient --help with the most recent version of ddclient. If it's there, check the patches section on sf.net and if it's really not supported by ddclient you can try to modify ddclient yourself.

 Since ddclient version 3.7, ddclient also supports https to update your favourite provider. Use the ssl=yes option to use this feature.

+# Overview of the protocols
+[TOC]
+
 # dnspark protocol
-
 The 'dnspark' protocol is used by DNS service offered by www.dnspark.com.

 Configuration variables applicable to the 'dsnpark' protocol are:

protocols modified by wimpunk

wimpunk — Sun, 28 Apr 2013 16:15:20 -0000

--- v7
+++ v8
@@ -237,3 +237,26 @@
     my.domain.name,my2nd.domain.com

+# Changeip
+
+The 'changeip' protocol is used by DNS services offered by changeip.com.
+
+Configuration variables applicable to the 'changeip' protocol are:
+
+configuration          | information 
+-----------------------|-------------
+protocol=changeip            |
+server=fqdn.of.service       | defaults to nic.changeip.com
+login=service-login          | login name and password registered with the service
+password=service-password    |
+fully.qualified.host         | the host registered with the service.
+
+Example ddclient.conf file entries:
+
+    ## single host update
+    protocol=changeip,                                               \
+    login=my-my-changeip.com-login,                                  \
+    password=my-changeip.com-password                                \
+    myhost.changeip.org
+
+ChangeIP is supported since [r150] based on a patch submitted by Michele Giorato in [e85661ad]