#628

pending completion

Build # #628

Build Type

push

github-actions

Committed by

web-flow

Commit Message

<a href="https://github.com/Badgerati/Pode/commit/<a class=hub.com/Badgerati/Pode/commit/453d0946576a3cb3e4fae5fdef1601f1324ed7f7">453d09465<a href="https://github.com/Badgerati/Pode/commit/453d0946576a3cb3e4fae5fdef1601f1324ed7f7">">Merge </a><a class="double-link" href="https://github.com/Badgerati/Pode/commit/<a class="double-link" href="https://github.com/Badgerati/Pode/commit/7bd19b1c76ebb2ce40cbea6cc459200dd4805fed">7bd19b1c7</a>">7bd19b1c7</a><a href="https://github.com/Badgerati/Pode/commit/453d0946576a3cb3e4fae5fdef1601f1324ed7f7"> into 722f5ab31">722f5ab31</a>

Run Details

5 of 5 new or added lines in 3 files covered. (100.0%)

2604 of 5836 relevant lines covered (44.62%)

1.15 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

55.56

/src/Public/Headers.ps1

<#
.SYNOPSIS
Appends a header against the Response.

.DESCRIPTION
Appends a header against the Response. If the current context is serverless, then this function acts like Set-PodeHeader.

.PARAMETER Name
The name of the header.

.PARAMETER Value
The value to set against the header.

.PARAMETER Secret
If supplied, the secret with which to sign the header's value.

.EXAMPLE
Add-PodeHeader -Name 'X-AuthToken' -Value 'AA-BB-CC-33'
#>
function Add-PodeHeader
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter(Mandatory=$true)]
        [string]
        $Value,

        [Parameter()]
        [string]
        $Secret
    )

    # sign the value if we have a secret
    if (![string]::IsNullOrWhiteSpace($Secret)) {
        $Value = (Invoke-PodeValueSign -Value $Value -Secret $Secret)
    }

    # add the header to the response
    switch ($PodeContext.Server.Type) {
        'http' {
            $WebEvent.Response.AppendHeader($Name, $Value) | Out-Null
        }

        'pode' {
            if (!$WebEvent.Response.Headers.ContainsKey($Name)) {
                $WebEvent.Response.Headers[$Name] = @()
            }

            $WebEvent.Response.Headers[$Name] += $Value
        }

        default {
            $WebEvent.Response.Headers[$Name] = $Value
        }
    }
}

<#
.SYNOPSIS
Tests if a header is present on the Request.

.DESCRIPTION
Tests if a header is present on the Request.

.PARAMETER Name
The name of the header to test.

.EXAMPLE
Test-PodeHeader -Name 'X-AuthToken'
#>
function Test-PodeHeader
{
    [CmdletBinding()]
    [OutputType([bool])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name
    )

    $header = (Get-PodeHeader -Name $Name)
    return (![string]::IsNullOrWhiteSpace($header))
}

<#
.SYNOPSIS
Retrieves the value of a header from the Request.

.DESCRIPTION
Retrieves the value of a header from the Request.

.PARAMETER Name
The name of the header to retrieve.

.PARAMETER Secret
The secret used to unsign the header's value.

.EXAMPLE
Get-PodeHeader -Name 'X-AuthToken'
#>
function Get-PodeHeader
{
    [CmdletBinding()]
    [OutputType([string])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter()]
        [string]
        $Secret
    )

    # get the value for the header from the request
    if ($PodeContext.Server.Type -ine 'http') {
        $header = $WebEvent.Request.Headers.$Name
    }
    else {
        $header = $WebEvent.Request.Headers[$Name]
    }

    # if a secret was supplied, attempt to unsign the header's value
    if (![string]::IsNullOrWhiteSpace($Secret)) {
        $header = (Invoke-PodeValueUnsign -Value $header -Secret $Secret)
    }

    return $header
}

<#
.SYNOPSIS
Sets a header on the Response, clearing all current values for the header.

.DESCRIPTION
Sets a header on the Response, clearing all current values for the header.

.PARAMETER Name
The name of the header.

.PARAMETER Value
The value to set against the header.

