@microsoft/vscode-azext-azureauth 1.2.1 → 1.3.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+## 1.3.0 - 2023-10-23
+
+* [#1610](https://github.com/microsoft/vscode-azuretools/pull/1610) Add `signInToTenant` command which facilitates signing in to a specific tenant.
+* [#1610](https://github.com/microsoft/vscode-azuretools/pull/1610) Add `getUnauthenticatedTenants` utility.
+
+## 1.2.2 - 2023-10-19
+
+* [#1608](https://github.com/microsoft/vscode-azuretools/pull/1608) Fix appending `.default` to tenant id scope which caused sign in to fail
+
+## 1.2.1 - 2023-09-26
+
+* [#1594](https://github.com/microsoft/vscode-azuretools/pull/1594) Fix getScopes always injecting the management scope, even if a scope for a different resource is specified
+* [#1597](https://github.com/microsoft/vscode-azuretools/pull/1597) Make `authentication.getSession` use scopes argument
+
+## 1.1.3 - 2023-09-14
+
+* [#1585](https://github.com/microsoft/vscode-azuretools/pull/1585) Check if tenant is signed in before listing subscriptions
+
+## 1.1.2 - 2023-07-26
+
+* [#1542](https://github.com/microsoft/vscode-azuretools/pull/1542) Fix Azure subscriptions are not returned in alphabetical order
+
+## 1.1.1 - 2023-07-26
+
+* [#1540](https://github.com/microsoft/vscode-azuretools/pull/1540) Ignore .default if it is passed as a scope
+
+## 1.0.0 - 2023-06-05
+
+Initial release

package/out/src/VSCodeAzureSubscriptionProvider.d.ts

@@ -100,22 +100,4 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      */
     private getSubscriptionClient;
     private getToken;
-    /**
-     * Gets a normalized list of scopes. If no scopes are provided, the return value of {@link getDefaultScope} is used.
-     *
-     * Only supports top-level resource scopes (e.g. http://management.azure.com, http://storage.azure.com) or .default scopes.
-     *
-     * All resources/scopes will be normalized to the `.default` scope for each resource.
-     *
-     * @param scopes An input scope string, list, or undefined
-     * @param tenantId (Optional) The tenant ID, will be added to the scopes
-     */
-    private getScopes;
-    /**
-     * Gets the default Azure scopes required for resource management,
-     * depending on the configured endpoint
-     *
-     * @returns The default Azure scopes required
-     */
-    private getDefaultScope;
 }

package/out/src/VSCodeAzureSubscriptionProvider.js

@@ -24,6 +24,7 @@ exports.VSCodeAzureSubscriptionProvider = void 0;
 const cross_fetch_1 = require("cross-fetch");
 const vscode = require("vscode");
 const NotSignedInError_1 = require("./NotSignedInError");
+const getSessionFromVSCode_1 = require("./getSessionFromVSCode");
 const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
 const EventDebounce = 5 * 1000; // 5 seconds
 /**
@@ -141,7 +142,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      */
     isSignedIn(tenantId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const session = yield vscode.authentication.getSession((0, configuredAzureEnv_1.getConfiguredAuthProviderId)(), this.getScopes([], tenantId), { createIfNone: false, silent: true });
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true });
             return !!session;
         });
     }
@@ -154,7 +155,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      */
     signIn(tenantId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const session = yield vscode.authentication.getSession((0, configuredAzureEnv_1.getConfiguredAuthProviderId)(), this.getScopes([], tenantId), { createIfNone: true, clearSessionPreference: true });
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: true, clearSessionPreference: true });
             return !!session;
         });
     }
@@ -255,7 +256,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
         return __awaiter(this, void 0, void 0, function* () {
             const armSubs = yield Promise.resolve().then(() => require('@azure/arm-subscriptions'));
             const getSession = (scopes) => __awaiter(this, void 0, void 0, function* () {
-                const session = yield vscode.authentication.getSession((0, configuredAzureEnv_1.getConfiguredAuthProviderId)(), this.getScopes(scopes, tenantId), { createIfNone: false, silent: true });
+                const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true });
                 if (!session) {
                     throw new NotSignedInError_1.NotSignedInError();
                 }
@@ -264,7 +265,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
             const credential = {
                 getToken: (scopes) => __awaiter(this, void 0, void 0, function* () {
                     return {
-                        token: (yield getSession(this.getScopes(scopes, tenantId))).accessToken,
+                        token: (yield getSession(scopes)).accessToken,
                         expiresOnTimestamp: 0
                     };
                 })
@@ -273,58 +274,20 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                 client: new armSubs.SubscriptionClient(credential),
                 credential: credential,
                 authentication: {
-                    getSession
+                    getSession,
                 }
             };
         });
     }
     getToken(tenantId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const session = yield vscode.authentication.getSession((0, configuredAzureEnv_1.getConfiguredAuthProviderId)(), this.getScopes([], tenantId), { createIfNone: false, silent: true });
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true });
             if (!session) {
                 throw new NotSignedInError_1.NotSignedInError();
             }
             return session.accessToken;
         });
     }
