Nebula Changelog

What's new in Nebula 1.9.0

May 8, 2024
  • Deprecated:
  • This release adds a new setting default_local_cidr_any that defaults to true to match previous behavior, but will default to false in the next release (1.10). When set to false, local_cidr is matched correctly for firewall rules on hosts acting as unsafe routers, and should be set for any firewall rules you want to allow unsafe route hosts to access.
  • Added:
  • Nebula now has an official Docker image nebulaoss/nebula that is distroless and contains just the nebula and nebula-cert binaries. You can find it here: https://hub.docker.com/r/nebulaoss/nebula (#1037)
  • Experimental binaries for loong64 are now provided. (#1003)
  • Added example service script for OpenRC. (#711)
  • The SSH daemon now supports inlined host keys. (#1054)
  • The SSH daemon now supports certificates with sshd.trusted_cas. (#1098)
  • Changed:
  • Config setting tun.unsafe_routes is now reloadable. (#1083)
  • Small documentation and internal improvements.
  • Various dependency updates.
  • Removed:
  • Support for the deprecated local_range option has been removed. Please change to preferred_ranges (which is also now reloadable). (#1043)
  • We are now building with go1.22, which means that for Windows you need at least Windows 10 or Windows Server 2016. This is because support for earlier versions was removed in Go 1.21. See https://go.dev/doc/go1.21#windows (#981)
  • Removed vagrant example, as it was unmaintained. (#1129)
  • Removed Fedora and Arch nebula.service files, as they are maintained in the upstream repos. (#1128, #1132)
  • Remove the TCP round trip tracking metrics, as they never had correct data and were an experiment to begin with. (#1114)
  • Fixed:
  • Fixed a potential deadlock introduced in 1.8.1. (#1112)
  • Fixed support for Linux when IPv6 has been disabled at the OS level. (#787)
  • DNS will return NXDOMAIN now when there are no results. (#845)
  • Allow :: in lighthouse.dns.host. (#1115)
  • Capitalization of NotAfter fixed in DNS TXT response. (#1127)
  • Don't log invalid certificates. It is untrusted data and can cause a large volume of logs. (#1116)

New in Nebula 1.8.2 (Jan 9, 2024)

  • Fixed:
  • Fix multiple routines when listen.port is zero. This was a regression introduced in v1.6.0. (#1057)
  • Changed:
  • Small dependency update for Noise. (#1038)

New in Nebula 1.8.1 (Dec 19, 2023)

  • Security:
  • Update golang.org/x/crypto, which includes a fix for CVE-2023-48795. (#1048)
  • Fixed:
  • Fix a deadlock introduced in v1.8.0 that could occur during handshakes. (#1044)
  • Fix mobile builds. (#1035)

New in Nebula 1.8.0 (Dec 7, 2023)

  • Deprecated:
  • The next minor release of Nebula, 1.9.0, will require at least Windows 10 or Windows Server 2016. This is because support for earlier versions was removed in Go 1.21. See https://go.dev/doc/go1.21#windows
  • Added:
  • Linux: Notify systemd of service readiness. This should resolve timing issues with services that depend on Nebula being active. For an example of how to enable this, see: examples/service_scripts/nebula.service. (#929)
  • Windows: Use Registered IO (RIO) when possible. Testing on a Windows 11 machine shows ~50x improvement in throughput. (#905)
  • NetBSD, OpenBSD: Added rudimentary support. (#916, #812)
  • FreeBSD: Add support for naming tun devices. (#903)
  • Changed:
  • pki.disconnect_invalid will now default to true. This means that once a certificate expires, the tunnel will be disconnected. If you use SIGHUP to reload certificates without restarting Nebula, you should ensure all of your clients are on 1.7.0 or newer before you enable this feature. (#859)
  • Limit how often a busy tunnel can requery the lighthouse. The new config option timers.requery_wait_duration defaults to 60s. (#940)
  • The internal structures for hostmaps were refactored to reduce memory usage and the potential for subtle bugs. (#843, #938, #953, #954, #955)
  • Lots of dependency updates.
  • Fixed:
  • Windows: Retry wintun device creation if it fails the first time. (#985)
  • Fix issues with firewall reject packets that could cause panics. (#957)
  • Fix relay migration during re-handshakes. (#964)
  • Various other refactors and fixes.

New in Nebula 1.7.2 (Jun 2, 2023)

  • Fix a freeze during config reload if the static_host_map config was changed. (#886)

New in Nebula 1.7.1 (May 18, 2023)

  • Fixed:
  • Fix IPv4 addresses returned by static_host_map DNS lookup queries being treated as IPv6 addresses. (#877)

New in Nebula 1.7.0 (May 17, 2023)

  • Changed:
  • Lighthouses and other static_host_map entries that use DNS names will now be automatically refreshed to detect when the IP address changes. (#796)
  • Lighthouses send ACK replies back to clients so that they do not fall into connection testing as often by clients. (#851, #408)
  • Allow the listen.host option to contain a hostname. (#825)
  • When Nebula switches to a new certificate (such as via SIGHUP), we now rehandshake with all existing tunnels. This allows firewall groups to be updated and pki.disconnect_invalid to know about the new certificate expiration time. (#838, #857, #842, #840, #835, #828, #820, #807)
  • Fixed:
  • Always disconnect blocklisted hosts, even if pki.disconnect_invalid is not set. (#858)
  • Dependencies updated and go1.20 required. (#780, #824, #855, #854)
  • Fix possible race condition with relays. (#827)
  • FreeBSD: Fix connection to the localhost's own Nebula IP. (#808)
  • Normalize and document some common log field values. (#837, #811)
  • Fix crash if you set unlucky values for the firewall timeout configuration options. (#802)
  • Make DNS queries case insensitive. (#793)
  • Update example systemd configurations to want nss-lookup. (#791)
  • Errors with SSH commands now go to the SSH tunnel instead of stderr. (#757)
  • Fix a hang when shutting down Android. (#772)

New in Nebula 1.6.1 (Sep 26, 2022)

  • Fixed:
  • Refuse to process underlay packets received from overlay IPs. This prevents confusion on hosts that have unsafe routes configured. (#741)
  • The ssh reload command did not work on Windows, since it relied on sending a SIGHUP signal internally. This has been fixed. (#725)
  • A regression in v1.5.2 that broke unsafe routes on Mobile clients has been fixed. (#729)

New in Nebula 1.6.0 (Jul 1, 2022)

  • Added:
  • Experimental: nebula clients can be configured to act as relays for other nebula clients.
  • Primarily useful when stubborn NATs make a direct tunnel impossible.
  • Configuration option to report manually specified ip:ports to lighthouses.
  • Windows arm64 build.
  • punchy and most lighthouse config options now support hot reloading.
  • Changed:
  • Build against go 1.18.
  • Promoted routines config from experimental to supported feature.
  • Dependencies updated.
  • Fixed:
  • unsafe_route configuration will no longer crash on Windows.
  • A few panics that were introduced in 1.5.x.

New in Nebula 1.5.2 (Dec 15, 2021)

  • Added:
  • Warn when a non lighthouse node does not have lighthouse hosts configured. (#587)
  • Changed:
  • No longer fatals if expired CA certificates are present in pki.ca, as long as 1 valid CA is present. (#599)
  • nebula-cert will now enforce ipv4 addresses. (#604)
  • Warn on macOS if an unsafe route cannot be created due to a collision with an existing route. (#610)
  • Warn if you set a route MTU on platforms where we don't support it. (#611)
  • Fixed:
  • Rare race condition when tearing down a tunnel due to recv_error and sending packets on another thread. (#590)
  • Bug in routes and unsafe_routes handling that was introduced in 1.5.0. (#595)
  • test mode no longer results in a crash. (#602)
  • Removed:
  • x509.ca config alias for pki.ca. (#604)
  • Security:
  • Upgraded golang.org/x/crypto to address an issue which allowed unauthenticated clients to cause a panic in SSH servers. (#603)

New in Nebula 1.5.0 (Nov 11, 2021)

  • Added:
  • SSH print-cert has a new -raw flag to get the PEM representation of a certificate. (#483)
  • New build architecture: Linux riscv64. (#542)
  • New experimental config option remote_allow_ranges. (#540)
  • New config option pki.disconnect_invalid that will tear down tunnels when they become invalid (through expiry or removal of root trust). Default is false. Note, this will not currently recognize if a remote has changed certificates since the last handshake. (#370)
  • New config option unsafe_routes.<route>.metric will set a metric for a specific unsafe route. It's useful if you have more than one identical route and want to prefer one against the other. (#353)
  • Changed:
  • Build against go 1.17. (#553)
  • Build with CGO_ENABLED=0 set, to create more portable binaries. This could have an effect on DNS resolution if you rely on anything non-standard. (#421)
  • Windows now uses the wintun driver which does not require installation. This driver is a large improvement over the TAP driver that was used in previous versions. If you had a previous version of nebula running, you will want to disable the tap driver in Control Panel, or uninstall the tap0901 driver before running this version. (#289)
  • Darwin binaries are now universal (works on both amd64 and arm64), signed, and shipped in a notarized zip file. nebula-darwin.zip will be the only darwin release artifact. (#571)
  • Darwin uses syscalls and AF_ROUTE to configure the routing table, instead of using /sbin/route. Setting tun.dev is now allowed on Darwin as well, it must be in the format utun[0-9]+ or it will be ignored. (#163)
  • Deprecated:
  • The preferred_ranges option has been supported as a replacement for local_range since v1.0.0. It has now been documented and local_range has been officially deprecated. (#541)
  • Fixed:
  • Valid recv_error packets were incorrectly marked as "spoofing" and ignored. (#482)
  • SSH server handles single exec requests correctly. (#483)
  • Signing a certificate with nebula-cert sign now verifies that the supplied ca-key matches the ca-crt. (#503)
  • If preferred_ranges (or the deprecated local_range) is configured, we will immediately switch to a preferred remote address after the reception of a handshake packet (instead of waiting until 1,000 packets have been sent). (#532)
  • A race condition when punchy.respond is enabled and ensures the correct vpn ip is sent a punch back response in highly queried node. (#566)
  • Fix a rare crash during handshake due to a race condition. (#535)

New in Nebula 1.4.0 (May 11, 2021)

  • Added:
  • Ability to output qr code images in print, ca, and sign modes for nebula-cert. This is useful when configuring mobile clients. (#297)
  • Experimental: Nebula can now do work on more than 2 cpu cores in send and receive paths via the new routines config option. (#382, #391, #395)
  • ICMP ping requests can be responded to when the tun.disabled is true. This is useful so that you can "ping" a lighthouse running in this mode. (#342)
  • Run smoke tests via make smoke-docker. (#287)
  • More reported stats, udp memory use on linux, build version (when using Prometheus), firewall, handshake, and cached packet stats. (#390, #405, #450, #453)
  • IPv6 support for the underlay network. (#369)
  • End to end testing, run with make e2e. (#425, #427, #428)
  • Changed:
  • Darwin will now log stdout/stderr to a file when using -service mode. (#303)
  • Example systemd unit file now better arranged startup order when using sshd and other fixes. (#317, #412, #438)
  • Reduced memory utilization/garbage collection. (#320, #323, #340)
  • Reduced CPU utilization. (#329)
  • Build against go 1.16. (#381)
  • Refactored handshakes to improve performance and correctness. (#401, #402, #404, #416, #451)
  • Improved roaming support for mobile clients. (#394, #457)
  • Lighthouse performance and correctness improvements. (#406, #418, #429, #433, #437, #442, #449)
  • Better ordered startup to enable sshd, stats, and dns subsystems to listen on the nebula interface. (#375)
  • Fixed:
  • No longer report handshake packets as lost in stats. (#331)
  • Error handling in the cert package. (#339, #373)
  • Orphaned pending hostmap entries are cleaned up. (#344)
  • Most known data races are now resolved. (#396, #400, #424)
  • Refuse to run a lighthouse on an ephemeral port. (#399)
  • Removed the global references. (#423, #426, #446)
  • Reloading via ssh command avoids a panic. (#447)
  • Shutdown is now performed in a cleaner way. (#448)
  • Logs will now find their way to Windows event viewer when running under -service mode in Windows. (#443)

New in Nebula 1.3.0 (Sep 22, 2020)

  • Added:
  • You can emit statistics about non-message packets by setting the option
  • stats.message_metrics. You can similarly emit detailed statistics about
  • lighthouse packets by setting the option stats.lighthouse_metrics. See
  • the example config for more details. (#230)
  • We now support freebsd/amd64. This is experimental, please give us feedback.
  • (#103)
  • We now release a binary for linux/mips-softfloat which has also been
  • stripped to reduce filesize and hopefully have a better chance on running on small mips devices. (#231)
  • You can set tun.disabled to true to run a standalone lighthouse without a
  • tun device (and thus, without root). (#269)
  • You can set logging.disable_timestamp to remove timestamps from log lines,
  • which is useful when output is redirected to a logging system that already
  • adds timestamps. (#288)
  • Changed:
  • Handshakes should now trigger faster, as we try to be proactive with sending
  • them instead of waiting for the next timer tick in most cases. (#246, #265)
  • Previously, we would drop the conntrack table whenever firewall rules were
  • changed during a SIGHUP. Now, we will maintain the table and just validate
  • that an entry still matches with the new rule set. (#233)
  • Debug logs for firewall drops now include the reason. (#220, #239)
  • Logs for handshakes now include the fingerprint of the remote host. (#262)
  • Config item pki.blacklist is now pki.blocklist. (#272)
  • Better support for older Linux kernels. We now only set SO_REUSEPORT if
  • tun.routines is greater than 1 (default is 1). We also only use the
  • recvmmsg syscall if listen.batch is greater than 1 (default is 64).
  • (#275)
  • It is possible to run Nebula as a library inside of another process now.
  • Note that this is still experimental and the internal APIs around this might
  • change in minor version releases. (#279)
  • Deprecated:
  • Pki.blacklist is deprecated in favor of pki.blocklist with the same
  • functionality. Existing configs will continue to load for this release to
  • allow for migrations. (#272)
  • Fixed:
  • Advmss is now set correctly for each route table entry when tun.routes
  • is configured to have some routes with higher MTU. (#245)
  • Packets that arrive on the tun device with an unroutable destination IP are
  • now dropped correctly, instead of wasting time making queries to the
  • lighthouses for IP 0.0.0.0 (#267)

New in Nebula 1.2.0 (Apr 14, 2020)

  • Added:
  • Add logging.timestamp_format config option. The primary purpose of this change is to allow logging timestamps with millisecond precision. (#187)
  • Support unsafe_routes on Windows. (#184)
  • Add lighthouse.remote_allow_list to filter which subnets we will use to handshake with other hosts. See the example config for more details. (#217)
  • Add lighthouse.local_allow_list to filter which local IP addresses and/or interfaces we advertise to the lighthouses. See the example config for more details. (#217)
  • Wireshark dissector plugin. Add this file in dist/wireshark to your
  • Wireshark plugins folder to see Nebula packet headers decoded. (#216)
  • systemd unit for Arch, so it can be built entirely from this repo. (#216)
  • Changed:
  • Added a delay to punching via lighthouse signal to deal with race conditions in some linux conntrack implementations. (#210)
  • See deprecated, this also adds a new punchy.delay option that defaults to 1s.
  • Validate all lighthouse.hosts and static_host_map VPN IPs are in the subnet defined in our cert. Exit with a fatal error if they are not in our subnet, as this is an invalid configuration (we will not have the proper routes set up to communicate with these hosts). (#170)
  • Use absolute paths to system binaries on macOS and Windows. (#191)
  • Add configuration options for handshakes. This includes options to tweak try_interval, retries and wait_rotation. See example config for descriptions. (#179)
  • Allow -config file to not end in .yaml or yml. Useful when using -test and automated tools like Ansible that create temporary files without suffixes. (#189)
  • The config test mode, -test, is now more thorough and catches more parsing issues. (#177)
  • Various documentation and example fixes. (#196)
  • Improved log messages. (#181, #200)
  • Dependencies updated. (#188)
  • Deprecated:
  • punchy, punch_back configuration options have been collapsed under the now top level punchy config directive. (#210)
  • punchy.punch - This is the old punchy option. Should we perform NAT hole punching (default false)?
  • punchy.respond - This is the old punch_back option. Should we respond to hole punching by hole punching back (default false)?
  • Fixed:
  • Reduce memory allocations when not using unsafe_routes. (#198)
  • Ignore packets from self to self. (#192)
  • MTU fixed for unsafe_routes. (#209)