.PARAMETER Secret
If supplied, the secret with which to sign the header's value.

.EXAMPLE
Set-PodeHeader -Name 'X-AuthToken' -Value 'AA-BB-CC-33'
#>
function Set-PodeHeader
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter(Mandatory=$true)]
        [string]
        $Value,

        [Parameter()]
        [string]
        $Secret
    )

    # sign the value if we have a secret
    if (![string]::IsNullOrWhiteSpace($Secret)) {
        $Value = (Invoke-PodeValueSign -Value $Value -Secret $Secret)
    }

    # set the header on the response
    switch ($PodeContext.Server.Type) {
        'http' {
            $WebEvent.Response.AddHeader($Name, $Value) | Out-Null
        }

        'pode' {
            $WebEvent.Response.Headers[$Name] = @($Value)
        }

        default {
            $WebEvent.Response.Headers[$Name] = $Value
        }
    }
}

<#
.SYNOPSIS
Tests if a header on the Request is validly signed.

.DESCRIPTION
Tests if a header on the Request is validly signed, by attempting to unsign it using some secret.

.PARAMETER Name
The name of the header to test.

.PARAMETER Secret
A secret to use for attempting to unsign the header's value.

.EXAMPLE
Test-PodeHeaderSigned -Name 'X-Header-Name' -Secret 'hunter2'
#>
function Test-PodeHeaderSigned
{
    [CmdletBinding()]
    [OutputType([bool])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter()]
        [string]
        $Secret
    )

    $header = Get-PodeHeader -Name $Name
    if ([string]::IsNullOrWhiteSpace($header)) {
        return $false
    }

    $value = (Invoke-PodeValueUnsign -Value $header -Secret $Secret)
    return (![string]::IsNullOrWhiteSpace($value))
}

