-
Notifications
You must be signed in to change notification settings - Fork 606
/
oauth2-password-grant.js
388 lines (340 loc) · 13.1 KB
/
oauth2-password-grant.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
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
import Ember from 'ember';
import BaseAuthenticator from './base';
import fetch from 'fetch';
const {
RSVP,
isEmpty,
run,
computed,
makeArray,
assign: emberAssign,
merge,
A,
testing,
warn,
keys: emberKeys
} = Ember;
const assign = emberAssign || merge;
const keys = Object.keys || emberKeys; // Ember.keys deprecated in 1.13
/**
Authenticator that conforms to OAuth 2
([RFC 6749](http://tools.ietf.org/html/rfc6749)), specifically the _"Resource
Owner Password Credentials Grant Type"_.
This authenticator also automatically refreshes access tokens (see
[RFC 6749, section 6](http://tools.ietf.org/html/rfc6749#section-6)) if the
server supports it.
@class OAuth2PasswordGrantAuthenticator
@module ember-simple-auth/authenticators/oauth2-password-grant
@extends BaseAuthenticator
@public
*/
export default BaseAuthenticator.extend({
/**
Triggered when the authenticator refreshed the access token (see
[RFC 6749, section 6](http://tools.ietf.org/html/rfc6749#section-6)).
@event sessionDataUpdated
@param {Object} data The updated session data
@public
*/
/**
The client_id to be sent to the authentication server (see
https://tools.ietf.org/html/rfc6749#appendix-A.1). __This should only be
used for statistics or logging etc. as it cannot actually be trusted since
it could have been manipulated on the client!__
@property clientId
@type String
@default null
@public
*/
clientId: null,
/**
The endpoint on the server that authentication and token refresh requests
are sent to.
@property serverTokenEndpoint
@type String
@default '/token'
@public
*/
serverTokenEndpoint: '/token',
/**
The endpoint on the server that token revocation requests are sent to. Only
set this if the server actually supports token revocation. If this is
`null`, the authenticator will not revoke tokens on session invalidation.
__If token revocation is enabled but fails, session invalidation will be
intercepted and the session will remain authenticated (see
{{#crossLink "OAuth2PasswordGrantAuthenticator/invalidate:method"}}{{/crossLink}}).__
@property serverTokenRevocationEndpoint
@type String
@default null
@public
*/
serverTokenRevocationEndpoint: null,
/**
Sets whether the authenticator automatically refreshes access tokens if the
server supports it.
@property refreshAccessTokens
@type Boolean
@default true
@public
*/
refreshAccessTokens: true,
/**
The offset time in milliseconds to refresh the access token. This must
return a random number. This randomization is needed because in case of
multiple tabs, we need to prevent the tabs from sending refresh token
request at the same exact moment.
__When overriding this property, make sure to mark the overridden property
as volatile so it will actually have a different value each time it is
accessed.__
@property refreshAccessTokens
@type Integer
@default a random number between 5 and 10
@public
*/
tokenRefreshOffset: computed(function() {
const min = 5;
const max = 10;
return (Math.floor(Math.random() * (max - min)) + min) * 1000;
}).volatile(),
_refreshTokenTimeout: null,
_clientIdHeader: computed('clientId', function() {
const clientId = this.get('clientId');
if (!isEmpty(clientId)) {
const base64ClientId = window.btoa(clientId.concat(':'));
return { Authorization: `Basic ${base64ClientId}` };
}
}),
/**
When authentication fails, the rejection callback is provided with the whole
Fetch API [Response](https://fetch.spec.whatwg.org/#response-class) object
instead of its responseJSON or responseText.
This is useful for cases when the backend provides additional context not
available in the response body.
@property rejectWithXhr
@type Boolean
@default false
@deprecated OAuth2PasswordGrantAuthenticator/rejectWithResponse:property
@public
*/
rejectWithXhr: computed.deprecatingAlias('rejectWithResponse', {
id: `ember-simple-auth.authenticator.reject-with-xhr`,
until: '2.0.0'
}),
/**
When authentication fails, the rejection callback is provided with the whole
Fetch API [Response](https://fetch.spec.whatwg.org/#response-class) object
instead of its responseJSON or responseText.
This is useful for cases when the backend provides additional context not
available in the response body.
@property rejectWithResponse
@type Boolean
@default false
@public
*/
rejectWithResponse: false,
/**
Restores the session from a session data object; __will return a resolving
promise when there is a non-empty `access_token` in the session data__ and
a rejecting promise otherwise.
If the server issues
[expiring access tokens](https://tools.ietf.org/html/rfc6749#section-5.1)
and there is an expired access token in the session data along with a
refresh token, the authenticator will try to refresh the access token and
return a promise that resolves with the new access token if the refresh was
successful. If there is no refresh token or the token refresh is not
successful, a rejecting promise will be returned.
@method restore
@param {Object} data The data to restore the session from
@return {Ember.RSVP.Promise} A promise that when it resolves results in the session becoming or remaining authenticated
@public
*/
restore(data) {
return new RSVP.Promise((resolve, reject) => {
const now = (new Date()).getTime();
const refreshAccessTokens = this.get('refreshAccessTokens');
if (!isEmpty(data['expires_at']) && data['expires_at'] < now) {
if (refreshAccessTokens) {
this._refreshAccessToken(data['expires_in'], data['refresh_token']).then(resolve, reject);
} else {
reject();
}
} else {
if (!this._validate(data)) {
reject();
} else {
this._scheduleAccessTokenRefresh(data['expires_in'], data['expires_at'], data['refresh_token']);
resolve(data);
}
}
});
},
/**
Authenticates the session with the specified `identification`, `password`
and optional `scope`; issues a `POST` request to the
{{#crossLink "OAuth2PasswordGrantAuthenticator/serverTokenEndpoint:property"}}{{/crossLink}}
and receives the access token in response (see
http://tools.ietf.org/html/rfc6749#section-4.3).
__If the credentials are valid (and the optionally requested scope is
granted) and thus authentication succeeds, a promise that resolves with the
server's response is returned__, otherwise a promise that rejects with the
error as returned by the server is returned.
__If the
[server supports it](https://tools.ietf.org/html/rfc6749#section-5.1), this
method also schedules refresh requests for the access token before it
expires.__
@method authenticate
@param {String} identification The resource owner username
@param {String} password The resource owner password
@param {String|Array} scope The scope of the access request (see [RFC 6749, section 3.3](http://tools.ietf.org/html/rfc6749#section-3.3))
@param {Object} headers Optional headers that particular backends may require (for example sending 2FA challenge responses)
@return {Ember.RSVP.Promise} A promise that when it resolves results in the session becoming authenticated
@public
*/
authenticate(identification, password, scope = [], headers = {}) {
return new RSVP.Promise((resolve, reject) => {
const data = { 'grant_type': 'password', username: identification, password };
const serverTokenEndpoint = this.get('serverTokenEndpoint');
const useResponse = this.get('rejectWithResponse');
const scopesString = makeArray(scope).join(' ');
if (!isEmpty(scopesString)) {
data.scope = scopesString;
}
this.makeRequest(serverTokenEndpoint, data, headers).then((response) => {
run(() => {
if (!this._validate(response)) {
reject('access_token is missing in server response');
}
const expiresAt = this._absolutizeExpirationTime(response['expires_in']);
this._scheduleAccessTokenRefresh(response['expires_in'], expiresAt, response['refresh_token']);
if (!isEmpty(expiresAt)) {
response = assign(response, { 'expires_at': expiresAt });
}
resolve(response);
});
}, (response) => {
run(null, reject, useResponse ? response : response.responseJSON);
});
});
},
/**
If token revocation is enabled, this will revoke the access token (and the
refresh token if present). If token revocation succeeds, this method
returns a resolving promise, otherwise it will return a rejecting promise,
thus intercepting session invalidation.
If token revocation is not enabled this method simply returns a resolving
promise.
@method invalidate
@param {Object} data The current authenticated session data
@return {Ember.RSVP.Promise} A promise that when it resolves results in the session being invalidated
@public
*/
invalidate(data) {
const serverTokenRevocationEndpoint = this.get('serverTokenRevocationEndpoint');
function success(resolve) {
run.cancel(this._refreshTokenTimeout);
delete this._refreshTokenTimeout;
resolve();
}
return new RSVP.Promise((resolve) => {
if (isEmpty(serverTokenRevocationEndpoint)) {
success.apply(this, [resolve]);
} else {
const requests = [];
A(['access_token', 'refresh_token']).forEach((tokenType) => {
const token = data[tokenType];
if (!isEmpty(token)) {
requests.push(this.makeRequest(serverTokenRevocationEndpoint, {
'token_type_hint': tokenType, token
}));
}
});
const succeed = () => {
success.apply(this, [resolve]);
};
RSVP.all(requests).then(succeed, succeed);
}
});
},
/**
Makes a request to the OAuth 2.0 server.
@method makeRequest
@param {String} url The request URL
@param {Object} data The request data
@param {Object} headers Additional headers to send in request
@return {Promise} A promise that resolves with the response object
@protected
*/
makeRequest(url, data, headers = {}) {
headers['Content-Type'] = 'application/x-www-form-urlencoded';
const body = keys(data).map((key) => {
return `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`;
}).join('&');
const options = {
body,
headers,
method: 'POST'
};
const clientIdHeader = this.get('_clientIdHeader');
if (!isEmpty(clientIdHeader)) {
merge(options.headers, clientIdHeader);
}
return new RSVP.Promise((resolve, reject) => {
fetch(url, options).then((response) => {
response.text().then((text) => {
let json = text ? JSON.parse(text) : {};
if (!response.ok) {
response.responseJSON = json;
reject(response);
} else {
resolve(json);
}
});
}).catch(reject);
});
},
_scheduleAccessTokenRefresh(expiresIn, expiresAt, refreshToken) {
const refreshAccessTokens = this.get('refreshAccessTokens');
if (refreshAccessTokens) {
const now = (new Date()).getTime();
if (isEmpty(expiresAt) && !isEmpty(expiresIn)) {
expiresAt = new Date(now + expiresIn * 1000).getTime();
}
const offset = this.get('tokenRefreshOffset');
if (!isEmpty(refreshToken) && !isEmpty(expiresAt) && expiresAt > now - offset) {
run.cancel(this._refreshTokenTimeout);
delete this._refreshTokenTimeout;
if (!testing) {
this._refreshTokenTimeout = run.later(this, this._refreshAccessToken, expiresIn, refreshToken, expiresAt - now - offset);
}
}
}
},
_refreshAccessToken(expiresIn, refreshToken) {
const data = { 'grant_type': 'refresh_token', 'refresh_token': refreshToken };
const serverTokenEndpoint = this.get('serverTokenEndpoint');
return new RSVP.Promise((resolve, reject) => {
this.makeRequest(serverTokenEndpoint, data).then((response) => {
run(() => {
expiresIn = response['expires_in'] || expiresIn;
refreshToken = response['refresh_token'] || refreshToken;
const expiresAt = this._absolutizeExpirationTime(expiresIn);
const data = assign(response, { 'expires_in': expiresIn, 'expires_at': expiresAt, 'refresh_token': refreshToken });
this._scheduleAccessTokenRefresh(expiresIn, null, refreshToken);
this.trigger('sessionDataUpdated', data);
resolve(data);
});
}, (response) => {
warn(`Access token could not be refreshed - server responded with ${response.responseJSON}.`, false, { id: 'ember-simple-auth.failedOAuth2TokenRefresh' });
reject();
});
});
},
_absolutizeExpirationTime(expiresIn) {
if (!isEmpty(expiresIn)) {
return new Date((new Date().getTime()) + expiresIn * 1000).getTime();
}
},
_validate(data) {
return !isEmpty(data['access_token']);
}
});