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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
|
package preflight
import (
"fmt"
"strconv"
"strings"
"github.com/crc-org/crc/v2/pkg/crc/logging"
"github.com/crc-org/crc/v2/pkg/crc/adminhelper"
winnet "github.com/crc-org/crc/v2/pkg/os/windows/network"
"github.com/crc-org/crc/v2/pkg/os/windows/powershell"
"github.com/crc-org/crc/v2/pkg/crc/constants"
"github.com/crc-org/crc/v2/pkg/crc/machine/hyperv"
)
const (
// Fall Creators update comes with the "Default Switch"
minimumWindowsReleaseID = 1709
)
func checkVersionOfWindowsUpdate() error {
windowsReleaseID := `(Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion" -Name ReleaseId).ReleaseId`
stdOut, _, err := powershell.Execute(windowsReleaseID)
if err != nil {
logging.Debug(err.Error())
return fmt.Errorf("Failed to get Windows release id")
}
yourWindowsReleaseID, err := strconv.Atoi(strings.TrimSpace(stdOut))
if err != nil {
logging.Debug(err.Error())
return fmt.Errorf("Failed to parse Windows release id: %s", stdOut)
}
if yourWindowsReleaseID < minimumWindowsReleaseID {
return fmt.Errorf("Please update Windows. Currently %d is the minimum release needed to run. You are running %d", minimumWindowsReleaseID, yourWindowsReleaseID)
}
return nil
}
func checkWindowsEdition() error {
windowsEditionCmd := `(Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion").EditionID`
stdOut, _, err := powershell.Execute(windowsEditionCmd)
if err != nil {
logging.Debug(err.Error())
return fmt.Errorf("Failed to get Windows edition")
}
windowsEdition := strings.TrimSpace(stdOut)
logging.Debugf("Running on Windows %s edition", windowsEdition)
if strings.ToLower(windowsEdition) == "core" {
return fmt.Errorf("Windows Home edition is not supported")
}
return nil
}
func checkHyperVInstalled() error {
// check to see if a hypervisor is present. if hyper-v is installed and enabled,
checkHypervisorPresent := `@(Get-Wmiobject Win32_ComputerSystem).HypervisorPresent`
stdOut, _, err := powershell.Execute(checkHypervisorPresent)
if err != nil {
logging.Debug(err.Error())
return fmt.Errorf("Failed checking if Hyper-V is installed")
}
if !strings.Contains(stdOut, "True") {
return fmt.Errorf("Hyper-V not installed")
}
checkVmmsExists := `@(Get-Service vmms).Status`
_, stdErr, err := powershell.Execute(checkVmmsExists)
if err != nil {
logging.Debug(err.Error())
return fmt.Errorf("Failed checking if Hyper-V management service exists")
}
if strings.Contains(stdErr, "Get-Service") {
return fmt.Errorf("Hyper-V management service not available")
}
return nil
}
func checkHyperVServiceRunning() error {
// Check if Hyper-V's Virtual Machine Management Service is running
checkVmmsRunning := `@(Get-Service vmms).Status`
stdOut, _, err := powershell.Execute(checkVmmsRunning)
if err != nil {
logging.Debug(err.Error())
return fmt.Errorf("Failed checking if Hyper-V is running")
}
if strings.TrimSpace(stdOut) != "Running" {
return fmt.Errorf("Hyper-V Virtual Machine Management service not running")
}
return nil
}
func checkUserPartOfCrcUsersAndHypervAdminsGroup() error {
groupMembers, _, err := powershell.Execute(`(Get-LocalGroupMember -Group 'crc-users').Name`)
if err != nil {
return err
}
logging.Debug("Checking current user is in the 'crc-user' group")
if !usernameInMembersList(username(), groupMembers) {
return fmt.Errorf("Could not find: %s in the 'crc-users' group", username())
}
// https://support.microsoft.com/en-us/help/243330/well-known-security-identifiers-in-windows-operating-systems
// BUILTIN\Hyper-V Administrators => S-1-5-32-578
groupMembers, _, err = powershell.Execute(`(Get-LocalGroupMember -SID 'S-1-5-32-578').Name`)
if err != nil {
return err
}
logging.Debug("Checking current user is in the 'Hyper-v Administrators' group")
if !usernameInMembersList(username(), groupMembers) {
return fmt.Errorf("Could not find: %s in the 'Hyper-v Administrators' group", username())
}
return nil
}
func usernameInMembersList(username, members string) bool {
m := strings.Split(members, "\n")
var memberList []string
// remove any empty elements
for _, elem := range m {
if strings.TrimSpace(elem) != "" {
memberList = append(memberList, strings.TrimSpace(elem))
}
}
logging.Debugf("group members: %s", strings.Join(memberList, ","))
for _, member := range memberList {
// we get the members of a group in the form domain\username
// if the current username is also returned in the same form
// check if that full domain\username is present in the list
if strings.Contains(username, "\\") {
if username == member {
return true
}
continue
}
// if we get only the username without domain part then we
// compare it with the username part of the group members
m := strings.Split(member, "\\")
if len(m) == 2 {
if m[1] == username {
return true
}
} else {
logging.Warnf("Got group member's name in unexpected format: %s", member)
}
}
return false
}
func fixUserPartOfCrcUsersAndHypervAdminsGroup() error {
cmd := `Add-LocalGroupMember -Group 'crc-users' -Member '%s';Add-LocalGroupMember -SID 'S-1-5-32-578' -Member '%s'`
_, _, err := powershell.ExecuteAsAdmin("adding current user to crc-users and Hyper-V admins group", fmt.Sprintf(cmd, username(), username()))
if err != nil {
return err
}
return errReboot
}
func checkIfHyperVVirtualSwitchExists() error {
switchName := hyperv.AlternativeNetwork
// use winnet instead
exists, foundName := winnet.SelectSwitchByNameOrDefault(switchName)
if exists {
logging.Info("Found Virtual Switch to use: ", foundName)
return nil
}
return fmt.Errorf("Virtual Switch not found")
}
func checkIfRunningAsNormalUser() error {
if !powershell.IsAdmin() {
return nil
}
logging.Debug("Ran as administrator")
return fmt.Errorf("crc should be ran in a shell without administrator rights")
}
func removeDNSServerAddress() error {
resetDNSCommand := `Set-DnsClientServerAddress -InterfaceAlias ("vEthernet (crc)") -ResetServerAddresses`
if exist, defaultSwitch := winnet.GetDefaultSwitchName(); exist {
resetDNSCommand = fmt.Sprintf(`Set-DnsClientServerAddress -InterfaceAlias ("vEthernet (%s)","vEthernet (crc)") -ResetServerAddresses`, defaultSwitch)
}
if _, _, err := powershell.ExecuteAsAdmin("Remove dns entry for default switch", resetDNSCommand); err != nil {
return err
}
return nil
}
func removeCrcVM() (err error) {
if _, _, err := powershell.Execute("Get-VM -Name crc"); err != nil {
// This means that there is no crc VM exist
return nil
}
stopVMCommand := fmt.Sprintf(`Stop-VM -Name "%s" -TurnOff -Force`, constants.DefaultName)
if _, _, err := powershell.Execute(stopVMCommand); err != nil {
// ignore the error as this is useless (prefer not to use nolint here)
return err
}
removeVMCommand := fmt.Sprintf(`Remove-VM -Name "%s" -Force`, constants.DefaultName)
if _, _, err := powershell.Execute(removeVMCommand); err != nil {
// ignore the error as this is useless (prefer not to use nolint here)
return err
}
logging.Debug("'crc' VM is removed")
return nil
}
func checkIfAdminHelperServiceRunning() error {
stdout, stderr, err := powershell.Execute(fmt.Sprintf("(Get-Service %s).Status", constants.AdminHelperServiceName))
if err != nil {
return fmt.Errorf("%s service is not present %v: %s", constants.AdminHelperServiceName, err, stderr)
}
if strings.TrimSpace(stdout) != "Running" {
return fmt.Errorf("%s service is not running", constants.AdminHelperServiceName)
}
return checkAdminHelperNamedPipeAccessible()
}
func checkAdminHelperNamedPipeAccessible() error {
client := adminhelper.Client()
if _, err := client.Version(); err != nil {
return err
}
return nil
}
|