@azure/identity
Version:
Provides credential implementations for Azure SDK libraries that can authenticate with Microsoft Entra ID
149 lines (148 loc) • 6.48 kB
JavaScript
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
var clientCertificateCredential_exports = {};
__export(clientCertificateCredential_exports, {
ClientCertificateCredential: () => ClientCertificateCredential,
parseCertificate: () => parseCertificate
});
module.exports = __toCommonJS(clientCertificateCredential_exports);
var import_msalClient = require("../msal/nodeFlows/msalClient.js");
var import_node_crypto = require("node:crypto");
var import_tenantIdUtils = require("../util/tenantIdUtils.js");
var import_logging = require("../util/logging.js");
var import_promises = require("node:fs/promises");
var import_tracing = require("../util/tracing.js");
const credentialName = "ClientCertificateCredential";
const logger = (0, import_logging.credentialLogger)(credentialName);
class ClientCertificateCredential {
tenantId;
additionallyAllowedTenantIds;
certificateConfiguration;
sendCertificateChain;
msalClient;
constructor(tenantId, clientId, certificatePathOrConfiguration, options = {}) {
if (!tenantId || !clientId) {
throw new Error(`${credentialName}: tenantId and clientId are required parameters.`);
}
this.tenantId = tenantId;
this.additionallyAllowedTenantIds = (0, import_tenantIdUtils.resolveAdditionallyAllowedTenantIds)(
options?.additionallyAllowedTenants
);
this.sendCertificateChain = options.sendCertificateChain;
this.certificateConfiguration = {
...typeof certificatePathOrConfiguration === "string" ? {
certificatePath: certificatePathOrConfiguration
} : certificatePathOrConfiguration
};
const certificate = this.certificateConfiguration.certificate;
const certificatePath = this.certificateConfiguration.certificatePath;
if (!this.certificateConfiguration || !(certificate || certificatePath)) {
throw new Error(
`${credentialName}: Provide either a PEM certificate in string form, or the path to that certificate in the filesystem. To troubleshoot, visit https://aka.ms/azsdk/js/identity/serviceprincipalauthentication/troubleshoot.`
);
}
if (certificate && certificatePath) {
throw new Error(
`${credentialName}: To avoid unexpected behaviors, providing both the contents of a PEM certificate and the path to a PEM certificate is forbidden. To troubleshoot, visit https://aka.ms/azsdk/js/identity/serviceprincipalauthentication/troubleshoot.`
);
}
this.msalClient = (0, import_msalClient.createMsalClient)(clientId, tenantId, {
...options,
logger,
tokenCredentialOptions: options
});
}
/**
* 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 = {}) {
return import_tracing.tracingClient.withSpan(`${credentialName}.getToken`, options, async (newOptions) => {
newOptions.tenantId = (0, import_tenantIdUtils.processMultiTenantRequest)(
this.tenantId,
newOptions,
this.additionallyAllowedTenantIds,
logger
);
const arrayScopes = Array.isArray(scopes) ? scopes : [scopes];
const certificate = await this.buildClientCertificate();
return this.msalClient.getTokenByClientCertificate(arrayScopes, certificate, newOptions);
});
}
async buildClientCertificate() {
const parts = await parseCertificate(
this.certificateConfiguration,
this.sendCertificateChain ?? false
);
let privateKey;
if (this.certificateConfiguration.certificatePassword !== void 0) {
privateKey = (0, import_node_crypto.createPrivateKey)({
key: parts.certificateContents,
passphrase: this.certificateConfiguration.certificatePassword,
format: "pem"
}).export({
format: "pem",
type: "pkcs8"
}).toString();
} else {
privateKey = parts.certificateContents;
}
return {
thumbprint: parts.thumbprint,
thumbprintSha256: parts.thumbprintSha256,
privateKey,
x5c: parts.x5c
};
}
}
async function parseCertificate(certificateConfiguration, sendCertificateChain) {
const certificate = certificateConfiguration.certificate;
const certificatePath = certificateConfiguration.certificatePath;
const certificateContents = certificate || await (0, import_promises.readFile)(certificatePath, "utf8");
const x5c = sendCertificateChain ? certificateContents : void 0;
const certificatePattern = /(-+BEGIN CERTIFICATE-+)(\n\r?|\r\n?)([A-Za-z0-9+/\n\r]+=*)(\n\r?|\r\n?)(-+END CERTIFICATE-+)/g;
const publicKeys = [];
let match;
do {
match = certificatePattern.exec(certificateContents);
if (match) {
publicKeys.push(match[3]);
}
} while (match);
if (publicKeys.length === 0) {
throw new Error("The file at the specified path does not contain a PEM-encoded certificate.");
}
const thumbprint = (0, import_node_crypto.createHash)("sha1").update(Buffer.from(publicKeys[0], "base64")).digest("hex").toUpperCase();
const thumbprintSha256 = (0, import_node_crypto.createHash)("sha256").update(Buffer.from(publicKeys[0], "base64")).digest("hex").toUpperCase();
return {
certificateContents,
thumbprintSha256,
thumbprint,
x5c
};
}
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
ClientCertificateCredential,
parseCertificate
});
//# sourceMappingURL=clientCertificateCredential.js.map