/wsl2-vpn-support

This Powershell script will reconfigure the system routes to fix WSL2 networking when on a VPN

Primary LanguagePowerShell

WSL2 VPN Support

About

There is a known issue with WSL2 that prevents the linux guest from having any network connection when the Windows host is on a VPN.

This Powershell script is designed to specifically address this issue when using a GlobalProtect VPN client. It can be configured to run automatically on network interface change where it will reconfigure the Windows systems routes to fix WSL2 networking.

Why is this script different?

Most other solutions on the internet involve setting the Interface Metric of the VPN interface to a really high number, essentially routing traffic from the WSL2 instance straight to the internet rather than over the VPN.

This script routes all traffic, including WSL2, via the VPN which makes it ideal for corporate environments where all traffic should use the VPN.

What does the script do?

This script detects whether the VPN is connected and then either Adds or Removes a Host Route, dynamically populating the necessary values, for the WSL2 Guest(s):

route add <WSL2_Guest_IP> mask 255.255.255.255 metric <WSL_interface_RouteMetric> if <WSL_Interface_ID>

Configuration

There are 5 configuration parameters at the start of the Powershell script that allow for user customisation of the scripts behaviour:

  1. $vpn_interface_desc
  2. $wsl_interface_name
  3. $wsl_interface_id
  4. $config_default_wsl_guest
  5. $wsl_guest_list
  6. $state_file

These are further explained as follows.

$vpn_interface_desc

$vpn_interface_desc is used to select the VPN client interface by matching the description field.

You can determine this value by executing Get-NetAdapter within Powershell and looking for the value contained in the InterfaceDescription property/column.

This script will accept an exact or partial match.

$wsl_interface_name

$wsl_interface_name is used to select the WSL2 Interface by matching the interface name.

You can determine this value by executing Get-NetAdapter within Powershell and looking for the value contained in the Name property/column.

This script expects an exact match for this parameter.

$wsl_interface_id

$wsl_interface_id is used to select the WSL2 guest Interface by matching the ID within Linux.

You can determine this value by executing ip addr and looking for the first word after the Numeric ID, for example: 2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1300 would have a network interface ID of eth0. The original method of determining the IP address of the WSL2 host was to use the hostname -I command which breaks the route add command if there is more than a single IP address, such as the presence of an internal virtual adapter like if docker is installed within the WSL2 Linux guest.

This script expects an exact match for this parameter.

$config_default_wsl_guest and $wsl_guest_list

The $config_default_wsl_guest parameter controls whether the script will attempt to configure the default WSL2 Guest - this is useful if you only have one guest as it saves you needing to specify its name..

Setting this parameter to 0 will disable default guest configuration. Setting it to a positive non-zero integer will enable default guest configuration.

The $wsl_guest_list parameter accepts an array of WSL2 Guests names. The script will iterate through each guest in this list to determine it's IP address so that routes can be created. If you only have a single WSL2 guest you can ommit setting this parameter (assuming you enabled $config_default_wsl_guest).

The guest name(s) can be determined by executing wsl --list --all from a shell.

$state_file

The $state_file parameter configures where the state file is recorded.

The state file is used to cleanup created routes when:

  • The VPN interface is deactivated
  • IP Addresses change
  • Interface ID Changes

WSL Configuration

Note, you may also need to configure DNS manually in the WSL2 guest. For Ubuntu proceed as follows:

  1. edit /etc/resolv.conf to contain:

    nameserver a.b.c.d

    where a.b.c.d is the DNS IP of your host network on the VPN. See here for more details.

  2. Make the resolv.conf immutable by issuing:

    # chattr +i resolv.conf

    See here for more details

  3. Prevent WSL from generating resolv.conf, by adding the following to /etc/wsl.conf

    [network]
generateResolvConf = false

    See here for more details.

  4. Restart WSL to apply the above changes

Installation

Please follow these steps if you would like your system to automatically execute the WSL2 VPN Configuration script each time a network connect or disconnect event occurs:

  1. Clone this repo to a scripts directory in the Users HOME (C:\Users<username>)

  2. From the START menu, Open 'Task Scheduler' (Will need ADMIN on Windows)

  3. Click "Create Task" on Right Sidebar and configure various tabs as described below

    General Tab:

    • Set the Name to: Update WSL2 Routing for VPN
    • Select the checkbox 'Run with highest priveleges'

    Triggers Tab:

    Add three triggers as specified below

    Trigger-1:

    • Click 'New' at bottom of Window
    • Open 'Begin the task' drop-down
    • Select 'On an Event'.
    • Next we need to enter the following to trigger on the 'Connect' Event
      • Log: Microsoft-Windows-NetworkProfile/Operational
      • Source: NetworkProfile
      • Event ID: 10000
    • Click 'OK'

    Trigger-2:

    • Click 'New' at bottom of Window
    • Open 'Begin the task' drop-down
    • Select 'On an Event'.
    • Next we need to enter the following to trigger on the 'Disconnect' Event
      • Log: Microsoft-Windows-NetworkProfile/Operational
      • Source: NetworkProfile
      • Event ID: 10001
    • Click 'OK'

    Trigger-3:

    • Click 'New' at bottom of Window
    • Open 'Begin the task' drop-down
    • Select 'On an Event'.
    • Next we need to enter the following to trigger on the 'Hyper-V VM Connect' Event
      • Log: System
      • Source: Hyper-V-VmSwitch
      • Event ID: 232
    • Click 'OK'

    Action Tab:

    • Action: 'Start a Program'
    • Program/script: 'Powershell.exe'
    • Add arguments: '-ExecutionPolicy Bypass -File %HOMEPATH%\scripts\configure-wsl-networking.ps1'
    • Click 'OK'

    Conditions Tab:

    • Uncheck box:
      • Power -> Start the task only if the computer is on AC Power

  4. Click 'OK'

Troubleshooting

Task Scheduler

If your task is not working properly, Open "Event Viewer", Navigate to "Windows Logs" -> "System". Observe, which events are logged when your WSL starts. Take the fields "Log", "Source", "Event ID" from the logged event and use them as trigger for the task.