newt

command module
v1.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2026 License: AGPL-3.0 Imports: 19 Imported by: 0

README

Newt

PkgGoDev GitHub License Go Report Card

[!NOTE] Newt is being phased out in favor of the Pangolin CLI. Use pangolin site up

Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.

Installation and Documentation

Newt is used with Pangolin and Gerbil as part of the larger system. See documentation below:

Key Functions

Registers with Pangolin

Using the Newt ID and a secret, the client will make HTTP requests to Pangolin to receive a session token. Using that token, it will connect to a websocket and maintain that connection. Control messages will be sent over the websocket.

Receives WireGuard Control Messages

When Newt receives WireGuard control messages, it will use the information encoded (endpoint, public key) to bring up a WireGuard tunnel using netstack fully in user space. It will ping over the tunnel to ensure the peer on the Gerbil side is brought up.

Receives Proxy Control Messages

When Newt receives WireGuard control messages, it will use the information encoded to create a local low level TCP and UDP proxies attached to the virtual tunnel in order to relay traffic to programmed targets.

Build

Binary

Make sure to have Go 1.25 installed.

make
Nix Flake
nix build

Binary will be at ./result/bin/newt

Development shell available with nix develop

Licensing

Newt is dual licensed under the AGPLv3 and the Fossorial Commercial license. For inquiries about commercial licensing, please contact us.

Contributions

Please see CONTRIBUTIONS in the repository for guidelines and best practices.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Example usage patterns for the extensible logger
Example usage patterns for the extensible logger
Package exitnode implements the exit-node ping dance run before registering with the server: request the candidate exit nodes, ping each one over HTTP, and report the results so the server can pick the best one.
Package exitnode implements the exit-node ping dance run before registering with the server: request the candidate exit nodes, ping each one over HTTP, and report the results so the server can pick the best one.
internal
Package newtconfig resolves Newt's runtime configuration (CLI flags, env vars, and config file) into a newt.Config.
Package newtconfig resolves Newt's runtime configuration (CLI flags, env vars, and config file) into a newt.Config.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL