-
-
Notifications
You must be signed in to change notification settings - Fork 90
/
Middleware.ps1
311 lines (259 loc) · 7.93 KB
/
Middleware.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
function Invoke-PodeMiddleware
{
param (
[Parameter(Mandatory=$true)]
[ValidateNotNull()]
$WebEvent,
[Parameter()]
$Middleware,
[Parameter()]
[string]
$Route
)
# if there's no middleware, do nothing
if (Test-Empty $Middleware) {
return $true
}
# filter the middleware down by route (retaining order)
if (!(Test-Empty $Route))
{
$Middleware = @($Middleware | Where-Object {
(Test-Empty $_.Route) -or
($_.Route -ieq '/') -or
($_.Route -ieq $Route) -or
($Route -imatch "^$($_.Route)$")
})
}
# continue or halt?
$continue = $true
# loop through each of the middleware, invoking the next if it returns true
foreach ($midware in @($Middleware))
{
try {
# set any custom middleware options
$WebEvent.Middleware = @{ 'Options' = $midware.Options }
# invoke the middleware logic
$continue = Invoke-ScriptBlock -ScriptBlock $midware.Logic -Arguments $WebEvent -Scoped -Return
# remove any custom middleware options
$WebEvent.Middleware.Clear()
}
catch {
status 500 -e $_
$continue = $false
$_.Exception | Out-Default
}
if (!$continue) {
break
}
}
return $continue
}
function Get-PodeInbuiltMiddleware
{
param (
[Parameter(Mandatory=$true)]
[ValidateNotNullOrEmpty()]
[string]
$Name,
[Parameter(Mandatory=$true)]
[ValidateNotNull()]
[scriptblock]
$ScriptBlock
)
# check if middleware contains an override
$override = ($PodeContext.Server.Middleware | Where-Object { $_.Name -ieq $Name })
# if override there, remove it from middleware
if ($override) {
$PodeContext.Server.Middleware = @($PodeContext.Server.Middleware | Where-Object { $_.Name -ine $Name })
$ScriptBlock = $override.Logic
}
# return the script
return @{
'Name' = $Name;
'Logic' = $ScriptBlock;
}
}
function Get-PodeAccessMiddleware
{
return (Get-PodeInbuiltMiddleware -Name '@access' -ScriptBlock {
param($s)
# ensure the request IP address is allowed
if (!(Test-PodeIPAccess -IP $s.Request.RemoteEndPoint.Address)) {
status 403
return $false
}
# IP address is allowed
return $true
})
}
function Get-PodeLimitMiddleware
{
return (Get-PodeInbuiltMiddleware -Name '@limit' -ScriptBlock {
param($s)
# ensure the request IP address has not hit a rate limit
if (!(Test-PodeIPLimit -IP $s.Request.RemoteEndPoint.Address)) {
status 429
return $false
}
# IP address is allowed
return $true
})
}
function Get-PodePublicMiddleware
{
return (Get-PodeInbuiltMiddleware -Name '@public' -ScriptBlock {
param($e)
# get the static file path
$info = Get-PodeStaticRoutePath -Route $e.Path -Protocol $e.Protocol -Endpoint $e.Endpoint
if (Test-Empty $info.Path) {
return $true
}
# check current state of caching
$config = $PodeContext.Server.Web.Static.Cache
$caching = $config.Enabled
# if caching, check include/exclude
if ($caching) {
if (($null -ne $config.Exclude) -and ($e.Path -imatch $config.Exclude)) {
$caching = $false
}
if (($null -ne $config.Include) -and ($e.Path -inotmatch $config.Include)) {
$caching = $false
}
}
# write, or attach, the file to the response
if ($info.Download) {
Attach -Path $info.Path -Literal
}
else {
File -Path $info.Path -MaxAge $PodeContext.Server.Web.Static.Cache.MaxAge -Cache:$caching
}
# static content found, stop
return $false
})
}
function Get-PodeRouteValidateMiddleware
{
return @{
'Name' = '@route-valid';
'Logic' = {
param($s)
# ensure the path has a route
$route = Get-PodeRoute -HttpMethod $s.Method -Route $s.Path -Protocol $s.Protocol -Endpoint $s.Endpoint -CheckWildMethod
# if there's no route defined, it's a 404
if ($null -eq $route -or $null -eq $route.Logic) {
status 404
return $false
}
# set the route parameters
$WebEvent.Parameters = $route.Parameters
# override the content type from the route if it's not empty
if (!(Test-Empty $route.ContentType)) {
$WebEvent.ContentType = $route.ContentType
}
# set the content type for any pages for the route if it's not empty
$WebEvent.ErrorType = $route.ErrorType
# route exists
return $true
}
}
}
function Get-PodeBodyMiddleware
{
return (Get-PodeInbuiltMiddleware -Name '@body' -ScriptBlock {
param($e)
try {
# attempt to parse that data
$result = ConvertFrom-PodeRequestContent -Request $e.Request -ContentType $e.ContentType
# set session data
$e.Data = $result.Data
$e.Files = $result.Files
# payload parsed
return $true
}
catch {
status 400 -e $_
return $false
}
})
}
function Get-PodeQueryMiddleware
{
return (Get-PodeInbuiltMiddleware -Name '@query' -ScriptBlock {
param($s)
try {
# set the query string from the request
$s.Query = (ConvertFrom-PodeNameValueToHashTable -Collection $s.Request.QueryString)
return $true
}
catch {
status 400 -e $_
return $false
}
})
}
function Middleware
{
param (
[Parameter(Mandatory=$true, Position=0, ParameterSetName='Script')]
[Parameter(Mandatory=$true, Position=1, ParameterSetName='ScriptRoute')]
[ValidateNotNull()]
[scriptblock]
$ScriptBlock,
[Parameter(Mandatory=$true, Position=0, ParameterSetName='ScriptRoute')]
[Parameter(Mandatory=$true, Position=0, ParameterSetName='HashRoute')]
[Alias('r')]
[string]
$Route,
[Parameter(Mandatory=$true, Position=0, ParameterSetName='Hash')]
[Parameter(Mandatory=$true, Position=1, ParameterSetName='HashRoute')]
[Alias('h')]
[hashtable]
$HashTable,
[Parameter()]
[Alias('n')]
[string]
$Name,
[switch]
$Return
)
# if a name was supplied, ensure it doesn't already exist
if (!(Test-Empty $Name)) {
if (($PodeContext.Server.Middleware | Where-Object { $_.Name -ieq $Name } | Measure-Object).Count -gt 0) {
throw "Middleware with defined name of $($Name) already exists"
}
}
# if route is empty, set it to root
$Route = Coalesce $Route '/'
$Route = Split-PodeRouteQuery -Route $Route
$Route = Coalesce $Route '/'
$Route = Update-PodeRouteSlashes -Route $Route
$Route = Update-PodeRoutePlaceholders -Route $Route
# create the middleware hash, or re-use a passed one
if (Test-Empty $HashTable)
{
$HashTable = @{
'Name' = $Name;
'Route' = $Route;
'Logic' = $ScriptBlock;
}
}
else
{
if (Test-Empty $HashTable.Logic) {
throw 'Middleware supplied has no Logic'
}
if (Test-Empty $HashTable.Route) {
$HashTable.Route = $Route
}
if (Test-Empty $HashTable.Name) {
$HashTable.Name = $Name
}
}
# add the scriptblock to array of middleware that needs to be run
if ($Return) {
return $HashTable
}
else {
$PodeContext.Server.Middleware += $HashTable
}
}