/*! @azure/msal-common v16.5.0 2026-04-16 */
|
'use strict';
|
import { CredentialType, AuthenticationScheme, THE_FAMILY_ID, APP_METADATA, AUTHORITY_METADATA_CACHE_KEY } from '../utils/Constants.mjs';
|
import { ScopeSet } from '../request/ScopeSet.mjs';
|
import { createClientAuthError } from '../error/ClientAuthError.mjs';
|
import { updateAccountTenantProfileData } from '../account/AccountInfo.mjs';
|
import { extractTokenClaims } from '../account/AuthToken.mjs';
|
import { name, version } from '../packageMetadata.mjs';
|
import { getAliasesFromStaticSources } from '../authority/AuthorityMetadata.mjs';
|
import { createCacheError } from '../error/CacheError.mjs';
|
import { getAccountInfo } from './utils/AccountEntityUtils.mjs';
|
import { AuthError } from '../error/AuthError.mjs';
|
import { invalidCacheRecord, multipleMatchingAppMetadata, methodNotImplemented } from '../error/ClientAuthErrorCodes.mjs';
|
|
/*
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
* Licensed under the MIT License.
|
*/
|
/**
|
* Interface class which implement cache storage functions used by MSAL to perform validity checks, and store tokens.
|
* @internal
|
*/
|
class CacheManager {
|
constructor(clientId, cryptoImpl, logger, performanceClient, staticAuthorityOptions) {
|
this.clientId = clientId;
|
this.cryptoImpl = cryptoImpl;
|
this.commonLogger = logger.clone(name, version);
|
this.staticAuthorityOptions = staticAuthorityOptions;
|
this.performanceClient = performanceClient;
|
}
|
/**
|
* Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.
|
* @param accountFilter - (Optional) filter to narrow down the accounts returned
|
* @returns Array of AccountInfo objects in cache
|
*/
|
getAllAccounts(accountFilter = {}, correlationId) {
|
return this.buildTenantProfiles(this.getAccountsFilteredBy(accountFilter, correlationId), correlationId, accountFilter);
|
}
|
/**
|
* Gets first tenanted AccountInfo object found based on provided filters
|
*/
|
getAccountInfoFilteredBy(accountFilter, correlationId) {
|
if (Object.keys(accountFilter).length === 0 ||
|
Object.values(accountFilter).every((value) => value === null || value === undefined || value === "")) {
|
this.commonLogger.warning("getAccountInfoFilteredBy: Account filter is empty or invalid, returning null", correlationId);
|
return null;
|
}
|
const allAccounts = this.getAllAccounts(accountFilter, correlationId);
|
if (allAccounts.length > 1) {
|
// If one or more accounts are found, prioritize accounts that have an ID token
|
const sortedAccounts = allAccounts.sort((account) => {
|
return account.idTokenClaims ? -1 : 1;
|
});
|
return sortedAccounts[0];
|
}
|
else if (allAccounts.length === 1) {
|
// If only one account is found, return it regardless of whether a matching ID token was found
|
return allAccounts[0];
|
}
|
else {
|
return null;
|
}
|
}
|
/**
|
* Returns a single matching
|
* @param accountFilter
|
* @returns
|
*/
|
getBaseAccountInfo(accountFilter, correlationId) {
|
const accountEntities = this.getAccountsFilteredBy(accountFilter, correlationId);
|
if (accountEntities.length > 0) {
|
return getAccountInfo(accountEntities[0]);
|
}
|
else {
|
return null;
|
}
|
}
|
/**
|
* Matches filtered account entities with cached ID tokens that match the tenant profile-specific account filters
|
* and builds the account info objects from the matching ID token's claims
|
* @param cachedAccounts
|
* @param accountFilter
|
* @returns Array of AccountInfo objects that match account and tenant profile filters
|
*/
|
buildTenantProfiles(cachedAccounts, correlationId, accountFilter) {
|
return cachedAccounts.flatMap((accountEntity) => {
|
return this.getTenantProfilesFromAccountEntity(accountEntity, correlationId, accountFilter?.tenantId, accountFilter);
|
});
|
}
|
getTenantedAccountInfoByFilter(accountInfo, tokenKeys, tenantProfile, correlationId, tenantProfileFilter) {
|
let tenantedAccountInfo = null;
|
let idTokenClaims;
|
if (tenantProfileFilter) {
|
if (!this.tenantProfileMatchesFilter(tenantProfile, tenantProfileFilter)) {
|
return null;
|
}
|
}
|
const idToken = this.getIdToken(accountInfo, correlationId, tokenKeys, tenantProfile.tenantId);
|
if (idToken) {
|
idTokenClaims = extractTokenClaims(idToken.secret, this.cryptoImpl.base64Decode);
|
if (!this.idTokenClaimsMatchTenantProfileFilter(idTokenClaims, tenantProfileFilter)) {
|
// ID token sourced claims don't match so this tenant profile is not a match
|
return null;
|
}
|
}
|
// Expand tenant profile into account info based on matching tenant profile and if available matching ID token claims
|
tenantedAccountInfo = updateAccountTenantProfileData(accountInfo, tenantProfile, idTokenClaims, idToken?.secret);
|
return tenantedAccountInfo;
|
}
|
getTenantProfilesFromAccountEntity(accountEntity, correlationId, targetTenantId, tenantProfileFilter) {
|
const accountInfo = getAccountInfo(accountEntity);
|
let searchTenantProfiles = accountInfo.tenantProfiles || new Map();
|
const tokenKeys = this.getTokenKeys();
|
// If a tenant ID was provided, only return the tenant profile for that tenant ID if it exists
|
if (targetTenantId) {
|
const tenantProfile = searchTenantProfiles.get(targetTenantId);
|
if (tenantProfile) {
|
// Reduce search field to just this tenant profile
|
searchTenantProfiles = new Map([
|
[targetTenantId, tenantProfile],
|
]);
|
}
|
else {
|
// No tenant profile for search tenant ID, return empty array
|
return [];
|
}
|
}
|
const matchingTenantProfiles = [];
|
searchTenantProfiles.forEach((tenantProfile) => {
|
const tenantedAccountInfo = this.getTenantedAccountInfoByFilter(accountInfo, tokenKeys, tenantProfile, correlationId, tenantProfileFilter);
|
if (tenantedAccountInfo) {
|
matchingTenantProfiles.push(tenantedAccountInfo);
|
}
|
});
|
return matchingTenantProfiles;
|
}
|
tenantProfileMatchesFilter(tenantProfile, tenantProfileFilter) {
|
if (!!tenantProfileFilter.localAccountId &&
|
!this.matchLocalAccountIdFromTenantProfile(tenantProfile, tenantProfileFilter.localAccountId)) {
|
return false;
|
}
|
if (!!tenantProfileFilter.name &&
|
!(tenantProfile.name === tenantProfileFilter.name)) {
|
return false;
|
}
|
if (tenantProfileFilter.isHomeTenant !== undefined &&
|
!(tenantProfile.isHomeTenant === tenantProfileFilter.isHomeTenant)) {
|
return false;
|
}
|
return true;
|
}
|
idTokenClaimsMatchTenantProfileFilter(idTokenClaims, tenantProfileFilter) {
|
// Tenant Profile filtering
|
if (tenantProfileFilter) {
|
if (!!tenantProfileFilter.localAccountId &&
|
!this.matchLocalAccountIdFromTokenClaims(idTokenClaims, tenantProfileFilter.localAccountId)) {
|
return false;
|
}
|
if (!!tenantProfileFilter.loginHint &&
|
!this.matchLoginHintFromTokenClaims(idTokenClaims, tenantProfileFilter.loginHint)) {
|
return false;
|
}
|
if (!!tenantProfileFilter.username &&
|
!this.matchUsername(idTokenClaims.preferred_username, tenantProfileFilter.username)) {
|
return false;
|
}
|
if (!!tenantProfileFilter.name &&
|
!this.matchName(idTokenClaims, tenantProfileFilter.name)) {
|
return false;
|
}
|
if (!!tenantProfileFilter.sid &&
|
!this.matchSid(idTokenClaims, tenantProfileFilter.sid)) {
|
return false;
|
}
|
}
|
return true;
|
}
|
/**
|
* saves a cache record
|
* @param cacheRecord {CacheRecord}
|
* @param storeInCache {?StoreInCache}
|
* @param correlationId {?string} correlation id
|
*/
|
async saveCacheRecord(cacheRecord, correlationId, kmsi, apiId, storeInCache) {
|
if (!cacheRecord) {
|
throw createClientAuthError(invalidCacheRecord);
|
}
|
try {
|
if (!!cacheRecord.account) {
|
await this.setAccount(cacheRecord.account, correlationId, kmsi, apiId);
|
}
|
if (!!cacheRecord.idToken && storeInCache?.idToken !== false) {
|
await this.setIdTokenCredential(cacheRecord.idToken, correlationId, kmsi);
|
}
|
if (!!cacheRecord.accessToken &&
|
storeInCache?.accessToken !== false) {
|
await this.saveAccessToken(cacheRecord.accessToken, correlationId, kmsi);
|
}
|
if (!!cacheRecord.refreshToken &&
|
storeInCache?.refreshToken !== false) {
|
await this.setRefreshTokenCredential(cacheRecord.refreshToken, correlationId, kmsi);
|
}
|
if (!!cacheRecord.appMetadata) {
|
this.setAppMetadata(cacheRecord.appMetadata, correlationId);
|
}
|
}
|
catch (e) {
|
this.commonLogger?.error(`CacheManager.saveCacheRecord: failed`, correlationId);
|
if (e instanceof AuthError) {
|
throw e;
|
}
|
else {
|
throw createCacheError(e);
|
}
|
}
|
}
|
/**
|
* saves access token credential
|
* @param credential
|
*/
|
async saveAccessToken(credential, correlationId, kmsi) {
|
const accessTokenFilter = {
|
clientId: credential.clientId,
|
credentialType: credential.credentialType,
|
environment: credential.environment,
|
homeAccountId: credential.homeAccountId,
|
realm: credential.realm,
|
tokenType: credential.tokenType,
|
};
|
const tokenKeys = this.getTokenKeys();
|
const currentScopes = ScopeSet.fromString(credential.target);
|
tokenKeys.accessToken.forEach((key) => {
|
if (!this.accessTokenKeyMatchesFilter(key, accessTokenFilter, false)) {
|
return;
|
}
|
const tokenEntity = this.getAccessTokenCredential(key, correlationId);
|
if (tokenEntity &&
|
this.credentialMatchesFilter(tokenEntity, accessTokenFilter, correlationId)) {
|
const tokenScopeSet = ScopeSet.fromString(tokenEntity.target);
|
if (tokenScopeSet.intersectingScopeSets(currentScopes)) {
|
this.removeAccessToken(key, correlationId);
|
}
|
}
|
});
|
await this.setAccessTokenCredential(credential, correlationId, kmsi);
|
}
|
/**
|
* Retrieve account entities matching all provided tenant-agnostic filters; if no filter is set, get all account entities in the cache
|
* Not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared
|
* @param accountFilter - An object containing Account properties to filter by
|
*/
|
getAccountsFilteredBy(accountFilter, correlationId) {
|
const allAccountKeys = this.getAccountKeys();
|
const matchingAccounts = [];
|
allAccountKeys.forEach((cacheKey) => {
|
const entity = this.getAccount(cacheKey, correlationId);
|
// Match base account fields
|
if (!entity) {
|
return;
|
}
|
if (!!accountFilter.homeAccountId &&
|
!this.matchHomeAccountId(entity, accountFilter.homeAccountId)) {
|
return;
|
}
|
if (!!accountFilter.username &&
|
!this.matchUsername(entity.username, accountFilter.username)) {
|
return;
|
}
|
if (!!accountFilter.environment &&
|
!this.matchEnvironment(entity, accountFilter.environment, correlationId)) {
|
return;
|
}
|
if (!!accountFilter.realm &&
|
!this.matchRealm(entity, accountFilter.realm)) {
|
return;
|
}
|
if (!!accountFilter.nativeAccountId &&
|
!this.matchNativeAccountId(entity, accountFilter.nativeAccountId)) {
|
return;
|
}
|
if (!!accountFilter.authorityType &&
|
!this.matchAuthorityType(entity, accountFilter.authorityType)) {
|
return;
|
}
|
// If at least one tenant profile matches the tenant profile filter, add the account to the list of matching accounts
|
const tenantProfileFilter = {
|
localAccountId: accountFilter?.localAccountId,
|
name: accountFilter?.name,
|
};
|
const matchingTenantProfiles = entity.tenantProfiles?.filter((tenantProfile) => {
|
return this.tenantProfileMatchesFilter(tenantProfile, tenantProfileFilter);
|
});
|
if (matchingTenantProfiles && matchingTenantProfiles.length === 0) {
|
// No tenant profile for this account matches filter, don't add to list of matching accounts
|
return;
|
}
|
matchingAccounts.push(entity);
|
});
|
return matchingAccounts;
|
}
|
/**
|
* Returns whether or not the given credential entity matches the filter
|
* @param entity
|
* @param filter
|
* @param correlationId
|
* @returns
|
*/
|
credentialMatchesFilter(entity, filter, correlationId) {
|
if (!!filter.clientId && !this.matchClientId(entity, filter.clientId)) {
|
return false;
|
}
|
if (!!filter.userAssertionHash &&
|
!this.matchUserAssertionHash(entity, filter.userAssertionHash)) {
|
return false;
|
}
|
/*
|
* homeAccountId can be undefined, and we want to filter out cached items that have a homeAccountId of ""
|
* because we don't want a client_credential request to return a cached token that has a homeAccountId
|
*/
|
if (typeof filter.homeAccountId === "string" &&
|
!this.matchHomeAccountId(entity, filter.homeAccountId)) {
|
return false;
|
}
|
if (!!filter.environment &&
|
!this.matchEnvironment(entity, filter.environment, correlationId)) {
|
return false;
|
}
|
if (!!filter.realm && !this.matchRealm(entity, filter.realm)) {
|
return false;
|
}
|
if (!!filter.credentialType &&
|
!this.matchCredentialType(entity, filter.credentialType)) {
|
return false;
|
}
|
if (!!filter.familyId && !this.matchFamilyId(entity, filter.familyId)) {
|
return false;
|
}
|
/*
|
* idTokens do not have "target", target specific refreshTokens do exist for some types of authentication
|
* Resource specific refresh tokens case will be added when the support is deemed necessary
|
*/
|
if (!!filter.target && !this.matchTarget(entity, filter.target)) {
|
return false;
|
}
|
// Access Token with Auth Scheme specific matching
|
if (entity.credentialType ===
|
CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME) {
|
if (!!filter.tokenType &&
|
!this.matchTokenType(entity, filter.tokenType)) {
|
return false;
|
}
|
// KeyId (sshKid) in request must match cached SSH certificate keyId because SSH cert is bound to a specific key
|
if (filter.tokenType === AuthenticationScheme.SSH) {
|
if (filter.keyId && !this.matchKeyId(entity, filter.keyId)) {
|
return false;
|
}
|
}
|
}
|
return true;
|
}
|
/**
|
* retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata
|
* @param filter
|
* @param correlationId
|
*/
|
getAppMetadataFilteredBy(filter, correlationId) {
|
const allCacheKeys = this.getKeys();
|
const matchingAppMetadata = {};
|
allCacheKeys.forEach((cacheKey) => {
|
// don't parse any non-appMetadata type cache entities
|
if (!this.isAppMetadata(cacheKey)) {
|
return;
|
}
|
// Attempt retrieval
|
const entity = this.getAppMetadata(cacheKey, correlationId);
|
if (!entity) {
|
return;
|
}
|
if (!!filter.environment &&
|
!this.matchEnvironment(entity, filter.environment, correlationId)) {
|
return;
|
}
|
if (!!filter.clientId &&
|
!this.matchClientId(entity, filter.clientId)) {
|
return;
|
}
|
matchingAppMetadata[cacheKey] = entity;
|
});
|
return matchingAppMetadata;
|
}
|
/**
|
* retrieve authorityMetadata that contains a matching alias
|
* @param host
|
* @param correlationId
|
*/
|
getAuthorityMetadataByAlias(host, correlationId) {
|
const allCacheKeys = this.getAuthorityMetadataKeys();
|
let matchedEntity = null;
|
allCacheKeys.forEach((cacheKey) => {
|
// don't parse any non-authorityMetadata type cache entities
|
if (!this.isAuthorityMetadata(cacheKey) ||
|
cacheKey.indexOf(this.clientId) === -1) {
|
return;
|
}
|
// Attempt retrieval
|
const entity = this.getAuthorityMetadata(cacheKey, correlationId);
|
if (!entity) {
|
return;
|
}
|
if (entity.aliases.indexOf(host) === -1) {
|
return;
|
}
|
matchedEntity = entity;
|
});
|
return matchedEntity;
|
}
|
/**
|
* Removes all accounts and related tokens from cache.
|
*/
|
removeAllAccounts(correlationId) {
|
const accounts = this.getAllAccounts({}, correlationId);
|
accounts.forEach((account) => {
|
this.removeAccount(account, correlationId);
|
});
|
}
|
/**
|
* Removes the account and related tokens for a given account key
|
* @param account
|
*/
|
removeAccount(account, correlationId) {
|
this.removeAccountContext(account, correlationId);
|
const accountKeys = this.getAccountKeys();
|
const keyFilter = (key) => {
|
return (key.includes(account.homeAccountId) &&
|
key.includes(account.environment));
|
};
|
accountKeys.filter(keyFilter).forEach((key) => {
|
this.removeItem(key, correlationId);
|
this.performanceClient.incrementFields({ accountsRemoved: 1 }, correlationId);
|
});
|
}
|
/**
|
* Removes credentials associated with the provided account
|
* @param account
|
*/
|
removeAccountContext(account, correlationId) {
|
const allTokenKeys = this.getTokenKeys();
|
const keyFilter = (key) => {
|
return (key.includes(account.homeAccountId) &&
|
key.includes(account.environment));
|
};
|
allTokenKeys.idToken.filter(keyFilter).forEach((key) => {
|
this.removeIdToken(key, correlationId);
|
});
|
allTokenKeys.accessToken.filter(keyFilter).forEach((key) => {
|
this.removeAccessToken(key, correlationId);
|
});
|
allTokenKeys.refreshToken.filter(keyFilter).forEach((key) => {
|
this.removeRefreshToken(key, correlationId);
|
});
|
}
|
/**
|
* returns a boolean if the given credential is removed
|
* @param key
|
* @param correlationId
|
*/
|
removeAccessToken(key, correlationId) {
|
const credential = this.getAccessTokenCredential(key, correlationId);
|
if (!credential) {
|
return;
|
}
|
this.removeItem(key, correlationId);
|
this.performanceClient.incrementFields({ accessTokensRemoved: 1 }, correlationId);
|
// Remove Token Binding Key from key store for PoP Tokens Credentials
|
if (credential.credentialType.toLowerCase() ===
|
CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME.toLowerCase()) {
|
if (credential.tokenType === AuthenticationScheme.POP) {
|
const accessTokenWithAuthSchemeEntity = credential;
|
const kid = accessTokenWithAuthSchemeEntity.keyId;
|
if (kid) {
|
void this.cryptoImpl
|
.removeTokenBindingKey(kid, correlationId)
|
.catch(() => {
|
this.commonLogger.error(`Failed to remove token binding key '${kid}'`, correlationId);
|
this.performanceClient?.incrementFields({ removeTokenBindingKeyFailure: 1 }, correlationId);
|
});
|
}
|
}
|
}
|
}
|
/**
|
* Removes all app metadata objects from cache.
|
*/
|
removeAppMetadata(correlationId) {
|
const allCacheKeys = this.getKeys();
|
allCacheKeys.forEach((cacheKey) => {
|
if (this.isAppMetadata(cacheKey)) {
|
this.removeItem(cacheKey, correlationId);
|
}
|
});
|
return true;
|
}
|
/**
|
* Retrieve IdTokenEntity from cache
|
* @param account {AccountInfo}
|
* @param tokenKeys {?TokenKeys}
|
* @param targetRealm {?string}
|
* @param performanceClient {?IPerformanceClient}
|
* @param correlationId {?string}
|
*/
|
getIdToken(account, correlationId, tokenKeys, targetRealm) {
|
this.commonLogger.trace("CacheManager - getIdToken called", correlationId);
|
const idTokenFilter = {
|
homeAccountId: account.homeAccountId,
|
environment: account.environment,
|
credentialType: CredentialType.ID_TOKEN,
|
clientId: this.clientId,
|
realm: targetRealm,
|
};
|
const idTokenMap = this.getIdTokensByFilter(idTokenFilter, correlationId, tokenKeys);
|
const numIdTokens = idTokenMap.size;
|
if (numIdTokens < 1) {
|
this.commonLogger.info("CacheManager:getIdToken - No token found", correlationId);
|
return null;
|
}
|
else if (numIdTokens > 1) {
|
let tokensToBeRemoved = idTokenMap;
|
// Multiple tenant profiles and no tenant specified, pick home account
|
if (!targetRealm) {
|
const homeIdTokenMap = new Map();
|
idTokenMap.forEach((idToken, key) => {
|
if (idToken.realm === account.tenantId) {
|
homeIdTokenMap.set(key, idToken);
|
}
|
});
|
const numHomeIdTokens = homeIdTokenMap.size;
|
if (numHomeIdTokens < 1) {
|
this.commonLogger.info("CacheManager:getIdToken - Multiple ID tokens found for account but none match account entity tenant id, returning first result", correlationId);
|
return idTokenMap.values().next().value;
|
}
|
else if (numHomeIdTokens === 1) {
|
this.commonLogger.info("CacheManager:getIdToken - Multiple ID tokens found for account, defaulting to home tenant profile", correlationId);
|
return homeIdTokenMap.values().next().value;
|
}
|
else {
|
// Multiple ID tokens for home tenant profile, remove all and return null
|
tokensToBeRemoved = homeIdTokenMap;
|
}
|
}
|
// Multiple tokens for a single tenant profile, remove all and return null
|
this.commonLogger.info("CacheManager:getIdToken - Multiple matching ID tokens found, clearing them", correlationId);
|
tokensToBeRemoved.forEach((idToken, key) => {
|
this.removeIdToken(key, correlationId);
|
});
|
this.performanceClient.addFields({ multiMatchedID: idTokenMap.size }, correlationId);
|
return null;
|
}
|
this.commonLogger.info("CacheManager:getIdToken - Returning ID token", correlationId);
|
return idTokenMap.values().next().value;
|
}
|
/**
|
* Gets all idTokens matching the given filter
|
* @param filter
|
* @returns
|
*/
|
getIdTokensByFilter(filter, correlationId, tokenKeys) {
|
const idTokenKeys = (tokenKeys && tokenKeys.idToken) || this.getTokenKeys().idToken;
|
const idTokens = new Map();
|
idTokenKeys.forEach((key) => {
|
if (!this.idTokenKeyMatchesFilter(key, {
|
clientId: this.clientId,
|
...filter,
|
})) {
|
return;
|
}
|
const idToken = this.getIdTokenCredential(key, correlationId);
|
if (idToken &&
|
this.credentialMatchesFilter(idToken, filter, correlationId)) {
|
idTokens.set(key, idToken);
|
}
|
});
|
return idTokens;
|
}
|
/**
|
* Validate the cache key against filter before retrieving and parsing cache value
|
* @param key
|
* @param filter
|
* @returns
|
*/
|
idTokenKeyMatchesFilter(inputKey, filter) {
|
const key = inputKey.toLowerCase();
|
if (filter.clientId &&
|
key.indexOf(filter.clientId.toLowerCase()) === -1) {
|
return false;
|
}
|
if (filter.homeAccountId &&
|
key.indexOf(filter.homeAccountId.toLowerCase()) === -1) {
|
return false;
|
}
|
return true;
|
}
|
/**
|
* Removes idToken from the cache
|
* @param key
|
*/
|
removeIdToken(key, correlationId) {
|
this.removeItem(key, correlationId);
|
}
|
/**
|
* Removes refresh token from the cache
|
* @param key
|
*/
|
removeRefreshToken(key, correlationId) {
|
this.removeItem(key, correlationId);
|
}
|
/**
|
* Retrieve AccessTokenEntity from cache
|
* @param account {AccountInfo}
|
* @param request {BaseAuthRequest}
|
* @param tokenKeys {?TokenKeys}
|
* @param performanceClient {?IPerformanceClient}
|
*/
|
getAccessToken(account, request, tokenKeys, targetRealm) {
|
const correlationId = request.correlationId;
|
this.commonLogger.trace("CacheManager - getAccessToken called", correlationId);
|
const scopes = ScopeSet.createSearchScopes(request.scopes);
|
const authScheme = request.authenticationScheme ||
|
AuthenticationScheme.BEARER;
|
/*
|
* Distinguish between Bearer and PoP/SSH token cache types
|
* Cast to lowercase to handle "bearer" from ADFS
|
*/
|
const credentialType = authScheme &&
|
authScheme.toLowerCase() !==
|
AuthenticationScheme.BEARER.toLowerCase()
|
? CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME
|
: CredentialType.ACCESS_TOKEN;
|
const accessTokenFilter = {
|
homeAccountId: account.homeAccountId,
|
environment: account.environment,
|
credentialType: credentialType,
|
clientId: this.clientId,
|
realm: targetRealm || account.tenantId,
|
target: scopes,
|
tokenType: authScheme,
|
keyId: request.sshKid,
|
};
|
const accessTokenKeys = (tokenKeys && tokenKeys.accessToken) ||
|
this.getTokenKeys().accessToken;
|
const accessTokens = [];
|
accessTokenKeys.forEach((key) => {
|
// Validate key
|
if (this.accessTokenKeyMatchesFilter(key, accessTokenFilter, true)) {
|
const accessToken = this.getAccessTokenCredential(key, correlationId);
|
// Validate value
|
if (accessToken &&
|
this.credentialMatchesFilter(accessToken, accessTokenFilter, correlationId)) {
|
accessTokens.push(accessToken);
|
}
|
}
|
});
|
const numAccessTokens = accessTokens.length;
|
if (numAccessTokens < 1) {
|
this.commonLogger.info("CacheManager:getAccessToken - No token found", correlationId);
|
return null;
|
}
|
else if (numAccessTokens > 1) {
|
this.commonLogger.info("CacheManager:getAccessToken - Multiple access tokens found, clearing them", correlationId);
|
accessTokens.forEach((accessToken) => {
|
this.removeAccessToken(this.generateCredentialKey(accessToken), correlationId);
|
});
|
this.performanceClient.addFields({ multiMatchedAT: accessTokens.length }, correlationId);
|
return null;
|
}
|
this.commonLogger.info("CacheManager:getAccessToken - Returning access token", correlationId);
|
return accessTokens[0];
|
}
|
/**
|
* Validate the cache key against filter before retrieving and parsing cache value
|
* @param key
|
* @param filter
|
* @param keyMustContainAllScopes
|
* @returns
|
*/
|
accessTokenKeyMatchesFilter(inputKey, filter, keyMustContainAllScopes) {
|
const key = inputKey.toLowerCase();
|
if (filter.clientId &&
|
key.indexOf(filter.clientId.toLowerCase()) === -1) {
|
return false;
|
}
|
if (filter.homeAccountId &&
|
key.indexOf(filter.homeAccountId.toLowerCase()) === -1) {
|
return false;
|
}
|
if (filter.realm && key.indexOf(filter.realm.toLowerCase()) === -1) {
|
return false;
|
}
|
if (filter.target) {
|
const scopes = filter.target.asArray();
|
for (let i = 0; i < scopes.length; i++) {
|
if (keyMustContainAllScopes &&
|
!key.includes(scopes[i].toLowerCase())) {
|
// When performing a cache lookup a missing scope would be a cache miss
|
return false;
|
}
|
else if (!keyMustContainAllScopes &&
|
key.includes(scopes[i].toLowerCase())) {
|
// When performing a cache write, any token with a subset of requested scopes should be replaced
|
return true;
|
}
|
}
|
}
|
return true;
|
}
|
/**
|
* Gets all access tokens matching the filter
|
* @param filter
|
* @returns
|
*/
|
getAccessTokensByFilter(filter, correlationId) {
|
const tokenKeys = this.getTokenKeys();
|
const accessTokens = [];
|
tokenKeys.accessToken.forEach((key) => {
|
if (!this.accessTokenKeyMatchesFilter(key, filter, true)) {
|
return;
|
}
|
const accessToken = this.getAccessTokenCredential(key, correlationId);
|
if (accessToken &&
|
this.credentialMatchesFilter(accessToken, filter, correlationId)) {
|
accessTokens.push(accessToken);
|
}
|
});
|
return accessTokens;
|
}
|
/**
|
* Helper to retrieve the appropriate refresh token from cache
|
* @param account {AccountInfo}
|
* @param familyRT {boolean}
|
* @param tokenKeys {?TokenKeys}
|
* @param performanceClient {?IPerformanceClient}
|
* @param correlationId {?string}
|
*/
|
getRefreshToken(account, familyRT, correlationId, tokenKeys) {
|
this.commonLogger.trace("CacheManager - getRefreshToken called", correlationId);
|
const id = familyRT ? THE_FAMILY_ID : undefined;
|
const refreshTokenFilter = {
|
homeAccountId: account.homeAccountId,
|
environment: account.environment,
|
credentialType: CredentialType.REFRESH_TOKEN,
|
clientId: this.clientId,
|
familyId: id,
|
};
|
const refreshTokenKeys = (tokenKeys && tokenKeys.refreshToken) ||
|
this.getTokenKeys().refreshToken;
|
const refreshTokens = [];
|
refreshTokenKeys.forEach((key) => {
|
// Validate key
|
if (this.refreshTokenKeyMatchesFilter(key, refreshTokenFilter)) {
|
const refreshToken = this.getRefreshTokenCredential(key, correlationId);
|
// Validate value
|
if (refreshToken &&
|
this.credentialMatchesFilter(refreshToken, refreshTokenFilter, correlationId)) {
|
refreshTokens.push(refreshToken);
|
}
|
}
|
});
|
const numRefreshTokens = refreshTokens.length;
|
if (numRefreshTokens < 1) {
|
this.commonLogger.info("CacheManager:getRefreshToken - No refresh token found.", correlationId);
|
return null;
|
}
|
// address the else case after remove functions address environment aliases
|
if (numRefreshTokens > 1) {
|
this.performanceClient.addFields({ multiMatchedRT: numRefreshTokens }, correlationId);
|
}
|
this.commonLogger.info("CacheManager:getRefreshToken - returning refresh token", correlationId);
|
return refreshTokens[0];
|
}
|
/**
|
* Validate the cache key against filter before retrieving and parsing cache value
|
* @param key
|
* @param filter
|
*/
|
refreshTokenKeyMatchesFilter(inputKey, filter) {
|
const key = inputKey.toLowerCase();
|
if (filter.familyId &&
|
key.indexOf(filter.familyId.toLowerCase()) === -1) {
|
return false;
|
}
|
// If familyId is used, clientId is not in the key
|
if (!filter.familyId &&
|
filter.clientId &&
|
key.indexOf(filter.clientId.toLowerCase()) === -1) {
|
return false;
|
}
|
if (filter.homeAccountId &&
|
key.indexOf(filter.homeAccountId.toLowerCase()) === -1) {
|
return false;
|
}
|
return true;
|
}
|
/**
|
* Retrieve AppMetadataEntity from cache
|
*/
|
readAppMetadataFromCache(environment, correlationId) {
|
const appMetadataFilter = {
|
environment,
|
clientId: this.clientId,
|
};
|
const appMetadata = this.getAppMetadataFilteredBy(appMetadataFilter, correlationId);
|
const appMetadataEntries = Object.keys(appMetadata).map((key) => appMetadata[key]);
|
const numAppMetadata = appMetadataEntries.length;
|
if (numAppMetadata < 1) {
|
return null;
|
}
|
else if (numAppMetadata > 1) {
|
throw createClientAuthError(multipleMatchingAppMetadata);
|
}
|
return appMetadataEntries[0];
|
}
|
/**
|
* Return the family_id value associated with FOCI
|
* @param environment
|
* @param clientId
|
*/
|
isAppMetadataFOCI(environment, correlationId) {
|
const appMetadata = this.readAppMetadataFromCache(environment, correlationId);
|
return !!(appMetadata && appMetadata.familyId === THE_FAMILY_ID);
|
}
|
/**
|
* helper to match account ids
|
* @param value
|
* @param homeAccountId
|
*/
|
matchHomeAccountId(entity, homeAccountId) {
|
return !!(typeof entity.homeAccountId === "string" &&
|
homeAccountId === entity.homeAccountId);
|
}
|
/**
|
* helper to match account ids
|
* @param entity
|
* @param localAccountId
|
* @returns
|
*/
|
matchLocalAccountIdFromTokenClaims(tokenClaims, localAccountId) {
|
const idTokenLocalAccountId = tokenClaims.oid || tokenClaims.sub;
|
return localAccountId === idTokenLocalAccountId;
|
}
|
matchLocalAccountIdFromTenantProfile(tenantProfile, localAccountId) {
|
return tenantProfile.localAccountId === localAccountId;
|
}
|
/**
|
* helper to match names
|
* @param entity
|
* @param name
|
* @returns true if the downcased name properties are present and match in the filter and the entity
|
*/
|
matchName(claims, name) {
|
return !!(name.toLowerCase() === claims.name?.toLowerCase());
|
}
|
/**
|
* helper to match usernames
|
* @param entity
|
* @param username
|
* @returns
|
*/
|
matchUsername(cachedUsername, filterUsername) {
|
return !!(cachedUsername &&
|
typeof cachedUsername === "string" &&
|
filterUsername?.toLowerCase() === cachedUsername.toLowerCase());
|
}
|
/**
|
* helper to match assertion
|
* @param value
|
* @param oboAssertion
|
*/
|
matchUserAssertionHash(entity, userAssertionHash) {
|
return !!(entity.userAssertionHash &&
|
userAssertionHash === entity.userAssertionHash);
|
}
|
/**
|
* helper to match environment
|
* @param value
|
* @param environment
|
*/
|
matchEnvironment(entity, environment, correlationId) {
|
// Check static authority options first for cases where authority metadata has not been resolved and cached yet
|
if (this.staticAuthorityOptions) {
|
const staticAliases = getAliasesFromStaticSources(this.staticAuthorityOptions, this.commonLogger, correlationId);
|
if (staticAliases.includes(environment) &&
|
staticAliases.includes(entity.environment)) {
|
return true;
|
}
|
}
|
// Query metadata cache if no static authority configuration has aliases that match enviroment
|
const cloudMetadata = this.getAuthorityMetadataByAlias(environment, correlationId);
|
if (cloudMetadata &&
|
cloudMetadata.aliases.indexOf(entity.environment) > -1) {
|
return true;
|
}
|
return false;
|
}
|
/**
|
* helper to match credential type
|
* @param entity
|
* @param credentialType
|
*/
|
matchCredentialType(entity, credentialType) {
|
return (entity.credentialType &&
|
credentialType.toLowerCase() === entity.credentialType.toLowerCase());
|
}
|
/**
|
* helper to match client ids
|
* @param entity
|
* @param clientId
|
*/
|
matchClientId(entity, clientId) {
|
return !!(entity.clientId && clientId === entity.clientId);
|
}
|
/**
|
* helper to match family ids
|
* @param entity
|
* @param familyId
|
*/
|
matchFamilyId(entity, familyId) {
|
return !!(entity.familyId && familyId === entity.familyId);
|
}
|
/**
|
* helper to match realm
|
* @param entity
|
* @param realm
|
*/
|
matchRealm(entity, realm) {
|
return !!(entity.realm?.toLowerCase() === realm.toLowerCase());
|
}
|
/**
|
* helper to match nativeAccountId
|
* @param entity
|
* @param nativeAccountId
|
* @returns boolean indicating the match result
|
*/
|
matchNativeAccountId(entity, nativeAccountId) {
|
return !!(entity.nativeAccountId && nativeAccountId === entity.nativeAccountId);
|
}
|
/**
|
* helper to match loginHint which can be either:
|
* 1. login_hint ID token claim
|
* 2. username in cached account object
|
* 3. upn in ID token claims
|
* @param entity
|
* @param loginHint
|
* @returns
|
*/
|
matchLoginHintFromTokenClaims(tokenClaims, loginHint) {
|
if (tokenClaims.login_hint === loginHint) {
|
return true;
|
}
|
if (tokenClaims.preferred_username === loginHint) {
|
return true;
|
}
|
if (tokenClaims.upn === loginHint) {
|
return true;
|
}
|
return false;
|
}
|
/**
|
* Helper to match sid
|
* @param entity
|
* @param sid
|
* @returns true if the sid claim is present and matches the filter
|
*/
|
matchSid(idTokenClaims, sid) {
|
return idTokenClaims.sid === sid;
|
}
|
matchAuthorityType(entity, authorityType) {
|
return !!(entity.authorityType &&
|
authorityType.toLowerCase() === entity.authorityType.toLowerCase());
|
}
|
/**
|
* Returns true if the target scopes are a subset of the current entity's scopes, false otherwise.
|
* @param entity
|
* @param target
|
*/
|
matchTarget(entity, target) {
|
const isNotAccessTokenCredential = entity.credentialType !== CredentialType.ACCESS_TOKEN &&
|
entity.credentialType !==
|
CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME;
|
if (isNotAccessTokenCredential || !entity.target) {
|
return false;
|
}
|
const entityScopeSet = ScopeSet.fromString(entity.target);
|
return entityScopeSet.containsScopeSet(target);
|
}
|
/**
|
* Returns true if the credential's tokenType or Authentication Scheme matches the one in the request, false otherwise
|
* @param entity
|
* @param tokenType
|
*/
|
matchTokenType(entity, tokenType) {
|
return !!(entity.tokenType && entity.tokenType === tokenType);
|
}
|
/**
|
* Returns true if the credential's keyId matches the one in the request, false otherwise
|
* @param entity
|
* @param keyId
|
*/
|
matchKeyId(entity, keyId) {
|
return !!(entity.keyId && entity.keyId === keyId);
|
}
|
/**
|
* returns if a given cache entity is of the type appmetadata
|
* @param key
|
*/
|
isAppMetadata(key) {
|
return key.indexOf(APP_METADATA) !== -1;
|
}
|
/**
|
* returns if a given cache entity is of the type authoritymetadata
|
* @param key
|
*/
|
isAuthorityMetadata(key) {
|
return key.indexOf(AUTHORITY_METADATA_CACHE_KEY) !== -1;
|
}
|
/**
|
* returns cache key used for cloud instance metadata
|
*/
|
generateAuthorityMetadataCacheKey(authority) {
|
return `${AUTHORITY_METADATA_CACHE_KEY}-${this.clientId}-${authority}`;
|
}
|
/**
|
* Helper to convert serialized data to object
|
* @param obj
|
* @param json
|
*/
|
static toObject(obj, json) {
|
for (const propertyName in json) {
|
obj[propertyName] = json[propertyName];
|
}
|
return obj;
|
}
|
}
|
/** @internal */
|
class DefaultStorageClass extends CacheManager {
|
async setAccount() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getAccount() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
async setIdTokenCredential() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getIdTokenCredential() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
async setAccessTokenCredential() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getAccessTokenCredential() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
async setRefreshTokenCredential() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getRefreshTokenCredential() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
setAppMetadata() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getAppMetadata() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
setServerTelemetry() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getServerTelemetry() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
setAuthorityMetadata() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getAuthorityMetadata() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getAuthorityMetadataKeys() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
setThrottlingCache() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getThrottlingCache() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
removeItem() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getKeys() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getAccountKeys() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
getTokenKeys() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
generateCredentialKey() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
generateAccountKey() {
|
throw createClientAuthError(methodNotImplemented);
|
}
|
}
|
|
export { CacheManager, DefaultStorageClass };
|
//# sourceMappingURL=CacheManager.mjs.map
|
