nebula README

The project's README from github.com/slackhq/nebula. As one markdown file: 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. 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.

Distribution Packages

Mobile (source code)

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 (aka lighthouses) 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)

Don't want to manage your own PKI and lighthouses? Managed Nebula from Defined Networking handles all of this for you.

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 $6/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.

Be aware! By default, certificate authorities have a 1-year lifetime before expiration. See this guide for details on rotating a CA.

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"

By default, host certificates will expire 1 second before the CA expires. Use the -duration flag to specify a shorter lifetime.

5. Configuration files for each host

Download a copy of the nebula example configuration.

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

For more detailed instructions, find the full documentation here.

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 FIPS 140-3 mode

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.

Nebula can be built to support the FIPS 140-3 mode of Go by running either of the following make targets. (This sets GOFIPS140=v1.0.0, which must be done at compile time so that the correct AES-GCM can be used for FIPS 140-3 enforcement mode).

make fips140
make fips140 test
make release-fips140

Nebula can also be built using the BoringCrypto GOEXPERIMENT by running either of the following make targets.

make bin-boringcrypto
make release-boringcrypto

NOTE: boringcrypto support is deprecated and will be removed in the next release. Users should migrate to the native FIPS 140-3 mode described above.

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.

nebula (slackhq/nebula)

Searching Database…

18.4K ·GitHub
Nebula
What is this?Nebula is an overlay networking tool that lets you connect computers anywhere in the world into a secure mesh network, scaling from a handful of machines to tens of thousands.
Is this a VPN client or something more like a mesh network stack?It is a mutually authenticated peer-to-peer software-defined network built on the Noise Protocol Framework, combining certificate-based identity, security-group-style firewall rules, and NAT-traversing tunnels rather than a traditional hub VPN.
How do I get a Nebula network running?Grab the nebula binary and nebula-cert tool for your platform, create a certificate authority with nebula-cert ca, generate host keys/certs for each node, write a config.yml per host, then copy the binary, config, ca.crt and host cert/key to each machine and run nebula.
Do I need a special server to make this work?You should run at least one 'lighthouse' node with a routable public IP so other nodes can discover each other and punch through NATs; a cheap $6/mo VPS is enough for this role.
What's the biggest thing I can mess up when setting this up?The ca.key file signs every node certificate and must never be copied to individual nodes, and by default certificate authorities expire after one year, so you need a rotation plan.
Which platforms does Nebula actually run on?Nebula runs on Linux, macOS, Windows, FreeBSD, iOS, and Android, with prebuilt packages for Arch, Fedora, Debian, Alpine, Homebrew, and Docker.
What encryption does Nebula actually use?By default Nebula uses Elliptic-curve Diffie-Hellman (Curve25519) key exchange with AES-256-GCM for data; it can optionally be switched to NIST Curve P256 for FIPS 140-3 compliance needs.
Can I skip managing my own certificate authority and lighthouses?Yes, the hosted service Managed Nebula from Defined Networking handles PKI and lighthouse operation for you if you don't want to run your own.
What are similar projects?EasyTier, netbird, tailscale, MeshLAN, p2wlan, syncthing, bitchat, gun
Which topics is it in?nat-traversal, mesh-network, certificate, firewall, decentralized, p2p, vpn, homebrew, authentication, encryption, bsd, ios
Creator
slackhq
Size
6.1 MB
Stars
18.4K
Updated
CommitOct 16Releasev1.11.2Sep 22
Age
6y
Commits · 90 Days