@microsoft/vscode-azext-azureauth 4.2.2 → 5.0.0

package/dist/esm/src/utils/isAuthenticationWwwAuthenticateRequest.d.ts

@@ -0,0 +1,2 @@
+import type * as vscode from "vscode";
+export declare function isAuthenticationWwwAuthenticateRequest(obj: unknown): obj is vscode.AuthenticationWwwAuthenticateRequest;

package/dist/esm/src/utils/isAuthenticationWwwAuthenticateRequest.js

@@ -0,0 +1,12 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+// Copied straight from https://github.com/microsoft/vscode/blob/32a309c4eceb1df1252215e36766ffb7e4e5afb3/src/vs/workbench/services/authentication/common/authentication.ts#L80-L85
+export function isAuthenticationWwwAuthenticateRequest(obj) {
+    return typeof obj === 'object'
+        && obj !== null
+        && 'wwwAuthenticate' in obj
+        && (typeof obj.wwwAuthenticate === 'string');
+}
+//# sourceMappingURL=isAuthenticationWwwAuthenticateRequest.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-azureauth",
     "author": "Microsoft Corporation",
-    "version": "4.2.2",
+    "version": "5.0.0",
     "description": "Azure authentication helpers for Visual Studio Code",
     "tags": [
         "azure",
@@ -11,8 +11,9 @@
         "azure",
         "vscode"
     ],
-    "main": "out/src/index.js",
-    "types": "out/src/index.d.ts",
+    "module": "dist/esm/src/index.js",
+    "main": "dist/cjs/src/index.js",
+    "types": "dist/esm/src/index.d.ts",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -23,26 +24,25 @@
     },
     "homepage": "https://github.com/Microsoft/vscode-azuretools/blob/main/auth/README.md",
     "scripts": {
-        "build": "tsc -p ./",
-        "compile": "tsc -watch -p ./",
+        "build": "npm run build:esm && npm run build:cjs",
+        "build:esm": "tsc -p ./",
+        "build:cjs": "tsc -p ./ --outDir ./dist/cjs --module nodenext --moduleResolution nodenext",
         "lint": "eslint --ext .ts .",
         "lint-fix": "eslint --ext .ts . --fix",
-        "test": "node ./out/test/runTest.js",
+        "test": "node ./dist/cjs/test/runTest.js",
         "package": "npm pack",
         "l10n": "npx @vscode/l10n-dev export --outDir ./l10n ./src"
     },
+    "engines": {
+        "vscode": "^1.105.0"
+    },
     "devDependencies": {
         "@azure/core-auth": "^1.4.0",
-        "@azure/identity": "^4.2.0",
         "@microsoft/eslint-config-azuretools": "^0.2.1",
         "@types/glob": "^8.1.0",
-        "@types/html-to-text": "^8.1.0",
         "@types/mocha": "^7.0.2",
         "@types/node": "^18.18.7",
-        "@types/node-fetch": "2.6.7",
-        "@types/semver": "^7.3.9",
-        "@types/uuid": "^9.0.1",
-        "@types/vscode": "^1.94.0",
+        "@types/vscode": "1.104.0",
         "@typescript-eslint/eslint-plugin": "^5.53.0",
         "@vscode/test-electron": "^2.3.8",
         "eslint": "^8.34.0",
@@ -57,6 +57,7 @@
         "@azure/arm-resources-subscriptions": "^2.1.0",
         "@azure/core-client": "^1.9.2",
         "@azure/core-rest-pipeline": "^1.16.0",
+        "@azure/identity": "^4.2.0",
         "@azure/ms-rest-azure-env": "^2.0.0"
     }
 }

package/out/src/AzureDevOpsSubscriptionProvider.js

