forked from markstan/Test-IntuneFirewallRules
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Test-IntuneFirewallRules.ps1
1792 lines (1331 loc) · 53.2 KB
/
Test-IntuneFirewallRules.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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<#
.COPYRIGHT
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
See LICENSE in the project root for license information.
Test-IntuneFirewallRules.ps1
Utility for testing Intune Firewall Rules
Author: Mark Stanfill ([email protected])
Published: 1/21/2022
Last Updated: 3/4/2022
Version: 1.0
#>
####################################################
Param (
[string]$PolicyName,
[string]$PolicyID,
[bool]$Debug = $false,
# clean up test rules standalone option
[switch]$DeleteTestFirewallRules,
# process policies that are not assigned to a group in Intune
[switch]$IncludeUnassignedPolicies,
# bypass EULA check
[switch]$AcceptEULA,
# ingest JSON exported from EndpointSecurityPolicy_Export.ps1
$RuleJSON
)
####################################################
#region Functions
####################################################
function Write-Log {
<#
.SYNOPSIS
Script-wide logging function
.DESCRIPTION
Writes debug logging statements to script log file
.EXAMPLE
Write-Log "Entering function"
Write log entry with information level
.EXAMPLE
Write-Log -Level Error -WriteStdOut "Error"
Write error to log and also show in PowerShell output
.NOTES
NAME: Write-Log
Set $global:LogName at the beginning of the script
#>
[CmdletBinding()]
param(
[Parameter(ValueFromPipeline = $true)]
[ValidateNotNullOrEmpty()]
[string]$Message = "",
[Parameter()]
[ValidateNotNullOrEmpty()]
[ValidateSet('Information', 'Warning', 'Error', 'Verbose')]
[string]$Level = 'Information',
[Parameter()]
[switch]$WriteStdOut,
[Parameter()]
# create log in format
[string]$LogName = $global:LogName
)
BEGIN {
if ( ($null -eq $LogName) -or ($LogName -eq "")) { Write-Error "Please set variable `$global`:LogName." }
}
PROCESS {
# only log verbose if flag is set
if ( ($Level -eq "Verbose") -and ( -not ($debugMode) ) ) {
# don't log events unless flag is set
} else {
[pscustomobject]@{
Time = (Get-Date -f u)
Line = "`[$($MyInvocation.ScriptLineNumber)`]"
Level = $Level
Message = $Message
} | Export-Csv -Path $LogName -Append -Force -NoTypeInformation -Encoding Unicode
if ( $WriteStdOut -or ( ($Level -eq "Verbose") -and $debugMode)) { Write-Output $Message }
}
}
END {}
}
####################################################
function Test-IsEULAAccepted {
<#
.SYNOPSIS
Show warning about firewall creation and how to remedy any artifacts left by the script
.DESCRIPTION
Informs admin of changes made to local device. Prompts admin to acknowledged
.EXAMPLE
Test-IsEULAAccepted
.NOTES
NAME: Test-IsEULAAccepted
Bypass at script-level with Test-IntuneFirewallRules.ps1 -AcceptEULA
#>
[string]$message =
@"
Warning: This script will create test firewall rules on the device it is ran on. These rules are disabled and named with a `"____MSTestRule_DeleteMe____`" prefix.
Rules will be automatically deleted when the script completes.
If there are any rules remaing (for instance, if the device reboots or the PowerShell window is closed while the script is running, run this command to delete remaining artifacts:
Test-IntuneFirewallRules.ps1 -DeleteTestFirewallRules
"@
[bool]$isEULAAccepted = $false
if ( $AcceptEULA ) {
$isEULAAccepted = $true
}
if ( $isEULAAccepted -eq $false) {
Write-Host -Object $message -ForegroundColor "Black" -BackgroundColor Yellow
Write-Host "`r`nType (Y)es to accept this warning and continue running this script: " -NoNewline
$accepted = Read-Host
if ($accepted -in ("y", "yes", "yep") ) {
$isEULAAccepted = $true
"EULA accepted via command line: $accepted" | Write-Log
} else {
"EULA not accepted, exiting: $accepted" | Write-Log
}
} else {
"EULA accepted via command line." | Write-Log
}
$isEULAAccepted
}
####################################################
function Get-SuggestedAction {
<#
.SYNOPSIS
Parses rules for common regex patterns
.DESCRIPTION
Examines rule contents for common known issues - spaces in environmental variables, non-default variables, etc.
.EXAMPLE
Get-SuggestedAction
.NOTES
NAME: Get-SuggestedAction
#>
param (
$ExceptionInfo,
$DetectedPathIssues,
$FilePath,
$Port,
$Protocol
)
[string]$Remediation = ""
"Change $DetectedPathIssues to $fixedPath" | Write-Log
# String fix-up for reporting
$ProblemDescription = $(($ExceptionInfo.Exception) | Out-String ) -replace "\r\n", ""
switch -Wildcard ( $ProblemDescription) {
"The parameter is incorrect*" {
switch -Wildcard ($DetectedPathIssues) {
"*space pattern*" {
$envVar = $FilePath -replace "(%.*%)(.*)", "`$1"
$fixedString = $envVar -replace " ", ""
$Remediation = "Remove spaces in the environmental variable in the rule's file path.`r`nChange $envVar to $fixedString in $FilePath."
}
"*Unterminated % *" {
$UnterminatedEnvVar = $FilePath -replace "(%.*)(\\.*)", "`$1"
$fixedString = $UnterminatedEnvVar + '%'
$Remediation = "Add a '%' character to the environmental variable in the rule's file path.`r`nChange $UnterminatedEnvVar to $fixedString in $FilePath."
}
"Invalid system variable*" {
$envVar = $FilePath -replace "(%.*%)(.*)", "`$1"
$Remediation = "The environmental variable in file path $FilePath is not supported. Only default environmental variables are supported. Change $envVar to a fixed path."
}
"Leading spaces*" {
$Remediation = "Remove all space characters before the first '%' character in file path `"$FilePath`"."
}
}
}
"The application contains invalid characters, or is an invalid length*" {
$IllegalPathChars = -join [System.IO.Path]::GetInvalidPathChars().Foreach{('\x{0:x2}' -f ([Byte][Char]$_))}
$IllegalFileChars = -join [System.IO.Path]::GetInvalidFileNameChars().Foreach{('\x{0:x2}' -f ([Byte][Char]$_))}
$IllegalPathRegex = "[$IllegalPathChars]"
$IllegalFileRegex = "[$IllegalFileChars]"
$null = $FilePath -match "^(?<Path>.*)\\(?<FileName>.*)$"
$IllegalPathChars = [regex]::Matches($Matches['Path'], $IllegalPathRegex, 'IgnoreCase').Value
$IllegalFileChars = [regex]::Matches($Matches['Filename'], $IllegalFileRegex, 'IgnoreCase').Value
$Remediation = "Verify that $Filepath is a legal Windows path."
if ($IllegalPathChars) { $Remediation += " Illegal characters in path: `"$IllegalPathChars`"." }
if ($IllegalFileChars) { $Remediation += " Illegal characters in file name: `"$IllegalFileChars`"." }
}
"The address range is invalid*" { $Remediation = "Fix address range in rule." }
"The port is invalid*" {
if ($null -eq $Protocol) {
$Remediation = "'Any' protocol is specified with port(s) $Port. Either change the protocol (typically to TCP or UDP) or remove the port number from the rule.
If in doubt, delete the rule and recreate it manually."
}
}
default { $Remediation = "Unable to detect fix. Please try to create rule manually to troubleshoot." }
}
"REMEDIATION: $Remediation" | Write-Log
$Remediation
}
####################################################
# https://devblogs.microsoft.com/scripting/use-function-to-determine-elevation-of-powershell-console/
# Returns True if Admin, False if not
Function Test-IsAdmin {
<#
.SYNOPSIS
Determines if script is being ran in elevated (admin) context
.DESCRIPTION
Required by script to create firewall rules
.EXAMPLE
Test-IsAdmin
.NOTES
NAME: Test-IsAdmin
#>
# https://docs.microsoft.com/en-us/dotnet/api/system.security.principal.windowsbuiltinrole?view=net-6.0
# BUILTIN\Administrators = 544
Set-Variable ADMINISTRATORS -Option ReadOnly -Value 544
([Security.Principal.WindowsPrincipal] `
[Security.Principal.WindowsIdentity]::GetCurrent() `
).IsInRole($ADMINISTRATORS)
}
####################################################
function Get-AuthToken {
<#
.SYNOPSIS
This function is used to authenticate with the Graph API REST interface
.DESCRIPTION
The function authenticate with the Graph API Interface with the tenant name
.EXAMPLE
Get-AuthToken
Authenticates you with the Graph API interface
.NOTES
NAME: Get-AuthToken
#>
[cmdletbinding()]
param
(
[Parameter(Mandatory = $true)]
$User
)
$userUpn = New-Object "System.Net.Mail.MailAddress" -ArgumentList $User
$tenant = $userUpn.Host
Write-Host "Checking for AzureAD module..."
$AadModule = Get-Module -Name "AzureAD" -ListAvailable
if ($null -eq $AadModule) {
Write-Host "AzureAD PowerShell module not found, looking for AzureADPreview"
$AadModule = Get-Module -Name "AzureADPreview" -ListAvailable
}
if ($null -eq $AadModule) {
Write-Host
Write-Host "AzureAD Powershell module not installed..." -f Red
Write-Host "Install by running 'Install-Module AzureAD' or 'Install-Module AzureADPreview' from an elevated PowerShell prompt" -f Yellow
Write-Host "Script can't continue..." -f Red
Write-Host
exit
}
# Getting path to ActiveDirectory Assemblies
# If the module count is greater than 1 find the latest version
if ($AadModule.count -gt 1) {
$Latest_Version = ($AadModule | Select-Object version | Sort-Object)[-1]
$aadModule = $AadModule | Where-Object { $_.version -eq $Latest_Version.version }
# Checking if there are multiple versions of the same module found
if ($AadModule.count -gt 1) {
$aadModule = $AadModule | Select-Object -Unique
}
$adal = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.dll"
$adalforms = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.Platform.dll"
}
else {
$adal = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.dll"
$adalforms = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.Platform.dll"
}
[System.Reflection.Assembly]::LoadFrom($adal) | Out-Null
[System.Reflection.Assembly]::LoadFrom($adalforms) | Out-Null
$clientId = "d1ddf0e4-d672-4dae-b554-9d5bdfd93547"
$redirectUri = "urn:ietf:wg:oauth:2.0:oob"
$resourceAppIdURI = "https://graph.microsoft.com"
$authority = "https://login.microsoftonline.com/$Tenant"
try {
$authContext = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext" -ArgumentList $authority
# https://msdn.microsoft.com/en-us/library/azure/microsoft.identitymodel.clients.activedirectory.promptbehavior.aspx
# Change the prompt behaviour to force credentials each time: Auto, Always, Never, RefreshSession
$platformParameters = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.PlatformParameters" -ArgumentList "Auto"
$userId = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier" -ArgumentList ($User, "OptionalDisplayableId")
$authResult = $authContext.AcquireTokenAsync($resourceAppIdURI, $clientId, $redirectUri, $platformParameters, $userId, "prompt=admin_consent").Result
if ($authResult.AccessToken) {
# Creating header for Authorization token
$authHeader = @{
'Content-Type' = 'application/json'
'Authorization' = "Bearer " + $authResult.AccessToken
'ExpiresOn' = $authResult.ExpiresOn
}
return $authHeader
}
else {
Write-Host
Write-Host "Authorization Access Token is null, please re-run authentication..." -ForegroundColor Red
Write-Host
break
}
}
catch {
Write-Host $_.Exception.Message -f Red
Write-Host $_.Exception.ItemName -f Red
Write-Host
break
}
}
####################################################
function Get-LeafProperty {
<#
.SYNOPSIS
Parses JSON objects
.DESCRIPTION
Returns values given a KVP JSON object
.EXAMPLE
Get-LeafProperty
.NOTES
NAME: Get- LeafProperty
https://stackoverflow.com/questions/64187004/powershell-selecting-noteproperty-type-objects-from-object
#>
param([Parameter(ValueFromPipeline)] [object] $InputObject, [string] $NamePath)
process {
if ($null -eq $InputObject -or $InputObject -is [DbNull] -or $InputObject.GetType().IsPrimitive -or $InputObject.GetType() -in [string], [datetime], [datetimeoffset], [decimal], [bigint]) {
# A null-like value or a primitive / quasi-primitive type -> output.
# Note: Returning a 2-element ValueTuple would result in better performance, both time- and space-wise:
# [ValueTuple]::Create($NamePath, $InputObject)
[pscustomobject] @{ NamePath = $NamePath; Value = $InputObject }
} elseif ($InputObject -is [System.Collections.IEnumerable] -and $InputObject -isnot [System.Collections.IDictionary]) {
# A collection of sorts (other than a string or dictionary (hash table)),
# recurse on its elements.
$i = 0
foreach ($o in $InputObject) { Get-LeafProperty $o ($NamePath + '[' + $i++ + ']') }
} else {
# A non-quasi-primitive scalar object or a dictionary:
# enumerate its properties / entries.
$props = if ($InputObject -is [System.Collections.IDictionary]) { $InputObject.GetEnumerator() } else { $InputObject.psobject.properties }
$sep = '.' * ($NamePath -ne '')
foreach ($p in $props) {
Get-LeafProperty $p.Value ($NamePath + $sep + $p.Name)
}
}
}
}
####################################################
function Write-BadRule {
<#
.SYNOPSIS
Records rules in error
.DESCRIPTION
Given a firewall rule, creates a reporting string based on known patterns and exceptions reported by the Defender service
.EXAMPLE
Write-BadRule
.NOTES
NAME: Write-BadRule
#>
param(
$FWRule,
$ExceptionInfo = "",
$DetectedPathIssues = " ",
$PolicyName = "Unknown",
$SuggestedFix
)
$ExceptionType = "Unknown"
if ($ExceptionInfo) { $ExceptionType = $ExceptionInfo }
$pathIssuesString = $DetectedPathIssues | Out-String
$newReport = New-RuleCheckResult -FWRuleName $FWRule.DisplayName -result "Failed" -Exception $ExceptionType -PatternsDetected $pathIssuesString -PolicyName $PolicyName -SuggestedFix $SuggestedFix
$global:detectedErrors += $newReport
}
####################################################
function New-RuleCheckResult {
<#
.SYNOPSIS
Helper function to return a formatted rule output object
.DESCRIPTION
Returns a rule result object for reporting
.EXAMPLE
New-RuleCheckResult
.NOTES
NAME: New-RuleCheckResult
#>
[CmdletBinding()]
param(
[string] [Parameter(Mandatory = $true)] $FWRuleName,
[string] $Exception,
[string] [ValidateSet("Passed", "Warning", "Failed", "Information")] $result,
[string] $PatternsDetected,
[string] $PolicyName = "Unknown",
$SuggestedFix
)
$RuleResult = [PSCustomObject] [Ordered] @{
'Policy name' = $PolicyName
'Firewall Rule Name' = $FWRuleName
'Exception' = $Exception
'Test Result' = $result
'Patterns Detected' = $PatternsDetected
'Suggested fix' = $SuggestedFix
}
return $RuleResult
}
####################################################
function New-HTMLReport {
<#
.SYNOPSIS
Generates HTML report
.DESCRIPTION
Creates HTML output based on rule results
.EXAMPLE
New-HTMLReport
.NOTES
NAME: New-HTMLReport
#>
Param ($resultBlob)
$head = @'
<style>
body { background-color:#ffffff;
font-family:Tahoma;
font-size:12pt; }
table {
border-spacing: 0;
width: 100%;
border: 1px solid #ddd;
margin: auto;
}
th {
background-color: #6495ED;
cursor: pointer;
}
th, td {
border: 1px solid #ddd;
text-align: left;
padding: 10px;
}
td.green { color: green; }
td.orange { color: orange; }
td.red { color: red; }
.active {
color: #efefef;
font-style: italic;
}
.filterList {
border: 1px solid #ddd;
display: inline-block;
margin: 4px 0px;
padding: 8px;
}
.filterList h4 {
margin: 0px 2px;
}
</style>
'@
$preContent = @'
<h1>Firewall rules with errors</h1>
'@
$script = @'
<script>
window.onload = function() {
if (document.querySelectorAll('tr th').length != 0) {
const headings = document.querySelectorAll('tr th');
const col = Array.from(headings).find(hd => hd.innerHTML === "Test Result");
const inx = Array.from(col.parentNode.children).indexOf(col);
const cells = col.closest('table').querySelectorAll(`td:nth-child(${inx+1})`);
}
else {
var table = document.querySelector('table');
var tableRow = table.insertRow(-1);
tableRow.innerHTML = "<td bgcolor=#6495ed>No errors detected in firewall rules.</td>";
}
Array.from(cells).map((td) => {
switch (td.innerHTML) {
case "Passed":
td.classList.add("green")
break
case "Warning":
td.classList.add("orange")
break
case "Failed":
td.classList.add("red")
break
}
})
Array.from(headings).map((hd) => {
hd.addEventListener('click', (e) => {
sortTable(e.target.cellIndex)
activeColumn(e)
})
})
}
function activeColumn(e) {
const headings = document.querySelectorAll('tr th')
const col = Array.from(headings).map(hd => hd.classList.remove('active'))
e.target.classList.add('active')
}
function sortTable(n) {
var table, rows, switching, i, x, y, shouldSwitch, dir, switchcount = 0;
table = document.querySelector('table')
switching = true;
//Set the sorting direction to ascending:
dir = "asc";
/*Make a loop that will continue until
no switching has been done:*/
while (switching) {
//start by saying: no switching is done:
switching = false;
rows = table.rows;
/*Loop through all table rows (except the
first, which contains table headers):*/
for (i = 1; i < (rows.length - 1); i++) {
//start by saying there should be no switching:
shouldSwitch = false;
/*Get the two elements you want to compare,
one from current row and one from the next:*/
x = rows[i].getElementsByTagName("TD")[n];
y = rows[i + 1].getElementsByTagName("TD")[n];
/*check if the two rows should switch place,
based on the direction, asc or desc:*/
if (dir == "asc") {
if (x.innerHTML.toLowerCase() > y.innerHTML.toLowerCase()) {
//if so, mark as a switch and break the loop:
shouldSwitch= true;
break;
}
} else if (dir == "desc") {
if (x.innerHTML.toLowerCase() < y.innerHTML.toLowerCase()) {
//if so, mark as a switch and break the loop:
shouldSwitch = true;
break;
}
}
}
if (shouldSwitch) {
/*If a switch has been marked, make the switch
and mark that a switch has been done:*/
rows[i].parentNode.insertBefore(rows[i + 1], rows[i]);
switching = true;
//Each time a switch is done, increase this count by 1:
switchcount ++;
} else {
/*If no switching has been done AND the direction is "asc",
set the direction to "desc" and run the while loop again.*/
if (switchcount == 0 && dir == "asc") {
dir = "desc";
switching = true;
}
}
}
}
function filterTable() {
const checkboxes = document.querySelectorAll('input[name="filter"]:checked')
const table = document.querySelector('table')
const headings = table.querySelectorAll('tr th')
const col = Array.from(headings).find(hd => hd.innerHTML === "Test Result")
const inx = Array.from(col.parentNode.children).indexOf(col)
const trs = table.querySelectorAll('tr')
const filters = Array.from(checkboxes).map(chbx => chbx.value )
if (filters.length === 0) {
resetTableRows(trs)
}
else {
Array.from(trs).map((tr) => {
let td = tr.querySelectorAll('td')[inx]
if (td) {
if (filters.includes(td.innerHTML.toLowerCase())) {
// display row
tr.style.display = ""
}
else {
// hide row
tr.style.display = "none"
}
}
})
}
}
function resetTableRows(trs) {
// reset rows for all to display
Array.from(trs).map((tr) => {
tr.style.display = ""
})
}
</script>
'@
$html = $resultBlob | ConvertTo-Html -Head $head -Body $script -PreContent $preContent
$now = (Get-Date).ToString("ddMMyyyyhhmmss")
$HTMLFileName = Join-Path $env:temp "FirewallRuleTests-$now.html"
$html | Out-File -FilePath $HTMLFileName -Force
$HTMLFileName
}
####################################################
function Test-FirewallRuleCreatesSuccessfully {
<#
.SYNOPSIS
Creates a disabled firewall rule given JSON definition of a FW rule
.DESCRIPTION
Return a command line for the New-NetFirewallRule cmdlet based on JSON data
.EXAMPLE
Test-FirewallRuleCreatesSuccessfully
.NOTES
NAME: Test-FirewallRuleCreatesSuccessfully
#>
param( $FWRuleToCreate,
$DetectedPathIssues,
$PolicyName = "Unknown" )
# support both object and JSON formats
if ($FWRuleToCreate.GetType().Name -eq "String") {
$FWRuleToCreate = $FWRuleToCreate | ConvertFrom-Json
}
# Get the list of populated properties to create the test rule from
$PopulatedProperties = $FWRuleToCreate | Get-LeafProperty | Where-Object { ("" -ne $_.Value) -and ($null -ne $_.Value) }
$ConstructedCommandLineArgs = @{}
# for logging
$tabs = "`t" * 3
$stars = '*' * 80
$pluses = '+' * 80
# always create the rule disabled so that we don't inadvertantly block traffic
$enabled = [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Enabled]::False
$testString = "____MSTestRule_DeleteMe____"
$errMsg = ""
# hash of object properties to match against the corresponding Net-NetFirewallRule command line switches
$PropertyToSwitchMapping = @{
displayName = "DisplayName"
description = "Description"
trafficDirection = "Direction"
action = "Action"
packageFamilyName = "Package"
filePath = "Program"
serviceName = "Service"
protocol = "Protocol"
localUserAuthorizations = "LocalUser"
}
foreach ($PopulatedProperty in $PopulatedProperties) {
$CommandLineSwitch = $PopulatedProperty.NamePath
"$CommandLineSwitch" | Out-String | Write-Log
$argument = $PopulatedProperty.Value
if ($argument -eq "notConfigured") {
"Skipping notConfigured value $CommandLineSwitch" | Write-Log
}
else {
switch -Wildcard ($CommandLineSwitch) {
'useAnyLocalAddressRange' {
$useAnyLocalAddressRange = $ConstructedCommandLineArgs[$CommandLineSwitch]
"$useAnyLocalAddressRange " | Write-Log
if ( ($null -eq $useAnyLocalAddressRange) -or ($useAnyLocalAddressRange -eq "") ) {
"Skipping empty value for useAnyLocalAddressRange" | Write-Log -Level Verbose
} else {
$ConstructedCommandLineArgs['LocalAddress'] = "Any"
}
}
'useAnyRemoteAddressRange' {
$useAnyRemoteAddressRange = $ConstructedCommandLineArgs[$CommandLineSwitch]
"$useAnyRemoteAddressRange " | Write-Log
if ( ($null -eq $useAnyRemoteAddressRange) -or ($useAnyRemoteAddressRange -eq "") ) {
"Skipping empty value for useAnyRemoteAddressRange" | Write-Log -Level Verbose
} else {
$ConstructedCommandLineArgs['RemoteAddress'] = "Any"
}
}
'DisplayName' {
# create unique display names so we don't duplicate existing rules
[string]$testName = $testString + $argument
$ConstructedCommandLineArgs['DisplayName'] = $testname
}
"actualRemoteAddressRanges*" {
$ipRanges = $FWRuleToCreate.actualremoteaddressranges
$ipAddressRanges = @()
foreach ($ipRange in $ipRanges) {
$ipAddressRanges += $ipRange
}
$ConstructedCommandLineArgs['RemoteAddress'] = $ipAddressRanges
}
'actualLocalAddressRanges*' {
$ipRanges = $FWRuleToCreate.actualLocaladdressranges
$ipAddressRanges = @()
foreach ($ipRange in $ipRanges) {
$ipAddressRanges += $ipRange
}
foreach ($ipRange in $ipRanges) {
$ConstructedCommandLineArgs['LocalAddress'] = $ipAddressRanges
}
}
'profileTypes*' {
$ProfileTypes = $FWRuleToCreate.profileTypes
$profileEnum = @()
foreach ($ProfileType in $ProfileTypes) {
switch ($ProfileType) {
"Domain" { $profileEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Profile]::Domain }
"Private" { $profileEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Profile]::Private }
"Public" { $profileEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Profile]::Public }
"NotApplicable" { $profileEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Profile]::NotApplicable }
}
}
$ConstructedCommandLineArgs['Profile'] = $ProfileEnum
}
'action' {
$Actions = $FWRuleToCreate.Action
$ActionsEnum = ""
foreach ($Action in $Actions) {
"Action: $action" | Write-Log
switch ($Action) {
"NotConfigured" { $ActionsEnum = [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Action]::NotConfigured }
"Allowed" { $ActionsEnum = [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Action]::Allow }
"Blocked" { $ActionsEnum = [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Action]::Block }
}
}
$ConstructedCommandLineArgs['Action'] = $ActionsEnum
}
'interfaceTypes*' {
$interfaceTypes = $FWRuleToCreate.interfaceTypes
$interfaceTypeEnum = @()
foreach ($interfaceType in $interfaceTypes) {
"interfaceType: $interfaceType" | Write-Log -WriteStdOut
switch ($interfaceType) {
"Any" { $interfaceTypeEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.InterfaceType]::Any }
"Lan" { $interfaceTypeEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.InterfaceType]::Wired }
"wireless" { $interfaceTypeEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.InterfaceType]::Wireless }
"remoteAccess" { $interfaceTypeEnum += [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.InterfaceType]::RemoteAccess }
}
}
$ConstructedCommandLineArgs['interfaceType'] = $interfaceTypeEnum
}
'*PortRanges*' {
# either localPortRanges or remotePortRanges
# Name fixup from Get-LeafProperty data
$localRemoteCommandLineSwitch = $CommandLineSwitch -replace "\[\d+\]$", ""
"Port range rule $localRemoteCommandLineSwitch" | Write-Log -WriteStdOut
$PortRangesTypes = $FWRuleToCreate.$localRemoteCommandLineSwitch
$PortRangesEnum = @()
foreach ($PortRange in $PortRangesTypes) {
"PortRanges: $PortRange" | Write-Log
$PortRangesEnum += $PortRange
}
$PortCmdArg = $localRemoteCommandLineSwitch -replace "(.+)Ranges.*", "`$1"
$ConstructedCommandLineArgs[$PortCmdArg] = $PortRangesEnum
}
Default {
if ("" -eq $CommandLineSwitch){
"Skipping null value for command line switch" | Write-Log
}
else {
$hashValue = $PropertyToSwitchMapping[$CommandLineSwitch]
if ($hashValue){
$ConstructedCommandLineArgs[$hashValue] = $argument
}
else {
write-host "unknown mapping $CommandLineSwitch"
}
}
}
}
}
}
# string interpolation for logging
$nnfwrule = ($ConstructedCommandLineArgs | Format-List | Out-String) -replace "(\r\n)+", " "
$nnfwrule = $nnfwrule -replace "Value\s+:\s+", ""
$nnfwrule = $nnfwrule -replace "Name : ", "-"
"Running command (spaces will be quoted):`r`n`r`n$tabs New-NetFirewallRule $nnfwrule -Enabled $enabled`r`n" | Write-Log
try {
$dispName = $ConstructedCommandLineArgs["displayName"] -replace $testString, ""
$null = New-NetFirewallRule @ConstructedCommandLineArgs -Enabled $enabled -ErrorAction "Stop"
"`r`n$tabs$pluses`r`n$tabs Successfully created rule. Name: $dispName`r`n`r`n" | Write-Log
} catch {
[string]$Remediation = ""
$errMsg = $error[0]
"`r`n$tabs$stars`r`n`r`n$tabs Exception creating rule. Name: $dispName`: $errMsg`r`n`r`n$tabs$stars`r`n" | Write-Log -WriteStdOut
$Remediation = Get-SuggestedAction -ExceptionInfo $errMsg -DetectedPathIssues $DetectedPathIssues -FilePath $ConstructedCommandLineArgs.program `
-Port ( ($ConstructedCommandLineArgs.localPort) + ($ConstructedCommandLineArgs.RemotePort)) -Protocol $ConstructedCommandLineArgs.protocol
Write-BadRule -FWRule $FWRuleToCreate -ExceptionInfo $errMsg -DetectedPathIssues $DetectedPathIssues -PolicyName $PolicyName -SuggestedFix $Remediation
} finally {
# Catch condition where rule creates successfully but have detected a bad path
if ( ($errMsg -eq "") -and ($DetectedPathIssues.count -gt 0) ) {
[string]$Remediation = ""
"Bad path regex found in $dispName" | Write-Log -Level Warning
$DetectedPathIssues | Write-Log -Level Warning
$Remediation = Get-SuggestedAction -ExceptionInfo $errMsg -DetectedPathIssues $DetectedPathIssues -FilePath $ConstructedCommandLineArgs.program `
-Port ( ($ConstructedCommandLineArgs.localPort) + ($ConstructedCommandLineArgs.RemotePort)) -Protocol $ConstructedCommandLineArgs.protocol
Write-BadRule -FWRule $FWRuleToCreate -ExceptionInfo $errMsg -DetectedPathIssues $DetectedPathIssues -PolicyName $PolicyName -SuggestedFix $Remediation
}
}
}
####################################################
function Remove-TestFirewallRules {
<#
.SYNOPSIS
Cleans up test firewall rules created during rule creation
.DESCRIPTION
Deletes firewall rules named "*____MSTestRule_DeleteMe____*"
.EXAMPLE
Remove-TestFirewallRules
.NOTES
NAME: Remove-TestFirewallRules
#>
$allLocalFWRules = Get-NetFirewallRule
$testString = "____MSTestRule_DeleteMe____"