-    /**
-     * Gets a normalized list of scopes. If no scopes are provided, the return value of {@link getDefaultScope} is used.
-     *
-     * Only supports top-level resource scopes (e.g. http://management.azure.com, http://storage.azure.com) or .default scopes.
-     *
-     * All resources/scopes will be normalized to the `.default` scope for each resource.
-     *
-     * @param scopes An input scope string, list, or undefined
-     * @param tenantId (Optional) The tenant ID, will be added to the scopes
-     */
-    getScopes(scopes, tenantId) {
-        if (scopes === undefined || scopes === "" || scopes.length === 0) {
-            scopes = this.getDefaultScope();
-        }
-        const arrScopes = (Array.isArray(scopes) ? scopes : [scopes])
-            .map((scope) => {
-            if (scope.endsWith('.default')) {
-                return scope;
-            }
-            else {
-                return `${scope}.default`;
-            }
-        });
-        const scopeSet = new Set(arrScopes);
-        if (tenantId) {
-            scopeSet.add(`VSCODE_TENANT:${tenantId}`);
-        }
-        return Array.from(scopeSet);
-    }
-    /**
-     * Gets the default Azure scopes required for resource management,
-     * depending on the configured endpoint
-     *
-     * @returns The default Azure scopes required
-     */
-    getDefaultScope() {
-        return `${(0, configuredAzureEnv_1.getConfiguredAzureEnv)().resourceManagerEndpointUrl}.default`;
-    }
 }
 exports.VSCodeAzureSubscriptionProvider = VSCodeAzureSubscriptionProvider;
 //# sourceMappingURL=VSCodeAzureSubscriptionProvider.js.map

package/out/src/getSessionFromVSCode.d.ts

@@ -0,0 +1,12 @@
+import * as vscode from "vscode";
+/**
+ * Wraps {@link vscode.authentication.getSession} and handles:
+ * * Passing the configured auth provider id
+ * * Getting the list of scopes, adding the tenant id to the scope list if needed
+ *
+ * @param scopes - top-level resource scopes (e.g. http://management.azure.com, http://storage.azure.com) or .default scopes. All resources/scopes will be normalized to the `.default` scope for each resource.
+ * @param tenantId - (Optional) The tenant ID, will be added to the scopes
+ * @param options - see {@link vscode.AuthenticationGetSessionOptions}
+ * @returns An authentication session if available, or undefined if there are no sessions
+ */
+export declare function getSessionFromVSCode(scopes?: string | string[], tenantId?: string, options?: vscode.AuthenticationGetSessionOptions): Promise<vscode.AuthenticationSession | undefined>;

package/out/src/getSessionFromVSCode.js

@@ -0,0 +1,62 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSessionFromVSCode = void 0;
+const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
+const vscode = require("vscode");
+function getResourceScopes(scopes) {
+    if (scopes === undefined || scopes === "" || scopes.length === 0) {
+        scopes = `${(0, configuredAzureEnv_1.getConfiguredAzureEnv)().resourceManagerEndpointUrl}.default`;
+    }
+    const arrScopes = (Array.isArray(scopes) ? scopes : [scopes])
+        .map((scope) => {
+        if (scope.endsWith('.default')) {
+            return scope;
+        }
+        else {
+            return `${scope}.default`;
+        }
+    });
+    return Array.from(new Set(arrScopes));
+}
+function addTenantIdScope(scopes, tenantId) {
+    const scopeSet = new Set(scopes);
+    scopeSet.add(`VSCODE_TENANT:${tenantId}`);
+    return Array.from(scopeSet);
+}
+function getScopes(scopes, tenantId) {
+    let scopeArr = getResourceScopes(scopes);
+    if (tenantId) {
+        scopeArr = addTenantIdScope(scopeArr, tenantId);
+    }
+    return scopeArr;
+}
+/**
+ * Wraps {@link vscode.authentication.getSession} and handles:
+ * * Passing the configured auth provider id
+ * * Getting the list of scopes, adding the tenant id to the scope list if needed
+ *
+ * @param scopes - top-level resource scopes (e.g. http://management.azure.com, http://storage.azure.com) or .default scopes. All resources/scopes will be normalized to the `.default` scope for each resource.
+ * @param tenantId - (Optional) The tenant ID, will be added to the scopes
+ * @param options - see {@link vscode.AuthenticationGetSessionOptions}
+ * @returns An authentication session if available, or undefined if there are no sessions
+ */
+function getSessionFromVSCode(scopes, tenantId, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield vscode.authentication.getSession((0, configuredAzureEnv_1.getConfiguredAuthProviderId)(), getScopes(scopes, tenantId), options);
+    });
+}
+exports.getSessionFromVSCode = getSessionFromVSCode;
+//# sourceMappingURL=getSessionFromVSCode.js.map

package/out/src/index.d.ts

