awl

README

About

Anywherelan (awl for brevity) is a mesh VPN project, similar to tinc, direct wireguard or tailscale. Awl makes it easy to connect to any of your devices (at the IP protocol level) wherever they are.

Some use cases:

• connect to your home/work laptop with RDP/VNC/SSH, which is usually behind NAT. Much easier with awl instead of configuring port forwarding or using heavy VPNs
• get secure access to your selfhosted services like Nextcloud, Home Assistant or Bitwarden without exposing them to the internet
• gaming: local multiplayer like in one LAN
• as an alternative instead of ngrok to share your development server with someone on another device for demonstration
• you can use your old android device remotely with scrcpy + awl to run some android-only apps instead of using an emulator on your PC

Features

• unlike many alternatives, it works fully peer-to-peer, no need to set up or trust any third-party coordination servers. Your traffic goes directly to other devices
• easy to use: just download the app, scan QR code of your device, and you're set up
• built-in support for NAT traversal
• if both devices don't have public IP addresses (thus peer-to-peer is unavailable), awl will send your encrypted data through community relays (donates for infrastructure are welcome!)
• TLS encryption
• DNS server built-in. It allows using domains for your devices, like work-laptop.awl instead of IP address
• works on Windows, Linux, macOS, Android

📷 Screenshots

How it works

Awl mainly relies on two libraries: tun/wintun driver for virtual network interface (networking layer 3, IP) and libp2p as peer-to-peer networking stack.

As a transport awl uses QUIC or TCP with TLS on top. Awl uses DHT for connecting between peers.

At first, awl connects to community bootstrap nodes, register itself (send peer id (with public key) and public ip addresses) and later asks for addresses of peers you want to connect (all known peers). If peer does not have public addresses, peer could be reached out through bootstrap nodes.

Installation

For desktop there are two versions: awl and awl-tray. awl is mainly used for servers and other headless purposes and awl-tray is for desktop usage: it has nice system tray service (app indicator) to quickly get status of the vpn server, start/stop/restart it or to see which peers are online. Both versions have web-based ui for configuration and monitoring, and terminal interface cli.

First, download archive from releases page for your OS and processor architecture, extract it to any place you like.

Android

Simply install apk from releases page and launch the application.

Windows desktop (awl-tray)

After downloading you need to unpack zip archive and to run program as administrator (right click on binary ➞ run as administrator). This is necessary because only admins can create virtual network interfaces.

It's known problem that some antivirus software may get false detection, in this case you need to manually allow this application.

After starting the program you will see icon in system tray below. Press right click and choose Open Web UI. Or you can manually go to the http://admin.awl

macOS

After downloading you need to unpack zip archive, right-click the awl-tray binary and select Open. You'll be warned that the app is from unidentified developer (because app isn't signed, it costs money), click "Open" to run it. It will also ask for admin rights. This is necessary because only admins can create virtual network interfaces.

After starting the program you will see icon in the system tray. Press right click and choose Open Web UI. Or you can manually go to the http://admin.awl

Linux

Desktop (awl-tray)

Make sure zenity is installed. It's not mandatory, but highly recommended in order to have working notifications and modal dialogs.

sudo apt install -y zenity

After downloading just execute binary as any other app. It will ask root permissions in order to get access to /dev/tun and to create virtual network interface. It will automatically create desktop entry, so next time you can run awl from applications list.

After starting the program you will see icon in system tray below. Press right click and choose Open Web UI. Or you can manually go to the http://admin.awl

Server (awl)

To automatically install awl use the script below. It will install latest awl version as systemd service awl.service, binary and config files will be in /etc/anywherelan/. Also, awl will be started on every system reboot.

curl -sL https://raw.githubusercontent.com/anywherelan/awl/master/install.sh | sudo bash

Awl is up and running!

# print server status
awl cli me status
# set a name for your device
awl cli me rename --name your-name-here
# print your peer id
awl cli me id
# print help
awl cli -h
# print systemd service status
systemctl status awl.service

See cli for more information on terminal client.

Connecting peers

To connect two devices with each other, you need to have their peer_ids. peer_id is a unique identifier of your device. One peer can send "friend invitation" to another. The second peer can accept or block the first one. After accepting the invitation, peers can access each other by their IP on vpn network or by their .awl domain address.

Below you can see example on how you can connect to public peer for testing purposes. This peer will automatically accept any invitations, so you don't need to wait for it.

Desktop/Android

