| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Adds an Antiforgery service to the server. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This cmdlet allows you to configure the Antiforgery service for the Kestrun server. |
| | | 6 | | It can be used to protect against Cross-Site Request Forgery (CSRF) attacks by generating and validating antifor |
| | | 7 | | .PARAMETER Options |
| | | 8 | | The Antiforgery options to configure the service. |
| | | 9 | | .PARAMETER CookieName |
| | | 10 | | The name of the cookie to use for the Antiforgery token. Default is '.Kestrun.AntiXSRF'. |
| | | 11 | | .PARAMETER FormFieldName |
| | | 12 | | The name of the form field to use for the Antiforgery token. If not specified, the default will be used. |
| | | 13 | | .PARAMETER HeaderName |
| | | 14 | | The name of the header to use for the Antiforgery token. Default is 'X-CSRF-TOKEN'. |
| | | 15 | | .PARAMETER SuppressXFrameOptionsHeader |
| | | 16 | | If specified, the X-Frame-Options header will not be added to responses. |
| | | 17 | | .PARAMETER SuppressReadingTokenFromFormBody |
| | | 18 | | If specified, the Antiforgery service will not read tokens from the form body. This option is only available in |
| | | 19 | | .EXAMPLE |
| | | 20 | | Add-KrAntiforgeryMiddleware -Cookie $cookieBuilder -FormField '__RequestVerificationToken' -HeaderName 'X-CSRF-T |
| | | 21 | | This example adds an Antiforgery service to the server with a custom cookie builder, form field name, and header |
| | | 22 | | .EXAMPLE |
| | | 23 | | Add-KrAntiforgeryMiddleware -Options $options |
| | | 24 | | This example adds an Antiforgery service to the server using the specified Antiforgery options. |
| | | 25 | | .LINK |
| | | 26 | | https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.antiforgery.antiforgeryoptions?view=aspnetcore |
| | | 27 | | #> |
| | | 28 | | function Add-KrAntiforgeryMiddleware { |
| | | 29 | | [KestrunRuntimeApi('Definition')] |
| | | 30 | | [CmdletBinding(defaultParameterSetName = 'Items')] |
| | | 31 | | param( |
| | | 32 | | |
| | | 33 | | [Parameter(Mandatory = $true, ParameterSetName = 'Options')] |
| | | 34 | | [Microsoft.AspNetCore.Antiforgery.AntiforgeryOptions]$Options, |
| | | 35 | | |
| | | 36 | | [Parameter(ParameterSetName = 'Items')] |
| | | 37 | | [string]$FormFieldName, |
| | | 38 | | |
| | | 39 | | [Parameter(ParameterSetName = 'Items')] |
| | | 40 | | [string]$CookieName = '.Kestrun.AntiXSRF', |
| | | 41 | | |
| | | 42 | | [Parameter(ParameterSetName = 'Items')] |
| | | 43 | | [string]$HeaderName = 'X-CSRF-TOKEN', |
| | | 44 | | |
| | | 45 | | [Parameter(ParameterSetName = 'Items')] |
| | | 46 | | [switch]$SuppressXFrameOptionsHeader, |
| | | 47 | | |
| | | 48 | | [Parameter(ParameterSetName = 'Items')] |
| | | 49 | | [switch]$SuppressReadingTokenFromFormBody |
| | | 50 | | ) |
| | | 51 | | # Ensure the server instance is resolved |
| | 0 | 52 | | $Server = Resolve-KestrunServer |
| | | 53 | | |
| | 0 | 54 | | if ($PSCmdlet.ParameterSetName -eq 'Items') { |
| | 0 | 55 | | $Options = [Microsoft.AspNetCore.Antiforgery.AntiforgeryOptions]::new() |
| | | 56 | | |
| | | 57 | | # build default cookie |
| | 0 | 58 | | $cookie = [Microsoft.AspNetCore.Http.CookieBuilder]::new() |
| | 0 | 59 | | $cookie.Name = $CookieName |
| | 0 | 60 | | $cookie.SameSite = [Microsoft.AspNetCore.Http.SameSiteMode]::Lax |
| | 0 | 61 | | $cookie.HttpOnly = $true |
| | 0 | 62 | | $cookie.SecurePolicy = [Microsoft.AspNetCore.Http.CookieSecurePolicy]::Always |
| | 0 | 63 | | $cookie.Path = '/' |
| | | 64 | | |
| | 0 | 65 | | $Options.Cookie = $cookie |
| | | 66 | | |
| | 0 | 67 | | if (-not [string]::IsNullOrEmpty($FormFieldName)) { |
| | 0 | 68 | | $Options.FormFieldName = $FormFieldName |
| | | 69 | | } |
| | 0 | 70 | | if (-not [string]::IsNullOrEmpty($HeaderName)) { |
| | 0 | 71 | | $Options.HeaderName = $HeaderName |
| | | 72 | | } |
| | 0 | 73 | | if ($SuppressXFrameOptionsHeader.IsPresent) { |
| | 0 | 74 | | $Options.SuppressXFrameOptionsHeader = $true |
| | | 75 | | } |
| | 0 | 76 | | if (Test-KrCapability -Feature 'SuppressReadingTokenFromFormBody') { |
| | 0 | 77 | | if ($SuppressReadingTokenFromFormBody.IsPresent) { |
| | 0 | 78 | | $Options.SuppressReadingTokenFromFormBody = $true |
| | | 79 | | } |
| | | 80 | | } |
| | | 81 | | } |
| | | 82 | | |
| | | 83 | | # Add the Antiforgery service to the server |
| | 0 | 84 | | [Kestrun.Hosting.KestrunSecurityMiddlewareExtensions]::AddAntiforgery($Server, $Options) | Out-Null |
| | | 85 | | } |