- Go 91.1%
- Shell 5.6%
- Python 1.1%
- Nix 1.1%
- Makefile 0.8%
- Other 0.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .github | ||
| authdaemon | ||
| bind | ||
| browsergateway | ||
| clients | ||
| device | ||
| docker | ||
| examples | ||
| exitnode | ||
| healthcheck | ||
| holepunch | ||
| internal | ||
| logger | ||
| nativessh | ||
| netstack2 | ||
| network | ||
| newt | ||
| packages | ||
| proxy | ||
| public/screenshots | ||
| testing | ||
| updates | ||
| util | ||
| websocket | ||
| wgtester | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| .go-version | ||
| authdaemon.go | ||
| config.go | ||
| config_test.go | ||
| CONTRIBUTING.md | ||
| docker-compose.metrics.collector.yml | ||
| docker-compose.metrics.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| entrypoint.sh | ||
| flake.lock | ||
| flake.nix | ||
| get-newt.sh | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| newt.iss | ||
| README.md | ||
| reexec_unix.go | ||
| reexec_windows.go | ||
| SECURITY.md | ||
| self-signed-certs-for-mtls.sh | ||
| service_unix.go | ||
| service_windows.go | ||
| stub.go | ||
| updown.py | ||
Newt
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.