@azure/identity 3.2.0-beta.1 → 3.2.0-beta.2

package/dist/index.js

@@ -257,7 +257,7 @@ function credentialLogger(title, log = logger$n) {
 /**
  * Current version of the `@azure/identity` package.
  */
-const SDK_VERSION = `3.2.0-beta.1`;
+const SDK_VERSION = `3.2.0-beta.2`;
 /**
  * The default client ID for authentication
  * @internal
@@ -473,7 +473,7 @@ class MsalBaseUtilities {
 }
 // transformations.ts
 function publicToMsal(account) {
-    const [environment] = account.authority.match(/([a-z]*\.[a-z]*\.[a-z]*)/) || [];
+    const [environment] = account.authority.match(/([a-z]*\.[a-z]*\.[a-z]*)/) || [""];
     return Object.assign(Object.assign({}, account), { localAccountId: account.homeAccountId, environment });
 }
 function msalToPublic(clientId, account) {
@@ -667,7 +667,7 @@ function mapScopesToResource(scopes) {
  * Given a token response, return the expiration timestamp as the number of milliseconds from the Unix epoch.
  * @param body - A parsed response body from the authentication endpoint.
  */
-function parseExpiresOn(body) {
+function parseExpirationTimestamp(body) {
     if (typeof body.expires_on === "number") {
         return body.expires_on * 1000;
     }
@@ -743,7 +743,7 @@ class IdentityClient extends coreClient.ServiceClient {
             const token = {
                 accessToken: {
                     token: parsedBody.access_token,
-                    expiresOnTimestamp: parseExpiresOn(parsedBody),
+                    expiresOnTimestamp: parseExpirationTimestamp(parsedBody),
                 },
                 refreshToken: parsedBody.refresh_token,
             };
@@ -1197,7 +1197,7 @@ To work with multiple accounts for the same Client ID and Tenant ID, please prov
      * Attempts to retrieve a token from cache.
      */
     async getTokenSilent(scopes, options) {
-        var _a, _b;
+        var _a, _b, _c;
         await this.getActiveAccount();
         if (!this.account) {
             throw new AuthenticationRequiredError({
@@ -1216,7 +1216,14 @@ To work with multiple accounts for the same Client ID and Tenant ID, please prov
         };
         try {
             this.logger.info("Attempting to acquire token silently");
-            const response = (_b = (await ((_a = this.confidentialApp) === null || _a === void 0 ? void 0 : _a.acquireTokenSilent(silentRequest)))) !== null && _b !== void 0 ? _b : (await this.publicApp.acquireTokenSilent(silentRequest));
+            /**
+             * The following code to retrieve all accounts is done as a workaround in an attempt to force the
+             * refresh of the token cache with the token and the account passed in through the
+             * `authenticationRecord` parameter. See issue - https://github.com/Azure/azure-sdk-for-js/issues/24349#issuecomment-1496715651
+             * This workaround serves as a workoaround for silent authentication not happening when authenticationRecord is passed.
+             */
+            await ((_a = (this.publicApp || this.confidentialApp)) === null || _a === void 0 ? void 0 : _a.getTokenCache().getAllAccounts());
+            const response = (_c = (await ((_b = this.confidentialApp) === null || _b === void 0 ? void 0 : _b.acquireTokenSilent(silentRequest)))) !== null && _c !== void 0 ? _c : (await this.publicApp.acquireTokenSilent(silentRequest));
             return this.handleResult(scopes, this.clientId, response || undefined);
         }
         catch (err) {
@@ -1969,37 +1976,28 @@ const logger$g = credentialLogger(credentialName$3);
  */
 class WorkloadIdentityCredential {
     /**
-     * @internal
-     * @hidden
+     * WorkloadIdentityCredential supports Azure workload identity on Kubernetes.
+     *
+     * @param options - The identity client options to use for authentication.
      */
     constructor(options) {
         this.azureFederatedTokenFileContent = undefined;
         this.cacheDate = undefined;
+        // Logging environment variables for error details
+        const assignedEnv = processEnvVars(SupportedWorkloadEnvironmentVariables).assigned.join(", ");
+        logger$g.info(`Found the following environment variables: ${assignedEnv}`);
         const workloadIdentityCredentialOptions = options;
-        if (workloadIdentityCredentialOptions.clientId &&
-            workloadIdentityCredentialOptions.tenantId &&
-            workloadIdentityCredentialOptions.federatedTokenFilePath) {
-            const tenantId = workloadIdentityCredentialOptions.tenantId;
-            if (tenantId) {
-                checkTenantId(logger$g, tenantId);
-            }
-            this.federatedTokenFilePath = workloadIdentityCredentialOptions.federatedTokenFilePath;
-            logger$g.info(`Invoking ClientAssertionCredential with tenant ID: ${tenantId}, clientId: ${workloadIdentityCredentialOptions.clientId} and federated token path: [REDACTED]`);
-            this.client = new ClientAssertionCredential(tenantId, workloadIdentityCredentialOptions.clientId, this.readFileContents.bind(this), options);
+        const tenantId = workloadIdentityCredentialOptions.tenantId || process.env.AZURE_TENANT_ID;
+        const clientId = workloadIdentityCredentialOptions.clientId || process.env.AZURE_CLIENT_ID;
+        this.federatedTokenFilePath =
+            workloadIdentityCredentialOptions.federatedTokenFilePath ||
+                process.env.AZURE_FEDERATED_TOKEN_FILE;
+        if (tenantId) {
+            checkTenantId(logger$g, tenantId);
         }
-        else {
-            // Keep track of any missing environment variables for error details
-            const assigned = processEnvVars(SupportedWorkloadEnvironmentVariables).assigned.join(", ");
-            logger$g.info(`Found the following environment variables: ${assigned}`);
-            const tenantId = process.env.AZURE_TENANT_ID, clientId = process.env.AZURE_CLIENT_ID, federatedTokenFilePath = process.env.AZURE_FEDERATED_TOKEN_FILE;
-            this.federatedTokenFilePath = federatedTokenFilePath;
-            if (tenantId) {
-                checkTenantId(logger$g, tenantId);
-            }
-            if (tenantId && clientId && federatedTokenFilePath) {
-                logger$g.info(`Invoking ClientAssertionCredential with the following environment variables tenant ID: ${tenantId}, clientId: ${clientId} and federatedTokenFilePath: [REDACTED]`);
-                this.client = new ClientAssertionCredential(tenantId, clientId, this.readFileContents.bind(this), options);
-            }
+        if (clientId && tenantId && this.federatedTokenFilePath) {
+            logger$g.info(`Invoking ClientAssertionCredential with tenant ID: ${tenantId}, clientId: ${workloadIdentityCredentialOptions.clientId} and federated token path: [REDACTED]`);
+            this.client = new ClientAssertionCredential(tenantId, clientId, this.readFileContents.bind(this), options);
         }
     }
     /**
@@ -2249,6 +2247,7 @@ class ManagedIdentityCredential {
     constructor(clientIdOrOptions, options) {
         var _a;
         this.isEndpointUnavailable = null;
+        this.isAppTokenProviderInitialized = false;
         let _options;
         if (typeof clientIdOrOptions === "string") {
             this.clientId = clientIdOrOptions;
@@ -2357,27 +2356,32 @@ class ManagedIdentityCredential {
                         scopes: Array.isArray(scopes) ? scopes : [scopes],
                         claims: options === null || options === void 0 ? void 0 : options.claims,
                     };
-                    this.confidentialApp.SetAppTokenProvider(async (appTokenProviderParameters = appTokenParameters) => {
-                        logger$c.info(`SetAppTokenProvider invoked with parameters- ${JSON.stringify(appTokenProviderParameters)}`);
-                        const resultToken = await this.authenticateManagedIdentity(scopes, Object.assign(Object.assign({}, updatedOptions), appTokenProviderParameters));
-                        if (resultToken) {
-                            logger$c.info(`SetAppTokenProvider has saved the token in cache`);
-                            const expiresInSeconds = (resultToken === null || resultToken === void 0 ? void 0 : resultToken.expiresOnTimestamp)
-                                ? Math.floor((resultToken.expiresOnTimestamp - Date.now()) / 1000)
-                                : 0;
-                            return {
-                                accessToken: resultToken === null || resultToken === void 0 ? void 0 : resultToken.token,
-                                expiresInSeconds,
-                            };
-                        }
-                        else {
-                            logger$c.info(`SetAppTokenProvider token has "no_access_token_returned" as the saved token`);
-                            return {
-                                accessToken: "no_access_token_returned",
-                                expiresInSeconds: 0,
-                            };
-                        }
-                    });
+                    // Added a check to see if SetAppTokenProvider was already defined.
+                    // Don't redefine it if it's already defined, since it should be static method.
+                    if (!this.isAppTokenProviderInitialized) {
+                        this.confidentialApp.SetAppTokenProvider(async (appTokenProviderParameters = appTokenParameters) => {
+                            logger$c.info(`SetAppTokenProvider invoked with parameters- ${JSON.stringify(appTokenProviderParameters)}`);
+                            const resultToken = await this.authenticateManagedIdentity(scopes, Object.assign(Object.assign({}, updatedOptions), appTokenProviderParameters));
+                            if (resultToken) {
+                                logger$c.info(`SetAppTokenProvider has saved the token in cache`);
+                                const expiresInSeconds = (resultToken === null || resultToken === void 0 ? void 0 : resultToken.expiresOnTimestamp)
+                                    ? Math.floor((resultToken.expiresOnTimestamp - Date.now()) / 1000)
+                                    : 0;
+                                return {
+                                    accessToken: resultToken === null || resultToken === void 0 ? void 0 : resultToken.token,
+                                    expiresInSeconds,
+                                };
+                            }
+                            else {
+                                logger$c.info(`SetAppTokenProvider token has "no_access_token_returned" as the saved token`);
+                                return {
+                                    accessToken: "no_access_token_returned",
+                                    expiresInSeconds: 0,
+                                };
+                            }
+                        });
+                        this.isAppTokenProviderInitialized = true;
+                    }
                     const authenticationResult = await this.confidentialApp.acquireTokenByClientCredential(Object.assign({}, appTokenParameters));
                     result = this.handleResult(scopes, authenticationResult || undefined);
                 }
@@ -2547,7 +2551,7 @@ const cliCredentialInternals = {
      * @param resource - The resource to use when getting the token
      * @internal
      */
-    async getAzureCliAccessToken(resource, tenantId) {
+    async getAzureCliAccessToken(resource, tenantId, timeout) {
         let tenantSection = [];
         if (tenantId) {
             tenantSection = ["--tenant", tenantId];
@@ -2562,7 +2566,7 @@ const cliCredentialInternals = {
                     "--resource",
                     resource,
                     ...tenantSection,
-                ], { cwd: cliCredentialInternals.getSafeWorkingDir(), shell: true }, (error, stdout, stderr) => {
+                ], { cwd: cliCredentialInternals.getSafeWorkingDir(), shell: true, timeout }, (error, stdout, stderr) => {
                     resolve({ stdout: stdout, stderr: stderr, error });
                 });
             }
@@ -2591,6 +2595,7 @@ class AzureCliCredential {
     constructor(options) {
         this.tenantId = options === null || options === void 0 ? void 0 : options.tenantId;
         this.additionallyAllowedTenantIds = resolveAddionallyAllowedTenantIds(options === null || options === void 0 ? void 0 : options.additionallyAllowedTenants);
+        this.timeout = options === null || options === void 0 ? void 0 : options.processTimeoutInMs;
     }
     /**
      * Authenticates with Azure Active Directory and returns an access token if successful.
@@ -2609,7 +2614,7 @@ class AzureCliCredential {
         return tracingClient.withSpan(`${this.constructor.name}.getToken`, options, async () => {
             var _a, _b, _c, _d;
             try {
-                const obj = await cliCredentialInternals.getAzureCliAccessToken(resource, tenantId);
+                const obj = await cliCredentialInternals.getAzureCliAccessToken(resource, tenantId, this.timeout);
                 const specificScope = (_a = obj.stderr) === null || _a === void 0 ? void 0 : _a.match("(.*)az login --scope(.*)");
                 const isLoginError = ((_b = obj.stderr) === null || _b === void 0 ? void 0 : _b.match("(.*)az login(.*)")) && !specificScope;
                 const isNotInstallError = ((_c = obj.stderr) === null || _c === void 0 ? void 0 : _c.match("az:(.*)not found")) || ((_d = obj.stderr) === null || _d === void 0 ? void 0 : _d.startsWith("'az' is not recognized"));
@@ -2702,11 +2707,14 @@ function formatCommand(commandName) {
  * If anything fails, an error is thrown.
  * @internal
  */
-async function runCommands(commands) {
+async function runCommands(commands, timeout) {
     const results = [];
     for (const command of commands) {
         const [file, ...parameters] = command;
-        const result = (await processUtils.execFile(file, parameters, { encoding: "utf8" }));
+        const result = (await processUtils.execFile(file, parameters, {
+            encoding: "utf8",
+            timeout,
+        }));
         results.push(result);
     }
     return results;
@@ -2761,16 +2769,17 @@ class AzurePowerShellCredential {
     constructor(options) {
         this.tenantId = options === null || options === void 0 ? void 0 : options.tenantId;
         this.additionallyAllowedTenantIds = resolveAddionallyAllowedTenantIds(options === null || options === void 0 ? void 0 : options.additionallyAllowedTenants);
+        this.timeout = options === null || options === void 0 ? void 0 : options.processTimeoutInMs;
     }
     /**
      * Gets the access token from Azure PowerShell
      * @param resource - The resource to use when getting the token
      */
-    async getAzurePowerShellAccessToken(resource, tenantId) {
+    async getAzurePowerShellAccessToken(resource, tenantId, timeout) {
         // Clone the stack to avoid mutating it while iterating
         for (const powerShellCommand of [...commandStack]) {
             try {
-                await runCommands([[powerShellCommand, "/?"]]);
+                await runCommands([[powerShellCommand, "/?"]], timeout);
             }
             catch (e) {
                 // Remove this credential from the original stack so that we don't try it again.
@@ -2818,7 +2827,7 @@ class AzurePowerShellCredential {
             logger$a.getToken.info(`Using the scope ${scope}`);
             const resource = getScopeResource(scope);
             try {
-                const response = await this.getAzurePowerShellAccessToken(resource, tenantId);
+                const response = await this.getAzurePowerShellAccessToken(resource, tenantId, this.timeout);
                 logger$a.getToken.info(formatSuccess(scopes));
                 return {
                     token: response.Token,
@@ -3376,7 +3385,7 @@ const developerCliCredentialInternals = {
      * @param scopes - The scopes to use when getting the token
      * @internal
      */
-    async getAzdAccessToken(scopes, tenantId) {
+    async getAzdAccessToken(scopes, tenantId, timeout) {
         let tenantSection = [];
         if (tenantId) {
             tenantSection = ["--tenant-id", tenantId];
@@ -3390,7 +3399,11 @@ const developerCliCredentialInternals = {
                     "json",
                     ...scopes.reduce((previous, current) => previous.concat("--scope", current), []),
                     ...tenantSection,
-                ], { cwd: developerCliCredentialInternals.getSafeWorkingDir(), shell: true }, (error, stdout, stderr) => {
+                ], {
+                    cwd: developerCliCredentialInternals.getSafeWorkingDir(),
+                    shell: true,
+                    timeout,
+                }, (error, stdout, stderr) => {
                     resolve({ stdout, stderr, error });
                 });
             }
@@ -3419,6 +3432,7 @@ class AzureDeveloperCliCredential {
     constructor(options) {
         this.tenantId = options === null || options === void 0 ? void 0 : options.tenantId;
         this.additionallyAllowedTenantIds = resolveAddionallyAllowedTenantIds(options === null || options === void 0 ? void 0 : options.additionallyAllowedTenants);
+        this.timeout = options === null || options === void 0 ? void 0 : options.processTimeoutInMs;
     }
     /**
      * Authenticates with Azure Active Directory and returns an access token if successful.
@@ -3441,7 +3455,7 @@ class AzureDeveloperCliCredential {
         return tracingClient.withSpan(`${this.constructor.name}.getToken`, options, async () => {
             var _a, _b, _c;
             try {
-                const obj = await developerCliCredentialInternals.getAzdAccessToken(scopeList, tenantId);
+                const obj = await developerCliCredentialInternals.getAzdAccessToken(scopeList, tenantId, this.timeout);
                 const isNotLoggedInError = (_a = obj.stderr) === null || _a === void 0 ? void 0 : _a.match("not logged in, run `azd login` to login");
                 const isNotInstallError = ((_b = obj.stderr) === null || _b === void 0 ? void 0 : _b.match("azd:(.*)not found")) ||
                     ((_c = obj.stderr) === null || _c === void 0 ? void 0 : _c.startsWith("'azd' is not recognized"));
@@ -3516,13 +3530,56 @@ class DefaultManagedIdentityCredential extends ManagedIdentityCredential {
         }
     }
 }
+/**
+ * A shim around WorkloadIdentityCredential that adapts it to accept
+ * `DefaultAzureCredentialOptions`.
+ *
+ * @internal
+ */
+class DefaultWorkloadIdentityCredential extends WorkloadIdentityCredential {
+    // Constructor overload with just the other default options
+    // Last constructor overload with Union of all options not required since the above two constructor overloads have optional properties
+    constructor(options) {
+        var _a, _b, _c;
+        const managedIdentityClientId = (_a = options === null || options === void 0 ? void 0 : options.managedIdentityClientId) !== null && _a !== void 0 ? _a : process.env.AZURE_CLIENT_ID;
+        const workloadIdentityClientId = (_b = options === null || options === void 0 ? void 0 : options.workloadIdentityClientId) !== null && _b !== void 0 ? _b : managedIdentityClientId;
+        const workloadFile = process.env.AZURE_FEDERATED_TOKEN_FILE;
+        const tenantId = (_c = options === null || options === void 0 ? void 0 : options.tenantId) !== null && _c !== void 0 ? _c : process.env.AZURE_TENANT_ID;
+        if (workloadFile && workloadIdentityClientId) {
+            const workloadIdentityCredentialOptions = Object.assign(Object.assign({}, options), { tenantId, clientId: workloadIdentityClientId, federatedTokenFilePath: workloadFile });
+            super(workloadIdentityCredentialOptions);
+        }
+        else if (tenantId) {
+            const workloadIdentityClientTenantOptions = Object.assign(Object.assign({}, options), { tenantId });
+            super(workloadIdentityClientTenantOptions);
+        }
+        else {
+            super(options);
+        }
+    }
+}
+class DefaultAzureDeveloperCliCredential extends AzureDeveloperCliCredential {
+    constructor(options) {
+        super(Object.assign({ processTimeoutInMs: options === null || options === void 0 ? void 0 : options.developerCredentialTimeOutInMs }, options));
+    }
+}
+class DefaultAzureCliCredential extends AzureCliCredential {
+    constructor(options) {
+        super(Object.assign({ processTimeoutInMs: options === null || options === void 0 ? void 0 : options.developerCredentialTimeOutInMs }, options));
+    }
+}
+class DefaultAzurePowershellCredential extends AzurePowerShellCredential {
+    constructor(options) {
+        super(Object.assign({ processTimeoutInMs: options === null || options === void 0 ? void 0 : options.developerCredentialTimeOutInMs }, options));
+    }
+}
 const defaultCredentials = [
     EnvironmentCredential,
-    WorkloadIdentityCredential,
+    DefaultWorkloadIdentityCredential,
     DefaultManagedIdentityCredential,
-    AzureDeveloperCliCredential,
-    AzureCliCredential,
-    AzurePowerShellCredential,
+    DefaultAzureDeveloperCliCredential,
+    DefaultAzureCliCredential,
+    DefaultAzurePowershellCredential,
 ];
 /**
  * Provides a default {@link ChainedTokenCredential} configuration that should
@@ -4073,6 +4130,7 @@ exports.AuthenticationErrorName = AuthenticationErrorName;
 exports.AuthenticationRequiredError = AuthenticationRequiredError;
 exports.AuthorizationCodeCredential = AuthorizationCodeCredential;
 exports.AzureCliCredential = AzureCliCredential;
+exports.AzureDeveloperCliCredential = AzureDeveloperCliCredential;
 exports.AzurePowerShellCredential = AzurePowerShellCredential;
 exports.ChainedTokenCredential = ChainedTokenCredential;
 exports.ClientAssertionCredential = ClientAssertionCredential;