forked from jgregmac/hyperv-fix-for-devs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Install-DeterministicNetwork.ps1
154 lines (135 loc) · 7.69 KB
/
Install-DeterministicNetwork.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<#
.SYNOPSIS
Installation Script for the WSL2 Network Fix for Developers
.DESCRIPTION
Linux developers who choose (or are forced) to use Windows will benefit greatly
from the use the the Windows Subsystem for Linux, and the Hyper-V virtualization
engine. Unfortunately, these tools often run into problems with corporate use of
private network ranges, especially when the developer using the system roams
between remote and on-site work, or needs a VPN connection.
The problem is that WSL and Hyper-V select private network ranges for internal use
based on the networks that it can "see" when the system starts up. If the private
networks in use change after startup, there may be a network collision. Networking
inside the Hyper-V and WSL VMs then fail, and sometimes general networking on the
host Windows system deteriorates as well. Microsoft does not appear to be
interested in fixing this common problem.
This tool will install a Loopback network adapter and startup and shutdown scripts
that are designed to "trick" the WSL (and experimentally, Hyper-V) network collision
avoidance algorithm into using a network range of our choosing that we know will not
collide with our corporate internal private networks.
.EXAMPLE
PS> .\Install-DeterministicNetwork.ps1 -NetworkType WSL `
-GatewayAddress 172.30.0.1 `
-NetworkAddress 172.30.0.0/23
"Class B Network" Example:
Creates a WSL network adapter at 172.30.0.1 and netmask 255.255.254.0. This provides
a range of addresses for WSL instances to use from 172.30.0.2 - 172.30.1.255
.EXAMPLE
PS> .\Install-DeterministicNetwork.ps1 -NetworkType WSL `
-GatewayAddress 10.10.10.1 `
-NetworkAddress 10.10.10.0/25
"Class A Network" Example:
Creates a WSL network adapter at 10.10.10.1 and netmask 255.255.255.128. This provides
a range of addresses for WSL instances to use from 10.10.10.2 - 10.10.10.127
.EXAMPLE
PS> .\Install-DeterministicNetwork.ps1 -NetworkType Hyper-V `
-GatewayAddress 192.168.10.1 `
-NetworkAddress 192.168.10.0/24
"Class C Network" Example:
Creates a Hyper-V network adapter at 192.168.10.1 and netmask 255.255.255.0. This provides
a range of addresses for WSL instances to use from 192.168.10.2 - 192.168.10.254
.LINK
https://github.com/jgregmac/hyperv-fix-for-devs
#>
[CmdletBinding()]
param (
# Name of the dummy adapter that will be created.
# Only testing this for WSL at present... will need to re-install Hyper-V to validate.
[Parameter()]
[ValidateSet("WSL", "Hyper-V")]
[string]
$NetworkType = "WSL",
<#
The IP address to be used on the interface created for WSL/Hyper-V. This will serve
as the gateway address for the new virtual network. Examples:
- 192.168.100.1 (Default) - A "class C" private network that is unlikely to collide with most home networks.
- 172.16.100.1 - A "class B" private network, which might collide with a corporate network.
- 10.100.100.1 - A "class A" private network, less likely to collide with a corporate network, but it could!
#>
[Parameter()]
[IPaddress]
$GatewayAddress = "192.168.100.1",
<#
The network address, in CIDR notation, to be assigned to the new virtual network.
For explanation, see: <https://docs.netgate.com/pfsense/en/latest/network/cidr.html>
For the "easy version", use: <https://www.subnet-calculator.com/cidr.php>
The default is 192.168.100.0/24.
#>
[Parameter()]
[string]
$NetworkAddress = "192.168.100.0/24",
<# Target directory for the startup/shutdown scripts. Default is "$NetworkType-Network-Fix"
directory under your user profile. #>
[Parameter()]
[string]
$ScriptDestination = (Join-Path -Path $env:USERPROFILE -ChildPath "$NetworkType-Network-Fix")
)
# Establish current path and logging:
$CurrentPath = Split-Path $script:MyInvocation.MyCommand.Path -Parent
Import-Module (Join-Path -Path $CurrentPath -ChildPath "\scripts\OutConsoleAndLog.psm1") -ea Stop
$global:GlobalLog = (Join-Path -Path $CurrentPath -ChildPath "Install-Deterministric-$NetworkType-Network.log")
if (Test-Path $GlobalLog) { Remove-Item -Path $GlobalLog -Force -Confirm:$false }
Out-ConsoleAndLog "Starting installation of the $NetworkType Network Fix."
Out-ConsoleAndLog "These messages will be logged to: $GlobalLog"
# The installer will create the tasks to run under the account of the user running this
# installer script. You could force installation for a specific user by changing these
# variables, but the target user /has to/ have a working WSL instance to launch at login.
# This scenario has not been tested, so it will remain a "constant" in the script for now.
# Both the user name (in DomainName\UserName) and SID are required:
$UserName = [System.Security.Principal.WindowsIdentity]::GetCurrent().Name
$UserSID = ([System.Security.Principal.WindowsIdentity]::GetCurrent()).User.Value
Out-ConsoleAndLog "Generated Tasks will be run as $UserName with SID: $UserSID"
#region Copy scripts to current user profile
Out-ConsoleAndLog "Scripts will be copied to directory: $ScriptDestination"
if (-not (Test-Path $ScriptDestination )) {
Out-ConsoleAndLog "Creating script directory..."
New-Item -ItemType Directory -Path $ScriptDestination -ea Stop -Force | Out-Null
}
#Write-Host "CurrentPath is: $CurrentPath"
$ScriptSource = Join-Path -Path $CurrentPath -ChildPath scripts
#Write-Host "ScriptSource is: $ScriptSource"
Out-ConsoleAndLog "Copying scripts into place..."
Copy-Item -Path (Join-Path -Path $ScriptSource -ChildPath "*.ps*1").ToString() `
-Destination $ScriptDestination -Force -Confirm:$false -ea Stop
#endregion
#region Create Scheduled Tasks
$TaskSource = Join-Path -Path $CurrentPath -ChildPath tasks
$TaskStage = Join-Path -Path $env:TEMP -ChildPath "$NetworkType-tasks"
Out-ConsoleAndLog "Staging task definitions to: $TaskStage"
if (-not (Test-Path $TaskStage)) {
Out-ConsoleAndLog "Creating staging directory: '$TaskStage'..."
New-Item -ItemType Directory -Path $TaskStage -Force -ea Stop | Out-Null
}
# Read the content of our scheduled task templates from the source,
# Update the templates with local user data, and write to the $env:temp directory.
Out-ConsoleAndLog "Updating the staged task definitions:"
Get-ChildItem -Path $TaskSource | ForEach-Object {
#Write-Host ("Working on source file: " + $_.FullName);
$Leaf = $_.Name;
Get-Content $_.FullName |
ForEach-Object { $_ -replace "USER_ID", $UserName } |
ForEach-Object { $_ -replace "USER_SID", $UserSID } |
ForEach-Object { $_ -replace "STARTUP_SCRIPT_PATH", $ScriptDestination } |
ForEach-Object { $_ -replace "NETWORK_TYPE", $NetworkType } |
ForEach-Object { $_ -replace "IP_ADDRESS", $GatewayAddress } |
ForEach-Object { $_ -replace "NETWORK_ADDRESS", $NetworkAddress } |
Set-Content -Path (Join-Path -Path $TaskStage -ChildPath $Leaf) -Force -Confirm:$false -ea Stop;
}
# Register the login actions task
Out-ConsoleAndLog "Registering the startup/login task..."
$SourceFile = Join-Path -Path $TaskStage -ChildPath login-task.xml -Resolve
Register-ScheduledTask -Xml (Get-Content $SourceFile | Out-String) `
-TaskName "$NetworkType Fix Task - On Startup" -Force -ea Stop | Out-Null
# Remove-Item -Recurse -Path $TaskStage -Force
#endregion
Out-ConsoleAndLog "All done. $NetworkType Network Fix Startup Script has been installed."