DscResources/MSFT_xWindowsUpdate/MSFT_xWindowsUpdate.psm1

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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
Data LocalizedData
{
    # culture="en-US"e
    ConvertFrom-StringData @'
        GettingHotfixMessage=Getting the hotfix patch with ID {0}.
        ValidatingPathUri=Validating path/URI.
        ErrorPathUriSpecifiedTogether=Hotfix path and Uri parameters cannot be specified together.
        ErrorInvalidFilePathMsu=Filename provided is an invalid file path for hotfix since it does not have the msu suffix to it.
        StartKeyWord=START
        EndKeyWord= END
        FailedKeyword = FAILED
        ActionDownloadFromUri= Download from {0} using BitsTransfer.
        ActionInstallUsingwsusa = Install using wsusa.exe
        ActionUninstallUsingwsusa = Uninstall using wsusa.exe
        DownloadingPackageTo = Downloading package to filepath {0}
        FileDoesntExist=The given path {0} does not exist.
        LogNotSpecified=Log name hasn't been specified. Hotfix will use the temporary log {0} .
        ErrorOccuredOnHotfixInstall = \nCould not install the windows update. Details are stored in the log {0} . Error message is \n\n {1} .\n\nPlease look at Windows Update error codes here for more information - http://technet.microsoft.com/en-us/library/dd939837(WS.10).aspx .
        ErrorOccuredOnHotfixUninnstall = \nCould not uninstall the windows update. Details are stored in the log {0} . Error message is \n\n {1} .\n\nPlease look at Windows Update error codes here for more information - http://technet.microsoft.com/en-us/library/dd939837(WS.10).aspx .
        TestingEnsure = Testing whether hotfix is {0}.
        InvalidPath=The specified Path ({0}) is not in a valid format. Valid formats are local paths, UNC, and HTTP.
        InvalidBinaryType=The specified Path ({0}) does not appear to specify an MSU file and as such is not supported.
        TestStandardArgumentsPathWasPath = Test-StandardArguments, Path was {0}.
        NeedToDownloadFileFromSchemeDestinationWillBeDestName = Need to download file from {0}, destination will be {1}.
        TheUriSchemeWasUriScheme = The uri scheme was {0}.
        MountSharePath=Mount share to get media.
        NeedsMoreInfo=Id is required.
        InvalidIdFormat=Id must be formated either KBNNNNNNN or NNNNNNN.
        DownloadHTTPFile=Download the media over HTTP or HTTPS.
        CreatingCacheLocation = Creating cache location.
        CouldNotOpenDestFile=Cannot open the file {0} for writing.
        CreatingTheSchemeStream = Creating the {0} stream.
        SettingDefaultCredential = Setting default credential.
        SettingAuthenticationLevel = Setting authentication level.
        IgnoringBadCertificates = Ignoring bad certificates.
        GettingTheSchemeResponseStream = Getting the {0} response stream.
        ErrorOutString = Error: {0}.
        CopyingTheSchemeStreamBytesToTheDiskCache = Copying the {0} stream bytes to the disk cache.
        RedirectingPackagePathToCacheFileLocation = Redirecting package path to cache file location.
        ThePathExtensionWasPathExt = The path extension was {0}
        CreatingTheDestinationCacheFile = Creating the destination cache file.
'@

}

$CacheLocation = "$env:ProgramData\Microsoft\Windows\PowerShell\Configuration\BuiltinProvCache\MSFT_xWindowsUpdate"

# Get-TargetResource function
function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    Param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Path,

        [parameter(Mandatory = $true)]
        [System.String]
        $Id
    )
    Set-StrictMode -Version latest

    $uri, $kbId = Test-StandardArguments -Path $Path -Id $Id

    Write-Verbose $($LocalizedData.GettingHotfixMessage -f ${Id})

    $hotfix = Get-HotFix -Id "KB$kbId"
    
    $returnValue = @{
        Path = ''
        Id = $hotfix.HotFixId
        Log = ''
    }

    $returnValue    

}

$Debug = $true
Function Trace-Message
{
    param([string] $Message)
    Set-StrictMode -Version latest
    if($Debug)
    {
        Write-Verbose $Message
    }
}

Function New-InvalidArgumentException
{
    param(
        [string] $Message,
        [string] $ParamName
    )
    Set-StrictMode -Version latest
    
    $exception = new-object System.ArgumentException $Message,$ParamName
    $errorRecord = New-Object System.Management.Automation.ErrorRecord $exception,$ParamName,'InvalidArgument',$null
    throw $errorRecord
}

