-
-
Notifications
You must be signed in to change notification settings - Fork 794
/
createAuthScheme.js
315 lines (275 loc) · 10.1 KB
/
createAuthScheme.js
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
312
313
314
315
import Boom from '@hapi/boom'
import { log } from '@serverless/utils/log.js'
import authCanExecuteResource from '../authCanExecuteResource.js'
import authValidateContext from '../authValidateContext.js'
import {
getRawQueryParams,
nullIfEmpty,
parseHeaders,
parseMultiValueHeaders,
parseMultiValueQueryStringParameters,
parseQueryStringParameters,
} from '../../utils/index.js'
const IDENTITY_SOURCE_TYPE_HEADER = 'header'
const IDENTITY_SOURCE_TYPE_QUERYSTRING = 'querystring'
const IDENTITY_SOURCE_TYPE_NONE = 'none'
export default function createAuthScheme(authorizerOptions, provider, lambda) {
const authFunName = authorizerOptions.name
let identitySourceField = 'authorization'
let identitySourceType = IDENTITY_SOURCE_TYPE_HEADER
const finalizeAuthScheme = () => {
return () => ({
async authenticate(request, h) {
log.notice()
log.notice(
`Running Authorization function for ${request.method} ${request.path} (λ: ${authFunName})`,
)
const { rawHeaders, url } = request.raw.req
// Get path params
// aws doesn't auto decode path params - hapi does
const pathParams = { ...request.params }
const accountId = 'random-account-id'
const apiId = 'random-api-id'
const requestId = 'random-request-id'
const httpMethod = request.method.toUpperCase()
const resourcePath = request.route.path.replace(
new RegExp(`^/${provider.stage}`),
'',
)
let event = {
enhancedAuthContext: {},
headers: parseHeaders(rawHeaders),
requestContext: {
accountId,
apiId,
domainName: `${apiId}.execute-api.us-east-1.amazonaws.com`,
domainPrefix: apiId,
requestId,
stage: provider.stage,
},
version: authorizerOptions.payloadVersion,
}
const protocol = `${request.server.info.protocol.toUpperCase()}/${
request.raw.req.httpVersion
}`
const currentDate = new Date()
const resourceId = `${httpMethod} ${resourcePath}`
const methodArn = `arn:aws:execute-api:${provider.region}:${accountId}:${apiId}/${provider.stage}/${httpMethod}${resourcePath}`
let authorization
switch (identitySourceType) {
case IDENTITY_SOURCE_TYPE_HEADER: {
const headers = request.raw.req.headers ?? {}
authorization = headers[identitySourceField]
break
}
case IDENTITY_SOURCE_TYPE_QUERYSTRING: {
const queryStringParameters = parseQueryStringParameters(url) ?? {}
authorization = queryStringParameters[identitySourceField]
break
}
default: {
break
}
}
let finalAuthorization
if (identitySourceType !== IDENTITY_SOURCE_TYPE_NONE) {
if (
authorization === undefined &&
authorizerOptions.type !== 'request'
) {
log.error(
`Identity Source is null for ${identitySourceType} ${identitySourceField} (λ: ${authFunName})`,
)
return Boom.unauthorized(
'User is not authorized to access this resource',
)
}
const identityValidationExpression = new RegExp(
authorizerOptions.identityValidationExpression,
)
const matchedAuthorization =
identityValidationExpression.test(authorization)
finalAuthorization = matchedAuthorization ? authorization : ''
log.debug(
`Retrieved ${identitySourceField} ${identitySourceType} "${finalAuthorization}"`,
)
}
if (authorizerOptions.payloadVersion === '1.0') {
event = {
...event,
authorizationToken: finalAuthorization,
httpMethod: request.method.toUpperCase(),
identitySource: finalAuthorization,
methodArn,
multiValueHeaders: parseMultiValueHeaders(rawHeaders),
multiValueQueryStringParameters:
parseMultiValueQueryStringParameters(url),
path: request.path,
pathParameters: nullIfEmpty(pathParams),
queryStringParameters: parseQueryStringParameters(url),
requestContext: {
extendedRequestId: requestId,
httpMethod,
path: request.path,
protocol,
requestTime: currentDate.toString(),
requestTimeEpoch: currentDate.getTime(),
resourceId,
resourcePath,
stage: provider.stage,
},
resource: resourcePath,
}
}
if (authorizerOptions.payloadVersion === '2.0') {
event = {
...event,
identitySource: [finalAuthorization],
rawPath: request.path,
rawQueryString: getRawQueryParams(url),
requestContext: {
http: {
method: httpMethod,
path: resourcePath,
protocol,
},
routeKey: resourceId,
time: currentDate.toString(),
timeEpoch: currentDate.getTime(),
},
routeArn: methodArn,
routeKey: resourceId,
}
}
// methodArn is the ARN of the function we are running we are authorizing access to (or not)
// Account ID and API ID are not simulated
event = {
...event,
// This is safe since type: 'TOKEN' cannot have payload format 2.0
type: authorizerOptions.type === 'request' ? 'REQUEST' : 'TOKEN',
}
const lambdaFunction = lambda.get(authFunName)
lambdaFunction.setEvent(event)
try {
const result = await lambdaFunction.runHandler()
if (authorizerOptions.enableSimpleResponses) {
if (result.isAuthorized) {
const authorizer = {
integrationLatency: '42',
...result.context,
}
return h.authenticated({
credentials: {
authorizer,
context: result.context || {},
},
})
}
return Boom.forbidden(
'User is not authorized to access this resource',
)
}
if (result === 'Unauthorized')
return Boom.unauthorized('Unauthorized')
// Validate that the policy document has the principalId set
if (!result.principalId) {
log.notice(
`Authorization response did not include a principalId: (λ: ${authFunName})`,
)
return Boom.forbidden('No principalId set on the Response')
}
if (
!authCanExecuteResource(
result.policyDocument,
event.methodArn || event.routeArn,
)
) {
log.notice(
`Authorization response didn't authorize user to access resource: (λ: ${authFunName})`,
)
return Boom.forbidden(
'User is not authorized to access this resource',
)
}
// validate the resulting context, ensuring that all
// values are either string, number, or boolean types
if (result.context) {
const validationResult = authValidateContext(
result.context,
authFunName,
)
if (validationResult instanceof Error) {
return validationResult
}
result.context = validationResult
}
log.notice(
`Authorization function returned a successful response: (λ: ${authFunName})`,
)
const authorizer = {
integrationLatency: '42',
principalId: result.principalId,
...result.context,
}
// Set the credentials for the rest of the pipeline
return h.authenticated({
credentials: {
authorizer,
context: result.context,
principalId: result.principalId,
usageIdentifierKey: result.usageIdentifierKey,
},
})
} catch {
log.notice(
`Authorization function returned an error response: (λ: ${authFunName})`,
)
return Boom.unauthorized('Unauthorized')
}
},
})
}
const checkForIdentitySourceMatch = (exp, expectedLength) => {
const identitySourceMatch = exp.exec(authorizerOptions.identitySource)
if (!identitySourceMatch || identitySourceMatch.length !== expectedLength) {
return undefined
}
return identitySourceMatch[expectedLength - 1]
}
if (authorizerOptions.identitySource === '') {
identitySourceField = null
identitySourceType = IDENTITY_SOURCE_TYPE_NONE
return finalizeAuthScheme()
}
if (authorizerOptions.identitySource) {
// Only validate the first of N possible headers.
const headerRegExp = /^(method.|\$)request.header.((?:\w+-?)+\w+).*$/
const queryStringRegExp =
/^(method.|\$)request.querystring.((?:\w+-?)+\w+)$/
const identityHeaderResult = checkForIdentitySourceMatch(headerRegExp, 3)
if (identityHeaderResult !== undefined) {
identitySourceField = identityHeaderResult.toLowerCase()
identitySourceType = IDENTITY_SOURCE_TYPE_HEADER
return finalizeAuthScheme()
}
const identityQueryStringResult = checkForIdentitySourceMatch(
queryStringRegExp,
3,
)
if (identityQueryStringResult !== undefined) {
identitySourceField = identityQueryStringResult
identitySourceType = IDENTITY_SOURCE_TYPE_QUERYSTRING
return finalizeAuthScheme()
}
if (authorizerOptions.type !== 'request') {
throw new Error(
`Serverless Offline only supports retrieving tokens from headers and querystring parameters (λ: ${authFunName})`,
)
}
}
if (authorizerOptions.resultTtlInSeconds === 0) {
identitySourceType = IDENTITY_SOURCE_TYPE_NONE
return finalizeAuthScheme()
}
return finalizeAuthScheme()
}