< Summary - Kestrun — Combined Coverage

Information
Class: Public.Cookies.Invoke-KrCookieSignIn
Assembly: Kestrun.PowerShell.Public
File(s): /home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/Cookies/Invoke-KrCookieSignIn.ps1
Tag: Kestrun/Kestrun@0d738bf294e6281b936d031e1979d928007495ff
Line coverage
0%
Covered lines: 0
Uncovered lines: 32
Coverable lines: 32
Total lines: 175
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 09/11/2025 - 03:23:38 Line coverage: 0% (0/31) Total lines: 161 Tag: Kestrun/Kestrun@b7a12f5205442de0d384c1a861c1f8f30c74dcb509/12/2025 - 03:43:11 Line coverage: 0% (0/31) Total lines: 174 Tag: Kestrun/Kestrun@d160286e3020330b1eb862d66a37db2e26fc904210/18/2025 - 15:14:40 Line coverage: 0% (0/32) Total lines: 175 Tag: Kestrun/Kestrun@2d87023b37eb91155071c91dd3d6a2eeb3004705

Metrics

Method
Invoke-KrCookieSignIn()

File(s)

/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/Cookies/Invoke-KrCookieSignIn.ps1

#LineLine coverage
 1<#
 2.SYNOPSIS
 3    Signs in a user issuing an authentication cookie for the given scheme.
 4.DESCRIPTION
 5    Wraps SignInAsync on the current HTTP context to create a cookie-based session.
 6    You can supply an existing ClaimsIdentity or provide claims via -Name, -Claim, or -ClaimTable.
 7    Optionally sets authentication properties like persistence and expiration.
 8    Designed for use inside Kestrun route script blocks where $Context is available.
 9.PARAMETER Scheme
 10    Authentication scheme to use (default 'Cookies').
 11.PARAMETER Name
 12    Convenience parameter to add a ClaimTypes.Name claim.
 13.PARAMETER Claims
 14    One or more pre-constructed System.Security.Claims.Claim objects to include.
 15.PARAMETER Identity
 16    Existing ClaimsIdentity to use instead of constructing a new one.
 17.PARAMETER AuthenticationProperties
 18    Existing AuthenticationProperties to use instead of constructing a new one.
 19.PARAMETER ExpiresUtc
 20    Explicit expiration timestamp for the authentication ticket.
 21.PARAMETER IssuedUtc
 22    Explicit issued timestamp for the authentication ticket.
 23.PARAMETER IsPersistent
 24    Marks the cookie as persistent (survives browser session) if supported.
 25.PARAMETER AllowRefresh
 26    Allows the authentication session to be refreshed (sliding expiration scenarios).
 27.PARAMETER RedirectUri
 28    Sets the RedirectUri property on AuthenticationProperties.
 29.PARAMETER Items
 30    Hashtable of string key-Value pairs to add to the Items collection on AuthenticationProperties.
 31.PARAMETER Parameters
 32    Hashtable of string key-Value pairs to add to the Parameters collection on AuthenticationProperties.
 33.PARAMETER PassThru
 34    Returns the created ClaimsPrincipal instead of no output.
 35.PARAMETER WhatIf
 36    Shows what would happen if the command runs. The command is not run.
 37.PARAMETER Confirm
 38    Prompts you for confirmation before running the command. The command is not run unless you respond affirmatively.
 39.EXAMPLE
 40    Invoke-KrCookieSignIn -Name 'admin'
 41.EXAMPLE
 42    Invoke-KrCookieSignIn -Scheme 'Cookies' -ClaimTable @{ role = 'admin'; dept = 'it' } -IsPersistent -ExpiresUtc (Get-
 43.OUTPUTS
 44    System.Security.Claims.ClaimsPrincipal (when -PassThru specified)
 45#>
 46function Invoke-KrCookieSignIn {
 47    [KestrunRuntimeApi('Route')]
 48    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Low', DefaultParameterSetName = 'Claims')]
 49    [OutputType([System.Security.Claims.ClaimsPrincipal])]
 50    param(
 51        [Parameter()]
 52        [string]$Scheme = 'Cookies',
 53
 54        # Identity construction helpers
 55        [Parameter(ParameterSetName = 'SimpleIdentity')]
 56        [string]$Name,
 57
 58        [Parameter(ParameterSetName = 'BuildIdentity')]
 59        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 60        [Parameter(ParameterSetName = 'AuthenticationProperties_Claim')]
 61        [Parameter(ParameterSetName = 'Claims')]
 62        [System.Security.Claims.Claim[]]$Claims,
 63
 64
 65        [Parameter(ParameterSetName = 'Identity', Mandatory = $true)]
 66        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 67        [Parameter(ParameterSetName = 'AuthenticationProperties_Identity')]
 68        [System.Security.Claims.ClaimsIdentity]$Identity,
 69
 70        [Parameter(Mandatory = $true, ParameterSetName = 'AuthenticationProperties_Claim')]
 71        [Parameter(ParameterSetName = 'AuthenticationProperties_Identity')]
 72        [Microsoft.AspNetCore.Authentication.AuthenticationProperties]$AuthenticationProperties,
 73        # Session lifetimes
 74        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 75        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 76        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 77        [object]$ExpiresUtc,        # accepts DateTimeOffset/DateTime/string/duration
 78
 79        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 80        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 81        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 82        [object]$IssuedUtc,         # same parsing
 83
 84        # Flags
 85        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 86        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 87        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 88        [switch]$IsPersistent,
 89        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 90        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 91        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 92        [switch]$AllowRefresh,
 93
 94        # Extras
 95        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 96        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 97        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 98        [string]$RedirectUri,
 99        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 100        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 101        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 102        [hashtable]$Items,
 103        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_BuildIdentity')]
 104        [Parameter(ParameterSetName = 'AuthenticationPropertiesItems_Identity')]
 105        [Parameter(ParameterSetName = 'SimpleIdentity_BuildIdentity')]
 106        [hashtable]$Parameters,
 107
 108        [Parameter()]
 109        [switch]$PassThru
 110    )
 111    # Only works inside a route script block where $Context is available
 0112    if ($null -ne $Context) {
 113
 114        # Build or accept identity
 0115        if (-not $Identity) {
 0116            $Identity = [System.Security.Claims.ClaimsIdentity]::new($Scheme)
 117        }
 118
 119        #   Add Name claim if provided
 0120        if ($PSBoundParameters.ContainsKey('Name') -and (-not [string]::IsNullOrWhiteSpace($Name))) {
 0121            $ClaimType = [Kestrun.Claims.KestrunClaimExtensions]::ToClaimUri('Name')
 0122            $Identity.AddClaim([System.Security.Claims.Claim]::new($ClaimType, $Name))
 123        }
 124
 125        # Add any provided claims
 0126        if ($Claims) {
 0127            foreach ($claim in $Claims) {
 0128                $Identity.AddClaim($claim)
 129            }
 130        }
 131
 132        # Create principal
 0133        $principal = [System.Security.Claims.ClaimsPrincipal]::new($Identity)
 134
 0135        if ($PSBoundParameters -eq 'AuthenticationPropertiesItems_BuildIdentity') {
 0136            $AuthenticationProperties = [Microsoft.AspNetCore.Authentication.AuthenticationProperties]::new()
 137
 0138            if ($PSBoundParameters.ContainsKey('ExpiresUtc') -and $ExpiresUtc) {
 0139                $authProps.ExpiresUtc = ConvertTo-DateTimeOffset $ExpiresUtc
 140            }
 0141            if ($PSBoundParameters.ContainsKey('IssuedUtc') -and $IssuedUtc) {
 0142                $authProps.IssuedUtc = ConvertTo-DateTimeOffset $IssuedUtc
 143            }
 0144            if ($PSBoundParameters.ContainsKey('IsPersistent')) {
 0145                $authProps.IsPersistent = [bool]$IsPersistent
 146            }
 0147            if ($PSBoundParameters.ContainsKey('AllowRefresh')) {
 0148                $authProps.AllowRefresh = [bool]$AllowRefresh
 149            }
 0150            if ($PSBoundParameters.ContainsKey('RedirectUri') -and $RedirectUri) {
 0151                $authProps.RedirectUri = $RedirectUri
 152            }
 0153            if ($PSBoundParameters.ContainsKey('Items') -and $Items) {
 0154                foreach ($k in $Items.Keys) { $authProps.Items[[string]$k] = [string]$Items[$k] }
 155            }
 0156            if ($PSBoundParameters.ContainsKey('Parameters') -and $Parameters) {
 0157                foreach ($k in $Parameters.Keys) { $authProps.Parameters[[string]$k] = $Parameters[$k] }
 158            }
 159        }
 160
 161        # Sign in
 0162        if ($PSCmdlet.ShouldProcess($Scheme, 'SignIn')) {
 0163            [Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions]::SignInAsync(
 164                $Context.HttpContext, $Scheme, $principal, $AuthenticationProperties
 0165            ).GetAwaiter().GetResult() | Out-Null
 166        }
 167
 168        # Return principal if requested
 0169        if ($PassThru) {
 0170            return $principal
 171        }
 172    } else {
 0173        Write-KrOutsideRouteWarning
 174    }
 175}
Generated by: ReportGenerator 5.5.1.0
12/18/2025 - 21:41:59
GitHub | reportgenerator.io

Methods/Properties

Invoke-KrCookieSignIn()