| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Adds Host Filtering middleware to a Kestrun server instance. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This cmdlet adds the Host Filtering middleware to a Kestrun server instance, allowing you to configure host filt |
| | | 6 | | .PARAMETER Options |
| | | 7 | | A Microsoft.AspNetCore.HostFiltering.HostFilteringOptions object that defines the configuration options for the |
| | | 8 | | If this parameter is provided, it takes precedence over the individual configuration parameters (AllowedHosts, A |
| | | 9 | | .PARAMETER AllowedHosts |
| | | 10 | | The hosts headers that are allowed to access this site. At least one value is required. |
| | | 11 | | Port numbers must be excluded. |
| | | 12 | | A top level wildcard "*" allows all non-empty hosts. |
| | | 13 | | Subdomain wildcards are permitted. E.g. "*.example.com" matches subdomains like foo.example.com, but not the par |
| | | 14 | | Unicode host names are allowed but will be converted to punycode for matching. |
| | | 15 | | IPv6 addresses must include their bounding brackets and be in their normalized form. |
| | | 16 | | .PARAMETER NotAllowEmptyHosts |
| | | 17 | | A switch indicating whether requests with an empty Host header should be allowed. |
| | | 18 | | If this switch is present, requests with an empty Host header will be rejected. |
| | | 19 | | .PARAMETER ExcludeFailureMessage |
| | | 20 | | A switch indicating whether to exclude the failure message in the response when a request is rejected due to hos |
| | | 21 | | If this switch is present, the failure message will be excluded from the response. |
| | | 22 | | .EXAMPLE |
| | | 23 | | Add-KrHostFiltering -AllowedHosts "example.com", "www.example.com" -PassThru |
| | | 24 | | This example adds Host Filtering middleware to the current Kestrun server instance, allowing only requests with |
| | | 25 | | matching "example.com" or "www.example.com", and returns the modified server instance. |
| | | 26 | | .EXAMPLE |
| | | 27 | | $options = [Microsoft.AspNetCore.HostFiltering.HostFilteringOptions]::new() |
| | | 28 | | $options.AllowedHosts.Add("example.com") |
| | | 29 | | $options.AllowEmptyHosts = $true |
| | | 30 | | Add-KrHostFiltering -Options $options -PassThru |
| | | 31 | | This example creates a HostFilteringOptions object that allows requests with the Host header "example.com" |
| | | 32 | | and allows empty Host headers, then adds the Host Filtering middleware to the current Kestrun server instance an |
| | | 33 | | .NOTES |
| | | 34 | | This cmdlet is part of the Kestrun PowerShell module. |
| | | 35 | | |
| | | 36 | | #> |
| | | 37 | | function Add-KrHostFiltering { |
| | | 38 | | [KestrunRuntimeApi('Definition')] |
| | | 39 | | [CmdletBinding(defaultParameterSetName = 'Items')] |
| | | 40 | | param( |
| | | 41 | | [Parameter(Mandatory = $true, ParameterSetName = 'Options')] |
| | | 42 | | [Microsoft.AspNetCore.HostFiltering.HostFilteringOptions]$Options, |
| | | 43 | | |
| | | 44 | | [Parameter(ParameterSetName = 'Items')] |
| | | 45 | | [string[]] $AllowedHosts, |
| | | 46 | | |
| | | 47 | | [Parameter(ParameterSetName = 'Items')] |
| | | 48 | | [switch] $NotAllowEmptyHosts, |
| | | 49 | | |
| | | 50 | | [Parameter(ParameterSetName = 'Items')] |
| | | 51 | | [switch] $ExcludeFailureMessage |
| | | 52 | | ) |
| | | 53 | | # Ensure the server instance is resolved |
| | 0 | 54 | | $Server = Resolve-KestrunServer |
| | | 55 | | |
| | 0 | 56 | | if ($PSCmdlet.ParameterSetName -eq 'Items') { |
| | | 57 | | # Create options from individual parameters |
| | 0 | 58 | | $Options = [Microsoft.AspNetCore.HostFiltering.HostFilteringOptions]::new() |
| | | 59 | | |
| | 0 | 60 | | if ($PSBoundParameters.ContainsKey('AllowedHosts')) { |
| | | 61 | | # Validate that at least one host is provided |
| | 0 | 62 | | if ($AllowedHosts.Count -eq 0) { |
| | 0 | 63 | | throw 'At least one AllowedHost must be specified when using the AllowedHosts parameter.' |
| | | 64 | | } |
| | 0 | 65 | | foreach ($h in $AllowedHosts) { |
| | 0 | 66 | | $Options.AllowedHosts.Add($h); |
| | | 67 | | } |
| | | 68 | | } |
| | | 69 | | # Validate the options |
| | 0 | 70 | | $Options.AllowEmptyHosts = -not $NotAllowEmptyHosts.IsPresent |
| | 0 | 71 | | $Options.IncludeFailureMessage = -not $ExcludeFailureMessage.IsPresent |
| | | 72 | | } |
| | | 73 | | |
| | | 74 | | # Add the Host Filtering middleware |
| | 0 | 75 | | [Kestrun.Hosting.KestrunSecurityMiddlewareExtensions]::AddHostFiltering($Server, $Options) | Out-Null |
| | | 76 | | } |
| | | 77 | | |