This repository was archived by the owner on Nov 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathusers.js
More file actions
422 lines (386 loc) · 10.3 KB
/
users.js
File metadata and controls
422 lines (386 loc) · 10.3 KB
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
// provide a module to handle requests associated with users
'use strict';
const Restful = require(process.env.CSSVC_BACKEND_ROOT + '/api_server/lib/util/restful/restful');
const UserCreator = require('./user_creator');
const UserUpdater = require('./user_updater');
const UserDeleter = require('./user_deleter');
const SignupTokens = require('./signup_tokens');
const User = require('./user');
const Errors = require('./errors');
const ErrorHandler = require(process.env.CSSVC_BACKEND_ROOT + '/shared/server_utils/error_handler');
const Reinviter = require('./reinviter');
const WeeklyEmails = require('./weekly_emails');
const PasswordEncrypt = require('./password_encrypt');
const DEPENDENCIES = [
'authenticator' // need the user
];
// expose these restful routes
const USERS_STANDARD_ROUTES = {
want: ['get', 'getMany', 'put', 'post', 'delete'],
baseRouteName: 'users',
requestClasses: {
'get': require('./get_user_request'),
'getMany': require('./get_users_request'),
'put': require('./put_user_request'),
'post': require('./post_user_request'),
'delete': require('./delete_user_request')
}
};
// additional routes for this module
const USERS_ADDITIONAL_ROUTES = [
{
method: 'post',
path: 'no-auth/register',
requestClass: require('./register_request')
},
{
method: 'post',
path: 'no-auth/nr-register',
requestClass: require('./nr_register_request')
},
{
method: 'post',
path: 'no-auth/confirm',
requestClass: require('./confirm_request')
},
{
method: 'put',
path: 'no-auth/login',
requestClass: require('./login_request')
},
{
method: 'put',
path: 'no-auth/login-by-code',
requestClass: require('./login_by_code_request')
},
{
method: 'post',
path: 'no-auth/generate-login-code',
requestClass: require('./generate_login_code_request')
},
{
method: 'put',
path: 'login',
requestClass: require('./raw_login_request')
},
{
method: 'put',
path: 'read/:streamId',
requestClass: require('./read_request')
},
{
method: 'put',
path: 'unread/:postId',
requestClass: require('./unread_request')
},
{
method: 'get',
path: 'preferences',
requestClass: require('./get_preferences_request')
},
{
method: 'put',
path: 'preferences',
requestClass: require('./put_preferences_request')
},
{
method: 'put',
path: 'grant/:channel',
requestClass: require('./grant_request')
},
{
method: 'put',
path: 'presence',
requestClass: require('./presence_request')
},
{
method: 'get',
path: 'sessions',
requestClass: require('./get_sessions_request')
},
{
method: 'put',
path: 'password',
requestClass: require('./change_password_request')
},
{
method: 'put',
path: 'no-auth/forgot-password',
requestClass: require('./forgot_password_request')
},
{
method: 'get',
path: 'no-auth/check-reset',
requestClass: require('./check_reset_request')
},
{
method: 'put',
path: 'no-auth/check-signup',
requestClass: require('./check_signup_request')
},
{
method: 'get',
path: 'no-auth/invite-info',
requestClass: require('./invite_info_request')
},
{
method: 'put',
path: 'change-email',
requestClass: require('./change_email_request')
},
{
method: 'put',
path: 'bump-posts',
requestClass: require('./bump_posts_request')
},
{
method: 'post',
path: 'no-auth/gitlens-user',
requestClass: require('./gitlens_user_request')
},
{
method: 'put',
path: 'read-item/:id',
requestClass: require('./read_item_request')
},
{
method: 'get',
path: 'no-auth/unsubscribe-weekly',
requestClass: require('./unsubscribe_weekly_email_request')
},
{
method: 'get',
path: 'no-auth/unsubscribe-notification',
requestClass: require('./unsubscribe_notification_email_request')
},
{
method: 'get',
path: 'no-auth/unsubscribe-reminder',
requestClass: require('./unsubscribe_reminder_email_request')
},
{
method: 'get',
path: 'signup-jwt',
requestClass: require('./get_signup_jwt_request')
},
{
method: 'put',
path: 'join-company/:id',
requestClass: require('./join_company_request')
},
{
method: 'put',
path: 'decline-invite/:id',
requestClass: require('./decline_invite_request')
},
// these request will be callable through Service Gateway using a CodeStream-issued
// access token
{
method: 'put',
path: 'cs-auth/join-company/:id',
requestClass: require('./join_company_request')
},
{
method: 'put',
path: 'cs-auth/decline-invite/:id',
requestClass: require('./decline_invite_request')
},
{
method: 'put',
path: 'logout',
requestClass: require('./logout_request')
},
{
method: 'put',
path: 'no-auth/check-login',
requestClass: require('./check_login_request')
},
{
method: 'put',
path: '/web/join-company/:id',
requestClass: require('./web_join_company_request')
},
{
method: 'post',
path: 'msteams/generate-connect-code',
requestClass: require('./generate_msteams_connect_code')
}
];
class Users extends Restful {
constructor (options) {
super(options);
this.errorHandler = new ErrorHandler(Errors);
}
get collectionName () {
return 'users'; // name of the data collection
}
get modelName () {
return 'user'; // name of the data model
}
get creatorClass () {
return UserCreator; // use this class to instantiate users
}
get modelClass () {
return User; // use this class for the data model
}
get modelDescription () {
return 'A single user';
}
get updaterClass () {
return UserUpdater; // use this class to update users
}
get deleterClass () {
return UserDeleter; // user this class to delete users
}
// get all routes exposed by this module
getRoutes () {
let standardRoutes = super.getRoutes(USERS_STANDARD_ROUTES);
return [...standardRoutes, ...USERS_ADDITIONAL_ROUTES];
}
services () {
// return a function that, when invoked, returns a service to handle signup tokens
return async () => {
this.api.log('Initializing signup token service...');
this.signupTokens = new SignupTokens({ api: this.api });
// used to temporarily encrypt passwords before hashing, during the New Relic IDP auth flow
this.passwordEncrypt = new PasswordEncrypt(this.api.config.integrations.newRelicIdentity.passwordKey);
return {
signupTokens: this.signupTokens,
passwordEncrypt: this.passwordEncrypt
};
};
}
getDependencies () {
return DEPENDENCIES;
}
middlewares () {
return async (request, response, next) => {
const now = Date.now();
// read globals, but only once a minute
let globalMaintenanceMode, clientBlackList;
if (!this.lastGlobalRead || this.lastGlobalRead < now - 60 * 1000) {
globalMaintenanceMode = await this.api.data.globals.getOneByQuery(
{ tag: 'inMaintenanceMode' },
{ overrideHintRequired: true }
);
clientBlackList = await this.api.data.globals.getOneByQuery(
{ tag: 'clientBlackList' },
{ overrideHintRequired: true }
);
this.lastGlobalRead = now;
this.cachedGLobalMaintenanceMode = globalMaintenanceMode;
this.cachedClientBlackList = clientBlackList;
} else {
globalMaintenanceMode = this.cachedGlobalMaintenanceMode;
clientBlackList = this.cachedClientBlackList;
}
// determine whether this client's client-generated machine ID is blacklisted,
// and if so, deny this request
const clientMachineId = request.headers['x-cs-client-machine-id'];
if (clientMachineId && clientBlackList && clientBlackList.enabled) {
clientBlackList = clientBlackList.list?.split(',');
if (clientBlackList.includes(clientMachineId)) {
request.abortWith = {
status: 403,
error: this.errorHandler.error('clientBlacklisted')
};
return next();
}
}
// look for override maintenance mode header, to allow for internal testing
const overrideMaintenanceMode = (
request.headers['x-cs-override-maintenance-mode'] === 'xyz123' ||
request.query._overrideMaintenanceMode === 'xyz123' ||
request.path.match(/~nrlogin.*OVMM~1/)
);
// for users in "maintenance mode", set header and return error
if (
!overrideMaintenanceMode &&
(
(globalMaintenanceMode && globalMaintenanceMode.enabled) ||
(request.user && request.user.get('inMaintenanceMode'))
)
) {
response.set('X-CS-API-Maintenance-Mode', 1);
request.abortWith = {
status: 403,
error: this.errorHandler.error('inMaintenanceMode')
};
}
// for users for whom a password set is required, return error unless it is the
// actual call to set their password
else if (
request.user &&
request.user.get('mustSetPassword') &&
(
!(
request.path.toLowerCase() === '/password' &&
request.method.toLowerCase() === 'put'
) &&
!(
request.path.toLowerCase() === '/login' &&
request.method.toLowerCase() === 'put'
) &&
!(
request.path.match(/\/web/i) &&
request.method.toLowerCase() === 'get'
)
)
) {
request.abortWith = {
status: 403,
error: this.errorHandler.error('mustSetPassword')
};
}
// look for a temporary encrypted password older than 10 minutes, and delete
if (
request.user &&
request.user.get('encryptedPasswordTemp')
) {
const [ , , time ] = request.user.get('encryptedPasswordTemp').split('.');
const timestamp = parseInt(time, 10);
if (timestamp < Date.now() - 10 * 60 * 60 * 1000) {
// note: no need to await here
this.api.data.users.updateDirect(
{ _id: this.api.data.users.objectIdSafe(request.user.id) },
{ $unset: { encryptedPasswordTemp: true } }
);
}
}
next();
};
}
async initialize () {
this.signupTokens.initialize();
// set up a reinvite emails
if (process.env.CS_API_MOCK_MODE) {
this.api.log('NOTE: API Server is running in mock mode, auto reinvites can not be performed');
} else {
this.reinviter = new Reinviter({
api: this.api,
module: this
});
this.reinviter.schedule();
}
/*
// schedule weekly email sending
if (process.env.CS_API_MOCK_MODE) {
this.api.log('NOTE: API Server is running in mock mode, weekly emails will not be scheduled');
} else {
this.weeklyEmails = new WeeklyEmails({
api: this.api,
module: this
});
this.weeklyEmails.schedule();
}
*/
this.oneUserPerOrg = true;
this.api.log('NOTE: API Server is running in one-user-per-org mode');
}
describeErrors () {
return {
'Users': Errors
};
}
}
module.exports = Users;