@@ -3,4 +3,6 @@ export * from './AzureSubscription';
 export * from './AzureSubscriptionProvider';
 export * from './NotSignedInError';
 export * from './utils/configuredAzureEnv';
+export * from './utils/getUnauthenticatedTenants';
 export * from './VSCodeAzureSubscriptionProvider';
+export * from './signInToTenant';

package/out/src/index.js

@@ -23,5 +23,7 @@ __exportStar(require("./AzureSubscription"), exports);
 __exportStar(require("./AzureSubscriptionProvider"), exports);
 __exportStar(require("./NotSignedInError"), exports);
 __exportStar(require("./utils/configuredAzureEnv"), exports);
+__exportStar(require("./utils/getUnauthenticatedTenants"), exports);
 __exportStar(require("./VSCodeAzureSubscriptionProvider"), exports);
+__exportStar(require("./signInToTenant"), exports);
 //# sourceMappingURL=index.js.map

package/out/src/signInToTenant.d.ts

@@ -0,0 +1,6 @@
+import type { AzureSubscriptionProvider } from "./AzureSubscriptionProvider";
+/**
+ * Prompts user to select from a list of unauthenticated tenants.
+ * Once selected, requests a new session from VS Code specifially for this tenant.
+ */
+export declare function signInToTenant(subscriptionProvider: AzureSubscriptionProvider): Promise<void>;

package/out/src/signInToTenant.js

@@ -0,0 +1,57 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signInToTenant = void 0;
+const vscode = require("vscode");
+const getUnauthenticatedTenants_1 = require("./utils/getUnauthenticatedTenants");
+/**
+ * Prompts user to select from a list of unauthenticated tenants.
+ * Once selected, requests a new session from VS Code specifially for this tenant.
+ */
+function signInToTenant(subscriptionProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tenantId = yield pickTenant(subscriptionProvider);
+        if (tenantId) {
+            yield subscriptionProvider.signIn(tenantId);
+        }
+    });
+}
+exports.signInToTenant = signInToTenant;
+function pickTenant(subscriptionProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const pick = yield vscode.window.showQuickPick(getPicks(subscriptionProvider), {
+            placeHolder: 'Select Directory to Sign In To',
+            matchOnDescription: true,
+            ignoreFocusOut: true,
+        });
+        return pick === null || pick === void 0 ? void 0 : pick.tenant.tenantId;
+    });
+}
+function getPicks(subscriptionProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const unauthenticatedTenants = yield (0, getUnauthenticatedTenants_1.getUnauthenticatedTenants)(subscriptionProvider);
+        const picks = unauthenticatedTenants.map(tenant => {
+            var _a, _b, _c;
+            return ({
+                label: (_a = tenant.displayName) !== null && _a !== void 0 ? _a : '',
+                description: (_b = tenant.tenantId) !== null && _b !== void 0 ? _b : '',
+                detail: (_c = tenant.defaultDomain) !== null && _c !== void 0 ? _c : '',
+                tenant,
+            });
+        });
+        return picks;
+    });
+}
+//# sourceMappingURL=signInToTenant.js.map

package/out/src/utils/getUnauthenticatedTenants.d.ts

@@ -0,0 +1,6 @@
+import type { TenantIdDescription } from "@azure/arm-subscriptions";
+import type { AzureSubscriptionProvider } from "../AzureSubscriptionProvider";
+/**
+ * @returns list of tenants that VS Code doesn't have sessions for
+ */
+export declare function getUnauthenticatedTenants(subscriptionProvider: AzureSubscriptionProvider): Promise<TenantIdDescription[]>;

package/out/src/utils/getUnauthenticatedTenants.js

@@ -0,0 +1,58 @@
+"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.getUnauthenticatedTenants = void 0;
+/**
+ * @returns list of tenants that VS Code doesn't have sessions for
+ */
+function getUnauthenticatedTenants(subscriptionProvider) {
+    var _a, e_1, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        const tenants = yield subscriptionProvider.getTenants();
+        const unauthenticatedTenants = [];
+        try {
+            for (var _d = true, tenants_1 = __asyncValues(tenants), tenants_1_1; tenants_1_1 = yield tenants_1.next(), _a = tenants_1_1.done, !_a;) {
+                _c = tenants_1_1.value;
+                _d = false;
+                try {
+                    const tenant = _c;
+                    if (!(yield subscriptionProvider.isSignedIn(tenant.tenantId))) {
+                        unauthenticatedTenants.push(tenant);
+                    }
+                }
+                finally {
+                    _d = true;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = tenants_1.return)) yield _b.call(tenants_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return unauthenticatedTenants;
+    });
+}
+exports.getUnauthenticatedTenants = getUnauthenticatedTenants;
+//# sourceMappingURL=getUnauthenticatedTenants.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-azureauth",
     "author": "Microsoft Corporation",
-    "version": "1.2.1",
+    "version": "1.3.0",
     "description": "Azure authentication helpers for Visual Studio Code",
     "tags": [
         "azure",