Go to web interface (http://admin.awl) or run application in case of android. You can find your peer_id by clicking SHOW ID. To invite peer you need to press NEW PEER. Let's add public peer as an example. Enter peer_id equal to 12D3KooWJMUjt9b5T1umzgzjLv5yG2ViuuF4qjmN65tsRXZGS1p8 and name it awl-tester. After a few seconds you will see a new peer in your list. Now try to go to the http://awl-tester.awl/. You should see a page with network speed test.

Note that awl dns is currently unsupported on Android, see #17.

If someone invites you, a notification will appear, and then you can accept/block this peer in the admin interface.

Server

# print your peer_id
awl cli me id
# print server status
awl cli me status
# print all incoming friend requests
awl cli peers requests
# invite peer or accept incoming request
awl cli peers add --pid 12D3KooWJMUjt9b5T1umzgzjLv5yG2ViuuF4qjmN65tsRXZGS1p8 --name awl-tester
# print all known peers
awl cli peers status

# try to access new peer
ping 10.66.0.2
# or by domain name
ping awl-tester.awl

Config file location

Awl looks for config file config_awl.json in paths in this order:

• in directory provided by environment variable AWL_DATA_DIR, if set. If path does not exist or there is no config file, awl will initialize new config in this path
• in the same directory as executable (if config file exists here)
• in OS-specific config directory. For example, on Linux it's $HOME/.config/anywherelan/, on Windows it's %AppData%/anywherelan/ and on macOS it's $HOME/Library/Application Support/anywherelan/. If there is no config here, awl will initialize new config in this path

Tip: you can force using config file in the same directory with executable by creating config_awl.json with content {} before first launch.

It is not recommended to amend config file while application is still running.

Terminal based client

Both awl and awl-tray versions have CLI to communicate with vpn server.

TODO: examples

$ ./awl cli -h     
NAME:
   awl cli - p2p mesh vpn

USAGE:
   awl cli [global options] command [command options] [arguments...]

VERSION:
   v0.8.1

DESCRIPTION:
   Anywherelan (awl for brevity) is a mesh VPN project, similar to tinc, direct wireguard or tailscale. Awl makes it easy to connect to any of your devices (at the IP protocol level) wherever they are.
   See more at the project page https://github.com/anywherelan/awl

COMMANDS:
   me         Group of commands to work with your status and settings
   peers      Group of commands to work with peers. Use to check friend requests and work with known peers
   logs, log  Prints application logs (default print 10 logs from the end of logs)
   p2p_info   Prints p2p debug info
   update     Updates awl to the latest version
   help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --api_addr value  awl api address, example: 127.0.0.1:8639
   --help, -h        show help
   --version, -v     print the version

Upgrading

Desktop

On desktop (awl-tray) you can upgrade application by clicking system tray icon ➞ Check for updates. It will ask for confirmation and replace the binary with the new version and restart the app.

Android

Awl is not yet published in any store, so the only option is to download new version .apk from the releases page and install it manually.

Server

You can easily upgrade and restart awl on remote host while being connected to it by awl (through ssh for example) and your connection won't be terminated.

# run under root
cd /etc/anywherelan
# no need to stop awl beforehand
./awl cli update
# restart with systemd in case you installed awl as described in Installation section
systemctl restart awl
# print current status
./awl cli me status

As alternative, on Desktop/Server you can download new version from releases page and manually replace old files with new ones.

Roadmap

• performance improvements for vpn tunnel protocol
• exit nodes - let you route all internet traffic through other peers
• add support for awl dns for android (#17)

Contributing

Contributions to this repository are very welcome.

You can help by creating:

• Bug reports - unexpected behavior, crashes
• Feature proposals - proposal to change/add/delete some features
• Documentation - improves to this README.md are appreciated
• Pull Requests - implementing a new feature yourself or fixing bugs. If the change is big, then it's a good idea to open a new issue first to discuss changes.

License

The project is licensed under the MPLv2.

Documentation

Index

• func FrontendStatic() fs.FS
• type Application
  • func New() *Application
  • func (a *Application) Close()
  • func (a *Application) Ctx() context.Context
  • func (a *Application) Init(ctx context.Context, tunDevice tun.Device) error
  • func (a *Application) SetupLoggerAndConfig() *log.ZapEventLogger
• type DNSService
  • func NewDNSService(conf *config.Config, eventbus awlevent.Bus, ctx context.Context, ...) *DNSService
  • func (a *DNSService) AwlDNSAddress() string
  • func (a *DNSService) Close()
  • func (a *DNSService) IsAwlDNSSetAsSystem() bool

Functions

func FrontendStatic

func FrontendStatic() fs.FS

Types

type Application

type Application struct {
	LogBuffer *ringbuffer.RingBuffer

	Conf     *config.Config
	Eventbus awlevent.Bus

	P2p        *p2p.P2p
	Api        *api.Handler
	AuthStatus *service.AuthStatus
	Tunnel     *service.Tunnel
	Dns        *DNSService
	// contains filtered or unexported fields
}

func New

func New() *Application

func (*Application) Close

func (a *Application) Close()

func (*Application) Ctx

func (a *Application) Ctx() context.Context

func (*Application) Init

func (a *Application) Init(ctx context.Context, tunDevice tun.Device) error

func (*Application) SetupLoggerAndConfig

func (a *Application) SetupLoggerAndConfig() *log.ZapEventLogger

type DNSService

type DNSService struct {
	// contains filtered or unexported fields
}

func NewDNSService

func NewDNSService(conf *config.Config, eventbus awlevent.Bus, ctx context.Context, logger *log.ZapEventLogger) *DNSService

func (*DNSService) AwlDNSAddress

func (a *DNSService) AwlDNSAddress() string

func (*DNSService) Close

func (a *DNSService) Close()

func (*DNSService) IsAwlDNSSetAsSystem

func (a *DNSService) IsAwlDNSSetAsSystem() bool