Module/STIG/STIG.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 |
# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. using module .\..\Common\Common.psm1 using module .\..\Rule\Rule.LoadFactory.psm1 using module .\..\Rule.Skip\Skip.psm1 # Header <# .SYNOPSIS This class describes a STIG .DESCRIPTION The STIG class describes a STIG, the collection of rules for a given technology that need to be implemented in order to enforce the security posture those rules define. STIG takes in instances of many other classes that describe the given technology and the implementing organizations specific settings, exceptions, and rules to skip. Upon creation of a STIG instance, the resulting Xml is immediately available for those preconditions. .PARAMETER StigVersion The document/published version of the Stig to select .PARAMETER Technology The type of the technology of the Stig to select .PARAMETER TechnologyRole The role of the technology of the Stig to select .PARAMETER TechnologyVersion The version of the technology of the Stig to select .PARAMETER StigXml The loaded Xml document of the Stig loaded from StigPath .PARAMETER StigPath The file path to the Stig Xml file in the StigData directory .EXAMPLE .NOTES This class requires PowerShell v5 or above. #> class STIG { [string] $Technology # this is aligned to a DSC composite resource. [string] $TechnologyVersion # this is 2012R2, 2016, etc. [string] $TechnologyRole # this is DC, MS, Database, Instance, etc. [Version] $Version # this is the version of the STIG hidden [string] $RuleFile # the file name of the processed rule file [System.Collections.ArrayList] $RuleList = @() # the STIG Rules hidden [hashtable] $RuleIdIndex = @{} # an index into $RuleList static $DataPath = (Resolve-Path -Path "$($script:PSScriptRoot)\..\..\StigData\Processed").Path #region Constructor hidden [STIG] _STIG ([string] $Technology, [string] $TechnologyVersion, [string] $TechnologyRole, [Version] $Version) { $this.Technology = $Technology $ruleFileString = $Technology $this.TechnologyVersion = $TechnologyVersion $ruleFileString += "-$TechnologyVersion" if (-not [string]::IsNullOrEmpty($TechnologyRole)) { $this.TechnologyRole = $TechnologyRole $ruleFileString += "-$TechnologyRole" } if ($null -eq $Version) { $this.Version = $this.GetLatest() } else { $this.Version = $Version } $ruleFileString += "-$($this.Version)" $this.RuleFile = [STIG]::DataPath + "\$ruleFileString`.xml" if (-not $this.Validate()) { throw "$ruleFileString was not found. Please run [Stig]::ListAvailable() to view the list of avalable STIG's." } return $this } <# .SYNOPSIS DO NOT USE - For testing only .DESCRIPTION A parameterless constructor for STIG. To be used only for build/unit testing purposes as Pester currently requires it in order to test static methods on powershell classes #> STIG () { Write-Warning "This constructor is for build testing only." } # STIG specification w/o role, return latest version or list available STIG ([string] $Technology, [string] $TechnologyVersion) { $this._STIG($Technology, $TechnologyVersion, $null, $null) } # Full STIG specification w/o role STIG ([string] $Technology, [string] $TechnologyVersion, [Version] $Version) { $this._STIG($Technology, $TechnologyVersion, $null, $Version) } # STIG specification w/ role, return latest version or list available STIG ([string] $Technology, [string] $TechnologyVersion, [string] $TechnologyRole) { $this._STIG($Technology, $TechnologyVersion, $TechnologyRole, $null) } # Full STIG specification w/ role STIG ([string] $Technology, [string] $TechnologyVersion, [string] $TechnologyRole, [Version] $Version) { $this._STIG($Technology, $TechnologyVersion, $TechnologyRole, $Version) } <# The validate method is used to test that the rule file exists #> [bool] Validate() { if ( Test-Path -Path $this.RuleFile ) { return $true } return $false } #endregion #region List Available static hidden [STIG[]] _ListAvailable ([string] $Technology, [string] $TechnologyVersion, [string] $TechnologyRole) { $params = @{ Path = [STIG]::DataPath Exclude = "*.org.default.xml" } if (-not [string]::IsNullOrEmpty($Technology)) { # The trailing \* is needed for the Include paramter to work $params.Path = "$($params.Path)\*" $params.Add('Include', "$Technology-") } if (-not [string]::IsNullOrEmpty($TechnologyVersion)) { $params.Include = "$($params.Include)$TechnologyVersion-" } if (-not [string]::IsNullOrEmpty($TechnologyRole)) { $params.Include = "$($params.Include)$TechnologyRole-" } # add the trailing wildcard to the include file name $params.Include = "$($params.Include)*" $stigRuleFileList = Get-ChildItem @params $return = [System.Collections.ArrayList]@() foreach ($stigRuleFile in $stigRuleFileList) { $propertyList = $stigRuleFile.BaseName -split "-" if ($propertyList.count -eq 3) { $null = $return.Add([STIG]::new($propertyList[0], $propertyList[1], [version]$propertyList[2])) } elseif ($propertyList.Count -eq 4) { $null = $return.Add([STIG]::new($propertyList[0], $propertyList[1], $propertyList[2], $propertyList[3])) } } return $return } static [STIG[]] ListAvailable () { return [STIG]::_ListAvailable($null, $null, $null) } static [STIG[]] ListAvailable ([string] $Technology) { return [STIG]::_ListAvailable($Technology, $null, $null) } static [STIG[]] ListAvailable ([string] $Technology, [string] $TechnologyVersion) { return [STIG]::_ListAvailable($Technology, $TechnologyVersion, $null) } static [STIG[]] ListAvailable ([string] $Technology, [string] $TechnologyVersion, [string] $TechnologyRole) { return [STIG]::_ListAvailable($Technology, $TechnologyVersion, $TechnologyRole) } #endregion #region Load Rules hidden [void] _LoadRules([object] $OrgSettings, [hashtable] $Exceptions, [string[]] $SkipRules, [string[]] $SkipRuleType, [string[]] $SkipRuleSeverity) { [xml]$rules = [xml](Get-Content -Path $this.RuleFile) $overRideValues = @{} #region Org Settings # Import Org Settings xml if ([string]::IsNullOrEmpty($OrgSettings) -or $OrgSettings -is [hashtable]) { [xml]$xmlOrgSettings = (Get-Content -Path ($this.RuleFile -replace '.xml', '.org.default.xml')) [hashtable]$settings = ConvertTo-OrgSettingHashtable -XmlOrgSetting $xmlOrgSettings if ($OrgSettings -is [hashtable]) { [hashtable]$settings = Merge-OrgSettingValue -DefaultOrgSetting $settings -UserSpecifiedOrgSetting $OrgSettings } } else { [xml]$xmlOrgSettings = Get-Content -Path $OrgSettings [hashtable]$settings = ConvertTo-OrgSettingHashtable -XmlOrgSetting $xmlOrgSettings } # If there are no org settings to merge, skip over that if ($null -ne $settings) { foreach ($ruleId in $settings.Keys) { $ruleOverRideInformation = @{} $ruleOverRideProperties = $settings[$ruleId].Keys foreach ($ruleOverRideProperty in $ruleOverRideProperties) { $ruleOverRideInformation[$ruleOverRideProperty] = $settings[$ruleId].$ruleOverRideProperty } $overRideValues[$ruleId] = $ruleOverRideInformation } } #endregion foreach ($type in $rules.DISASTIG.ChildNodes.GetEnumerator()) { foreach ($rule in $type.Rule) { $ruleSplit = $($rule.id).Split(".") # Using the category and severity enums to convert low/medium/high to CAT_III/CAT_II/CAT_I if ( ( @($SkipRules) -contains $rule.Id -or @($SkipRules) -contains $ruleSplit[0] -or @($SkipRuleType) -contains $type.Name -or @($SkipRuleSeverity) -contains [category]([int][severity]$rule.severity) ) -and $rule.dscresource -ne 'None' ) { Write-Warning -Message "$($rules.DISASTIG.stigid): $($rule.Id)/$($type.Name)/$($rule.severity) will be Skipped as specified by the configuration" $importRule = [SkippedRule]::new($rule) } else { $importRule = [LoadFactory]::Rule($rule) # OrgSettings if ($importRule.OrganizationValueRequired) { if ($overRideValues.ContainsKey($rule.Id)) { if (-not ($overRideValues[$rule.Id].Values -contains [string]::Empty)) { $importRule.AddOrgSetting($overRideValues[$rule.Id]) } else { Write-Warning -Message "$($rules.DISASTIG.stigid): $($rule.Id)/$($type.Name)/$($rule.severity) contains an empty Organizational Value, setting rule as Skipped" $importRule = [SkippedRule]::new($rule) } } else { throw "Org Setting not found for $($rule.Id)" } } # Exceptions Need to apply after org settings if ($null -ne $Exceptions -and $Exceptions.ContainsKey($rule.Id)) { $importRule.AddExceptionToPolicy($Exceptions[$rule.Id]) } } $ruleListIndex = $this.RuleList.Add($importRule) $this.RuleIdIndex.Add($importRule.Id, $ruleListIndex) } } } [void] LoadRules() { $this._LoadRules($null, $null, $null, $null, $null) } [void] LoadRules([object] $OrgSettings) { $this._LoadRules($OrgSettings, $null, $null, $null, $null) } [void] LoadRules([object] $OrgSettings, [hashtable] $Exceptions) { $this._LoadRules($OrgSettings, $Exceptions, $null, $null, $null) } [void] LoadRules([object] $OrgSettings, [hashtable] $Exceptions, [string[]] $SkipRules) { $this._LoadRules($OrgSettings, $Exceptions, $SkipRules, $null, $null) } [void] LoadRules([object] $OrgSettings, [hashtable] $Exceptions, [string[]] $SkipRules, [string[]] $SkipRuleType) { $this._LoadRules($OrgSettings, $Exceptions, $SkipRules, $SkipRuleType, $null) } [void] LoadRules([object] $OrgSettings, [hashtable] $Exceptions, [string[]] $SkipRules, [string[]] $SkipRuleType, [string[]] $SkipRuleSeverity) { $this._LoadRules($OrgSettings, $Exceptions, $SkipRules, $SkipRuleType, $SkipRuleSeverity) } #endregion #region Help [string] GetExceptionHelp ([string] $RuleId) { # Get the module version from the manifest to inject into the help example $moduleVersion = ( Import-PowerShellDataFile -Path $PSScriptRoot\..\..\PowerStig.psd1 ).ModuleVersion # load the STIG rules if they are not already laoded if ($this.RuleList.Count -le 0) { $this.LoadRules() } try { $rule = $this.RuleList[$this.RuleIdIndex[$RuleId]] } catch { throw "$ruleId was not found in the currently loaded STIG." } $exceptionHelp = $rule.GetExceptionHelp() $return = [System.Text.StringBuilder]::new() $null = $return.AppendLine('') $null = $return.AppendLine('RULE TYPE') $null = $return.AppendLine(" $($rule.GetType().ToString())") $null = $return.AppendLine('') $null = $return.AppendLine('DESCRIPTION') $null = $return.AppendLine(" The $($rule.GetType().ToString()) property '$($rule.GetOverrideValue())' can be overridden ") $null = $return.AppendLine(' with an exception using the syntax below.') $null = $return.AppendLine('') if ($null -ne $exceptionHelp.Notes) { $null = $return.AppendLine('NOTES') $null = $return.AppendLine(" $($exceptionHelp.Notes)") $null = $return.AppendLine('') } $null = $return.AppendLine('SAMPLE CONFIGURATION') $null = $return.AppendLine('') $null = $return.AppendLine('configuration Sample') $null = $return.AppendLine('{') $null = $return.AppendLine(" Import-DscResource -ModuleName PowerStig -ModuleVersion $moduleVersion") $null = $return.AppendLine('') $null = $return.AppendLine(' Node $NodeName') $null = $return.AppendLine(' {') $null = $return.AppendLine(" $($this.Technology) BaseLine") $null = $return.AppendLine(' {') $null = $return.AppendLine(" OsVersion = '$($this.TechnologyVersion)'") $null = $return.AppendLine(" OsRole = '$($this.TechnologyRole)'") $null = $return.AppendLine(" StigVersion = '$($this.Version)'") $null = $return.AppendLine(" Exception = @{'$($rule.id)' = '$($exceptionHelp.value)'}") $null = $return.AppendLine(' }') $null = $return.AppendLine(' }') $null = $return.AppendLine('}') return $return.ToString() } #endregion <# .SYNOPSIS Returns the highest available Stig version .DESCRIPTION Returns the highest available Stig version for a given Technology, TechnologyVersion, and TechnologyRole #> [version] GetLatest () { $stigList = [STIG]::ListAvailable( $this.Technology, $this.TechnologyVersion, $this.TechnologyRole) $maximumStigVersion = ( $stigList | Measure-Object -Maximum -Property Version).Maximum return [version]::new($maximumStigVersion) } } # Footer $exclude = @($MyInvocation.MyCommand.Name,'Template.*.txt', '*.md') foreach ($supportFile in Get-ChildItem -Path $PSScriptRoot -File -Exclude $exclude) { Write-Verbose "Loading $($supportFile.FullName)" . $supportFile.FullName } Export-ModuleMember -Function '*' -Variable '*' |