Expose authentication providers array

This commit is contained in:
Rachel Macfarlane 2020-01-22 11:37:06 -08:00
parent b76893899d
commit c1eacb4e56
5 changed files with 110 additions and 48 deletions

View file

@ -50,13 +50,7 @@ declare module 'vscode' {
export const onDidRegisterAuthenticationProvider: Event<string>; export const onDidRegisterAuthenticationProvider: Event<string>;
export const onDidUnregisterAuthenticationProvider: Event<string>; export const onDidUnregisterAuthenticationProvider: Event<string>;
/** export const providers: ReadonlyArray<AuthenticationProvider>;
* Fires with the provider id that changed sessions.
*/
export const onDidChangeSessions: Event<string>;
export function login(providerId: string): Promise<Session>;
export function logout(providerId: string, accountId: string): Promise<void>;
export function getSessions(providerId: string): Promise<ReadonlyArray<Session>>;
} }
//#endregion //#endregion

View file

@ -5,9 +5,13 @@
import { Disposable } from 'vs/base/common/lifecycle'; import { Disposable } from 'vs/base/common/lifecycle';
import * as modes from 'vs/editor/common/modes'; import * as modes from 'vs/editor/common/modes';
import * as nls from 'vs/nls';
import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers'; import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers';
import { IAuthenticationService } from 'vs/workbench/services/authentication/browser/authenticationService'; import { IAuthenticationService } from 'vs/workbench/services/authentication/browser/authenticationService';
import { ExtHostAuthenticationShape, ExtHostContext, IExtHostContext, MainContext, MainThreadAuthenticationShape } from '../common/extHost.protocol'; import { ExtHostAuthenticationShape, ExtHostContext, IExtHostContext, MainContext, MainThreadAuthenticationShape } from '../common/extHost.protocol';
import { IDialogService } from 'vs/platform/dialogs/common/dialogs';
import { IStorageService, StorageScope } from 'vs/platform/storage/common/storage';
import Severity from 'vs/base/common/severity';
export class MainThreadAuthenticationProvider { export class MainThreadAuthenticationProvider {
constructor( constructor(
@ -35,6 +39,8 @@ export class MainThreadAuthentication extends Disposable implements MainThreadAu
constructor( constructor(
extHostContext: IExtHostContext, extHostContext: IExtHostContext,
@IAuthenticationService private readonly authenticationService: IAuthenticationService, @IAuthenticationService private readonly authenticationService: IAuthenticationService,
@IDialogService private readonly dialogService: IDialogService,
@IStorageService private readonly storageService: IStorageService
) { ) {
super(); super();
this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostAuthentication); this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostAuthentication);
@ -49,7 +55,55 @@ export class MainThreadAuthentication extends Disposable implements MainThreadAu
this.authenticationService.unregisterAuthenticationProvider(id); this.authenticationService.unregisterAuthenticationProvider(id);
} }
$onDidChangeSessions(id: string) { $onDidChangeSessions(id: string): void {
this.authenticationService.sessionsUpdate(id); this.authenticationService.sessionsUpdate(id);
} }
async $getSessionsPrompt(providerId: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean> {
const alwaysAllow = this.storageService.get(`${extensionId}-${providerId}`, StorageScope.GLOBAL);
if (alwaysAllow) {
return true;
}
const { choice } = await this.dialogService.show(
Severity.Info,
nls.localize('confirmAuthenticationAccess', "The extension '{0}' is trying to access authentication information from {1}.", extensionName, providerName),
[nls.localize('cancel', "Cancel"), nls.localize('allow', "Allow"), nls.localize('alwaysAllow', "Always Allow"),],
{ cancelId: 0 }
);
switch (choice) {
case 1/** Allow */:
return true;
case 2 /** Always Allow */:
this.storageService.store(`${extensionId}-${providerId}`, 'true', StorageScope.GLOBAL);
return true;
default:
return false;
}
}
async $loginPrompt(providerId: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean> {
const alwaysAllow = this.storageService.get(`${extensionId}-${providerId}`, StorageScope.GLOBAL);
if (alwaysAllow) {
return true;
}
const { choice } = await this.dialogService.show(
Severity.Info,
nls.localize('confirmLogin', "The extension '{0}' wants to sign in using {1}.", extensionName, providerName),
[nls.localize('cancel', "Cancel"), nls.localize('continue', "Continue"), nls.localize('neverAgain', "Don't Show Again")],
{ cancelId: 0 }
);
switch (choice) {
case 1/** Allow */:
return true;
case 2 /** Always Allow */:
this.storageService.store(`${extensionId}-${providerId}`, 'true', StorageScope.GLOBAL);
return true;
default:
return false;
}
}
} }

View file

@ -183,17 +183,8 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
registerAuthenticationProvider(provider: vscode.AuthenticationProvider): vscode.Disposable { registerAuthenticationProvider(provider: vscode.AuthenticationProvider): vscode.Disposable {
return extHostAuthentication.registerAuthenticationProvider(provider); return extHostAuthentication.registerAuthenticationProvider(provider);
}, },
login(providerId: string): Promise<vscode.Session> { get providers() {
return extHostAuthentication.$login(providerId); return extHostAuthentication.providers(extension);
},
logout(providerId: string, accountId: string): Promise<void> {
return extHostAuthentication.$logout(providerId, accountId);
},
getSessions(providerId: string): Promise<ReadonlyArray<vscode.Session>> {
return extHostAuthentication.$getSessions(providerId);
},
get onDidChangeSessions() {
return extHostAuthentication.onDidChangeSessions;
}, },
get onDidRegisterAuthenticationProvider() { get onDidRegisterAuthenticationProvider() {
return extHostAuthentication.onDidRegisterAuthenticationProvider; return extHostAuthentication.onDidRegisterAuthenticationProvider;

View file

@ -151,6 +151,8 @@ export interface MainThreadAuthenticationShape extends IDisposable {
$registerAuthenticationProvider(id: string): void; $registerAuthenticationProvider(id: string): void;
$unregisterAuthenticationProvider(id: string): void; $unregisterAuthenticationProvider(id: string): void;
$onDidChangeSessions(id: string): void; $onDidChangeSessions(id: string): void;
$getSessionsPrompt(providerId: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean>;
$loginPrompt(providerId: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean>;
} }
export interface MainThreadConfigurationShape extends IDisposable { export interface MainThreadConfigurationShape extends IDisposable {

View file

@ -7,69 +7,90 @@ import * as vscode from 'vscode';
import * as modes from 'vs/editor/common/modes'; import * as modes from 'vs/editor/common/modes';
import { Emitter, Event } from 'vs/base/common/event'; import { Emitter, Event } from 'vs/base/common/event';
import { IMainContext, MainContext, MainThreadAuthenticationShape, ExtHostAuthenticationShape } from 'vs/workbench/api/common/extHost.protocol'; import { IMainContext, MainContext, MainThreadAuthenticationShape, ExtHostAuthenticationShape } from 'vs/workbench/api/common/extHost.protocol';
import { IDisposable } from 'vs/base/common/lifecycle'; import { Disposable } from 'vs/workbench/api/common/extHostTypes';
import { IExtensionDescription, ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
const _onDidUnregisterAuthenticationProvider = new Emitter<string>(); export class AuthenticationProviderWrapper implements vscode.AuthenticationProvider {
const _onDidChangeSessions = new Emitter<string>(); onDidChangeSessions: Event<void>;
export class ExtHostAuthenticationProvider implements IDisposable { constructor(private _requestingExtension: IExtensionDescription,
constructor(private _provider: vscode.AuthenticationProvider, private _provider: vscode.AuthenticationProvider,
private _id: string,
private _proxy: MainThreadAuthenticationShape) { private _proxy: MainThreadAuthenticationShape) {
this._provider.onDidChangeSessions(x => {
this._proxy.$onDidChangeSessions(this._id); this.onDidChangeSessions = this._provider.onDidChangeSessions;
_onDidChangeSessions.fire(this._id);
});
} }
getSessions(): Promise<ReadonlyArray<vscode.Session>> { get id(): string {
return this._provider.id;
}
get displayName(): string {
return this._provider.displayName;
}
async getSessions(): Promise<ReadonlyArray<vscode.Session>> {
const isAllowed = await this._proxy.$getSessionsPrompt(this._provider.id, this.displayName, ExtensionIdentifier.toKey(this._requestingExtension.identifier), this._requestingExtension.displayName || this._requestingExtension.name);
if (!isAllowed) {
throw new Error('User did not consent to session access.');
}
return this._provider.getSessions(); return this._provider.getSessions();
} }
login(): Promise<vscode.Session> { async login(): Promise<vscode.Session> {
const isAllowed = await this._proxy.$loginPrompt(this._provider.id, this.displayName, ExtensionIdentifier.toKey(this._requestingExtension.identifier), this._requestingExtension.displayName || this._requestingExtension.name);
if (!isAllowed) {
throw new Error('User did not consent to login.');
}
return this._provider.login(); return this._provider.login();
} }
logout(sessionId: string): Promise<void> { logout(sessionId: string): Promise<void> {
return this._provider.logout(sessionId); return this._provider.logout(sessionId);
} }
dispose(): void {
this._proxy.$unregisterAuthenticationProvider(this._id);
_onDidUnregisterAuthenticationProvider.fire(this._id);
}
} }
export class ExtHostAuthentication implements ExtHostAuthenticationShape { export class ExtHostAuthentication implements ExtHostAuthenticationShape {
private _proxy: MainThreadAuthenticationShape; private _proxy: MainThreadAuthenticationShape;
private _authenticationProviders: Map<string, ExtHostAuthenticationProvider> = new Map<string, ExtHostAuthenticationProvider>(); private _authenticationProviders: Map<string, vscode.AuthenticationProvider> = new Map<string, vscode.AuthenticationProvider>();
private _onDidRegisterAuthenticationProvider = new Emitter<string>(); private _onDidRegisterAuthenticationProvider = new Emitter<string>();
readonly onDidRegisterAuthenticationProvider: Event<string> = this._onDidRegisterAuthenticationProvider.event; readonly onDidRegisterAuthenticationProvider: Event<string> = this._onDidRegisterAuthenticationProvider.event;
readonly onDidUnregisterAuthenticationProvider: Event<string> = _onDidUnregisterAuthenticationProvider.event; private _onDidUnregisterAuthenticationProvider = new Emitter<string>();
readonly onDidUnregisterAuthenticationProvider: Event<string> = this._onDidUnregisterAuthenticationProvider.event;
readonly onDidChangeSessions: Event<string> = _onDidChangeSessions.event;
constructor(mainContext: IMainContext) { constructor(mainContext: IMainContext) {
this._proxy = mainContext.getProxy(MainContext.MainThreadAuthentication); this._proxy = mainContext.getProxy(MainContext.MainThreadAuthentication);
this.onDidUnregisterAuthenticationProvider(providerId => {
this._authenticationProviders.delete(providerId);
});
} }
registerAuthenticationProvider(provider: vscode.AuthenticationProvider) { providers(requestingExtension: IExtensionDescription): vscode.AuthenticationProvider[] {
let providers: vscode.AuthenticationProvider[] = [];
this._authenticationProviders.forEach(provider => providers.push(new AuthenticationProviderWrapper(requestingExtension, provider, this._proxy)));
return providers;
}
registerAuthenticationProvider(provider: vscode.AuthenticationProvider): vscode.Disposable {
if (this._authenticationProviders.get(provider.id)) { if (this._authenticationProviders.get(provider.id)) {
throw new Error(`An authentication provider with id '${provider.id}' is already registered.`); throw new Error(`An authentication provider with id '${provider.id}' is already registered.`);
} }
const authenticationProvider = new ExtHostAuthenticationProvider(provider, provider.id, this._proxy); this._authenticationProviders.set(provider.id, provider);
this._authenticationProviders.set(provider.id, authenticationProvider);
const listener = provider.onDidChangeSessions(_ => {
this._proxy.$onDidChangeSessions(provider.id);
});
this._proxy.$registerAuthenticationProvider(provider.id); this._proxy.$registerAuthenticationProvider(provider.id);
this._onDidRegisterAuthenticationProvider.fire(provider.id); this._onDidRegisterAuthenticationProvider.fire(provider.id);
return authenticationProvider;
return new Disposable(() => {
listener.dispose();
this._authenticationProviders.delete(provider.id);
this._proxy.$unregisterAuthenticationProvider(provider.id);
this._onDidUnregisterAuthenticationProvider.fire(provider.id);
});
} }
$login(providerId: string): Promise<modes.Session> { $login(providerId: string): Promise<modes.Session> {