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

Caleb Jasik 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
.github 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
cert 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
cert_test d97ed57a19 V2 certificate format (#1216) преди 4 месеца
cmd 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
config 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
dist 8b55caa15e Remove Arch nebula.service file (#1132) преди 1 година
docker b5c3486796 Push Docker images as part of the release workflow (#1037) преди 1 година
e2e 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
examples d97ed57a19 V2 certificate format (#1216) преди 4 месеца
firewall d97ed57a19 V2 certificate format (#1216) преди 4 месеца
header 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
iputil d97ed57a19 V2 certificate format (#1216) преди 4 месеца
noiseutil 35603d1c39 add PKCS11 support (#1153) преди 10 месеца
overlay 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
pkclient 35603d1c39 add PKCS11 support (#1153) преди 10 месеца
service d97ed57a19 V2 certificate format (#1216) преди 4 месеца
sshd d97ed57a19 V2 certificate format (#1216) преди 4 месеца
test d97ed57a19 V2 certificate format (#1216) преди 4 месеца
udp d97ed57a19 V2 certificate format (#1216) преди 4 месеца
util e3f5a129c1 Return full error context from ContextualError.Error() (#1069) преди 1 година
wintun 9af242dc47 switch to new sync/atomic helpers in go1.19 (#728) преди 2 години
.gitignore d97ed57a19 V2 certificate format (#1216) преди 4 месеца
.golangci.yaml 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
AUTHORS f22b4b584d Public Release преди 5 години
CHANGELOG.md ab81b62ea0 v1.9.4 (#1210) преди 10 месеца
LICENSE f22b4b584d Public Release преди 5 години
LOGGING.md a99618e95c Don't log invalid certificates (#1116) преди 1 година
Makefile 32d3a6e091 build with go1.23 (#1198) преди 4 месеца
README.md 2b427a7e89 Update slack invitation link (#1308) преди 6 месеца
SECURITY.md 115b4b70b1 add SECURITY.md (#864) преди 2 години
allow_list.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
allow_list_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
bits.go 3ea7e1b75f Don't use a global logger (#423) преди 4 години
bits_test.go 4453964e34 Move util to test, contextual errors to util (#575) преди 3 години
boring.go 0b67b19771 add boringcrypto Makefile targets (#856) преди 2 години
calculated_remote.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
calculated_remote_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
connection_manager.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
connection_manager_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
connection_state.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
control.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
control_test.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
control_tester.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
dns_server.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
dns_server_test.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
firewall.go 8a090e59d7 Bump github.com/gaissmai/bart from 0.13.0 to 0.18.1 (#1341) преди 4 месеца
firewall_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
go.mod 096179a8c9 Bump github.com/miekg/dns from 1.1.62 to 1.1.63 (#1346) преди 4 месеца
go.sum 096179a8c9 Bump github.com/miekg/dns from 1.1.62 to 1.1.63 (#1346) преди 4 месеца
handshake_ix.go f8734ffa43 Improve logging when handshaking with an invalid cert (#1345) преди 4 месеца
handshake_manager.go f8734ffa43 Improve logging when handshaking with an invalid cert (#1345) преди 4 месеца
handshake_manager_test.go 612637f529 Fix `testifylint` lint errors (#1321) преди 4 месеца
hostmap.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
hostmap_test.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
hostmap_tester.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
inside.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
inside_bsd.go 5bd8712946 Immediately forward packets from self to self on FreeBSD (#808) преди 2 години
inside_generic.go 5bd8712946 Immediately forward packets from self to self on FreeBSD (#808) преди 2 години
interface.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
lighthouse.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
lighthouse_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
logger.go 4453964e34 Move util to test, contextual errors to util (#575) преди 3 години
main.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
message_metrics.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
nebula.pb.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
nebula.proto d97ed57a19 V2 certificate format (#1216) преди 4 месеца
noise.go 8109cf2170 Add puncuation to doc comment (#1164) преди 1 година
notboring.go 0b67b19771 add boringcrypto Makefile targets (#856) преди 2 години
outside.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
outside_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
pki.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
punchy.go 03e4a7f988 Rehandshaking (#838) преди 2 години
punchy_test.go 088af8edb2 Enable running testifylint in CI (#1350) преди 4 месеца
relay_manager.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
remote_list.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
remote_list_test.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
ssh.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца
stats.go 0b67b19771 add boringcrypto Makefile targets (#856) преди 2 години
timeout.go 5278b6f926 Generic timerwheel (#804) преди 2 години
timeout_test.go d97ed57a19 V2 certificate format (#1216) преди 4 месеца

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.

Further documentation can be found here.

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 or see the Distribution Packages section.

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

Distribution Packages

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 (ECDH) key exchange and AES-256-GCM in its default configuration.

Nebula was created to provide a mechanism for groups of 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 or Distribution Packages 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.yml 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.yml

Building Nebula from source

Make sure you have go installed 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

Curve P256 and BoringCrypto

The default curve used for cryptographic handshakes and signatures is Curve25519. This is the recommended setting for most users. If your deployment has certain compliance requirements, you have the option of creating your CA using nebula-cert ca -curve P256 to use NIST Curve P256. The CA will then sign certificates using ECDSA P256, and any hosts using these certificates will use P256 for ECDH handshakes.

In addition, Nebula can be built using the BoringCrypto GOEXPERIMENT by running either of the following make targets:

make bin-boringcrypto
make release-boringcrypto

This is not the recommended default deployment, but may be useful based on your compliance requirements.

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.