ipv6ddns

README

Network wide IPv6 DDNS Updater

This utility discovers IPv6 addresses on your local network and updates DNS records dynamically. Details

If you have a special use case: ipv6disc

Installation

Download the latest release for your architecture.

Or use the docker image

This may or may not work on your system. I was able to make it work with host networking and without ipv6:true in /etc/docker/daemon.json???. If you have experience and can help with ipv6 docker please let me know.

docker run -it --rm --network host -v ./config.json:/config.json gcr.io/miguelangel-nubla/ipv6ddns -live

Or install from source

Ensure you have Go installed on your system. If not, follow the instructions on the official Go website to install it. Then:

go install github.com/miguelangel-nubla/ipv6ddns/cmd/ipv6ddns

Usage

Adjust the configuration on config.json and run the binary with the desired flags:

⚠ This utility needs to be executed as a superuser to be able to listen for IPv6 ICMP packets.

sudo ipv6ddns [flags]

Flags

• -config_file (default "config.json"): Config file to use.
• -log_level (default "info"): Set the logging level (debug, info, warn, error, fatal, panic).
• -lifetime (default "4h"): Time to keep a discovered host entry after it has been last seen.
• -live (default false): Show the current state live on the terminal.
• -webserver_port (default 0): If port specified you can connect to this port to view the same live output from a browser.

Depending on your IPv6 network configuration, you will need to allow outside access to the hosts you want to expose.

The easiest way is to either specify allowed subnets or simply allow by destination MAC address.

Configuration

This is the structure of the config.json file:

{ 
  "tasks": {
    "my_public_web_server": { // whichever name you like for this task, it is only for reference
      "subnets": ["2000::/3"], // only IPv6 addresses on these subnets will be updated into the DDNS provider. "2000::/3" is any GUA.
      "mac_address": ["00:11:22:33:44:55", "00:11:22:33:44:56"], // MAC addresses of the hosts to look for
      "endpoints": {
        "example-project": [ // name of the endpoint to use for this task, as configured on the credentials section at the bottom
          "test-webapp" // hostname whose AAAA records will be kept in sync. This results in updating test-webapp.example.com as defined by example-project settings
        ]
      },
      "lifetime": "4h",
      "ipv4": { // optional, also update IPv4 (A) records aquired from command run at the specified interval. expects one IPv4 per line in cleartext as output
        "interval": "10m",
        "command": "printf",
        "args": [
          "%s\\n",
          "192.168.0.12"
          "192.168.0.34"
        ],
        "lifetime": "4h"
      }
    }
    // ...
    // more task configurations if needed
    // ...
  },
  "credentials": {
    "example-project": { // name you will use to refer to this endpoint on the tasks
      "provider": "cloudflare", // one of the supported providers
      "settings": { // provider specific configuration
        "api_token": "CLOUDFLARETOKEN",
        "zone": "example.com",
        "ttl": "1h", // if proxied over cloudflare this will have no effect
        "proxied": true
      }
      "debounce_time": "10s", // optional, default 10s. time to wait before pushing updates
      "retry_time": "60s" // optional, default 60s. time to wait between retries on update error
    }
    // ...
    // more credentials if needed
    // ...
  }
}

DDNS providers

The available DDNS providers are:

• Cloudflare (free plan compatible)

• Duckdns (provider only allows a single AAAA record)

• Gravity (hosted locally)

• 🚀 Adding your preferred provider is easy:

  • Take a provider from ddns/ such as cloudflare.go as a template.
  • Replace every reference to cloudflare with the new provider. This is case-sensitive.
  • Replace the API calls with the ones your provider need.
  • Test.
  • Create a PR!

---

What does this do?

The problem

Having a domain name my-web.example.com point to your application on an IPv6 network is both simpler and more challenging than doing it with regular IPv4.

The classic method of directing traffic to your public IPv4 address (i.e., your router) and then using NAT is no longer a good idea, nor necessary.

IPv6 addresses are globally routable, which is nice, but you will need to know the exact IPv6, as different machines or even containers on the same host (and even different applications) will have different "public" IPv6s, or GUAs in IPv6 terminology.

In this scenario DNS names become almost mandatory, good luck trying to remember and type a different https://[2001:0db8:85a3:0000:8a2e:0370:7334:abcd] to access each one of your hosts.

