Tag: Client

The Wireleap client includes support for TUN in both GNU/Linux and macOS, allowing for a “VPN like” experience of tunneling all traffic (both TCP and UDP) on the system through a multiplexed circuit.

However, at the very least, traffic destined for the first relay in the circuit needs to be excluded from the TUN device routing configuration, otherwise this would result in a blackhole. So, what is needed is for the controller to communicate a list of addresses for exclusion to the TUN daemon, as well as a way to update the list if and when the circuit is changed.

Wireleap v0.6.0 is a major update to the client, with a brand new controller including a REST API, splitting out the SOCKSv5 forwarder, and other internal changes and improvements. As such, there are a number of changes users should be aware of.

Please note, this is a backwards incompatible release.

It’s been possible to run the Wireleap client on the WSL (Windows Subsystem for Linux), although there are occasional issues which are very hard to reproduce and therefore fix. Additionally, having WSL as a requirement isn’t optimal, and limits future planned features.

The latest client release (0.5.2) now includes a native build for Windows, so no need for WSL. This release includes support for the SOCKSv5 interface (TUN is not yet supported), ported exec scripts for Windows, as well as a powershell convenience installation script.

The Wireleap client on MacOS reaches feature parity (except for intercept) of the Linux client with TUN device support, allowing for a “VPN like” experience of tunneling all traffic (both TCP and UDP) on the system through a multiplexed circuit.

Additionally, shell completion on Zsh (MacOS and Linux) is now supported in addition to bash completion.

Wireleap now uses built-in h/2 mechanisms instead of the previous implementation which encoded the initial payload (ie. next-hop and sharetoken) and the status messages on error or connection close in the request body.

This results in simplifying the code, simplifying the protocol, faster establishment and closing of connections, and improved performance. Traffic literally passes bytewise from client to target and back with no modification.

Please note, this is a backwards incompatible release.

Bash completion is a last minute addition to the upcoming 0.4.0 release, adding shell-completion to all wireleap commands, sub-commands, option flags, as well as exec and config circuit.whitelist.

Due to protocol versioning, it is highly recommended to keep clients up to date. This release simplifies the process, bringing inline client upgrade functionality, including an upgrade supervisor, migration and rollback support. The required version is specified by the contract operator-owned directory.

Go 1.16 now supports including static files and file trees natively as part of the final executable using the new //go:embed directive. This has resulted in a 47.2% file size decrease of the client binary (from 36M to 19M).

In addition, Setuid and related calls on Linux are now implemented (previously they returned an syscall.EOPNOTSUPP error), which allows the client tun binary to be configured with appropriate privileges for improved security and user-experience, especially in regards to the upcoming GUI frontend.

When using a precompiled binary, it is highly recommended to ensure the file has not been corrupted in transit or tampered with. For this, our build pipeline generates a hashfile to be used to cryptographically verify its integrity via GPG signature and the corresponding binary via checksum hash.

The process can be a little involved when performed manually, so we’ve scripted the process and made it available for the client via get.wireleap.com.

This update brings multiplexing as well as experimental TUN device support for the client (on Linux) which forwards all traffic (UDP and TCP) over the circuit.

Please note, this is a backwards incompatible release.

This sequence diagram shows the high-level flow and behind the scenes interaction between Wireleap components, from the perspective of the client.

This documentation is imported from the wireleap/client README.md. Find a typo? Something not clear? Edit on Github

This documentation is imported from the wireleap/client API.md. Find a typo? Something not clear? Edit on Github

This documentation is imported from the wireleap/client CLI.md. Find a typo? Something not clear? Edit on Github