PSRule.psm1
# Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # # PSRule module # Set-StrictMode -Version latest; [PSRule.Configuration.PSRuleOption]::UseExecutionContext($ExecutionContext); [PSRule.Environment]::UseCurrentCulture(); # # Localization # Import-LocalizedData -BindingVariable LocalizedHelp -FileName 'PSRule.Resources.psd1' -ErrorAction SilentlyContinue; if ($Null -eq (Get-Variable -Name LocalizedHelp -ErrorAction SilentlyContinue)) { Import-LocalizedData -BindingVariable LocalizedHelp -FileName 'PSRule.Resources.psd1' -UICulture 'en-US' -ErrorAction SilentlyContinue; } # # Public functions # # .ExternalHelp PSRule-Help.xml function Invoke-PSRule { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'ShouldProcess is used within CSharp code.')] [CmdletBinding(DefaultParameterSetName = 'Input', SupportsShouldProcess = $True)] [OutputType([PSRule.Rules.RuleRecord])] [OutputType([PSRule.Rules.RuleSummaryRecord])] [OutputType([System.String])] param ( [Parameter(Mandatory = $True, ParameterSetName = 'InputPath')] [Alias('f')] [String[]]$InputPath, [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False)] [PSRule.Rules.RuleOutcome]$Outcome = [PSRule.Rules.RuleOutcome]::Processed, [Parameter(Mandatory = $False)] [ValidateSet('Detail', 'Summary')] [PSRule.Configuration.ResultFormat]$As = [PSRule.Configuration.ResultFormat]::Detail, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [PSRule.Options.InputFormat]$Format = [PSRule.Options.InputFormat]::None, [Parameter(Mandatory = $False)] [String]$OutputPath, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'NUnit3', 'Csv', 'Wide', 'Sarif')] [Alias('o')] [PSRule.Configuration.OutputFormat]$OutputFormat = [PSRule.Configuration.OutputFormat]::None, [Parameter(Mandatory = $False)] [PSRule.Configuration.BaselineOption]$Baseline, [Parameter(Mandatory = $False)] [String[]]$Convention, # A list of paths to check for rule definitions [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path, # Filter to rules with the following names [Parameter(Mandatory = $False)] [Alias('n')] [String[]]$Name, [Parameter(Mandatory = $False)] [Hashtable]$Tag, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$ObjectPath, [Parameter(Mandatory = $False)] [String[]]$TargetType, [Parameter(Mandatory = $False)] [String[]]$Culture, [Parameter(Mandatory = $True, ValueFromPipeline = $True, ParameterSetName = 'Input')] [Alias('TargetObject')] [PSObject]$InputObject ) begin { Write-Verbose -Message '[Invoke-PSRule] BEGIN::'; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSRule.Options.LanguageMode]::ConstrainedLanguage; } if ($PSBoundParameters.ContainsKey('Format')) { $Option.Input.Format = $Format; } if ($PSBoundParameters.ContainsKey('ObjectPath')) { $Option.Input.ObjectPath = $ObjectPath; } if ($PSBoundParameters.ContainsKey('TargetType')) { $Option.Input.TargetType = $TargetType; } if ($PSBoundParameters.ContainsKey('As')) { $Option.Output.As = $As; } if ($PSBoundParameters.ContainsKey('OutputFormat')) { $Option.Output.Format = $OutputFormat; } if ($PSBoundParameters.ContainsKey('Outcome')) { $Option.Output.Outcome = $Outcome; } if ($PSBoundParameters.ContainsKey('OutputPath')) { $Option.Output.Path = $OutputPath; } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::Invoke($sourceFiles, $Option, $hostContext); $builder.Name($Name); $builder.Tag($Tag); $builder.Convention($Convention); $builder.Baseline($Baseline); if ($PSBoundParameters.ContainsKey('InputPath')) { $builder.InputPath($InputPath); } try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $pipeline.RuleCount -gt 0; } } catch { throw $_.Exception.GetBaseException(); } } process { if ($pipelineReady) { try { # Process pipeline objects $pipeline.Process($InputObject); } catch { $pipeline.Dispose(); throw; } } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message '[Invoke-PSRule] END::'; } } # .ExternalHelp PSRule-Help.xml function Test-PSRuleTarget { [CmdletBinding(DefaultParameterSetName = 'Input')] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $True, ParameterSetName = 'InputPath')] [Alias('f')] [String[]]$InputPath, [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False)] [PSRule.Rules.RuleOutcome]$Outcome = [PSRule.Rules.RuleOutcome]::Processed, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [PSRule.Options.InputFormat]$Format, [Parameter(Mandatory = $False)] [String[]]$Convention, # A list of paths to check for rule definitions [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path, # Filter to rules with the following names [Parameter(Mandatory = $False)] [Alias('n')] [String[]]$Name, [Parameter(Mandatory = $False)] [Hashtable]$Tag, [Parameter(Mandatory = $True, ValueFromPipeline = $True, ParameterSetName = 'Input')] [Alias('TargetObject')] [PSObject]$InputObject, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$ObjectPath, [Parameter(Mandatory = $False)] [String[]]$TargetType, [Parameter(Mandatory = $False)] [String]$Culture ) begin { Write-Verbose -Message "[Test-PSRuleTarget] BEGIN::"; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSRule.Options.LanguageMode]::ConstrainedLanguage; } if ($PSBoundParameters.ContainsKey('Format')) { $Option.Input.Format = $Format; } if ($PSBoundParameters.ContainsKey('ObjectPath')) { $Option.Input.ObjectPath = $ObjectPath; } if ($PSBoundParameters.ContainsKey('TargetType')) { $Option.Input.TargetType = $TargetType; } if ($PSBoundParameters.ContainsKey('Outcome')) { $Option.Output.Outcome = $Outcome; } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::Test($sourceFiles, $Option, $hostContext); $builder.Name($Name); $builder.Tag($Tag); $builder.Convention($Convention); if ($PSBoundParameters.ContainsKey('InputPath')) { $builder.InputPath($InputPath); } try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $pipeline.RuleCount -gt 0; } } catch { throw $_.Exception.GetBaseException(); } } process { if ($pipelineReady) { try { # Process pipeline objects $pipeline.Process($InputObject); } catch { $pipeline.Dispose(); throw; } } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message "[Test-PSRuleTarget] END::"; } } # .ExternalHelp PSRule-Help.xml function Get-PSRuleTarget { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'ShouldProcess is used within CSharp code.')] [CmdletBinding(DefaultParameterSetName = 'Input', SupportsShouldProcess = $True)] [OutputType([PSObject])] param ( [Parameter(Mandatory = $True, ParameterSetName = 'InputPath')] [Alias('f')] [String[]]$InputPath, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [PSRule.Options.InputFormat]$Format = [PSRule.Options.InputFormat]::None, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$ObjectPath, [Parameter(Mandatory = $True, ValueFromPipeline = $True, ParameterSetName = 'Input')] [Alias('TargetObject')] [PSObject]$InputObject ) begin { Write-Verbose -Message '[Get-PSRuleTarget] BEGIN::'; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSRule.Options.LanguageMode]::ConstrainedLanguage; } if ($PSBoundParameters.ContainsKey('Format')) { $Option.Input.Format = $Format; } if ($PSBoundParameters.ContainsKey('ObjectPath')) { $Option.Input.ObjectPath = $ObjectPath; } if ($PSBoundParameters.ContainsKey('TargetType')) { $Option.Input.TargetType = $TargetType; } if ($PSBoundParameters.ContainsKey('OutputFormat')) { $Option.Output.Format = $OutputFormat; } if ($PSBoundParameters.ContainsKey('OutputPath')) { $Option.Output.Path = $OutputPath; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::GetTarget($Option, $hostContext); if ($PSBoundParameters.ContainsKey('InputPath')) { $builder.InputPath($InputPath); } try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } process { if ($pipelineReady) { try { # Process pipeline objects $pipeline.Process($InputObject); } catch { $pipeline.Dispose(); throw; } } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message '[Get-PSRuleTarget] END::'; } } # .ExternalHelp PSRule-Help.xml function Assert-PSRule { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'ShouldProcess is used within CSharp code.')] [CmdletBinding(DefaultParameterSetName = 'Input', SupportsShouldProcess = $True)] [OutputType([System.String])] param ( [Parameter(Mandatory = $True, ParameterSetName = 'InputPath')] [Alias('f')] [String[]]$InputPath, [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [PSRule.Options.InputFormat]$Format = [PSRule.Options.InputFormat]::None, [Parameter(Mandatory = $False)] [PSRule.Configuration.BaselineOption]$Baseline, [Parameter(Mandatory = $False)] [String[]]$Convention, [Parameter(Mandatory = $False)] [ValidateSet('Client', 'Plain', 'AzurePipelines', 'GitHubActions', 'VisualStudioCode', 'Detect')] [PSRule.Configuration.OutputStyle]$Style = [PSRule.Configuration.OutputStyle]::Detect, [Parameter(Mandatory = $False)] [PSRule.Rules.RuleOutcome]$Outcome = [PSRule.Rules.RuleOutcome]::Processed, [Parameter(Mandatory = $False)] [ValidateSet('Detail', 'Summary')] [PSRule.Configuration.ResultFormat]$As = [PSRule.Configuration.ResultFormat]::Detail, # A list of paths to check for rule definitions [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path, # Filter to rules with the following names [Parameter(Mandatory = $False)] [Alias('n')] [String[]]$Name, [Parameter(Mandatory = $False)] [Hashtable]$Tag, [Parameter(Mandatory = $False)] [String]$OutputPath, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'NUnit3', 'Csv', 'Sarif')] [Alias('o')] [PSRule.Configuration.OutputFormat]$OutputFormat, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$ObjectPath, [Parameter(Mandatory = $False)] [String[]]$TargetType, [Parameter(Mandatory = $False)] [String[]]$Culture, [Parameter(Mandatory = $True, ValueFromPipeline = $True, ParameterSetName = 'Input')] [Alias('TargetObject')] [PSObject]$InputObject, [Parameter(Mandatory = $False)] [String]$ResultVariable ) begin { Write-Verbose -Message '[Assert-PSRule] BEGIN::'; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSRule.Options.LanguageMode]::ConstrainedLanguage; } if ($PSBoundParameters.ContainsKey('Format')) { $Option.Input.Format = $Format; } if ($PSBoundParameters.ContainsKey('ObjectPath')) { $Option.Input.ObjectPath = $ObjectPath; } if ($PSBoundParameters.ContainsKey('TargetType')) { $Option.Input.TargetType = $TargetType; } if ($PSBoundParameters.ContainsKey('As')) { $Option.Output.As = $As; } if ($PSBoundParameters.ContainsKey('Outcome')) { $Option.Output.Outcome = $Outcome; } if ($PSBoundParameters.ContainsKey('Style')) { $Option.Output.Style = $Style; } if ($PSBoundParameters.ContainsKey('OutputFormat')) { $Option.Output.Format = $OutputFormat; } if ($PSBoundParameters.ContainsKey('OutputPath')) { $Option.Output.Path = $OutputPath; } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::Assert($sourceFiles, $Option, $hostContext);; $builder.Name($Name); $builder.Tag($Tag); $builder.Convention($Convention); $builder.Baseline($Baseline); $builder.ResultVariable($ResultVariable); if ($PSBoundParameters.ContainsKey('InputPath')) { $builder.InputPath($InputPath); } try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $pipeline.RuleCount -gt 0; } } catch { throw $_.Exception.GetBaseException(); } } process { if ($pipelineReady) { try { # Process pipeline objects $pipeline.Process($InputObject); } catch { $pipeline.Dispose(); throw; } } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message '[Assert-PSRule] END::'; } } # .ExternalHelp PSRule-Help.xml function Get-PSRule { [CmdletBinding()] [OutputType([PSRule.Definitions.Rules.IRuleV1])] param ( [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False)] [Switch]$ListAvailable, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Wide', 'Yaml', 'Json')] [Alias('o')] [PSRule.Configuration.OutputFormat]$OutputFormat, [Parameter(Mandatory = $False)] [PSRule.Configuration.BaselineOption]$Baseline, # A list of paths to check for rule definitions [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path, # Filter to rules with the following names [Parameter(Mandatory = $False)] [Alias('n')] [String[]]$Name, [Parameter(Mandatory = $False)] [Hashtable]$Tag, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$Culture, [Parameter(Mandatory = $False)] [Switch]$IncludeDependencies ) begin { Write-Verbose -Message "[Get-PSRule]::BEGIN"; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } if ($PSBoundParameters.ContainsKey('ListAvailable')) { $sourceParams['ListAvailable'] = $ListAvailable; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; # Check that some matching script files were found if ($Null -eq $sourceFiles) { Write-Verbose -Message "[Get-PSRule] -- Could not find any .Rule.ps1 script files in the path."; return; # continue causes issues with Pester } Write-Verbose -Message "[Get-PSRule] -- Found $($sourceFiles.Length) source file(s)"; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSRule.Options.LanguageMode]::ConstrainedLanguage; } if ($PSBoundParameters.ContainsKey('OutputFormat')) { $Option.Output.Format = $OutputFormat; } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::Get($sourceFiles, $Option, $hostContext); $builder.Name($Name); $builder.Tag($Tag); $builder.Baseline($Baseline); if ($IncludeDependencies) { $builder.IncludeDependencies(); } try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message "[Get-PSRule]::END"; } } # .ExternalHelp PSRule-Help.xml function Get-PSRuleBaseline { [CmdletBinding()] [OutputType([PSRule.Definitions.Baselines.Baseline])] [OutputType([System.String])] param ( [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False)] [Switch]$ListAvailable, [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path, [Parameter(Mandatory = $False)] [Alias('n')] [SupportsWildcards()] [String[]]$Name, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$Culture, [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json')] [Alias('o')] [PSRule.Configuration.OutputFormat]$OutputFormat ) begin { Write-Verbose -Message "[Get-PSRuleBaseline] BEGIN::"; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } if ($PSBoundParameters.ContainsKey('ListAvailable')) { $sourceParams['ListAvailable'] = $ListAvailable; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; # Check that some matching script files were found if ($Null -eq $sourceFiles) { Write-Verbose -Message "[Get-PSRuleBaseline] -- Could not find any .Rule.ps1 script files in the path."; return; # continue causes issues with Pester } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } if ($PSBoundParameters.ContainsKey('OutputFormat')) { $Option.Output.Format = $OutputFormat; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::GetBaseline($sourceFiles, $Option, $hostContext);; $builder.Name($Name); try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message '[Get-PSRuleBaseline] END::'; } } # .ExternalHelp PSRule-Help.xml function Export-PSRuleBaseline { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'ShouldProcess is used within CSharp code.')] [CmdletBinding(SupportsShouldProcess = $True)] [OutputType([void])] param ( [Parameter(Mandatory = $False)] [Alias('m')] [String[]]$Module, [Parameter(Mandatory = $False, Position = 0)] [Alias('p')] [String[]]$Path, [Parameter(Mandatory = $False)] [Alias('n')] [SupportsWildcards()] [String[]]$Name, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$Culture, [Parameter(Mandatory = $False)] [ValidateSet('Yaml', 'Json')] [Alias('o')] [PSRule.Configuration.OutputFormat]$OutputFormat = 'Yaml', [Parameter(Mandatory = $True)] [String]$OutputPath, [Parameter(Mandatory = $False)] [ValidateSet('Default', 'UTF8', 'UTF7', 'Unicode', 'UTF32', 'ASCII')] [PSRule.Configuration.OutputEncoding]$OutputEncoding = 'Default' ) begin { Write-Verbose -Message "[Export-PSRuleBaseline] BEGIN::"; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; # Check that some matching script files were found if ($Null -eq $sourceFiles) { Write-Verbose -Message "[Export-PSRuleBaseline] -- Could not find any .Rule.ps1 script files in the path."; return; # continue causes issues with Pester } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } $Option.Output.Format = $OutputFormat; $Option.Output.Path = $OutputPath; if ($PSBoundParameters.ContainsKey('OutputEncoding')) { $Option.Output.Encoding = $OutputEncoding; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::ExportBaseline($sourceFiles, $Option, $hostContext);; $builder.Name($Name); try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message '[Export-PSRuleBaseline] END::'; } } # .ExternalHelp PSRule-Help.xml function Get-PSRuleHelp { [CmdletBinding()] [OutputType([PSRule.Rules.RuleHelpInfo])] param ( [Parameter(Mandatory = $False)] [Alias('m')] [String]$Module, [Parameter(Mandatory = $False)] [Switch]$Online = $False, [Parameter(Mandatory = $False)] [Switch]$Full = $False, # The name of the rule to get documentation for. [Parameter(Position = 0, Mandatory = $False)] [Alias('n')] [SupportsWildcards()] [String[]]$Name, # A path to check documentation for. [Parameter(Mandatory = $False)] [Alias('p')] [String]$Path, [Parameter(Mandatory = $False)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [String]$Culture ) begin { Write-Verbose -Message "[Get-PSRuleHelp]::BEGIN"; $pipelineReady = $False; # Get parameter options, which will override options from other sources $optionParams = @{ }; if ($PSBoundParameters.ContainsKey('Option')) { $optionParams['Option'] = $Option; } # Get an options object $Option = New-PSRuleOption @optionParams -WarningAction SilentlyContinue; # Discover scripts in the specified paths $sourceParams = @{ }; $sourceParams['PreferModule'] = $True; if ($PSBoundParameters.ContainsKey('Path')) { $sourceParams['Path'] = $Path; } if ($PSBoundParameters.ContainsKey('Module')) { $sourceParams['Module'] = $Module; } if ($PSBoundParameters.ContainsKey('Culture')) { $sourceParams['Culture'] = $Culture; } $sourceParams['Option'] = $Option; [PSRule.Pipeline.Source[]]$sourceFiles = GetSource @sourceParams -Verbose:$VerbosePreference; # Check that some matching script files were found if ($Null -eq $sourceFiles) { Write-Verbose -Message "[Get-PSRuleHelp] -- Could not find any .Rule.ps1 script files in the path."; return; # continue causes issues with Pester } Write-Verbose -Message "[Get-PSRuleHelp] -- Found $($sourceFiles.Length) source file(s)"; $isDeviceGuard = IsDeviceGuardEnabled; # If DeviceGuard is enabled, force a contrained execution environment if ($isDeviceGuard) { $Option.Execution.LanguageMode = [PSRule.Options.LanguageMode]::ConstrainedLanguage; } if ($PSBoundParameters.ContainsKey('Culture')) { $Option.Output.Culture = $Culture; } $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::GetHelp($sourceFiles, $Option, $hostContext); $builder.Name($Name); if ($Online) { $builder.Online(); } if ($Full) { $builder.Full(); } # $builder.UseCommandRuntime($PSCmdlet); # $builder.UseExecutionContext($ExecutionContext); try { $pipeline = $builder.Build(); if ($Null -ne $pipeline) { $pipeline.Begin(); $pipelineReady = $True; } } catch { throw $_.Exception.GetBaseException(); } } end { if ($pipelineReady) { try { $pipeline.End(); } finally { $pipeline.Dispose(); } } Write-Verbose -Message "[Get-PSRuleHelp]::END"; } } # .ExternalHelp PSRule-Help.xml function New-PSRuleOption { [CmdletBinding(DefaultParameterSetName = 'FromPath')] [OutputType([PSRule.Configuration.PSRuleOption])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'Creates an in memory object only')] param ( [Parameter(Position = 0, Mandatory = $False, ParameterSetName = 'FromPath')] [String]$Path, [Parameter(Mandatory = $True, ParameterSetName = 'FromOption')] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $True, ParameterSetName = 'FromDefault')] [Switch]$Default, [Parameter(Mandatory = $False)] [Alias('BaselineConfiguration')] [PSRule.Configuration.ConfigurationOption]$Configuration, [Parameter(Mandatory = $False)] [PSRule.Configuration.SuppressionOption]$SuppressTargetName, # Options # Sets the Baseline.Group option [Parameter(Mandatory = $False)] [Hashtable]$BaselineGroup, # Sets the Binding.IgnoreCase option [Parameter(Mandatory = $False)] [System.Boolean]$BindingIgnoreCase = $True, # Sets the Binding.Field option [Parameter(Mandatory = $False)] [Hashtable]$BindingField, # Sets the Binding.NameSeparator option [Parameter(Mandatory = $False)] [String]$BindingNameSeparator = '/', # Sets the Binding.PreferTargetInfo option [Parameter(Mandatory = $False)] [System.Boolean]$BindingPreferTargetInfo = $False, # Sets the Binding.TargetName option [Parameter(Mandatory = $False)] [Alias('BindingTargetName')] [String[]]$TargetName, # Sets the Binding.TargetType option [Parameter(Mandatory = $False)] [Alias('BindingTargetType')] [String[]]$TargetType, # Sets the Binding.UseQualifiedName option [Parameter(Mandatory = $False)] [System.Boolean]$BindingUseQualifiedName = $False, # Sets the Convention.Include option [Parameter(Mandatory = $False)] [Alias('ConventionInclude')] [String[]]$Convention, # Sets the Execution.Break option [Parameter(Mandatory = $False)] [PSRule.Options.BreakLevel]$ExecutionBreak = [PSRule.Options.BreakLevel]::OnError, # Sets the Execution.DuplicateResourceId option [Parameter(Mandatory = $False)] [Alias('ExecutionDuplicateResourceId')] [PSRule.Options.ExecutionActionPreference]$DuplicateResourceId = [PSRule.Options.ExecutionActionPreference]::Error, # Sets the Execution.InitialSessionState option [Parameter(Mandatory = $False)] [Alias('ExecutionInitialSessionState')] [PSRule.Options.SessionState]$InitialSessionState = [PSRule.Options.SessionState]::BuiltIn, # Sets the Execution.RestrictScriptSource option [Parameter(Mandatory = $False)] [Alias('ExecutionRestrictScriptSource')] [PSRule.Options.RestrictScriptSource]$RestrictScriptSource = [PSRule.Options.RestrictScriptSource]::Unrestricted, # Sets the Execution.SuppressionGroupExpired option [Parameter(Mandatory = $False)] [Alias('ExecutionSuppressionGroupExpired')] [PSRule.Options.ExecutionActionPreference]$SuppressionGroupExpired = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.RuleExcluded option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleExcluded = [PSRule.Options.ExecutionActionPreference]::Ignore, # Sets the Execution.RuleSuppressed option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleSuppressed = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.AliasReference option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionAliasReference = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.RuleInconclusive option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleInconclusive = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.InvariantCulture option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionInvariantCulture = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.UnprocessedObject option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionUnprocessedObject = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Include.Module option [Parameter(Mandatory = $False)] [String[]]$IncludeModule, # Sets the Include.Path option [Parameter(Mandatory = $False)] [String[]]$IncludePath, # Sets the Input.FileObjects option [Parameter(Mandatory = $False)] [System.Boolean]$InputFileObjects = $False, # Sets the Input.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [Alias('InputFormat')] [PSRule.Options.InputFormat]$Format = 'None', # Sets the Input.IgnoreGitPath option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreGitPath = $True, # Sets the Input.IgnoreRepositoryCommon option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreRepositoryCommon = $True, # Sets the Input.IgnoreObjectSource option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreObjectSource = $False, # Sets the Input.IgnoreUnchangedPath option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreUnchangedPath = $False, # Sets the Input.ObjectPath option [Parameter(Mandatory = $False)] [Alias('InputObjectPath')] [String]$ObjectPath = '', # Sets the Input.TargetType option [Parameter(Mandatory = $False)] [String[]]$InputTargetType, # Sets the Input.PathIgnore option [Parameter(Mandatory = $False)] [String[]]$InputPathIgnore = '', # Sets the Logging.LimitDebug option [Parameter(Mandatory = $False)] [String[]]$LoggingLimitDebug = $Null, # Sets the Logging.LimitVerbose option [Parameter(Mandatory = $False)] [String[]]$LoggingLimitVerbose = $Null, # Sets the Logging.RuleFail option [Parameter(Mandatory = $False)] [PSRule.Configuration.OutcomeLogStream]$LoggingRuleFail = 'None', # Sets the Logging.RulePass option [Parameter(Mandatory = $False)] [PSRule.Configuration.OutcomeLogStream]$LoggingRulePass = 'None', # Sets the Output.As option [Parameter(Mandatory = $False)] [ValidateSet('Detail', 'Summary')] [PSRule.Configuration.ResultFormat]$OutputAs = 'Detail', # Sets the Output.Banner option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'Minimal', 'None', 'Title', 'Source', 'SupportLinks', 'RepositoryInfo')] [PSRule.Configuration.BannerFormat]$OutputBanner = 'Default', # Sets the Output.Culture option [Parameter(Mandatory = $False)] [String[]]$OutputCulture, # Sets the Output.Encoding option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'UTF8', 'UTF7', 'Unicode', 'UTF32', 'ASCII')] [PSRule.Configuration.OutputEncoding]$OutputEncoding = 'Default', # Sets the Output.Footer option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'None', 'RuleCount', 'RunInfo')] [PSRule.Configuration.FooterFormat]$OutputFooter = 'Default', # Sets the Output.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'NUnit3', 'Csv', 'Wide', 'Sarif')] [PSRule.Configuration.OutputFormat]$OutputFormat = 'None', # Sets the Output.JobSummaryPath option [Parameter(Mandatory = $False)] [String]$OutputJobSummaryPath = '', # Sets the Output.JsonIndent option [Parameter(Mandatory = $False)] [ValidateRange(0, 4)] [Alias('JsonIndent')] [int]$OutputJsonIndent = 0, # Sets the Output.Outcome option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Fail', 'Pass', 'Error', 'Problem', 'Processed', 'All')] [Alias('Outcome')] [PSRule.Rules.RuleOutcome]$OutputOutcome = 'Processed', # Sets the Output.Path option [Parameter(Mandatory = $False)] [String]$OutputPath = '', # Sets the Output.SarifProblemsOnly option [Parameter(Mandatory = $False)] [System.Boolean]$OutputSarifProblemsOnly = $True, # Sets the Output.Style option [Parameter(Mandatory = $False)] [ValidateSet('Client', 'Plain', 'AzurePipelines', 'GitHubActions', 'VisualStudioCode', 'Detect')] [PSRule.Configuration.OutputStyle]$OutputStyle = [PSRule.Configuration.OutputStyle]::Detect, # Sets the OverrideLevel option [Parameter(Mandatory = $False)] [Hashtable]$OverrideLevel, # Sets the Repository.BaseRef option [Parameter(Mandatory = $False)] [String]$RepositoryBaseRef, # Sets the Repository.Url option [Parameter(Mandatory = $False)] [String]$RepositoryUrl, # Sets the Rule.IncludeLocal option [Parameter(Mandatory = $False)] [System.Boolean]$RuleIncludeLocal = $False ) begin { Write-Verbose -Message "[New-PSRuleOption] BEGIN::"; # Get parameter options, which will override options from other sources $optionParams = @{ }; $optionParams += $PSBoundParameters; # Remove invalid parameters if ($optionParams.ContainsKey('Path')) { $optionParams.Remove('Path'); } if ($optionParams.ContainsKey('Option')) { $optionParams.Remove('Option'); } if ($optionParams.ContainsKey('Default')) { $optionParams.Remove('Default'); } if ($optionParams.ContainsKey('Verbose')) { $optionParams.Remove('Verbose'); } if ($optionParams.ContainsKey('Configuration')) { $optionParams.Remove('Configuration'); } if ($optionParams.ContainsKey('SuppressTargetName')) { $optionParams.Remove('SuppressTargetName'); } if ($PSBoundParameters.ContainsKey('Option')) { $Option = [PSRule.Configuration.PSRuleOption]::FromFileOrEmpty($Option, $Path); } elseif ($PSBoundParameters.ContainsKey('Path')) { Write-Verbose -Message "Attempting to read: $Path"; $Option = [PSRule.Configuration.PSRuleOption]::FromFile($Path); } elseif ($PSBoundParameters.ContainsKey('Default')) { $Option = [PSRule.Configuration.PSRuleOption]::FromDefault(); } else { Write-Verbose -Message "Attempting to read: $Path"; $Option = [PSRule.Configuration.PSRuleOption]::FromFileOrEmpty($Option, $Path); } } end { if ($PSBoundParameters.ContainsKey('Configuration')) { $Option.Configuration = $Configuration; } if ($PSBoundParameters.ContainsKey('SuppressTargetName')) { $Option.Suppression = $SuppressTargetName; } # Options $Option | SetOptions @optionParams -Verbose:$VerbosePreference; Write-Verbose -Message "[New-PSRuleOption] END::"; } } # .ExternalHelp PSRule-Help.xml function Set-PSRuleOption { [CmdletBinding(SupportsShouldProcess = $True)] [OutputType([PSRule.Configuration.PSRuleOption])] param ( # The path to a YAML file where options will be set [Parameter(Position = 0, Mandatory = $False)] [String]$Path, [Parameter(Mandatory = $False, ValueFromPipeline = $True)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $False)] [Switch]$PassThru = $False, # Force creation of directory path for Path parameter [Parameter(Mandatory = $False)] [Switch]$Force = $False, # Overwrite YAML files that contain comments [Parameter(Mandatory = $False)] [Switch]$AllowClobber = $False, # Options # Sets the Baseline.Group option [Parameter(Mandatory = $False)] [Hashtable]$BaselineGroup, # Sets the Binding.IgnoreCase option [Parameter(Mandatory = $False)] [System.Boolean]$BindingIgnoreCase = $True, # Sets the Binding.Field option [Parameter(Mandatory = $False)] [Hashtable]$BindingField, # Sets the Binding.NameSeparator option [Parameter(Mandatory = $False)] [String]$BindingNameSeparator = '/', # Sets the Binding.PreferTargetInfo option [Parameter(Mandatory = $False)] [System.Boolean]$BindingPreferTargetInfo = $False, # Sets the Binding.TargetName option [Parameter(Mandatory = $False)] [Alias('BindingTargetName')] [String[]]$TargetName, # Sets the Binding.TargetType option [Parameter(Mandatory = $False)] [Alias('BindingTargetType')] [String[]]$TargetType, # Sets the Binding.UseQualifiedName option [Parameter(Mandatory = $False)] [System.Boolean]$BindingUseQualifiedName = $False, # Sets the Convention.Include option [Parameter(Mandatory = $False)] [Alias('ConventionInclude')] [String[]]$Convention, # Sets the Execution.Break option [Parameter(Mandatory = $False)] [PSRule.Options.BreakLevel]$ExecutionBreak = [PSRule.Options.BreakLevel]::OnError, # Sets the Execution.DuplicateResourceId option [Parameter(Mandatory = $False)] [Alias('ExecutionDuplicateResourceId')] [PSRule.Options.ExecutionActionPreference]$DuplicateResourceId = [PSRule.Options.ExecutionActionPreference]::Error, # Sets the Execution.InitialSessionState option [Parameter(Mandatory = $False)] [Alias('ExecutionInitialSessionState')] [PSRule.Options.SessionState]$InitialSessionState = [PSRule.Options.SessionState]::BuiltIn, # Sets the Execution.RestrictScriptSource option [Parameter(Mandatory = $False)] [Alias('ExecutionRestrictScriptSource')] [PSRule.Options.RestrictScriptSource]$RestrictScriptSource = [PSRule.Options.RestrictScriptSource]::Unrestricted, # Sets the Execution.SuppressionGroupExpired option [Parameter(Mandatory = $False)] [Alias('ExecutionSuppressionGroupExpired')] [PSRule.Options.ExecutionActionPreference]$SuppressionGroupExpired = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.RuleExcluded option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleExcluded = [PSRule.Options.ExecutionActionPreference]::Ignore, # Sets the Execution.RuleSuppressed option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleSuppressed = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.AliasReference option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionAliasReference = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.RuleInconclusive option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleInconclusive = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.InvariantCulture option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionInvariantCulture = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.UnprocessedObject option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionUnprocessedObject = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Include.Module option [Parameter(Mandatory = $False)] [String[]]$IncludeModule, # Sets the Include.Path option [Parameter(Mandatory = $False)] [String[]]$IncludePath, # Sets the Input.FileObjects option [Parameter(Mandatory = $False)] [System.Boolean]$InputFileObjects = $False, # Sets the Input.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [Alias('InputFormat')] [PSRule.Options.InputFormat]$Format = 'None', # Sets the Input.IgnoreGitPath option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreGitPath = $True, # Sets the Input.IgnoreObjectSource option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreObjectSource = $False, # Sets the Input.IgnoreRepositoryCommon option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreRepositoryCommon = $True, # Sets the Input.IgnoreUnchangedPath option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreUnchangedPath = $False, # Sets the Input.ObjectPath option [Parameter(Mandatory = $False)] [Alias('InputObjectPath')] [String]$ObjectPath = '', # Sets the Input.PathIgnore option [Parameter(Mandatory = $False)] [String[]]$InputPathIgnore = '', # Sets the Input.TargetType option [Parameter(Mandatory = $False)] [String[]]$InputTargetType, # Sets the Logging.LimitDebug option [Parameter(Mandatory = $False)] [String[]]$LoggingLimitDebug = $Null, # Sets the Logging.LimitVerbose option [Parameter(Mandatory = $False)] [String[]]$LoggingLimitVerbose = $Null, # Sets the Logging.RuleFail option [Parameter(Mandatory = $False)] [PSRule.Configuration.OutcomeLogStream]$LoggingRuleFail = 'None', # Sets the Logging.RulePass option [Parameter(Mandatory = $False)] [PSRule.Configuration.OutcomeLogStream]$LoggingRulePass = 'None', # Sets the Output.As option [Parameter(Mandatory = $False)] [ValidateSet('Detail', 'Summary')] [PSRule.Configuration.ResultFormat]$OutputAs = 'Detail', # Sets the Output.Banner option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'Minimal', 'None', 'Title', 'Source', 'SupportLinks', 'RepositoryInfo')] [PSRule.Configuration.BannerFormat]$OutputBanner = 'Default', # Sets the Output.Culture option [Parameter(Mandatory = $False)] [String[]]$OutputCulture, # Sets the Output.Encoding option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'UTF8', 'UTF7', 'Unicode', 'UTF32', 'ASCII')] [PSRule.Configuration.OutputEncoding]$OutputEncoding = 'Default', # Sets the Output.Footer option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'None', 'RuleCount', 'RunInfo')] [PSRule.Configuration.FooterFormat]$OutputFooter = 'Default', # Sets the Output.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'NUnit3', 'Csv', 'Wide', 'Sarif')] [PSRule.Configuration.OutputFormat]$OutputFormat = 'None', # Sets the Output.JobSummaryPath option [Parameter(Mandatory = $False)] [String]$OutputJobSummaryPath = '', # Sets the Output.JsonIndent option [Parameter(Mandatory = $False)] [ValidateRange(0, 4)] [Alias('JsonIndent')] [int]$OutputJsonIndent = 0, # Sets the Output.Outcome option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Fail', 'Pass', 'Error', 'Problem', 'Processed', 'All')] [Alias('Outcome')] [PSRule.Rules.RuleOutcome]$OutputOutcome = 'Processed', # Sets the Output.Path option [Parameter(Mandatory = $False)] [String]$OutputPath = '', # Sets the Output.SarifProblemsOnly option [Parameter(Mandatory = $False)] [System.Boolean]$OutputSarifProblemsOnly = $True, # Sets the Output.Style option [Parameter(Mandatory = $False)] [ValidateSet('Client', 'Plain', 'AzurePipelines', 'GitHubActions', 'VisualStudioCode', 'Detect')] [PSRule.Configuration.OutputStyle]$OutputStyle = [PSRule.Configuration.OutputStyle]::Detect, # Sets the OverrideLevel option [Parameter(Mandatory = $False)] [Hashtable]$OverrideLevel, # Sets the Repository.BaseRef option [Parameter(Mandatory = $False)] [String]$RepositoryBaseRef, # Sets the Repository.Url option [Parameter(Mandatory = $False)] [String]$RepositoryUrl, # Sets the Rule.IncludeLocal option [Parameter(Mandatory = $False)] [System.Boolean]$RuleIncludeLocal = $False ) begin { Write-Verbose -Message "[Set-PSRuleOption] BEGIN::"; # Get parameter options, which will override options from other sources $optionParams = @{ }; $optionParams += $PSBoundParameters; # Remove invalid parameters if ($optionParams.ContainsKey('Path')) { $optionParams.Remove('Path'); } if ($optionParams.ContainsKey('Option')) { $optionParams.Remove('Option'); } if ($optionParams.ContainsKey('PassThru')) { $optionParams.Remove('PassThru'); } if ($optionParams.ContainsKey('Force')) { $optionParams.Remove('Force'); } if ($optionParams.ContainsKey('AllowClobber')) { $optionParams.Remove('AllowClobber'); } if ($optionParams.ContainsKey('WhatIf')) { $optionParams.Remove('WhatIf'); } if ($optionParams.ContainsKey('Confirm')) { $optionParams.Remove('Confirm'); } if ($optionParams.ContainsKey('Verbose')) { $optionParams.Remove('Verbose'); } # Build options object if ($PSBoundParameters.ContainsKey('Option')) { $Option = $Option.Clone(); } else { Write-Verbose -Message "[Set-PSRuleOption] -- Attempting to read: $Path"; $Option = [PSRule.Configuration.PSRuleOption]::FromFileOrEmpty($Path); } $filePath = [PSRule.Configuration.PSRuleOption]::GetFilePath($Path); $containsComments = YamlContainsComments -Path $filePath; } process { try { $result = $Option | SetOptions @optionParams -Verbose:$VerbosePreference; if ($PassThru) { $result; } elseif ($containsComments -and !$AllowClobber) { Write-Error -Message $LocalizedHelp.YamlContainsComments -Category ResourceExists -ErrorId 'PSRule.PSRuleOption.YamlContainsComments'; } else { $parentPath = Split-Path -Path $filePath -Parent; if (!(Test-Path -Path $parentPath)) { if ($Force) { if ($PSCmdlet.ShouldProcess('Create directory', $parentPath)) { $Null = New-Item -Path $parentPath -ItemType Directory -Force; } } else { Write-Error -Message $LocalizedHelp.PathNotFound -Category ObjectNotFound -ErrorId 'PSRule.PSRuleOption.ParentPathNotFound'; } } if ($PSCmdlet.ShouldProcess('Write options to file', $filePath)) { $result.ToFile($Path); } } } finally { } } end { Write-Verbose -Message "[Set-PSRuleOption] END::"; } } # # Keywords # #region Keywords <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#rule #> function Rule { [OutputType([void])] param ( # The name of the rule [Parameter(Position = 0, Mandatory = $True)] [ValidateLength(3, 128)] [ValidateNotNullOrEmpty()] [String]$Name, # An optional stable opaque identifier of this resource for lookup. [Parameter(Mandatory = $False)] [ValidateLength(3, 128)] [ValidateNotNullOrEmpty()] [String]$Ref, # Any aliases for the rule. [Parameter(Mandatory = $False)] [String[]]$Alias, # If the rule fails, how serious is the result. [Parameter(Mandatory = $False)] [PSRule.Definitions.Rules.SeverityLevel]$Level, # The body of the rule [Parameter(Position = 1, Mandatory = $True)] [ScriptBlock]$Body, [Parameter(Mandatory = $False)] [Hashtable]$Tag, # Any taxonomy references. [Parameter(Mandatory = $False)] [hashtable]$Labels, [Parameter(Mandatory = $False)] [ScriptBlock]$If, [Parameter(Mandatory = $False)] [String[]]$Type, [Parameter(Mandatory = $False)] [String[]]$With, # Any dependencies for this rule [Parameter(Mandatory = $False)] [String[]]$DependsOn, [Parameter(Mandatory = $False)] [Hashtable]$Configure ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#allof #> function AllOf { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [ScriptBlock]$Body ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#anyof #> function AnyOf { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [ScriptBlock]$Body ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#exists #> function Exists { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [String[]]$Field, [Parameter(Mandatory = $False)] [Switch]$CaseSensitive = $False, [Parameter(Mandatory = $False)] [Switch]$Not = $False, [Parameter(Mandatory = $False)] [Switch]$All = $False, [Parameter(Mandatory = $False)] [String]$Reason, [Parameter(Mandatory = $False, ValueFromPipeline = $True)] [PSObject]$InputObject ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#match #> function Match { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [String]$Field, [Parameter(Mandatory = $True, Position = 1)] [String[]]$Expression, [Parameter(Mandatory = $False)] [Switch]$CaseSensitive = $False, [Parameter(Mandatory = $False)] [Switch]$Not = $False, [Parameter(Mandatory = $False)] [String]$Reason, [Parameter(Mandatory = $False, ValueFromPipeline = $True)] [PSObject]$InputObject ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#within #> function Within { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [String]$Field, [Parameter(Mandatory = $False)] [Switch]$Not = $False, [Parameter(Mandatory = $False)] [Switch]$Like = $False, [Parameter(Mandatory = $True, Position = 1)] [Alias('AllowedValue')] [PSObject[]]$Value, [Parameter(Mandatory = $False)] [Switch]$CaseSensitive = $False, [Parameter(Mandatory = $False)] [String]$Reason, [Parameter(Mandatory = $False, ValueFromPipeline = $True)] [PSObject]$InputObject ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#typeof #> function TypeOf { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [String[]]$TypeName, [Parameter(Mandatory = $False)] [String]$Reason, [Parameter(Mandatory = $False, ValueFromPipeline = $True)] [PSObject]$InputObject ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#reason #> function Reason { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $False, Position = 0)] [String]$Text ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } <# .LINK https://microsoft.github.io/PSRule/keywords/PSRule/en-US/about_PSRule_Keywords.html#recommend #> function Recommend { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $False, Position = 0)] [String]$Text ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } function Export-PSRuleConvention { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True, Position = 0)] [String]$Name, [Parameter(Mandatory = $False)] [ScriptBlock]$Initialize, [Parameter(Mandatory = $False)] [ScriptBlock]$Begin, [Parameter(Mandatory = $False, Position = 1)] [ScriptBlock]$Process, [Parameter(Mandatory = $False)] [ScriptBlock]$End, [Parameter(Mandatory = $False)] [ScriptBlock]$If ) begin { # This is just a stub to improve rule authoring and discovery Write-Error -Message $LocalizedHelp.KeywordOutsideEngine -Category InvalidOperation; } } #endregion Keywords # # Helper functions # # Get a list of rule script files in the matching paths function GetSource { [CmdletBinding()] [OutputType([PSRule.Pipeline.Source])] param ( [Parameter(Mandatory = $False)] [String[]]$Path, [Parameter(Mandatory = $False)] [String[]]$Module, [Parameter(Mandatory = $False)] [Switch]$ListAvailable, [Parameter(Mandatory = $False)] [String]$Culture, [Parameter(Mandatory = $False)] [Switch]$PreferModule = $False, [Parameter(Mandatory = $True)] [PSRule.Configuration.PSRuleOption]$Option ) process { $hostContext = [PSRule.Pipeline.PSHostContext]::new($PSCmdlet, $ExecutionContext); $builder = [PSRule.Pipeline.PipelineBuilder]::RuleSource($Option, $hostContext); $moduleParams = @{}; if ($PSBoundParameters.ContainsKey('Module')) { $moduleParams['Name'] = $Module; # Determine if module should be automatically loaded if (GetAutoloadPreference) { foreach ($m in $Module) { if ($Null -eq (GetRuleModule -Name $m)) { LoadModule -Name $m -Verbose:$VerbosePreference; } } } } if ($PSBoundParameters.ContainsKey('ListAvailable')) { $moduleParams['ListAvailable'] = $ListAvailable.ToBool(); } if ($Null -ne $Option.Include -and $Null -ne $Option.Include.Module -and $Option.Include.Module.Length -gt 0) { # Determine if module should be automatically loaded if (GetAutoloadPreference) { foreach ($m in $Option.Include.Module) { if ($Null -eq (GetRuleModule -Name $m)) { LoadModule -Name $m -Verbose:$VerbosePreference; } } } $modules = @(GetRuleModule -Name $Option.Include.Module); $builder.Module($modules); } if ($moduleParams.Count -gt 0 -or $PreferModule) { $modules = @(GetRuleModule @moduleParams); $builder.Module($modules); } # Ensure module files are discovered before loose files in Path if ($PSBoundParameters.ContainsKey('Path')) { try { $builder.Directory($Path, $True); } catch { throw $_.Exception.GetBaseException(); } } $builder.Build(); } } function GetAutoloadPreference { [CmdletBinding()] [OutputType([System.Boolean])] param () process { $v = Microsoft.PowerShell.Utility\Get-Variable -Name 'PSModuleAutoLoadingPreference' -ErrorAction SilentlyContinue; return ($Null -eq $v) -or ($v.Value -eq [System.Management.Automation.PSModuleAutoLoadingPreference]::All); } } function GetRuleModule { [CmdletBinding()] [OutputType([System.Management.Automation.PSModuleInfo])] param ( [Parameter(Mandatory = $False)] [String[]]$Name, [Parameter(Mandatory = $False)] [Switch]$ListAvailable = $False ) process { $moduleResults = (Microsoft.PowerShell.Core\Get-Module @PSBoundParameters | Microsoft.PowerShell.Core\Where-Object -FilterScript { 'PSRule' -in $_.Tags -or 'PSRule-rules' -in $_.Tags } | Microsoft.PowerShell.Utility\Group-Object -Property Name) if ($Null -ne $moduleResults) { foreach ($m in $moduleResults) { @($m.Group | Microsoft.PowerShell.Utility\Sort-Object -Descending -Property Version)[0]; } } } } function LoadModule { [CmdletBinding()] [OutputType([void])] param ( [Parameter(Mandatory = $True)] [String]$Name ) process{ $Null = GetRuleModule -Name $Name -ListAvailable | Microsoft.PowerShell.Core\Import-Module -Global; } } function GetFilePath { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter(Mandatory = $True)] [PSRule.Configuration.PSRuleOption]$Option, [Parameter(Mandatory = $True)] [String[]]$Path ) process { $builder = [PSRule.Pipeline.InputPathBuilder]::new(); Write-Verbose -Message "[PSRule][D] -- Scanning for input files: $Path"; foreach ($p in $Path) { if ($p -notlike 'https://*' -and $p -notlike 'http://*') { if ([System.IO.Path]::HasExtension($p)) { $items = [System.Management.Automation.PathInfo[]]@(Resolve-Path -Path $p); $builder.Add($items); } else { $builder.Add([System.IO.FileInfo[]]@(Get-ChildItem -Path $p -ErrorAction Ignore -Recurse -File)); } } elseif (!$p.Contains('*')) { $builder.Add($p); } else { throw 'The path is not valid. Wildcards are not supported in URL input paths.'; } } $builder.Build(); } } function SetOptions { [CmdletBinding()] [OutputType([PSRule.Configuration.PSRuleOption])] param ( [Parameter(Mandatory = $True, ValueFromPipeline = $True)] [PSRule.Configuration.PSRuleOption]$InputObject, # Options # Sets the Baseline.Group option [Parameter(Mandatory = $False)] [Hashtable]$BaselineGroup, # Sets the Binding.IgnoreCase option [Parameter(Mandatory = $False)] [System.Boolean]$BindingIgnoreCase = $True, # Sets the Binding.Field option [Parameter(Mandatory = $False)] [Hashtable]$BindingField, # Sets the Binding.NameSeparator option [Parameter(Mandatory = $False)] [String]$BindingNameSeparator = '/', # Sets the Binding.PreferTargetInfo option [Parameter(Mandatory = $False)] [System.Boolean]$BindingPreferTargetInfo = $False, # Sets the Binding.TargetName option [Parameter(Mandatory = $False)] [Alias('BindingTargetName')] [String[]]$TargetName, # Sets the Binding.TargetType option [Parameter(Mandatory = $False)] [Alias('BindingTargetType')] [String[]]$TargetType, # Sets the Binding.UseQualifiedName option [Parameter(Mandatory = $False)] [System.Boolean]$BindingUseQualifiedName = $False, # Sets the Convention.Include option [Parameter(Mandatory = $False)] [Alias('ConventionInclude')] [String[]]$Convention, # Sets the Execution.Break option [Parameter(Mandatory = $False)] [PSRule.Options.BreakLevel]$ExecutionBreak = [PSRule.Options.BreakLevel]::OnError, # Sets the Execution.DuplicateResourceId option [Parameter(Mandatory = $False)] [Alias('ExecutionDuplicateResourceId')] [PSRule.Options.ExecutionActionPreference]$DuplicateResourceId = [PSRule.Options.ExecutionActionPreference]::Error, # Sets the Execution.InitialSessionState option [Parameter(Mandatory = $False)] [Alias('ExecutionInitialSessionState')] [PSRule.Options.SessionState]$InitialSessionState = [PSRule.Options.SessionState]::BuiltIn, # Sets the Execution.RestrictScriptSource option [Parameter(Mandatory = $False)] [Alias('ExecutionRestrictScriptSource')] [PSRule.Options.RestrictScriptSource]$RestrictScriptSource = [PSRule.Options.RestrictScriptSource]::Unrestricted, # Sets the Execution.SuppressionGroupExpired option [Parameter(Mandatory = $False)] [Alias('ExecutionSuppressionGroupExpired')] [PSRule.Options.ExecutionActionPreference]$SuppressionGroupExpired = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.RuleExcluded option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleExcluded = [PSRule.Options.ExecutionActionPreference]::Ignore, # Sets the Execution.RuleSuppressed option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleSuppressed = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.AliasReference option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionAliasReference = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.RuleInconclusive option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionRuleInconclusive = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.InvariantCulture option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionInvariantCulture = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Execution.UnprocessedObject option [Parameter(Mandatory = $False)] [PSRule.Options.ExecutionActionPreference]$ExecutionUnprocessedObject = [PSRule.Options.ExecutionActionPreference]::Warn, # Sets the Include.Module option [Parameter(Mandatory = $False)] [String[]]$IncludeModule, # Sets the Include.Path option [Parameter(Mandatory = $False)] [String[]]$IncludePath, # Sets the Input.FileObjects option [Parameter(Mandatory = $False)] [System.Boolean]$InputFileObjects = $False, # Sets the Input.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData')] [Alias('InputFormat')] [PSRule.Options.InputFormat]$Format = 'None', # Sets the Input.IgnoreGitPath option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreGitPath = $True, # Sets the Input.IgnoreObjectSource option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreObjectSource = $False, # Sets the Input.IgnoreRepositoryCommon option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreRepositoryCommon = $True, # Sets the Input.IgnoreUnchangedPath option [Parameter(Mandatory = $False)] [System.Boolean]$InputIgnoreUnchangedPath = $False, # Sets the Input.ObjectPath option [Parameter(Mandatory = $False)] [Alias('InputObjectPath')] [String]$ObjectPath = '', # Sets the Input.PathIgnore option [Parameter(Mandatory = $False)] [String[]]$InputPathIgnore = '', # Sets the Input.TargetType option [Parameter(Mandatory = $False)] [String[]]$InputTargetType, # Sets the Logging.LimitDebug option [Parameter(Mandatory = $False)] [String[]]$LoggingLimitDebug = $Null, # Sets the Logging.LimitVerbose option [Parameter(Mandatory = $False)] [String[]]$LoggingLimitVerbose = $Null, # Sets the Logging.RuleFail option [Parameter(Mandatory = $False)] [PSRule.Configuration.OutcomeLogStream]$LoggingRuleFail = 'None', # Sets the Logging.RulePass option [Parameter(Mandatory = $False)] [PSRule.Configuration.OutcomeLogStream]$LoggingRulePass = 'None', # Sets the Output.As option [Parameter(Mandatory = $False)] [ValidateSet('Detail', 'Summary')] [PSRule.Configuration.ResultFormat]$OutputAs = 'Detail', # Sets the Output.Banner option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'Minimal', 'None', 'Title', 'Source', 'SupportLinks', 'RepositoryInfo')] [PSRule.Configuration.BannerFormat]$OutputBanner = 'Default', # Sets the Output.Culture option [Parameter(Mandatory = $False)] [String[]]$OutputCulture, # Sets the Output.Encoding option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'UTF8', 'UTF7', 'Unicode', 'UTF32', 'ASCII')] [PSRule.Configuration.OutputEncoding]$OutputEncoding = 'Default', # Sets the Output.Footer option [Parameter(Mandatory = $False)] [ValidateSet('Default', 'None', 'RuleCount', 'RunInfo')] [PSRule.Configuration.FooterFormat]$OutputFooter = 'Default', # Sets the Output.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'NUnit3', 'Csv', 'Wide', 'Sarif')] [PSRule.Configuration.OutputFormat]$OutputFormat = 'None', # Sets the Output.JobSummaryPath option [Parameter(Mandatory = $False)] [String]$OutputJobSummaryPath = '', # Sets the Output.JsonIndent option [Parameter(Mandatory = $False)] [ValidateRange(0, 4)] [Alias('JsonIndent')] [int]$OutputJsonIndent = 0, # Sets the Output.Outcome option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Fail', 'Pass', 'Error', 'Problem', 'Processed', 'All')] [Alias('Outcome')] [PSRule.Rules.RuleOutcome]$OutputOutcome = 'Processed', # Sets the Output.Path option [Parameter(Mandatory = $False)] [String]$OutputPath = '', # Sets the Output.SarifProblemsOnly option [Parameter(Mandatory = $False)] [System.Boolean]$OutputSarifProblemsOnly = $True, # Sets the Output.Style option [Parameter(Mandatory = $False)] [ValidateSet('Client', 'Plain', 'AzurePipelines', 'GitHubActions', 'VisualStudioCode', 'Detect')] [PSRule.Configuration.OutputStyle]$OutputStyle = [PSRule.Configuration.OutputStyle]::Detect, # Sets the OverrideLevel option [Parameter(Mandatory = $False)] [Hashtable]$OverrideLevel, # Sets the Repository.BaseRef option [Parameter(Mandatory = $False)] [String]$RepositoryBaseRef, # Sets the Repository.Url option [Parameter(Mandatory = $False)] [String]$RepositoryUrl, # Sets the Rule.IncludeLocal option [Parameter(Mandatory = $False)] [System.Boolean]$RuleIncludeLocal = $False ) process { # Options # Sets option Baseline.Group if ($PSBoundParameters.ContainsKey('BaselineGroup')) { $Option.Baseline.Group = $BaselineGroup; } # Sets option Binding.IgnoreCase if ($PSBoundParameters.ContainsKey('BindingIgnoreCase')) { $Option.Binding.IgnoreCase = $BindingIgnoreCase; } # Sets option Binding.PreferTargetInfo if ($PSBoundParameters.ContainsKey('BindingPreferTargetInfo')) { $Option.Binding.PreferTargetInfo = $BindingPreferTargetInfo; } # Sets option Binding.Field if ($PSBoundParameters.ContainsKey('BindingField')) { $Option.Binding.Field = $BindingField; } # Sets option Binding.NameSeparator if ($PSBoundParameters.ContainsKey('BindingNameSeparator')) { $Option.Binding.NameSeparator = $BindingNameSeparator; } # Sets option Binding.TargetName if ($PSBoundParameters.ContainsKey('TargetName')) { $Option.Binding.TargetName = $TargetName; } # Sets option Binding.TargetType if ($PSBoundParameters.ContainsKey('TargetType')) { $Option.Binding.TargetType = $TargetType; } # Sets option Binding.UseQualifiedName if ($PSBoundParameters.ContainsKey('BindingUseQualifiedName')) { $Option.Binding.UseQualifiedName = $BindingUseQualifiedName; } # Sets option Convention.Include if ($PSBoundParameters.ContainsKey('Convention')) { $Option.Convention.Include = $Convention; } # Sets option Execution.Break if ($PSBoundParameters.ContainsKey('ExecutionBreak')) { $Option.Execution.Break = $ExecutionBreak; } # Sets option Execution.DuplicateResourceId if ($PSBoundParameters.ContainsKey('DuplicateResourceId')) { $Option.Execution.DuplicateResourceId = $DuplicateResourceId; } # Sets option Execution.InitialSessionState if ($PSBoundParameters.ContainsKey('InitialSessionState')) { $Option.Execution.InitialSessionState = $InitialSessionState; } # Sets option Execution.RestrictScriptSource if ($PSBoundParameters.ContainsKey('RestrictScriptSource')) { $Option.Execution.RestrictScriptSource = $RestrictScriptSource; } # Sets option Execution.SuppressionGroupExpired if ($PSBoundParameters.ContainsKey('SuppressionGroupExpired')) { $Option.Execution.SuppressionGroupExpired = $SuppressionGroupExpired; } # Sets option Execution.RuleExcluded if ($PSBoundParameters.ContainsKey('ExecutionRuleExcluded')) { $Option.Execution.RuleExcluded = $ExecutionRuleExcluded; } # Sets option Execution.RuleSuppressed if ($PSBoundParameters.ContainsKey('ExecutionRuleSuppressed')) { $Option.Execution.RuleSuppressed = $ExecutionRuleSuppressed; } # Sets option Execution.AliasReference if ($PSBoundParameters.ContainsKey('ExecutionAliasReference')) { $Option.Execution.AliasReference = $ExecutionAliasReference; } # Sets option Execution.RuleInconclusive if ($PSBoundParameters.ContainsKey('ExecutionRuleInconclusive')) { $Option.Execution.RuleInconclusive = $ExecutionRuleInconclusive; } # Sets option Execution.InvariantCulture if ($PSBoundParameters.ContainsKey('ExecutionInvariantCulture')) { $Option.Execution.InvariantCulture = $ExecutionInvariantCulture; } # Sets option Execution.UnprocessedObject if ($PSBoundParameters.ContainsKey('ExecutionUnprocessedObject')) { $Option.Execution.UnprocessedObject = $ExecutionUnprocessedObject; } # Sets option Include.Module if ($PSBoundParameters.ContainsKey('IncludeModule')) { $Option.Include.Module = $IncludeModule; } # Sets option Include.Path if ($PSBoundParameters.ContainsKey('IncludePath')) { $Option.Include.Path = $IncludePath; } # Sets option Input.FileObjects if ($PSBoundParameters.ContainsKey('InputFileObjects')) { $Option.Input.FileObjects = $InputFileObjects; } # Sets option Input.Format if ($PSBoundParameters.ContainsKey('Format')) { $Option.Input.Format = $Format; } # Sets option Input.IgnoreGitPath if ($PSBoundParameters.ContainsKey('InputIgnoreGitPath')) { $Option.Input.IgnoreGitPath = $InputIgnoreGitPath; } # Sets option Input.IgnoreObjectSource if ($PSBoundParameters.ContainsKey('InputIgnoreObjectSource')) { $Option.Input.IgnoreObjectSource = $InputIgnoreObjectSource; } # Sets option Input.IgnoreRepositoryCommon if ($PSBoundParameters.ContainsKey('InputIgnoreRepositoryCommon')) { $Option.Input.IgnoreRepositoryCommon = $InputIgnoreRepositoryCommon; } # Sets option Input.IgnoreUnchangedPath if ($PSBoundParameters.ContainsKey('InputIgnoreUnchangedPath')) { $Option.Input.IgnoreUnchangedPath = $InputIgnoreUnchangedPath; } # Sets option Input.ObjectPath if ($PSBoundParameters.ContainsKey('ObjectPath')) { $Option.Input.ObjectPath = $ObjectPath; } # Sets option Input.PathIgnore if ($PSBoundParameters.ContainsKey('InputPathIgnore')) { $Option.Input.PathIgnore = $InputPathIgnore; } # Sets option Input.TargetType if ($PSBoundParameters.ContainsKey('InputTargetType')) { $Option.Input.TargetType = $InputTargetType; } # Sets option Logging.LimitDebug if ($PSBoundParameters.ContainsKey('LoggingLimitDebug')) { $Option.Logging.LimitDebug = $LoggingLimitDebug; } # Sets option Logging.LimitVerbose if ($PSBoundParameters.ContainsKey('LoggingLimitVerbose')) { $Option.Logging.LimitVerbose = $LoggingLimitVerbose; } # Sets option Logging.RuleFail if ($PSBoundParameters.ContainsKey('LoggingRuleFail')) { $Option.Logging.RuleFail = $LoggingRuleFail; } # Sets option Logging.RulePass if ($PSBoundParameters.ContainsKey('LoggingRulePass')) { $Option.Logging.RulePass = $LoggingRulePass; } # Sets option Output.As if ($PSBoundParameters.ContainsKey('OutputAs')) { $Option.Output.As = $OutputAs; } # Sets option Output.Banner if ($PSBoundParameters.ContainsKey('OutputBanner')) { $Option.Output.Banner = $OutputBanner; } # Sets option Output.Culture if ($PSBoundParameters.ContainsKey('OutputCulture')) { $Option.Output.Culture = $OutputCulture; } # Sets option Output.Encoding if ($PSBoundParameters.ContainsKey('OutputEncoding')) { $Option.Output.Encoding = $OutputEncoding; } # Sets option Output.Footer if ($PSBoundParameters.ContainsKey('OutputFooter')) { $Option.Output.Footer = $OutputFooter; } # Sets option Output.Format if ($PSBoundParameters.ContainsKey('OutputFormat')) { $Option.Output.Format = $OutputFormat; } # Sets option Output.OutputJobSummaryPath if ($PSBoundParameters.ContainsKey('OutputJobSummaryPath')) { $Option.Output.JobSummaryPath = $OutputJobSummaryPath; } # Sets option Output.JsonIndent if ($PSBoundParameters.ContainsKey('OutputJsonIndent')) { $Option.Output.JsonIndent = $OutputJsonIndent; } # Sets option Output.Outcome if ($PSBoundParameters.ContainsKey('OutputOutcome')) { $Option.Output.Outcome = $OutputOutcome; } # Sets option Output.Path if ($PSBoundParameters.ContainsKey('OutputPath')) { $Option.Output.Path = $OutputPath; } # Sets option Output.SarifProblemsOnly if ($PSBoundParameters.ContainsKey('OutputSarifProblemsOnly')) { $Option.Output.SarifProblemsOnly = $OutputSarifProblemsOnly; } # Sets option Output.Style if ($PSBoundParameters.ContainsKey('OutputStyle')) { $Option.Output.Style = $OutputStyle; } # Sets option Override.Level if ($PSBoundParameters.ContainsKey('OverrideLevel')) { $Option.Override.Level = $OverrideLevel; } # Sets option Repository.BaseRef if ($PSBoundParameters.ContainsKey('RepositoryBaseRef')) { $Option.Repository.BaseRef = $RepositoryBaseRef; } # Sets option Repository.Url if ($PSBoundParameters.ContainsKey('RepositoryUrl')) { $Option.Repository.Url = $RepositoryUrl; } # Sets option Rule.IncludeLocal if ($PSBoundParameters.ContainsKey('RuleIncludeLocal')) { $Option.Rule.IncludeLocal = $RuleIncludeLocal; } return $Option; } } function YamlContainsComments { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $True)] [String]$Path ) process { if (!(Test-Path -Path $Path)) { return $False; } return (Get-Content -Path $Path -Raw) -match '(?:(^[ \t]*)|[ \t]+|)(?=\#|^\#)'; } } function IsDeviceGuardEnabled { [CmdletBinding()] [OutputType([System.Boolean])] param () process { if ((Get-Variable -Name IsMacOS -ErrorAction Ignore) -or (Get-Variable -Name IsLinux -ErrorAction Ignore)) { return $False; } # PowerShell 6.0.x does not support Device Guard if ($PSVersionTable.PSVersion -ge '6.0' -and $PSVersionTable.PSVersion -lt '6.1') { return $False; } return [System.Management.Automation.Security.SystemPolicy]::GetSystemLockdownPolicy() -eq [System.Management.Automation.Security.SystemEnforcementMode]::Enforce; } } function InitEditorServices { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalAliases', '', Justification = 'Alias is used for editor discovery only.', Scope = 'Function')] [CmdletBinding()] param () process { if ($Null -ne (Get-Variable -Name psEditor -ErrorAction Ignore)) { # Export keywords Export-ModuleMember -Function @( 'AllOf' 'AnyOf' 'Exists' 'Match' 'TypeOf' 'Within' 'Reason' 'Recommend' 'Export-PSRuleConvention' ); # Export variables Export-ModuleMember -Variable @( 'Assert' 'Configuration' 'LocalizedData' 'PSRule' 'Rule' 'TargetObject' ); } } } function InitCompletionServices { [CmdletBinding()] param () process { # Complete -Module parameter Register-ArgumentCompleter -CommandName Assert-PSRule,Get-PSRule,Get-PSRuleBaseline,Get-PSRuleHelp,Invoke-PSRule,Test-PSRuleTarget -ParameterName Module -ScriptBlock { param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter) GetRuleModule -Name "$wordToComplete*" -ListAvailable | ForEach-Object -Process { [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', ([String]::Concat("ModuleName: ", $_.Name, ", ModuleVersion: ", $_.Version.ToString()))) } } } } # # Editor services # # Define variables and types [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSRule.Runtime.Assert]$Assert = New-Object -TypeName 'PSRule.Runtime.Assert'; [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSObject]$Configuration = $Null; [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSRule.Runtime.PSRule]$PSRule = New-Object -TypeName 'PSRule.Runtime.PSRule'; [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSRule.Runtime.Rule]$Rule = New-Object -TypeName 'PSRule.Runtime.Rule'; [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSObject]$TargetObject = New-Object -TypeName 'PSObject'; [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignment', '', Justification = 'Variable is used for editor discovery only.')] [PSObject]$LocalizedData = $Null; InitEditorServices; InitCompletionServices; # # Export module # Export-ModuleMember -Function @( 'Rule' 'Invoke-PSRule' 'Test-PSRuleTarget' 'Get-PSRuleTarget' 'Assert-PSRule' 'Get-PSRule' 'Get-PSRuleHelp' 'Get-PSRuleBaseline' 'Export-PSRuleBaseline' 'New-PSRuleOption' 'Set-PSRuleOption' ) # EOM # SIG # Begin signature block # MIIoOwYJKoZIhvcNAQcCoIIoLDCCKCgCAQExDzANBglghkgBZQMEAgEFADB5Bgor # BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG # KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCASG16qCJq1r10D # ef+XNqoBI5589iURiP2duhlhmTKOeaCCDYUwggYDMIID66ADAgECAhMzAAAEA73V # lV0POxitAAAAAAQDMA0GCSqGSIb3DQEBCwUAMH4xCzAJBgNVBAYTAlVTMRMwEQYD # VQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24xKDAmBgNVBAMTH01pY3Jvc29mdCBDb2RlIFNpZ25p # bmcgUENBIDIwMTEwHhcNMjQwOTEyMjAxMTEzWhcNMjUwOTExMjAxMTEzWjB0MQsw # CQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9u # ZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMR4wHAYDVQQDExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB # AQCfdGddwIOnbRYUyg03O3iz19XXZPmuhEmW/5uyEN+8mgxl+HJGeLGBR8YButGV # LVK38RxcVcPYyFGQXcKcxgih4w4y4zJi3GvawLYHlsNExQwz+v0jgY/aejBS2EJY # oUhLVE+UzRihV8ooxoftsmKLb2xb7BoFS6UAo3Zz4afnOdqI7FGoi7g4vx/0MIdi # kwTn5N56TdIv3mwfkZCFmrsKpN0zR8HD8WYsvH3xKkG7u/xdqmhPPqMmnI2jOFw/ # /n2aL8W7i1Pasja8PnRXH/QaVH0M1nanL+LI9TsMb/enWfXOW65Gne5cqMN9Uofv # ENtdwwEmJ3bZrcI9u4LZAkujAgMBAAGjggGCMIIBfjAfBgNVHSUEGDAWBgorBgEE # AYI3TAgBBggrBgEFBQcDAzAdBgNVHQ4EFgQU6m4qAkpz4641iK2irF8eWsSBcBkw # VAYDVR0RBE0wS6RJMEcxLTArBgNVBAsTJE1pY3Jvc29mdCBJcmVsYW5kIE9wZXJh # dGlvbnMgTGltaXRlZDEWMBQGA1UEBRMNMjMwMDEyKzUwMjkyNjAfBgNVHSMEGDAW # gBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8v # d3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIw # MTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDov # L3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDEx # XzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIB # AFFo/6E4LX51IqFuoKvUsi80QytGI5ASQ9zsPpBa0z78hutiJd6w154JkcIx/f7r # EBK4NhD4DIFNfRiVdI7EacEs7OAS6QHF7Nt+eFRNOTtgHb9PExRy4EI/jnMwzQJV # NokTxu2WgHr/fBsWs6G9AcIgvHjWNN3qRSrhsgEdqHc0bRDUf8UILAdEZOMBvKLC # rmf+kJPEvPldgK7hFO/L9kmcVe67BnKejDKO73Sa56AJOhM7CkeATrJFxO9GLXos # oKvrwBvynxAg18W+pagTAkJefzneuWSmniTurPCUE2JnvW7DalvONDOtG01sIVAB # +ahO2wcUPa2Zm9AiDVBWTMz9XUoKMcvngi2oqbsDLhbK+pYrRUgRpNt0y1sxZsXO # raGRF8lM2cWvtEkV5UL+TQM1ppv5unDHkW8JS+QnfPbB8dZVRyRmMQ4aY/tx5x5+ # sX6semJ//FbiclSMxSI+zINu1jYerdUwuCi+P6p7SmQmClhDM+6Q+btE2FtpsU0W # +r6RdYFf/P+nK6j2otl9Nvr3tWLu+WXmz8MGM+18ynJ+lYbSmFWcAj7SYziAfT0s # IwlQRFkyC71tsIZUhBHtxPliGUu362lIO0Lpe0DOrg8lspnEWOkHnCT5JEnWCbzu # iVt8RX1IV07uIveNZuOBWLVCzWJjEGa+HhaEtavjy6i7MIIHejCCBWKgAwIBAgIK # YQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNV # BAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jv # c29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlm # aWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEw # OTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UE # BxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYD # VQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG # 9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+la # UKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc # 6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4D # dato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+ # lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nk # kDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6 # A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmd # X4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL # 5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zd # sGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3 # T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS # 4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRI # bmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAL # BgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBD # uRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jv # c29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFf # MDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3 # dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFf # MDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEF # BQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1h # cnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkA # YwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn # 8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7 # v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0b # pdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/ # KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvy # CInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBp # mLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJi # hsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYb # BL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbS # oqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sL # gOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtX # cVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzTGCGgwwghoIAgEBMIGVMH4x # CzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRt # b25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xKDAmBgNVBAMTH01p # Y3Jvc29mdCBDb2RlIFNpZ25pbmcgUENBIDIwMTECEzMAAAQDvdWVXQ87GK0AAAAA # BAMwDQYJYIZIAWUDBAIBBQCgga4wGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcCAQQw # HAYKKwYBBAGCNwIBCzEOMAwGCisGAQQBgjcCARUwLwYJKoZIhvcNAQkEMSIEIHaP # PI4hoq4qWd2vdkRXzfqkL2YNzJeIRQ12BY++NvfbMEIGCisGAQQBgjcCAQwxNDAy # oBSAEgBNAGkAYwByAG8AcwBvAGYAdKEagBhodHRwOi8vd3d3Lm1pY3Jvc29mdC5j # b20wDQYJKoZIhvcNAQEBBQAEggEAm7UCwAQFYOb4Vxd7tL4L/r6+bxtGOrk2BCqR # MRohsgU3dnqK63ydqaQ5ngZZmzP8KoXsKk1EQtBgfRFpFazytlfH7NOHYZIVWQsv # sTz22XJjbNpd9nHHtfXzbLVx6CII6Nq887SSekv/nX1upq4tM4GQAE+5X1S9PXy7 # BHSLX4FFVdHDD/ctEMh/u19pd/+X2VJkm6l85v4nA6EB68tOWgsadtjdvxcKeDrS # pMXnzCTfZUC8gFRTPK+KCC3NqTcYN8xS1ylw+AaSQL4hYg0NzhHebuGqfSlEtyem # yq2z2IPucH3UC1GWy1uPPqywAW62EGLV3FhUqFb+yF2ySZpmUaGCF5YwgheSBgor # BgEEAYI3AwMBMYIXgjCCF34GCSqGSIb3DQEHAqCCF28wghdrAgEDMQ8wDQYJYIZI # AWUDBAIBBQAwggFSBgsqhkiG9w0BCRABBKCCAUEEggE9MIIBOQIBAQYKKwYBBAGE # WQoDATAxMA0GCWCGSAFlAwQCAQUABCBjQJOgIcgdM0K6rWq9ct/5RtR+l/MhuXx4 # fuUhXBYLWgIGZ4kDCNxHGBMyMDI1MDExNjE3Mzg0NS44MTVaMASAAgH0oIHRpIHO # MIHLMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMH # UmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSUwIwYDVQQL # ExxNaWNyb3NvZnQgQW1lcmljYSBPcGVyYXRpb25zMScwJQYDVQQLEx5uU2hpZWxk # IFRTUyBFU046OTYwMC0wNUUwLUQ5NDcxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1l # LVN0YW1wIFNlcnZpY2WgghHsMIIHIDCCBQigAwIBAgITMwAAAe+JP1ahWMyo2gAB # AAAB7zANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2Fz # aGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENv # cnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAx # MDAeFw0yMzEyMDYxODQ1NDhaFw0yNTAzMDUxODQ1NDhaMIHLMQswCQYDVQQGEwJV # UzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UE # ChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSUwIwYDVQQLExxNaWNyb3NvZnQgQW1l # cmljYSBPcGVyYXRpb25zMScwJQYDVQQLEx5uU2hpZWxkIFRTUyBFU046OTYwMC0w # NUUwLUQ5NDcxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2Uw # ggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCjC1jinwzgHwhOakZqy17o # E4BIBKsm5kX4DUmCBWI0lFVpEiK5mZ2Kh59soL4ns52phFMQYGG5kypCipungwP9 # Nob4VGVE6aoMo5hZ9NytXR5ZRgb9Z8NR6EmLKICRhD4sojPMg/RnGRTcdf7/TYvy # M10jLjmLyKEegMHfvIwPmM+AP7hzQLfExDdqCJ2u64Gd5XlnrFOku5U9jLOKk1y7 # 0c+Twt04/RLqruv1fGP8LmYmtHvrB4TcBsADXSmcFjh0VgQkX4zXFwqnIG8rgY+z # DqJYQNZP8O1Yo4kSckHT43XC0oM40ye2+9l/rTYiDFM3nlZe2jhtOkGCO6GqiTp5 # 0xI9ITpJXi0vEek8AejT4PKMEO2bPxU63p63uZbjdN5L+lgIcCNMCNI0SIopS4ga # VR4Sy/IoDv1vDWpe+I28/Ky8jWTeed0O3HxPJMZqX4QB3I6DnwZrHiKn6oE38tgB # TCCAKvEoYOTg7r2lF0Iubt/3+VPvKtTCUbZPFOG8jZt9q6AFodlvQntiolYIYtqS # rLyXAQIlXGhZ4gNcv4dv1YAilnbWA9CsnYh+OKEFr/4w4M69lI+yaoZ3L/t/UfXp # T/+yc7hS/FolcmrGFJTBYlS4nE1cuKblwZ/UOG26SLhDONWXGZDKMJKN53oOLSSk # 4ldR0HlsbT4heLlWlOElJQIDAQABo4IBSTCCAUUwHQYDVR0OBBYEFO1MWqKFwrCb # trw9P8A63bAVSJzLMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8G # A1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMv # Y3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBs # BggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0 # LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUy # MDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUH # AwgwDgYDVR0PAQH/BAQDAgeAMA0GCSqGSIb3DQEBCwUAA4ICAQAYGZa3aCDudbk9 # EVdkP8xcQGZuIAIPRx9K1CA7uRzBt80fC0aWkuYYhQMvHHJRHUobSM4Uw3zN7fHE # N8hhaBDb9NRaGnFWdtHxmJ9eMz6Jpn6KiIyi9U5Og7QCTZMl17n2w4eddq5vtk4r # RWOVvpiDBGJARKiXWB9u2ix0WH2EMFGHqjIhjWUXhPgR4C6NKFNXHvWvXecJ2WXr # JnvvQGXAfNJGETJZGpR41nUN3ijfiCSjFDxamGPsy5iYu904Hv9uuSXYd5m0Jxf2 # WNJSXkPGlNhrO27pPxgT111myAR61S3S2hc572zN9yoJEObE98Vy5KEM3ZX53cLe # fN81F1C9p/cAKkE6u9V6ryyl/qSgxu1UqeOZCtG/iaHSKMoxM7Mq4SMFsPT/8ieO # dwClYpcw0CjZe5KBx2xLa4B1neFib8J8/gSosjMdF3nHiyHx1YedZDtxSSgegeJs # i0fbUgdzsVMJYvqVw52WqQNu0GRC79ZuVreUVKdCJmUMBHBpTp6VFopL0Jf4Srgg # +zRD9iwbc9uZrn+89odpInbznYrnPKHiO26qe1ekNwl/d7ro2ItP/lghz0DoD7kE # GeikKJWHdto7eVJoJhkrUcanTuUH08g+NYwG6S+PjBSB/NyNF6bHa/xR+ceAYhcj # x0iBiv90Mn0JiGfnA2/hLj5evhTcAjCCB3EwggVZoAMCAQICEzMAAAAVxedrngKb # SZkAAAAAABUwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQI # EwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3Nv # ZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBSb290IENlcnRpZmlj # YXRlIEF1dGhvcml0eSAyMDEwMB4XDTIxMDkzMDE4MjIyNVoXDTMwMDkzMDE4MzIy # NVowfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcT # B1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UE # AxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwggIiMA0GCSqGSIb3DQEB # AQUAA4ICDwAwggIKAoICAQDk4aZM57RyIQt5osvXJHm9DtWC0/3unAcH0qlsTnXI # yjVX9gF/bErg4r25PhdgM/9cT8dm95VTcVrifkpa/rg2Z4VGIwy1jRPPdzLAEBjo # YH1qUoNEt6aORmsHFPPFdvWGUNzBRMhxXFExN6AKOG6N7dcP2CZTfDlhAnrEqv1y # aa8dq6z2Nr41JmTamDu6GnszrYBbfowQHJ1S/rboYiXcag/PXfT+jlPP1uyFVk3v # 3byNpOORj7I5LFGc6XBpDco2LXCOMcg1KL3jtIckw+DJj361VI/c+gVVmG1oO5pG # ve2krnopN6zL64NF50ZuyjLVwIYwXE8s4mKyzbnijYjklqwBSru+cakXW2dg3viS # kR4dPf0gz3N9QZpGdc3EXzTdEonW/aUgfX782Z5F37ZyL9t9X4C626p+Nuw2TPYr # bqgSUei/BQOj0XOmTTd0lBw0gg/wEPK3Rxjtp+iZfD9M269ewvPV2HM9Q07BMzlM # jgK8QmguEOqEUUbi0b1qGFphAXPKZ6Je1yh2AuIzGHLXpyDwwvoSCtdjbwzJNmSL # W6CmgyFdXzB0kZSU2LlQ+QuJYfM2BjUYhEfb3BvR/bLUHMVr9lxSUV0S2yW6r1AF # emzFER1y7435UsSFF5PAPBXbGjfHCBUYP3irRbb1Hode2o+eFnJpxq57t7c+auIu # rQIDAQABo4IB3TCCAdkwEgYJKwYBBAGCNxUBBAUCAwEAATAjBgkrBgEEAYI3FQIE # FgQUKqdS/mTEmr6CkTxGNSnPEP8vBO4wHQYDVR0OBBYEFJ+nFV0AXmJdg/Tl0mWn # G1M1GelyMFwGA1UdIARVMFMwUQYMKwYBBAGCN0yDfQEBMEEwPwYIKwYBBQUHAgEW # M2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvRG9jcy9SZXBvc2l0b3J5 # Lmh0bTATBgNVHSUEDDAKBggrBgEFBQcDCDAZBgkrBgEEAYI3FAIEDB4KAFMAdQBi # AEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBTV # 9lbLj+iiXGJo0T2UkFvXzpoYxDBWBgNVHR8ETzBNMEugSaBHhkVodHRwOi8vY3Js # Lm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXRfMjAx # MC0wNi0yMy5jcmwwWgYIKwYBBQUHAQEETjBMMEoGCCsGAQUFBzAChj5odHRwOi8v # d3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY1Jvb0NlckF1dF8yMDEwLTA2 # LTIzLmNydDANBgkqhkiG9w0BAQsFAAOCAgEAnVV9/Cqt4SwfZwExJFvhnnJL/Klv # 6lwUtj5OR2R4sQaTlz0xM7U518JxNj/aZGx80HU5bbsPMeTCj/ts0aGUGCLu6WZn # OlNN3Zi6th542DYunKmCVgADsAW+iehp4LoJ7nvfam++Kctu2D9IdQHZGN5tggz1 # bSNU5HhTdSRXud2f8449xvNo32X2pFaq95W2KFUn0CS9QKC/GbYSEhFdPSfgQJY4 # rPf5KYnDvBewVIVCs/wMnosZiefwC2qBwoEZQhlSdYo2wh3DYXMuLGt7bj8sCXgU # 6ZGyqVvfSaN0DLzskYDSPeZKPmY7T7uG+jIa2Zb0j/aRAfbOxnT99kxybxCrdTDF # NLB62FD+CljdQDzHVG2dY3RILLFORy3BFARxv2T5JL5zbcqOCb2zAVdJVGTZc9d/ # HltEAY5aGZFrDZ+kKNxnGSgkujhLmm77IVRrakURR6nxt67I6IleT53S0Ex2tVdU # CbFpAUR+fKFhbHP+CrvsQWY9af3LwUFJfn6Tvsv4O+S3Fb+0zj6lMVGEvL8CwYKi # excdFYmNcP7ntdAoGokLjzbaukz5m/8K6TT4JDVnK+ANuOaMmdbhIurwJ0I9JZTm # dHRbatGePu1+oDEzfbzL6Xu/OHBE0ZDxyKs6ijoIYn/ZcGNTTY3ugm2lBRDBcQZq # ELQdVTNYs6FwZvKhggNPMIICNwIBATCB+aGB0aSBzjCByzELMAkGA1UEBhMCVVMx # EzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoT # FU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjElMCMGA1UECxMcTWljcm9zb2Z0IEFtZXJp # Y2EgT3BlcmF0aW9uczEnMCUGA1UECxMeblNoaWVsZCBUU1MgRVNOOjk2MDAtMDVF # MC1EOTQ3MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiMK # AQEwBwYFKw4DAhoDFQBLcI81gxbea1Ex2mFbXx7ck+0g/6CBgzCBgKR+MHwxCzAJ # BgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25k # MR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jv # c29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMA0GCSqGSIb3DQEBCwUAAgUA6zOBhjAi # GA8yMDI1MDExNjEzMDA1NFoYDzIwMjUwMTE3MTMwMDU0WjB2MDwGCisGAQQBhFkK # BAExLjAsMAoCBQDrM4GGAgEAMAkCAQACARQCAf8wBwIBAAICE1MwCgIFAOs00wYC # AQAwNgYKKwYBBAGEWQoEAjEoMCYwDAYKKwYBBAGEWQoDAqAKMAgCAQACAwehIKEK # MAgCAQACAwGGoDANBgkqhkiG9w0BAQsFAAOCAQEAHcPFdirxr+5ncBYu/V2r1mO5 # tWkTCZ2z+fkF1QTe5OZ61aCKGqkrb+ZKvb48x4cR0PI0CxkIf2GcOw+Z2+v9zYxs # sedFByw5bKyxaQYO3xQ0WY844o6ONI4zZ0ib3RQJ5Y50072xL8V9bPXwU2++CJ2V # I+infVnG4ogBjAr/E3mV0A6fwDgbzfXAyJX1MGA7n3ajQPEsyUJnkuiIt9flrbFN # I1HMH95oejIFcMnbq8dr2jhObbikCYuH0KFFswaMsUPqALhecvC9vvbK4U+o6Xr1 # u03IqQ+TLIsyIy2oDuosYn6itV0ksyxyFreK/Q8cnbMj7TlEg5USvjdgyMpcDjGC # BA0wggQJAgEBMIGTMHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9u # MRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRp # b24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwAhMzAAAB # 74k/VqFYzKjaAAEAAAHvMA0GCWCGSAFlAwQCAQUAoIIBSjAaBgkqhkiG9w0BCQMx # DQYLKoZIhvcNAQkQAQQwLwYJKoZIhvcNAQkEMSIEIK9JYxOtFSUwJD89Ym+xpOps # XEbiPFtwsap8VtCN8OnOMIH6BgsqhkiG9w0BCRACLzGB6jCB5zCB5DCBvQQg8GEo # RbgWjfBTPT01DHZrQNtx2xfyOi8zkuLMeafJf6MwgZgwgYCkfjB8MQswCQYDVQQG # EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwG # A1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQg # VGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAe+JP1ahWMyo2gABAAAB7zAiBCDMkpAc # VsRj/L3kn4iVc1E2PsjiHaPnd5i/aXL1pbH2QTANBgkqhkiG9w0BAQsFAASCAgCX # ue8twEoaw7ItZiO/aqzqEO8BlxBR0E0x+qPmJ2pKW15ctNZvyBCMgZbKSi0Ya+dy # /3sdOJi9AHMOsnoXxVhGFFEjaNTqltjCOvhBiRoY5jfgBOu4msrJQYgdUyGRsUMg # nWcrFuRkwAeCmN9nQhXLed99A00cvGL2bsbiE7WE27xpyNnAI15K5boePEywOJZh # uWUri3FT18cHdU+Gk7tt74o48cUbIXdfhwoGR3eHh5JGVrYSvUw3PWSScS3fXXpA # BR6AJ6FDxTg/MO8YK1vSPlGy8+4levVHgu8ZLrmTi1/mW2epN0ziWL9StDkeTNMm # fPmmnChNMOI4bz/YVL00xC9VeuRhdSoPeh4jfaEKCJZNM8waP2ld3ilPMjw24tW1 # ZJ27itXuCdcDtMErKou1MQQodIGzgcYNLWI0uubUjr2k6KPhjVx/n3nGGoxitOkV # zn2sNUF8UBbIxaJMnNMdvc2pJmF8iJQu2EjBz55Y2EBB6fCUEi8jS750ufspQjdA # P4MOCtVfzKHffKfUD/MFVVmFMAxScZdkLBZzK5eXGBvbc3JMUKPXZiCsHJWIoWWh # iAh3WKd3Scd5l+xZk4zgbKT2zwYQWk/Cf1M4WWd6HV3GZP4qi1YN5mibR96s8Kkg # dPXDpnXEsG+kJYeaBvtiRS2qpJKHSU2Gjlw9TSiDcQ== # SIG # End signature block |