-
Notifications
You must be signed in to change notification settings - Fork 12
/
Get-TargetedWinEvent.ps1
419 lines (310 loc) · 12.6 KB
/
Get-TargetedWinEvent.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
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
function Get-TargetedWinEvent {
<#
.SYNOPSIS
Searches Windows logs for events related to specific Event IDs or EventData.Data values
.DESCRIPTION
Searches Windows logs for events related to specific Event IDs or EventData.Data values
Supports searching offline/exported evt/evtx files as well as online machines
.PARAMETER SearchTerm
EventData.Data property value to search for
.PARAMETER EventId
Windows Event ID to search for
.PARAMETER ComputerName
Remote computer to search logs on
Defaults to $env:COMPUTERNAME
.PARAMETER Credential
Credential used to connect to remote computers if default credentials won't work
.PARAMETER Offline
Switch to search offline/exported logs either locally or remotely
.PARAMETER Path
Path to offline/exported log files
Defaults to "$env:SystemRoot\System32\winevt\Logs"
.PARAMETER Days
Number of days to go back in the search for offline/exported logs
.PARAMETER Flatten
Switch to flatten the EventData.Data values and append them as properties to the parent object
.EXAMPLE
Get-TargetedWinEvent -SearchTerm user.name
Finds local events related to user.name
.EXAMPLE
'host1','host2' | Get-TargetedWinEvent -SearchTerm user.name -EventId 4624
Finds successful logon events for user.name from both hosts via the pipeline
.EXAMPLE
Get-TargetedWinEvent -EventId 4624 -SearchTerm user.name -Offline -Path \\server\share\LogArchive
Finds successful logon events for user.name in all archived log files under \\server\share\LogArchive
.NOTES
#######################################################################################
Author: @oregon-national-guard/systems-administration
Version: 1.0
#######################################################################################
License: https://github.com/oregon-national-guard/powershell/blob/master/LICENCE
#######################################################################################
.LINK
https://github.com/oregon-national-guard
.LINK
https://creativecommons.org/publicdomain/zero/1.0/
#>
[CmdletBinding(DefaultParameterSetName='Online')]
param (
[Parameter(ParameterSetName='Online')]
[Parameter(ParameterSetName='Offline')]
[string]
$SearchTerm,
[Parameter(ParameterSetName='Online')]
[Parameter(ParameterSetName='Offline')]
[string]
$EventId,
[Parameter(ParameterSetName='Online',ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
[Alias('PSComputerName','DNSHostName','CN','Hostname')]
[System.Object[]]
$ComputerName,
[Parameter(ParameterSetName='Online')]
[ValidateNotNull()]
[System.Management.Automation.PSCredential]
[System.Management.Automation.Credential()]
$Credential = [System.Management.Automation.PSCredential]::Empty,
[Parameter(Mandatory=$true,ParameterSetName='Offline')]
[switch]
$Offline,
[Parameter(ParameterSetName='Offline',ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
[Alias('PSPath','FullName','LogFilePath')]
[System.Object[]]
$Path,
[Parameter(ParameterSetName='Offline')]
[int]
$Days,
[Parameter(ParameterSetName='Online')]
[Parameter(ParameterSetName='Offline')]
[switch]
$Flatten
) #param
begin {
Write-Debug -Message 'start of private function definitions'
function FlattenWinEvent {
[CmdletBinding()]
param (
[Parameter(ValueFromPipeline=$true)]
[System.Diagnostics.Eventing.Reader.EventLogRecord[]]
$EventLogRecord
) #param
process {
$EventLogRecord | ForEach-Object {
$EventXml = [xml]$_.ToXml()
$XmlData = $null
if ($XmlData = @($EventXml.Event.EventData.Data)) {
for ($i=0; $i -lt $XmlData.Count; $i++) {
$SplatArgs = @{
InputObject = $_
MemberType = "NoteProperty"
Name = "$($XmlData[$i].name)"
Value = "$($XmlData[$i].'#text')"
Force = $true
Passthru = $true
}
$_ = Add-Member @SplatArgs
} #for
} #if
$_
} #ForEach EventLogRecord
} #process
} #function FlattenWinEvent
Write-Debug -Message 'end of private function definitions'
Write-Debug -Message 'start detecting which parameters were bound at runtime'
if ($PSBoundParameters.ContainsKey('EventId')) {
$Id = $true
} elseif (-not ($PSBoundParameters.ContainsKey('EventId'))) {
$Id = $false
} #if
if ($PSBoundParameters.ContainsKey('SearchTerm')) {
$Search = $true
} elseif (-not ($PSBoundParameters.ContainsKey('SearchTerm'))) {
$Search = $false
} #if
if ($PSBoundParameters.ContainsKey('ComputerName')) {
$Computer = $true
} elseif (-not ($PSBoundParameters.ContainsKey('ComputerName'))) {
$Computer = $false
} #if
if ($PSBoundParameters.ContainsKey('Credential')) {
$Creds = $true
} elseif (-not ($PSBoundParameters.ContainsKey('Credential'))) {
$Creds = $false
} #if
Write-Debug -Message 'end detecting which parameters were bound at runtime'
Write-Debug -Message 'start setting default parameter values'
if (-not $Computer) {
$ComputerName = $env:COMPUTERNAME
} #if
if (-not ($PSBoundParameters.ContainsKey('Days'))) {
$Days = 1
} #if
if (($PSCmdlet.ParameterSetName -match 'Offline') -and (-not ($PSBoundParameters.ContainsKey('Path')))) {
Write-Debug -Message 'No $Path supplied. Using "$env:SystemRoot\System32\winevt\Logs"'
$Path = "$env:SystemRoot\System32\winevt\Logs"
} #if
Write-Debug -Message 'end setting default parameter values'
} #begin
process {
if ($PSCmdlet.ParameterSetName -match 'Online') {
Write-Verbose -Message 'Running in "Online" mode'
Write-Debug -Message 'start building "Here-Strings" for query XML'
if ($Id -and $Search) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="Security">
<Select Path="Security">
*[System[Provider[@Name='Microsoft-Windows-Security-Auditing'] and (EventID=$EventId)]]
and
*[EventData[Data and (Data='$SearchTerm')]]
</Select>
</Query>
</QueryList>
"@
} elseif ($Id -and (-not $Search)) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="Security">
<Select Path="Security">
*[System[Provider[@Name='Microsoft-Windows-Security-Auditing'] and (EventID=$EventId)]]
</Select>
</Query>
</QueryList>
"@
} elseif ((-not $Id) -and $Search) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="Security">
<Select Path="Security">
*[System[Provider[@Name='Microsoft-Windows-Security-Auditing']]]
and
*[EventData[Data and (Data='$SearchTerm')]]
</Select>
</Query>
</QueryList>
"@
} elseif ((-not $Id) -and (-not $Search)) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="Security">
<Select Path="Security">
*[System[Provider[@Name='Microsoft-Windows-Security-Auditing']]]
</Select>
</Query>
</QueryList>
"@
} #if ($Id -and $Search)
Write-Debug -Message 'end building "Here-Strings" for query XML'
$QueryXml = [xml]$QueryString
$ComputerName | ForEach-Object {
$EachComputer = $_
if (-not $Computer) {
$SplatArgs = @{
FilterXml = $QueryXml
ErrorAction = [System.Management.Automation.ActionPreference]::SilentlyContinue
}
if (-not $Flatten) {
Get-WinEvent @SplatArgs
} elseif ($Flatten) {
Get-WinEvent @SplatArgs | FlattenWinEvent
} #if
} elseif ($Computer -and (-not $Creds)) {
$SplatArgs = @{
ComputerName = $EachComputer
FilterXml = $QueryXml
ErrorAction = [System.Management.Automation.ActionPreference]::SilentlyContinue
}
if (-not $Flatten) {
Get-WinEvent @SplatArgs
} elseif ($Flatten) {
Get-WinEvent @SplatArgs | FlattenWinEvent
} #if
} elseif ($Computer -and $Creds) {
$SplatArgs = @{
ComputerName = $EachComputer
FilterXml = $QueryXml
Credential = $Credential
ErrorAction = [System.Management.Automation.ActionPreference]::SilentlyContinue
}
if (-not $Flatten) {
Get-WinEvent @SplatArgs
} elseif ($Flatten) {
Get-WinEvent @SplatArgs | FlattenWinEvent
} #if
} #if
} #ForEach ComputerName
} elseif ($PSCmdlet.ParameterSetName -match 'Offline') {
Write-Verbose -Message 'Running in "Offline" mode'
$Path | ForEach-Object {
Write-Verbose -Message "looking for evt or evtx files in $_"
$EachPath = $_ | Get-Item
if (-not $EachPath.PSIsContainer) {
$LogFiles = $EachPath | Where-Object { $_.Name -match '\.(evt|evtx)$' }
} elseif ($EachPath.PSIsContainer) {
$LogFiles = $EachPath | Get-ChildItem | Where-Object {
$_.Name -match '\.(evt|evtx)$' -and
$_.LastWriteTime -ge (Get-Date).AddDays(-$Days)
}
} #if
$LogFiles | ForEach-Object {
Write-Verbose -Message "now processing $($_.Name)"
Write-Debug -Message 'start building "Here-Strings" for query XML'
if ($Id -and $Search) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="file://$($_.FullName)">
<Select Path="file://$($_.FullName)">
*[System[(EventID=$EventId)]]
and
*[EventData[Data and (Data='$SearchTerm')]]
</Select>
</Query>
</QueryList>
"@
} elseif ($Id -and (-not $Search)) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="file://$($_.FullName)">
<Select Path="file://$($_.FullName)">
*[System[(EventID=$EventId)]]
</Select>
</Query>
</QueryList>
"@
} elseif ((-not $Id) -and $Search) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="file://$($_.FullName)">
<Select Path="file://$($_.FullName)">
*[EventData[Data and (Data='$SearchTerm')]]
</Select>
</Query>
</QueryList>
"@
} elseif ((-not $Id) -and (-not $Search)) {
$QueryString = @"
<QueryList>
<Query Id="0" Path="file://$($_.FullName)">
<Select Path="file://$($_.FullName)">
</Select>
</Query>
</QueryList>
"@
} #if ($Id -and $Search)
Write-Debug -Message 'end building "Here-Strings" for query XML'
$QueryXml = [xml]$QueryString
$SplatArgs = @{
FilterXml = $QueryXml
Oldest = $true
ErrorAction = [System.Management.Automation.ActionPreference]::SilentlyContinue
}
if (-not $Flatten) {
Get-WinEvent @SplatArgs
} elseif ($Flatten) {
Get-WinEvent @SplatArgs | FlattenWinEvent
} #if
} #ForEach LogFile
} #ForEach Path
} #if ($PSCmdlet.ParameterSetName -match 'Online')
} #process
end {} #end
} #function Get-TargetedWinEvent