#546

pending completion

Build # #546

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/<a class="double-link" href="https://git"><a class=hub.com/Badgerati/Pode/commit/<a class="double-link" href="https://git"><a class=hub.com/Badgerati/Pode/commit/<a class="double-link" href="https://git"><a class=hub.com/Badgerati/Pode/commit/616949ac4ac5d547a9eccd153b3cf010cf05497a">616949ac4">&lt;a href=&quot;https://github.com/Badgerati/Pode/commit/</a><a class="double-link" href="https://github.com/Badgerati/Pode/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Badgerati/Pode/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Badgerati/Pode/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Badgerati/Pode/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Badgerati/Pode/commit/616949ac4ac5d547a9eccd153b3cf010cf05497a">616949ac4</a><a href="https://github.com/Badgerati/Pode/commit/616949ac4ac5d547a9eccd153b3cf010cf05497a">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/Badgerati/Pode/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/Badgerati/Pode/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Badgerati/Pode/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Badgerati/Pode/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Badgerati/Pode/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Badgerati/Pode/commit/616949ac4ac5d547a9eccd153b3cf010cf05497a&quot;&gt;616949ac4&lt;/a&gt;&lt;a href=&quot;https://github.com/Badgerati/Pode/commit/616949ac4ac5d547a9eccd153b3cf010cf05497a&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/Badgerati/Pode/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Badgerati/Pode/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=... (continued)

Run Details

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

2365 of 5187 relevant lines covered (45.59%)

1.17 hits per line

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

0.0

/src/Public/Authentication.ps1

<#
.SYNOPSIS
Create a new type of Authentication.

.DESCRIPTION
Create a new type of Authentication, which is used to parse the Request for user credentials for validating.

.PARAMETER Basic
If supplied, will use the inbuilt Basic Authentication credentials retriever.

.PARAMETER Encoding
The Encoding to use when decoding the Basic Authorization header.

.PARAMETER HeaderTag
The name of the type of Basic Authentication.

.PARAMETER Form
If supplied, will use the inbuilt Form Authentication credentials retriever.

.PARAMETER UsernameField
The name of the Username Field in the payload to retrieve the username.

.PARAMETER PasswordField
The name of the Password Field in the payload to retrieve the password.

.PARAMETER Custom
If supplied, will allow you to create a Custom Authentication credentials retriever.

.PARAMETER ScriptBlock
The ScriptBlock is used to parse the request and retieve user credentials and other information.

.PARAMETER ArgumentList
An array of arguments to supply to the Custom Authentication type's ScriptBlock.

.PARAMETER Name
The Name of an Authentication type - such as Basic or NTLM.

.PARAMETER Realm
The name of scope of the protected area.

.PARAMETER Scheme
The scheme type for custom Authentication types. Default is HTTP.

.PARAMETER Digest
If supplied, will use the inbuilt Digest Authentication credentials retriever.

.PARAMETER PostValidator
The PostValidator is a scriptblock that is invoked after user validation.

.EXAMPLE
$basic_auth = New-PodeAuthType -Basic

.EXAMPLE
$form_auth = New-PodeAuthType -Form -UsernameField 'Email'

