-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
auth-helper.js
212 lines (186 loc) · 5.39 KB
/
auth-helper.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
'use strict'
const { URL } = require('url')
const { InvalidParameter } = require('./errors')
class AuthHelper {
constructor(
{
userKey,
passKey,
authorizedOrigins,
serviceKey,
isRequired = false,
defaultToEmptyStringForUser = false,
},
config
) {
if (!userKey && !passKey) {
throw Error('Expected userKey or passKey to be set')
}
if (!authorizedOrigins && !serviceKey) {
throw Error('Expected authorizedOrigins or serviceKey to be set')
}
this._userKey = userKey
this._passKey = passKey
if (userKey) {
this._user = config.private[userKey]
} else {
this._user = defaultToEmptyStringForUser ? '' : undefined
}
this._pass = passKey ? config.private[passKey] : undefined
this.isRequired = isRequired
if (serviceKey !== undefined && !(serviceKey in config.public.services)) {
// Keep this as its own error, as it's useful to the programmer as they're
// getting auth set up.
throw Error(`Service key ${serviceKey} was missing from config schema`)
}
let requireStrictSsl, requireStrictSslToAuthenticate
if (serviceKey === undefined) {
requireStrictSsl = true
requireStrictSslToAuthenticate = true
} else {
;({
authorizedOrigins,
requireStrictSsl = true,
requireStrictSslToAuthenticate = true,
} = config.public.services[serviceKey])
}
if (!Array.isArray(authorizedOrigins)) {
throw Error('Expected authorizedOrigins to be an array of origins')
}
this._authorizedOrigins = authorizedOrigins
this._requireStrictSsl = requireStrictSsl
this._requireStrictSslToAuthenticate = requireStrictSslToAuthenticate
}
get isConfigured() {
return (
this._authorizedOrigins.length > 0 &&
(this._userKey ? Boolean(this._user) : true) &&
(this._passKey ? Boolean(this._pass) : true)
)
}
get isValid() {
if (this.isRequired) {
return this.isConfigured
} else {
const configIsEmpty = !this._user && !this._pass
return this.isConfigured || configIsEmpty
}
}
static _isInsecureSslRequest({ options = {} }) {
const { strictSSL = true } = options
return strictSSL !== true
}
enforceStrictSsl({ options = {} }) {
if (
this._requireStrictSsl &&
this.constructor._isInsecureSslRequest({ options })
) {
throw new InvalidParameter({ prettyMessage: 'strict ssl is required' })
}
}
shouldAuthenticateRequest({ url, options = {} }) {
let parsed
try {
parsed = new URL(url)
} catch (e) {
throw new InvalidParameter({ prettyMessage: 'invalid url parameter' })
}
const { protocol, host } = parsed
const origin = `${protocol}//${host}`
const originViolation = !this._authorizedOrigins.includes(origin)
const strictSslCheckViolation =
this._requireStrictSslToAuthenticate &&
this.constructor._isInsecureSslRequest({ options })
return this.isConfigured && !originViolation && !strictSslCheckViolation
}
get _basicAuth() {
const { _user: user, _pass: pass } = this
return this.isConfigured ? { user, pass } : undefined
}
/*
* Helper function for `withBasicAuth()` and friends.
*/
_withAnyAuth(requestParams, mergeAuthFn) {
this.enforceStrictSsl(requestParams)
const shouldAuthenticate = this.shouldAuthenticateRequest(requestParams)
if (this.isRequired && !shouldAuthenticate) {
throw new InvalidParameter({
prettyMessage: 'requested origin not authorized',
})
}
return shouldAuthenticate ? mergeAuthFn(requestParams) : requestParams
}
static _mergeAuth(requestParams, auth) {
const { options, ...rest } = requestParams
return {
options: {
auth,
...options,
},
...rest,
}
}
withBasicAuth(requestParams) {
return this._withAnyAuth(requestParams, requestParams =>
this.constructor._mergeAuth(requestParams, this._basicAuth)
)
}
_bearerAuthHeader(bearerKey) {
const { _pass: pass } = this
return this.isConfigured
? { Authorization: `${bearerKey} ${pass}` }
: undefined
}
static _mergeHeaders(requestParams, headers) {
const {
options: { headers: existingHeaders, ...restOptions } = {},
...rest
} = requestParams
return {
options: {
headers: {
...existingHeaders,
...headers,
},
...restOptions,
},
...rest,
}
}
withBearerAuthHeader(
requestParams,
bearerKey = 'Bearer' // lgtm [js/hardcoded-credentials]
) {
return this._withAnyAuth(requestParams, requestParams =>
this.constructor._mergeHeaders(
requestParams,
this._bearerAuthHeader(bearerKey)
)
)
}
static _mergeQueryParams(requestParams, query) {
const {
options: { qs: existingQuery, ...restOptions } = {},
...rest
} = requestParams
return {
options: {
qs: {
...existingQuery,
...query,
},
...restOptions,
},
...rest,
}
}
withQueryStringAuth({ userKey, passKey }, requestParams) {
return this._withAnyAuth(requestParams, requestParams =>
this.constructor._mergeQueryParams(requestParams, {
...(userKey ? { [userKey]: this._user } : undefined),
...(passKey ? { [passKey]: this._pass } : undefined),
})
)
}
}
module.exports = { AuthHelper }