@@ -1,252 +0,0 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AzureDevOpsSubscriptionProvider = void 0;
-exports.createAzureDevOpsSubscriptionProviderFactory = createAzureDevOpsSubscriptionProviderFactory;
-const vscode_1 = require("vscode");
-const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
-let azureDevOpsSubscriptionProvider;
-function createAzureDevOpsSubscriptionProviderFactory(initializer) {
-    return () => __awaiter(this, void 0, void 0, function* () {
-        azureDevOpsSubscriptionProvider !== null && azureDevOpsSubscriptionProvider !== void 0 ? azureDevOpsSubscriptionProvider : (azureDevOpsSubscriptionProvider = new AzureDevOpsSubscriptionProvider(initializer));
-        return azureDevOpsSubscriptionProvider;
-    });
-}
-/**
- * AzureSubscriptionProvider implemented to authenticate via federated DevOps service connection, using workflow identity federation
- * To learn how to configure your DevOps environment to use this provider, refer to the README.md
- * NOTE: This provider is only available when running in an Azure DevOps pipeline
- * Reference: https://learn.microsoft.com/en-us/entra/workload-id/workload-identity-federation
- */
-class AzureDevOpsSubscriptionProvider {
-    constructor({ serviceConnectionId, domain, clientId }) {
-        this.onDidSignIn = () => { return new vscode_1.Disposable(() => { }); };
-        this.onDidSignOut = () => { return new vscode_1.Disposable(() => { }); };
-        if (!serviceConnectionId || !domain || !clientId) {
-            throw new Error(`Missing initializer values to identify Azure DevOps federated service connection\n
-                Values provided:\n
-                serviceConnectionId: ${serviceConnectionId ? "✅" : "❌"}\n
-                domain: ${domain ? "✅" : "❌"}\n
-                clientId: ${clientId ? "✅" : "❌"}\n
-            `);
-        }
-        this._SERVICE_CONNECTION_ID = serviceConnectionId;
-        this._DOMAIN = domain;
-        this._CLIENT_ID = clientId;
-    }
-    getSubscriptions(_filter) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // ignore the filter setting because not every consumer of this provider will use the Resources extension
-            const results = [];
-            for (const tenant of yield this.getTenants()) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                const tenantId = tenant.tenantId;
-                results.push(...yield this.getSubscriptionsForTenant(tenantId));
-            }
-            const sortSubscriptions = (subscriptions) => subscriptions.sort((a, b) => a.name.localeCompare(b.name));
-            return sortSubscriptions(results);
-        });
-    }
-    isSignedIn() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return !!this._tokenCredential;
-        });
-    }
-    signIn() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this._tokenCredential = yield getTokenCredential(this._SERVICE_CONNECTION_ID, this._DOMAIN, this._CLIENT_ID);
-            return !!this._tokenCredential;
-        });
-    }
-    signOut() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this._tokenCredential = undefined;
-        });
-    }
-    getTenants() {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            return [{
-                    tenantId: (_a = this._tokenCredential) === null || _a === void 0 ? void 0 : _a.tenantId,
-                    account: {
-                        id: "test-account-id",
-                        label: "test-account",
-                    }
-                }];
-        });
-    }
-    /**
-     * Gets the subscriptions for a given tenant.
-     *
-     * @param tenantId The tenant ID to get subscriptions for.
-     *
-     * @returns The list of subscriptions for the tenant.
-     */
-    getSubscriptionsForTenant(tenantId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, e_1, _b, _c;
-            const { client, credential, authentication } = yield this.getSubscriptionClient(tenantId);
-            const environment = (0, configuredAzureEnv_1.getConfiguredAzureEnv)();
-            const subscriptions = [];
-            try {
-                for (var _d = true, _e = __asyncValues(client.subscriptions.list()), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const subscription = _c;
-                    subscriptions.push({
-                        authentication,
-                        environment: environment,
-                        credential: credential,
-                        isCustomCloud: environment.isCustomCloud,
-                        /* eslint-disable @typescript-eslint/no-non-null-assertion */
-                        name: subscription.displayName,
-                        subscriptionId: subscription.subscriptionId,
-                        /* eslint-enable @typescript-eslint/no-non-null-assertion */
-                        tenantId,
-                        account: {
-                            id: "test-account-id",
-                            label: "test-account",
-                        },
-                    });
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-            return subscriptions;
-        });
-    }
-    /**
-     * Gets a fully-configured subscription client for a given tenant ID
-     *
-     * @param tenantId (Optional) The tenant ID to get a client for
-     *
-     * @returns A client, the credential used by the client, and the authentication function
-     */
-    getSubscriptionClient(_tenantId, scopes) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const armSubs = yield Promise.resolve().then(() => require('@azure/arm-resources-subscriptions'));
-            if (!this._tokenCredential) {
-                throw new Error('Not signed in');
-            }
-            const accessToken = ((_b = (yield ((_a = this._tokenCredential) === null || _a === void 0 ? void 0 : _a.getToken("https://management.azure.com/.default")))) === null || _b === void 0 ? void 0 : _b.token) || '';
-            const getSession = () => {
-                var _a, _b, _c, _d;
-                return {
-                    accessToken,
-                    id: ((_a = this._tokenCredential) === null || _a === void 0 ? void 0 : _a.tenantId) || '',
-                    account: {
-                        id: ((_b = this._tokenCredential) === null || _b === void 0 ? void 0 : _b.tenantId) || '',
-                        label: ((_c = this._tokenCredential) === null || _c === void 0 ? void 0 : _c.tenantId) || '',
-                    },
-                    tenantId: ((_d = this._tokenCredential) === null || _d === void 0 ? void 0 : _d.tenantId) || '',
-                    scopes: scopes || [],
-                };
-            };
-            return {
-                client: new armSubs.SubscriptionClient(this._tokenCredential),
-                credential: this._tokenCredential,
-                authentication: {
-                    getSession,
-                    getSessionWithScopes: getSession,
-                }
-            };
-        });
-    }
-}
-exports.AzureDevOpsSubscriptionProvider = AzureDevOpsSubscriptionProvider;
-/*
-* @param serviceConnectionId The resource ID of the Azure DevOps federated service connection,
-*   which can be found on the `resourceId` field of the URL at the address bar when viewing the service connection in the Azure DevOps portal
-* @param domain The `Tenant ID` field of the service connection properties
-* @param clientId The `Service Principal Id` field of the service connection properties
-*/
-function getTokenCredential(serviceConnectionId, domain, clientId) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!process.env.AGENT_BUILDDIRECTORY) {
-            // Assume that AGENT_BUILDDIRECTORY is set if running in an Azure DevOps pipeline.
-            // So when not running in an Azure DevOps pipeline, throw an error since we cannot use the DevOps federated service connection credential.
-            throw new Error(`Cannot create DevOps federated service connection credential outside of an Azure DevOps pipeline.`);
-        }
-        else {
-            console.log(`Creating DevOps federated service connection credential for service connection..`);
-            // Pre-defined DevOps variable reference: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops
-            const systemAccessToken = process.env.SYSTEM_ACCESSTOKEN;
-            const teamFoundationCollectionUri = process.env.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI;
-            const teamProjectId = process.env.SYSTEM_TEAMPROJECTID;
-            const planId = process.env.SYSTEM_PLANID;
-            const jobId = process.env.SYSTEM_JOBID;
-            if (!systemAccessToken || !teamFoundationCollectionUri || !teamProjectId || !planId || !jobId) {
-                throw new Error(`Azure DevOps environment variables are not set.\n
-            process.env.SYSTEM_ACCESSTOKEN: ${process.env.SYSTEM_ACCESSTOKEN ? "✅" : "❌"}\n
-            process.env.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI: ${process.env.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI ? "✅" : "❌"}\n
-            process.env.SYSTEM_TEAMPROJECTID: ${process.env.SYSTEM_TEAMPROJECTID ? "✅" : "❌"}\n
-            process.env.SYSTEM_PLANID: ${process.env.SYSTEM_PLANID ? "✅" : "❌"}\n
-            process.env.SYSTEM_JOBID: ${process.env.SYSTEM_JOBID ? "✅" : "❌"}\n
-            REMEMBER: process.env.SYSTEM_ACCESSTOKEN must be explicitly mapped!\n
-            https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#systemaccesstoken
-        `);
-            }
-            const oidcRequestUrl = `${teamFoundationCollectionUri}${teamProjectId}/_apis/distributedtask/hubs/build/plans/${planId}/jobs/${jobId}/oidctoken?api-version=7.1-preview.1&serviceConnectionId=${serviceConnectionId}`;
-            const { ClientAssertionCredential } = yield Promise.resolve().then(() => require("@azure/identity"));
-            return new ClientAssertionCredential(domain, clientId, () => __awaiter(this, void 0, void 0, function* () { return yield requestOidcToken(oidcRequestUrl, systemAccessToken); }));
-        }
-    });
-}
-/**
- * API reference: https://learn.microsoft.com/en-us/rest/api/azure/devops/distributedtask/oidctoken/create
- */
-function requestOidcToken(oidcRequestUrl, systemAccessToken) {
-    return __awaiter(this, void 0, void 0, function* () {
-        var _a;
-        const { ServiceClient } = yield Promise.resolve().then(() => require('@azure/core-client'));
-        const { createHttpHeaders, createPipelineRequest } = yield Promise.resolve().then(() => require('@azure/core-rest-pipeline'));
-        const genericClient = new ServiceClient();
-        const request = createPipelineRequest({
-            url: oidcRequestUrl,
-            method: "POST",
-            headers: createHttpHeaders({
-                "Content-Type": "application/json",
-                "Authorization": `Bearer ${systemAccessToken}`
-            })
-        });
-        const response = yield genericClient.sendRequest(request);
-        const body = ((_a = response.bodyAsText) === null || _a === void 0 ? void 0 : _a.toString()) || "";
-        if (response.status !== 200) {
-            throw new Error(`Failed to get OIDC token:\n
-            Response status: ${response.status}\n
-            Response body: ${body}\n
-            Response headers: ${JSON.stringify(response.headers.toJSON())}
-        `);
-        }
-        else {
-            console.log(`Successfully got OIDC token with status ${response.status}`);
-        }
-        return JSON.parse(body).oidcToken;
-    });
-}
-//# sourceMappingURL=AzureDevOpsSubscriptionProvider.js.map