-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
websession.ts
248 lines (206 loc) · 6.44 KB
/
websession.ts
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
/*
Copyright 2019 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import Logger from 'shared/libs/logger';
import cfg from 'teleport/config';
import history from 'teleport/services/history';
import api from 'teleport/services/api';
import localStorage, { KeysEnum } from 'teleport/services/localStorage';
import makeBearerToken from './makeBearerToken';
import { RenewSessionRequest } from './types';
// Time to determine when to renew session which is
// when expiry time of token is less than 3 minutes.
const RENEW_TOKEN_TIME = 180 * 1000;
const TOKEN_CHECKER_INTERVAL = 15 * 1000; // every 15 sec
const logger = Logger.create('services/session');
let sesstionCheckerTimerId = null;
const session = {
logout(rememberLocation = false) {
api.delete(cfg.api.webSessionPath).finally(() => {
history.goToLogin(rememberLocation);
});
this.clear();
},
clear() {
this._stopTokenChecker();
localStorage.unsubscribe(receiveMessage);
localStorage.clear();
},
// ensureSession verifies that token is valid and starts
// periodically checking and refreshing the token.
ensureSession() {
this._stopTokenChecker();
this._ensureLocalStorageSubscription();
if (!this.isValid()) {
this.logout();
return;
}
if (this._shouldRenewToken()) {
this._renewToken()
.then(() => {
this._startTokenChecker();
})
.catch(this.logout.bind(this));
} else {
this._startTokenChecker();
}
},
// renewSession renews session and returns the
// absolute time the new session expires.
renewSession(req: RenewSessionRequest): Promise<Date> {
return this._renewToken(req).then(token => token.sessionExpires);
},
/**
* isValid first extracts bearer token from HTML if
* not already extracted and sets in the local storage.
* Then checks if token is not expired.
*/
isValid() {
return this._timeLeft() > 0;
},
getInactivityTimeout() {
const bearerToken = this._getBearerToken();
const time = Number(bearerToken.sessionInactiveTimeout);
return time ? time : 0;
},
_getBearerToken() {
let token = null;
try {
token = this._extractBearerTokenFromHtml();
if (token) {
localStorage.setBearerToken(token);
} else {
token = localStorage.getBearerToken();
}
} catch (err) {
logger.error('Cannot find bearer token', err);
}
return token;
},
_extractBearerTokenFromHtml() {
const el = document.querySelector<HTMLMetaElement>(
'[name=grv_bearer_token]'
);
if (!el || !el.content) {
return null;
}
// remove token from HTML as it will be renewed with a time
// and stored in the localStorage
el.parentNode.removeChild(el);
const decoded = window.atob(el.content);
const json = JSON.parse(decoded);
return makeBearerToken(json);
},
_shouldRenewToken() {
if (this._getIsRenewing()) {
return false;
}
// Renew session if token expiry time is less than 3 minutes.
// Browsers have js timer throttling behavior in inactive tabs that can go
// up to 100s between timer calls from testing. 3 minutes seems to be a safe number
// with extra padding.
return this._timeLeft() < RENEW_TOKEN_TIME;
},
_renewToken(req: RenewSessionRequest = {}) {
this._setAndBroadcastIsRenewing(true);
return api
.post(cfg.getRenewTokenUrl(), req)
.then(json => {
const token = makeBearerToken(json);
localStorage.setBearerToken(token);
return token;
})
.finally(() => {
this._setAndBroadcastIsRenewing(false);
});
},
_setAndBroadcastIsRenewing(value) {
this._setIsRenewing(value);
localStorage.broadcast(KeysEnum.TOKEN_RENEW, value);
},
_setIsRenewing(value) {
this._isRenewing = value;
},
_getIsRenewing() {
return !!this._isRenewing;
},
_timeLeft() {
const token = this._getBearerToken();
if (!token) {
return 0;
}
let { expiresIn, created } = token;
if (!created || !expiresIn) {
return 0;
}
expiresIn = expiresIn * 1000;
const delta = created + expiresIn - new Date().getTime();
return delta;
},
_shouldCheckStatus() {
if (this._getIsRenewing()) {
return false;
}
/*
* double the threshold value for slow connections to avoid
* access-denied response due to concurrent renew token request
* made from other tab
*/
return this._timeLeft() > TOKEN_CHECKER_INTERVAL * 2;
},
// subsribes to localStorage changes (triggered from other browser tabs)
_ensureLocalStorageSubscription() {
localStorage.subscribe(receiveMessage);
},
_fetchStatus() {
this.validateCookieAndSession().catch(err => {
// this indicates that session is no longer valid (caused by server restarts or updates)
if (err.response.status == 403) {
this.logout();
}
});
},
/**
* validateCookieAndSessionFromBackend makes an authenticated request
* which checks if the cookie and the user session are still valid.
*/
validateCookieAndSession() {
return api.get(cfg.api.userStatusPath);
},
_startTokenChecker() {
this._stopTokenChecker();
sesstionCheckerTimerId = setInterval(() => {
// calling ensureSession() will again invoke _startTokenChecker
this.ensureSession();
// handle server restarts when session may become invalid
if (this._shouldCheckStatus()) {
this._fetchStatus();
}
}, TOKEN_CHECKER_INTERVAL);
},
_stopTokenChecker() {
clearInterval(sesstionCheckerTimerId);
sesstionCheckerTimerId = null;
},
};
function receiveMessage(event) {
const { key, newValue } = event;
// check if logout was triggered from other tabs
if (localStorage.getBearerToken() === null) {
session.logout();
}
// check if token is being renewed from another tab
if (key === KeysEnum.TOKEN_RENEW && !!newValue) {
session._setIsRenewing(JSON.parse(newValue));
}
}
export default session;