A scalable overlay networking tool with a focus on performance, simplicity and security (written by Slack)
#vpn #p2p #mesh #remote-access #networking #golang #go

Nathan Brown 0c2e5973e1 Simple lie test (#427) 4 lat temu
.github 0c2e5973e1 Simple lie test (#427) 4 lat temu
cert 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
cmd 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
dist 9e94442ce7 Add fedora dist files. (#413) 4 lat temu
e2e 0c2e5973e1 Simple lie test (#427) 4 lat temu
examples 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
sshd aba42f9fa6 enforce the use of goimports (#248) 5 lat temu
util 68e3e84fdc More like a library (#279) 4 lat temu
.gitignore c4c334fedb Support for 1.0.0 release 5 lat temu
AUTHORS f22b4b584d Public Release 5 lat temu
CHANGELOG.md 0d6b55e495 Bring in the new version of kardianos/service and output logfiles on osx (#303) 4 lat temu
LICENSE f22b4b584d Public Release 5 lat temu
Makefile 0c2e5973e1 Simple lie test (#427) 4 lat temu
README.md f6d0b4b893 Update README for supported platforms (#312) 4 lat temu
allow_list.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
allow_list_test.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
bits.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
bits_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
cert.go 883e09a392 Don't use a global ca pool (#426) 4 lat temu
cidr6_radix.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
cidr6_radix_test.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
cidr_radix.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
cidr_radix_test.go c1182869c4 Add a way to find the most specific network 5 lat temu
config.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
config_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
connection_manager.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
connection_manager_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
connection_state.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
control.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
control_test.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
control_tester.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
dns_server.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
dns_server_test.go f22b4b584d Public Release 5 lat temu
firewall.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
firewall_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
go.mod 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
go.sum 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
handshake.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
handshake_ix.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
handshake_manager.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
handshake_manager_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
header.go f22b4b584d Public Release 5 lat temu
header_test.go aba42f9fa6 enforce the use of goimports (#248) 5 lat temu
hostmap.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
hostmap_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
inside.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
interface.go 883e09a392 Don't use a global ca pool (#426) 4 lat temu
lighthouse.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
lighthouse_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
logger.go 68e3e84fdc More like a library (#279) 4 lat temu
logger_test.go aba42f9fa6 enforce the use of goimports (#248) 5 lat temu
main.go 883e09a392 Don't use a global ca pool (#426) 4 lat temu
main_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
message_metrics.go b37a91cfbc add meta packet statistics (#230) 5 lat temu
metadata.go f22b4b584d Public Release 5 lat temu
nebula.pb.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
nebula.proto 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
noise.go 9e2ff7df57 Correct typos in noise.go (#205) 5 lat temu
outside.go 883e09a392 Don't use a global ca pool (#426) 4 lat temu
outside_test.go aba42f9fa6 enforce the use of goimports (#248) 5 lat temu
punchy.go 1297090af3 add configurable punching delay because of race-condition-y conntracks (#210) 5 lat temu
punchy_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
ssh.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
stats.go a71541fb0b export build version as a prometheus label (#405) 4 lat temu
timeout.go f22b4b584d Public Release 5 lat temu
timeout_system.go f22b4b584d Public Release 5 lat temu
timeout_system_test.go f22b4b584d Public Release 5 lat temu
timeout_test.go aba42f9fa6 enforce the use of goimports (#248) 5 lat temu
tun_android.go 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
tun_common.go ff64d1f952 unsafe_routes mtu (#209) 5 lat temu
tun_darwin.go 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
tun_disabled.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
tun_freebsd.go 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
tun_ios.go 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
tun_linux.go 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
tun_linux_test.go 830d6d4639 Start of end to end testing with a good handshake between two nodes (#425) 4 lat temu
tun_test.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
tun_tester.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
tun_windows.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
udp_all.go 7073d204a8 IPv6 support for outside (udp) (#369) 4 lat temu
udp_android.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_darwin.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_freebsd.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_generic.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_linux.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_linux_32.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_linux_64.go 3ea7e1b75f Don't use a global logger (#423) 4 lat temu
udp_tester.go 0c2e5973e1 Simple lie test (#427) 4 lat temu
udp_windows.go 0c2e5973e1 Simple lie test (#427) 4 lat temu

README.md

What is Nebula?

Nebula is a scalable overlay networking tool with a focus on performance, simplicity and security. It lets you seamlessly connect computers anywhere in the world. Nebula is portable, and runs on Linux, OSX, Windows, iOS, and Android. It can be used to connect a small number of computers, but is also able to connect tens of thousands of computers.

Nebula incorporates a number of existing concepts like encryption, security groups, certificates, and tunneling, and each of those individual pieces existed before Nebula in various forms. What makes Nebula different to existing offerings is that it brings all of these ideas together, resulting in a sum that is greater than its individual parts.

You can read more about Nebula here.

You can also join the NebulaOSS Slack group here

Supported Platforms

Desktop and Server

Check the releases page for downloads

  • Linux - 64 and 32 bit, arm, and others
  • Windows
  • MacOS
  • Freebsd

Mobile

Technical Overview

Nebula is a mutually authenticated peer-to-peer software defined network based on the Noise Protocol Framework. Nebula uses certificates to assert a node's IP address, name, and membership within user-defined groups. Nebula's user-defined groups allow for provider agnostic traffic filtering between nodes. Discovery nodes allow individual peers to find each other and optionally use UDP hole punching to establish connections from behind most firewalls or NATs. Users can move data between nodes in any number of cloud service providers, datacenters, and endpoints, without needing to maintain a particular addressing scheme.

Nebula uses elliptic curve Diffie-Hellman key exchange, and AES-256-GCM in its default configuration.

Nebula was created to provide a mechanism for groups hosts to communicate securely, even across the internet, while enabling expressive firewall definitions similar in style to cloud security groups.

Getting started (quickly)

To set up a Nebula network, you'll need:

1. The Nebula binaries for your specific platform. Specifically you'll need nebula-cert and the specific nebula binary for each platform you use.

2. (Optional, but you really should..) At least one discovery node with a routable IP address, which we call a lighthouse.

Nebula lighthouses allow nodes to find each other, anywhere in the world. A lighthouse is the only node in a Nebula network whose IP should not change. Running a lighthouse requires very few compute resources, and you can easily use the least expensive option from a cloud hosting provider. If you're not sure which provider to use, a number of us have used $5/mo DigitalOcean droplets as lighthouses.

Once you have launched an instance, ensure that Nebula udp traffic (default port udp/4242) can reach it over the internet.

3. A Nebula certificate authority, which will be the root of trust for a particular Nebula network.

  ./nebula-cert ca -name "Myorganization, Inc"

This will create files named ca.key and ca.cert in the current directory. The ca.key file is the most sensitive file you'll create, because it is the key used to sign the certificates for individual nebula nodes/hosts. Please store this file somewhere safe, preferably with strong encryption.

4. Nebula host keys and certificates generated from that certificate authority

This assumes you have four nodes, named lighthouse1, laptop, server1, host3. You can name the nodes any way you'd like, including FQDN. You'll also need to choose IP addresses and the associated subnet. In this example, we are creating a nebula network that will use 192.168.100.x/24 as its network range. This example also demonstrates nebula groups, which can later be used to define traffic rules in a nebula network.

./nebula-cert sign -name "lighthouse1" -ip "192.168.100.1/24"
./nebula-cert sign -name "laptop" -ip "192.168.100.2/24" -groups "laptop,home,ssh"
./nebula-cert sign -name "server1" -ip "192.168.100.9/24" -groups "servers"
./nebula-cert sign -name "host3" -ip "192.168.100.10/24"

5. Configuration files for each host

Download a copy of the nebula example configuration.

  • On the lighthouse node, you'll need to ensure am_lighthouse: true is set.

  • On the individual hosts, ensure the lighthouse is defined properly in the static_host_map section, and is added to the lighthouse hosts section.

6. Copy nebula credentials, configuration, and binaries to each host

For each host, copy the nebula binary to the host, along with config.yaml from step 5, and the files ca.crt, {host}.crt, and {host}.key from step 4.

DO NOT COPY ca.key TO INDIVIDUAL NODES.

7. Run nebula on each host

./nebula -config /path/to/config.yaml

Building Nebula from source

Download go and clone this repo. Change to the nebula directory.

To build nebula for all platforms: make all

To build nebula for a specific platform (ex, Windows): make bin-windows

See the Makefile for more details on build targets

Credits

Nebula was created at Slack Technologies, Inc by Nate Brown and Ryan Huber, with contributions from Oliver Fross, Alan Lam, Wade Simmons, and Lining Wang.