Module/STIG/Functions.Checklist.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 |
# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. # Header <# .SYNOPSIS Automatically creates a STIG Viewer checklist from DSC results (DscResults) or a compiled MOF (ReferenceConfiguration) parameter for a single endpoint. The function will test based upon the passed in STIG file or files (XccdfPath) parameter. Manual entries in the checklist can be injected from a ManualChecklistEntriesFile file. .PARAMETER ReferenceConfiguration A MOF that was compiled with a PowerStig composite. This parameter supports an alias of 'MofFile' .PARAMETER DscResults The results of Test-DscConfiguration or DSC report server output for a node. This can also be data retrieved from a DSC pull server with some modifications. See the PowerSTIG wiki for more information. .PARAMETER XccdfPath The path to a DISA STIG .xccdf file. PowerSTIG includes the supported files in the /PowerShell/StigData/Archive folder. .PARAMETER OutputPath The location where the checklist .ckl file will be created. Must include the filename with .ckl on the end. .PARAMETER ManualChecklistEntriesFile Location of a .xml file containing the input for Vulnerabilities unmanaged via DSC/PowerSTIG. This file can be created manually or by exporting an Excel worksheet as XML. The file format should look like the following: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <stigManualChecklistData> <stigRuleData> <STIG>U_Windows_Firewall_STIG_V1R7_Manual-xccdf.xml</STIG> <ID>V-36440</ID> <Status>NotAFinding</Status> <Comments>Not Applicable</Comments> <Details>This machine is not part of a domain, so this rule does not apply.</Details> </stigRuleData> See a sample at /PowerShell/StigData/Samples/ManualChecklistEntriesFileSample.xml. .EXAMPLE Generate a checklist for single STIG using a .MOF file: $ReferenceConfiguration = 'C:\contoso.local.mof' $xccdfPath = 'C:\SQL Server\U_MS_SQL_Server_2016_Instance_STIG_V1R7_Manual-xccdf.xml' $outputPath = 'C:\SqlServerInstance_2016_V1R7_STIG_config_mof.ckl' $ManualChecklistEntriesFile = 'C:\ManualChecklistEntriesFileExcelExport.xml' New-StigCheckList -ReferenceConfiguration $ReferenceConfiguration -XccdfPath $XccdfPath -OutputPath $outputPath -ManualChecklistEntriesFile $ManualChecklistEntriesFile .EXAMPLE Generate a checklist for a single STIG using DSC results obtained from Test-DscConfiguration: $audit = Test-DscConfiguration -ComputerName localhost -ReferenceConfiguration 'C:\Dev\Utilities\SqlServerInstance_config\localhost.mof' $xccdfPath = 'C:\U_MS_SQL_Server_2016_Instance_STIG_V1R7_Manual-xccdf.xml' $outputPath = 'C:\SqlServerInstance_2016_V1R7_STIG_config_dscresults.ckl' $ManualChecklistEntriesFile = 'C:\ManualChecklistEntriesFileSQL2016Instance.xml' New-StigCheckList -DscResult $audit -XccdfPath $xccdfPath -OutputPath $outputPath -ManualChecklistEntriesFile $ManualChecklistEntriesFile .EXAMPLE Generate a checklist for multiple STIGs for an endpoint using a .MOF file and a file containing STIGs to check: $XccdfPath = Get-Content 'C:\ChecklistSTIGFiles.txt' $outputPath = 'C:\SqlServer01_mof.ckl' $ManualChecklistEntriesFile = 'C:\ManualChecklistEntriesFileSqlServer01ExcelExport.xml' New-StigCheckList -DscResults $auditRehydrated -XccdfPath $XccdfPath -OutputPath $outputPath -ManualChecklistEntriesFile $ManualChecklistEntriesFile .EXAMPLE Generate a checklist for multiple STIGs for an endpoint using DSC results obtained from Test-DscConfiguration, dehydrated/rehydrated using CLIXML: $audit = Test-DscConfiguration -ComputerName localhost -MofFile 'C:\localhost.mof' $audit | Export-Clixml 'C:\TestDSC.xml' $auditRehydrated = import-clixml C:\TestDSC.xml $XccdfPath = 'C:\STIGS\SQL Server\U_MS_SQL_Server_2016_Instance_STIG_V1R7_Manual-xccdf.xml','C:\STIGS\Windows.Server.2012R2\U_MS_Windows_2012_and_2012_R2_DC_STIG_V2R19_Manual-xccdf.xml' $outputPath = 'C:\SqlServer01_dsc.ckl' $ManualChecklistEntriesFile = 'C:\ManualChecklistEntriesFileSqlServer01ExcelExport.xml' New-StigCheckList -DscResults $auditRehydrated -XccdfPath $XccdfPath -OutputPath $outputPath -ManualChecklistEntriesFile $ManualChecklistEntriesFile #> function New-StigCheckList { [CmdletBinding()] [OutputType([XML])] param ( [Parameter(Mandatory = $true, ParameterSetName = 'mof')] [Alias('MofFile')] [ValidateNotNullOrEmpty()] [ValidateScript( { if (Test-Path -Path $_ -PathType Leaf) { return $true } else { throw "$($_) is not a valid path to a reference configuration (.mof) file. Provide a full valid path and filename." } } )] [String] $ReferenceConfiguration, [Parameter(Mandatory = $true, ParameterSetName = 'dsc')] [PSObject] $DscResults, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [ValidateScript( { foreach ($filename in $_) { if (Test-Path -Path $filename -PathType Leaf) { return $true } else { throw "$($filename) is not a valid path to a DISA STIG .xccdf file. Provide a full valid path and filename." } } } )] [String[]] $XccdfPath, [Parameter()] [ValidateNotNullOrEmpty()] [ValidateScript( { if (Test-Path -Path $_ -PathType Leaf) { return $true } else { throw "$($_) is not a valid path to a Manual Checklist Entries File file. Provide a full valid path and filename." } } )] [String] $ManualChecklistEntriesFile, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [ValidateScript( { if (Test-Path -Path $_.DirectoryName -PathType Container) { return $true } else { throw "$($_) is not a valid directory. Please provide a valid directory." } if ($_.Extension -ne '.ckl') { throw "$($_.FullName) is not a valid checklist extension. Please provide a full valid path ending in .ckl" } else { return $true } } )] [System.IO.FileInfo] $OutputPath, [Parameter()] [String] $Verifier ) if ($PSBoundParameters.ContainsKey('ManualChecklistEntriesFile')) { $manualCheckData = ConvertTo-ManualCheckListHashTable -Path $ManualChecklistEntriesFile -XccdfPath $XccdfPath } # Values for some of these fields can be read from the .mof file or the DSC results file if ($PSCmdlet.ParameterSetName -eq 'mof') { $mofString = Get-Content -Path $ReferenceConfiguration -Raw $targetNode = Get-TargetNodeFromMof -MofString $mofString } elseif ($PSCmdlet.ParameterSetName -eq 'dsc') { # Check the returned object if ($null -eq $DscResults) { throw 'Passed in $DscResults parameter is null. Please provide a valid result using Test-DscConfiguration.' } $targetNode = $DscResults.PSComputerName } $statusMap = @{ NotReviewed = 'Not_Reviewed' Open = 'Open' NotAFinding = 'NotAFinding' NotApplicable = 'Not_Applicable' } $targetNodeType = Get-TargetNodeType -TargetNode $targetNode switch ($targetNodeType) { "MACAddress" { $HostnameMACAddress = $targetNode break } "IPv4Address" { $HostnameIPAddress = $targetNode break } "IPv6Address" { $HostnameIPAddress = $targetNode break } "FQDN" { $HostnameFQDN = $targetNode break } default { $Hostname = $targetNode } } $xmlWriterSettings = [System.Xml.XmlWriterSettings]::new() $xmlWriterSettings.Indent = $true $xmlWriterSettings.IndentChars = "`t" $xmlWriterSettings.NewLineChars = "`n" $writer = [System.Xml.XmlWriter]::Create($OutputPath.FullName, $xmlWriterSettings) $writer.WriteStartElement('CHECKLIST') #region ASSET $writer.WriteStartElement("ASSET") $assetElements = [ordered] @{ 'ROLE' = 'None' 'ASSET_TYPE' = 'Computing' 'HOST_NAME' = "$Hostname" 'HOST_IP' = "$HostnameIPAddress" 'HOST_MAC' = "$HostnameMACAddress" 'HOST_FQDN' = "$HostnameFQDN" 'TECH_AREA' = '' 'TARGET_KEY' = '2350' 'WEB_OR_DATABASE' = 'false' 'WEB_DB_SITE' = '' 'WEB_DB_INSTANCE' = '' } foreach ($assetElement in $assetElements.GetEnumerator()) { $writer.WriteStartElement($assetElement.name) $writer.WriteString($assetElement.value) $writer.WriteEndElement() } $writer.WriteEndElement(<#ASSET#>) #endregion ASSET #region STIGS $writer.WriteStartElement("STIGS") #region STIG_iteration foreach ($xccdfPathItem in $XccdfPath) { $writer.WriteStartElement("iSTIG") #region iSTIG/STIG_INFO $writer.WriteStartElement("STIG_INFO") $xccdfBenchmarkContent = Get-StigXccdfBenchmarkContent -Path $XccdfPathItem $stigInfoElements = [ordered] @{ 'version' = $xccdfBenchmarkContent.version 'classification' = 'UNCLASSIFIED' 'customname' = '' 'stigid' = $xccdfBenchmarkContent.id 'description' = $xccdfBenchmarkContent.description 'filename' = Split-Path -Path $xccdfPathItem -Leaf 'releaseinfo' = $xccdfBenchmarkContent.'plain-text'.InnerText 'title' = $xccdfBenchmarkContent.title 'uuid' = (New-Guid).Guid 'notice' = $xccdfBenchmarkContent.notice.InnerText 'source' = $xccdfBenchmarkContent.reference.source } foreach ($stigInfoElement in $stigInfoElements.GetEnumerator()) { $writer.WriteStartElement("SI_DATA") $writer.WriteStartElement('SID_NAME') $writer.WriteString($stigInfoElement.name) $writer.WriteEndElement(<#SID_NAME#>) $writer.WriteStartElement('SID_DATA') $writer.WriteString($stigInfoElement.value) $writer.WriteEndElement(<#SID_DATA#>) $writer.WriteEndElement(<#SI_DATA#>) } $writer.WriteEndElement(<#STIG_INFO#>) #endregion STIGS/iSTIG/STIG_INFO #region STIGS/iSTIG/VULN[] # Parse out the STIG file name for lookups $stigPathFileName = $XccdfPathItem.Split('\\') $stigFileName = $stigPathFileName[$stigPathFileName.Length-1] # Pull in the processed XML file to check for duplicate rules for each vulnerability [XML] $xccdfBenchmark = Get-Content -Path $xccdfPathItem -Encoding UTF8 $fileList = Get-PowerStigFileList -StigDetails $xccdfBenchmark -Path $XccdfPathItem $processedFileName = $fileList.Settings.FullName [XML] $processed = Get-Content -Path $processedFileName $vulnerabilities = Get-VulnerabilityList -XccdfBenchmark $xccdfBenchmarkContent foreach ($vulnerability in $vulnerabilities) { $writer.WriteStartElement("VULN") foreach ($attribute in $vulnerability.GetEnumerator()) { $status = $null $findingDetails = $null $comments = $null $manualCheck = $null if ($attribute.Name -eq 'Vuln_Num') { $vid = $attribute.Value } $writer.WriteStartElement("STIG_DATA") $writer.WriteStartElement("VULN_ATTRIBUTE") $writer.WriteString($attribute.Name) $writer.WriteEndElement(<#VULN_ATTRIBUTE#>) $writer.WriteStartElement("ATTRIBUTE_DATA") $writer.WriteString($attribute.Value) $writer.WriteEndElement(<#ATTRIBUTE_DATA#>) $writer.WriteEndElement(<#STIG_DATA#>) } if ($PSCmdlet.ParameterSetName -eq 'mof') { $setting = Get-SettingsFromMof -ReferenceConfiguration $ReferenceConfiguration -Id $vid $manualCheck = $manualCheckData | Where-Object -FilterScript {$_.STIG -eq $stigFileName -and $_.ID -eq $vid} if ($setting) { $status = $statusMap['Open'] $comments = "To be addressed by PowerStig MOF via $setting" $findingDetails = Get-FindingDetails -Setting $setting } elseif ($manualCheck) { $status = $statusMap["$($manualCheck.Status)"] $findingDetails = $manualCheck.Details $comments = $manualCheck.Comments } else { $status = $statusMap['NotReviewed'] } } elseif ($PSCmdlet.ParameterSetName -eq 'dsc') { $manualCheck = $manualCheckData | Where-Object -FilterScript {$_.STIG -eq $stigFileName -and $_.ID -eq $vid} if ($manualCheck) { $status = $statusMap["$($manualCheck.Status)"] $findingDetails = $manualCheck.Details $comments = $manualCheck.Comments } else { $setting = Get-SettingsFromResult -DscResults $DscResults -Id $vid if ($setting) { if ($setting.InDesiredState -eq $true) { $status = $statusMap['NotAFinding'] if ($PSBoundParameters.ContainsKey('Verifier')) { $comments = "Addressed by PowerStig MOF via {0} and verified by {1}" -f $setting, $Verifier } else { $comments = "Addressed by PowerStig MOF via $setting" } $findingDetails = Get-FindingDetails -Setting $setting } elseif ($setting.InDesiredState -eq $false) { $status = $statusMap['Open'] $comments = "Configuration attempted by PowerStig MOF via $setting, but not currently set." $findingDetails = Get-FindingDetails -Setting $setting } else { $status = $statusMap['Open'] } } else { $status = $statusMap['NotReviewed'] } } } # Test to see if this rule is managed as a duplicate $convertedRule = $processed.SelectSingleNode("//Rule[@id='$vid']") if ($convertedRule.DuplicateOf) { # How is the duplicate rule handled? If it is handled, then this duplicate should have the same status if ($PSCmdlet.ParameterSetName -eq 'mof') { $originalSetting = Get-SettingsFromMof -ReferenceConfiguration $ReferenceConfiguration -Id $convertedRule.DuplicateOf if ($originalSetting) { $status = $statusMap['Open'] $findingDetails = 'See {0} for Finding Details.' -f $convertedRule.DuplicateOf $comments = 'Managed via PowerStigDsc - this rule is a duplicate of {0}' -f $convertedRule.DuplicateOf } } elseif ($PSCmdlet.ParameterSetName -eq 'dsc') { $originalSetting = Get-SettingsFromResult -DscResults $DscResults -Id $convertedRule.DuplicateOf if ($originalSetting.InDesiredState -eq 'True') { $status = $statusMap['NotAFinding'] $findingDetails = 'See {0} for Finding Details.' -f $convertedRule.DuplicateOf $comments = 'Managed via PowerStigDsc - this rule is a duplicate of {0}' -f $convertedRule.DuplicateOf } else { $status = $statusMap['Open'] $findingDetails = 'See {0} for Finding Details.' -f $convertedRule.DuplicateOf $comments = 'Managed via PowerStigDsc - this rule is a duplicate of {0}' -f $convertedRule.DuplicateOf } } } $writer.WriteStartElement("STATUS") $writer.WriteString($status) $writer.WriteEndElement(<#STATUS#>) $writer.WriteStartElement("FINDING_DETAILS") $findingDetails = ConvertTo-SafeXml -UnescapedXmlString $findingDetails $writer.WriteString($findingDetails) $writer.WriteEndElement(<#FINDING_DETAILS#>) $writer.WriteStartElement("COMMENTS") $comments = ConvertTo-SafeXml -UnescapedXmlString $comments $writer.WriteString($comments) $writer.WriteEndElement(<#COMMENTS#>) $writer.WriteStartElement("SEVERITY_OVERRIDE") $writer.WriteString('') $writer.WriteEndElement(<#SEVERITY_OVERRIDE#>) $writer.WriteStartElement("SEVERITY_JUSTIFICATION") $writer.WriteString('') $writer.WriteEndElement(<#SEVERITY_JUSTIFICATION#>) $writer.WriteEndElement(<#VULN#>) } #endregion STIGS/iSTIG/VULN[] $writer.WriteEndElement(<#iSTIG#>) } #endregion STIG_iteration $writer.WriteEndElement(<#STIGS#>) #endregion STIGS $writer.WriteEndElement(<#CHECKLIST#>) $writer.Flush() $writer.Close() } <# .SYNOPSIS Gets the vulnerability details from the rule description #> function Get-VulnerabilityList { [CmdletBinding()] [OutputType([XML])] param ( [Parameter()] [PSObject] $XccdfBenchmark ) [System.Collections.ArrayList] $vulnerabilityList = @() foreach ($vulnerability in $XccdfBenchmark.Group) { $vulnerabilityDiscussion = ConvertTo-SafeXml -UnescapedXmlString $($vulnerability.Rule.description) [XML] $vulnerabiltyDiscussionElement = "<discussionroot>$vulnerabilityDiscussion</discussionroot>" [void] $vulnerabilityList.Add( @( [PSCustomObject] @{Name = 'Vuln_Num'; Value = $vulnerability.id}, [PSCustomObject] @{Name = 'Severity'; Value = $vulnerability.Rule.severity}, [PSCustomObject] @{Name = 'Group_Title'; Value = $vulnerability.title}, [PSCustomObject] @{Name = 'Rule_ID'; Value = $vulnerability.Rule.id}, [PSCustomObject] @{Name = 'Rule_Ver'; Value = $vulnerability.Rule.version}, [PSCustomObject] @{Name = 'Rule_Title'; Value = $vulnerability.Rule.title}, [PSCustomObject] @{Name = 'Vuln_Discuss'; Value = $vulnerabiltyDiscussionElement.discussionroot.VulnDiscussion}, [PSCustomObject] @{Name = 'IA_Controls'; Value = $vulnerabiltyDiscussionElement.discussionroot.IAControls}, [PSCustomObject] @{Name = 'Check_Content'; Value = $vulnerability.Rule.check.'check-content'}, [PSCustomObject] @{Name = 'Fix_Text'; Value = $vulnerability.Rule.fixtext.InnerText}, [PSCustomObject] @{Name = 'False_Positives'; Value = $vulnerabiltyDiscussionElement.discussionroot.FalsePositives}, [PSCustomObject] @{Name = 'False_Negatives'; Value = $vulnerabiltyDiscussionElement.discussionroot.FalseNegatives}, [PSCustomObject] @{Name = 'Documentable'; Value = $vulnerabiltyDiscussionElement.discussionroot.Documentable}, [PSCustomObject] @{Name = 'Mitigations'; Value = $vulnerabiltyDiscussionElement.discussionroot.Mitigations}, [PSCustomObject] @{Name = 'Potential_Impact'; Value = $vulnerabiltyDiscussionElement.discussionroot.PotentialImpacts}, [PSCustomObject] @{Name = 'Third_Party_Tools'; Value = $vulnerabiltyDiscussionElement.discussionroot.ThirdPartyTools}, [PSCustomObject] @{Name = 'Mitigation_Control'; Value = $vulnerabiltyDiscussionElement.discussionroot.MitigationControl}, [PSCustomObject] @{Name = 'Responsibility'; Value = $vulnerabiltyDiscussionElement.discussionroot.Responsibility}, [PSCustomObject] @{Name = 'Security_Override_Guidance'; Value = $vulnerabiltyDiscussionElement.discussionroot.SeverityOverrideGuidance}, [PSCustomObject] @{Name = 'Check_Content_Ref'; Value = $vulnerability.Rule.check.'check-content-ref'.href}, [PSCustomObject] @{Name = 'Weight'; Value = $vulnerability.Rule.Weight}, [PSCustomObject] @{Name = 'Class'; Value = 'Unclass'}, [PSCustomObject] @{Name = 'STIGRef'; Value = "$($XccdfBenchmark.title) :: $($XccdfBenchmark.'plain-text'.InnerText)"}, [PSCustomObject] @{Name = 'TargetKey'; Value = $vulnerability.Rule.reference.identifier} # Some Stigs have multiple Control Correlation Identifiers (CCI) $( # Extract only the cci entries $CCIREFList = $vulnerability.Rule.ident | Where-Object -FilterScript {$PSItem.system -eq 'http://iase.disa.mil/cci'} | Select-Object 'InnerText' -ExpandProperty 'InnerText' foreach ($CCIREF in $CCIREFList) { [PSCustomObject] @{Name = 'CCI_REF'; Value = $CCIREF} } ) ) ) } return $vulnerabilityList } <# .SYNOPSIS Converts the mof into an array of objects #> function Get-MofContent { [CmdletBinding()] [OutputType([PSObject])] param ( [Parameter(Mandatory = $true)] [String] $ReferenceConfiguration ) if (-not $script:mofContent) { $script:mofContent = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ImportInstances($ReferenceConfiguration, 4) } return $script:mofContent } <# .SYNOPSIS Gets the stig details from the mof #> function Get-SettingsFromMof { [CmdletBinding()] [OutputType([PSObject])] param ( [Parameter(Mandatory = $true)] [String] $ReferenceConfiguration, [Parameter(Mandatory = $true)] [String] $Id ) $mofContent = Get-MofContent -ReferenceConfiguration $ReferenceConfiguration $mofContentFound = $mofContent.Where({$PSItem.ResourceID -match $Id}) return $mofContentFound } <# .SYNOPSIS Gets the stig details from the Test\Get-DscConfiguration output #> function Get-SettingsFromResult { [CmdletBinding()] [OutputType([PSObject])] param ( [Parameter(Mandatory = $true)] [PSObject] $DscResults, [Parameter(Mandatory = $true)] [String] $Id ) if (-not $script:allResources) { $script:allResources = $DscResults.ResourcesNotInDesiredState + $DscResults.ResourcesInDesiredState } return $script:allResources.Where({$PSItem.ResourceID -match $id}) } <# .SYNOPSIS Gets the value from a STIG setting #> function Get-FindingDetails { [OutputType([String])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [AllowNull()] [PSObject] $Setting ) switch ($setting.ResourceID) { # Only add custom entries if specific output is more valuable than dumping all properties {$PSItem -match "^\[None\]"} { return "No DSC resource was leveraged for this rule (Resource=None)" } {$PSItem -match "^\[UserRightsAssignment\]"} { return "UserRightsAssignment Identity = $($setting.Identity)" } default { return Get-FindingDetailsString -Setting $setting } } } <# .SYNOPSIS Formats properties and values with standard string format. #> function Get-FindingDetailsString { [OutputType([String])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [AllowNull()] [PSObject] $Setting ) foreach ($property in $setting.PSobject.properties) { if ($property.TypeNameOfValue -Match 'String') { $returnString += $($property.Name) + ' = ' $returnString += $($setting.PSobject.properties[$property.Name].Value) + "`n" } } return $returnString } <# .SYNOPSIS Extracts the node targeted by the MOF file #> function Get-TargetNodeFromMof { [OutputType([String])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $MofString ) $pattern = "((?<=@TargetNode=')(.*)(?='))" $targetNodeSearch = $MofString | Select-String -Pattern $pattern $targetNode = $targetNodeSearch.matches.value return $targetNode } <# .SYNOPSIS Determines the type of node address #> function Get-TargetNodeType { [OutputType([String])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] $TargetNode ) switch ($TargetNode) { # Do we have a MAC address? { $_ -match '(([0-9a-f]{2}:){5}[0-9a-f]{2})' } { return 'MACAddress' } # Do we have an IPv6 address? { $_ -match '(([0-9a-f]{0,4}:){7}[0-9a-f]{0,4})' } { return 'IPv4Address' } # Do we have an IPv4 address? { $_ -match '(([0-9]{1,3}\.){3}[0-9]{1,3})' } { return 'IPv6Address' } # Do we have a Fully-qualified Domain Name? { $_ -match '([a-zA-Z0-9-.\+]{2,256}\.[a-z]{2,256}\b)' } { return 'FQDN' } } return '' } <# .SYNOPSIS Escapes invalid characters in the input to create safe XML output. Note: Intended for contents of attributes, elements, etc. #> function ConvertTo-SafeXml { [OutputType([xml])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String] [AllowEmptyString()] $UnescapedXmlString ) $escapedXml = [System.Security.SecurityElement]::Escape($UnescapedXmlString) return $escapedXml } <# .SYNOPSIS Converts the xml or psd1 in to a consistent data structure (hashtable) for use with the New-StigCheckList function. .DESCRIPTION Converts the xml or psd1 in to a consistent data structure (hashtable) for use with the New-StigCheckList function. .PARAMETER Path Location of a .xml or .psd1 file containing the input for Vulnerabilities unmanaged via DSC/PowerSTIG i.e.: Document/Manual Rules. .PARAMETER XccdfPath The path to a DISA STIG .xccdf file. PowerSTIG includes the supported files in the /PowerShell/StigData/Archive folder. .EXAMPLE PS> ConvertTo-ManualCheckListHashTable -Path C:\dev\ManualEntryData.psd1 -XccdfPath $xccdfPath Returns a hashtable that constains checklist data that will be used to inject into the ckl in the New-StigCheckList function. .NOTES Internal use only function, not for Export-ModuleMember #> function ConvertTo-ManualCheckListHashTable { [OutputType([hashtable[]])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $Path, [Parameter(Mandatory = $true)] [string[]] $XccdfPath ) $fileDetail = Get-Item -Path $Path switch ($fileDetail.Extension) { '.xml' { # Import ManualCheckList xml contents to convert to hashtable to match psd1 back compat [xml] $xmlToConvert = Get-Content -Path $Path foreach ($stigRuleData in $xmlToConvert.stigManualChecklistData.stigRuleData) { $stigRuleManualCheck = @{} $stigRuleDataPropertyNames = (Get-Member -InputObject $stigRuleData -MemberType 'Property').Name foreach ($stigRuleDataPropertyName in $stigRuleDataPropertyNames) { $stigRuleManualCheck.Add($stigRuleDataPropertyName, $stigRuleData.$stigRuleDataPropertyName) } $stigRuleManualCheck } } '.psd1' { $formattedPsd1ToConvert = (Get-Content -Path $Path -Raw) -replace '"|@{' -split '}' $convertedPsd1HashTable = $formattedPsd1ToConvert | ConvertFrom-StringData foreach ($stigRuleManualCheck in $convertedPsd1HashTable) { if ($stigRuleManualCheck.Count -ne 0) { $stigFileName = Get-StigXccdfFileName -VulnId $stigRuleManualCheck.VulID -XccdfPath $XccdfPath $stigRuleManualCheck.Add('STIG', $stigFileName) $stigRuleManualCheck.Add('Details', $stigRuleManualCheck.Comments) $stigRuleManualCheck.Add('ID', $stigRuleManualCheck['VulId']) $stigRuleManualCheck.Remove('VulId') $stigRuleManualCheck } } } } } <# .SYNOPSIS Used to detect the correct STIG property when a psd1 is specified. .DESCRIPTION Used to detect the correct STIG property when a psd1 is specified. .PARAMETER VulnId The VulnId or RuleId for a given STIG Rule .PARAMETER XccdfPath The path to a DISA STIG .xccdf file. PowerSTIG includes the supported files in the /PowerShell/StigData/Archive folder. .EXAMPLE PS> Get-StigXccdfFileName -VulnId 'V-1114' -XccdfPath C:\PowerStig\StigData\Archive\Windows.Server.2012R2\U_MS_Windows_2012_and_2012_R2_DC_STIG_V2R19_Manual-xccdf.xml Returns U_MS_Windows_2012_and_2012_R2_DC_STIG_V2R19_Manual-xccdf.xml as the correct xccdf file specified by the user. .NOTES Internal use only function, not for Export-ModuleMember #> function Get-StigXccdfFileName { [CmdletBinding()] [OutputType([string])] param ( [Parameter(Mandatory = $true)] [string] $VulnId, [Parameter(Mandatory = $true)] [string[]] $XccdfPath ) $processedXmlPath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\StigData\Processed\*.xml' $processedXml = Select-String -Path $processedXmlPath -Pattern $VulnId -Exclude '*.org.default.xml' | Sort-Object -Property Pattern $stigVersionData = @() foreach ($xmlPath in $processedXml.Path) { [xml] $xml = Get-Content -Path $xmlPath $stigVersionData += [PSCustomObject] @{ Version = [version] $xml.DISASTIG.fullversion FileName = $xml.DISASTIG.filename } } # populate the STIG value based on Xccdf Path passed by user $compareObjectParams = @{ ReferenceObject = $(Split-Path -Path $XccdfPath -Leaf) DifferenceObject = $stigVersionData.FileName IncludeEqual = $true ExcludeDifferent = $true } $xccdfFileDetection = (Compare-Object @compareObjectParams).InputObject if ($xccdfFileDetection.Count -eq 1) { return $xccdfFileDetection } elseif ($xccdfFileDetection.Count -gt 1) { throw 'Unable to determine correct Xccdf file for psd1 usage, ensure that the correct Xccdf file(s) are used.' } else { return ($stigVersionData | Sort-Object -Property Version -Descending | Select-Object -First 1).FileName } } |