.EXAMPLE
$custom_auth = New-PodeAuthType -Custom -ScriptBlock { /* logic */ }
#>
function New-PodeAuthType
{
    [CmdletBinding(DefaultParameterSetName='Basic')]
    [OutputType([hashtable])]
    param (
        [Parameter(ParameterSetName='Basic')]
        [switch]
        $Basic,

        [Parameter(ParameterSetName='Basic')]
        [string]
        $Encoding = 'ISO-8859-1',

        [Parameter(ParameterSetName='Basic')]
        [string]
        $HeaderTag = 'Basic',

        [Parameter(ParameterSetName='Form')]
        [switch]
        $Form,

        [Parameter(ParameterSetName='Form')]
        [string]
        $UsernameField = 'username',

        [Parameter(ParameterSetName='Form')]
        [string]
        $PasswordField = 'password',

        [Parameter(ParameterSetName='Custom')]
        [switch]
        $Custom,

        [Parameter(Mandatory=$true, ParameterSetName='Custom')]
        [ValidateScript({
            if (Test-IsEmpty $_) {
                throw "A non-empty ScriptBlock is required for the Custom authentication type"
            }

            return $true
        })]
        [scriptblock]
        $ScriptBlock,

        [Parameter(ParameterSetName='Custom')]
        [hashtable]
        $ArgumentList,

        [Parameter()]
        [string]
        $Name,

        [Parameter()]
        [string]
        $Realm,

        [Parameter(ParameterSetName='Custom')]
        [ValidateSet('ApiKey', 'Http', 'OAuth2', 'OpenIdConnect')]
        [string]
        $Scheme = 'Http',

        [Parameter(ParameterSetName='Custom')]
        [scriptblock]
        $PostValidator,

        [Parameter(ParameterSetName='Digest')]
        [switch]
        $Digest
    )

    # configure the auth type
    switch ($PSCmdlet.ParameterSetName.ToLowerInvariant()) {
        'basic' {
            return @{
                Name = (Protect-PodeValue -Value $Name -Default 'Basic')
                Realm = $Realm
                ScriptBlock = (Get-PodeAuthBasicType)
                PostValidator = $null
                Scheme = 'http'
                Arguments = @{
                    HeaderTag = (Protect-PodeValue -Value $HeaderTag -Default 'Basic')
                    Encoding = (Protect-PodeValue -Value $Encoding -Default 'ISO-8859-1')
                }
            }
        }

        'digest' {
            return @{
                Name = (Protect-PodeValue -Value $Name -Default 'Digest')
                Realm = (Protect-PodeValue -Value $Realm -Default 'User Authentication')
                ScriptBlock = (Get-PodeAuthDigestType)
                PostValidator = (Get-PodeAuthDigestPostValidator)
                Scheme = 'http'
                Arguments = @{}
            }
        }

        'form' {
            return @{
                Name = (Protect-PodeValue -Value $Name -Default 'Form')
                Realm = $Realm
                ScriptBlock = (Get-PodeAuthFormType)
                PostValidator = $null
                Scheme = 'http'
                Arguments = @{
                    Fields = @{
                        Username = (Protect-PodeValue -Value $UsernameField -Default 'username')
                        Password = (Protect-PodeValue -Value $PasswordField -Default 'password')
                    }
                }
            }
        }

        'custom' {
            return @{
                Name = $Name
                Realm = $Realm
                Scheme = $Scheme.ToLowerInvariant()
                ScriptBlock = $ScriptBlock
                PostValidator = $PostValidator
                Arguments = $ArgumentList
            }
        }
    }
}

<#
.SYNOPSIS
Adds a custom Authentication method for verifying users.

.DESCRIPTION
Adds a custom Authentication method for verifying users.

.PARAMETER Name
A unique Name for the Authentication method.

.PARAMETER Type
The Type to use for retrieving credentials (From New-PodeAuthType).

.PARAMETER ScriptBlock
The ScriptBlock defining logic that retrieves and verifys a user.

.PARAMETER ArgumentList
An array of arguments to supply to the Custom Authentication's ScriptBlock.

.EXAMPLE
New-PodeAuthType -Form | Add-PodeAuth -Name 'Main' -ScriptBlock { /* logic */ }
#>
function Add-PodeAuth
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter(Mandatory=$true, ValueFromPipeline=$true)]
        [hashtable]
        $Type,

        [Parameter(Mandatory=$true)]
        [ValidateScript({
            if (Test-IsEmpty $_) {
                throw "A non-empty ScriptBlock is required for the authentication method"
            }

            return $true
        })]
        [scriptblock]
        $ScriptBlock,

        [Parameter()]
        [object[]]
        $ArgumentList
    )

    # ensure the name doesn't already exist
    if ($PodeContext.Server.Authentications.ContainsKey($Name)) {
        throw "Authentication method already defined: $($Name)"
    }

    # ensure the Type contains a scriptblock
    if (Test-IsEmpty $Type.ScriptBlock) {
        throw "The supplied Type for the '$($Name)' authentication method requires a valid ScriptBlock"
    }

    # add auth method to server
    $PodeContext.Server.Authentications[$Name] = @{
        Type = $Type
        ScriptBlock = $ScriptBlock
        Arguments = $ArgumentList
    }
}

<#
.SYNOPSIS
Adds the inbuilt Windows AD Authentication method for verifying users.

.DESCRIPTION
Adds the inbuilt Windows AD Authentication method for verifying users.

.PARAMETER Name
A unique Name for the Authentication method.

.PARAMETER Type
The Type to use for retrieving credentials (From New-PodeAuthType).

