boringtunjs

BoringTunJS

A userspace WireGuard VPN implementation for NodeJS based on BoringTun which is written in Rust.

Project Status: Early Development Phase

This project is at the beginning of its journey. As such, it is currently in its initial development phase, where features are being developed and the architecture is being established.

Bindings for the BoringTun library are ready, but it does not include a network stack. The original library doesn't include it. It will be written on Nodejs.

Installation

npm install boringtunjs

In progress

• The network stack (TCP/UDP) has errors and is in active development. Sockets are not closing properly.
• Statistics by peer

Supported platforms

• MacOS M-chip
• MacOS Intel-chip
• Ubuntu 20.04 x64
• Windows x64

Usage

Please note that this project is still in the development phase, and the API may change.

const { Wireguard } = require('boringtunjs')

new Wireguard({
  privateKey: '3RLqvLwIYch6efW7iK7lywzFnZQfSzblDTvRwJ7CAbA=',
  // publicKey: 'PhDFug7ZouGnrWuVFW9ez41OwEhgLNmyi9/CEnHRlFg=',
  listenPort: 51820,
  address: '10.8.0.1',
}).addPeer({
    // privateKey: '/2iZCtOrderkA2hkuUy4E1q7Py9qIGiFytTd/ivXZ4E=',
    publicKey: '3g5U/6myr9DZf/HkNuwSKR+h1lcOJQbnAQfjrZ4q5xg=',
    keepAlive: 25,
    allowedIPs: '10.8.0.2/32',
  })
  .listen()

Acknowledgments

This project makes use of "BoringTun", a userspace WireGuard VPN implementation, developed and maintained by Cloudflare, Inc. We extend our gratitude to Cloudflare, Inc. and the contributors to the BoringTun project for their work. BoringTun is distributed under the BSD 3-Clause License, and we adhere to its licensing conditions in the use of this library within our project.

Building

You need Rust installed on your machine. The build process is divided into two steps: building the static library in Rust and creating the Node.js bindings in C++.

git clone --recursive [e-mail]:boringjs/boringtun.js.git 
cd boringtun.js
npm install
npm run build:boringtun
npm run build

License

The project is licensed under the 3-Clause BSD License.