goll72 / ipup

IP update tool

ipup

Small tool that uses Netlink to detect IP address changes on specified interfaces and update a DNS entry using RFC 2136.

Building

Dependencies

• meson
• libldns
• libinih
• libnl
• libcriterion (testing only)

These should be easily installable using your system's package manager. Note that on some distributions you may have to install libnl and libnl-route separately.

Actually building

Simply clone the repository:

$ git clone https://github.com/goll72/ipup

and run

$ meson setup build
$ meson compile -C build

Note that you may want to set the sysconfdir option to /etc on Linux, otherwise ipup will look for the systemwide configuration file in $(prefix)/$(sysconfdir), which is /usr/local/etc by default. You can set it by adding -Dsysconfdir=/etc to the meson setup invocation.

To install, run

$ meson install -C build

Configuration

Ipup's configuration file uses a syntax similar to INI. For instance:

[server/example]
fqdn = example.com
# default
port = 53

key-name = example
key-secret = ...
# or, alternatively:
key-file = /etc/ipup/key
key-algo = HMAC-SHA512

max-retry = 10

[iface/wlan0]
server = example
zone = example.com
record = foo

# default: no
delete-existing = yes

# mutually exclusive
ttl = 86400s
# default: no
respect-ttl = yes

• There are two types of sections. Those starting with server/ denote a DNS server, that may be reused. Those starting with iface/ denote network interfaces.
• Boolen options can take a value of yes, true, 1 or no, false and 0.
• If the record isn't a valid subdomain of the zone, it will be concatenated with it.
• Time durations can take the following specifiers: seconds, minutes, hours or days. Multiple specifiers are allowed, e.g. 1d 2h 10m.

Options

For the server

• fqdn is the FQDN (fully qualified domain name) of the DNS server.
• port is the port used for the DNS connection (53 by default).
• key-secret is the Base64-encoded key secret.
• key-file is a file containing only the Base64-encoded key secret.
• key-algo is the encryption algorithm used. Possible values can be listed with ldns-keygen -a list.
• max-retry sets the maximum number of times ipup will retry to send a request to the server before giving up.

For the interface

• server is the name of the server used for the given interface as specified in its section (not the FQDN).
• ttl specifies the TTL to be used for the records. The default TTL used if it isn't specified, and neither is respect-ttl, is 1 hour.
• respect-ttl makes the TTL of the DNS record match the TTL of the given address (valid lifetime). You should only enable it if you know your leases are consistently short enough.
• delete-existing will delete any DNS records not present in the kernel address table on startup.

For either

These options can be placed in either the server or the interface section, but they must be fully specified in only one or the other.

• zone is the DNS zone for the record.
• record is the DNS record that will be updated.

Running

Specify a configuration file with the -c option, otherwise it will look for a configuration file in:

• $(sysconfdir)/ipup/conf
• $XDG_CONFIG_HOME/ipup/conf
• ~/.ipup.conf

Ipup can be run in oneshot with the -o option. When in oneshot mode, it will only synchronize the DNS records with the host addresses and exit.

Notes

IPv4

Only IPv6 is supported, as IPv4 needs an external host to be able to tell your public IPv4 address. That much is manageable, however, polling for address changes is not. Also, most commonly, IPv4 networks have NATs in place, which makes keeping track of an external IPv4 address pretty much useless.

Couldn't you do the same thing with ip monitor?

Yes, but in some badly configured IPv6 setups (like mine), spurious router advertisements can flood the Netlink queue with duplicate addresses, so it's more ergonomic and more efficient to figure out if an address really has changed in C than in a shell script, for instance.