You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
emanuele-f 9cc2aee7fc Fix config load from file in Windows 5 years ago
android Updated instructions, dependencies and configurations for gradle 4.4. 5 years ago
doc added more detailed routing information 5 years ago
legacy Code rework changes 6 years ago
packages Update openwrt instructions with the toolchain setup 5 years ago
win32 Windows compilation fixes 5 years ago
.gitignore Update gitignore 5 years ago
CHANGELOG.md Added changelog file 6 years ago
CMakeLists.txt Unify n2n version 5 years ago
COPYING Initial SVN import of n2n v2 8 years ago
INSTALL Initial SVN import of n2n v2 8 years ago
LICENSE Initial commit 8 years ago
Makefile.in Package fixes 5 years ago
README.md Add link to Routing.md 5 years ago
autogen.sh Do not run configure in autogen.sh 5 years ago
benchmark.c Code rework changes 6 years ago
community.list Added the ability to specify (-c) on the supernode the list of allowed communities 6 years ago
config.guess Added configure and autogen.sh 6 years ago
configure.seed Package fixes 5 years ago
contributors.txt Refreshed copyright and added contributors list 7 years ago
edge.8 Add the -i option to specify registration interval on edge nodes 6 years ago
edge.c Fix config load from file in Windows 5 years ago
edge_utils.c Windows compilation fix 5 years ago
example_edge_embed.c n2n.h cleanup 6 years ago
lzoconf.h Initial SVN import of n2n v2 8 years ago
lzodefs.h Initial SVN import of n2n v2 8 years ago
minilzo.c Initial SVN import of n2n v2 8 years ago
minilzo.h Initial SVN import of n2n v2 8 years ago
n2n.7 Reworked debian/ubuntu packaging 6 years ago
n2n.c Unify n2n version 5 years ago
n2n.h Fix adapter name length in windows 5 years ago
n2n_transforms.h OpenWRT build files and instructions 5 years ago
n2n_wire.h Implement query peer to try p2p during send 6 years ago
sn.c Supernode graceful termination in Windows 5 years ago
supernode.1 Initial SVN import of n2n v2 8 years ago
transform_aes.c Update openwrt readme 5 years ago
transform_null.c Code rework changes 6 years ago
transform_tf.c Code rework changes 6 years ago
tuntap_freebsd.c Fix a few leftover instances which used the old function name 6 years ago
tuntap_linux.c Fix compilation warnings and little leak 6 years ago
tuntap_netbsd.c Refreshed copyright and added contributors list 7 years ago
tuntap_osx.c Added note to fix /dev/tap problems 6 years ago
twofish.c Properly initialize AES IV and hash the AES key 6 years ago
twofish.h Properly initialize AES IV and hash the AES key 6 years ago
uthash.h Update uthash to version 2.1.0 6 years ago
wire.c Implement query peer to try p2p during send 6 years ago

README.md

N2N

N2n is a light VPN software which make it easy to create virtual networks bypassing intermediate firewalls.

In order to start using N2N, two elements are required:

  • A supernode: it allows edge nodes to announce and discover other nodes. It must have a port publicly accessible on internet.

  • Edge nodes: the nodes which will be part of the virtual networks

A virtual network shared between multiple edge nodes in n2n is called a community. A single supernode can relay multiple communities and a single PC can be part of multiple communities at the same time. An encryption key can be used by the edge nodes to encrypt the packets within their community.

N2n tries to enstablish a direct P2P connection between the edge nodes when possible. When this is not possible (usually due to special NAT devices), the supernode is also used to relay the packets.

Quick Setup

Some linux distributions already provide n2n as a package so a simple sudo apt-get install n2n will do the work. Alternatively, up to date packages for most distributions are available on ntop repositories.

On host1 run:

$ sudo edge -c mynetwork -k mysecretpass -a 192.168.100.1 -f -l supernode.ntop.org:7777

On host2 run:

$ sudo edge -c mynetwork -k mysecretpass -a 192.168.100.2 -f -l supernode.ntop.org:7777

Now the two hosts can ping each other.

IMPORTANT It is strongly adviced to choose a custom community name (-c) and a secret encryption key (-k) in order to prevent other users to connect to your PC. For privacy and to reduce the above server load, it is also suggested to set up a custom supernode as exmplained below.

Setting up a custom Supernode

You can create your own infrastructure by setting up a supernode on a public server (e.g. a VPS). You just need to open a single port (1234 in the example below) on your firewall (usually iptables).

  1. Install the n2n package
  2. Edit /etc/n2n/supernode.conf and add the following:
-l=1234
  1. Start the supernode service with sudo systemctl start supernode
  2. Optionally enable supernode start on boot: sudo systemctl enable supernode

Now the supernode service should be up and running on port 1234. On your edge nodes you can now specify -l your_supernode_ip:1234 to use it. All the edge nodes must use the same supernode.

Routing the traffic

On linux, n2n provides a standard TAP interface, so routing works gracefully via the standard system utilities as follows.

In this example host1 is the edge router (with n2n IP 192.168.100.1), whereas host2 is the client.

Here is how to configure host1:

  1. Add the -r option to the edge options to enable routing
  2. Enable packet forwarding with sudo sysctl -w net.ipv4.ip_forward=1
  3. Possibly configure iptables to ACCEPT the packets on the FORWARD chain.

On host2, run the edge program as normal to join the host1 community.

In order to forward all the internet traffic via host2:

# Determine the current gateway (e.g. 192.168.1.1)
$ ip route show default

# Add a route to reach the supernode via such gateway
$ sudo ip route add supernode.ntop.org via 192.168.1.1

# Forward all the internet traffic via host1
$ sudo ip route del default
$ sudo ip route add default via 192.168.100.1

This process can be greatly simplified by using the n2n_gateway.sh script.

See Routing.md for other use cases and in depth explanation.

Manual Compilation

On linux, compilation from source is straight forward:

./autogen.sh
./configure
make

# optionally install
make install

For Windows, check out Windows.md for compilation and run instuctions.

For MacOS, check out n2n_on_MacOS.txt.

Running edge as a service

edge can also be run as a service instead of cli:

  1. Edit /etc/n2n/edge with your custom options. See /etc/n2n/edge.conf.sample.
  2. Start the service: sudo systemctl start edge
  3. Optionally enable edge start on boot: sudo systemctl enable edge

You can run multiple edge service instances by creating /etc/n2n/edge-instance1 and starting it with sudo systemctl start edge@instance1.

IPv6 Support

N2n can tunnel IPv6 traffic into the virtual network but does not support IPv6 for edge-to-supernode communication yet.

Check out IPv6.md for more information.

Security considerations

n2n edge nodes use twofish encryption by default for compatibility reasons with existing versions.

IMPORTANT Encryption is only applied to the packet payload. Some metadata like the virtual MAC address of the edge nodes, their IP address and the community are sent in cleartext.

When encryption is enabled, the supernode will not be able to decrypt the traffic exchanged between two edge nodes, but it will now that edge A is talking with edge B.

Recently AES encryption support has been implemented, which increases both security and performance, so it is recommended to enable it on all the edge nodes by specifying the -A option.

A benchmark of the encryption methods is available when compiled from source with ./benchmark.

Contribution

You can contribute to n2n in variuos ways:

  • Update an open issue or create a new one with detailed information
  • Propose new features
  • Improve the documentation
  • Provide pull requests with enhancenents

For details about the internals of n2n check out Hacking guide.

Here is a list of third-party projects connected to this repository.


(C) 2007-2019 - ntop.org and contributors