.PARAMETER Fqdn
A custom FQDN for the DNS of the AD you wish to authenticate against.

.PARAMETER Groups
An array of Group names to only allow access.

.PARAMETER Users
An array of Usernames to only allow access.

.PARAMETER NoGroups
If supplied, groups will not be retrieved for the user in AD.

.EXAMPLE
New-PodeAuthType -Form | Add-PodeAuthWindowsAd -Name 'WinAuth'

.EXAMPLE
New-PodeAuthType -Basic | Add-PodeAuthWindowsAd -Name 'WinAuth' -Groups @('Developers')

.EXAMPLE
New-PodeAuthType -Form | Add-PodeAuthWindowsAd -Name 'WinAuth' -NoGroups
#>
function Add-PodeAuthWindowsAd
{
    [CmdletBinding(DefaultParameterSetName='Groups')]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter(Mandatory=$true, ValueFromPipeline=$true)]
        [hashtable]
        $Type,

        [Parameter()]
        [string]
        $Fqdn = $env:USERDNSDOMAIN,

        [Parameter(ParameterSetName='Groups')]
        [string[]]
        $Groups,

        [Parameter()]
        [string[]]
        $Users,

        [Parameter(ParameterSetName='NoGroups')]
        [switch]
        $NoGroups
    )

    # Check PowerShell/OS version
    $version = $PSVersionTable.PSVersion
    if ((Test-IsUnix) -or ($version.Major -eq 6 -and $version.Minor -eq 0)) {
        throw 'Windows AD authentication is currently only supported on Windows PowerShell, and Windows PowerShell Core v6.1+'
    }

    # ensure the name doesn't already exist
    if ($PodeContext.Server.Authentications.ContainsKey($Name)) {
        throw "Windows AD Authentication method already defined: $($Name)"
    }

    # ensure the Type contains a scriptblock
    if (Test-IsEmpty $Type.ScriptBlock) {
        throw "The supplied Type for the '$($Name)' Windows AD authentication method requires a valid ScriptBlock"
    }

    # add Windows AD auth method to server
    $PodeContext.Server.Authentications[$Name] = @{
        Type = $Type
        ScriptBlock = (Get-PodeAuthInbuiltMethod -Type WindowsAd)
        Arguments = @{
            Fqdn = $Fqdn
            Users = $Users
            Groups = $Groups
            NoGroups = $NoGroups
        }
    }
}

<#
.SYNOPSIS
Remove a specific Authentication method.

.DESCRIPTION
Remove a specific Authentication method.

.PARAMETER Name
The Name of the Authentication method.

.EXAMPLE
Remove-PodeAuth -Name 'Login'
#>
function Remove-PodeAuth
{
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$true, ValueFromPipeline=$true)]
        [string]
        $Name
    )

    $PodeContext.Server.Authentications.Remove($Name) | Out-Null
}

<#
.SYNOPSIS
Clear all defined Authentication methods.

.DESCRIPTION
Clear all defined Authentication methods.

.EXAMPLE
Clear-PodeAuth
#>
function Clear-PodeAuth
{
    [CmdletBinding()]
    param()

    $PodeContext.Server.Authentications.Clear()
}

<#
.SYNOPSIS
Returns Authentication Middleware that can be used globally, or an Routes.

.DESCRIPTION
Returns Authentication Middleware that can be used globally, or an Routes.

.PARAMETER Name
The Name of the Authentication method.

.PARAMETER FailureUrl
The URL to redirect to when authentication fails.

.PARAMETER FailureMessage
An override Message to throw when authentication fails.

.PARAMETER SuccessUrl
The URL to redirect to when authentication succeeds.

.PARAMETER EnableFlash
If supplied, error messages will be added as Flash messages.

.PARAMETER Sessionless
If supplied, authenticated users will not be stored in sessions, and sessions will not be used.

.PARAMETER AutoLogin
If supplied, navigating to a login page with a valid session will redirect to the SuccessUrl. Otherwise the login page will be displayed.

.PARAMETER Logout
If supplied, the current session will be purged, and the user will be redirected to the FailureUrl.

.EXAMPLE
Add-PodeRoute -Method Get -Path '/' -Middleware (Get-PodeAuthMiddleware -Name 'Main') -ScriptBlock { /* logic */ }

.EXAMPLE
Get-PodeAuthMiddleware -Name 'BasicAuth' -Sessionless | Add-PodeMiddeware -Name 'GlobalAuth'

