AmmarRahman / wsl-vpn

wsl-vpn

This is a repository to script in the wrokaround for WSL2 connectivity over VPN based on Keiichi Shimamura work on Ubuntu and Debian WSL Distros.

The solution utilises Docker's VPNKit and Jeff Trotman's npiperelay to tunnel the connectivity

Getting started

1. Clone the repo, in windows or WSL.
   • If you are currently on VPN, you can only clone from WSL1 or Windows. It doesn't matter where you put the repo, as it can be removed when done.
2. (Currently) if you are on VPN, you will have to install socat before you can run the setup script.
   • Easy option: Get off of VPN
   • Or if you cannot (for example, always-on-VPN Corporate rules)
     1. You can convert to image to WSL1: Windows: wsl --set-version {WSL_NAME} 1
     2. Install these dependencies (e.g. apt-get update; apt-get install socat)
     3. Convert it back to WSL2: Windows: wsl --set-version {WSL_NAME} 2
3. Run the setup script:
   • Option 1: The preferred option since it gurantees fresh copies of all the dependencies to run the tunnel.
     1. Install Docker Desktop on your windows machine.
     2. Run sudo ./wsl-vpnkit-setup.sh from within this folder in WSL
   • Option 2: If you prefer not to (or can't) install Docker on your Windows machine, you can have the script download the required files instead.
     1. sudo ./wsl-vpnkit-setup.sh --no-docker

Once everything is working and you are satisfied, you can feel free to remove the cloned repository; all relavent files have been installed (However, you cannot delete C:\bin\ in Windows)

Removal

In case you want to remove and/or re-install the wsl-vpn files, you can run:

1. In the cloned repo, run:
   • sudo ./wsl-vpnkit-unsetup.sh

FAQ

1. What if I have multiple WSLs?
   • You only install WSL-VPN into one WSL2 distro. The rest of the distros will get working internet from the WSL-VPN distro.
   • The only caveat is that you must start the WSL-VPN distro everytime you restart your computer or "shutdown" or "terminate" the WSL-VPN distro.
   • Simply opening up a tab to the WSL-VPN distro starts and fixes all of the other WSL2 distros. You can close it as soon as you open it.
   • If you need to script starting WSL-VPN: /mnt/c/Windows/System32/wsl.exe -d {WSL-VPN distro name} --user root service wsl-vpnkit start
2. What if I want to use a distro other than Debian/Ubuntu?
   • You can install a Debian or Ubuntu from the Windows store to run along side your other distros, and use the multiple WSLs support to get your particular distro to work.
   • The only part that is specific to Debian and Ubuntu is the service script. You are free to wrap the script `/usr/local
3. What if I'm trying to expose a port from WSL2?
   • Ports bound to localhost in WSL2 will be listening on localhost on the Windows Host side.
   • Unforunately, this solution will not allow you to expose a port on any other IP when on or off of VPN.
     • If you need to expose a port (other than on localhost) when off of VPN, you'll need to run the ./wsl-vpnkit-unsetup.sh script
     • A socat-like solution might also be possible on the Windows side (e.g. cygwin) that will allow you to link localhost to another IP.
4. What about IPv6?
   • On tested clients IPv6 actually works when on VPN without the need for WSL-VPN, and continues to work when WSL-VPN is fixing IPv4. Tested clients include:
     • SonicWall NetExtender
   • Exposing ports on IPv6 still works
5. What if I started killing random parts of the WSL-VPN, and now nothing's working.
   • Well, if the scripts are killed mid-script, they can't restore settings. But to fix this, you simply run: wsl --shutdown and everything will be restored.
   • Note: This will restart all WSLs. I.e. if you are running docker, it will be restarted.

Acknowledgements

• wsl-vpnkit
• vpn-kit
• npiperelay