# The Set-TargetResource cmdlet
function Set-TargetResource
{
    # should be [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidGlobalVars", "DSCMachineStatus")], but it doesn't work
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidGlobalVars", "")]   
    [CmdletBinding()]
    Param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Path,

        [parameter(Mandatory = $true)]
        [System.String]
        $Id,

        [System.String]
        $Log,

        [ValidateSet('Present','Absent')]
        [System.String]
        $Ensure='Present',

        [pscredential] $Credential

    )
    Set-StrictMode -Version latest
    if (!$Log)
    {
        $Log = [IO.Path]::GetTempFileName()
        $Log += '.etl'

        Write-Verbose "$($LocalizedData.LogNotSpecified -f ${Log})"
    }
    $uri, $kbId = Test-StandardArguments -Path $Path -Id $Id

    
            
    if($Ensure -eq 'Present')
    {
        $filePath = Test-WindowsUpdatePath -uri $uri -Credential $Credential 
        Write-Verbose "$($LocalizedData.StartKeyWord) $($LocalizedData.ActionInstallUsingwsusa)"
    
        Start-Process -FilePath 'wusa.exe' -ArgumentList "`"$filepath`" /quiet /norestart /log:`"$Log`"" -Wait -NoNewWindow -ErrorAction SilentlyContinue
        $errorOccured = Get-WinEvent -Path $Log -Oldest | Where-Object {$_.Id -eq 3}                         
        if($errorOccured)
        {
            $errorMessage= $errorOccured.Message
            Throw "$($LocalizedData.ErrorOccuredOnHotfixInstall -f ${Log}, ${errorMessage})"
        }

        Write-Verbose "$($LocalizedData.EndKeyWord) $($LocalizedData.ActionInstallUsingwsusa)"
    }
    else
    {
        $argumentList = "/uninstall /KB:$kbId /quiet /norestart /log:`"$Log`""
        
        Write-Verbose "$($LocalizedData.StartKeyWord) $($LocalizedData.ActionUninstallUsingwsusa) Arguments: $ArgumentList"
    
        Start-Process -FilePath 'wusa.exe' -ArgumentList $argumentList  -Wait -NoNewWindow  -ErrorAction SilentlyContinue 
        #Read the log and see if there was an error event
        $errorOccured = Get-WinEvent -Path $Log -Oldest | Where-Object {$_.Id -eq 3}                         
        if($errorOccured)
        {
            $errorMessage= $errorOccured.Message
            Throw "$($LocalizedData.ErrorOccuredOnHotfixUninstall -f ${Log}, ${errorMessage})"
        }

        Write-Verbose "$($LocalizedData.EndKeyWord) $($LocalizedData.ActionUninstallUsingwsusa)"

        
    }
    
    if (Test-Path -Path 'variable:\LASTEXITCODE')
    {
        if ($LASTEXITCODE -eq 3010)
        {
            # reboot machine if exitcode indicates reboot.
            $global:DSCMachineStatus = 1        
        }
    }
}


# Function to test if Hotfix is installed.
function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [System.String]
        $Path,

        [parameter(Mandatory = $true)]
        [System.String]
        $Id,

        [System.String]
        $Log,

        [ValidateSet('Present','Absent')]
        [System.String]
        $Ensure='Present',

        [pscredential] $Credential
    )
    Set-StrictMode -Version latest
    Write-Verbose "$($LocalizedData.TestingEnsure -f ${Ensure})"
    $uri, $kbId = Test-StandardArguments -Path $Path -Id $Id
    
    # This is not the correct way to test to see if an update is applicable to a machine
    # but, WUSA does not currently expose a way to ask.
    $result = Get-HotFix -Id "KB$kbId" -ErrorAction SilentlyContinue
    $returnValue=  [bool]$result
    if($Ensure -eq 'Present')
    {

        Return $returnValue
    }
    else
    {
        Return !$returnValue
    }

}

Function Test-StandardArguments
{
    param(
        [string]
        $Path,

        [string]
        $Id
    )
    Set-StrictMode -Version latest
    
    Trace-Message ($LocalizedData.TestStandardArgumentsPathWasPath -f $Path)
    $uri = $null
    try
    {
        $uri = [uri] $Path
    }
    catch
    {
        New-InvalidArgumentException ($LocalizedData.InvalidPath -f $Path) 'Path'
    }
    
    if(-not @('file', 'http', 'https') -contains $uri.Scheme)
    {
        Trace-Message ($Localized.TheUriSchemeWasUriScheme -f $uri.Scheme)
        New-InvalidArgumentException ($LocalizedData.InvalidPath -f $Path) 'Path'
    }
    
    $pathExt = [System.IO.Path]::GetExtension($Path)
    Trace-Message ($LocalizedData.ThePathExtensionWasPathExt -f $pathExt)
    if(-not @('.msu') -contains $pathExt.ToLower())
    {
        New-InvalidArgumentException ($LocalizedData.InvalidBinaryType -f $Path) 'Path'
    }
    
    if(-not $Id)
    {
        New-InvalidArgumentException ($LocalizedData.NeedsMoreInfo -f $Path) 'Id'
    }
    else
    {
        if($Id -match 'kb[0-9]+')
        {
            if($Matches[0] -eq $id)
            {
                $kbId = $id.Substring(2)
            }
            else
            {
                New-InvalidArgumentException ($LocalizedData.InvalidIdFormat -f $Path) 'Id'
            }
        }
        elseif($id -match '[0-9]+')
        {
            if($Matches[0] -eq $id)
            {
                $kbId = $id
            }
            else
            {
                New-InvalidArgumentException ($LocalizedData.InvalidIdFormat -f $Path) 'Id'
            }
        }
    }
    
    return @($uri, $kbId)
}


function Test-WindowsUpdatePath
{
    <#
        .SYNOPSIS
        Validate path, if necessary, cache file and return the location to be accessed
    #>

    param(
            [parameter(Mandatory = $true)]
            [System.Uri] $uri,
            
            [pscredential] $Credential
    )
    Set-StrictMode -Version latest

    if($uri.IsUnc)
    {
        $psdriveArgs = @{Name=([guid]::NewGuid());PSProvider='FileSystem';Root=(Split-Path $uri.LocalPath)}
        if($Credential)
        {
            #We need to optionally include these and then splat the hash otherwise
            #we pass a null for Credential which causes the cmdlet to pop a dialog up
            $psdriveArgs['Credential'] = $Credential
        }
        
        $psdrive = New-PSDrive @psdriveArgs
        $Path = Join-Path $psdrive.Root (Split-Path -Leaf $uri.LocalPath) #Necessary?
    }
    elseif(@('http', 'https') -contains $uri.Scheme)
    {
        $scheme = $uri.Scheme
        $outStream = $null
        $responseStream = $null
        
        try
        {
            Trace-Message ($LocalizedData.CreatingCacheLocation)
            
            if(-not (Test-Path -PathType Container $CacheLocation))
            {
                mkdir $CacheLocation | Out-Null
            }
            
            $destName = Join-Path $CacheLocation (Split-Path -Leaf $uri.LocalPath)
            
            Trace-Message ($LocalizedData.NeedToDownloadFileFromSchemeDestinationWillBeDestName -f $scheme, $destName)
            
            try
            {
                Trace-Message ($LocalizedData.CreatingTheDestinationCacheFile)
                $outStream = New-Object System.IO.FileStream $destName, 'Create'
            }
            catch
            {
                #Should never happen since we own the cache directory
                Throw-TerminatingError ($LocalizedData.CouldNotOpenDestFile -f $destName) $_
            }
            
            try
            {
                Trace-Message ($LocalizedData.CreatingTheSchemeStream -f $scheme)
                $request = [System.Net.WebRequest]::Create($uri)
                Trace-Message ($LocalizedData.SettingDefaultCredential)
                $request.Credentials = [System.Net.CredentialCache]::DefaultCredentials
                if ($scheme -eq 'http')
                {
                    Trace-Message ($LocalizedData.SettingAuthenticationLevel)
                    # default value is MutualAuthRequested, which applies to https scheme
                    $request.AuthenticationLevel = [System.Net.Security.AuthenticationLevel]::None                            
                }
                if ($scheme -eq 'https')
                {
                    Trace-Message ($LocalizedData.IgnoringBadCertificates)
                    $request.ServerCertificateValidationCallBack = {$true}
                }
                Trace-Message ($LocalizedData.GettingTheSchemeResponseStream -f $scheme)
                $responseStream = (([System.Net.HttpWebRequest]$request).GetResponse()).GetResponseStream()
            }
            catch
            {
                Trace-Message ($LocalizedData.ErrorOutString -f ($_ | Out-String))
                Throw-TerminatingError ($LocalizedData.CouldNotGetHttpStream -f $scheme, $Path) $_
            }
            
            try
            {
                Trace-Message ($LocalizedData.CopyingTheSchemeStreamBytesToTheDiskCache -f $scheme)
                $responseStream.CopyTo($outStream)
                $responseStream.Flush()
                $outStream.Flush()
            }
            catch
            {
                Trace-Message ($LocalizedData.ErrorOutString -f ($_ | Out-String))
                Throw-TerminatingError ($LocalizedData.ErrorCopyingDataToFile -f $Path,$destName) $_
            }
        }
        finally
        {
            if($outStream)
            {
                $outStream.Close()
            }
            
            if($responseStream)
            {
                $responseStream.Close()
            }
        }
        Trace-Message ($LocalizedData.RedirectingPackagePathToCacheFileLocation)
        $Path = $downloadedFileName = $destName
    }
    return $Path
}

Export-ModuleMember -Function *-TargetResource