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', 'File', 'Detect')] [PSRule.Configuration.InputFormat]$Format = [PSRule.Configuration.InputFormat]::Detect, [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', 'File', 'Detect')] [PSRule.Configuration.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', 'File', 'Detect')] [PSRule.Configuration.InputFormat]$Format = [PSRule.Configuration.InputFormat]::Detect, [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', 'File', 'Detect')] [PSRule.Configuration.InputFormat]$Format = [PSRule.Configuration.InputFormat]::Detect, [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, [Parameter(Mandatory = $False)] [PSRule.Configuration.BindTargetName[]]$BindTargetName, [Parameter(Mandatory = $False)] [PSRule.Configuration.BindTargetName[]]$BindTargetType, # 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.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.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData', 'Detect')] [Alias('InputFormat')] [PSRule.Configuration.InputFormat]$Format = 'Detect', # 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', '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 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 ($optionParams.ContainsKey('BindTargetName')) { $optionParams.Remove('BindTargetName'); } if ($optionParams.ContainsKey('BindTargetType')) { $optionParams.Remove('BindTargetType'); } 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; } if ($PSBoundParameters.ContainsKey('BindTargetName')) { Write-Verbose -Message 'Set BindTargetName pipeline hook'; $Option.Pipeline.BindTargetName.AddRange($BindTargetName); } if ($PSBoundParameters.ContainsKey('BindTargetType')) { Write-Verbose -Message 'Set BindTargetType pipeline hook'; $Option.Pipeline.BindTargetType.AddRange($BindTargetType); } # 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.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.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData', 'Detect')] [Alias('InputFormat')] [PSRule.Configuration.InputFormat]$Format = 'Detect', # 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', '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 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.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.Format option [Parameter(Mandatory = $False)] [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'PowerShellData', 'Detect')] [Alias('InputFormat')] [PSRule.Configuration.InputFormat]$Format = 'Detect', # 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', '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 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.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.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 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 # MIInvwYJKoZIhvcNAQcCoIInsDCCJ6wCAQExDzANBglghkgBZQMEAgEFADB5Bgor # BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG # KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCAGWAvKSEKLx4LF # UDYC/9Uf7aqe/LWftjGkDJLaxWkM/6CCDXYwggX0MIID3KADAgECAhMzAAADrzBA # DkyjTQVBAAAAAAOvMA0GCSqGSIb3DQEBCwUAMH4xCzAJBgNVBAYTAlVTMRMwEQYD # VQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24xKDAmBgNVBAMTH01pY3Jvc29mdCBDb2RlIFNpZ25p # bmcgUENBIDIwMTEwHhcNMjMxMTE2MTkwOTAwWhcNMjQxMTE0MTkwOTAwWjB0MQsw # CQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9u # ZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMR4wHAYDVQQDExVNaWNy # b3NvZnQgQ29ycG9yYXRpb24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB # AQDOS8s1ra6f0YGtg0OhEaQa/t3Q+q1MEHhWJhqQVuO5amYXQpy8MDPNoJYk+FWA # hePP5LxwcSge5aen+f5Q6WNPd6EDxGzotvVpNi5ve0H97S3F7C/axDfKxyNh21MG # 0W8Sb0vxi/vorcLHOL9i+t2D6yvvDzLlEefUCbQV/zGCBjXGlYJcUj6RAzXyeNAN # xSpKXAGd7Fh+ocGHPPphcD9LQTOJgG7Y7aYztHqBLJiQQ4eAgZNU4ac6+8LnEGAL # go1ydC5BJEuJQjYKbNTy959HrKSu7LO3Ws0w8jw6pYdC1IMpdTkk2puTgY2PDNzB # tLM4evG7FYer3WX+8t1UMYNTAgMBAAGjggFzMIIBbzAfBgNVHSUEGDAWBgorBgEE # AYI3TAgBBggrBgEFBQcDAzAdBgNVHQ4EFgQURxxxNPIEPGSO8kqz+bgCAQWGXsEw # RQYDVR0RBD4wPKQ6MDgxHjAcBgNVBAsTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEW # MBQGA1UEBRMNMjMwMDEyKzUwMTgyNjAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzci # tW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5j # b20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEG # CCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQu # Y29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0 # MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAISxFt/zR2frTFPB45Yd # mhZpB2nNJoOoi+qlgcTlnO4QwlYN1w/vYwbDy/oFJolD5r6FMJd0RGcgEM8q9TgQ # 2OC7gQEmhweVJ7yuKJlQBH7P7Pg5RiqgV3cSonJ+OM4kFHbP3gPLiyzssSQdRuPY # 1mIWoGg9i7Y4ZC8ST7WhpSyc0pns2XsUe1XsIjaUcGu7zd7gg97eCUiLRdVklPmp # XobH9CEAWakRUGNICYN2AgjhRTC4j3KJfqMkU04R6Toyh4/Toswm1uoDcGr5laYn # TfcX3u5WnJqJLhuPe8Uj9kGAOcyo0O1mNwDa+LhFEzB6CB32+wfJMumfr6degvLT # e8x55urQLeTjimBQgS49BSUkhFN7ois3cZyNpnrMca5AZaC7pLI72vuqSsSlLalG # OcZmPHZGYJqZ0BacN274OZ80Q8B11iNokns9Od348bMb5Z4fihxaBWebl8kWEi2O # PvQImOAeq3nt7UWJBzJYLAGEpfasaA3ZQgIcEXdD+uwo6ymMzDY6UamFOfYqYWXk # ntxDGu7ngD2ugKUuccYKJJRiiz+LAUcj90BVcSHRLQop9N8zoALr/1sJuwPrVAtx # HNEgSW+AKBqIxYWM4Ev32l6agSUAezLMbq5f3d8x9qzT031jMDT+sUAoCw0M5wVt # CUQcqINPuYjbS1WgJyZIiEkBMIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkq # hkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24x # EDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlv # bjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5 # IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQG # EwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwG # A1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQg # Q29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIIC # CgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03 # a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akr # rnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0Rrrg # OGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy # 4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9 # sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAh # dCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8k # A/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTB # w3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmn # Eyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90 # lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0w # ggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2o # ynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYD # VR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBa # BgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2Ny # bC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsG # AQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29t # L3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNV # HSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3 # dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsG # AQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABl # AG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKb # C5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11l # hJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6 # I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0 # wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560 # STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQam # ASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGa # J+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ah # XJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA # 9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33Vt # Y5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr # /Xmfwb1tbWrJUnMTDXpQzTGCGZ8wghmbAgEBMIGVMH4xCzAJBgNVBAYTAlVTMRMw # EQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVN # aWNyb3NvZnQgQ29ycG9yYXRpb24xKDAmBgNVBAMTH01pY3Jvc29mdCBDb2RlIFNp # Z25pbmcgUENBIDIwMTECEzMAAAOvMEAOTKNNBUEAAAAAA68wDQYJYIZIAWUDBAIB # BQCgga4wGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcCAQQwHAYKKwYBBAGCNwIBCzEO # MAwGCisGAQQBgjcCARUwLwYJKoZIhvcNAQkEMSIEIL9Ch+BG1EIT7d6UeIt0MHex # 4GiFDNXe6uD9UXdvv/foMEIGCisGAQQBgjcCAQwxNDAyoBSAEgBNAGkAYwByAG8A # cwBvAGYAdKEagBhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20wDQYJKoZIhvcNAQEB # BQAEggEAbeQO81iAWHKPur6yla8MyyqS63i8Wky1ofBPed9kQiFXRZimVnAt+ME9 # IDlFHPeGV91fphxiNz8n/pkybzMfL2AxmNMYaYKGfLkklnzQjfafFShTMzyjrZnB # uwXzrED3ydczNfW1M1RXlIF4ODmMWcMAKmrBIu7yBHuc90p9kg2gCtM6dz9H2QEu # iStPuOGOczDNNkCUPEJ5gMdZpzZ1ZXLWSA3I/Oe/P9hd7slp2u58kEfhlMaE1v2V # UNpE0WgV4v3arysZRil2t634XNExe3M2ELyQI5yl3YSnn8n2Op9bSD5d1QBUDY72 # 5KmcuN3yplgsZ7PitNuG7qwsXGUJXKGCFykwghclBgorBgEEAYI3AwMBMYIXFTCC # FxEGCSqGSIb3DQEHAqCCFwIwghb+AgEDMQ8wDQYJYIZIAWUDBAIBBQAwggFZBgsq # hkiG9w0BCRABBKCCAUgEggFEMIIBQAIBAQYKKwYBBAGEWQoDATAxMA0GCWCGSAFl # AwQCAQUABCDW3SQrml2o3LH9FpGmic7E+6EtCLvvecDD+i8Elx4CwAIGZbqk7oxk # GBMyMDI0MDIxMzA3MjkwMS43NjlaMASAAgH0oIHYpIHVMIHSMQswCQYDVQQGEwJV # UzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UE # ChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMS0wKwYDVQQLEyRNaWNyb3NvZnQgSXJl # bGFuZCBPcGVyYXRpb25zIExpbWl0ZWQxJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNO # OkZDNDEtNEJENC1EMjIwMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBT # ZXJ2aWNloIIReDCCBycwggUPoAMCAQICEzMAAAHimZmV8dzjIOsAAQAAAeIwDQYJ # KoZIhvcNAQELBQAwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24x # EDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlv # bjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwHhcNMjMx # MDEyMTkwNzI1WhcNMjUwMTEwMTkwNzI1WjCB0jELMAkGA1UEBhMCVVMxEzARBgNV # BAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jv # c29mdCBDb3Jwb3JhdGlvbjEtMCsGA1UECxMkTWljcm9zb2Z0IElyZWxhbmQgT3Bl # cmF0aW9ucyBMaW1pdGVkMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjpGQzQxLTRC # RDQtRDIyMDElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZTCC # AiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBALVjtZhV+kFmb8cKQpg2mzis # DlRI978Gb2amGvbAmCd04JVGeTe/QGzM8KbQrMDol7DC7jS03JkcrPsWi9WpVwsI # ckRQ8AkX1idBG9HhyCspAavfuvz55khl7brPQx7H99UJbsE3wMmpmJasPWpgF05z # ZlvpWQDULDcIYyl5lXI4HVZ5N6MSxWO8zwWr4r9xkMmUXs7ICxDJr5a39SSePAJR # IyznaIc0WzZ6MFcTRzLLNyPBE4KrVv1LFd96FNxAzwnetSePg88EmRezr2T3HTFE # lneJXyQYd6YQ7eCIc7yllWoY03CEg9ghorp9qUKcBUfFcS4XElf3GSERnlzJsK7s # /ZGPU4daHT2jWGoYha2QCOmkgjOmBFCqQFFwFmsPrZj4eQszYxq4c4HqPnUu4hT4 # aqpvUZ3qIOXbdyU42pNL93cn0rPTTleOUsOQbgvlRdthFCBepxfb6nbsp3fcZaPB # fTbtXVa8nLQuMCBqyfsebuqnbwj+lHQfqKpivpyd7KCWACoj78XUwYqy1HyYnStT # me4T9vK6u2O/KThfROeJHiSg44ymFj+34IcFEhPogaKvNNsTVm4QbqphCyknrwBy # qorBCLH6bllRtJMJwmu7GRdTQsIx2HMKqphEtpSm1z3ufASdPrgPhsQIRFkHZGui # hL1Jjj4Lu3CbAmha0lOrAgMBAAGjggFJMIIBRTAdBgNVHQ4EFgQURIQOEdq+7Qds # lptJiCRNpXgJ2gUwHwYDVR0jBBgwFoAUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXwYD # VR0fBFgwVjBUoFKgUIZOaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9j # cmwvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3JsMGwG # CCsGAQUFBwEBBGAwXjBcBggrBgEFBQcwAoZQaHR0cDovL3d3dy5taWNyb3NvZnQu # Y29tL3BraW9wcy9jZXJ0cy9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIw # MjAxMCgxKS5jcnQwDAYDVR0TAQH/BAIwADAWBgNVHSUBAf8EDDAKBggrBgEFBQcD # CDAOBgNVHQ8BAf8EBAMCB4AwDQYJKoZIhvcNAQELBQADggIBAORURDGrVRTbnulf # sg2cTsyyh7YXvhVU7NZMkITAQYsFEPVgvSviCylr5ap3ka76Yz0t/6lxuczI6w7t # Xq8n4WxUUgcj5wAhnNorhnD8ljYqbck37fggYK3+wEwLhP1PGC5tvXK0xYomU1nU # +lXOy9ZRnShI/HZdFrw2srgtsbWow9OMuADS5lg7okrXa2daCOGnxuaD1IO+65E7 # qv2O0W0sGj7AWdOjNdpexPrspL2KEcOMeJVmkk/O0ganhFzzHAnWjtNWneU11WQ6 # Bxv8OpN1fY9wzQoiycgvOOJM93od55EGeXxfF8bofLVlUE3zIikoSed+8s61NDP+ # x9RMya2mwK/Ys1xdvDlZTHndIKssfmu3vu/a+BFf2uIoycVTvBQpv/drRJD68eo4 # 01mkCRFkmy/+BmQlRrx2rapqAu5k0Nev+iUdBUKmX/iOaKZ75vuQg7hCiBA5xIm5 # ZIXDSlX47wwFar3/BgTwntMq9ra6QRAeS/o/uYWkmvqvE8Aq38QmKgTiBnWSS/uV # PcaHEyArnyFh5G+qeCGmL44MfEnFEhxc3saPmXhe6MhSgCIGJUZDA7336nQD8fn4 # y6534Lel+LuT5F5bFt0mLwd+H5GxGzObZmm/c3pEWtHv1ug7dS/Dfrcd1sn2E4gk # 4W1L1jdRBbK9xwkMmwY+CHZeMSvBMIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJ # mQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgT # Cldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29m # dCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNh # dGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1 # WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMH # UmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQD # Ex1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEB # BQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjK # NVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhg # fWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJp # rx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/d # vI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka9 # 7aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKR # Hh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9itu # qBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyO # ArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItb # oKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6 # bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6t # AgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQW # BBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacb # UzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYz # aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnku # aHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIA # QwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2 # VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwu # bWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEw # LTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93 # d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYt # MjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/q # XBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6 # U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVt # I1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis # 9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTp # kbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0 # sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138e # W0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJ # sWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7 # Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0 # dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQ # tB1VM1izoXBm8qGCAtQwggI9AgEBMIIBAKGB2KSB1TCB0jELMAkGA1UEBhMCVVMx # EzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoT # FU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEtMCsGA1UECxMkTWljcm9zb2Z0IElyZWxh # bmQgT3BlcmF0aW9ucyBMaW1pdGVkMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjpG # QzQxLTRCRDQtRDIyMDElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2Vy # dmljZaIjCgEBMAcGBSsOAwIaAxUAFpuZafp0bnpJdIhfiB1d8pTohm+ggYMwgYCk # fjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMH # UmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQD # Ex1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDANBgkqhkiG9w0BAQUFAAIF # AOl0S1kwIhgPMjAyNDAyMTIxNTQ2MzNaGA8yMDI0MDIxMzE1NDYzM1owdDA6Bgor # BgEEAYRZCgQBMSwwKjAKAgUA6XRLWQIBADAHAgEAAgIVwzAHAgEAAgIUTzAKAgUA # 6XWc2QIBADA2BgorBgEEAYRZCgQCMSgwJjAMBgorBgEEAYRZCgMCoAowCAIBAAID # B6EgoQowCAIBAAIDAYagMA0GCSqGSIb3DQEBBQUAA4GBAKSvdq5/OwSqLipXDPR/ # fz5CiLbm0lCxv+PjDUqfK5ccPWEVkKsD9zmiB4N1ZQarjww5WUro+QdoUzSzV/Ly # OaxhyB8c2JwDLLMQK8JyHWefD6cG4cvgYDg5iEzioerBrjSnrGxsb3qVV0n31Fhc # Z9Hh71O9RocFcjpVHRSVEF7MMYIEDTCCBAkCAQEwgZMwfDELMAkGA1UEBhMCVVMx # EzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoT # FU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUt # U3RhbXAgUENBIDIwMTACEzMAAAHimZmV8dzjIOsAAQAAAeIwDQYJYIZIAWUDBAIB # BQCgggFKMBoGCSqGSIb3DQEJAzENBgsqhkiG9w0BCRABBDAvBgkqhkiG9w0BCQQx # IgQg7JEhkmXlpQfKYeNaCXm6TNgPyZvo0MaOmbJd61VKWTgwgfoGCyqGSIb3DQEJ # EAIvMYHqMIHnMIHkMIG9BCAriSpKEP0muMbBUETODoL4d5LU6I/bjucIZkOJCI9/ # /zCBmDCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAw # DgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24x # JjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwAhMzAAAB4pmZ # lfHc4yDrAAEAAAHiMCIEII1oQoIqDDF/dls2LazpjkRTP0GoZvbNELQJtb8XKdao # MA0GCSqGSIb3DQEBCwUABIICADBDjnaB3NJ/JLLqdBG0Xij3roM4uWGV9UKgmq4s # 3Hj0iW4+m0mBEeT+k3OIZjB/9NoLmxNaeWnSNQWLBo9U8pJa2ImShqZg3SYEZ4/I # sSh3T09hYFygkLURxNJhPfgqtfg8Kvy0Gf9eXizs8wCMG5YNurabvSbpayXMagbB # qM91uRZrzb4ikYt3sdeXE+20QGe74znI48LUhUAVhqU4VTIXXeEAFzMAGUNRfIhr # m0Ms90bWS544xSBpLVvYu9bah+WVjFf/1O9eVdMt08/3KtjkpxbBGKgjwos011EI # /WBPBHk7FuETSpfCnNRNdDGIACV02pNZZs/9hDTS4gqfM2/E9oqF6tjFOAc6nRCY # T5f5CMzWevXaDO8PnRiA5f5KrVQv2SMgfFyXB0Fm8pnbnYQvehWERtcBeVXZFBod # phpZxaSN+nSqJHpIfryWr9P79F4k+sxsF6S5KqA3xSnBTP5U73fFDs58SMK2etKo # rqycjH3A4qHHU89iL86PqNvOmCPNoyYCci3x1l9fUWJXDcjy4dz0/sqwoYPdAiAJ # A2IXI/Yy2Qg0iFirZHg50n9RQOTVy0gsehOnOY+zrvznEeM0S2YGmHkCKvKDQlJA # w76ejE7O1rPXQ8em2jGkOZOLNgvQvzXU+4BILlnngytP6THlimWIDiyxQgZh4j5H # Be1V # SIG # End signature block |