.EXAMPLE
Add-PodeRoute -Method Get -Path '/login' -Middleware (Get-PodeAuthMiddleware -Name 'Main' -SuccessUrl '/' -AutoLogin) -ScriptBlock { /* logic */ }
#>
function Get-PodeAuthMiddleware
{
    [CmdletBinding()]
    [OutputType([hashtable])]
    param (
        [Parameter(Mandatory=$true, ValueFromPipeline=$true)]
        [string]
        $Name,

        [Parameter()]
        [string]
        $FailureUrl,

        [Parameter()]
        [string]
        $FailureMessage,

        [Parameter()]
        [string]
        $SuccessUrl,

        [switch]
        $EnableFlash,

        [switch]
        $Sessionless,

        [switch]
        $AutoLogin,

        [switch]
        $Logout
    )

    # ensure the auth method exists
    if (!$PodeContext.Server.Authentications.ContainsKey($Name)) {
        throw "Authentication method does not exist: $($Name)"
    }

    # if we're using sessions, ensure sessions have been setup
    if (!$Sessionless -and !(Test-PodeSessionsConfigured)) {
        throw 'Sessions are required to use session persistent authentication'
    }

    # create the options
    $options = @{
        Name = $Name
        Failure = @{
            Url = $FailureUrl
            Message = $FailureMessage
            FlashEnabled = $EnableFlash
        }
        Success = @{
            Url = $SuccessUrl
        }
        Sessionless = $Sessionless
        AutoLogin = $AutoLogin
        Logout = $Logout
    }

    # return the middleware
    return (Get-PodeAuthMiddlewareScript | New-PodeMiddleware -ArgumentList $options)
}