1	<#
2	.SYNOPSIS
3	Appends a header against the Response.
4
5	.DESCRIPTION
6	Appends a header against the Response. If the current context is serverless, then this function acts like Set-PodeHeader.
7
8	.PARAMETER Name
9	The name of the header.
10
11	.PARAMETER Value
12	The value to set against the header.
13
14	.PARAMETER Secret
15	If supplied, the secret with which to sign the header's value.
16
17	.EXAMPLE
18	Add-PodeHeader -Name 'X-AuthToken' -Value 'AA-BB-CC-33'
19	#>
20	function Add-PodeHeader
21	{
22	[CmdletBinding()]
23	param (
24	[Parameter(Mandatory=$true)]
25	[string]
26	$Name,
27
28	[Parameter(Mandatory=$true)]
29	[string]
30	$Value,
31
32	[Parameter()]
33	[string]
34	$Secret
35	)
36
37	# sign the value if we have a secret
38	if (![string]::IsNullOrWhiteSpace($Secret)) {	2✔
39	$Value = (Invoke-PodeValueSign -Value $Value -Secret $Secret)	×
40	}
41
42	# add the header to the response
43	switch ($PodeContext.Server.Type) {	2✔
44	'http' {
45	$WebEvent.Response.AppendHeader($Name, $Value) \| Out-Null	4✔
46	}
47
48	'pode' {
49	if (!$WebEvent.Response.Headers.ContainsKey($Name)) {	×
50	$WebEvent.Response.Headers[$Name] = @()	×
51	}
52
53	$WebEvent.Response.Headers[$Name] += $Value	×
54	}
55
56	default {
57	$WebEvent.Response.Headers[$Name] = $Value	2✔
58	}
59	}
60	}
61
62	<#
63	.SYNOPSIS
64	Tests if a header is present on the Request.
65
66	.DESCRIPTION
67	Tests if a header is present on the Request.
68
69	.PARAMETER Name
70	The name of the header to test.
71
72	.EXAMPLE
73	Test-PodeHeader -Name 'X-AuthToken'
74	#>
75	function Test-PodeHeader
76	{
77	[CmdletBinding()]
78	[OutputType([bool])]
79	param (
80	[Parameter(Mandatory=$true)]
81	[string]
82	$Name
83	)
84
85	$header = (Get-PodeHeader -Name $Name)	4✔
86	return (![string]::IsNullOrWhiteSpace($header))	4✔
87	}
88
89	<#
90	.SYNOPSIS
91	Retrieves the value of a header from the Request.
92
93	.DESCRIPTION
94	Retrieves the value of a header from the Request.
95
96	.PARAMETER Name
97	The name of the header to retrieve.
98
99	.PARAMETER Secret
100	The secret used to unsign the header's value.
101
102	.EXAMPLE
103	Get-PodeHeader -Name 'X-AuthToken'
104	#>
105	function Get-PodeHeader
106	{
107	[CmdletBinding()]
108	[OutputType([string])]
109	param (
110	[Parameter(Mandatory=$true)]
111	[string]
112	$Name,
113
114	[Parameter()]
115	[string]
116	$Secret
117	)
118
119	# get the value for the header from the request
120	if ($PodeContext.Server.Type -ine 'http') {	2✔
121	$header = $WebEvent.Request.Headers.$Name	2✔
122	}
123	else {
124	$header = $WebEvent.Request.Headers[$Name]	2✔
125	}
126
127	# if a secret was supplied, attempt to unsign the header's value
128	if (![string]::IsNullOrWhiteSpace($Secret)) {	2✔
129	$header = (Invoke-PodeValueUnsign -Value $header -Secret $Secret)	×
130	}
131
132	return $header	2✔
133	}
134
135	<#
136	.SYNOPSIS
137	Sets a header on the Response, clearing all current values for the header.
138
139	.DESCRIPTION
140	Sets a header on the Response, clearing all current values for the header.
141
142	.PARAMETER Name
143	The name of the header.
144
145	.PARAMETER Value
146	The value to set against the header.
147
148	.PARAMETER Secret
149	If supplied, the secret with which to sign the header's value.
150
151	.EXAMPLE
152	Set-PodeHeader -Name 'X-AuthToken' -Value 'AA-BB-CC-33'
153	#>
154	function Set-PodeHeader
155	{
156	[CmdletBinding()]
157	param (
158	[Parameter(Mandatory=$true)]
159	[string]
160	$Name,
161
162	[Parameter(Mandatory=$true)]
163	[string]
164	$Value,
165
166	[Parameter()]
167	[string]
168	$Secret
169	)
170
171	# sign the value if we have a secret
172	if (![string]::IsNullOrWhiteSpace($Secret)) {	2✔
173	$Value = (Invoke-PodeValueSign -Value $Value -Secret $Secret)	×
174	}
175
176	# set the header on the response
177	switch ($PodeContext.Server.Type) {	2✔
178	'http' {
179	$WebEvent.Response.AddHeader($Name, $Value) \| Out-Null	4✔
180	}
181
182	'pode' {
183	$WebEvent.Response.Headers[$Name] = @($Value)	×
184	}
185
186	default {
187	$WebEvent.Response.Headers[$Name] = $Value	2✔
188	}
189	}
190	}
191
192	<#
193	.SYNOPSIS
194	Tests if a header on the Request is validly signed.
195
196	.DESCRIPTION
197	Tests if a header on the Request is validly signed, by attempting to unsign it using some secret.
198
199	.PARAMETER Name
200	The name of the header to test.
201
202	.PARAMETER Secret
203	A secret to use for attempting to unsign the header's value.
204
205	.EXAMPLE
206	Test-PodeHeaderSigned -Name 'X-Header-Name' -Secret 'hunter2'
207	#>
208	function Test-PodeHeaderSigned
209	{
210	[CmdletBinding()]
211	[OutputType([bool])]
212	param (
213	[Parameter(Mandatory=$true)]
214	[string]
215	$Name,
216
217	[Parameter()]
218	[string]
219	$Secret
220	)
221
222	$header = Get-PodeHeader -Name $Name	×
223	if ([string]::IsNullOrWhiteSpace($header)) {	×
224	return $false	×
225	}
226
227	$value = (Invoke-PodeValueUnsign -Value $header -Secret $Secret)	×
228	return (![string]::IsNullOrWhiteSpace($value))	×
229	}

Badgerati / Pode / #628

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous