| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Adds Windows authentication to the Kestrun server. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | Configures the Kestrun server to use Windows authentication for incoming requests. |
| | | 6 | | This allows the server to authenticate users based on their Windows credentials. |
| | | 7 | | This enables the server to use Kerberos or NTLM for authentication. |
| | | 8 | | .PARAMETER Server |
| | | 9 | | The Kestrun server instance to configure. |
| | | 10 | | .PARAMETER PassThru |
| | | 11 | | If specified, returns the modified server instance after adding the authentication. |
| | | 12 | | .EXAMPLE |
| | | 13 | | Add-KrWindowsAuthentication -Server $myServer -PassThru |
| | | 14 | | This example adds Windows authentication to the specified Kestrun server instance and returns the modified insta |
| | | 15 | | .LINK |
| | | 16 | | https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.authentication.windowsauthentication?view=aspn |
| | | 17 | | .NOTES |
| | | 18 | | This cmdlet is used to configure Windows authentication for the Kestrun server, allowing you to secure your APIs |
| | | 19 | | #> |
| | | 20 | | function Add-KrWindowsAuthentication { |
| | | 21 | | [KestrunRuntimeApi('Definition')] |
| | | 22 | | [CmdletBinding(defaultParameterSetName = 'ItemsScriptBlock')] |
| | | 23 | | [OutputType([Kestrun.Hosting.KestrunHost])] |
| | | 24 | | param( |
| | | 25 | | [Parameter(Mandatory = $false, ValueFromPipeline)] |
| | | 26 | | [Kestrun.Hosting.KestrunHost]$Server, |
| | | 27 | | |
| | | 28 | | [Parameter()] |
| | | 29 | | [switch]$PassThru |
| | | 30 | | ) |
| | | 31 | | begin { |
| | | 32 | | # Ensure the server instance is resolved |
| | 1 | 33 | | $Server = Resolve-KestrunServer -Server $Server |
| | 1 | 34 | | if ($null -eq $Server) { |
| | 0 | 35 | | throw 'Server is not initialized. Please ensure the server is configured before setting options.' |
| | | 36 | | } |
| | | 37 | | } |
| | | 38 | | process { |
| | | 39 | | # Add Windows authentication to the server instance --- |
| | 2 | 40 | | [Kestrun.Hosting.KestrunHostAuthExtensions]::AddWindowsAuthentication($Server) | Out-Null |
| | 1 | 41 | | if ($PassThru.IsPresent) { |
| | | 42 | | # if the PassThru switch is specified, return the server instance |
| | | 43 | | # Return the modified server instance |
| | 0 | 44 | | return $Server |
| | | 45 | | } |
| | | 46 | | } |
| | | 47 | | } |
| | | 48 | | |