// Copyright (c) Microsoft Corporation.
|
// Licensed under the MIT License.
|
import { CACHE_CAE_SUFFIX, CACHE_NON_CAE_SUFFIX, DEFAULT_TOKEN_CACHE_NAME, } from "../../constants.js";
|
/**
|
* The current persistence provider, undefined by default.
|
* @internal
|
*/
|
export let persistenceProvider = undefined;
|
/**
|
* An object that allows setting the persistence provider.
|
* @internal
|
*/
|
export const msalNodeFlowCacheControl = {
|
setPersistence(pluginProvider) {
|
persistenceProvider = pluginProvider;
|
},
|
};
|
/**
|
* The current native broker provider, undefined by default.
|
* @internal
|
*/
|
export let nativeBrokerInfo = undefined;
|
/**
|
* The current VSCode auth record path, undefined by default.
|
* @internal
|
*/
|
export let vsCodeAuthRecordPath = undefined;
|
/**
|
* The current VSCode broker, undefined by default.
|
* @internal
|
*/
|
export let vsCodeBrokerInfo = undefined;
|
export function hasNativeBroker() {
|
return nativeBrokerInfo !== undefined;
|
}
|
export function hasVSCodePlugin() {
|
return vsCodeAuthRecordPath !== undefined && vsCodeBrokerInfo !== undefined;
|
}
|
/**
|
* An object that allows setting the native broker provider.
|
* @internal
|
*/
|
export const msalNodeFlowNativeBrokerControl = {
|
setNativeBroker(broker) {
|
nativeBrokerInfo = {
|
broker,
|
};
|
},
|
};
|
/**
|
* An object that allows setting the VSCode credential auth record path and broker.
|
* @internal
|
*/
|
export const msalNodeFlowVSCodeCredentialControl = {
|
setVSCodeAuthRecordPath(path) {
|
vsCodeAuthRecordPath = path;
|
},
|
setVSCodeBroker(broker) {
|
vsCodeBrokerInfo = {
|
broker,
|
};
|
},
|
};
|
/**
|
* Configures plugins, validating that required plugins are available and enabled.
|
*
|
* Does not create the plugins themselves, but rather returns the configuration that will be used to create them.
|
*
|
* @param options - options for creating the MSAL client
|
* @returns plugin configuration
|
*/
|
function generatePluginConfiguration(options) {
|
const config = {
|
cache: {},
|
broker: {
|
...options.brokerOptions,
|
isEnabled: options.brokerOptions?.enabled ?? false,
|
enableMsaPassthrough: options.brokerOptions?.legacyEnableMsaPassthrough ?? false,
|
},
|
};
|
if (options.tokenCachePersistenceOptions?.enabled) {
|
if (persistenceProvider === undefined) {
|
throw new Error([
|
"Persistent token caching was requested, but no persistence provider was configured.",
|
"You must install the identity-cache-persistence plugin package (`npm install --save @azure/identity-cache-persistence`)",
|
"and enable it by importing `useIdentityPlugin` from `@azure/identity` and calling",
|
"`useIdentityPlugin(cachePersistencePlugin)` before using `tokenCachePersistenceOptions`.",
|
].join(" "));
|
}
|
const cacheBaseName = options.tokenCachePersistenceOptions.name || DEFAULT_TOKEN_CACHE_NAME;
|
config.cache.cachePlugin = persistenceProvider({
|
name: `${cacheBaseName}.${CACHE_NON_CAE_SUFFIX}`,
|
...options.tokenCachePersistenceOptions,
|
});
|
config.cache.cachePluginCae = persistenceProvider({
|
name: `${cacheBaseName}.${CACHE_CAE_SUFFIX}`,
|
...options.tokenCachePersistenceOptions,
|
});
|
}
|
if (options.brokerOptions?.enabled) {
|
config.broker.nativeBrokerPlugin = getBrokerPlugin(options.isVSCodeCredential || false);
|
}
|
return config;
|
}
|
// Broker error message templates with variables for credential and package names
|
const brokerErrorTemplates = {
|
missing: (credentialName, packageName, pluginVar) => [
|
`${credentialName} was requested, but no plugin was configured or no authentication record was found.`,
|
`You must install the ${packageName} plugin package (npm install --save ${packageName})`,
|
"and enable it by importing `useIdentityPlugin` from `@azure/identity` and calling",
|
`useIdentityPlugin(${pluginVar}) before using enableBroker.`,
|
].join(" "),
|
unavailable: (credentialName, packageName) => [
|
`${credentialName} was requested, and the plugin is configured, but the broker is unavailable.`,
|
`Ensure the ${credentialName} plugin is properly installed and configured.`,
|
"Check for missing native dependencies and ensure the package is properly installed.",
|
`See the README for prerequisites on installing and using ${packageName}.`,
|
].join(" "),
|
};
|
// Values for VSCode and native broker configurations for error message
|
const brokerConfig = {
|
vsCode: {
|
credentialName: "Visual Studio Code Credential",
|
packageName: "@azure/identity-vscode",
|
pluginVar: "vsCodePlugin",
|
get brokerInfo() {
|
return vsCodeBrokerInfo;
|
},
|
},
|
native: {
|
credentialName: "Broker for WAM",
|
packageName: "@azure/identity-broker",
|
pluginVar: "nativeBrokerPlugin",
|
get brokerInfo() {
|
return nativeBrokerInfo;
|
},
|
},
|
};
|
/**
|
* Set appropriate broker plugin based on whether VSCode or native broker is requested.
|
* @param isVSCodePlugin - true for VSCode broker, false for native broker
|
* @returns the broker plugin if available
|
*/
|
function getBrokerPlugin(isVSCodePlugin) {
|
const { credentialName, packageName, pluginVar, brokerInfo } = brokerConfig[isVSCodePlugin ? "vsCode" : "native"];
|
if (brokerInfo === undefined) {
|
throw new Error(brokerErrorTemplates.missing(credentialName, packageName, pluginVar));
|
}
|
if (brokerInfo.broker.isBrokerAvailable === false) {
|
throw new Error(brokerErrorTemplates.unavailable(credentialName, packageName));
|
}
|
return brokerInfo.broker;
|
}
|
/**
|
* Wraps generatePluginConfiguration as a writeable property for test stubbing purposes.
|
*/
|
export const msalPlugins = {
|
generatePluginConfiguration,
|
};
|
//# sourceMappingURL=msalPlugins.js.map
|