Technically, IPv6 addresses could be static, but part of the beauty of IPv6 is the ability to use and rotate multiple different IP addresses on demand. Even if you don't want to, some ISPs change your IPv6 prefix on router reboot or periodically.

Rationale

You might be thinking well, I will just run a DDNS updater on my server? It turns out that may not be really an option, remember each application has its own, dynamic IPv6? How do you indicate which IP should the DNS record point to? Does that mean the way to do that is to run the updater on the same container as your web server?

Unfortunately yes. That is not a great idea. Aside from the inconvenience of forking and using your own container images, there will be systems that you will not be able to modify. Think about a device on your network that has no way of running a custom executable, like an appliance, or an IP camera.

Wouldn't it be nice to have a single instance of a "DNS updater" anywhere on your network that detects the IPv6 of your desired hosts, identifies when they change, and updates the relevant DNS records accordingly?

The solution

This utility scans the network for the IPv6s of the hosts you want to expose, identified by their MAC address, and updates the corresponding DNS records automatically.

This works for all your network, having the configuration and your credentials in a single place.

---

Other nice usages

Roaming over multiple IPv6 networks

This utility allows you to move between IPv6 networks and to maintain inbound connectivity. You can have as many IPv6 addresses from different ISPs as you like and the AAAA records for your domain will be kept in sync.

For example, you can have a fiber connection, a backup LTE connection, and Starlink on your roof. Your domain will have AAAA records for every WAN connection, inbound WAN failover will simply work.

License

This project is licensed under Apache License 2.0

It uses libraries from the following projects:

• github.com/miguelangel-nubla/ipv6disc - Apache License 2.0
• github.com/xeipuuv/gojsonschema - MIT License
• go.uber.org/zap - MIT License
• github.com/cloudflare/cloudflare-go - BSD 3-Clause License

Documentation

Index

• type Endpoint
  • func NewEndpoint(service ddns.Service) *Endpoint
• type Hostname
  • func NewHostname(updateAction func(*ipv6disc.AddrCollection) error, ...) *Hostname
  • func (h *Hostname) ScheduleUpdate(timeout time.Duration)
  • func (h *Hostname) SetAddrCollection(addrCollection *ipv6disc.AddrCollection)
• type InvalidInterfaceError
  • func (e *InvalidInterfaceError) Error() string
• type Provider
  • func NewProvider() *Provider
• type State
  • func NewState() *State
  • func (s *State) PrettyPrint(prefix string, hideSensible bool) string
• type Worker
  • func NewWorker(logger *zap.SugaredLogger, rediscover time.Duration, lifetime time.Duration, ...) *Worker
  • func (w *Worker) PrettyPrint(prefix string, hideSensible bool) string
  • func (w *Worker) Start() error

Types

type Endpoint

type Endpoint struct {
	ddns.Service
	// contains filtered or unexported fields
}

func NewEndpoint

func NewEndpoint(service ddns.Service) *Endpoint

type Hostname

type Hostname struct {
	ipv6disc.AddrCollection
	// contains filtered or unexported fields
}

func NewHostname

func NewHostname(updateAction func(*ipv6disc.AddrCollection) error, updateDebounceTime time.Duration, updateRetryInterval time.Duration) *Hostname

func (*Hostname) ScheduleUpdate

func (h *Hostname) ScheduleUpdate(timeout time.Duration)

func (*Hostname) SetAddrCollection

func (h *Hostname) SetAddrCollection(addrCollection *ipv6disc.AddrCollection)

type InvalidInterfaceError

type InvalidInterfaceError struct {
	// contains filtered or unexported fields
}

func (*InvalidInterfaceError) Error

func (e *InvalidInterfaceError) Error() string

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

func NewProvider

func NewProvider() *Provider

type State

type State struct {
	// contains filtered or unexported fields
}

func NewState

func NewState() *State

func (*State) PrettyPrint

func (s *State) PrettyPrint(prefix string, hideSensible bool) string

type Worker

type Worker struct {
	*State
	// contains filtered or unexported fields
}

func NewWorker

func NewWorker(logger *zap.SugaredLogger, rediscover time.Duration, lifetime time.Duration, config config.Config) *Worker

func (*Worker) PrettyPrint

func (w *Worker) PrettyPrint(prefix string, hideSensible bool) string

func (*Worker) Start

func (w *Worker) Start() error