mirror of
https://github.com/tvytlx/ai-agent-deep-dive.git
synced 2026-04-06 00:54:49 +08:00
60 lines
3.5 KiB
JavaScript
60 lines
3.5 KiB
JavaScript
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT License.
|
|
import { createMsalClient } from "../msal/nodeFlows/msalClient.js";
|
|
import { processMultiTenantRequest, resolveAdditionallyAllowedTenantIds, } from "../util/tenantIdUtils.js";
|
|
import { CredentialUnavailableError } from "../errors.js";
|
|
import { credentialLogger } from "../util/logging.js";
|
|
import { ensureScopes } from "../util/scopeUtils.js";
|
|
import { tracingClient } from "../util/tracing.js";
|
|
const logger = credentialLogger("ClientSecretCredential");
|
|
/**
|
|
* Enables authentication to Microsoft Entra ID using a client secret
|
|
* that was generated for an App Registration. More information on how
|
|
* to configure a client secret can be found here:
|
|
*
|
|
* https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
|
|
*
|
|
*/
|
|
export class ClientSecretCredential {
|
|
/**
|
|
* Creates an instance of the ClientSecretCredential with the details
|
|
* needed to authenticate against Microsoft Entra ID with a client
|
|
* secret.
|
|
*
|
|
* @param tenantId - The Microsoft Entra tenant (directory) ID.
|
|
* @param clientId - The client (application) ID of an App Registration in the tenant.
|
|
* @param clientSecret - A client secret that was generated for the App Registration.
|
|
* @param options - Options for configuring the client which makes the authentication request.
|
|
*/
|
|
constructor(tenantId, clientId, clientSecret, options = {}) {
|
|
if (!tenantId) {
|
|
throw new CredentialUnavailableError("ClientSecretCredential: tenantId is a required parameter. To troubleshoot, visit https://aka.ms/azsdk/js/identity/serviceprincipalauthentication/troubleshoot.");
|
|
}
|
|
if (!clientId) {
|
|
throw new CredentialUnavailableError("ClientSecretCredential: clientId is a required parameter. To troubleshoot, visit https://aka.ms/azsdk/js/identity/serviceprincipalauthentication/troubleshoot.");
|
|
}
|
|
if (!clientSecret) {
|
|
throw new CredentialUnavailableError("ClientSecretCredential: clientSecret is a required parameter. To troubleshoot, visit https://aka.ms/azsdk/js/identity/serviceprincipalauthentication/troubleshoot.");
|
|
}
|
|
this.clientSecret = clientSecret;
|
|
this.tenantId = tenantId;
|
|
this.additionallyAllowedTenantIds = resolveAdditionallyAllowedTenantIds(options === null || options === void 0 ? void 0 : options.additionallyAllowedTenants);
|
|
this.msalClient = createMsalClient(clientId, tenantId, Object.assign(Object.assign({}, 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 tracingClient.withSpan(`${this.constructor.name}.getToken`, options, async (newOptions) => {
|
|
newOptions.tenantId = processMultiTenantRequest(this.tenantId, newOptions, this.additionallyAllowedTenantIds, logger);
|
|
const arrayScopes = ensureScopes(scopes);
|
|
return this.msalClient.getTokenByClientSecret(arrayScopes, this.clientSecret, newOptions);
|
|
});
|
|
}
|
|
}
|
|
//# sourceMappingURL=clientSecretCredential.js.map
|