vscodium/patches/use-github-pat.patch

445 lines
17 KiB
Diff
Raw Normal View History

diff --git a/extensions/github-authentication/src/githubServer.ts b/extensions/github-authentication/src/githubServer.ts
2023-05-09 20:30:07 -04:00
index 3662719..5bf55e0 100644
--- a/extensions/github-authentication/src/githubServer.ts
+++ b/extensions/github-authentication/src/githubServer.ts
2022-11-10 12:36:08 -05:00
@@ -6,4 +6,2 @@
import * as vscode from 'vscode';
-import * as path from 'path';
-import { PromiseAdapter, promiseFromEvent } from './common/utils';
2022-11-10 12:36:08 -05:00
import { ExperimentationTelemetry } from './common/experimentationService';
2023-05-09 20:30:07 -04:00
@@ -11,10 +9,5 @@ import { AuthProviderType, UriEventHandler } from './github';
import { Log } from './common/logger';
2023-03-02 17:23:03 -05:00
-import { isSupportedClient, isSupportedTarget } from './common/env';
2022-11-10 12:36:08 -05:00
-import { LoopbackAuthServer } from './node/authServer';
-import { crypto } from './node/crypto';
2023-03-02 17:23:03 -05:00
+import { isSupportedTarget } from './common/env';
2022-11-10 12:36:08 -05:00
import { fetching } from './node/fetch';
2022-05-07 03:50:30 -04:00
-const CLIENT_ID = '01ab8ac9400c4e429b23';
-const GITHUB_TOKEN_URL = 'https://vscode.dev/codeExchangeProxyEndpoints/github/login/oauth/access_token';
2023-05-09 20:30:07 -04:00
-
// This is the error message that we throw if the login was cancelled for any reason. Extensions
@@ -23,3 +16,2 @@ const CANCELLATION_ERROR = 'Cancelled';
// These error messages are internal and should not be shown to the user in any way.
-const TIMED_OUT_ERROR = 'Timed out';
const USER_CANCELLATION_ERROR = 'User Cancelled';
@@ -27,5 +19,2 @@ const NETWORK_ERROR = 'network error';
2022-02-03 15:46:31 -05:00
-const REDIRECT_URL_STABLE = 'https://vscode.dev/redirect';
-const REDIRECT_URL_INSIDERS = 'https://insiders.vscode.dev/redirect';
2022-09-18 08:52:48 -04:00
-
2022-11-10 12:36:08 -05:00
export interface IGitHubServer {
2023-05-09 20:30:07 -04:00
@@ -37,9 +26,2 @@ export interface IGitHubServer {
2022-05-07 03:50:30 -04:00
-interface IGitHubDeviceCodeResponse {
- device_code: string;
- user_code: string;
- verification_uri: string;
- interval: number;
-}
2023-03-02 17:23:03 -05:00
-
async function getScopes(token: string, serverUri: vscode.Uri, logger: Log): Promise<string[]> {
2023-05-09 20:30:07 -04:00
@@ -70,8 +52,4 @@ export class GitHubServer implements IGitHubServer {
2022-11-10 12:36:08 -05:00
- private readonly _pendingNonces = new Map<string, string[]>();
- private readonly _codeExchangePromises = new Map<string, { promise: Promise<string>; cancel: vscode.EventEmitter<void> }>();
private readonly _type: AuthProviderType;
2022-02-03 15:46:31 -05:00
2022-11-10 12:36:08 -05:00
- private _redirectEndpoint: string | undefined;
-
constructor(
2023-05-09 20:30:07 -04:00
@@ -79,3 +57,5 @@ export class GitHubServer implements IGitHubServer {
2022-11-10 12:36:08 -05:00
private readonly _telemetryReporter: ExperimentationTelemetry,
+ // @ts-ignore
private readonly _uriHandler: UriEventHandler,
2022-09-18 08:52:48 -04:00
+ // @ts-ignore
2023-01-03 05:53:10 -05:00
private readonly _extensionKind: vscode.ExtensionKind,
2023-05-09 20:30:07 -04:00
@@ -94,26 +74,2 @@ export class GitHubServer implements IGitHubServer {
2022-09-18 08:52:48 -04:00
- private async getRedirectEndpoint(): Promise<string> {
- if (this._redirectEndpoint) {
- return this._redirectEndpoint;
- }
2022-11-10 12:36:08 -05:00
- if (this._type === AuthProviderType.github) {
2022-09-18 08:52:48 -04:00
- const proxyEndpoints = await vscode.commands.executeCommand<{ [providerId: string]: string } | undefined>('workbench.getCodeExchangeProxyEndpoints');
2022-05-07 03:50:30 -04:00
- // If we are running in insiders vscode.dev, then ensure we use the redirect route on that.
2022-09-18 08:52:48 -04:00
- this._redirectEndpoint = REDIRECT_URL_STABLE;
2022-05-07 03:50:30 -04:00
- if (proxyEndpoints?.github && new URL(proxyEndpoints.github).hostname === 'insiders.vscode.dev') {
2022-09-18 08:52:48 -04:00
- this._redirectEndpoint = REDIRECT_URL_INSIDERS;
2022-05-07 03:50:30 -04:00
- }
2022-09-18 08:52:48 -04:00
- } else {
2023-03-02 17:23:03 -05:00
- // GHE only supports a single redirect endpoint, so we can't use
- // insiders.vscode.dev/redirect when we're running in Insiders, unfortunately.
- // Additionally, we make the assumption that this function will only be used
- // in flows that target supported GHE targets, not on-prem GHES. Because of this
- // assumption, we can assume that the GHE version used is at least 3.8 which is
- // the version that changed the redirect endpoint to this URI from the old
- // GitHub maintained server.
- this._redirectEndpoint = 'https://vscode.dev/redirect';
2022-09-18 08:52:48 -04:00
- }
- return this._redirectEndpoint;
- }
-
2022-11-10 12:36:08 -05:00
// TODO@joaomoreno TODO@TylerLeonhardt
2023-05-09 20:30:07 -04:00
@@ -129,68 +85,7 @@ export class GitHubServer implements IGitHubServer {
2022-05-07 03:50:30 -04:00
let userCancelled: boolean | undefined;
2022-11-02 04:42:32 -04:00
- const yes = vscode.l10n.t('Yes');
- const no = vscode.l10n.t('No');
2023-05-09 20:30:07 -04:00
- const promptToContinue = async (mode: string) => {
2022-05-07 03:50:30 -04:00
- if (userCancelled === undefined) {
- // We haven't had a failure yet so wait to prompt
- return;
- }
- const message = userCancelled
2023-05-09 20:30:07 -04:00
- ? vscode.l10n.t('Having trouble logging in? Would you like to try a different way? ({0})', mode)
- : vscode.l10n.t('You have not yet finished authorizing this extension to use GitHub. Would you like to try a different way? ({0})', mode);
2022-05-07 03:50:30 -04:00
- const result = await vscode.window.showWarningMessage(message, yes, no);
- if (result !== yes) {
2023-05-09 20:30:07 -04:00
- throw new Error(CANCELLATION_ERROR);
2022-05-07 03:50:30 -04:00
- }
- };
2022-11-02 04:42:32 -04:00
-
2022-11-10 12:36:08 -05:00
- const nonce: string = crypto.getRandomValues(new Uint32Array(2)).reduce((prev, curr) => prev += curr.toString(16), '');
- const callbackUri = await vscode.env.asExternalUri(vscode.Uri.parse(`${vscode.env.uriScheme}://vscode.github-authentication/did-authenticate?nonce=${encodeURIComponent(nonce)}`));
2023-05-09 20:30:07 -04:00
-
2023-03-02 17:23:03 -05:00
- const supportedClient = isSupportedClient(callbackUri);
- const supportedTarget = isSupportedTarget(this._type, this._ghesUri);
- if (supportedClient && supportedTarget) {
2022-05-07 03:50:30 -04:00
- try {
- return await this.doLoginWithoutLocalServer(scopes, nonce, callbackUri);
- } catch (e) {
- this._logger.error(e);
2023-05-09 20:30:07 -04:00
- userCancelled = e.message ?? e === USER_CANCELLATION_ERROR;
2022-05-07 03:50:30 -04:00
- }
- }
2022-09-18 08:52:48 -04:00
-
2023-01-03 05:53:10 -05:00
- // Starting a local server is only supported if:
- // 1. We are in a UI extension because we need to open a port on the machine that has the browser
- // 2. We are in a node runtime because we need to open a port on the machine
2023-03-02 17:23:03 -05:00
- // 3. code exchange can only be done with a supported target
2023-01-03 05:53:10 -05:00
- if (
- this._extensionKind === vscode.ExtensionKind.UI &&
2023-03-02 17:23:03 -05:00
- typeof navigator === 'undefined' &&
- supportedTarget
2023-01-03 05:53:10 -05:00
- ) {
2022-05-07 03:50:30 -04:00
- try {
2023-05-09 20:30:07 -04:00
- await promptToContinue(vscode.l10n.t('local server'));
2022-05-07 03:50:30 -04:00
- return await this.doLoginWithLocalServer(scopes);
- } catch (e) {
2023-05-09 20:30:07 -04:00
- userCancelled = this.processLoginError(e);
2022-05-07 03:50:30 -04:00
- }
- }
-
2023-01-03 05:53:10 -05:00
- // We only can use the Device Code flow when we have a full node environment because of CORS.
- if (typeof navigator === 'undefined') {
2022-05-07 03:50:30 -04:00
- try {
2023-05-09 20:30:07 -04:00
- await promptToContinue(vscode.l10n.t('device code'));
2022-05-07 03:50:30 -04:00
- return await this.doLoginDeviceCodeFlow(scopes);
- } catch (e) {
2023-05-09 20:30:07 -04:00
- userCancelled = this.processLoginError(e);
2022-05-07 03:50:30 -04:00
- }
2023-01-03 06:10:17 -05:00
- }
2023-05-09 20:30:07 -04:00
2023-03-02 17:23:03 -05:00
- // In a supported environment, we can't use PAT auth because we use this auth for Settings Sync and it doesn't support PATs.
- // With that said, GitHub Enterprise isn't used by Settings Sync so we can use PATs for that.
- if (!supportedClient || this._type === AuthProviderType.githubEnterprise) {
2022-05-07 03:50:30 -04:00
- try {
2023-05-09 20:30:07 -04:00
- await promptToContinue(vscode.l10n.t('personal access token'));
2022-05-07 03:50:30 -04:00
- return await this.doLoginWithPat(scopes);
- } catch (e) {
2023-05-09 20:30:07 -04:00
- userCancelled = this.processLoginError(e);
2022-05-07 03:50:30 -04:00
- }
+ try {
+ return await this.doLoginWithPat(scopes);
+ } catch (e) {
2023-05-09 20:30:07 -04:00
+ userCancelled = this.processLoginError(e);
2022-02-03 15:46:31 -05:00
}
2023-05-09 20:30:07 -04:00
@@ -200,136 +95,2 @@ export class GitHubServer implements IGitHubServer {
2022-05-07 03:50:30 -04:00
- private async doLoginWithoutLocalServer(scopes: string, nonce: string, callbackUri: vscode.Uri): Promise<string> {
- this._logger.info(`Trying without local server... (${scopes})`);
- return await vscode.window.withProgress<string>({
- location: vscode.ProgressLocation.Notification,
2022-11-02 04:42:32 -04:00
- title: vscode.l10n.t({
- message: 'Signing in to {0}...',
- args: [this.baseUri.authority],
- comment: ['The {0} will be a url, e.g. github.com']
- }),
2022-05-07 03:50:30 -04:00
- cancellable: true
- }, async (_, token) => {
- const existingNonces = this._pendingNonces.get(scopes) || [];
- this._pendingNonces.set(scopes, [...existingNonces, nonce]);
2022-09-18 08:52:48 -04:00
- const redirectUri = await this.getRedirectEndpoint();
2022-05-07 03:50:30 -04:00
- const searchParams = new URLSearchParams([
- ['client_id', CLIENT_ID],
- ['redirect_uri', redirectUri],
- ['scope', scopes],
- ['state', encodeURIComponent(callbackUri.toString(true))]
- ]);
2022-09-18 08:52:48 -04:00
-
- const uri = vscode.Uri.parse(this.baseUri.with({
- path: '/login/oauth/authorize',
- query: searchParams.toString()
- }).toString(true));
- await vscode.env.openExternal(uri);
-
- // Register a single listener for the URI callback, in case the user starts the login process multiple times
- // before completing it.
- let codeExchangePromise = this._codeExchangePromises.get(scopes);
- if (!codeExchangePromise) {
2022-11-10 12:36:08 -05:00
- codeExchangePromise = promiseFromEvent(this._uriHandler!.event, this.handleUri(scopes));
- this._codeExchangePromises.set(scopes, codeExchangePromise);
- }
-
2022-05-07 03:50:30 -04:00
- try {
- return await Promise.race([
- codeExchangePromise.promise,
2023-05-09 20:30:07 -04:00
- new Promise<string>((_, reject) => setTimeout(() => reject(TIMED_OUT_ERROR), 300_000)), // 5min timeout
- promiseFromEvent<any, any>(token.onCancellationRequested, (_, __, reject) => { reject(USER_CANCELLATION_ERROR); }).promise
2022-05-07 03:50:30 -04:00
- ]);
- } finally {
- this._pendingNonces.delete(scopes);
- codeExchangePromise?.cancel.fire();
- this._codeExchangePromises.delete(scopes);
2022-05-07 03:50:30 -04:00
- }
- });
2022-05-07 03:50:30 -04:00
- }
-
- private async doLoginWithLocalServer(scopes: string): Promise<string> {
- this._logger.info(`Trying with local server... (${scopes})`);
- return await vscode.window.withProgress<string>({
- location: vscode.ProgressLocation.Notification,
2022-11-02 04:42:32 -04:00
- title: vscode.l10n.t({
- message: 'Signing in to {0}...',
- args: [this.baseUri.authority],
- comment: ['The {0} will be a url, e.g. github.com']
- }),
2022-05-07 03:50:30 -04:00
- cancellable: true
- }, async (_, token) => {
2022-09-18 08:52:48 -04:00
- const redirectUri = await this.getRedirectEndpoint();
2022-05-07 03:50:30 -04:00
- const searchParams = new URLSearchParams([
- ['client_id', CLIENT_ID],
- ['redirect_uri', redirectUri],
- ['scope', scopes],
- ]);
2022-09-18 08:52:48 -04:00
-
- const loginUrl = this.baseUri.with({
- path: '/login/oauth/authorize',
- query: searchParams.toString()
- });
- const server = new LoopbackAuthServer(path.join(__dirname, '../media'), loginUrl.toString(true));
2022-05-07 03:50:30 -04:00
- const port = await server.start();
-
- let codeToExchange;
- try {
- vscode.env.openExternal(vscode.Uri.parse(`http://127.0.0.1:${port}/signin?nonce=${encodeURIComponent(server.nonce)}`));
- const { code } = await Promise.race([
- server.waitForOAuthResponse(),
2023-05-09 20:30:07 -04:00
- new Promise<any>((_, reject) => setTimeout(() => reject(TIMED_OUT_ERROR), 300_000)), // 5min timeout
- promiseFromEvent<any, any>(token.onCancellationRequested, (_, __, reject) => { reject(USER_CANCELLATION_ERROR); }).promise
2022-05-07 03:50:30 -04:00
- ]);
- codeToExchange = code;
- } finally {
- setTimeout(() => {
- void server.stop();
- }, 5000);
- }
-
- const accessToken = await this.exchangeCodeForToken(codeToExchange);
- return accessToken;
- });
- }
-
- private async doLoginDeviceCodeFlow(scopes: string): Promise<string> {
- this._logger.info(`Trying device code flow... (${scopes})`);
-
- // Get initial device code
2022-09-18 08:52:48 -04:00
- const uri = this.baseUri.with({
- path: '/login/device/code',
- query: `client_id=${CLIENT_ID}&scope=${scopes}`
- });
2022-11-10 12:36:08 -05:00
- const result = await fetching(uri.toString(true), {
2022-05-07 03:50:30 -04:00
- method: 'POST',
- headers: {
- Accept: 'application/json'
- }
- });
- if (!result.ok) {
- throw new Error(`Failed to get one-time code: ${await result.text()}`);
- }
-
- const json = await result.json() as IGitHubDeviceCodeResponse;
-
2022-11-02 04:42:32 -04:00
- const button = vscode.l10n.t('Copy & Continue to GitHub');
2022-05-07 03:50:30 -04:00
- const modalResult = await vscode.window.showInformationMessage(
2022-11-02 04:42:32 -04:00
- vscode.l10n.t({ message: 'Your Code: {0}', args: [json.user_code], comment: ['The {0} will be a code, e.g. 123-456'] }),
2022-05-07 03:50:30 -04:00
- {
- modal: true,
2022-11-02 04:42:32 -04:00
- detail: vscode.l10n.t('To finish authenticating, navigate to GitHub and paste in the above one-time code.')
- }, button);
2022-05-07 03:50:30 -04:00
-
2022-11-02 04:42:32 -04:00
- if (modalResult !== button) {
2023-05-09 20:30:07 -04:00
- throw new Error(USER_CANCELLATION_ERROR);
2022-05-07 03:50:30 -04:00
- }
-
- await vscode.env.clipboard.writeText(json.user_code);
-
- const uriToOpen = await vscode.env.asExternalUri(vscode.Uri.parse(json.verification_uri));
- await vscode.env.openExternal(uriToOpen);
-
- return await this.waitForDeviceCodeAccessToken(json);
- }
2023-01-03 06:10:17 -05:00
-
private async doLoginWithPat(scopes: string): Promise<string> {
2023-05-09 20:30:07 -04:00
@@ -373,124 +134,2 @@ export class GitHubServer implements IGitHubServer {
2022-05-07 03:50:30 -04:00
- private async waitForDeviceCodeAccessToken(
- json: IGitHubDeviceCodeResponse,
- ): Promise<string> {
- return await vscode.window.withProgress<string>({
- location: vscode.ProgressLocation.Notification,
- cancellable: true,
2022-11-02 04:42:32 -04:00
- title: vscode.l10n.t({
- message: 'Open [{0}]({0}) in a new tab and paste your one-time code: {1}',
- args: [json.verification_uri, json.user_code],
- comment: [
- 'The [{0}]({0}) will be a url and the {1} will be a code, e.g. 123-456',
- '{Locked="[{0}]({0})"}'
- ]
- })
2022-05-07 03:50:30 -04:00
- }, async (_, token) => {
2022-09-18 08:52:48 -04:00
- const refreshTokenUri = this.baseUri.with({
- path: '/login/oauth/access_token',
- query: `client_id=${CLIENT_ID}&device_code=${json.device_code}&grant_type=urn:ietf:params:oauth:grant-type:device_code`
- });
2022-05-07 03:50:30 -04:00
-
- // Try for 2 minutes
- const attempts = 120 / json.interval;
- for (let i = 0; i < attempts; i++) {
- await new Promise(resolve => setTimeout(resolve, json.interval * 1000));
- if (token.isCancellationRequested) {
2023-05-09 20:30:07 -04:00
- throw new Error(USER_CANCELLATION_ERROR);
2022-05-07 03:50:30 -04:00
- }
- let accessTokenResult;
- try {
2022-11-10 12:36:08 -05:00
- accessTokenResult = await fetching(refreshTokenUri.toString(true), {
2022-05-07 03:50:30 -04:00
- method: 'POST',
- headers: {
- Accept: 'application/json'
- }
- });
- } catch {
- continue;
- }
-
- if (!accessTokenResult.ok) {
- continue;
- }
-
- const accessTokenJson = await accessTokenResult.json();
-
- if (accessTokenJson.error === 'authorization_pending') {
- continue;
- }
-
- if (accessTokenJson.error) {
- throw new Error(accessTokenJson.error_description);
- }
-
- return accessTokenJson.access_token;
- }
-
2023-05-09 20:30:07 -04:00
- throw new Error(TIMED_OUT_ERROR);
2022-05-07 03:50:30 -04:00
- });
- }
-
- private handleUri: (scopes: string) => PromiseAdapter<vscode.Uri, string> =
- (scopes) => (uri, resolve, reject) => {
- const query = new URLSearchParams(uri.query);
- const code = query.get('code');
- const nonce = query.get('nonce');
2022-05-07 03:50:30 -04:00
- if (!code) {
- reject(new Error('No code'));
- return;
- }
- if (!nonce) {
2022-05-07 03:50:30 -04:00
- reject(new Error('No nonce'));
- return;
- }
2022-05-07 03:50:30 -04:00
-
- const acceptedNonces = this._pendingNonces.get(scopes) || [];
- if (!acceptedNonces.includes(nonce)) {
- // A common scenario of this happening is if you:
- // 1. Trigger a sign in with one set of scopes
- // 2. Before finishing 1, you trigger a sign in with a different set of scopes
- // In this scenario we should just return and wait for the next UriHandler event
- // to run as we are probably still waiting on the user to hit 'Continue'
- this._logger.info('Nonce not found in accepted nonces. Skipping this execution...');
- return;
- }
-
2022-05-07 03:50:30 -04:00
- resolve(this.exchangeCodeForToken(code));
- };
-
2022-05-07 03:50:30 -04:00
- private async exchangeCodeForToken(code: string): Promise<string> {
- this._logger.info('Exchanging code for token...');
-
2022-05-07 03:50:30 -04:00
- const proxyEndpoints: { [providerId: string]: string } | undefined = await vscode.commands.executeCommand('workbench.getCodeExchangeProxyEndpoints');
- const endpointUrl = proxyEndpoints?.github ? `${proxyEndpoints.github}login/oauth/access_token` : GITHUB_TOKEN_URL;
-
2022-09-18 08:52:48 -04:00
- const body = new URLSearchParams([['code', code]]);
2022-11-10 12:36:08 -05:00
- if (this._type === AuthProviderType.githubEnterprise) {
2022-09-18 08:52:48 -04:00
- body.append('github_enterprise', this.baseUri.toString(true));
- body.append('redirect_uri', await this.getRedirectEndpoint());
- }
2022-11-10 12:36:08 -05:00
- const result = await fetching(endpointUrl, {
2022-05-07 03:50:30 -04:00
- method: 'POST',
- headers: {
- Accept: 'application/json',
- 'Content-Type': 'application/x-www-form-urlencoded',
- 'Content-Length': body.toString()
-
2022-05-07 03:50:30 -04:00
- },
2022-09-18 08:52:48 -04:00
- body: body.toString()
2022-05-07 03:50:30 -04:00
- });
-
- if (result.ok) {
- const json = await result.json();
- this._logger.info('Token exchange success!');
- return json.access_token;
- } else {
- const text = await result.text();
- const error = new Error(text);
- error.name = 'GitHubTokenExchangeError';
- throw error;
- }
2022-05-07 03:50:30 -04:00
- }
2023-05-09 20:30:07 -04:00
-
private getServerUri(path: string = '') {
diff --git a/src/vs/workbench/browser/parts/activitybar/activitybarActions.ts b/src/vs/workbench/browser/parts/activitybar/activitybarActions.ts
2023-05-09 20:30:07 -04:00
index ce04327..e66a7f5 100644
--- a/src/vs/workbench/browser/parts/activitybar/activitybarActions.ts
+++ b/src/vs/workbench/browser/parts/activitybar/activitybarActions.ts
2023-05-09 20:30:07 -04:00
@@ -355,3 +355,3 @@ export class AccountsActivityActionViewItem extends MenuActivityActionViewItem {
- if (providers.length && !menus.length) {
+ if (!menus.length) {
const noAccountsAvailableAction = disposables.add(new Action('noAccountsAvailable', localize('noAccounts', "You are not signed in to any accounts"), undefined, false));
diff --git a/src/vs/workbench/services/authentication/browser/authenticationService.ts b/src/vs/workbench/services/authentication/browser/authenticationService.ts
2023-05-09 20:30:07 -04:00
index 5285663..08f9e42 100644
--- a/src/vs/workbench/services/authentication/browser/authenticationService.ts
+++ b/src/vs/workbench/services/authentication/browser/authenticationService.ts
2023-01-03 05:53:10 -05:00
@@ -274,12 +274,2 @@ export class AuthenticationService extends Disposable implements IAuthentication
}
-
- if (!this._authenticationProviders.size) {
2022-09-25 08:54:41 -04:00
- placeholderMenuItem = MenuRegistry.appendMenuItem(MenuId.AccountsContext, {
- command: {
- id: 'noAuthenticationProviders',
- title: nls.localize('loading', "Loading..."),
- precondition: ContextKeyExpr.false()
- },
- });
- }
}