/
userTokens.js
257 lines (237 loc) · 8.25 KB
/
userTokens.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
/**
* Copyright (c) 2016, salesforce.com, inc.
* All rights reserved.
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or
* https://opensource.org/licenses/BSD-3-Clause
*/
/**
* api/v1/controllers/userTokens.js
*/
'use strict'; // eslint-disable-line strict
const helper = require('../helpers/nouns/tokens');
const apiErrors = require('../apiErrors');
const cnstnts = require('../constants');
const u = require('../helpers/verbs/utils');
const httpStatus = cnstnts.httpStatus;
const Op = require('sequelize').Op;
/**
* where clause to get user tokens
* @param {String} userNameOrId - User name or id
* @returns {Object} - where clause
*/
function whereClauseForUser(userNameOrId) {
const whr = {};
if (u.looksLikeId(userNameOrId)) {
/*
* need to use '$table.field$' for association fields. User IDs in the url
* are case-sensitve.
*/
whr.where = { '$user.id$': {} };
whr.where['$user.id$'] = userNameOrId;
} else {
whr.where = { '$user.name$': {} };
whr.where['$user.name$'][Op.iLike] = userNameOrId;
}
return whr;
} // whereClauseForUser
/**
* where clause to get a token for a user
* @param {String} user - User name or id
* @param {Str} tokenName - Token name
* @returns {Object} - where clause
*/
function whereClauseForUserAndTokenName(user, tokenName) {
const whr = whereClauseForUser(user);
whr.where.name = {};
whr.where.name[Op.iLike] = tokenName;
return whr;
} // whereClauseForUserAndTokenName
module.exports = {
/**
* DELETE /users/{key}/tokens/{tokenName}
*
* Deletes the token metadata record and sends it back in the response. Only
* permitted for an admin user or the owner of the token being deleted.
*
* @param {IncomingMessage} req - The request object
* @param {ServerResponse} res - The response object
* @param {Function} next - The next middleware function in the stack
*/
deleteUserToken(req, res, next) {
const resultObj = { reqStartTime: req.timestamp };
const user = req.swagger.params.key.value;
const tokenName = req.swagger.params.tokenName.value;
const whr = whereClauseForUserAndTokenName(user, tokenName);
let deletedToken;
// get user token
helper.model.findOne(whr)
.then((token) => {
if (!token) { // if no token found, return error
const err = new apiErrors.ResourceNotFoundError();
err.resource = helper.model.name;
err.key = user + ', ' + tokenName;
throw err;
}
deletedToken = token;
if (token.name === token.user.name) { // Default token cannot be deleted!
throw new apiErrors.ForbiddenError({
explanation: 'Insufficient Privileges',
});
}
/*
* Ok to destroy the token if the request is made by an admin user or
* if an non admin user wants to revoke their own token.
*/
if (req.headers.IsAdmin || token.createdBy === req.user.id) {
return token.destroy();
}
// else forbidden
throw new apiErrors.ForbiddenError({
explanation: 'Insufficient Privileges',
});
})
.then((o) => {
resultObj.dbTime = new Date() - resultObj.reqStartTime;
if (o) { // object deleted successfully
u.logAPI(req, resultObj, deletedToken.dataValues);
const retval = u.responsify(deletedToken, helper, req.method);
res.status(httpStatus.OK).json(retval);
} else if (o instanceof Error) {
throw o; // forbidden err
}
})
.catch((err) => u.handleError(next, err, helper.modelName));
},
/**
* GET /users/{key}/tokens/{tokenName}
*
* Retrieves the token metadata record and sends it back in the response.
*
* @param {IncomingMessage} req - The request object
* @param {ServerResponse} res - The response object
* @param {Function} next - The next middleware function in the stack
*/
getUserToken(req, res, next) {
const resultObj = { reqStartTime: req.timestamp };
const user = req.swagger.params.key.value;
const tokenName = req.swagger.params.tokenName.value;
const whr = whereClauseForUserAndTokenName(user, tokenName);
helper.model.findOne(whr)
.then((o) => {
resultObj.dbTime = new Date() - resultObj.reqStartTime;
if (!o) {
const err = new apiErrors.ResourceNotFoundError();
err.resource = helper.model.name;
err.key = user + ', ' + tokenName;
throw err;
}
u.logAPI(req, resultObj, o.dataValues);
res.status(httpStatus.OK).json(u.responsify(o, helper, req.method));
})
.catch((err) => u.handleError(next, err, helper.modelName));
},
/**
* GET /users/{key}/tokens
*
* Gets zero or more tokens for the specified user and sends them back in the
* response.
*
* @param {IncomingMessage} req - The request object
* @param {ServerResponse} res - The response object
* @param {Function} next - The next middleware function in the stack
*/
getUserTokens(req, res, next) {
const resultObj = { reqStartTime: req.timestamp };
const user = req.swagger.params.key.value;
const whr = whereClauseForUser(user);
helper.model.findAll(whr)
.then((o) => {
resultObj.dbTime = new Date() - resultObj.reqStartTime;
res.set(cnstnts.COUNT_HEADER_NAME, o.length);
const retval = o.map((row) => u.responsify(row, helper, req.method));
u.logAPI(req, resultObj, retval);
res.status(httpStatus.OK).json(retval);
})
.catch((err) => u.handleError(next, err, helper.modelName));
},
/**
* POST /users/{key}tokens/{tokenName}/restore
*
* Restore access for the specified token if access had previously been
* revoked. Only permitted for an admin user.
*
* @param {IncomingMessage} req - The request object
* @param {ServerResponse} res - The response object
* @param {Function} next - The next middleware function in the stack
*/
restoreTokenByName(req, res, next) {
const resultObj = { reqStartTime: req.timestamp };
if (req.headers.IsAdmin) {
const user = req.swagger.params.key.value;
const tokenName = req.swagger.params.tokenName.value;
const whr = whereClauseForUserAndTokenName(user, tokenName);
helper.model.findOne(whr)
.then((o) => {
if (!o) {
const err = new apiErrors.ResourceNotFoundError();
err.resource = helper.model.name;
err.key = user + ', ' + tokenName;
throw err;
}
if (o.isRevoked === '0') {
throw new apiErrors.InvalidTokenActionError();
}
return o.restore();
})
.then((o) => {
resultObj.dbTime = new Date() - resultObj.reqStartTime;
const retval = u.responsify(o, helper, req.method);
res.status(httpStatus.OK).json(retval);
u.logAPI(req, resultObj, retval);
})
.catch((err) => u.handleError(next, err, helper.modelName));
} else {
u.forbidden(next);
}
},
/**
* POST /users/{key}tokens/{tokenName}/revoke
*
* Revoke access for the specified token. Only permitted for an admin user.
*
* @param {IncomingMessage} req - The request object
* @param {ServerResponse} res - The response object
* @param {Function} next - The next middleware function in the stack
*/
revokeTokenByName(req, res, next) {
const resultObj = { reqStartTime: req.timestamp };
if (req.headers.IsAdmin) {
const user = req.swagger.params.key.value;
const tokenName = req.swagger.params.tokenName.value;
const whr = whereClauseForUserAndTokenName(user, tokenName);
helper.model.findOne(whr)
.then((o) => {
if (!o) {
const err = new apiErrors.ResourceNotFoundError();
err.resource = helper.model.name;
err.key = user + ', ' + tokenName;
throw err;
}
if (o.isRevoked > '0') {
throw new apiErrors.InvalidTokenActionError();
}
return o.revoke();
})
.then((o) => {
resultObj.dbTime = new Date() - resultObj.reqStartTime;
const retval = u.responsify(o, helper, req.method);
u.logAPI(req, resultObj, retval);
res.status(httpStatus.OK).json(retval);
})
.catch((err) => u.handleError(next, err, helper.modelName));
} else {
u.forbidden(next);
}
},
}; // exports