1	<#
2	.SYNOPSIS
3	Create a new type of Authentication.
4
5	.DESCRIPTION
6	Create a new type of Authentication, which is used to parse the Request for user credentials for validating.
7
8	.PARAMETER Basic
9	If supplied, will use the inbuilt Basic Authentication credentials retriever.
10
11	.PARAMETER Encoding
12	The Encoding to use when decoding the Basic Authorization header.
13
14	.PARAMETER HeaderTag
15	The name of the type of Basic Authentication.
16
17	.PARAMETER Form
18	If supplied, will use the inbuilt Form Authentication credentials retriever.
19
20	.PARAMETER UsernameField
21	The name of the Username Field in the payload to retrieve the username.
22
23	.PARAMETER PasswordField
24	The name of the Password Field in the payload to retrieve the password.
25
26	.PARAMETER Custom
27	If supplied, will allow you to create a Custom Authentication credentials retriever.
28
29	.PARAMETER ScriptBlock
30	The ScriptBlock is used to parse the request and retieve user credentials and other information.
31
32	.PARAMETER ArgumentList
33	An array of arguments to supply to the Custom Authentication type's ScriptBlock.
34
35	.PARAMETER Name
36	The Name of an Authentication type - such as Basic or NTLM.
37
38	.PARAMETER Realm
39	The name of scope of the protected area.
40
41	.PARAMETER Scheme
42	The scheme type for custom Authentication types. Default is HTTP.
43
44	.PARAMETER Digest
45	If supplied, will use the inbuilt Digest Authentication credentials retriever.
46
47	.PARAMETER PostValidator
48	The PostValidator is a scriptblock that is invoked after user validation.
49
50	.EXAMPLE
51	$basic_auth = New-PodeAuthType -Basic
52
53	.EXAMPLE
54	$form_auth = New-PodeAuthType -Form -UsernameField 'Email'
55
56	.EXAMPLE
57	$custom_auth = New-PodeAuthType -Custom -ScriptBlock { /* logic */ }
58	#>
59	function New-PodeAuthType
60	{
61	[CmdletBinding(DefaultParameterSetName='Basic')]
62	[OutputType([hashtable])]
63	param (
64	[Parameter(ParameterSetName='Basic')]
65	[switch]
66	$Basic,
67
68	[Parameter(ParameterSetName='Basic')]
69	[string]
70	$Encoding = 'ISO-8859-1',
71
72	[Parameter(ParameterSetName='Basic')]
73	[string]
74	$HeaderTag = 'Basic',
75
76	[Parameter(ParameterSetName='Form')]
77	[switch]
78	$Form,
79
80	[Parameter(ParameterSetName='Form')]
81	[string]
82	$UsernameField = 'username',
83
84	[Parameter(ParameterSetName='Form')]
85	[string]
86	$PasswordField = 'password',
87
88	[Parameter(ParameterSetName='Custom')]
89	[switch]
90	$Custom,
91
92	[Parameter(Mandatory=$true, ParameterSetName='Custom')]
93	[ValidateScript({
94	if (Test-IsEmpty $_) {	×
95	throw "A non-empty ScriptBlock is required for the Custom authentication type"	×
96	}
97
98	return $true	×
99	})]
100	[scriptblock]
101	$ScriptBlock,
102
103	[Parameter(ParameterSetName='Custom')]
104	[hashtable]
105	$ArgumentList,
106
107	[Parameter()]
108	[string]
109	$Name,
110
111	[Parameter()]
112	[string]
113	$Realm,
114
115	[Parameter(ParameterSetName='Custom')]
116	[ValidateSet('ApiKey', 'Http', 'OAuth2', 'OpenIdConnect')]
117	[string]
118	$Scheme = 'Http',
119
120	[Parameter(ParameterSetName='Custom')]
121	[scriptblock]
122	$PostValidator,
123
124	[Parameter(ParameterSetName='Digest')]
125	[switch]
126	$Digest
127	)
128
129	# configure the auth type
130	switch ($PSCmdlet.ParameterSetName.ToLowerInvariant()) {	×
131	'basic' {
132	return @{	×
133	Name = (Protect-PodeValue -Value $Name -Default 'Basic')	×
134	Realm = $Realm	×
135	ScriptBlock = (Get-PodeAuthBasicType)	×
136	PostValidator = $null	×
137	Scheme = 'http'	×
138	Arguments = @{	×
139	HeaderTag = (Protect-PodeValue -Value $HeaderTag -Default 'Basic')	×
140	Encoding = (Protect-PodeValue -Value $Encoding -Default 'ISO-8859-1')	×
141	}
142	}
143	}
144
145	'digest' {
146	return @{	×
147	Name = (Protect-PodeValue -Value $Name -Default 'Digest')	×
148	Realm = (Protect-PodeValue -Value $Realm -Default 'User Authentication')	×
149	ScriptBlock = (Get-PodeAuthDigestType)	×
150	PostValidator = (Get-PodeAuthDigestPostValidator)	×
151	Scheme = 'http'	×
152	Arguments = @{}	×
153	}
154	}
155
156	'form' {
157	return @{	×
158	Name = (Protect-PodeValue -Value $Name -Default 'Form')	×
159	Realm = $Realm	×
160	ScriptBlock = (Get-PodeAuthFormType)	×
161	PostValidator = $null	×
162	Scheme = 'http'	×
163	Arguments = @{	×
164	Fields = @{	×
165	Username = (Protect-PodeValue -Value $UsernameField -Default 'username')	×
166	Password = (Protect-PodeValue -Value $PasswordField -Default 'password')	×
167	}
168	}
169	}
170	}
171
172	'custom' {
173	return @{	×
174	Name = $Name	×
175	Realm = $Realm	×
176	Scheme = $Scheme.ToLowerInvariant()	×
177	ScriptBlock = $ScriptBlock	×
178	PostValidator = $PostValidator	×
179	Arguments = $ArgumentList	×
180	}
181	}
182	}
183	}
184
185	<#
186	.SYNOPSIS
187	Adds a custom Authentication method for verifying users.
188
189	.DESCRIPTION
190	Adds a custom Authentication method for verifying users.
191
192	.PARAMETER Name
193	A unique Name for the Authentication method.
194
195	.PARAMETER Type
196	The Type to use for retrieving credentials (From New-PodeAuthType).
197
198	.PARAMETER ScriptBlock
199	The ScriptBlock defining logic that retrieves and verifys a user.
200
201	.PARAMETER ArgumentList
202	An array of arguments to supply to the Custom Authentication's ScriptBlock.
203
204	.EXAMPLE
205	New-PodeAuthType -Form \| Add-PodeAuth -Name 'Main' -ScriptBlock { /* logic */ }
206	#>
207	function Add-PodeAuth
208	{
209	[CmdletBinding()]
210	param (
211	[Parameter(Mandatory=$true)]
212	[string]
213	$Name,
214
215	[Parameter(Mandatory=$true, ValueFromPipeline=$true)]
216	[hashtable]
217	$Type,
218
219	[Parameter(Mandatory=$true)]
220	[ValidateScript({
221	if (Test-IsEmpty $_) {	×
222	throw "A non-empty ScriptBlock is required for the authentication method"	×
223	}
224
225	return $true	×
226	})]
227	[scriptblock]
228	$ScriptBlock,
229
230	[Parameter()]
231	[object[]]
232	$ArgumentList
233	)
234
235	# ensure the name doesn't already exist
236	if ($PodeContext.Server.Authentications.ContainsKey($Name)) {	×
237	throw "Authentication method already defined: $($Name)"	×
238	}
239
240	# ensure the Type contains a scriptblock
241	if (Test-IsEmpty $Type.ScriptBlock) {	×
242	throw "The supplied Type for the '$($Name)' authentication method requires a valid ScriptBlock"	×
243	}
244
245	# add auth method to server
246	$PodeContext.Server.Authentications[$Name] = @{	×
247	Type = $Type	×
248	ScriptBlock = $ScriptBlock	×
249	Arguments = $ArgumentList	×
250	}
251	}
252
253	<#
254	.SYNOPSIS
255	Adds the inbuilt Windows AD Authentication method for verifying users.
256
257	.DESCRIPTION
258	Adds the inbuilt Windows AD Authentication method for verifying users.
259
260	.PARAMETER Name
261	A unique Name for the Authentication method.
262
263	.PARAMETER Type
264	The Type to use for retrieving credentials (From New-PodeAuthType).
265
266	.PARAMETER Fqdn
267	A custom FQDN for the DNS of the AD you wish to authenticate against.
268
269	.PARAMETER Groups
270	An array of Group names to only allow access.
271
272	.PARAMETER Users
273	An array of Usernames to only allow access.
274
275	.PARAMETER NoGroups
276	If supplied, groups will not be retrieved for the user in AD.
277
278	.EXAMPLE
279	New-PodeAuthType -Form \| Add-PodeAuthWindowsAd -Name 'WinAuth'
280
281	.EXAMPLE
282	New-PodeAuthType -Basic \| Add-PodeAuthWindowsAd -Name 'WinAuth' -Groups @('Developers')
283
284	.EXAMPLE
285	New-PodeAuthType -Form \| Add-PodeAuthWindowsAd -Name 'WinAuth' -NoGroups
286	#>
287	function Add-PodeAuthWindowsAd
288	{
289	[CmdletBinding(DefaultParameterSetName='Groups')]
290	param (
291	[Parameter(Mandatory=$true)]
292	[string]
293	$Name,
294
295	[Parameter(Mandatory=$true, ValueFromPipeline=$true)]
296	[hashtable]
297	$Type,
298
299	[Parameter()]
300	[string]
301	$Fqdn = $env:USERDNSDOMAIN,
302
303	[Parameter(ParameterSetName='Groups')]
304	[string[]]
305	$Groups,
306
307	[Parameter()]
308	[string[]]
309	$Users,
310
311	[Parameter(ParameterSetName='NoGroups')]
312	[switch]
313	$NoGroups
314	)
315
316	# Check PowerShell/OS version
317	$version = $PSVersionTable.PSVersion	×
318	if ((Test-IsUnix) -or ($version.Major -eq 6 -and $version.Minor -eq 0)) {	×
319	throw 'Windows AD authentication is currently only supported on Windows PowerShell, and Windows PowerShell Core v6.1+'	×
320	}
321
322	# ensure the name doesn't already exist
323	if ($PodeContext.Server.Authentications.ContainsKey($Name)) {	×
324	throw "Windows AD Authentication method already defined: $($Name)"	×
325	}
326
327	# ensure the Type contains a scriptblock
328	if (Test-IsEmpty $Type.ScriptBlock) {	×
329	throw "The supplied Type for the '$($Name)' Windows AD authentication method requires a valid ScriptBlock"	×
330	}
331
332	# add Windows AD auth method to server
333	$PodeContext.Server.Authentications[$Name] = @{	×
334	Type = $Type	×
335	ScriptBlock = (Get-PodeAuthInbuiltMethod -Type WindowsAd)	×
336	Arguments = @{	×
337	Fqdn = $Fqdn	×
338	Users = $Users	×
339	Groups = $Groups	×
340	NoGroups = $NoGroups	×
341	}
342	}
343	}
344
345	<#
346	.SYNOPSIS
347	Remove a specific Authentication method.
348
349	.DESCRIPTION
350	Remove a specific Authentication method.
351
352	.PARAMETER Name
353	The Name of the Authentication method.
354
355	.EXAMPLE
356	Remove-PodeAuth -Name 'Login'
357	#>
358	function Remove-PodeAuth
359	{
360	[CmdletBinding()]
361	param (
362	[Parameter(Mandatory=$true, ValueFromPipeline=$true)]
363	[string]
364	$Name
365	)
366
367	$PodeContext.Server.Authentications.Remove($Name) \| Out-Null	×
368	}
369
370	<#
371	.SYNOPSIS
372	Clear all defined Authentication methods.
373
374	.DESCRIPTION
375	Clear all defined Authentication methods.
376
377	.EXAMPLE
378	Clear-PodeAuth
379	#>
380	function Clear-PodeAuth
381	{
382	[CmdletBinding()]
383	param()
384
385	$PodeContext.Server.Authentications.Clear()	×
386	}
387
388	<#
389	.SYNOPSIS
390	Returns Authentication Middleware that can be used globally, or an Routes.
391
392	.DESCRIPTION
393	Returns Authentication Middleware that can be used globally, or an Routes.
394
395	.PARAMETER Name
396	The Name of the Authentication method.
397
398	.PARAMETER FailureUrl
399	The URL to redirect to when authentication fails.
400
401	.PARAMETER FailureMessage
402	An override Message to throw when authentication fails.
403
404	.PARAMETER SuccessUrl
405	The URL to redirect to when authentication succeeds.
406
407	.PARAMETER EnableFlash
408	If supplied, error messages will be added as Flash messages.
409
410	.PARAMETER Sessionless
411	If supplied, authenticated users will not be stored in sessions, and sessions will not be used.
412
413	.PARAMETER AutoLogin
414	If supplied, navigating to a login page with a valid session will redirect to the SuccessUrl. Otherwise the login page will be displayed.
415
416	.PARAMETER Logout
417	If supplied, the current session will be purged, and the user will be redirected to the FailureUrl.
418
419	.EXAMPLE
420	Add-PodeRoute -Method Get -Path '/' -Middleware (Get-PodeAuthMiddleware -Name 'Main') -ScriptBlock { /* logic */ }
421
422	.EXAMPLE
423	Get-PodeAuthMiddleware -Name 'BasicAuth' -Sessionless \| Add-PodeMiddeware -Name 'GlobalAuth'
424
425	.EXAMPLE
426	Add-PodeRoute -Method Get -Path '/login' -Middleware (Get-PodeAuthMiddleware -Name 'Main' -SuccessUrl '/' -AutoLogin) -ScriptBlock { /* logic */ }
427	#>
428	function Get-PodeAuthMiddleware
429	{
430	[CmdletBinding()]
431	[OutputType([hashtable])]
432	param (
433	[Parameter(Mandatory=$true, ValueFromPipeline=$true)]
434	[string]
435	$Name,
436
437	[Parameter()]
438	[string]
439	$FailureUrl,
440
441	[Parameter()]
442	[string]
443	$FailureMessage,
444
445	[Parameter()]
446	[string]
447	$SuccessUrl,
448
449	[switch]
450	$EnableFlash,
451
452	[switch]
453	$Sessionless,
454
455	[switch]
456	$AutoLogin,
457
458	[switch]
459	$Logout
460	)
461
462	# ensure the auth method exists
463	if (!$PodeContext.Server.Authentications.ContainsKey($Name)) {	×
464	throw "Authentication method does not exist: $($Name)"	×
465	}
466
467	# if we're using sessions, ensure sessions have been setup
468	if (!$Sessionless -and !(Test-PodeSessionsConfigured)) {	×
469	throw 'Sessions are required to use session persistent authentication'	×
470	}
471
472	# create the options
473	$options = @{	×
474	Name = $Name	×
475	Failure = @{	×
476	Url = $FailureUrl	×
477	Message = $FailureMessage	×
478	FlashEnabled = $EnableFlash	×
479	}
480	Success = @{	×
481	Url = $SuccessUrl	×
482	}
483	Sessionless = $Sessionless	×
484	AutoLogin = $AutoLogin	×
485	Logout = $Logout	×
486	}
487
488	# return the middleware
489	return (Get-PodeAuthMiddlewareScript \| New-PodeMiddleware -ArgumentList $options)	×
490	}

Badgerati / Pode / #546

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