-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
authentication-main.ts
369 lines (316 loc) · 18 KB
/
authentication-main.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
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
// *****************************************************************************
// Copyright (C) 2020 Red Hat, Inc. and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
// code copied and modified from https://github.com/microsoft/vscode/blob/1.47.3/src/vs/workbench/api/browser/mainThreadAuthentication.ts
import { interfaces } from '@theia/core/shared/inversify';
import { AuthenticationExt, AuthenticationMain, MAIN_RPC_CONTEXT } from '../../common/plugin-api-rpc';
import { RPCProtocol } from '../../common/rpc-protocol';
import { MessageService } from '@theia/core/lib/common/message-service';
import { Dialog, StorageService } from '@theia/core/lib/browser';
import {
AuthenticationProvider,
AuthenticationService,
readAllowedExtensions
} from '@theia/core/lib/browser/authentication-service';
import { QuickPickService } from '@theia/core/lib/common/quick-pick-service';
import * as theia from '@theia/plugin';
import { QuickPickValue } from '@theia/core/lib/browser/quick-input/quick-input-service';
import { nls } from '@theia/core/lib/common/nls';
export function getAuthenticationProviderActivationEvent(id: string): string { return `onAuthenticationRequest:${id}`; }
export class AuthenticationMainImpl implements AuthenticationMain {
private readonly proxy: AuthenticationExt;
private readonly messageService: MessageService;
private readonly storageService: StorageService;
private readonly authenticationService: AuthenticationService;
private readonly quickPickService: QuickPickService;
constructor(rpc: RPCProtocol, container: interfaces.Container) {
this.proxy = rpc.getProxy(MAIN_RPC_CONTEXT.AUTHENTICATION_EXT);
this.messageService = container.get(MessageService);
this.storageService = container.get(StorageService);
this.authenticationService = container.get(AuthenticationService);
this.quickPickService = container.get(QuickPickService);
this.authenticationService.onDidChangeSessions(e => {
this.proxy.$onDidChangeAuthenticationSessions({ id: e.providerId, label: e.label });
});
}
async $registerAuthenticationProvider(id: string, label: string, supportsMultipleAccounts: boolean): Promise<void> {
const provider = new AuthenticationProviderImpl(this.proxy, id, label, supportsMultipleAccounts, this.storageService, this.messageService);
this.authenticationService.registerAuthenticationProvider(id, provider);
}
async $unregisterAuthenticationProvider(id: string): Promise<void> {
this.authenticationService.unregisterAuthenticationProvider(id);
}
async $updateSessions(id: string, event: theia.AuthenticationProviderAuthenticationSessionsChangeEvent): Promise<void> {
this.authenticationService.updateSessions(id, event);
}
$logout(providerId: string, sessionId: string): Promise<void> {
return this.authenticationService.logout(providerId, sessionId);
}
protected async requestNewSession(providerId: string, scopes: string[], extensionId: string, extensionName: string): Promise<void> {
return this.authenticationService.requestNewSession(providerId, scopes, extensionId, extensionName);
}
async $getSession(providerId: string, scopes: string[], extensionId: string, extensionName: string,
options: theia.AuthenticationGetSessionOptions): Promise<theia.AuthenticationSession | undefined> {
const sessions = await this.authenticationService.getSessions(providerId, scopes);
// Error cases
if (options.forceNewSession && !sessions.length) {
throw new Error('No existing sessions found.');
}
if (options.forceNewSession && options.createIfNone) {
throw new Error('Invalid combination of options. Please remove one of the following: forceNewSession, createIfNone');
}
if (options.forceNewSession && options.silent) {
throw new Error('Invalid combination of options. Please remove one of the following: forceNewSession, silent');
}
if (options.createIfNone && options.silent) {
throw new Error('Invalid combination of options. Please remove one of the following: createIfNone, silent');
}
const supportsMultipleAccounts = this.authenticationService.supportsMultipleAccounts(providerId);
// Check if the sessions we have are valid
if (!options.forceNewSession && sessions.length) {
if (supportsMultipleAccounts) {
if (options.clearSessionPreference) {
await this.storageService.setData(`authentication-session-${extensionName}-${providerId}`, undefined);
} else {
const existingSessionPreference = await this.storageService.getData(`authentication-session-${extensionName}-${providerId}`);
if (existingSessionPreference) {
const matchingSession = sessions.find(session => session.id === existingSessionPreference);
if (matchingSession && await this.isAccessAllowed(providerId, matchingSession.account.label, extensionId)) {
return matchingSession;
}
}
}
} else if (await this.isAccessAllowed(providerId, sessions[0].account.label, extensionId)) {
return sessions[0];
}
}
// We may need to prompt because we don't have a valid session modal flows
if (options.createIfNone || options.forceNewSession) {
const providerName = this.authenticationService.getLabel(providerId);
const detail = (typeof options.forceNewSession === 'object') ? options.forceNewSession!.detail : undefined;
const isAllowed = await this.loginPrompt(providerName, extensionName, !!options.forceNewSession, detail);
if (!isAllowed) {
throw new Error('User did not consent to login.');
}
const session = sessions?.length && !options.forceNewSession && supportsMultipleAccounts
? await this.selectSession(providerId, providerName, extensionId, extensionName, sessions, scopes, !!options.clearSessionPreference)
: await this.authenticationService.login(providerId, scopes);
await this.setTrustedExtensionAndAccountPreference(providerId, session.account.label, extensionId, extensionName, session.id);
return session;
}
// passive flows (silent or default)
const validSession = sessions.find(s => this.isAccessAllowed(providerId, s.account.label, extensionId));
if (!options.silent && !validSession) {
this.authenticationService.requestNewSession(providerId, scopes, extensionId, extensionName);
}
return validSession;
}
protected async selectSession(providerId: string, providerName: string, extensionId: string, extensionName: string,
potentialSessions: Readonly<theia.AuthenticationSession[]>, scopes: string[], clearSessionPreference: boolean): Promise<theia.AuthenticationSession> {
if (!potentialSessions.length) {
throw new Error('No potential sessions found');
}
return new Promise(async (resolve, reject) => {
const items: QuickPickValue<{ session?: theia.AuthenticationSession }>[] = potentialSessions.map(session => ({
label: session.account.label,
value: { session }
}));
items.push({
label: nls.localizeByDefault('Sign in to another account'),
value: { session: undefined }
});
const selected = await this.quickPickService.show(items,
{
title: nls.localizeByDefault("The extension '{0}' wants to access a {1} account", extensionName, providerName),
ignoreFocusOut: true
});
if (selected) {
const session = selected.value?.session ?? await this.authenticationService.login(providerId, scopes);
const accountName = session.account.label;
const allowList = await readAllowedExtensions(this.storageService, providerId, accountName);
if (!allowList.find(allowed => allowed.id === extensionId)) {
allowList.push({ id: extensionId, name: extensionName });
this.storageService.setData(`authentication-trusted-extensions-${providerId}-${accountName}`, JSON.stringify(allowList));
}
this.storageService.setData(`authentication-session-${extensionName}-${providerId}`, session.id);
resolve(session);
} else {
reject('User did not consent to account access');
}
});
}
protected async getSessionsPrompt(providerId: string, accountName: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean> {
const allowList = await readAllowedExtensions(this.storageService, providerId, accountName);
const extensionData = allowList.find(extension => extension.id === extensionId);
if (extensionData) {
addAccountUsage(this.storageService, providerId, accountName, extensionId, extensionName);
return true;
}
const choice = await this.messageService.info(`The extension '${extensionName}' wants to access the ${providerName} account '${accountName}'.`, 'Allow', 'Cancel');
const allow = choice === 'Allow';
if (allow) {
await addAccountUsage(this.storageService, providerId, accountName, extensionId, extensionName);
allowList.push({ id: extensionId, name: extensionName });
this.storageService.setData(`authentication-trusted-extensions-${providerId}-${accountName}`, JSON.stringify(allowList));
}
return allow;
}
protected async loginPrompt(providerName: string, extensionName: string, recreatingSession: boolean, _detail?: string): Promise<boolean> {
const message = recreatingSession
? nls.localizeByDefault("The extension '{0}' wants you to sign in again using {1}.", extensionName, providerName)
: nls.localizeByDefault("The extension '{0}' wants to sign in using {1}.", extensionName, providerName);
const choice = await this.messageService.info(message, 'Allow', 'Cancel');
return choice === 'Allow';
}
protected async isAccessAllowed(providerId: string, accountName: string, extensionId: string): Promise<boolean> {
const allowList = await readAllowedExtensions(this.storageService, providerId, accountName);
return !!allowList.find(allowed => allowed.id === extensionId);
}
protected async setTrustedExtensionAndAccountPreference(providerId: string, accountName: string, extensionId: string, extensionName: string, sessionId: string): Promise<void> {
const allowList = await readAllowedExtensions(this.storageService, providerId, accountName);
if (!allowList.find(allowed => allowed.id === extensionId)) {
allowList.push({ id: extensionId, name: extensionName });
this.storageService.setData(`authentication-trusted-extensions-${providerId}-${accountName}`, JSON.stringify(allowList));
}
this.storageService.setData(`authentication-session-${extensionName}-${providerId}`, sessionId);
}
$onDidChangeSessions(providerId: string, event: theia.AuthenticationProviderAuthenticationSessionsChangeEvent): void {
this.authenticationService.updateSessions(providerId, event);
}
}
async function addAccountUsage(storageService: StorageService, providerId: string, accountName: string, extensionId: string, extensionName: string): Promise<void> {
const accountKey = `authentication-${providerId}-${accountName}-usages`;
const usages = await readAccountUsages(storageService, providerId, accountName);
const existingUsageIndex = usages.findIndex(usage => usage.extensionId === extensionId);
if (existingUsageIndex > -1) {
usages.splice(existingUsageIndex, 1, {
extensionId,
extensionName,
lastUsed: Date.now()
});
} else {
usages.push({
extensionId,
extensionName,
lastUsed: Date.now()
});
}
await storageService.setData(accountKey, JSON.stringify(usages));
}
interface AccountUsage {
extensionId: string;
extensionName: string;
lastUsed: number;
}
export class AuthenticationProviderImpl implements AuthenticationProvider {
/** map from account name to session ids */
private accounts = new Map<string, string[]>();
/** map from session id to account name */
private sessions = new Map<string, string>();
readonly onDidChangeSessions: theia.Event<theia.AuthenticationProviderAuthenticationSessionsChangeEvent>;
constructor(
private readonly proxy: AuthenticationExt,
public readonly id: string,
public readonly label: string,
public readonly supportsMultipleAccounts: boolean,
private readonly storageService: StorageService,
private readonly messageService: MessageService
) { }
public hasSessions(): boolean {
return !!this.sessions.size;
}
private registerSession(session: theia.AuthenticationSession): void {
this.sessions.set(session.id, session.account.label);
const existingSessionsForAccount = this.accounts.get(session.account.label);
if (existingSessionsForAccount) {
this.accounts.set(session.account.label, existingSessionsForAccount.concat(session.id));
return;
} else {
this.accounts.set(session.account.label, [session.id]);
}
}
async signOut(accountName: string): Promise<void> {
const accountUsages = await readAccountUsages(this.storageService, this.id, accountName);
const sessionsForAccount = this.accounts.get(accountName);
const result = await this.messageService.info(accountUsages.length
? nls.localizeByDefault("The account '{0}' has been used by: \n\n{1}\n\n Sign out from these extensions?", accountName,
accountUsages.map(usage => usage.extensionName).join(', '))
: nls.localizeByDefault("Sign out of '{0}'?", accountName),
nls.localizeByDefault('Sign Out'),
Dialog.CANCEL);
if (result && result === nls.localizeByDefault('Sign Out') && sessionsForAccount) {
sessionsForAccount.forEach(sessionId => this.removeSession(sessionId));
removeAccountUsage(this.storageService, this.id, accountName);
}
}
async getSessions(scopes?: string[]): Promise<ReadonlyArray<theia.AuthenticationSession>> {
return this.proxy.$getSessions(this.id, scopes);
}
async updateSessionItems(event: theia.AuthenticationProviderAuthenticationSessionsChangeEvent): Promise<void> {
const { added, removed } = event;
const session = await this.proxy.$getSessions(this.id);
const addedSessions = added ? session.filter(s => added.some(addedSession => addedSession.id === s.id)) : [];
removed?.forEach(removedSession => {
const sessionId = removedSession.id;
if (sessionId) {
const accountName = this.sessions.get(sessionId);
if (accountName) {
this.sessions.delete(sessionId);
const sessionsForAccount = this.accounts.get(accountName) || [];
const sessionIndex = sessionsForAccount.indexOf(sessionId);
sessionsForAccount.splice(sessionIndex);
if (!sessionsForAccount.length) {
this.accounts.delete(accountName);
}
}
}
});
addedSessions.forEach(s => this.registerSession(s));
}
async login(scopes: string[]): Promise<theia.AuthenticationSession> {
return this.createSession(scopes);
}
async logout(sessionId: string): Promise<void> {
return this.removeSession(sessionId);
}
createSession(scopes: string[]): Thenable<theia.AuthenticationSession> {
return this.proxy.$createSession(this.id, scopes);
}
removeSession(sessionId: string): Thenable<void> {
return this.proxy.$removeSession(this.id, sessionId)
.then(() => { this.messageService.info('Successfully signed out.'); });
}
}
async function readAccountUsages(storageService: StorageService, providerId: string, accountName: string): Promise<AccountUsage[]> {
const accountKey = `authentication-${providerId}-${accountName}-usages`;
const storedUsages: string | undefined = await storageService.getData(accountKey);
let usages: AccountUsage[] = [];
if (storedUsages) {
try {
usages = JSON.parse(storedUsages);
} catch (e) {
console.log(e);
}
}
return usages;
}
function removeAccountUsage(storageService: StorageService, providerId: string, accountName: string): void {
const accountKey = `authentication-${providerId}-${accountName}-usages`;
storageService.setData(accountKey, undefined);
}