"use strict";
|
// Copyright (c) Microsoft Corporation.
|
// Licensed under the MIT License.
|
Object.defineProperty(exports, "__esModule", { value: true });
|
exports.AzureCliCredential = exports.cliCredentialInternals = exports.azureCliPublicErrorMessages = void 0;
|
const tslib_1 = require("tslib");
|
const tenantIdUtils_js_1 = require("../util/tenantIdUtils.js");
|
const logging_js_1 = require("../util/logging.js");
|
const scopeUtils_js_1 = require("../util/scopeUtils.js");
|
const errors_js_1 = require("../errors.js");
|
const child_process_1 = tslib_1.__importDefault(require("child_process"));
|
const tracing_js_1 = require("../util/tracing.js");
|
const subscriptionUtils_js_1 = require("../util/subscriptionUtils.js");
|
const logger = (0, logging_js_1.credentialLogger)("AzureCliCredential");
|
/**
|
* Messages to use when throwing in this credential.
|
* @internal
|
*/
|
exports.azureCliPublicErrorMessages = {
|
claim: "This credential doesn't support claims challenges. To authenticate with the required claims, please run the following command:",
|
notInstalled: "Azure CLI could not be found. Please visit https://aka.ms/azure-cli for installation instructions and then, once installed, authenticate to your Azure account using 'az login'.",
|
login: "Please run 'az login' from a command prompt to authenticate before using this credential.",
|
unknown: "Unknown error while trying to retrieve the access token",
|
unexpectedResponse: 'Unexpected response from Azure CLI when getting token. Expected "expiresOn" to be a RFC3339 date string. Got:',
|
};
|
/**
|
* Mockable reference to the CLI credential cliCredentialFunctions
|
* @internal
|
*/
|
exports.cliCredentialInternals = {
|
/**
|
* @internal
|
*/
|
getSafeWorkingDir() {
|
if (process.platform === "win32") {
|
let systemRoot = process.env.SystemRoot || process.env["SYSTEMROOT"];
|
if (!systemRoot) {
|
logger.getToken.warning("The SystemRoot environment variable is not set. This may cause issues when using the Azure CLI credential.");
|
systemRoot = "C:\\Windows";
|
}
|
return systemRoot;
|
}
|
else {
|
return "/bin";
|
}
|
},
|
/**
|
* Gets the access token from Azure CLI
|
* @param resource - The resource to use when getting the token
|
* @internal
|
*/
|
async getAzureCliAccessToken(resource, tenantId, subscription, timeout) {
|
let tenantSection = [];
|
let subscriptionSection = [];
|
if (tenantId) {
|
tenantSection = ["--tenant", tenantId];
|
}
|
if (subscription) {
|
// Add quotes around the subscription to handle subscriptions with spaces
|
subscriptionSection = ["--subscription", `"${subscription}"`];
|
}
|
return new Promise((resolve, reject) => {
|
try {
|
const args = [
|
"account",
|
"get-access-token",
|
"--output",
|
"json",
|
"--resource",
|
resource,
|
...tenantSection,
|
...subscriptionSection,
|
];
|
const command = ["az", ...args].join(" ");
|
child_process_1.default.exec(command, { cwd: exports.cliCredentialInternals.getSafeWorkingDir(), timeout }, (error, stdout, stderr) => {
|
resolve({ stdout: stdout, stderr: stderr, error });
|
});
|
}
|
catch (err) {
|
reject(err);
|
}
|
});
|
},
|
};
|
/**
|
* This credential will use the currently logged-in user login information
|
* via the Azure CLI ('az') commandline tool.
|
* To do so, it will read the user access token and expire time
|
* with Azure CLI command "az account get-access-token".
|
*/
|
class AzureCliCredential {
|
tenantId;
|
additionallyAllowedTenantIds;
|
timeout;
|
subscription;
|
/**
|
* Creates an instance of the {@link AzureCliCredential}.
|
*
|
* To use this credential, ensure that you have already logged
|
* in via the 'az' tool using the command "az login" from the commandline.
|
*
|
* @param options - Options, to optionally allow multi-tenant requests.
|
*/
|
constructor(options) {
|
if (options?.tenantId) {
|
(0, tenantIdUtils_js_1.checkTenantId)(logger, options?.tenantId);
|
this.tenantId = options?.tenantId;
|
}
|
if (options?.subscription) {
|
(0, subscriptionUtils_js_1.checkSubscription)(logger, options?.subscription);
|
this.subscription = options?.subscription;
|
}
|
this.additionallyAllowedTenantIds = (0, tenantIdUtils_js_1.resolveAdditionallyAllowedTenantIds)(options?.additionallyAllowedTenants);
|
this.timeout = options?.processTimeoutInMs;
|
}
|
/**
|
* Authenticates with Microsoft Entra ID and returns an access token if successful.
|
* If authentication fails, a {@link CredentialUnavailableError} will be thrown with the details of the failure.
|
*
|
* @param scopes - The list of scopes for which the token will have access.
|
* @param options - The options used to configure any requests this
|
* TokenCredential implementation might make.
|
*/
|
async getToken(scopes, options = {}) {
|
const scope = typeof scopes === "string" ? scopes : scopes[0];
|
const claimsValue = options.claims;
|
if (claimsValue && claimsValue.trim()) {
|
const encodedClaims = btoa(claimsValue);
|
let loginCmd = `az login --claims-challenge ${encodedClaims} --scope ${scope}`;
|
const tenantIdFromOptions = options.tenantId;
|
if (tenantIdFromOptions) {
|
loginCmd += ` --tenant ${tenantIdFromOptions}`;
|
}
|
const error = new errors_js_1.CredentialUnavailableError(`${exports.azureCliPublicErrorMessages.claim} ${loginCmd}`);
|
logger.getToken.info((0, logging_js_1.formatError)(scope, error));
|
throw error;
|
}
|
const tenantId = (0, tenantIdUtils_js_1.processMultiTenantRequest)(this.tenantId, options, this.additionallyAllowedTenantIds);
|
if (tenantId) {
|
(0, tenantIdUtils_js_1.checkTenantId)(logger, tenantId);
|
}
|
if (this.subscription) {
|
(0, subscriptionUtils_js_1.checkSubscription)(logger, this.subscription);
|
}
|
logger.getToken.info(`Using the scope ${scope}`);
|
return tracing_js_1.tracingClient.withSpan(`${this.constructor.name}.getToken`, options, async () => {
|
try {
|
(0, scopeUtils_js_1.ensureValidScopeForDevTimeCreds)(scope, logger);
|
const resource = (0, scopeUtils_js_1.getScopeResource)(scope);
|
const obj = await exports.cliCredentialInternals.getAzureCliAccessToken(resource, tenantId, this.subscription, this.timeout);
|
const specificScope = obj.stderr?.match("(.*)az login --scope(.*)");
|
const isLoginError = obj.stderr?.match("(.*)az login(.*)") && !specificScope;
|
const isNotInstallError = obj.stderr?.match("az:(.*)not found") || obj.stderr?.startsWith("'az' is not recognized");
|
if (isNotInstallError) {
|
const error = new errors_js_1.CredentialUnavailableError(exports.azureCliPublicErrorMessages.notInstalled);
|
logger.getToken.info((0, logging_js_1.formatError)(scopes, error));
|
throw error;
|
}
|
if (isLoginError) {
|
const error = new errors_js_1.CredentialUnavailableError(exports.azureCliPublicErrorMessages.login);
|
logger.getToken.info((0, logging_js_1.formatError)(scopes, error));
|
throw error;
|
}
|
try {
|
const responseData = obj.stdout;
|
const response = this.parseRawResponse(responseData);
|
logger.getToken.info((0, logging_js_1.formatSuccess)(scopes));
|
return response;
|
}
|
catch (e) {
|
if (obj.stderr) {
|
throw new errors_js_1.CredentialUnavailableError(obj.stderr);
|
}
|
throw e;
|
}
|
}
|
catch (err) {
|
const error = err.name === "CredentialUnavailableError"
|
? err
|
: new errors_js_1.CredentialUnavailableError(err.message || exports.azureCliPublicErrorMessages.unknown);
|
logger.getToken.info((0, logging_js_1.formatError)(scopes, error));
|
throw error;
|
}
|
});
|
}
|
/**
|
* Parses the raw JSON response from the Azure CLI into a usable AccessToken object
|
*
|
* @param rawResponse - The raw JSON response from the Azure CLI
|
* @returns An access token with the expiry time parsed from the raw response
|
*
|
* The expiryTime of the credential's access token, in milliseconds, is calculated as follows:
|
*
|
* When available, expires_on (introduced in Azure CLI v2.54.0) will be preferred. Otherwise falls back to expiresOn.
|
*/
|
parseRawResponse(rawResponse) {
|
const response = JSON.parse(rawResponse);
|
const token = response.accessToken;
|
// if available, expires_on will be a number representing seconds since epoch.
|
// ensure it's a number or NaN
|
let expiresOnTimestamp = Number.parseInt(response.expires_on, 10) * 1000;
|
if (!isNaN(expiresOnTimestamp)) {
|
logger.getToken.info("expires_on is available and is valid, using it");
|
return {
|
token,
|
expiresOnTimestamp,
|
tokenType: "Bearer",
|
};
|
}
|
// fallback to the older expiresOn - an RFC3339 date string
|
expiresOnTimestamp = new Date(response.expiresOn).getTime();
|
// ensure expiresOn is well-formatted
|
if (isNaN(expiresOnTimestamp)) {
|
throw new errors_js_1.CredentialUnavailableError(`${exports.azureCliPublicErrorMessages.unexpectedResponse} "${response.expiresOn}"`);
|
}
|
return {
|
token,
|
expiresOnTimestamp,
|
tokenType: "Bearer",
|
};
|
}
|
}
|
exports.AzureCliCredential = AzureCliCredential;
|
//# sourceMappingURL=azureCliCredential.js.map
|
