/*! @azure/msal-node v2.16.2 2024-11-19 */ 'use strict'; 'use strict'; var http = require('http'); var https = require('https'); var uuid = require('uuid'); var crypto = require('crypto'); var jwt = require('jsonwebtoken'); var fs = require('fs'); var path = require('path'); /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class serializes cache entities to be saved into in-memory object types defined internally * @internal */ class Serializer { /** * serialize the JSON blob * @param data - JSON blob cache */ static serializeJSONBlob(data) { return JSON.stringify(data); } /** * Serialize Accounts * @param accCache - cache of accounts */ static serializeAccounts(accCache) { const accounts = {}; Object.keys(accCache).map(function (key) { const accountEntity = accCache[key]; accounts[key] = { home_account_id: accountEntity.homeAccountId, environment: accountEntity.environment, realm: accountEntity.realm, local_account_id: accountEntity.localAccountId, username: accountEntity.username, authority_type: accountEntity.authorityType, name: accountEntity.name, client_info: accountEntity.clientInfo, last_modification_time: accountEntity.lastModificationTime, last_modification_app: accountEntity.lastModificationApp, tenantProfiles: accountEntity.tenantProfiles?.map((tenantProfile) => { return JSON.stringify(tenantProfile); }), }; }); return accounts; } /** * Serialize IdTokens * @param idTCache - cache of ID tokens */ static serializeIdTokens(idTCache) { const idTokens = {}; Object.keys(idTCache).map(function (key) { const idTEntity = idTCache[key]; idTokens[key] = { home_account_id: idTEntity.homeAccountId, environment: idTEntity.environment, credential_type: idTEntity.credentialType, client_id: idTEntity.clientId, secret: idTEntity.secret, realm: idTEntity.realm, }; }); return idTokens; } /** * Serializes AccessTokens * @param atCache - cache of access tokens */ static serializeAccessTokens(atCache) { const accessTokens = {}; Object.keys(atCache).map(function (key) { const atEntity = atCache[key]; accessTokens[key] = { home_account_id: atEntity.homeAccountId, environment: atEntity.environment, credential_type: atEntity.credentialType, client_id: atEntity.clientId, secret: atEntity.secret, realm: atEntity.realm, target: atEntity.target, cached_at: atEntity.cachedAt, expires_on: atEntity.expiresOn, extended_expires_on: atEntity.extendedExpiresOn, refresh_on: atEntity.refreshOn, key_id: atEntity.keyId, token_type: atEntity.tokenType, requestedClaims: atEntity.requestedClaims, requestedClaimsHash: atEntity.requestedClaimsHash, userAssertionHash: atEntity.userAssertionHash, }; }); return accessTokens; } /** * Serialize refreshTokens * @param rtCache - cache of refresh tokens */ static serializeRefreshTokens(rtCache) { const refreshTokens = {}; Object.keys(rtCache).map(function (key) { const rtEntity = rtCache[key]; refreshTokens[key] = { home_account_id: rtEntity.homeAccountId, environment: rtEntity.environment, credential_type: rtEntity.credentialType, client_id: rtEntity.clientId, secret: rtEntity.secret, family_id: rtEntity.familyId, target: rtEntity.target, realm: rtEntity.realm, }; }); return refreshTokens; } /** * Serialize amdtCache * @param amdtCache - cache of app metadata */ static serializeAppMetadata(amdtCache) { const appMetadata = {}; Object.keys(amdtCache).map(function (key) { const amdtEntity = amdtCache[key]; appMetadata[key] = { client_id: amdtEntity.clientId, environment: amdtEntity.environment, family_id: amdtEntity.familyId, }; }); return appMetadata; } /** * Serialize the cache * @param inMemCache - itemised cache read from the JSON */ static serializeAllCache(inMemCache) { return { Account: this.serializeAccounts(inMemCache.accounts), IdToken: this.serializeIdTokens(inMemCache.idTokens), AccessToken: this.serializeAccessTokens(inMemCache.accessTokens), RefreshToken: this.serializeRefreshTokens(inMemCache.refreshTokens), AppMetadata: this.serializeAppMetadata(inMemCache.appMetadata), }; } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const Constants$1 = { LIBRARY_NAME: "MSAL.JS", SKU: "msal.js.common", // Prefix for all library cache entries CACHE_PREFIX: "msal", // default authority DEFAULT_AUTHORITY: "https://login.microsoftonline.com/common/", DEFAULT_AUTHORITY_HOST: "login.microsoftonline.com", DEFAULT_COMMON_TENANT: "common", // ADFS String ADFS: "adfs", DSTS: "dstsv2", // Default AAD Instance Discovery Endpoint AAD_INSTANCE_DISCOVERY_ENDPT: "https://login.microsoftonline.com/common/discovery/instance?api-version=1.1&authorization_endpoint=", // CIAM URL CIAM_AUTH_URL: ".ciamlogin.com", AAD_TENANT_DOMAIN_SUFFIX: ".onmicrosoft.com", // Resource delimiter - used for certain cache entries RESOURCE_DELIM: "|", // Placeholder for non-existent account ids/objects NO_ACCOUNT: "NO_ACCOUNT", // Claims CLAIMS: "claims", // Consumer UTID CONSUMER_UTID: "9188040d-6c67-4c5b-b112-36a304b66dad", // Default scopes OPENID_SCOPE: "openid", PROFILE_SCOPE: "profile", OFFLINE_ACCESS_SCOPE: "offline_access", EMAIL_SCOPE: "email", // Default response type for authorization code flow CODE_RESPONSE_TYPE: "code", CODE_GRANT_TYPE: "authorization_code", RT_GRANT_TYPE: "refresh_token", FRAGMENT_RESPONSE_MODE: "fragment", S256_CODE_CHALLENGE_METHOD: "S256", URL_FORM_CONTENT_TYPE: "application/x-www-form-urlencoded;charset=utf-8", AUTHORIZATION_PENDING: "authorization_pending", NOT_DEFINED: "not_defined", EMPTY_STRING: "", NOT_APPLICABLE: "N/A", NOT_AVAILABLE: "Not Available", FORWARD_SLASH: "/", IMDS_ENDPOINT: "http://169.254.169.254/metadata/instance/compute/location", IMDS_VERSION: "2020-06-01", IMDS_TIMEOUT: 2000, AZURE_REGION_AUTO_DISCOVER_FLAG: "TryAutoDetect", REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: "login.microsoft.com", KNOWN_PUBLIC_CLOUDS: [ "login.microsoftonline.com", "login.windows.net", "login.microsoft.com", "sts.windows.net", ], TOKEN_RESPONSE_TYPE: "token", ID_TOKEN_RESPONSE_TYPE: "id_token", SHR_NONCE_VALIDITY: 240, INVALID_INSTANCE: "invalid_instance", }; const HttpStatus = { SUCCESS: 200, SUCCESS_RANGE_START: 200, SUCCESS_RANGE_END: 299, REDIRECT: 302, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_START: 400, BAD_REQUEST: 400, UNAUTHORIZED: 401, NOT_FOUND: 404, REQUEST_TIMEOUT: 408, TOO_MANY_REQUESTS: 429, CLIENT_ERROR_RANGE_END: 499, SERVER_ERROR: 500, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, GATEWAY_TIMEOUT: 504, SERVER_ERROR_RANGE_END: 599, MULTI_SIDED_ERROR: 600, }; const OIDC_DEFAULT_SCOPES = [ Constants$1.OPENID_SCOPE, Constants$1.PROFILE_SCOPE, Constants$1.OFFLINE_ACCESS_SCOPE, ]; const OIDC_SCOPES = [...OIDC_DEFAULT_SCOPES, Constants$1.EMAIL_SCOPE]; /** * Request header names */ const HeaderNames = { CONTENT_TYPE: "Content-Type", CONTENT_LENGTH: "Content-Length", RETRY_AFTER: "Retry-After", CCS_HEADER: "X-AnchorMailbox", WWWAuthenticate: "WWW-Authenticate", AuthenticationInfo: "Authentication-Info", X_MS_REQUEST_ID: "x-ms-request-id", X_MS_HTTP_VERSION: "x-ms-httpver", }; /** * String constants related to AAD Authority */ const AADAuthorityConstants = { COMMON: "common", ORGANIZATIONS: "organizations", CONSUMERS: "consumers", }; /** * Claims request keys */ const ClaimsRequestKeys = { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc", }; /** * we considered making this "enum" in the request instead of string, however it looks like the allowed list of * prompt values kept changing over past couple of years. There are some undocumented prompt values for some * internal partners too, hence the choice of generic "string" type instead of the "enum" */ const PromptValue = { LOGIN: "login", SELECT_ACCOUNT: "select_account", CONSENT: "consent", NONE: "none", CREATE: "create", NO_SESSION: "no_session", }; /** * allowed values for codeVerifier */ const CodeChallengeMethodValues = { PLAIN: "plain", S256: "S256", }; /** * allowed values for server response type */ const ServerResponseType = { QUERY: "query", FRAGMENT: "fragment", }; /** * allowed values for response_mode */ const ResponseMode = { ...ServerResponseType, FORM_POST: "form_post", }; /** * allowed grant_type */ const GrantType = { IMPLICIT_GRANT: "implicit", AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", RESOURCE_OWNER_PASSWORD_GRANT: "password", REFRESH_TOKEN_GRANT: "refresh_token", DEVICE_CODE_GRANT: "device_code", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", }; /** * Account types in Cache */ const CacheAccountType = { MSSTS_ACCOUNT_TYPE: "MSSTS", ADFS_ACCOUNT_TYPE: "ADFS", MSAV1_ACCOUNT_TYPE: "MSA", GENERIC_ACCOUNT_TYPE: "Generic", // NTLM, Kerberos, FBA, Basic etc }; /** * Separators used in cache */ const Separators = { CACHE_KEY_SEPARATOR: "-", CLIENT_INFO_SEPARATOR: ".", }; /** * Credential Type stored in the cache */ const CredentialType = { ID_TOKEN: "IdToken", ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", REFRESH_TOKEN: "RefreshToken", }; /** * More Cache related constants */ const APP_METADATA = "appmetadata"; const CLIENT_INFO = "client_info"; const THE_FAMILY_ID = "1"; const AUTHORITY_METADATA_CONSTANTS = { CACHE_KEY: "authority-metadata", REFRESH_TIME_SECONDS: 3600 * 24, // 24 Hours }; const AuthorityMetadataSource = { CONFIG: "config", CACHE: "cache", NETWORK: "network", HARDCODED_VALUES: "hardcoded_values", }; const SERVER_TELEM_CONSTANTS = { SCHEMA_VERSION: 5, MAX_CUR_HEADER_BYTES: 80, MAX_LAST_HEADER_BYTES: 330, MAX_CACHED_ERRORS: 50, CACHE_KEY: "server-telemetry", CATEGORY_SEPARATOR: "|", VALUE_SEPARATOR: ",", OVERFLOW_TRUE: "1", OVERFLOW_FALSE: "0", UNKNOWN_ERROR: "unknown_error", }; /** * Type of the authentication request */ const AuthenticationScheme = { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert", }; /** * Constants related to throttling */ const ThrottlingConstants = { // Default time to throttle RequestThumbprint in seconds DEFAULT_THROTTLE_TIME_SECONDS: 60, // Default maximum time to throttle in seconds, overrides what the server sends back DEFAULT_MAX_THROTTLE_TIME_SECONDS: 3600, // Prefix for storing throttling entries THROTTLING_PREFIX: "throttling", // Value assigned to the x-ms-lib-capability header to indicate to the server the library supports throttling X_MS_LIB_CAPABILITY_VALUE: "retry-after, h429", }; const Errors = { INVALID_GRANT_ERROR: "invalid_grant", CLIENT_MISMATCH_ERROR: "client_mismatch", }; /** * Password grant parameters */ const PasswordGrantConstants = { username: "username", password: "password", }; /** * Response codes */ const ResponseCodes = { httpSuccess: 200, httpBadRequest: 400, }; /** * Region Discovery Sources */ const RegionDiscoverySources = { FAILED_AUTO_DETECTION: "1", INTERNAL_CACHE: "2", ENVIRONMENT_VARIABLE: "3", IMDS: "4", }; /** * Region Discovery Outcomes */ const RegionDiscoveryOutcomes = { CONFIGURED_MATCHES_DETECTED: "1", CONFIGURED_NO_AUTO_DETECTION: "2", CONFIGURED_NOT_DETECTED: "3", AUTO_DETECTION_REQUESTED_SUCCESSFUL: "4", AUTO_DETECTION_REQUESTED_FAILED: "5", }; /** * Specifies the reason for fetching the access token from the identity provider */ const CacheOutcome = { // When a token is found in the cache or the cache is not supposed to be hit when making the request NOT_APPLICABLE: "0", // When the token request goes to the identity provider because force_refresh was set to true. Also occurs if claims were requested FORCE_REFRESH_OR_CLAIMS: "1", // When the token request goes to the identity provider because no cached access token exists NO_CACHED_ACCESS_TOKEN: "2", // When the token request goes to the identity provider because cached access token expired CACHED_ACCESS_TOKEN_EXPIRED: "3", // When the token request goes to the identity provider because refresh_in was used and the existing token needs to be refreshed PROACTIVELY_REFRESHED: "4", }; // Token renewal offset default in seconds const DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = 300; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * AuthErrorMessage class containing string constants used by error codes and messages. */ const unexpectedError = "unexpected_error"; const postRequestFailed = "post_request_failed"; var AuthErrorCodes = /*#__PURE__*/Object.freeze({ __proto__: null, postRequestFailed: postRequestFailed, unexpectedError: unexpectedError }); /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const AuthErrorMessages = { [unexpectedError]: "Unexpected error in authentication.", [postRequestFailed]: "Post request failed from the network, could be a 4xx/5xx or a network unavailability. Please check the exact error code for details.", }; /** * AuthErrorMessage class containing string constants used by error codes and messages. * @deprecated Use AuthErrorCodes instead */ const AuthErrorMessage = { unexpectedError: { code: unexpectedError, desc: AuthErrorMessages[unexpectedError], }, postRequestFailed: { code: postRequestFailed, desc: AuthErrorMessages[postRequestFailed], }, }; /** * General error class thrown by the MSAL.js library. */ class AuthError extends Error { constructor(errorCode, errorMessage, suberror) { const errorString = errorMessage ? `${errorCode}: ${errorMessage}` : errorCode; super(errorString); Object.setPrototypeOf(this, AuthError.prototype); this.errorCode = errorCode || Constants$1.EMPTY_STRING; this.errorMessage = errorMessage || Constants$1.EMPTY_STRING; this.subError = suberror || Constants$1.EMPTY_STRING; this.name = "AuthError"; } setCorrelationId(correlationId) { this.correlationId = correlationId; } } function createAuthError(code, additionalMessage) { return new AuthError(code, additionalMessage ? `${AuthErrorMessages[code]} ${additionalMessage}` : AuthErrorMessages[code]); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const clientInfoDecodingError = "client_info_decoding_error"; const clientInfoEmptyError = "client_info_empty_error"; const tokenParsingError = "token_parsing_error"; const nullOrEmptyToken = "null_or_empty_token"; const endpointResolutionError = "endpoints_resolution_error"; const networkError = "network_error"; const openIdConfigError = "openid_config_error"; const hashNotDeserialized = "hash_not_deserialized"; const invalidState = "invalid_state"; const stateMismatch = "state_mismatch"; const stateNotFound = "state_not_found"; const nonceMismatch = "nonce_mismatch"; const authTimeNotFound = "auth_time_not_found"; const maxAgeTranspired = "max_age_transpired"; const multipleMatchingTokens = "multiple_matching_tokens"; const multipleMatchingAccounts = "multiple_matching_accounts"; const multipleMatchingAppMetadata = "multiple_matching_appMetadata"; const requestCannotBeMade = "request_cannot_be_made"; const cannotRemoveEmptyScope = "cannot_remove_empty_scope"; const cannotAppendScopeSet = "cannot_append_scopeset"; const emptyInputScopeSet = "empty_input_scopeset"; const deviceCodePollingCancelled = "device_code_polling_cancelled"; const deviceCodeExpired = "device_code_expired"; const deviceCodeUnknownError = "device_code_unknown_error"; const noAccountInSilentRequest = "no_account_in_silent_request"; const invalidCacheRecord = "invalid_cache_record"; const invalidCacheEnvironment = "invalid_cache_environment"; const noAccountFound = "no_account_found"; const noCryptoObject = "no_crypto_object"; const unexpectedCredentialType = "unexpected_credential_type"; const invalidAssertion = "invalid_assertion"; const invalidClientCredential = "invalid_client_credential"; const tokenRefreshRequired = "token_refresh_required"; const userTimeoutReached = "user_timeout_reached"; const tokenClaimsCnfRequiredForSignedJwt = "token_claims_cnf_required_for_signedjwt"; const authorizationCodeMissingFromServerResponse = "authorization_code_missing_from_server_response"; const bindingKeyNotRemoved = "binding_key_not_removed"; const endSessionEndpointNotSupported = "end_session_endpoint_not_supported"; const keyIdMissing = "key_id_missing"; const noNetworkConnectivity = "no_network_connectivity"; const userCanceled = "user_canceled"; const missingTenantIdError = "missing_tenant_id_error"; const methodNotImplemented = "method_not_implemented"; const nestedAppAuthBridgeDisabled = "nested_app_auth_bridge_disabled"; var ClientAuthErrorCodes = /*#__PURE__*/Object.freeze({ __proto__: null, authTimeNotFound: authTimeNotFound, authorizationCodeMissingFromServerResponse: authorizationCodeMissingFromServerResponse, bindingKeyNotRemoved: bindingKeyNotRemoved, cannotAppendScopeSet: cannotAppendScopeSet, cannotRemoveEmptyScope: cannotRemoveEmptyScope, clientInfoDecodingError: clientInfoDecodingError, clientInfoEmptyError: clientInfoEmptyError, deviceCodeExpired: deviceCodeExpired, deviceCodePollingCancelled: deviceCodePollingCancelled, deviceCodeUnknownError: deviceCodeUnknownError, emptyInputScopeSet: emptyInputScopeSet, endSessionEndpointNotSupported: endSessionEndpointNotSupported, endpointResolutionError: endpointResolutionError, hashNotDeserialized: hashNotDeserialized, invalidAssertion: invalidAssertion, invalidCacheEnvironment: invalidCacheEnvironment, invalidCacheRecord: invalidCacheRecord, invalidClientCredential: invalidClientCredential, invalidState: invalidState, keyIdMissing: keyIdMissing, maxAgeTranspired: maxAgeTranspired, methodNotImplemented: methodNotImplemented, missingTenantIdError: missingTenantIdError, multipleMatchingAccounts: multipleMatchingAccounts, multipleMatchingAppMetadata: multipleMatchingAppMetadata, multipleMatchingTokens: multipleMatchingTokens, nestedAppAuthBridgeDisabled: nestedAppAuthBridgeDisabled, networkError: networkError, noAccountFound: noAccountFound, noAccountInSilentRequest: noAccountInSilentRequest, noCryptoObject: noCryptoObject, noNetworkConnectivity: noNetworkConnectivity, nonceMismatch: nonceMismatch, nullOrEmptyToken: nullOrEmptyToken, openIdConfigError: openIdConfigError, requestCannotBeMade: requestCannotBeMade, stateMismatch: stateMismatch, stateNotFound: stateNotFound, tokenClaimsCnfRequiredForSignedJwt: tokenClaimsCnfRequiredForSignedJwt, tokenParsingError: tokenParsingError, tokenRefreshRequired: tokenRefreshRequired, unexpectedCredentialType: unexpectedCredentialType, userCanceled: userCanceled, userTimeoutReached: userTimeoutReached }); /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * ClientAuthErrorMessage class containing string constants used by error codes and messages. */ const ClientAuthErrorMessages = { [clientInfoDecodingError]: "The client info could not be parsed/decoded correctly", [clientInfoEmptyError]: "The client info was empty", [tokenParsingError]: "Token cannot be parsed", [nullOrEmptyToken]: "The token is null or empty", [endpointResolutionError]: "Endpoints cannot be resolved", [networkError]: "Network request failed", [openIdConfigError]: "Could not retrieve endpoints. Check your authority and verify the .well-known/openid-configuration endpoint returns the required endpoints.", [hashNotDeserialized]: "The hash parameters could not be deserialized", [invalidState]: "State was not the expected format", [stateMismatch]: "State mismatch error", [stateNotFound]: "State not found", [nonceMismatch]: "Nonce mismatch error", [authTimeNotFound]: "Max Age was requested and the ID token is missing the auth_time variable." + " auth_time is an optional claim and is not enabled by default - it must be enabled." + " See https://aka.ms/msaljs/optional-claims for more information.", [maxAgeTranspired]: "Max Age is set to 0, or too much time has elapsed since the last end-user authentication.", [multipleMatchingTokens]: "The cache contains multiple tokens satisfying the requirements. " + "Call AcquireToken again providing more requirements such as authority or account.", [multipleMatchingAccounts]: "The cache contains multiple accounts satisfying the given parameters. Please pass more info to obtain the correct account", [multipleMatchingAppMetadata]: "The cache contains multiple appMetadata satisfying the given parameters. Please pass more info to obtain the correct appMetadata", [requestCannotBeMade]: "Token request cannot be made without authorization code or refresh token.", [cannotRemoveEmptyScope]: "Cannot remove null or empty scope from ScopeSet", [cannotAppendScopeSet]: "Cannot append ScopeSet", [emptyInputScopeSet]: "Empty input ScopeSet cannot be processed", [deviceCodePollingCancelled]: "Caller has cancelled token endpoint polling during device code flow by setting DeviceCodeRequest.cancel = true.", [deviceCodeExpired]: "Device code is expired.", [deviceCodeUnknownError]: "Device code stopped polling for unknown reasons.", [noAccountInSilentRequest]: "Please pass an account object, silent flow is not supported without account information", [invalidCacheRecord]: "Cache record object was null or undefined.", [invalidCacheEnvironment]: "Invalid environment when attempting to create cache entry", [noAccountFound]: "No account found in cache for given key.", [noCryptoObject]: "No crypto object detected.", [unexpectedCredentialType]: "Unexpected credential type.", [invalidAssertion]: "Client assertion must meet requirements described in https://tools.ietf.org/html/rfc7515", [invalidClientCredential]: "Client credential (secret, certificate, or assertion) must not be empty when creating a confidential client. An application should at most have one credential", [tokenRefreshRequired]: "Cannot return token from cache because it must be refreshed. This may be due to one of the following reasons: forceRefresh parameter is set to true, claims have been requested, there is no cached access token or it is expired.", [userTimeoutReached]: "User defined timeout for device code polling reached", [tokenClaimsCnfRequiredForSignedJwt]: "Cannot generate a POP jwt if the token_claims are not populated", [authorizationCodeMissingFromServerResponse]: "Server response does not contain an authorization code to proceed", [bindingKeyNotRemoved]: "Could not remove the credential's binding key from storage.", [endSessionEndpointNotSupported]: "The provided authority does not support logout", [keyIdMissing]: "A keyId value is missing from the requested bound token's cache record and is required to match the token to it's stored binding key.", [noNetworkConnectivity]: "No network connectivity. Check your internet connection.", [userCanceled]: "User cancelled the flow.", [missingTenantIdError]: "A tenant id - not common, organizations, or consumers - must be specified when using the client_credentials flow.", [methodNotImplemented]: "This method has not been implemented", [nestedAppAuthBridgeDisabled]: "The nested app auth bridge is disabled", }; /** * String constants used by error codes and messages. * @deprecated Use ClientAuthErrorCodes instead */ const ClientAuthErrorMessage = { clientInfoDecodingError: { code: clientInfoDecodingError, desc: ClientAuthErrorMessages[clientInfoDecodingError], }, clientInfoEmptyError: { code: clientInfoEmptyError, desc: ClientAuthErrorMessages[clientInfoEmptyError], }, tokenParsingError: { code: tokenParsingError, desc: ClientAuthErrorMessages[tokenParsingError], }, nullOrEmptyToken: { code: nullOrEmptyToken, desc: ClientAuthErrorMessages[nullOrEmptyToken], }, endpointResolutionError: { code: endpointResolutionError, desc: ClientAuthErrorMessages[endpointResolutionError], }, networkError: { code: networkError, desc: ClientAuthErrorMessages[networkError], }, unableToGetOpenidConfigError: { code: openIdConfigError, desc: ClientAuthErrorMessages[openIdConfigError], }, hashNotDeserialized: { code: hashNotDeserialized, desc: ClientAuthErrorMessages[hashNotDeserialized], }, invalidStateError: { code: invalidState, desc: ClientAuthErrorMessages[invalidState], }, stateMismatchError: { code: stateMismatch, desc: ClientAuthErrorMessages[stateMismatch], }, stateNotFoundError: { code: stateNotFound, desc: ClientAuthErrorMessages[stateNotFound], }, nonceMismatchError: { code: nonceMismatch, desc: ClientAuthErrorMessages[nonceMismatch], }, authTimeNotFoundError: { code: authTimeNotFound, desc: ClientAuthErrorMessages[authTimeNotFound], }, maxAgeTranspired: { code: maxAgeTranspired, desc: ClientAuthErrorMessages[maxAgeTranspired], }, multipleMatchingTokens: { code: multipleMatchingTokens, desc: ClientAuthErrorMessages[multipleMatchingTokens], }, multipleMatchingAccounts: { code: multipleMatchingAccounts, desc: ClientAuthErrorMessages[multipleMatchingAccounts], }, multipleMatchingAppMetadata: { code: multipleMatchingAppMetadata, desc: ClientAuthErrorMessages[multipleMatchingAppMetadata], }, tokenRequestCannotBeMade: { code: requestCannotBeMade, desc: ClientAuthErrorMessages[requestCannotBeMade], }, removeEmptyScopeError: { code: cannotRemoveEmptyScope, desc: ClientAuthErrorMessages[cannotRemoveEmptyScope], }, appendScopeSetError: { code: cannotAppendScopeSet, desc: ClientAuthErrorMessages[cannotAppendScopeSet], }, emptyInputScopeSetError: { code: emptyInputScopeSet, desc: ClientAuthErrorMessages[emptyInputScopeSet], }, DeviceCodePollingCancelled: { code: deviceCodePollingCancelled, desc: ClientAuthErrorMessages[deviceCodePollingCancelled], }, DeviceCodeExpired: { code: deviceCodeExpired, desc: ClientAuthErrorMessages[deviceCodeExpired], }, DeviceCodeUnknownError: { code: deviceCodeUnknownError, desc: ClientAuthErrorMessages[deviceCodeUnknownError], }, NoAccountInSilentRequest: { code: noAccountInSilentRequest, desc: ClientAuthErrorMessages[noAccountInSilentRequest], }, invalidCacheRecord: { code: invalidCacheRecord, desc: ClientAuthErrorMessages[invalidCacheRecord], }, invalidCacheEnvironment: { code: invalidCacheEnvironment, desc: ClientAuthErrorMessages[invalidCacheEnvironment], }, noAccountFound: { code: noAccountFound, desc: ClientAuthErrorMessages[noAccountFound], }, noCryptoObj: { code: noCryptoObject, desc: ClientAuthErrorMessages[noCryptoObject], }, unexpectedCredentialType: { code: unexpectedCredentialType, desc: ClientAuthErrorMessages[unexpectedCredentialType], }, invalidAssertion: { code: invalidAssertion, desc: ClientAuthErrorMessages[invalidAssertion], }, invalidClientCredential: { code: invalidClientCredential, desc: ClientAuthErrorMessages[invalidClientCredential], }, tokenRefreshRequired: { code: tokenRefreshRequired, desc: ClientAuthErrorMessages[tokenRefreshRequired], }, userTimeoutReached: { code: userTimeoutReached, desc: ClientAuthErrorMessages[userTimeoutReached], }, tokenClaimsRequired: { code: tokenClaimsCnfRequiredForSignedJwt, desc: ClientAuthErrorMessages[tokenClaimsCnfRequiredForSignedJwt], }, noAuthorizationCodeFromServer: { code: authorizationCodeMissingFromServerResponse, desc: ClientAuthErrorMessages[authorizationCodeMissingFromServerResponse], }, bindingKeyNotRemovedError: { code: bindingKeyNotRemoved, desc: ClientAuthErrorMessages[bindingKeyNotRemoved], }, logoutNotSupported: { code: endSessionEndpointNotSupported, desc: ClientAuthErrorMessages[endSessionEndpointNotSupported], }, keyIdMissing: { code: keyIdMissing, desc: ClientAuthErrorMessages[keyIdMissing], }, noNetworkConnectivity: { code: noNetworkConnectivity, desc: ClientAuthErrorMessages[noNetworkConnectivity], }, userCanceledError: { code: userCanceled, desc: ClientAuthErrorMessages[userCanceled], }, missingTenantIdError: { code: missingTenantIdError, desc: ClientAuthErrorMessages[missingTenantIdError], }, nestedAppAuthBridgeDisabled: { code: nestedAppAuthBridgeDisabled, desc: ClientAuthErrorMessages[nestedAppAuthBridgeDisabled], }, }; /** * Error thrown when there is an error in the client code running on the browser. */ class ClientAuthError extends AuthError { constructor(errorCode, additionalMessage) { super(errorCode, additionalMessage ? `${ClientAuthErrorMessages[errorCode]}: ${additionalMessage}` : ClientAuthErrorMessages[errorCode]); this.name = "ClientAuthError"; Object.setPrototypeOf(this, ClientAuthError.prototype); } } function createClientAuthError(errorCode, additionalMessage) { return new ClientAuthError(errorCode, additionalMessage); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const DEFAULT_CRYPTO_IMPLEMENTATION = { createNewGuid: () => { throw createClientAuthError(methodNotImplemented); }, base64Decode: () => { throw createClientAuthError(methodNotImplemented); }, base64Encode: () => { throw createClientAuthError(methodNotImplemented); }, base64UrlEncode: () => { throw createClientAuthError(methodNotImplemented); }, encodeKid: () => { throw createClientAuthError(methodNotImplemented); }, async getPublicKeyThumbprint() { throw createClientAuthError(methodNotImplemented); }, async removeTokenBindingKey() { throw createClientAuthError(methodNotImplemented); }, async clearKeystore() { throw createClientAuthError(methodNotImplemented); }, async signJwt() { throw createClientAuthError(methodNotImplemented); }, async hashString() { throw createClientAuthError(methodNotImplemented); }, }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Log message level. */ exports.LogLevel = void 0; (function (LogLevel) { LogLevel[LogLevel["Error"] = 0] = "Error"; LogLevel[LogLevel["Warning"] = 1] = "Warning"; LogLevel[LogLevel["Info"] = 2] = "Info"; LogLevel[LogLevel["Verbose"] = 3] = "Verbose"; LogLevel[LogLevel["Trace"] = 4] = "Trace"; })(exports.LogLevel || (exports.LogLevel = {})); /** * Class which facilitates logging of messages to a specific place. */ class Logger { constructor(loggerOptions, packageName, packageVersion) { // Current log level, defaults to info. this.level = exports.LogLevel.Info; const defaultLoggerCallback = () => { return; }; const setLoggerOptions = loggerOptions || Logger.createDefaultLoggerOptions(); this.localCallback = setLoggerOptions.loggerCallback || defaultLoggerCallback; this.piiLoggingEnabled = setLoggerOptions.piiLoggingEnabled || false; this.level = typeof setLoggerOptions.logLevel === "number" ? setLoggerOptions.logLevel : exports.LogLevel.Info; this.correlationId = setLoggerOptions.correlationId || Constants$1.EMPTY_STRING; this.packageName = packageName || Constants$1.EMPTY_STRING; this.packageVersion = packageVersion || Constants$1.EMPTY_STRING; } static createDefaultLoggerOptions() { return { loggerCallback: () => { // allow users to not set loggerCallback }, piiLoggingEnabled: false, logLevel: exports.LogLevel.Info, }; } /** * Create new Logger with existing configurations. */ clone(packageName, packageVersion, correlationId) { return new Logger({ loggerCallback: this.localCallback, piiLoggingEnabled: this.piiLoggingEnabled, logLevel: this.level, correlationId: correlationId || this.correlationId, }, packageName, packageVersion); } /** * Log message with required options. */ logMessage(logMessage, options) { if (options.logLevel > this.level || (!this.piiLoggingEnabled && options.containsPii)) { return; } const timestamp = new Date().toUTCString(); // Add correlationId to logs if set, correlationId provided on log messages take precedence const logHeader = `[${timestamp}] : [${options.correlationId || this.correlationId || ""}]`; const log = `${logHeader} : ${this.packageName}@${this.packageVersion} : ${exports.LogLevel[options.logLevel]} - ${logMessage}`; // debug(`msal:${LogLevel[options.logLevel]}${options.containsPii ? "-Pii": Constants.EMPTY_STRING}${options.context ? `:${options.context}` : Constants.EMPTY_STRING}`)(logMessage); this.executeCallback(options.logLevel, log, options.containsPii || false); } /** * Execute callback with message. */ executeCallback(level, message, containsPii) { if (this.localCallback) { this.localCallback(level, message, containsPii); } } /** * Logs error messages. */ error(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Error, containsPii: false, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs error messages with PII. */ errorPii(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Error, containsPii: true, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs warning messages. */ warning(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Warning, containsPii: false, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs warning messages with PII. */ warningPii(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Warning, containsPii: true, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs info messages. */ info(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Info, containsPii: false, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs info messages with PII. */ infoPii(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Info, containsPii: true, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs verbose messages. */ verbose(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Verbose, containsPii: false, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs verbose messages with PII. */ verbosePii(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Verbose, containsPii: true, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs trace messages. */ trace(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Trace, containsPii: false, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Logs trace messages with PII. */ tracePii(message, correlationId) { this.logMessage(message, { logLevel: exports.LogLevel.Trace, containsPii: true, correlationId: correlationId || Constants$1.EMPTY_STRING, }); } /** * Returns whether PII Logging is enabled or not. */ isPiiLoggingEnabled() { return this.piiLoggingEnabled || false; } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* eslint-disable header/header */ const name$1 = "@azure/msal-common"; const version$1 = "14.16.0"; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const AzureCloudInstance = { // AzureCloudInstance is not specified. None: "none", // Microsoft Azure public cloud AzurePublic: "https://login.microsoftonline.com", // Microsoft PPE AzurePpe: "https://login.windows-ppe.net", // Microsoft Chinese national/regional cloud AzureChina: "https://login.chinacloudapi.cn", // Microsoft German national/regional cloud ("Black Forest") AzureGermany: "https://login.microsoftonline.de", // US Government cloud AzureUsGovernment: "https://login.microsoftonline.us", }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Extract token by decoding the rawToken * * @param encodedToken */ function extractTokenClaims(encodedToken, base64Decode) { const jswPayload = getJWSPayload(encodedToken); // token will be decoded to get the username try { // base64Decode() should throw an error if there is an issue const base64Decoded = base64Decode(jswPayload); return JSON.parse(base64Decoded); } catch (err) { throw createClientAuthError(tokenParsingError); } } /** * decode a JWT * * @param authToken */ function getJWSPayload(authToken) { if (!authToken) { throw createClientAuthError(nullOrEmptyToken); } const tokenPartsRegex = /^([^\.\s]*)\.([^\.\s]+)\.([^\.\s]*)$/; const matches = tokenPartsRegex.exec(authToken); if (!matches || matches.length < 4) { throw createClientAuthError(tokenParsingError); } /** * const crackedToken = { * header: matches[1], * JWSPayload: matches[2], * JWSSig: matches[3], * }; */ return matches[2]; } /** * Determine if the token's max_age has transpired */ function checkMaxAge(authTime, maxAge) { /* * per https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest * To force an immediate re-authentication: If an app requires that a user re-authenticate prior to access, * provide a value of 0 for the max_age parameter and the AS will force a fresh login. */ const fiveMinuteSkew = 300000; // five minutes in milliseconds if (maxAge === 0 || Date.now() - fiveMinuteSkew > authTime + maxAge) { throw createClientAuthError(maxAgeTranspired); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Utility functions for managing date and time operations. */ /** * return the current time in Unix time (seconds). */ function nowSeconds() { // Date.getTime() returns in milliseconds. return Math.round(new Date().getTime() / 1000.0); } /** * check if a token is expired based on given UTC time in seconds. * @param expiresOn */ function isTokenExpired(expiresOn, offset) { // check for access token expiry const expirationSec = Number(expiresOn) || 0; const offsetCurrentTimeSec = nowSeconds() + offset; // If current time + offset is greater than token expiration time, then token is expired. return offsetCurrentTimeSec > expirationSec; } /** * If the current time is earlier than the time that a token was cached at, we must discard the token * i.e. The system clock was turned back after acquiring the cached token * @param cachedAt * @param offset */ function wasClockTurnedBack(cachedAt) { const cachedAtSec = Number(cachedAt); return cachedAtSec > nowSeconds(); } /** * Waits for t number of milliseconds * @param t number * @param value T */ function delay(t, value) { return new Promise((resolve) => setTimeout(() => resolve(value), t)); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Cache Key: ------- * IdToken Example: uid.utid-login.microsoftonline.com-idtoken-app_client_id-contoso.com * AccessToken Example: uid.utid-login.microsoftonline.com-accesstoken-app_client_id-contoso.com-scope1 scope2--pop * RefreshToken Example: uid.utid-login.microsoftonline.com-refreshtoken-1-contoso.com * @param credentialEntity * @returns */ function generateCredentialKey(credentialEntity) { const credentialKey = [ generateAccountId(credentialEntity), generateCredentialId(credentialEntity), generateTarget(credentialEntity), generateClaimsHash(credentialEntity), generateScheme(credentialEntity), ]; return credentialKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase(); } /** * Create IdTokenEntity * @param homeAccountId * @param authenticationResult * @param clientId * @param authority */ function createIdTokenEntity(homeAccountId, environment, idToken, clientId, tenantId) { const idTokenEntity = { credentialType: CredentialType.ID_TOKEN, homeAccountId: homeAccountId, environment: environment, clientId: clientId, secret: idToken, realm: tenantId, }; return idTokenEntity; } /** * Create AccessTokenEntity * @param homeAccountId * @param environment * @param accessToken * @param clientId * @param tenantId * @param scopes * @param expiresOn * @param extExpiresOn */ function createAccessTokenEntity(homeAccountId, environment, accessToken, clientId, tenantId, scopes, expiresOn, extExpiresOn, base64Decode, refreshOn, tokenType, userAssertionHash, keyId, requestedClaims, requestedClaimsHash) { const atEntity = { homeAccountId: homeAccountId, credentialType: CredentialType.ACCESS_TOKEN, secret: accessToken, cachedAt: nowSeconds().toString(), expiresOn: expiresOn.toString(), extendedExpiresOn: extExpiresOn.toString(), environment: environment, clientId: clientId, realm: tenantId, target: scopes, tokenType: tokenType || AuthenticationScheme.BEARER, }; if (userAssertionHash) { atEntity.userAssertionHash = userAssertionHash; } if (refreshOn) { atEntity.refreshOn = refreshOn.toString(); } if (requestedClaims) { atEntity.requestedClaims = requestedClaims; atEntity.requestedClaimsHash = requestedClaimsHash; } /* * Create Access Token With Auth Scheme instead of regular access token * Cast to lower to handle "bearer" from ADFS */ if (atEntity.tokenType?.toLowerCase() !== AuthenticationScheme.BEARER.toLowerCase()) { atEntity.credentialType = CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME; switch (atEntity.tokenType) { case AuthenticationScheme.POP: // Make sure keyId is present and add it to credential const tokenClaims = extractTokenClaims(accessToken, base64Decode); if (!tokenClaims?.cnf?.kid) { throw createClientAuthError(tokenClaimsCnfRequiredForSignedJwt); } atEntity.keyId = tokenClaims.cnf.kid; break; case AuthenticationScheme.SSH: atEntity.keyId = keyId; } } return atEntity; } /** * Create RefreshTokenEntity * @param homeAccountId * @param authenticationResult * @param clientId * @param authority */ function createRefreshTokenEntity(homeAccountId, environment, refreshToken, clientId, familyId, userAssertionHash, expiresOn) { const rtEntity = { credentialType: CredentialType.REFRESH_TOKEN, homeAccountId: homeAccountId, environment: environment, clientId: clientId, secret: refreshToken, }; if (userAssertionHash) { rtEntity.userAssertionHash = userAssertionHash; } if (familyId) { rtEntity.familyId = familyId; } if (expiresOn) { rtEntity.expiresOn = expiresOn.toString(); } return rtEntity; } function isCredentialEntity(entity) { return (entity.hasOwnProperty("homeAccountId") && entity.hasOwnProperty("environment") && entity.hasOwnProperty("credentialType") && entity.hasOwnProperty("clientId") && entity.hasOwnProperty("secret")); } /** * Validates an entity: checks for all expected params * @param entity */ function isAccessTokenEntity(entity) { if (!entity) { return false; } return (isCredentialEntity(entity) && entity.hasOwnProperty("realm") && entity.hasOwnProperty("target") && (entity["credentialType"] === CredentialType.ACCESS_TOKEN || entity["credentialType"] === CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME)); } /** * Validates an entity: checks for all expected params * @param entity */ function isIdTokenEntity(entity) { if (!entity) { return false; } return (isCredentialEntity(entity) && entity.hasOwnProperty("realm") && entity["credentialType"] === CredentialType.ID_TOKEN); } /** * Validates an entity: checks for all expected params * @param entity */ function isRefreshTokenEntity(entity) { if (!entity) { return false; } return (isCredentialEntity(entity) && entity["credentialType"] === CredentialType.REFRESH_TOKEN); } /** * Generate Account Id key component as per the schema: - */ function generateAccountId(credentialEntity) { const accountId = [ credentialEntity.homeAccountId, credentialEntity.environment, ]; return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase(); } /** * Generate Credential Id key component as per the schema: -- */ function generateCredentialId(credentialEntity) { const clientOrFamilyId = credentialEntity.credentialType === CredentialType.REFRESH_TOKEN ? credentialEntity.familyId || credentialEntity.clientId : credentialEntity.clientId; const credentialId = [ credentialEntity.credentialType, clientOrFamilyId, credentialEntity.realm || "", ]; return credentialId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase(); } /** * Generate target key component as per schema: */ function generateTarget(credentialEntity) { return (credentialEntity.target || "").toLowerCase(); } /** * Generate requested claims key component as per schema: */ function generateClaimsHash(credentialEntity) { return (credentialEntity.requestedClaimsHash || "").toLowerCase(); } /** * Generate scheme key componenet as per schema: */ function generateScheme(credentialEntity) { /* * PoP Tokens and SSH certs include scheme in cache key * Cast to lowercase to handle "bearer" from ADFS */ return credentialEntity.tokenType && credentialEntity.tokenType.toLowerCase() !== AuthenticationScheme.BEARER.toLowerCase() ? credentialEntity.tokenType.toLowerCase() : ""; } /** * validates if a given cache entry is "Telemetry", parses * @param key * @param entity */ function isServerTelemetryEntity(key, entity) { const validateKey = key.indexOf(SERVER_TELEM_CONSTANTS.CACHE_KEY) === 0; let validateEntity = true; if (entity) { validateEntity = entity.hasOwnProperty("failedRequests") && entity.hasOwnProperty("errors") && entity.hasOwnProperty("cacheHits"); } return validateKey && validateEntity; } /** * validates if a given cache entry is "Throttling", parses * @param key * @param entity */ function isThrottlingEntity(key, entity) { let validateKey = false; if (key) { validateKey = key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0; } let validateEntity = true; if (entity) { validateEntity = entity.hasOwnProperty("throttleTime"); } return validateKey && validateEntity; } /** * Generate AppMetadata Cache Key as per the schema: appmetadata-- */ function generateAppMetadataKey({ environment, clientId, }) { const appMetaDataKeyArray = [ APP_METADATA, environment, clientId, ]; return appMetaDataKeyArray .join(Separators.CACHE_KEY_SEPARATOR) .toLowerCase(); } /* * Validates an entity: checks for all expected params * @param entity */ function isAppMetadataEntity(key, entity) { if (!entity) { return false; } return (key.indexOf(APP_METADATA) === 0 && entity.hasOwnProperty("clientId") && entity.hasOwnProperty("environment")); } /** * Validates an entity: checks for all expected params * @param entity */ function isAuthorityMetadataEntity(key, entity) { if (!entity) { return false; } return (key.indexOf(AUTHORITY_METADATA_CONSTANTS.CACHE_KEY) === 0 && entity.hasOwnProperty("aliases") && entity.hasOwnProperty("preferred_cache") && entity.hasOwnProperty("preferred_network") && entity.hasOwnProperty("canonical_authority") && entity.hasOwnProperty("authorization_endpoint") && entity.hasOwnProperty("token_endpoint") && entity.hasOwnProperty("issuer") && entity.hasOwnProperty("aliasesFromNetwork") && entity.hasOwnProperty("endpointsFromNetwork") && entity.hasOwnProperty("expiresAt") && entity.hasOwnProperty("jwks_uri")); } /** * Reset the exiresAt value */ function generateAuthorityMetadataExpiresAt() { return (nowSeconds() + AUTHORITY_METADATA_CONSTANTS.REFRESH_TIME_SECONDS); } function updateAuthorityEndpointMetadata(authorityMetadata, updatedValues, fromNetwork) { authorityMetadata.authorization_endpoint = updatedValues.authorization_endpoint; authorityMetadata.token_endpoint = updatedValues.token_endpoint; authorityMetadata.end_session_endpoint = updatedValues.end_session_endpoint; authorityMetadata.issuer = updatedValues.issuer; authorityMetadata.endpointsFromNetwork = fromNetwork; authorityMetadata.jwks_uri = updatedValues.jwks_uri; } function updateCloudDiscoveryMetadata(authorityMetadata, updatedValues, fromNetwork) { authorityMetadata.aliases = updatedValues.aliases; authorityMetadata.preferred_cache = updatedValues.preferred_cache; authorityMetadata.preferred_network = updatedValues.preferred_network; authorityMetadata.aliasesFromNetwork = fromNetwork; } /** * Returns whether or not the data needs to be refreshed */ function isAuthorityMetadataExpired(metadata) { return metadata.expiresAt <= nowSeconds(); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const redirectUriEmpty = "redirect_uri_empty"; const claimsRequestParsingError = "claims_request_parsing_error"; const authorityUriInsecure = "authority_uri_insecure"; const urlParseError = "url_parse_error"; const urlEmptyError = "empty_url_error"; const emptyInputScopesError = "empty_input_scopes_error"; const invalidPromptValue = "invalid_prompt_value"; const invalidClaims = "invalid_claims"; const tokenRequestEmpty = "token_request_empty"; const logoutRequestEmpty = "logout_request_empty"; const invalidCodeChallengeMethod = "invalid_code_challenge_method"; const pkceParamsMissing = "pkce_params_missing"; const invalidCloudDiscoveryMetadata = "invalid_cloud_discovery_metadata"; const invalidAuthorityMetadata = "invalid_authority_metadata"; const untrustedAuthority = "untrusted_authority"; const missingSshJwk = "missing_ssh_jwk"; const missingSshKid = "missing_ssh_kid"; const missingNonceAuthenticationHeader = "missing_nonce_authentication_header"; const invalidAuthenticationHeader = "invalid_authentication_header"; const cannotSetOIDCOptions = "cannot_set_OIDCOptions"; const cannotAllowNativeBroker = "cannot_allow_native_broker"; const authorityMismatch = "authority_mismatch"; var ClientConfigurationErrorCodes = /*#__PURE__*/Object.freeze({ __proto__: null, authorityMismatch: authorityMismatch, authorityUriInsecure: authorityUriInsecure, cannotAllowNativeBroker: cannotAllowNativeBroker, cannotSetOIDCOptions: cannotSetOIDCOptions, claimsRequestParsingError: claimsRequestParsingError, emptyInputScopesError: emptyInputScopesError, invalidAuthenticationHeader: invalidAuthenticationHeader, invalidAuthorityMetadata: invalidAuthorityMetadata, invalidClaims: invalidClaims, invalidCloudDiscoveryMetadata: invalidCloudDiscoveryMetadata, invalidCodeChallengeMethod: invalidCodeChallengeMethod, invalidPromptValue: invalidPromptValue, logoutRequestEmpty: logoutRequestEmpty, missingNonceAuthenticationHeader: missingNonceAuthenticationHeader, missingSshJwk: missingSshJwk, missingSshKid: missingSshKid, pkceParamsMissing: pkceParamsMissing, redirectUriEmpty: redirectUriEmpty, tokenRequestEmpty: tokenRequestEmpty, untrustedAuthority: untrustedAuthority, urlEmptyError: urlEmptyError, urlParseError: urlParseError }); /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const ClientConfigurationErrorMessages = { [redirectUriEmpty]: "A redirect URI is required for all calls, and none has been set.", [claimsRequestParsingError]: "Could not parse the given claims request object.", [authorityUriInsecure]: "Authority URIs must use https. Please see here for valid authority configuration options: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-js-initializing-client-applications#configuration-options", [urlParseError]: "URL could not be parsed into appropriate segments.", [urlEmptyError]: "URL was empty or null.", [emptyInputScopesError]: "Scopes cannot be passed as null, undefined or empty array because they are required to obtain an access token.", [invalidPromptValue]: "Please see here for valid configuration options: https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_common.html#commonauthorizationurlrequest", [invalidClaims]: "Given claims parameter must be a stringified JSON object.", [tokenRequestEmpty]: "Token request was empty and not found in cache.", [logoutRequestEmpty]: "The logout request was null or undefined.", [invalidCodeChallengeMethod]: 'code_challenge_method passed is invalid. Valid values are "plain" and "S256".', [pkceParamsMissing]: "Both params: code_challenge and code_challenge_method are to be passed if to be sent in the request", [invalidCloudDiscoveryMetadata]: "Invalid cloudDiscoveryMetadata provided. Must be a stringified JSON object containing tenant_discovery_endpoint and metadata fields", [invalidAuthorityMetadata]: "Invalid authorityMetadata provided. Must by a stringified JSON object containing authorization_endpoint, token_endpoint, issuer fields.", [untrustedAuthority]: "The provided authority is not a trusted authority. Please include this authority in the knownAuthorities config parameter.", [missingSshJwk]: "Missing sshJwk in SSH certificate request. A stringified JSON Web Key is required when using the SSH authentication scheme.", [missingSshKid]: "Missing sshKid in SSH certificate request. A string that uniquely identifies the public SSH key is required when using the SSH authentication scheme.", [missingNonceAuthenticationHeader]: "Unable to find an authentication header containing server nonce. Either the Authentication-Info or WWW-Authenticate headers must be present in order to obtain a server nonce.", [invalidAuthenticationHeader]: "Invalid authentication header provided", [cannotSetOIDCOptions]: "Cannot set OIDCOptions parameter. Please change the protocol mode to OIDC or use a non-Microsoft authority.", [cannotAllowNativeBroker]: "Cannot set allowNativeBroker parameter to true when not in AAD protocol mode.", [authorityMismatch]: "Authority mismatch error. Authority provided in login request or PublicClientApplication config does not match the environment of the provided account. Please use a matching account or make an interactive request to login to this authority.", }; /** * ClientConfigurationErrorMessage class containing string constants used by error codes and messages. * @deprecated Use ClientConfigurationErrorCodes instead */ const ClientConfigurationErrorMessage = { redirectUriNotSet: { code: redirectUriEmpty, desc: ClientConfigurationErrorMessages[redirectUriEmpty], }, claimsRequestParsingError: { code: claimsRequestParsingError, desc: ClientConfigurationErrorMessages[claimsRequestParsingError], }, authorityUriInsecure: { code: authorityUriInsecure, desc: ClientConfigurationErrorMessages[authorityUriInsecure], }, urlParseError: { code: urlParseError, desc: ClientConfigurationErrorMessages[urlParseError], }, urlEmptyError: { code: urlEmptyError, desc: ClientConfigurationErrorMessages[urlEmptyError], }, emptyScopesError: { code: emptyInputScopesError, desc: ClientConfigurationErrorMessages[emptyInputScopesError], }, invalidPrompt: { code: invalidPromptValue, desc: ClientConfigurationErrorMessages[invalidPromptValue], }, invalidClaimsRequest: { code: invalidClaims, desc: ClientConfigurationErrorMessages[invalidClaims], }, tokenRequestEmptyError: { code: tokenRequestEmpty, desc: ClientConfigurationErrorMessages[tokenRequestEmpty], }, logoutRequestEmptyError: { code: logoutRequestEmpty, desc: ClientConfigurationErrorMessages[logoutRequestEmpty], }, invalidCodeChallengeMethod: { code: invalidCodeChallengeMethod, desc: ClientConfigurationErrorMessages[invalidCodeChallengeMethod], }, invalidCodeChallengeParams: { code: pkceParamsMissing, desc: ClientConfigurationErrorMessages[pkceParamsMissing], }, invalidCloudDiscoveryMetadata: { code: invalidCloudDiscoveryMetadata, desc: ClientConfigurationErrorMessages[invalidCloudDiscoveryMetadata], }, invalidAuthorityMetadata: { code: invalidAuthorityMetadata, desc: ClientConfigurationErrorMessages[invalidAuthorityMetadata], }, untrustedAuthority: { code: untrustedAuthority, desc: ClientConfigurationErrorMessages[untrustedAuthority], }, missingSshJwk: { code: missingSshJwk, desc: ClientConfigurationErrorMessages[missingSshJwk], }, missingSshKid: { code: missingSshKid, desc: ClientConfigurationErrorMessages[missingSshKid], }, missingNonceAuthenticationHeader: { code: missingNonceAuthenticationHeader, desc: ClientConfigurationErrorMessages[missingNonceAuthenticationHeader], }, invalidAuthenticationHeader: { code: invalidAuthenticationHeader, desc: ClientConfigurationErrorMessages[invalidAuthenticationHeader], }, cannotSetOIDCOptions: { code: cannotSetOIDCOptions, desc: ClientConfigurationErrorMessages[cannotSetOIDCOptions], }, cannotAllowNativeBroker: { code: cannotAllowNativeBroker, desc: ClientConfigurationErrorMessages[cannotAllowNativeBroker], }, authorityMismatch: { code: authorityMismatch, desc: ClientConfigurationErrorMessages[authorityMismatch], }, }; /** * Error thrown when there is an error in configuration of the MSAL.js library. */ class ClientConfigurationError extends AuthError { constructor(errorCode) { super(errorCode, ClientConfigurationErrorMessages[errorCode]); this.name = "ClientConfigurationError"; Object.setPrototypeOf(this, ClientConfigurationError.prototype); } } function createClientConfigurationError(errorCode) { return new ClientConfigurationError(errorCode); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * @hidden */ class StringUtils { /** * Check if stringified object is empty * @param strObj */ static isEmptyObj(strObj) { if (strObj) { try { const obj = JSON.parse(strObj); return Object.keys(obj).length === 0; } catch (e) { } } return true; } static startsWith(str, search) { return str.indexOf(search) === 0; } static endsWith(str, search) { return (str.length >= search.length && str.lastIndexOf(search) === str.length - search.length); } /** * Parses string into an object. * * @param query */ static queryStringToObject(query) { const obj = {}; const params = query.split("&"); const decode = (s) => decodeURIComponent(s.replace(/\+/g, " ")); params.forEach((pair) => { if (pair.trim()) { const [key, value] = pair.split(/=(.+)/g, 2); // Split on the first occurence of the '=' character if (key && value) { obj[decode(key)] = decode(value); } } }); return obj; } /** * Trims entries in an array. * * @param arr */ static trimArrayEntries(arr) { return arr.map((entry) => entry.trim()); } /** * Removes empty strings from array * @param arr */ static removeEmptyStringsFromArray(arr) { return arr.filter((entry) => { return !!entry; }); } /** * Attempts to parse a string into JSON * @param str */ static jsonParseHelper(str) { try { return JSON.parse(str); } catch (e) { return null; } } /** * Tests if a given string matches a given pattern, with support for wildcards and queries. * @param pattern Wildcard pattern to string match. Supports "*" for wildcards and "?" for queries * @param input String to match against */ static matchPattern(pattern, input) { /** * Wildcard support: https://stackoverflow.com/a/3117248/4888559 * Queries: replaces "?" in string with escaped "\?" for regex test */ // eslint-disable-next-line security/detect-non-literal-regexp const regex = new RegExp(pattern .replace(/\\/g, "\\\\") .replace(/\*/g, "[^ ]*") .replace(/\?/g, "\\?")); return regex.test(input); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * The ScopeSet class creates a set of scopes. Scopes are case-insensitive, unique values, so the Set object in JS makes * the most sense to implement for this class. All scopes are trimmed and converted to lower case strings in intersection and union functions * to ensure uniqueness of strings. */ class ScopeSet { constructor(inputScopes) { // Filter empty string and null/undefined array items const scopeArr = inputScopes ? StringUtils.trimArrayEntries([...inputScopes]) : []; const filteredInput = scopeArr ? StringUtils.removeEmptyStringsFromArray(scopeArr) : []; // Validate and filter scopes (validate function throws if validation fails) this.validateInputScopes(filteredInput); this.scopes = new Set(); // Iterator in constructor not supported by IE11 filteredInput.forEach((scope) => this.scopes.add(scope)); } /** * Factory method to create ScopeSet from space-delimited string * @param inputScopeString * @param appClientId * @param scopesRequired */ static fromString(inputScopeString) { const scopeString = inputScopeString || Constants$1.EMPTY_STRING; const inputScopes = scopeString.split(" "); return new ScopeSet(inputScopes); } /** * Creates the set of scopes to search for in cache lookups * @param inputScopeString * @returns */ static createSearchScopes(inputScopeString) { const scopeSet = new ScopeSet(inputScopeString); if (!scopeSet.containsOnlyOIDCScopes()) { scopeSet.removeOIDCScopes(); } else { scopeSet.removeScope(Constants$1.OFFLINE_ACCESS_SCOPE); } return scopeSet; } /** * Used to validate the scopes input parameter requested by the developer. * @param {Array} inputScopes - Developer requested permissions. Not all scopes are guaranteed to be included in the access token returned. * @param {boolean} scopesRequired - Boolean indicating whether the scopes array is required or not */ validateInputScopes(inputScopes) { // Check if scopes are required but not given or is an empty array if (!inputScopes || inputScopes.length < 1) { throw createClientConfigurationError(emptyInputScopesError); } } /** * Check if a given scope is present in this set of scopes. * @param scope */ containsScope(scope) { const lowerCaseScopes = this.printScopesLowerCase().split(" "); const lowerCaseScopesSet = new ScopeSet(lowerCaseScopes); // compare lowercase scopes return scope ? lowerCaseScopesSet.scopes.has(scope.toLowerCase()) : false; } /** * Check if a set of scopes is present in this set of scopes. * @param scopeSet */ containsScopeSet(scopeSet) { if (!scopeSet || scopeSet.scopes.size <= 0) { return false; } return (this.scopes.size >= scopeSet.scopes.size && scopeSet.asArray().every((scope) => this.containsScope(scope))); } /** * Check if set of scopes contains only the defaults */ containsOnlyOIDCScopes() { let defaultScopeCount = 0; OIDC_SCOPES.forEach((defaultScope) => { if (this.containsScope(defaultScope)) { defaultScopeCount += 1; } }); return this.scopes.size === defaultScopeCount; } /** * Appends single scope if passed * @param newScope */ appendScope(newScope) { if (newScope) { this.scopes.add(newScope.trim()); } } /** * Appends multiple scopes if passed * @param newScopes */ appendScopes(newScopes) { try { newScopes.forEach((newScope) => this.appendScope(newScope)); } catch (e) { throw createClientAuthError(cannotAppendScopeSet); } } /** * Removes element from set of scopes. * @param scope */ removeScope(scope) { if (!scope) { throw createClientAuthError(cannotRemoveEmptyScope); } this.scopes.delete(scope.trim()); } /** * Removes default scopes from set of scopes * Primarily used to prevent cache misses if the default scopes are not returned from the server */ removeOIDCScopes() { OIDC_SCOPES.forEach((defaultScope) => { this.scopes.delete(defaultScope); }); } /** * Combines an array of scopes with the current set of scopes. * @param otherScopes */ unionScopeSets(otherScopes) { if (!otherScopes) { throw createClientAuthError(emptyInputScopeSet); } const unionScopes = new Set(); // Iterator in constructor not supported in IE11 otherScopes.scopes.forEach((scope) => unionScopes.add(scope.toLowerCase())); this.scopes.forEach((scope) => unionScopes.add(scope.toLowerCase())); return unionScopes; } /** * Check if scopes intersect between this set and another. * @param otherScopes */ intersectingScopeSets(otherScopes) { if (!otherScopes) { throw createClientAuthError(emptyInputScopeSet); } // Do not allow OIDC scopes to be the only intersecting scopes if (!otherScopes.containsOnlyOIDCScopes()) { otherScopes.removeOIDCScopes(); } const unionScopes = this.unionScopeSets(otherScopes); const sizeOtherScopes = otherScopes.getScopeCount(); const sizeThisScopes = this.getScopeCount(); const sizeUnionScopes = unionScopes.size; return sizeUnionScopes < sizeThisScopes + sizeOtherScopes; } /** * Returns size of set of scopes. */ getScopeCount() { return this.scopes.size; } /** * Returns the scopes as an array of string values */ asArray() { const array = []; this.scopes.forEach((val) => array.push(val)); return array; } /** * Prints scopes into a space-delimited string */ printScopes() { if (this.scopes) { const scopeArr = this.asArray(); return scopeArr.join(" "); } return Constants$1.EMPTY_STRING; } /** * Prints scopes into a space-delimited lower-case string (used for caching) */ printScopesLowerCase() { return this.printScopes().toLowerCase(); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Function to build a client info object from server clientInfo string * @param rawClientInfo * @param crypto */ function buildClientInfo(rawClientInfo, base64Decode) { if (!rawClientInfo) { throw createClientAuthError(clientInfoEmptyError); } try { const decodedClientInfo = base64Decode(rawClientInfo); return JSON.parse(decodedClientInfo); } catch (e) { throw createClientAuthError(clientInfoDecodingError); } } /** * Function to build a client info object from cached homeAccountId string * @param homeAccountId */ function buildClientInfoFromHomeAccountId(homeAccountId) { if (!homeAccountId) { throw createClientAuthError(clientInfoDecodingError); } const clientInfoParts = homeAccountId.split(Separators.CLIENT_INFO_SEPARATOR, 2); return { uid: clientInfoParts[0], utid: clientInfoParts.length < 2 ? Constants$1.EMPTY_STRING : clientInfoParts[1], }; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Returns true if tenantId matches the utid portion of homeAccountId * @param tenantId * @param homeAccountId * @returns */ function tenantIdMatchesHomeTenant(tenantId, homeAccountId) { return (!!tenantId && !!homeAccountId && tenantId === homeAccountId.split(".")[1]); } /** * Build tenant profile * @param homeAccountId - Home account identifier for this account object * @param localAccountId - Local account identifer for this account object * @param tenantId - Full tenant or organizational id that this account belongs to * @param idTokenClaims - Claims from the ID token * @returns */ function buildTenantProfile(homeAccountId, localAccountId, tenantId, idTokenClaims) { if (idTokenClaims) { const { oid, sub, tid, name, tfp, acr } = idTokenClaims; /** * Since there is no way to determine if the authority is AAD or B2C, we exhaust all the possible claims that can serve as tenant ID with the following precedence: * tid - TenantID claim that identifies the tenant that issued the token in AAD. Expected in all AAD ID tokens, not present in B2C ID Tokens. * tfp - Trust Framework Policy claim that identifies the policy that was used to authenticate the user. Functions as tenant for B2C scenarios. * acr - Authentication Context Class Reference claim used only with older B2C policies. Fallback in case tfp is not present, but likely won't be present anyway. */ const tenantId = tid || tfp || acr || ""; return { tenantId: tenantId, localAccountId: oid || sub || "", name: name, isHomeTenant: tenantIdMatchesHomeTenant(tenantId, homeAccountId), }; } else { return { tenantId, localAccountId, isHomeTenant: tenantIdMatchesHomeTenant(tenantId, homeAccountId), }; } } /** * Replaces account info that varies by tenant profile sourced from the ID token claims passed in with the tenant-specific account info * @param baseAccountInfo * @param idTokenClaims * @returns */ function updateAccountTenantProfileData(baseAccountInfo, tenantProfile, idTokenClaims, idTokenSecret) { let updatedAccountInfo = baseAccountInfo; // Tenant Profile overrides passed in account info if (tenantProfile) { // eslint-disable-next-line @typescript-eslint/no-unused-vars const { isHomeTenant, ...tenantProfileOverride } = tenantProfile; updatedAccountInfo = { ...baseAccountInfo, ...tenantProfileOverride }; } // ID token claims override passed in account info and tenant profile if (idTokenClaims) { // Ignore isHomeTenant, loginHint, and sid which are part of tenant profile but not base account info // eslint-disable-next-line @typescript-eslint/no-unused-vars const { isHomeTenant, ...claimsSourcedTenantProfile } = buildTenantProfile(baseAccountInfo.homeAccountId, baseAccountInfo.localAccountId, baseAccountInfo.tenantId, idTokenClaims); updatedAccountInfo = { ...updatedAccountInfo, ...claimsSourcedTenantProfile, idTokenClaims: idTokenClaims, idToken: idTokenSecret, }; return updatedAccountInfo; } return updatedAccountInfo; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Authority types supported by MSAL. */ const AuthorityType = { Default: 0, Adfs: 1, Dsts: 2, Ciam: 3, }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Gets tenantId from available ID token claims to set as credential realm with the following precedence: * 1. tid - if the token is acquired from an Azure AD tenant tid will be present * 2. tfp - if the token is acquired from a modern B2C tenant tfp should be present * 3. acr - if the token is acquired from a legacy B2C tenant acr should be present * Downcased to match the realm case-insensitive comparison requirements * @param idTokenClaims * @returns */ function getTenantIdFromIdTokenClaims(idTokenClaims) { if (idTokenClaims) { const tenantId = idTokenClaims.tid || idTokenClaims.tfp || idTokenClaims.acr; return tenantId || null; } return null; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Protocol modes supported by MSAL. */ const ProtocolMode = { AAD: "AAD", OIDC: "OIDC", }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Type that defines required and optional parameters for an Account field (based on universal cache schema implemented by all MSALs). * * Key : Value Schema * * Key: -- * * Value Schema: * { * homeAccountId: home account identifier for the auth scheme, * environment: entity that issued the token, represented as a full host * realm: Full tenant or organizational identifier that the account belongs to * localAccountId: Original tenant-specific accountID, usually used for legacy cases * username: primary username that represents the user, usually corresponds to preferred_username in the v2 endpt * authorityType: Accounts authority type as a string * name: Full name for the account, including given name and family name, * lastModificationTime: last time this entity was modified in the cache * lastModificationApp: * nativeAccountId: Account identifier on the native device * tenantProfiles: Array of tenant profile objects for each tenant that the account has authenticated with in the browser * } * @internal */ class AccountEntity { /** * Generate Account Id key component as per the schema: - */ generateAccountId() { const accountId = [this.homeAccountId, this.environment]; return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase(); } /** * Generate Account Cache Key as per the schema: -- */ generateAccountKey() { return AccountEntity.generateAccountCacheKey({ homeAccountId: this.homeAccountId, environment: this.environment, tenantId: this.realm, username: this.username, localAccountId: this.localAccountId, }); } /** * Returns the AccountInfo interface for this account. */ getAccountInfo() { return { homeAccountId: this.homeAccountId, environment: this.environment, tenantId: this.realm, username: this.username, localAccountId: this.localAccountId, name: this.name, nativeAccountId: this.nativeAccountId, authorityType: this.authorityType, // Deserialize tenant profiles array into a Map tenantProfiles: new Map((this.tenantProfiles || []).map((tenantProfile) => { return [tenantProfile.tenantId, tenantProfile]; })), }; } /** * Returns true if the account entity is in single tenant format (outdated), false otherwise */ isSingleTenant() { return !this.tenantProfiles; } /** * Generates account key from interface * @param accountInterface */ static generateAccountCacheKey(accountInterface) { const homeTenantId = accountInterface.homeAccountId.split(".")[1]; const accountKey = [ accountInterface.homeAccountId, accountInterface.environment || "", homeTenantId || accountInterface.tenantId || "", ]; return accountKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase(); } /** * Build Account cache from IdToken, clientInfo and authority/policy. Associated with AAD. * @param accountDetails */ static createAccount(accountDetails, authority, base64Decode) { const account = new AccountEntity(); if (authority.authorityType === AuthorityType.Adfs) { account.authorityType = CacheAccountType.ADFS_ACCOUNT_TYPE; } else if (authority.protocolMode === ProtocolMode.AAD) { account.authorityType = CacheAccountType.MSSTS_ACCOUNT_TYPE; } else { account.authorityType = CacheAccountType.GENERIC_ACCOUNT_TYPE; } let clientInfo; if (accountDetails.clientInfo && base64Decode) { clientInfo = buildClientInfo(accountDetails.clientInfo, base64Decode); } account.clientInfo = accountDetails.clientInfo; account.homeAccountId = accountDetails.homeAccountId; account.nativeAccountId = accountDetails.nativeAccountId; const env = accountDetails.environment || (authority && authority.getPreferredCache()); if (!env) { throw createClientAuthError(invalidCacheEnvironment); } account.environment = env; // non AAD scenarios can have empty realm account.realm = clientInfo?.utid || getTenantIdFromIdTokenClaims(accountDetails.idTokenClaims) || ""; // How do you account for MSA CID here? account.localAccountId = clientInfo?.uid || accountDetails.idTokenClaims?.oid || accountDetails.idTokenClaims?.sub || ""; /* * In B2C scenarios the emails claim is used instead of preferred_username and it is an array. * In most cases it will contain a single email. This field should not be relied upon if a custom * policy is configured to return more than 1 email. */ const preferredUsername = accountDetails.idTokenClaims?.preferred_username || accountDetails.idTokenClaims?.upn; const email = accountDetails.idTokenClaims?.emails ? accountDetails.idTokenClaims.emails[0] : null; account.username = preferredUsername || email || ""; account.name = accountDetails.idTokenClaims?.name || ""; account.cloudGraphHostName = accountDetails.cloudGraphHostName; account.msGraphHost = accountDetails.msGraphHost; if (accountDetails.tenantProfiles) { account.tenantProfiles = accountDetails.tenantProfiles; } else { const tenantProfile = buildTenantProfile(accountDetails.homeAccountId, account.localAccountId, account.realm, accountDetails.idTokenClaims); account.tenantProfiles = [tenantProfile]; } return account; } /** * Creates an AccountEntity object from AccountInfo * @param accountInfo * @param cloudGraphHostName * @param msGraphHost * @returns */ static createFromAccountInfo(accountInfo, cloudGraphHostName, msGraphHost) { const account = new AccountEntity(); account.authorityType = accountInfo.authorityType || CacheAccountType.GENERIC_ACCOUNT_TYPE; account.homeAccountId = accountInfo.homeAccountId; account.localAccountId = accountInfo.localAccountId; account.nativeAccountId = accountInfo.nativeAccountId; account.realm = accountInfo.tenantId; account.environment = accountInfo.environment; account.username = accountInfo.username; account.name = accountInfo.name; account.cloudGraphHostName = cloudGraphHostName; account.msGraphHost = msGraphHost; // Serialize tenant profiles map into an array account.tenantProfiles = Array.from(accountInfo.tenantProfiles?.values() || []); return account; } /** * Generate HomeAccountId from server response * @param serverClientInfo * @param authType */ static generateHomeAccountId(serverClientInfo, authType, logger, cryptoObj, idTokenClaims) { // since ADFS/DSTS do not have tid and does not set client_info if (!(authType === AuthorityType.Adfs || authType === AuthorityType.Dsts)) { // for cases where there is clientInfo if (serverClientInfo) { try { const clientInfo = buildClientInfo(serverClientInfo, cryptoObj.base64Decode); if (clientInfo.uid && clientInfo.utid) { return `${clientInfo.uid}.${clientInfo.utid}`; } } catch (e) { } } logger.warning("No client info in response"); } // default to "sub" claim return idTokenClaims?.sub || ""; } /** * Validates an entity: checks for all expected params * @param entity */ static isAccountEntity(entity) { if (!entity) { return false; } return (entity.hasOwnProperty("homeAccountId") && entity.hasOwnProperty("environment") && entity.hasOwnProperty("realm") && entity.hasOwnProperty("localAccountId") && entity.hasOwnProperty("username") && entity.hasOwnProperty("authorityType")); } /** * Helper function to determine whether 2 accountInfo objects represent the same account * @param accountA * @param accountB * @param compareClaims - If set to true idTokenClaims will also be compared to determine account equality */ static accountInfoIsEqual(accountA, accountB, compareClaims) { if (!accountA || !accountB) { return false; } let claimsMatch = true; // default to true so as to not fail comparison below if compareClaims: false if (compareClaims) { const accountAClaims = (accountA.idTokenClaims || {}); const accountBClaims = (accountB.idTokenClaims || {}); // issued at timestamp and nonce are expected to change each time a new id token is acquired claimsMatch = accountAClaims.iat === accountBClaims.iat && accountAClaims.nonce === accountBClaims.nonce; } return (accountA.homeAccountId === accountB.homeAccountId && accountA.localAccountId === accountB.localAccountId && accountA.username === accountB.username && accountA.tenantId === accountB.tenantId && accountA.environment === accountB.environment && accountA.nativeAccountId === accountB.nativeAccountId && claimsMatch); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Parses hash string from given string. Returns empty string if no hash symbol is found. * @param hashString */ function stripLeadingHashOrQuery(responseString) { if (responseString.startsWith("#/")) { return responseString.substring(2); } else if (responseString.startsWith("#") || responseString.startsWith("?")) { return responseString.substring(1); } return responseString; } /** * Returns URL hash as server auth code response object. */ function getDeserializedResponse(responseString) { // Check if given hash is empty if (!responseString || responseString.indexOf("=") < 0) { return null; } try { // Strip the # or ? symbol if present const normalizedResponse = stripLeadingHashOrQuery(responseString); // If # symbol was not present, above will return empty string, so give original hash value const deserializedHash = Object.fromEntries(new URLSearchParams(normalizedResponse)); // Check for known response properties if (deserializedHash.code || deserializedHash.error || deserializedHash.error_description || deserializedHash.state) { return deserializedHash; } } catch (e) { throw createClientAuthError(hashNotDeserialized); } return null; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Url object class which can perform various transformations on url strings. */ class UrlString { get urlString() { return this._urlString; } constructor(url) { this._urlString = url; if (!this._urlString) { // Throws error if url is empty throw createClientConfigurationError(urlEmptyError); } if (!url.includes("#")) { this._urlString = UrlString.canonicalizeUri(url); } } /** * Ensure urls are lower case and end with a / character. * @param url */ static canonicalizeUri(url) { if (url) { let lowerCaseUrl = url.toLowerCase(); if (StringUtils.endsWith(lowerCaseUrl, "?")) { lowerCaseUrl = lowerCaseUrl.slice(0, -1); } else if (StringUtils.endsWith(lowerCaseUrl, "?/")) { lowerCaseUrl = lowerCaseUrl.slice(0, -2); } if (!StringUtils.endsWith(lowerCaseUrl, "/")) { lowerCaseUrl += "/"; } return lowerCaseUrl; } return url; } /** * Throws if urlString passed is not a valid authority URI string. */ validateAsUri() { // Attempts to parse url for uri components let components; try { components = this.getUrlComponents(); } catch (e) { throw createClientConfigurationError(urlParseError); } // Throw error if URI or path segments are not parseable. if (!components.HostNameAndPort || !components.PathSegments) { throw createClientConfigurationError(urlParseError); } // Throw error if uri is insecure. if (!components.Protocol || components.Protocol.toLowerCase() !== "https:") { throw createClientConfigurationError(authorityUriInsecure); } } /** * Given a url and a query string return the url with provided query string appended * @param url * @param queryString */ static appendQueryString(url, queryString) { if (!queryString) { return url; } return url.indexOf("?") < 0 ? `${url}?${queryString}` : `${url}&${queryString}`; } /** * Returns a url with the hash removed * @param url */ static removeHashFromUrl(url) { return UrlString.canonicalizeUri(url.split("#")[0]); } /** * Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns https://a:b/tenantId/d * @param href The url * @param tenantId The tenant id to replace */ replaceTenantPath(tenantId) { const urlObject = this.getUrlComponents(); const pathArray = urlObject.PathSegments; if (tenantId && pathArray.length !== 0 && (pathArray[0] === AADAuthorityConstants.COMMON || pathArray[0] === AADAuthorityConstants.ORGANIZATIONS)) { pathArray[0] = tenantId; } return UrlString.constructAuthorityUriFromObject(urlObject); } /** * Parses out the components from a url string. * @returns An object with the various components. Please cache this value insted of calling this multiple times on the same url. */ getUrlComponents() { // https://gist.github.com/curtisz/11139b2cfcaef4a261e0 const regEx = RegExp("^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?"); // If url string does not match regEx, we throw an error const match = this.urlString.match(regEx); if (!match) { throw createClientConfigurationError(urlParseError); } // Url component object const urlComponents = { Protocol: match[1], HostNameAndPort: match[4], AbsolutePath: match[5], QueryString: match[7], }; let pathSegments = urlComponents.AbsolutePath.split("/"); pathSegments = pathSegments.filter((val) => val && val.length > 0); // remove empty elements urlComponents.PathSegments = pathSegments; if (urlComponents.QueryString && urlComponents.QueryString.endsWith("/")) { urlComponents.QueryString = urlComponents.QueryString.substring(0, urlComponents.QueryString.length - 1); } return urlComponents; } static getDomainFromUrl(url) { const regEx = RegExp("^([^:/?#]+://)?([^/?#]*)"); const match = url.match(regEx); if (!match) { throw createClientConfigurationError(urlParseError); } return match[2]; } static getAbsoluteUrl(relativeUrl, baseUrl) { if (relativeUrl[0] === Constants$1.FORWARD_SLASH) { const url = new UrlString(baseUrl); const baseComponents = url.getUrlComponents(); return (baseComponents.Protocol + "//" + baseComponents.HostNameAndPort + relativeUrl); } return relativeUrl; } static constructAuthorityUriFromObject(urlObject) { return new UrlString(urlObject.Protocol + "//" + urlObject.HostNameAndPort + "/" + urlObject.PathSegments.join("/")); } /** * Check if the hash of the URL string contains known properties * @deprecated This API will be removed in a future version */ static hashContainsKnownProperties(response) { return !!getDeserializedResponse(response); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const rawMetdataJSON = { endpointMetadata: { "login.microsoftonline.com": { token_endpoint: "https://login.microsoftonline.com/{tenantid}/oauth2/v2.0/token", jwks_uri: "https://login.microsoftonline.com/{tenantid}/discovery/v2.0/keys", issuer: "https://login.microsoftonline.com/{tenantid}/v2.0", authorization_endpoint: "https://login.microsoftonline.com/{tenantid}/oauth2/v2.0/authorize", end_session_endpoint: "https://login.microsoftonline.com/{tenantid}/oauth2/v2.0/logout", }, "login.chinacloudapi.cn": { token_endpoint: "https://login.chinacloudapi.cn/{tenantid}/oauth2/v2.0/token", jwks_uri: "https://login.chinacloudapi.cn/{tenantid}/discovery/v2.0/keys", issuer: "https://login.partner.microsoftonline.cn/{tenantid}/v2.0", authorization_endpoint: "https://login.chinacloudapi.cn/{tenantid}/oauth2/v2.0/authorize", end_session_endpoint: "https://login.chinacloudapi.cn/{tenantid}/oauth2/v2.0/logout", }, "login.microsoftonline.us": { token_endpoint: "https://login.microsoftonline.us/{tenantid}/oauth2/v2.0/token", jwks_uri: "https://login.microsoftonline.us/{tenantid}/discovery/v2.0/keys", issuer: "https://login.microsoftonline.us/{tenantid}/v2.0", authorization_endpoint: "https://login.microsoftonline.us/{tenantid}/oauth2/v2.0/authorize", end_session_endpoint: "https://login.microsoftonline.us/{tenantid}/oauth2/v2.0/logout", }, }, instanceDiscoveryMetadata: { tenant_discovery_endpoint: "https://{canonicalAuthority}/v2.0/.well-known/openid-configuration", metadata: [ { preferred_network: "login.microsoftonline.com", preferred_cache: "login.windows.net", aliases: [ "login.microsoftonline.com", "login.windows.net", "login.microsoft.com", "sts.windows.net", ], }, { preferred_network: "login.partner.microsoftonline.cn", preferred_cache: "login.partner.microsoftonline.cn", aliases: [ "login.partner.microsoftonline.cn", "login.chinacloudapi.cn", ], }, { preferred_network: "login.microsoftonline.de", preferred_cache: "login.microsoftonline.de", aliases: ["login.microsoftonline.de"], }, { preferred_network: "login.microsoftonline.us", preferred_cache: "login.microsoftonline.us", aliases: [ "login.microsoftonline.us", "login.usgovcloudapi.net", ], }, { preferred_network: "login-us.microsoftonline.com", preferred_cache: "login-us.microsoftonline.com", aliases: ["login-us.microsoftonline.com"], }, ], }, }; const EndpointMetadata = rawMetdataJSON.endpointMetadata; const InstanceDiscoveryMetadata = rawMetdataJSON.instanceDiscoveryMetadata; const InstanceDiscoveryMetadataAliases = new Set(); InstanceDiscoveryMetadata.metadata.forEach((metadataEntry) => { metadataEntry.aliases.forEach((alias) => { InstanceDiscoveryMetadataAliases.add(alias); }); }); /** * Attempts to get an aliases array from the static authority metadata sources based on the canonical authority host * @param staticAuthorityOptions * @param logger * @returns */ function getAliasesFromStaticSources(staticAuthorityOptions, logger) { let staticAliases; const canonicalAuthority = staticAuthorityOptions.canonicalAuthority; if (canonicalAuthority) { const authorityHost = new UrlString(canonicalAuthority).getUrlComponents().HostNameAndPort; staticAliases = getAliasesFromMetadata(authorityHost, staticAuthorityOptions.cloudDiscoveryMetadata?.metadata, AuthorityMetadataSource.CONFIG, logger) || getAliasesFromMetadata(authorityHost, InstanceDiscoveryMetadata.metadata, AuthorityMetadataSource.HARDCODED_VALUES, logger) || staticAuthorityOptions.knownAuthorities; } return staticAliases || []; } /** * Returns aliases for from the raw cloud discovery metadata passed in * @param authorityHost * @param rawCloudDiscoveryMetadata * @returns */ function getAliasesFromMetadata(authorityHost, cloudDiscoveryMetadata, source, logger) { logger?.trace(`getAliasesFromMetadata called with source: ${source}`); if (authorityHost && cloudDiscoveryMetadata) { const metadata = getCloudDiscoveryMetadataFromNetworkResponse(cloudDiscoveryMetadata, authorityHost); if (metadata) { logger?.trace(`getAliasesFromMetadata: found cloud discovery metadata in ${source}, returning aliases`); return metadata.aliases; } else { logger?.trace(`getAliasesFromMetadata: did not find cloud discovery metadata in ${source}`); } } return null; } /** * Get cloud discovery metadata for common authorities */ function getCloudDiscoveryMetadataFromHardcodedValues(authorityHost) { const metadata = getCloudDiscoveryMetadataFromNetworkResponse(InstanceDiscoveryMetadata.metadata, authorityHost); return metadata; } /** * Searches instance discovery network response for the entry that contains the host in the aliases list * @param response * @param authority */ function getCloudDiscoveryMetadataFromNetworkResponse(response, authorityHost) { for (let i = 0; i < response.length; i++) { const metadata = response[i]; if (metadata.aliases.includes(authorityHost)) { return metadata; } } return null; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const cacheQuotaExceededErrorCode = "cache_quota_exceeded"; const cacheUnknownErrorCode = "cache_error_unknown"; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const CacheErrorMessages = { [cacheQuotaExceededErrorCode]: "Exceeded cache storage capacity.", [cacheUnknownErrorCode]: "Unexpected error occurred when using cache storage.", }; /** * Error thrown when there is an error with the cache */ class CacheError extends Error { constructor(errorCode, errorMessage) { const message = errorMessage || (CacheErrorMessages[errorCode] ? CacheErrorMessages[errorCode] : CacheErrorMessages[cacheUnknownErrorCode]); super(`${errorCode}: ${message}`); Object.setPrototypeOf(this, CacheError.prototype); this.name = "CacheError"; this.errorCode = errorCode; this.errorMessage = message; } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * 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, staticAuthorityOptions) { this.clientId = clientId; this.cryptoImpl = cryptoImpl; this.commonLogger = logger.clone(name$1, version$1); this.staticAuthorityOptions = staticAuthorityOptions; } /** * 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) { return this.buildTenantProfiles(this.getAccountsFilteredBy(accountFilter || {}), accountFilter); } /** * Gets first tenanted AccountInfo object found based on provided filters */ getAccountInfoFilteredBy(accountFilter) { const allAccounts = this.getAllAccounts(accountFilter); 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) { const accountEntities = this.getAccountsFilteredBy(accountFilter); if (accountEntities.length > 0) { return accountEntities[0].getAccountInfo(); } 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, accountFilter) { return cachedAccounts.flatMap((accountEntity) => { return this.getTenantProfilesFromAccountEntity(accountEntity, accountFilter?.tenantId, accountFilter); }); } getTenantedAccountInfoByFilter(accountInfo, tokenKeys, tenantProfile, tenantProfileFilter) { let tenantedAccountInfo = null; let idTokenClaims; if (tenantProfileFilter) { if (!this.tenantProfileMatchesFilter(tenantProfile, tenantProfileFilter)) { return null; } } const idToken = this.getIdToken(accountInfo, 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, targetTenantId, tenantProfileFilter) { const accountInfo = accountEntity.getAccountInfo(); 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, 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, storeInCache, correlationId) { if (!cacheRecord) { throw createClientAuthError(invalidCacheRecord); } try { if (!!cacheRecord.account) { this.setAccount(cacheRecord.account); } if (!!cacheRecord.idToken && storeInCache?.idToken !== false) { this.setIdTokenCredential(cacheRecord.idToken); } if (!!cacheRecord.accessToken && storeInCache?.accessToken !== false) { await this.saveAccessToken(cacheRecord.accessToken); } if (!!cacheRecord.refreshToken && storeInCache?.refreshToken !== false) { this.setRefreshTokenCredential(cacheRecord.refreshToken); } if (!!cacheRecord.appMetadata) { this.setAppMetadata(cacheRecord.appMetadata); } } catch (e) { this.commonLogger?.error(`CacheManager.saveCacheRecord: failed`); if (e instanceof Error) { this.commonLogger?.errorPii(`CacheManager.saveCacheRecord: ${e.message}`, correlationId); if (e.name === "QuotaExceededError" || e.name === "NS_ERROR_DOM_QUOTA_REACHED" || e.message.includes("exceeded the quota")) { this.commonLogger?.error(`CacheManager.saveCacheRecord: exceeded storage quota`, correlationId); throw new CacheError(cacheQuotaExceededErrorCode); } else { throw new CacheError(e.name, e.message); } } else { this.commonLogger?.errorPii(`CacheManager.saveCacheRecord: ${e}`, correlationId); throw new CacheError(cacheUnknownErrorCode); } } } /** * saves access token credential * @param credential */ async saveAccessToken(credential) { const accessTokenFilter = { clientId: credential.clientId, credentialType: credential.credentialType, environment: credential.environment, homeAccountId: credential.homeAccountId, realm: credential.realm, tokenType: credential.tokenType, requestedClaimsHash: credential.requestedClaimsHash, }; const tokenKeys = this.getTokenKeys(); const currentScopes = ScopeSet.fromString(credential.target); const removedAccessTokens = []; tokenKeys.accessToken.forEach((key) => { if (!this.accessTokenKeyMatchesFilter(key, accessTokenFilter, false)) { return; } const tokenEntity = this.getAccessTokenCredential(key); if (tokenEntity && this.credentialMatchesFilter(tokenEntity, accessTokenFilter)) { const tokenScopeSet = ScopeSet.fromString(tokenEntity.target); if (tokenScopeSet.intersectingScopeSets(currentScopes)) { removedAccessTokens.push(this.removeAccessToken(key)); } } }); await Promise.all(removedAccessTokens); this.setAccessTokenCredential(credential); } /** * 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) { const allAccountKeys = this.getAccountKeys(); const matchingAccounts = []; allAccountKeys.forEach((cacheKey) => { if (!this.isAccountKey(cacheKey, accountFilter.homeAccountId)) { // Don't parse value if the key doesn't match the account filters return; } const entity = this.getAccount(cacheKey, this.commonLogger); // 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)) { 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 true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided * @param key * @param homeAccountId * @param tenantId * @returns */ isAccountKey(key, homeAccountId, tenantId) { if (key.split(Separators.CACHE_KEY_SEPARATOR).length < 3) { // Account cache keys contain 3 items separated by '-' (each item may also contain '-') return false; } if (homeAccountId && !key.toLowerCase().includes(homeAccountId.toLowerCase())) { return false; } if (tenantId && !key.toLowerCase().includes(tenantId.toLowerCase())) { return false; } // Do not check environment as aliasing can cause false negatives return true; } /** * Returns true if the given key matches our credential key schema. * @param key */ isCredentialKey(key) { if (key.split(Separators.CACHE_KEY_SEPARATOR).length < 6) { // Credential cache keys contain 6 items separated by '-' (each item may also contain '-') return false; } const lowerCaseKey = key.toLowerCase(); // Credential keys must indicate what credential type they represent if (lowerCaseKey.indexOf(CredentialType.ID_TOKEN.toLowerCase()) === -1 && lowerCaseKey.indexOf(CredentialType.ACCESS_TOKEN.toLowerCase()) === -1 && lowerCaseKey.indexOf(CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME.toLowerCase()) === -1 && lowerCaseKey.indexOf(CredentialType.REFRESH_TOKEN.toLowerCase()) === -1) { return false; } if (lowerCaseKey.indexOf(CredentialType.REFRESH_TOKEN.toLowerCase()) > -1) { // Refresh tokens must contain the client id or family id const clientIdValidation = `${CredentialType.REFRESH_TOKEN}${Separators.CACHE_KEY_SEPARATOR}${this.clientId}${Separators.CACHE_KEY_SEPARATOR}`; const familyIdValidation = `${CredentialType.REFRESH_TOKEN}${Separators.CACHE_KEY_SEPARATOR}${THE_FAMILY_ID}${Separators.CACHE_KEY_SEPARATOR}`; if (lowerCaseKey.indexOf(clientIdValidation.toLowerCase()) === -1 && lowerCaseKey.indexOf(familyIdValidation.toLowerCase()) === -1) { return false; } } else if (lowerCaseKey.indexOf(this.clientId.toLowerCase()) === -1) { // Tokens must contain the clientId return false; } return true; } /** * Returns whether or not the given credential entity matches the filter * @param entity * @param filter * @returns */ credentialMatchesFilter(entity, filter) { 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)) { 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; } // If request OR cached entity has requested Claims Hash, check if they match if (filter.requestedClaimsHash || entity.requestedClaimsHash) { // Don't match if either is undefined or they are different if (entity.requestedClaimsHash !== filter.requestedClaimsHash) { 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 */ getAppMetadataFilteredBy(filter) { 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); if (!entity) { return; } if (!!filter.environment && !this.matchEnvironment(entity, filter.environment)) { return; } if (!!filter.clientId && !this.matchClientId(entity, filter.clientId)) { return; } matchingAppMetadata[cacheKey] = entity; }); return matchingAppMetadata; } /** * retrieve authorityMetadata that contains a matching alias * @param filter */ getAuthorityMetadataByAlias(host) { 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); if (!entity) { return; } if (entity.aliases.indexOf(host) === -1) { return; } matchedEntity = entity; }); return matchedEntity; } /** * Removes all accounts and related tokens from cache. */ async removeAllAccounts() { const allAccountKeys = this.getAccountKeys(); const removedAccounts = []; allAccountKeys.forEach((cacheKey) => { removedAccounts.push(this.removeAccount(cacheKey)); }); await Promise.all(removedAccounts); } /** * Removes the account and related tokens for a given account key * @param account */ async removeAccount(accountKey) { const account = this.getAccount(accountKey, this.commonLogger); if (!account) { return; } await this.removeAccountContext(account); this.removeItem(accountKey); } /** * Removes credentials associated with the provided account * @param account */ async removeAccountContext(account) { const allTokenKeys = this.getTokenKeys(); const accountId = account.generateAccountId(); const removedCredentials = []; allTokenKeys.idToken.forEach((key) => { if (key.indexOf(accountId) === 0) { this.removeIdToken(key); } }); allTokenKeys.accessToken.forEach((key) => { if (key.indexOf(accountId) === 0) { removedCredentials.push(this.removeAccessToken(key)); } }); allTokenKeys.refreshToken.forEach((key) => { if (key.indexOf(accountId) === 0) { this.removeRefreshToken(key); } }); await Promise.all(removedCredentials); } /** * Migrates a single-tenant account and all it's associated alternate cross-tenant account objects in the * cache into a condensed multi-tenant account object with tenant profiles. * @param accountKey * @param accountEntity * @param logger * @returns */ updateOutdatedCachedAccount(accountKey, accountEntity, logger) { // Only update if account entity is defined and has no tenantProfiles object (is outdated) if (accountEntity && accountEntity.isSingleTenant()) { this.commonLogger?.verbose("updateOutdatedCachedAccount: Found a single-tenant (outdated) account entity in the cache, migrating to multi-tenant account entity"); // Get keys of all accounts belonging to user const matchingAccountKeys = this.getAccountKeys().filter((key) => { return key.startsWith(accountEntity.homeAccountId); }); // Get all account entities belonging to user const accountsToMerge = []; matchingAccountKeys.forEach((key) => { const account = this.getCachedAccountEntity(key); if (account) { accountsToMerge.push(account); } }); // Set base account to home account if available, any account if not const baseAccount = accountsToMerge.find((account) => { return tenantIdMatchesHomeTenant(account.realm, account.homeAccountId); }) || accountsToMerge[0]; // Populate tenant profiles built from each account entity belonging to the user baseAccount.tenantProfiles = accountsToMerge.map((account) => { return { tenantId: account.realm, localAccountId: account.localAccountId, name: account.name, isHomeTenant: tenantIdMatchesHomeTenant(account.realm, account.homeAccountId), }; }); const updatedAccount = CacheManager.toObject(new AccountEntity(), { ...baseAccount, }); const newAccountKey = updatedAccount.generateAccountKey(); // Clear cache of legacy account objects that have been collpsed into tenant profiles matchingAccountKeys.forEach((key) => { if (key !== newAccountKey) { this.removeOutdatedAccount(accountKey); } }); // Cache updated account object this.setAccount(updatedAccount); logger?.verbose("Updated an outdated account entity in the cache"); return updatedAccount; } // No update is necessary return accountEntity; } /** * returns a boolean if the given credential is removed * @param credential */ async removeAccessToken(key) { const credential = this.getAccessTokenCredential(key); if (!credential) { return; } // 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) { try { await this.cryptoImpl.removeTokenBindingKey(kid); } catch (error) { throw createClientAuthError(bindingKeyNotRemoved); } } } } return this.removeItem(key); } /** * Removes all app metadata objects from cache. */ removeAppMetadata() { const allCacheKeys = this.getKeys(); allCacheKeys.forEach((cacheKey) => { if (this.isAppMetadata(cacheKey)) { this.removeItem(cacheKey); } }); return true; } /** * Retrieve AccountEntity from cache * @param account */ readAccountFromCache(account) { const accountKey = AccountEntity.generateAccountCacheKey(account); return this.getAccount(accountKey, this.commonLogger); } /** * Retrieve IdTokenEntity from cache * @param account {AccountInfo} * @param tokenKeys {?TokenKeys} * @param targetRealm {?string} * @param performanceClient {?IPerformanceClient} * @param correlationId {?string} */ getIdToken(account, tokenKeys, targetRealm, performanceClient, correlationId) { this.commonLogger.trace("CacheManager - getIdToken called"); const idTokenFilter = { homeAccountId: account.homeAccountId, environment: account.environment, credentialType: CredentialType.ID_TOKEN, clientId: this.clientId, realm: targetRealm, }; const idTokenMap = this.getIdTokensByFilter(idTokenFilter, tokenKeys); const numIdTokens = idTokenMap.size; if (numIdTokens < 1) { this.commonLogger.info("CacheManager:getIdToken - No token found"); 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"); 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"); 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"); tokensToBeRemoved.forEach((idToken, key) => { this.removeIdToken(key); }); if (performanceClient && correlationId) { performanceClient.addFields({ multiMatchedID: idTokenMap.size }, correlationId); } return null; } this.commonLogger.info("CacheManager:getIdToken - Returning ID token"); return idTokenMap.values().next().value; } /** * Gets all idTokens matching the given filter * @param filter * @returns */ getIdTokensByFilter(filter, 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); if (idToken && this.credentialMatchesFilter(idToken, filter)) { 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) { this.removeItem(key); } /** * Removes refresh token from the cache * @param key */ removeRefreshToken(key) { this.removeItem(key); } /** * Retrieve AccessTokenEntity from cache * @param account {AccountInfo} * @param request {BaseAuthRequest} * @param tokenKeys {?TokenKeys} * @param performanceClient {?IPerformanceClient} * @param correlationId {?string} */ getAccessToken(account, request, tokenKeys, targetRealm, performanceClient, correlationId) { this.commonLogger.trace("CacheManager - getAccessToken called"); 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, requestedClaimsHash: request.requestedClaimsHash, }; 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); // Validate value if (accessToken && this.credentialMatchesFilter(accessToken, accessTokenFilter)) { accessTokens.push(accessToken); } } }); const numAccessTokens = accessTokens.length; if (numAccessTokens < 1) { this.commonLogger.info("CacheManager:getAccessToken - No token found"); return null; } else if (numAccessTokens > 1) { this.commonLogger.info("CacheManager:getAccessToken - Multiple access tokens found, clearing them"); accessTokens.forEach((accessToken) => { void this.removeAccessToken(generateCredentialKey(accessToken)); }); if (performanceClient && correlationId) { performanceClient.addFields({ multiMatchedAT: accessTokens.length }, correlationId); } return null; } this.commonLogger.info("CacheManager:getAccessToken - Returning access token"); 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.requestedClaimsHash && key.indexOf(filter.requestedClaimsHash.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) { const tokenKeys = this.getTokenKeys(); const accessTokens = []; tokenKeys.accessToken.forEach((key) => { if (!this.accessTokenKeyMatchesFilter(key, filter, true)) { return; } const accessToken = this.getAccessTokenCredential(key); if (accessToken && this.credentialMatchesFilter(accessToken, filter)) { 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, tokenKeys, performanceClient, correlationId) { this.commonLogger.trace("CacheManager - getRefreshToken called"); 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); // Validate value if (refreshToken && this.credentialMatchesFilter(refreshToken, refreshTokenFilter)) { refreshTokens.push(refreshToken); } } }); const numRefreshTokens = refreshTokens.length; if (numRefreshTokens < 1) { this.commonLogger.info("CacheManager:getRefreshToken - No refresh token found."); return null; } // address the else case after remove functions address environment aliases if (numRefreshTokens > 1 && performanceClient && correlationId) { performanceClient.addFields({ multiMatchedRT: numRefreshTokens }, correlationId); } this.commonLogger.info("CacheManager:getRefreshToken - returning refresh token"); 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) { const appMetadataFilter = { environment, clientId: this.clientId, }; const appMetadata = this.getAppMetadataFilteredBy(appMetadataFilter); 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) { const appMetadata = this.readAppMetadataFromCache(environment); 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) { // 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); 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); 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_CONSTANTS.CACHE_KEY) !== -1; } /** * returns cache key used for cloud instance metadata */ generateAuthorityMetadataCacheKey(authority) { return `${AUTHORITY_METADATA_CONSTANTS.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 { setAccount() { throw createClientAuthError(methodNotImplemented); } getAccount() { throw createClientAuthError(methodNotImplemented); } getCachedAccountEntity() { throw createClientAuthError(methodNotImplemented); } setIdTokenCredential() { throw createClientAuthError(methodNotImplemented); } getIdTokenCredential() { throw createClientAuthError(methodNotImplemented); } setAccessTokenCredential() { throw createClientAuthError(methodNotImplemented); } getAccessTokenCredential() { throw createClientAuthError(methodNotImplemented); } 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); } updateCredentialCacheKey() { throw createClientAuthError(methodNotImplemented); } removeOutdatedAccount() { throw createClientAuthError(methodNotImplemented); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const DEFAULT_SYSTEM_OPTIONS$1 = { tokenRenewalOffsetSeconds: DEFAULT_TOKEN_RENEWAL_OFFSET_SEC, preventCorsPreflight: false, }; const DEFAULT_LOGGER_IMPLEMENTATION = { loggerCallback: () => { // allow users to not set loggerCallback }, piiLoggingEnabled: false, logLevel: exports.LogLevel.Info, correlationId: Constants$1.EMPTY_STRING, }; const DEFAULT_CACHE_OPTIONS$1 = { claimsBasedCachingEnabled: false, }; const DEFAULT_NETWORK_IMPLEMENTATION = { async sendGetRequestAsync() { throw createClientAuthError(methodNotImplemented); }, async sendPostRequestAsync() { throw createClientAuthError(methodNotImplemented); }, }; const DEFAULT_LIBRARY_INFO = { sku: Constants$1.SKU, version: version$1, cpu: Constants$1.EMPTY_STRING, os: Constants$1.EMPTY_STRING, }; const DEFAULT_CLIENT_CREDENTIALS = { clientSecret: Constants$1.EMPTY_STRING, clientAssertion: undefined, }; const DEFAULT_AZURE_CLOUD_OPTIONS = { azureCloudInstance: AzureCloudInstance.None, tenant: `${Constants$1.DEFAULT_COMMON_TENANT}`, }; const DEFAULT_TELEMETRY_OPTIONS$1 = { application: { appName: "", appVersion: "", }, }; /** * Function that sets the default options when not explicitly configured from app developer * * @param Configuration * * @returns Configuration */ function buildClientConfiguration({ authOptions: userAuthOptions, systemOptions: userSystemOptions, loggerOptions: userLoggerOption, cacheOptions: userCacheOptions, storageInterface: storageImplementation, networkInterface: networkImplementation, cryptoInterface: cryptoImplementation, clientCredentials: clientCredentials, libraryInfo: libraryInfo, telemetry: telemetry, serverTelemetryManager: serverTelemetryManager, persistencePlugin: persistencePlugin, serializableCache: serializableCache, }) { const loggerOptions = { ...DEFAULT_LOGGER_IMPLEMENTATION, ...userLoggerOption, }; return { authOptions: buildAuthOptions(userAuthOptions), systemOptions: { ...DEFAULT_SYSTEM_OPTIONS$1, ...userSystemOptions }, loggerOptions: loggerOptions, cacheOptions: { ...DEFAULT_CACHE_OPTIONS$1, ...userCacheOptions }, storageInterface: storageImplementation || new DefaultStorageClass(userAuthOptions.clientId, DEFAULT_CRYPTO_IMPLEMENTATION, new Logger(loggerOptions)), networkInterface: networkImplementation || DEFAULT_NETWORK_IMPLEMENTATION, cryptoInterface: cryptoImplementation || DEFAULT_CRYPTO_IMPLEMENTATION, clientCredentials: clientCredentials || DEFAULT_CLIENT_CREDENTIALS, libraryInfo: { ...DEFAULT_LIBRARY_INFO, ...libraryInfo }, telemetry: { ...DEFAULT_TELEMETRY_OPTIONS$1, ...telemetry }, serverTelemetryManager: serverTelemetryManager || null, persistencePlugin: persistencePlugin || null, serializableCache: serializableCache || null, }; } /** * Construct authoptions from the client and platform passed values * @param authOptions */ function buildAuthOptions(authOptions) { return { clientCapabilities: [], azureCloudOptions: DEFAULT_AZURE_CLOUD_OPTIONS, skipAuthorityMetadataCache: false, instanceAware: false, ...authOptions, }; } /** * Returns true if config has protocolMode set to ProtocolMode.OIDC, false otherwise * @param ClientConfiguration */ function isOidcProtocolMode(config) { return (config.authOptions.authority.options.protocolMode === ProtocolMode.OIDC); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const CcsCredentialType = { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN", }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const CLIENT_ID = "client_id"; const REDIRECT_URI = "redirect_uri"; const RESPONSE_TYPE = "response_type"; const RESPONSE_MODE = "response_mode"; const GRANT_TYPE = "grant_type"; const CLAIMS = "claims"; const SCOPE = "scope"; const REFRESH_TOKEN = "refresh_token"; const STATE = "state"; const NONCE = "nonce"; const PROMPT = "prompt"; const CODE = "code"; const CODE_CHALLENGE = "code_challenge"; const CODE_CHALLENGE_METHOD = "code_challenge_method"; const CODE_VERIFIER = "code_verifier"; const CLIENT_REQUEST_ID = "client-request-id"; const X_CLIENT_SKU = "x-client-SKU"; const X_CLIENT_VER = "x-client-VER"; const X_CLIENT_OS = "x-client-OS"; const X_CLIENT_CPU = "x-client-CPU"; const X_CLIENT_CURR_TELEM = "x-client-current-telemetry"; const X_CLIENT_LAST_TELEM = "x-client-last-telemetry"; const X_MS_LIB_CAPABILITY = "x-ms-lib-capability"; const X_APP_NAME = "x-app-name"; const X_APP_VER = "x-app-ver"; const POST_LOGOUT_URI = "post_logout_redirect_uri"; const ID_TOKEN_HINT = "id_token_hint"; const DEVICE_CODE = "device_code"; const CLIENT_SECRET = "client_secret"; const CLIENT_ASSERTION = "client_assertion"; const CLIENT_ASSERTION_TYPE = "client_assertion_type"; const TOKEN_TYPE = "token_type"; const REQ_CNF = "req_cnf"; const OBO_ASSERTION = "assertion"; const REQUESTED_TOKEN_USE = "requested_token_use"; const ON_BEHALF_OF = "on_behalf_of"; const RETURN_SPA_CODE = "return_spa_code"; const NATIVE_BROKER = "nativebroker"; const LOGOUT_HINT = "logout_hint"; const SID = "sid"; const LOGIN_HINT = "login_hint"; const DOMAIN_HINT = "domain_hint"; const X_CLIENT_EXTRA_SKU = "x-client-xtra-sku"; const BROKER_CLIENT_ID = "brk_client_id"; const BROKER_REDIRECT_URI = "brk_redirect_uri"; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Validates server consumable params from the "request" objects */ class RequestValidator { /** * Utility to check if the `redirectUri` in the request is a non-null value * @param redirectUri */ static validateRedirectUri(redirectUri) { if (!redirectUri) { throw createClientConfigurationError(redirectUriEmpty); } } /** * Utility to validate prompt sent by the user in the request * @param prompt */ static validatePrompt(prompt) { const promptValues = []; for (const value in PromptValue) { promptValues.push(PromptValue[value]); } if (promptValues.indexOf(prompt) < 0) { throw createClientConfigurationError(invalidPromptValue); } } static validateClaims(claims) { try { JSON.parse(claims); } catch (e) { throw createClientConfigurationError(invalidClaims); } } /** * Utility to validate code_challenge and code_challenge_method * @param codeChallenge * @param codeChallengeMethod */ static validateCodeChallengeParams(codeChallenge, codeChallengeMethod) { if (!codeChallenge || !codeChallengeMethod) { throw createClientConfigurationError(pkceParamsMissing); } else { this.validateCodeChallengeMethod(codeChallengeMethod); } } /** * Utility to validate code_challenge_method * @param codeChallengeMethod */ static validateCodeChallengeMethod(codeChallengeMethod) { if ([ CodeChallengeMethodValues.PLAIN, CodeChallengeMethodValues.S256, ].indexOf(codeChallengeMethod) < 0) { throw createClientConfigurationError(invalidCodeChallengeMethod); } } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ function instrumentBrokerParams(parameters, correlationId, performanceClient) { if (!correlationId) { return; } const clientId = parameters.get(CLIENT_ID); if (clientId && parameters.has(BROKER_CLIENT_ID)) { performanceClient?.addFields({ embeddedClientId: clientId, embeddedRedirectUri: parameters.get(REDIRECT_URI), }, correlationId); } } /** @internal */ class RequestParameterBuilder { constructor(correlationId, performanceClient) { this.parameters = new Map(); this.performanceClient = performanceClient; this.correlationId = correlationId; } /** * add response_type = code */ addResponseTypeCode() { this.parameters.set(RESPONSE_TYPE, encodeURIComponent(Constants$1.CODE_RESPONSE_TYPE)); } /** * add response_type = token id_token */ addResponseTypeForTokenAndIdToken() { this.parameters.set(RESPONSE_TYPE, encodeURIComponent(`${Constants$1.TOKEN_RESPONSE_TYPE} ${Constants$1.ID_TOKEN_RESPONSE_TYPE}`)); } /** * add response_mode. defaults to query. * @param responseMode */ addResponseMode(responseMode) { this.parameters.set(RESPONSE_MODE, encodeURIComponent(responseMode ? responseMode : ResponseMode.QUERY)); } /** * Add flag to indicate STS should attempt to use WAM if available */ addNativeBroker() { this.parameters.set(NATIVE_BROKER, encodeURIComponent("1")); } /** * add scopes. set addOidcScopes to false to prevent default scopes in non-user scenarios * @param scopeSet * @param addOidcScopes */ addScopes(scopes, addOidcScopes = true, defaultScopes = OIDC_DEFAULT_SCOPES) { // Always add openid to the scopes when adding OIDC scopes if (addOidcScopes && !defaultScopes.includes("openid") && !scopes.includes("openid")) { defaultScopes.push("openid"); } const requestScopes = addOidcScopes ? [...(scopes || []), ...defaultScopes] : scopes || []; const scopeSet = new ScopeSet(requestScopes); this.parameters.set(SCOPE, encodeURIComponent(scopeSet.printScopes())); } /** * add clientId * @param clientId */ addClientId(clientId) { this.parameters.set(CLIENT_ID, encodeURIComponent(clientId)); } /** * add redirect_uri * @param redirectUri */ addRedirectUri(redirectUri) { RequestValidator.validateRedirectUri(redirectUri); this.parameters.set(REDIRECT_URI, encodeURIComponent(redirectUri)); } /** * add post logout redirectUri * @param redirectUri */ addPostLogoutRedirectUri(redirectUri) { RequestValidator.validateRedirectUri(redirectUri); this.parameters.set(POST_LOGOUT_URI, encodeURIComponent(redirectUri)); } /** * add id_token_hint to logout request * @param idTokenHint */ addIdTokenHint(idTokenHint) { this.parameters.set(ID_TOKEN_HINT, encodeURIComponent(idTokenHint)); } /** * add domain_hint * @param domainHint */ addDomainHint(domainHint) { this.parameters.set(DOMAIN_HINT, encodeURIComponent(domainHint)); } /** * add login_hint * @param loginHint */ addLoginHint(loginHint) { this.parameters.set(LOGIN_HINT, encodeURIComponent(loginHint)); } /** * Adds the CCS (Cache Credential Service) query parameter for login_hint * @param loginHint */ addCcsUpn(loginHint) { this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`UPN:${loginHint}`)); } /** * Adds the CCS (Cache Credential Service) query parameter for account object * @param loginHint */ addCcsOid(clientInfo) { this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`Oid:${clientInfo.uid}@${clientInfo.utid}`)); } /** * add sid * @param sid */ addSid(sid) { this.parameters.set(SID, encodeURIComponent(sid)); } /** * add claims * @param claims */ addClaims(claims, clientCapabilities) { const mergedClaims = this.addClientCapabilitiesToClaims(claims, clientCapabilities); RequestValidator.validateClaims(mergedClaims); this.parameters.set(CLAIMS, encodeURIComponent(mergedClaims)); } /** * add correlationId * @param correlationId */ addCorrelationId(correlationId) { this.parameters.set(CLIENT_REQUEST_ID, encodeURIComponent(correlationId)); } /** * add library info query params * @param libraryInfo */ addLibraryInfo(libraryInfo) { // Telemetry Info this.parameters.set(X_CLIENT_SKU, libraryInfo.sku); this.parameters.set(X_CLIENT_VER, libraryInfo.version); if (libraryInfo.os) { this.parameters.set(X_CLIENT_OS, libraryInfo.os); } if (libraryInfo.cpu) { this.parameters.set(X_CLIENT_CPU, libraryInfo.cpu); } } /** * Add client telemetry parameters * @param appTelemetry */ addApplicationTelemetry(appTelemetry) { if (appTelemetry?.appName) { this.parameters.set(X_APP_NAME, appTelemetry.appName); } if (appTelemetry?.appVersion) { this.parameters.set(X_APP_VER, appTelemetry.appVersion); } } /** * add prompt * @param prompt */ addPrompt(prompt) { RequestValidator.validatePrompt(prompt); this.parameters.set(`${PROMPT}`, encodeURIComponent(prompt)); } /** * add state * @param state */ addState(state) { if (state) { this.parameters.set(STATE, encodeURIComponent(state)); } } /** * add nonce * @param nonce */ addNonce(nonce) { this.parameters.set(NONCE, encodeURIComponent(nonce)); } /** * add code_challenge and code_challenge_method * - throw if either of them are not passed * @param codeChallenge * @param codeChallengeMethod */ addCodeChallengeParams(codeChallenge, codeChallengeMethod) { RequestValidator.validateCodeChallengeParams(codeChallenge, codeChallengeMethod); if (codeChallenge && codeChallengeMethod) { this.parameters.set(CODE_CHALLENGE, encodeURIComponent(codeChallenge)); this.parameters.set(CODE_CHALLENGE_METHOD, encodeURIComponent(codeChallengeMethod)); } else { throw createClientConfigurationError(pkceParamsMissing); } } /** * add the `authorization_code` passed by the user to exchange for a token * @param code */ addAuthorizationCode(code) { this.parameters.set(CODE, encodeURIComponent(code)); } /** * add the `authorization_code` passed by the user to exchange for a token * @param code */ addDeviceCode(code) { this.parameters.set(DEVICE_CODE, encodeURIComponent(code)); } /** * add the `refreshToken` passed by the user * @param refreshToken */ addRefreshToken(refreshToken) { this.parameters.set(REFRESH_TOKEN, encodeURIComponent(refreshToken)); } /** * add the `code_verifier` passed by the user to exchange for a token * @param codeVerifier */ addCodeVerifier(codeVerifier) { this.parameters.set(CODE_VERIFIER, encodeURIComponent(codeVerifier)); } /** * add client_secret * @param clientSecret */ addClientSecret(clientSecret) { this.parameters.set(CLIENT_SECRET, encodeURIComponent(clientSecret)); } /** * add clientAssertion for confidential client flows * @param clientAssertion */ addClientAssertion(clientAssertion) { if (clientAssertion) { this.parameters.set(CLIENT_ASSERTION, encodeURIComponent(clientAssertion)); } } /** * add clientAssertionType for confidential client flows * @param clientAssertionType */ addClientAssertionType(clientAssertionType) { if (clientAssertionType) { this.parameters.set(CLIENT_ASSERTION_TYPE, encodeURIComponent(clientAssertionType)); } } /** * add OBO assertion for confidential client flows * @param clientAssertion */ addOboAssertion(oboAssertion) { this.parameters.set(OBO_ASSERTION, encodeURIComponent(oboAssertion)); } /** * add grant type * @param grantType */ addRequestTokenUse(tokenUse) { this.parameters.set(REQUESTED_TOKEN_USE, encodeURIComponent(tokenUse)); } /** * add grant type * @param grantType */ addGrantType(grantType) { this.parameters.set(GRANT_TYPE, encodeURIComponent(grantType)); } /** * add client info * */ addClientInfo() { this.parameters.set(CLIENT_INFO, "1"); } /** * add extraQueryParams * @param eQParams */ addExtraQueryParameters(eQParams) { Object.entries(eQParams).forEach(([key, value]) => { if (!this.parameters.has(key) && value) { this.parameters.set(key, value); } }); } addClientCapabilitiesToClaims(claims, clientCapabilities) { let mergedClaims; // Parse provided claims into JSON object or initialize empty object if (!claims) { mergedClaims = {}; } else { try { mergedClaims = JSON.parse(claims); } catch (e) { throw createClientConfigurationError(invalidClaims); } } if (clientCapabilities && clientCapabilities.length > 0) { if (!mergedClaims.hasOwnProperty(ClaimsRequestKeys.ACCESS_TOKEN)) { // Add access_token key to claims object mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN] = {}; } // Add xms_cc claim with provided clientCapabilities to access_token key mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN][ClaimsRequestKeys.XMS_CC] = { values: clientCapabilities, }; } return JSON.stringify(mergedClaims); } /** * adds `username` for Password Grant flow * @param username */ addUsername(username) { this.parameters.set(PasswordGrantConstants.username, encodeURIComponent(username)); } /** * adds `password` for Password Grant flow * @param password */ addPassword(password) { this.parameters.set(PasswordGrantConstants.password, encodeURIComponent(password)); } /** * add pop_jwk to query params * @param cnfString */ addPopToken(cnfString) { if (cnfString) { this.parameters.set(TOKEN_TYPE, AuthenticationScheme.POP); this.parameters.set(REQ_CNF, encodeURIComponent(cnfString)); } } /** * add SSH JWK and key ID to query params */ addSshJwk(sshJwkString) { if (sshJwkString) { this.parameters.set(TOKEN_TYPE, AuthenticationScheme.SSH); this.parameters.set(REQ_CNF, encodeURIComponent(sshJwkString)); } } /** * add server telemetry fields * @param serverTelemetryManager */ addServerTelemetry(serverTelemetryManager) { this.parameters.set(X_CLIENT_CURR_TELEM, serverTelemetryManager.generateCurrentRequestHeaderValue()); this.parameters.set(X_CLIENT_LAST_TELEM, serverTelemetryManager.generateLastRequestHeaderValue()); } /** * Adds parameter that indicates to the server that throttling is supported */ addThrottling() { this.parameters.set(X_MS_LIB_CAPABILITY, ThrottlingConstants.X_MS_LIB_CAPABILITY_VALUE); } /** * Adds logout_hint parameter for "silent" logout which prevent server account picker */ addLogoutHint(logoutHint) { this.parameters.set(LOGOUT_HINT, encodeURIComponent(logoutHint)); } addBrokerParameters(params) { const brokerParams = {}; brokerParams[BROKER_CLIENT_ID] = params.brokerClientId; brokerParams[BROKER_REDIRECT_URI] = params.brokerRedirectUri; this.addExtraQueryParameters(brokerParams); } /** * Utility to create a URL from the params map */ createQueryString() { const queryParameterArray = new Array(); this.parameters.forEach((value, key) => { queryParameterArray.push(`${key}=${value}`); }); instrumentBrokerParams(this.parameters, this.correlationId, this.performanceClient); return queryParameterArray.join("&"); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ function isOpenIdConfigResponse(response) { return (response.hasOwnProperty("authorization_endpoint") && response.hasOwnProperty("token_endpoint") && response.hasOwnProperty("issuer") && response.hasOwnProperty("jwks_uri")); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ function isCloudInstanceDiscoveryResponse(response) { return (response.hasOwnProperty("tenant_discovery_endpoint") && response.hasOwnProperty("metadata")); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ function isCloudInstanceDiscoveryErrorResponse(response) { return (response.hasOwnProperty("error") && response.hasOwnProperty("error_description")); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Enumeration of operations that are instrumented by have their performance measured by the PerformanceClient. * * @export * @enum {number} */ const PerformanceEvents = { /** * acquireTokenByCode API (msal-browser and msal-node). * Used to acquire tokens by trading an authorization code against the token endpoint. */ AcquireTokenByCode: "acquireTokenByCode", /** * acquireTokenByRefreshToken API (msal-browser and msal-node). * Used to renew an access token using a refresh token against the token endpoint. */ AcquireTokenByRefreshToken: "acquireTokenByRefreshToken", /** * acquireTokenSilent API (msal-browser and msal-node). * Used to silently acquire a new access token (from the cache or the network). */ AcquireTokenSilent: "acquireTokenSilent", /** * acquireTokenSilentAsync (msal-browser). * Internal API for acquireTokenSilent. */ AcquireTokenSilentAsync: "acquireTokenSilentAsync", /** * acquireTokenPopup (msal-browser). * Used to acquire a new access token interactively through pop ups */ AcquireTokenPopup: "acquireTokenPopup", /** * acquireTokenPreRedirect (msal-browser). * First part of the redirect flow. * Used to acquire a new access token interactively through redirects. */ AcquireTokenPreRedirect: "acquireTokenPreRedirect", /** * acquireTokenRedirect (msal-browser). * Second part of the redirect flow. * Used to acquire a new access token interactively through redirects. */ AcquireTokenRedirect: "acquireTokenRedirect", /** * getPublicKeyThumbprint API in CryptoOpts class (msal-browser). * Used to generate a public/private keypair and generate a public key thumbprint for pop requests. */ CryptoOptsGetPublicKeyThumbprint: "cryptoOptsGetPublicKeyThumbprint", /** * signJwt API in CryptoOpts class (msal-browser). * Used to signed a pop token. */ CryptoOptsSignJwt: "cryptoOptsSignJwt", /** * acquireToken API in the SilentCacheClient class (msal-browser). * Used to read access tokens from the cache. */ SilentCacheClientAcquireToken: "silentCacheClientAcquireToken", /** * acquireToken API in the SilentIframeClient class (msal-browser). * Used to acquire a new set of tokens from the authorize endpoint in a hidden iframe. */ SilentIframeClientAcquireToken: "silentIframeClientAcquireToken", AwaitConcurrentIframe: "awaitConcurrentIframe", /** * acquireToken API in SilentRereshClient (msal-browser). * Used to acquire a new set of tokens from the token endpoint using a refresh token. */ SilentRefreshClientAcquireToken: "silentRefreshClientAcquireToken", /** * ssoSilent API (msal-browser). * Used to silently acquire an authorization code and set of tokens using a hidden iframe. */ SsoSilent: "ssoSilent", /** * getDiscoveredAuthority API in StandardInteractionClient class (msal-browser). * Used to load authority metadata for a request. */ StandardInteractionClientGetDiscoveredAuthority: "standardInteractionClientGetDiscoveredAuthority", /** * acquireToken APIs in msal-browser. * Used to make an /authorize endpoint call with native brokering enabled. */ FetchAccountIdWithNativeBroker: "fetchAccountIdWithNativeBroker", /** * acquireToken API in NativeInteractionClient class (msal-browser). * Used to acquire a token from Native component when native brokering is enabled. */ NativeInteractionClientAcquireToken: "nativeInteractionClientAcquireToken", /** * Time spent creating default headers for requests to token endpoint */ BaseClientCreateTokenRequestHeaders: "baseClientCreateTokenRequestHeaders", /** * Time spent sending/waiting for the response of a request to the token endpoint */ NetworkClientSendPostRequestAsync: "networkClientSendPostRequestAsync", RefreshTokenClientExecutePostToTokenEndpoint: "refreshTokenClientExecutePostToTokenEndpoint", AuthorizationCodeClientExecutePostToTokenEndpoint: "authorizationCodeClientExecutePostToTokenEndpoint", /** * Used to measure the time taken for completing embedded-broker handshake (PW-Broker). */ BrokerHandhshake: "brokerHandshake", /** * acquireTokenByRefreshToken API in BrokerClientApplication (PW-Broker) . */ AcquireTokenByRefreshTokenInBroker: "acquireTokenByRefreshTokenInBroker", /** * Time taken for token acquisition by broker */ AcquireTokenByBroker: "acquireTokenByBroker", /** * Time spent on the network for refresh token acquisition */ RefreshTokenClientExecuteTokenRequest: "refreshTokenClientExecuteTokenRequest", /** * Time taken for acquiring refresh token , records RT size */ RefreshTokenClientAcquireToken: "refreshTokenClientAcquireToken", /** * Time taken for acquiring cached refresh token */ RefreshTokenClientAcquireTokenWithCachedRefreshToken: "refreshTokenClientAcquireTokenWithCachedRefreshToken", /** * acquireTokenByRefreshToken API in RefreshTokenClient (msal-common). */ RefreshTokenClientAcquireTokenByRefreshToken: "refreshTokenClientAcquireTokenByRefreshToken", /** * Helper function to create token request body in RefreshTokenClient (msal-common). */ RefreshTokenClientCreateTokenRequestBody: "refreshTokenClientCreateTokenRequestBody", /** * acquireTokenFromCache (msal-browser). * Internal API for acquiring token from cache */ AcquireTokenFromCache: "acquireTokenFromCache", SilentFlowClientAcquireCachedToken: "silentFlowClientAcquireCachedToken", SilentFlowClientGenerateResultFromCacheRecord: "silentFlowClientGenerateResultFromCacheRecord", /** * acquireTokenBySilentIframe (msal-browser). * Internal API for acquiring token by silent Iframe */ AcquireTokenBySilentIframe: "acquireTokenBySilentIframe", /** * Internal API for initializing base request in BaseInteractionClient (msal-browser) */ InitializeBaseRequest: "initializeBaseRequest", /** * Internal API for initializing silent request in SilentCacheClient (msal-browser) */ InitializeSilentRequest: "initializeSilentRequest", InitializeClientApplication: "initializeClientApplication", /** * Helper function in SilentIframeClient class (msal-browser). */ SilentIframeClientTokenHelper: "silentIframeClientTokenHelper", /** * SilentHandler */ SilentHandlerInitiateAuthRequest: "silentHandlerInitiateAuthRequest", SilentHandlerMonitorIframeForHash: "silentHandlerMonitorIframeForHash", SilentHandlerLoadFrame: "silentHandlerLoadFrame", SilentHandlerLoadFrameSync: "silentHandlerLoadFrameSync", /** * Helper functions in StandardInteractionClient class (msal-browser) */ StandardInteractionClientCreateAuthCodeClient: "standardInteractionClientCreateAuthCodeClient", StandardInteractionClientGetClientConfiguration: "standardInteractionClientGetClientConfiguration", StandardInteractionClientInitializeAuthorizationRequest: "standardInteractionClientInitializeAuthorizationRequest", StandardInteractionClientInitializeAuthorizationCodeRequest: "standardInteractionClientInitializeAuthorizationCodeRequest", /** * getAuthCodeUrl API (msal-browser and msal-node). */ GetAuthCodeUrl: "getAuthCodeUrl", /** * Functions from InteractionHandler (msal-browser) */ HandleCodeResponseFromServer: "handleCodeResponseFromServer", HandleCodeResponse: "handleCodeResponse", UpdateTokenEndpointAuthority: "updateTokenEndpointAuthority", /** * APIs in Authorization Code Client (msal-common) */ AuthClientAcquireToken: "authClientAcquireToken", AuthClientExecuteTokenRequest: "authClientExecuteTokenRequest", AuthClientCreateTokenRequestBody: "authClientCreateTokenRequestBody", AuthClientCreateQueryString: "authClientCreateQueryString", /** * Generate functions in PopTokenGenerator (msal-common) */ PopTokenGenerateCnf: "popTokenGenerateCnf", PopTokenGenerateKid: "popTokenGenerateKid", /** * handleServerTokenResponse API in ResponseHandler (msal-common) */ HandleServerTokenResponse: "handleServerTokenResponse", DeserializeResponse: "deserializeResponse", /** * Authority functions */ AuthorityFactoryCreateDiscoveredInstance: "authorityFactoryCreateDiscoveredInstance", AuthorityResolveEndpointsAsync: "authorityResolveEndpointsAsync", AuthorityResolveEndpointsFromLocalSources: "authorityResolveEndpointsFromLocalSources", AuthorityGetCloudDiscoveryMetadataFromNetwork: "authorityGetCloudDiscoveryMetadataFromNetwork", AuthorityUpdateCloudDiscoveryMetadata: "authorityUpdateCloudDiscoveryMetadata", AuthorityGetEndpointMetadataFromNetwork: "authorityGetEndpointMetadataFromNetwork", AuthorityUpdateEndpointMetadata: "authorityUpdateEndpointMetadata", AuthorityUpdateMetadataWithRegionalInformation: "authorityUpdateMetadataWithRegionalInformation", /** * Region Discovery functions */ RegionDiscoveryDetectRegion: "regionDiscoveryDetectRegion", RegionDiscoveryGetRegionFromIMDS: "regionDiscoveryGetRegionFromIMDS", RegionDiscoveryGetCurrentVersion: "regionDiscoveryGetCurrentVersion", AcquireTokenByCodeAsync: "acquireTokenByCodeAsync", GetEndpointMetadataFromNetwork: "getEndpointMetadataFromNetwork", GetCloudDiscoveryMetadataFromNetworkMeasurement: "getCloudDiscoveryMetadataFromNetworkMeasurement", HandleRedirectPromiseMeasurement: "handleRedirectPromise", HandleNativeRedirectPromiseMeasurement: "handleNativeRedirectPromise", UpdateCloudDiscoveryMetadataMeasurement: "updateCloudDiscoveryMetadataMeasurement", UsernamePasswordClientAcquireToken: "usernamePasswordClientAcquireToken", NativeMessageHandlerHandshake: "nativeMessageHandlerHandshake", NativeGenerateAuthResult: "nativeGenerateAuthResult", RemoveHiddenIframe: "removeHiddenIframe", /** * Cache operations */ ClearTokensAndKeysWithClaims: "clearTokensAndKeysWithClaims", CacheManagerGetRefreshToken: "cacheManagerGetRefreshToken", /** * Crypto Operations */ GeneratePkceCodes: "generatePkceCodes", GenerateCodeVerifier: "generateCodeVerifier", GenerateCodeChallengeFromVerifier: "generateCodeChallengeFromVerifier", Sha256Digest: "sha256Digest", GetRandomValues: "getRandomValues", }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Wraps a function with a performance measurement. * Usage: invoke(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction) * @param callback * @param eventName * @param logger * @param telemetryClient * @param correlationId * @returns * @internal */ // eslint-disable-next-line @typescript-eslint/no-explicit-any const invoke = (callback, eventName, logger, telemetryClient, correlationId) => { return (...args) => { logger.trace(`Executing function ${eventName}`); const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId); if (correlationId) { // Track number of times this API is called in a single request const eventCount = eventName + "CallCount"; telemetryClient?.incrementFields({ [eventCount]: 1 }, correlationId); } try { const result = callback(...args); inProgressEvent?.end({ success: true, }); logger.trace(`Returning result from ${eventName}`); return result; } catch (e) { logger.trace(`Error occurred in ${eventName}`); try { logger.trace(JSON.stringify(e)); } catch (e) { logger.trace("Unable to print error message."); } inProgressEvent?.end({ success: false, }, e); throw e; } }; }; /** * Wraps an async function with a performance measurement. * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction) * @param callback * @param eventName * @param logger * @param telemetryClient * @param correlationId * @returns * @internal * */ // eslint-disable-next-line @typescript-eslint/no-explicit-any const invokeAsync = (callback, eventName, logger, telemetryClient, correlationId) => { return (...args) => { logger.trace(`Executing function ${eventName}`); const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId); if (correlationId) { // Track number of times this API is called in a single request const eventCount = eventName + "CallCount"; telemetryClient?.incrementFields({ [eventCount]: 1 }, correlationId); } telemetryClient?.setPreQueueTime(eventName, correlationId); return callback(...args) .then((response) => { logger.trace(`Returning result from ${eventName}`); inProgressEvent?.end({ success: true, }); return response; }) .catch((e) => { logger.trace(`Error occurred in ${eventName}`); try { logger.trace(JSON.stringify(e)); } catch (e) { logger.trace("Unable to print error message."); } inProgressEvent?.end({ success: false, }, e); throw e; }); }; }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class RegionDiscovery { constructor(networkInterface, logger, performanceClient, correlationId) { this.networkInterface = networkInterface; this.logger = logger; this.performanceClient = performanceClient; this.correlationId = correlationId; } /** * Detect the region from the application's environment. * * @returns Promise */ async detectRegion(environmentRegion, regionDiscoveryMetadata) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryDetectRegion, this.correlationId); // Initialize auto detected region with the region from the envrionment let autodetectedRegionName = environmentRegion; // Check if a region was detected from the environment, if not, attempt to get the region from IMDS if (!autodetectedRegionName) { const options = RegionDiscovery.IMDS_OPTIONS; try { const localIMDSVersionResponse = await invokeAsync(this.getRegionFromIMDS.bind(this), PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.logger, this.performanceClient, this.correlationId)(Constants$1.IMDS_VERSION, options); if (localIMDSVersionResponse.status === ResponseCodes.httpSuccess) { autodetectedRegionName = localIMDSVersionResponse.body; regionDiscoveryMetadata.region_source = RegionDiscoverySources.IMDS; } // If the response using the local IMDS version failed, try to fetch the current version of IMDS and retry. if (localIMDSVersionResponse.status === ResponseCodes.httpBadRequest) { const currentIMDSVersion = await invokeAsync(this.getCurrentVersion.bind(this), PerformanceEvents.RegionDiscoveryGetCurrentVersion, this.logger, this.performanceClient, this.correlationId)(options); if (!currentIMDSVersion) { regionDiscoveryMetadata.region_source = RegionDiscoverySources.FAILED_AUTO_DETECTION; return null; } const currentIMDSVersionResponse = await invokeAsync(this.getRegionFromIMDS.bind(this), PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.logger, this.performanceClient, this.correlationId)(currentIMDSVersion, options); if (currentIMDSVersionResponse.status === ResponseCodes.httpSuccess) { autodetectedRegionName = currentIMDSVersionResponse.body; regionDiscoveryMetadata.region_source = RegionDiscoverySources.IMDS; } } } catch (e) { regionDiscoveryMetadata.region_source = RegionDiscoverySources.FAILED_AUTO_DETECTION; return null; } } else { regionDiscoveryMetadata.region_source = RegionDiscoverySources.ENVIRONMENT_VARIABLE; } // If no region was auto detected from the environment or from the IMDS endpoint, mark the attempt as a FAILED_AUTO_DETECTION if (!autodetectedRegionName) { regionDiscoveryMetadata.region_source = RegionDiscoverySources.FAILED_AUTO_DETECTION; } return autodetectedRegionName || null; } /** * Make the call to the IMDS endpoint * * @param imdsEndpointUrl * @returns Promise> */ async getRegionFromIMDS(version, options) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.correlationId); return this.networkInterface.sendGetRequestAsync(`${Constants$1.IMDS_ENDPOINT}?api-version=${version}&format=text`, options, Constants$1.IMDS_TIMEOUT); } /** * Get the most recent version of the IMDS endpoint available * * @returns Promise */ async getCurrentVersion(options) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryGetCurrentVersion, this.correlationId); try { const response = await this.networkInterface.sendGetRequestAsync(`${Constants$1.IMDS_ENDPOINT}?format=json`, options); // When IMDS endpoint is called without the api version query param, bad request response comes back with latest version. if (response.status === ResponseCodes.httpBadRequest && response.body && response.body["newest-versions"] && response.body["newest-versions"].length > 0) { return response.body["newest-versions"][0]; } return null; } catch (e) { return null; } } } // Options for the IMDS endpoint request RegionDiscovery.IMDS_OPTIONS = { headers: { Metadata: "true", }, }; /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * The authority class validates the authority URIs used by the user, and retrieves the OpenID Configuration Data from the * endpoint. It will store the pertinent config data in this object for use during token calls. * @internal */ class Authority { constructor(authority, networkInterface, cacheManager, authorityOptions, logger, correlationId, performanceClient, managedIdentity) { this.canonicalAuthority = authority; this._canonicalAuthority.validateAsUri(); this.networkInterface = networkInterface; this.cacheManager = cacheManager; this.authorityOptions = authorityOptions; this.regionDiscoveryMetadata = { region_used: undefined, region_source: undefined, region_outcome: undefined, }; this.logger = logger; this.performanceClient = performanceClient; this.correlationId = correlationId; this.managedIdentity = managedIdentity || false; this.regionDiscovery = new RegionDiscovery(networkInterface, this.logger, this.performanceClient, this.correlationId); } /** * Get {@link AuthorityType} * @param authorityUri {@link IUri} * @private */ getAuthorityType(authorityUri) { // CIAM auth url pattern is being standardized as: .ciamlogin.com if (authorityUri.HostNameAndPort.endsWith(Constants$1.CIAM_AUTH_URL)) { return AuthorityType.Ciam; } const pathSegments = authorityUri.PathSegments; if (pathSegments.length) { switch (pathSegments[0].toLowerCase()) { case Constants$1.ADFS: return AuthorityType.Adfs; case Constants$1.DSTS: return AuthorityType.Dsts; } } return AuthorityType.Default; } // See above for AuthorityType get authorityType() { return this.getAuthorityType(this.canonicalAuthorityUrlComponents); } /** * ProtocolMode enum representing the way endpoints are constructed. */ get protocolMode() { return this.authorityOptions.protocolMode; } /** * Returns authorityOptions which can be used to reinstantiate a new authority instance */ get options() { return this.authorityOptions; } /** * A URL that is the authority set by the developer */ get canonicalAuthority() { return this._canonicalAuthority.urlString; } /** * Sets canonical authority. */ set canonicalAuthority(url) { this._canonicalAuthority = new UrlString(url); this._canonicalAuthority.validateAsUri(); this._canonicalAuthorityUrlComponents = null; } /** * Get authority components. */ get canonicalAuthorityUrlComponents() { if (!this._canonicalAuthorityUrlComponents) { this._canonicalAuthorityUrlComponents = this._canonicalAuthority.getUrlComponents(); } return this._canonicalAuthorityUrlComponents; } /** * Get hostname and port i.e. login.microsoftonline.com */ get hostnameAndPort() { return this.canonicalAuthorityUrlComponents.HostNameAndPort.toLowerCase(); } /** * Get tenant for authority. */ get tenant() { return this.canonicalAuthorityUrlComponents.PathSegments[0]; } /** * OAuth /authorize endpoint for requests */ get authorizationEndpoint() { if (this.discoveryComplete()) { return this.replacePath(this.metadata.authorization_endpoint); } else { throw createClientAuthError(endpointResolutionError); } } /** * OAuth /token endpoint for requests */ get tokenEndpoint() { if (this.discoveryComplete()) { return this.replacePath(this.metadata.token_endpoint); } else { throw createClientAuthError(endpointResolutionError); } } get deviceCodeEndpoint() { if (this.discoveryComplete()) { return this.replacePath(this.metadata.token_endpoint.replace("/token", "/devicecode")); } else { throw createClientAuthError(endpointResolutionError); } } /** * OAuth logout endpoint for requests */ get endSessionEndpoint() { if (this.discoveryComplete()) { // ROPC policies may not have end_session_endpoint set if (!this.metadata.end_session_endpoint) { throw createClientAuthError(endSessionEndpointNotSupported); } return this.replacePath(this.metadata.end_session_endpoint); } else { throw createClientAuthError(endpointResolutionError); } } /** * OAuth issuer for requests */ get selfSignedJwtAudience() { if (this.discoveryComplete()) { return this.replacePath(this.metadata.issuer); } else { throw createClientAuthError(endpointResolutionError); } } /** * Jwks_uri for token signing keys */ get jwksUri() { if (this.discoveryComplete()) { return this.replacePath(this.metadata.jwks_uri); } else { throw createClientAuthError(endpointResolutionError); } } /** * Returns a flag indicating that tenant name can be replaced in authority {@link IUri} * @param authorityUri {@link IUri} * @private */ canReplaceTenant(authorityUri) { return (authorityUri.PathSegments.length === 1 && !Authority.reservedTenantDomains.has(authorityUri.PathSegments[0]) && this.getAuthorityType(authorityUri) === AuthorityType.Default && this.protocolMode === ProtocolMode.AAD); } /** * Replaces tenant in url path with current tenant. Defaults to common. * @param urlString */ replaceTenant(urlString) { return urlString.replace(/{tenant}|{tenantid}/g, this.tenant); } /** * Replaces path such as tenant or policy with the current tenant or policy. * @param urlString */ replacePath(urlString) { let endpoint = urlString; const cachedAuthorityUrl = new UrlString(this.metadata.canonical_authority); const cachedAuthorityUrlComponents = cachedAuthorityUrl.getUrlComponents(); const cachedAuthorityParts = cachedAuthorityUrlComponents.PathSegments; const currentAuthorityParts = this.canonicalAuthorityUrlComponents.PathSegments; currentAuthorityParts.forEach((currentPart, index) => { let cachedPart = cachedAuthorityParts[index]; if (index === 0 && this.canReplaceTenant(cachedAuthorityUrlComponents)) { const tenantId = new UrlString(this.metadata.authorization_endpoint).getUrlComponents().PathSegments[0]; /** * Check if AAD canonical authority contains tenant domain name, for example "testdomain.onmicrosoft.com", * by comparing its first path segment to the corresponding authorization endpoint path segment, which is * always resolved with tenant id by OIDC. */ if (cachedPart !== tenantId) { this.logger.verbose(`Replacing tenant domain name ${cachedPart} with id ${tenantId}`); cachedPart = tenantId; } } if (currentPart !== cachedPart) { endpoint = endpoint.replace(`/${cachedPart}/`, `/${currentPart}/`); } }); return this.replaceTenant(endpoint); } /** * The default open id configuration endpoint for any canonical authority. */ get defaultOpenIdConfigurationEndpoint() { const canonicalAuthorityHost = this.hostnameAndPort; if (this.canonicalAuthority.endsWith("v2.0/") || this.authorityType === AuthorityType.Adfs || (this.protocolMode !== ProtocolMode.AAD && !this.isAliasOfKnownMicrosoftAuthority(canonicalAuthorityHost))) { return `${this.canonicalAuthority}.well-known/openid-configuration`; } return `${this.canonicalAuthority}v2.0/.well-known/openid-configuration`; } /** * Boolean that returns whether or not tenant discovery has been completed. */ discoveryComplete() { return !!this.metadata; } /** * Perform endpoint discovery to discover aliases, preferred_cache, preferred_network * and the /authorize, /token and logout endpoints. */ async resolveEndpointsAsync() { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityResolveEndpointsAsync, this.correlationId); const metadataEntity = this.getCurrentMetadataEntity(); const cloudDiscoverySource = await invokeAsync(this.updateCloudDiscoveryMetadata.bind(this), PerformanceEvents.AuthorityUpdateCloudDiscoveryMetadata, this.logger, this.performanceClient, this.correlationId)(metadataEntity); this.canonicalAuthority = this.canonicalAuthority.replace(this.hostnameAndPort, metadataEntity.preferred_network); const endpointSource = await invokeAsync(this.updateEndpointMetadata.bind(this), PerformanceEvents.AuthorityUpdateEndpointMetadata, this.logger, this.performanceClient, this.correlationId)(metadataEntity); this.updateCachedMetadata(metadataEntity, cloudDiscoverySource, { source: endpointSource, }); this.performanceClient?.addFields({ cloudDiscoverySource: cloudDiscoverySource, authorityEndpointSource: endpointSource, }, this.correlationId); } /** * Returns metadata entity from cache if it exists, otherwiser returns a new metadata entity built * from the configured canonical authority * @returns */ getCurrentMetadataEntity() { let metadataEntity = this.cacheManager.getAuthorityMetadataByAlias(this.hostnameAndPort); if (!metadataEntity) { metadataEntity = { aliases: [], preferred_cache: this.hostnameAndPort, preferred_network: this.hostnameAndPort, canonical_authority: this.canonicalAuthority, authorization_endpoint: "", token_endpoint: "", end_session_endpoint: "", issuer: "", aliasesFromNetwork: false, endpointsFromNetwork: false, expiresAt: generateAuthorityMetadataExpiresAt(), jwks_uri: "", }; } return metadataEntity; } /** * Updates cached metadata based on metadata source and sets the instance's metadata * property to the same value * @param metadataEntity * @param cloudDiscoverySource * @param endpointMetadataResult */ updateCachedMetadata(metadataEntity, cloudDiscoverySource, endpointMetadataResult) { if (cloudDiscoverySource !== AuthorityMetadataSource.CACHE && endpointMetadataResult?.source !== AuthorityMetadataSource.CACHE) { // Reset the expiration time unless both values came from a successful cache lookup metadataEntity.expiresAt = generateAuthorityMetadataExpiresAt(); metadataEntity.canonical_authority = this.canonicalAuthority; } const cacheKey = this.cacheManager.generateAuthorityMetadataCacheKey(metadataEntity.preferred_cache); this.cacheManager.setAuthorityMetadata(cacheKey, metadataEntity); this.metadata = metadataEntity; } /** * Update AuthorityMetadataEntity with new endpoints and return where the information came from * @param metadataEntity */ async updateEndpointMetadata(metadataEntity) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityUpdateEndpointMetadata, this.correlationId); const localMetadata = this.updateEndpointMetadataFromLocalSources(metadataEntity); // Further update may be required for hardcoded metadata if regional metadata is preferred if (localMetadata) { if (localMetadata.source === AuthorityMetadataSource.HARDCODED_VALUES) { // If the user prefers to use an azure region replace the global endpoints with regional information. if (this.authorityOptions.azureRegionConfiguration?.azureRegion) { if (localMetadata.metadata) { const hardcodedMetadata = await invokeAsync(this.updateMetadataWithRegionalInformation.bind(this), PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation, this.logger, this.performanceClient, this.correlationId)(localMetadata.metadata); updateAuthorityEndpointMetadata(metadataEntity, hardcodedMetadata, false); metadataEntity.canonical_authority = this.canonicalAuthority; } } } return localMetadata.source; } // Get metadata from network if local sources aren't available let metadata = await invokeAsync(this.getEndpointMetadataFromNetwork.bind(this), PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork, this.logger, this.performanceClient, this.correlationId)(); if (metadata) { // If the user prefers to use an azure region replace the global endpoints with regional information. if (this.authorityOptions.azureRegionConfiguration?.azureRegion) { metadata = await invokeAsync(this.updateMetadataWithRegionalInformation.bind(this), PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation, this.logger, this.performanceClient, this.correlationId)(metadata); } updateAuthorityEndpointMetadata(metadataEntity, metadata, true); return AuthorityMetadataSource.NETWORK; } else { // Metadata could not be obtained from the config, cache, network or hardcoded values throw createClientAuthError(openIdConfigError, this.defaultOpenIdConfigurationEndpoint); } } /** * Updates endpoint metadata from local sources and returns where the information was retrieved from and the metadata config * response if the source is hardcoded metadata * @param metadataEntity * @returns */ updateEndpointMetadataFromLocalSources(metadataEntity) { this.logger.verbose("Attempting to get endpoint metadata from authority configuration"); const configMetadata = this.getEndpointMetadataFromConfig(); if (configMetadata) { this.logger.verbose("Found endpoint metadata in authority configuration"); updateAuthorityEndpointMetadata(metadataEntity, configMetadata, false); return { source: AuthorityMetadataSource.CONFIG, }; } this.logger.verbose("Did not find endpoint metadata in the config... Attempting to get endpoint metadata from the hardcoded values."); // skipAuthorityMetadataCache is used to bypass hardcoded authority metadata and force a network metadata cache lookup and network metadata request if no cached response is available. if (this.authorityOptions.skipAuthorityMetadataCache) { this.logger.verbose("Skipping hardcoded metadata cache since skipAuthorityMetadataCache is set to true. Attempting to get endpoint metadata from the network metadata cache."); } else { const hardcodedMetadata = this.getEndpointMetadataFromHardcodedValues(); if (hardcodedMetadata) { updateAuthorityEndpointMetadata(metadataEntity, hardcodedMetadata, false); return { source: AuthorityMetadataSource.HARDCODED_VALUES, metadata: hardcodedMetadata, }; } else { this.logger.verbose("Did not find endpoint metadata in hardcoded values... Attempting to get endpoint metadata from the network metadata cache."); } } // Check cached metadata entity expiration status const metadataEntityExpired = isAuthorityMetadataExpired(metadataEntity); if (this.isAuthoritySameType(metadataEntity) && metadataEntity.endpointsFromNetwork && !metadataEntityExpired) { // No need to update this.logger.verbose("Found endpoint metadata in the cache."); return { source: AuthorityMetadataSource.CACHE }; } else if (metadataEntityExpired) { this.logger.verbose("The metadata entity is expired."); } return null; } /** * Compares the number of url components after the domain to determine if the cached * authority metadata can be used for the requested authority. Protects against same domain different * authority such as login.microsoftonline.com/tenant and login.microsoftonline.com/tfp/tenant/policy * @param metadataEntity */ isAuthoritySameType(metadataEntity) { const cachedAuthorityUrl = new UrlString(metadataEntity.canonical_authority); const cachedParts = cachedAuthorityUrl.getUrlComponents().PathSegments; return (cachedParts.length === this.canonicalAuthorityUrlComponents.PathSegments.length); } /** * Parse authorityMetadata config option */ getEndpointMetadataFromConfig() { if (this.authorityOptions.authorityMetadata) { try { return JSON.parse(this.authorityOptions.authorityMetadata); } catch (e) { throw createClientConfigurationError(invalidAuthorityMetadata); } } return null; } /** * Gets OAuth endpoints from the given OpenID configuration endpoint. * * @param hasHardcodedMetadata boolean */ async getEndpointMetadataFromNetwork() { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork, this.correlationId); const options = {}; /* * TODO: Add a timeout if the authority exists in our library's * hardcoded list of metadata */ const openIdConfigurationEndpoint = this.defaultOpenIdConfigurationEndpoint; this.logger.verbose(`Authority.getEndpointMetadataFromNetwork: attempting to retrieve OAuth endpoints from ${openIdConfigurationEndpoint}`); try { const response = await this.networkInterface.sendGetRequestAsync(openIdConfigurationEndpoint, options); const isValidResponse = isOpenIdConfigResponse(response.body); if (isValidResponse) { return response.body; } else { this.logger.verbose(`Authority.getEndpointMetadataFromNetwork: could not parse response as OpenID configuration`); return null; } } catch (e) { this.logger.verbose(`Authority.getEndpointMetadataFromNetwork: ${e}`); return null; } } /** * Get OAuth endpoints for common authorities. */ getEndpointMetadataFromHardcodedValues() { if (this.hostnameAndPort in EndpointMetadata) { return EndpointMetadata[this.hostnameAndPort]; } return null; } /** * Update the retrieved metadata with regional information. * User selected Azure region will be used if configured. */ async updateMetadataWithRegionalInformation(metadata) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation, this.correlationId); const userConfiguredAzureRegion = this.authorityOptions.azureRegionConfiguration?.azureRegion; if (userConfiguredAzureRegion) { if (userConfiguredAzureRegion !== Constants$1.AZURE_REGION_AUTO_DISCOVER_FLAG) { this.regionDiscoveryMetadata.region_outcome = RegionDiscoveryOutcomes.CONFIGURED_NO_AUTO_DETECTION; this.regionDiscoveryMetadata.region_used = userConfiguredAzureRegion; return Authority.replaceWithRegionalInformation(metadata, userConfiguredAzureRegion); } const autodetectedRegionName = await invokeAsync(this.regionDiscovery.detectRegion.bind(this.regionDiscovery), PerformanceEvents.RegionDiscoveryDetectRegion, this.logger, this.performanceClient, this.correlationId)(this.authorityOptions.azureRegionConfiguration ?.environmentRegion, this.regionDiscoveryMetadata); if (autodetectedRegionName) { this.regionDiscoveryMetadata.region_outcome = RegionDiscoveryOutcomes.AUTO_DETECTION_REQUESTED_SUCCESSFUL; this.regionDiscoveryMetadata.region_used = autodetectedRegionName; return Authority.replaceWithRegionalInformation(metadata, autodetectedRegionName); } this.regionDiscoveryMetadata.region_outcome = RegionDiscoveryOutcomes.AUTO_DETECTION_REQUESTED_FAILED; } return metadata; } /** * Updates the AuthorityMetadataEntity with new aliases, preferred_network and preferred_cache * and returns where the information was retrieved from * @param metadataEntity * @returns AuthorityMetadataSource */ async updateCloudDiscoveryMetadata(metadataEntity) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityUpdateCloudDiscoveryMetadata, this.correlationId); const localMetadataSource = this.updateCloudDiscoveryMetadataFromLocalSources(metadataEntity); if (localMetadataSource) { return localMetadataSource; } // Fallback to network as metadata source const metadata = await invokeAsync(this.getCloudDiscoveryMetadataFromNetwork.bind(this), PerformanceEvents.AuthorityGetCloudDiscoveryMetadataFromNetwork, this.logger, this.performanceClient, this.correlationId)(); if (metadata) { updateCloudDiscoveryMetadata(metadataEntity, metadata, true); return AuthorityMetadataSource.NETWORK; } // Metadata could not be obtained from the config, cache, network or hardcoded values throw createClientConfigurationError(untrustedAuthority); } updateCloudDiscoveryMetadataFromLocalSources(metadataEntity) { this.logger.verbose("Attempting to get cloud discovery metadata from authority configuration"); this.logger.verbosePii(`Known Authorities: ${this.authorityOptions.knownAuthorities || Constants$1.NOT_APPLICABLE}`); this.logger.verbosePii(`Authority Metadata: ${this.authorityOptions.authorityMetadata || Constants$1.NOT_APPLICABLE}`); this.logger.verbosePii(`Canonical Authority: ${metadataEntity.canonical_authority || Constants$1.NOT_APPLICABLE}`); const metadata = this.getCloudDiscoveryMetadataFromConfig(); if (metadata) { this.logger.verbose("Found cloud discovery metadata in authority configuration"); updateCloudDiscoveryMetadata(metadataEntity, metadata, false); return AuthorityMetadataSource.CONFIG; } // If the cached metadata came from config but that config was not passed to this instance, we must go to hardcoded values this.logger.verbose("Did not find cloud discovery metadata in the config... Attempting to get cloud discovery metadata from the hardcoded values."); if (this.options.skipAuthorityMetadataCache) { this.logger.verbose("Skipping hardcoded cloud discovery metadata cache since skipAuthorityMetadataCache is set to true. Attempting to get cloud discovery metadata from the network metadata cache."); } else { const hardcodedMetadata = getCloudDiscoveryMetadataFromHardcodedValues(this.hostnameAndPort); if (hardcodedMetadata) { this.logger.verbose("Found cloud discovery metadata from hardcoded values."); updateCloudDiscoveryMetadata(metadataEntity, hardcodedMetadata, false); return AuthorityMetadataSource.HARDCODED_VALUES; } this.logger.verbose("Did not find cloud discovery metadata in hardcoded values... Attempting to get cloud discovery metadata from the network metadata cache."); } const metadataEntityExpired = isAuthorityMetadataExpired(metadataEntity); if (this.isAuthoritySameType(metadataEntity) && metadataEntity.aliasesFromNetwork && !metadataEntityExpired) { this.logger.verbose("Found cloud discovery metadata in the cache."); // No need to update return AuthorityMetadataSource.CACHE; } else if (metadataEntityExpired) { this.logger.verbose("The metadata entity is expired."); } return null; } /** * Parse cloudDiscoveryMetadata config or check knownAuthorities */ getCloudDiscoveryMetadataFromConfig() { // CIAM does not support cloud discovery metadata if (this.authorityType === AuthorityType.Ciam) { this.logger.verbose("CIAM authorities do not support cloud discovery metadata, generate the aliases from authority host."); return Authority.createCloudDiscoveryMetadataFromHost(this.hostnameAndPort); } // Check if network response was provided in config if (this.authorityOptions.cloudDiscoveryMetadata) { this.logger.verbose("The cloud discovery metadata has been provided as a network response, in the config."); try { this.logger.verbose("Attempting to parse the cloud discovery metadata."); const parsedResponse = JSON.parse(this.authorityOptions.cloudDiscoveryMetadata); const metadata = getCloudDiscoveryMetadataFromNetworkResponse(parsedResponse.metadata, this.hostnameAndPort); this.logger.verbose("Parsed the cloud discovery metadata."); if (metadata) { this.logger.verbose("There is returnable metadata attached to the parsed cloud discovery metadata."); return metadata; } else { this.logger.verbose("There is no metadata attached to the parsed cloud discovery metadata."); } } catch (e) { this.logger.verbose("Unable to parse the cloud discovery metadata. Throwing Invalid Cloud Discovery Metadata Error."); throw createClientConfigurationError(invalidCloudDiscoveryMetadata); } } // If cloudDiscoveryMetadata is empty or does not contain the host, check knownAuthorities if (this.isInKnownAuthorities()) { this.logger.verbose("The host is included in knownAuthorities. Creating new cloud discovery metadata from the host."); return Authority.createCloudDiscoveryMetadataFromHost(this.hostnameAndPort); } return null; } /** * Called to get metadata from network if CloudDiscoveryMetadata was not populated by config * * @param hasHardcodedMetadata boolean */ async getCloudDiscoveryMetadataFromNetwork() { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityGetCloudDiscoveryMetadataFromNetwork, this.correlationId); const instanceDiscoveryEndpoint = `${Constants$1.AAD_INSTANCE_DISCOVERY_ENDPT}${this.canonicalAuthority}oauth2/v2.0/authorize`; const options = {}; /* * TODO: Add a timeout if the authority exists in our library's * hardcoded list of metadata */ let match = null; try { const response = await this.networkInterface.sendGetRequestAsync(instanceDiscoveryEndpoint, options); let typedResponseBody; let metadata; if (isCloudInstanceDiscoveryResponse(response.body)) { typedResponseBody = response.body; metadata = typedResponseBody.metadata; this.logger.verbosePii(`tenant_discovery_endpoint is: ${typedResponseBody.tenant_discovery_endpoint}`); } else if (isCloudInstanceDiscoveryErrorResponse(response.body)) { this.logger.warning(`A CloudInstanceDiscoveryErrorResponse was returned. The cloud instance discovery network request's status code is: ${response.status}`); typedResponseBody = response.body; if (typedResponseBody.error === Constants$1.INVALID_INSTANCE) { this.logger.error("The CloudInstanceDiscoveryErrorResponse error is invalid_instance."); return null; } this.logger.warning(`The CloudInstanceDiscoveryErrorResponse error is ${typedResponseBody.error}`); this.logger.warning(`The CloudInstanceDiscoveryErrorResponse error description is ${typedResponseBody.error_description}`); this.logger.warning("Setting the value of the CloudInstanceDiscoveryMetadata (returned from the network) to []"); metadata = []; } else { this.logger.error("AAD did not return a CloudInstanceDiscoveryResponse or CloudInstanceDiscoveryErrorResponse"); return null; } this.logger.verbose("Attempting to find a match between the developer's authority and the CloudInstanceDiscoveryMetadata returned from the network request."); match = getCloudDiscoveryMetadataFromNetworkResponse(metadata, this.hostnameAndPort); } catch (error) { if (error instanceof AuthError) { this.logger.error(`There was a network error while attempting to get the cloud discovery instance metadata.\nError: ${error.errorCode}\nError Description: ${error.errorMessage}`); } else { const typedError = error; this.logger.error(`A non-MSALJS error was thrown while attempting to get the cloud instance discovery metadata.\nError: ${typedError.name}\nError Description: ${typedError.message}`); } return null; } // Custom Domain scenario, host is trusted because Instance Discovery call succeeded if (!match) { this.logger.warning("The developer's authority was not found within the CloudInstanceDiscoveryMetadata returned from the network request."); this.logger.verbose("Creating custom Authority for custom domain scenario."); match = Authority.createCloudDiscoveryMetadataFromHost(this.hostnameAndPort); } return match; } /** * Helper function to determine if this host is included in the knownAuthorities config option */ isInKnownAuthorities() { const matches = this.authorityOptions.knownAuthorities.filter((authority) => { return (authority && UrlString.getDomainFromUrl(authority).toLowerCase() === this.hostnameAndPort); }); return matches.length > 0; } /** * helper function to populate the authority based on azureCloudOptions * @param authorityString * @param azureCloudOptions */ static generateAuthority(authorityString, azureCloudOptions) { let authorityAzureCloudInstance; if (azureCloudOptions && azureCloudOptions.azureCloudInstance !== AzureCloudInstance.None) { const tenant = azureCloudOptions.tenant ? azureCloudOptions.tenant : Constants$1.DEFAULT_COMMON_TENANT; authorityAzureCloudInstance = `${azureCloudOptions.azureCloudInstance}/${tenant}/`; } return authorityAzureCloudInstance ? authorityAzureCloudInstance : authorityString; } /** * Creates cloud discovery metadata object from a given host * @param host */ static createCloudDiscoveryMetadataFromHost(host) { return { preferred_network: host, preferred_cache: host, aliases: [host], }; } /** * helper function to generate environment from authority object */ getPreferredCache() { if (this.managedIdentity) { return Constants$1.DEFAULT_AUTHORITY_HOST; } else if (this.discoveryComplete()) { return this.metadata.preferred_cache; } else { throw createClientAuthError(endpointResolutionError); } } /** * Returns whether or not the provided host is an alias of this authority instance * @param host */ isAlias(host) { return this.metadata.aliases.indexOf(host) > -1; } /** * Returns whether or not the provided host is an alias of a known Microsoft authority for purposes of endpoint discovery * @param host */ isAliasOfKnownMicrosoftAuthority(host) { return InstanceDiscoveryMetadataAliases.has(host); } /** * Checks whether the provided host is that of a public cloud authority * * @param authority string * @returns bool */ static isPublicCloudAuthority(host) { return Constants$1.KNOWN_PUBLIC_CLOUDS.indexOf(host) >= 0; } /** * Rebuild the authority string with the region * * @param host string * @param region string */ static buildRegionalAuthorityString(host, region, queryString) { // Create and validate a Url string object with the initial authority string const authorityUrlInstance = new UrlString(host); authorityUrlInstance.validateAsUri(); const authorityUrlParts = authorityUrlInstance.getUrlComponents(); let hostNameAndPort = `${region}.${authorityUrlParts.HostNameAndPort}`; if (this.isPublicCloudAuthority(authorityUrlParts.HostNameAndPort)) { hostNameAndPort = `${region}.${Constants$1.REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX}`; } // Include the query string portion of the url const url = UrlString.constructAuthorityUriFromObject({ ...authorityUrlInstance.getUrlComponents(), HostNameAndPort: hostNameAndPort, }).urlString; // Add the query string if a query string was provided if (queryString) return `${url}?${queryString}`; return url; } /** * Replace the endpoints in the metadata object with their regional equivalents. * * @param metadata OpenIdConfigResponse * @param azureRegion string */ static replaceWithRegionalInformation(metadata, azureRegion) { const regionalMetadata = { ...metadata }; regionalMetadata.authorization_endpoint = Authority.buildRegionalAuthorityString(regionalMetadata.authorization_endpoint, azureRegion); regionalMetadata.token_endpoint = Authority.buildRegionalAuthorityString(regionalMetadata.token_endpoint, azureRegion); if (regionalMetadata.end_session_endpoint) { regionalMetadata.end_session_endpoint = Authority.buildRegionalAuthorityString(regionalMetadata.end_session_endpoint, azureRegion); } return regionalMetadata; } /** * Transform CIAM_AUTHORIY as per the below rules: * If no path segments found and it is a CIAM authority (hostname ends with .ciamlogin.com), then transform it * * NOTE: The transformation path should go away once STS supports CIAM with the format: `tenantIdorDomain.ciamlogin.com` * `ciamlogin.com` can also change in the future and we should accommodate the same * * @param authority */ static transformCIAMAuthority(authority) { let ciamAuthority = authority; const authorityUrl = new UrlString(authority); const authorityUrlComponents = authorityUrl.getUrlComponents(); // check if transformation is needed if (authorityUrlComponents.PathSegments.length === 0 && authorityUrlComponents.HostNameAndPort.endsWith(Constants$1.CIAM_AUTH_URL)) { const tenantIdOrDomain = authorityUrlComponents.HostNameAndPort.split(".")[0]; ciamAuthority = `${ciamAuthority}${tenantIdOrDomain}${Constants$1.AAD_TENANT_DOMAIN_SUFFIX}`; } return ciamAuthority; } } // Reserved tenant domain names that will not be replaced with tenant id Authority.reservedTenantDomains = new Set([ "{tenant}", "{tenantid}", AADAuthorityConstants.COMMON, AADAuthorityConstants.CONSUMERS, AADAuthorityConstants.ORGANIZATIONS, ]); /** * Extract tenantId from authority */ function getTenantFromAuthorityString(authority) { const authorityUrl = new UrlString(authority); const authorityUrlComponents = authorityUrl.getUrlComponents(); /** * For credential matching purposes, tenantId is the last path segment of the authority URL: * AAD Authority - domain/tenantId -> Credentials are cached with realm = tenantId * B2C Authority - domain/{tenantId}?/.../policy -> Credentials are cached with realm = policy * tenantId is downcased because B2C policies can have mixed case but tfp claim is downcased * * Note that we may not have any path segments in certain OIDC scenarios. */ const tenantId = authorityUrlComponents.PathSegments.slice(-1)[0]?.toLowerCase(); switch (tenantId) { case AADAuthorityConstants.COMMON: case AADAuthorityConstants.ORGANIZATIONS: case AADAuthorityConstants.CONSUMERS: return undefined; default: return tenantId; } } function formatAuthorityUri(authorityUri) { return authorityUri.endsWith(Constants$1.FORWARD_SLASH) ? authorityUri : `${authorityUri}${Constants$1.FORWARD_SLASH}`; } function buildStaticAuthorityOptions(authOptions) { const rawCloudDiscoveryMetadata = authOptions.cloudDiscoveryMetadata; let cloudDiscoveryMetadata = undefined; if (rawCloudDiscoveryMetadata) { try { cloudDiscoveryMetadata = JSON.parse(rawCloudDiscoveryMetadata); } catch (e) { throw createClientConfigurationError(invalidCloudDiscoveryMetadata); } } return { canonicalAuthority: authOptions.authority ? formatAuthorityUri(authOptions.authority) : undefined, knownAuthorities: authOptions.knownAuthorities, cloudDiscoveryMetadata: cloudDiscoveryMetadata, }; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Create an authority object of the correct type based on the url * Performs basic authority validation - checks to see if the authority is of a valid type (i.e. aad, b2c, adfs) * * Also performs endpoint discovery. * * @param authorityUri * @param networkClient * @param protocolMode * @internal */ async function createDiscoveredInstance(authorityUri, networkClient, cacheManager, authorityOptions, logger, correlationId, performanceClient) { performanceClient?.addQueueMeasurement(PerformanceEvents.AuthorityFactoryCreateDiscoveredInstance, correlationId); const authorityUriFinal = Authority.transformCIAMAuthority(formatAuthorityUri(authorityUri)); // Initialize authority and perform discovery endpoint check. const acquireTokenAuthority = new Authority(authorityUriFinal, networkClient, cacheManager, authorityOptions, logger, correlationId, performanceClient); try { await invokeAsync(acquireTokenAuthority.resolveEndpointsAsync.bind(acquireTokenAuthority), PerformanceEvents.AuthorityResolveEndpointsAsync, logger, performanceClient, correlationId)(); return acquireTokenAuthority; } catch (e) { throw createClientAuthError(endpointResolutionError); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Error thrown when there is an error with the server code, for example, unavailability. */ class ServerError extends AuthError { constructor(errorCode, errorMessage, subError, errorNo, status) { super(errorCode, errorMessage, subError); this.name = "ServerError"; this.errorNo = errorNo; this.status = status; Object.setPrototypeOf(this, ServerError.prototype); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** @internal */ class ThrottlingUtils { /** * Prepares a RequestThumbprint to be stored as a key. * @param thumbprint */ static generateThrottlingStorageKey(thumbprint) { return `${ThrottlingConstants.THROTTLING_PREFIX}.${JSON.stringify(thumbprint)}`; } /** * Performs necessary throttling checks before a network request. * @param cacheManager * @param thumbprint */ static preProcess(cacheManager, thumbprint) { const key = ThrottlingUtils.generateThrottlingStorageKey(thumbprint); const value = cacheManager.getThrottlingCache(key); if (value) { if (value.throttleTime < Date.now()) { cacheManager.removeItem(key); return; } throw new ServerError(value.errorCodes?.join(" ") || Constants$1.EMPTY_STRING, value.errorMessage, value.subError); } } /** * Performs necessary throttling checks after a network request. * @param cacheManager * @param thumbprint * @param response */ static postProcess(cacheManager, thumbprint, response) { if (ThrottlingUtils.checkResponseStatus(response) || ThrottlingUtils.checkResponseForRetryAfter(response)) { const thumbprintValue = { throttleTime: ThrottlingUtils.calculateThrottleTime(parseInt(response.headers[HeaderNames.RETRY_AFTER])), error: response.body.error, errorCodes: response.body.error_codes, errorMessage: response.body.error_description, subError: response.body.suberror, }; cacheManager.setThrottlingCache(ThrottlingUtils.generateThrottlingStorageKey(thumbprint), thumbprintValue); } } /** * Checks a NetworkResponse object's status codes against 429 or 5xx * @param response */ static checkResponseStatus(response) { return (response.status === 429 || (response.status >= 500 && response.status < 600)); } /** * Checks a NetworkResponse object's RetryAfter header * @param response */ static checkResponseForRetryAfter(response) { if (response.headers) { return (response.headers.hasOwnProperty(HeaderNames.RETRY_AFTER) && (response.status < 200 || response.status >= 300)); } return false; } /** * Calculates the Unix-time value for a throttle to expire given throttleTime in seconds. * @param throttleTime */ static calculateThrottleTime(throttleTime) { const time = throttleTime <= 0 ? 0 : throttleTime; const currentSeconds = Date.now() / 1000; return Math.floor(Math.min(currentSeconds + (time || ThrottlingConstants.DEFAULT_THROTTLE_TIME_SECONDS), currentSeconds + ThrottlingConstants.DEFAULT_MAX_THROTTLE_TIME_SECONDS) * 1000); } static removeThrottle(cacheManager, clientId, request, homeAccountIdentifier) { const thumbprint = { clientId: clientId, authority: request.authority, scopes: request.scopes, homeAccountIdentifier: homeAccountIdentifier, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; const key = this.generateThrottlingStorageKey(thumbprint); cacheManager.removeItem(key); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Represents network related errors */ class NetworkError extends AuthError { constructor(error, httpStatus, responseHeaders) { super(error.errorCode, error.errorMessage, error.subError); Object.setPrototypeOf(this, NetworkError.prototype); this.name = "NetworkError"; this.error = error; this.httpStatus = httpStatus; this.responseHeaders = responseHeaders; } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Base application class which will construct requests to send to and handle responses from the Microsoft STS using the authorization code flow. * @internal */ class BaseClient { constructor(configuration, performanceClient) { // Set the configuration this.config = buildClientConfiguration(configuration); // Initialize the logger this.logger = new Logger(this.config.loggerOptions, name$1, version$1); // Initialize crypto this.cryptoUtils = this.config.cryptoInterface; // Initialize storage interface this.cacheManager = this.config.storageInterface; // Set the network interface this.networkClient = this.config.networkInterface; // Set TelemetryManager this.serverTelemetryManager = this.config.serverTelemetryManager; // set Authority this.authority = this.config.authOptions.authority; // set performance telemetry client this.performanceClient = performanceClient; } /** * Creates default headers for requests to token endpoint */ createTokenRequestHeaders(ccsCred) { const headers = {}; headers[HeaderNames.CONTENT_TYPE] = Constants$1.URL_FORM_CONTENT_TYPE; if (!this.config.systemOptions.preventCorsPreflight && ccsCred) { switch (ccsCred.type) { case CcsCredentialType.HOME_ACCOUNT_ID: try { const clientInfo = buildClientInfoFromHomeAccountId(ccsCred.credential); headers[HeaderNames.CCS_HEADER] = `Oid:${clientInfo.uid}@${clientInfo.utid}`; } catch (e) { this.logger.verbose("Could not parse home account ID for CCS Header: " + e); } break; case CcsCredentialType.UPN: headers[HeaderNames.CCS_HEADER] = `UPN: ${ccsCred.credential}`; break; } } return headers; } /** * Http post to token endpoint * @param tokenEndpoint * @param queryString * @param headers * @param thumbprint */ async executePostToTokenEndpoint(tokenEndpoint, queryString, headers, thumbprint, correlationId, queuedEvent) { if (queuedEvent) { this.performanceClient?.addQueueMeasurement(queuedEvent, correlationId); } const response = await this.sendPostRequest(thumbprint, tokenEndpoint, { body: queryString, headers: headers }, correlationId); if (this.config.serverTelemetryManager && response.status < 500 && response.status !== 429) { // Telemetry data successfully logged by server, clear Telemetry cache this.config.serverTelemetryManager.clearTelemetryCache(); } return response; } /** * Wraps sendPostRequestAsync with necessary preflight and postflight logic * @param thumbprint - Request thumbprint for throttling * @param tokenEndpoint - Endpoint to make the POST to * @param options - Body and Headers to include on the POST request * @param correlationId - CorrelationId for telemetry */ async sendPostRequest(thumbprint, tokenEndpoint, options, correlationId) { ThrottlingUtils.preProcess(this.cacheManager, thumbprint); let response; try { response = await invokeAsync((this.networkClient.sendPostRequestAsync.bind(this.networkClient)), PerformanceEvents.NetworkClientSendPostRequestAsync, this.logger, this.performanceClient, correlationId)(tokenEndpoint, options); const responseHeaders = response.headers || {}; this.performanceClient?.addFields({ refreshTokenSize: response.body.refresh_token?.length || 0, httpVerToken: responseHeaders[HeaderNames.X_MS_HTTP_VERSION] || "", requestId: responseHeaders[HeaderNames.X_MS_REQUEST_ID] || "", }, correlationId); } catch (e) { if (e instanceof NetworkError) { const responseHeaders = e.responseHeaders; if (responseHeaders) { this.performanceClient?.addFields({ httpVerToken: responseHeaders[HeaderNames.X_MS_HTTP_VERSION] || "", requestId: responseHeaders[HeaderNames.X_MS_REQUEST_ID] || "", contentTypeHeader: responseHeaders[HeaderNames.CONTENT_TYPE] || undefined, contentLengthHeader: responseHeaders[HeaderNames.CONTENT_LENGTH] || undefined, httpStatus: e.httpStatus, }, correlationId); } throw e.error; } if (e instanceof AuthError) { throw e; } else { throw createClientAuthError(networkError); } } ThrottlingUtils.postProcess(this.cacheManager, thumbprint, response); return response; } /** * Updates the authority object of the client. Endpoint discovery must be completed. * @param updatedAuthority */ async updateAuthority(cloudInstanceHostname, correlationId) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.UpdateTokenEndpointAuthority, correlationId); const cloudInstanceAuthorityUri = `https://${cloudInstanceHostname}/${this.authority.tenant}/`; const cloudInstanceAuthority = await createDiscoveredInstance(cloudInstanceAuthorityUri, this.networkClient, this.cacheManager, this.authority.options, this.logger, correlationId, this.performanceClient); this.authority = cloudInstanceAuthority; } /** * Creates query string for the /token request * @param request */ createTokenQueryParameters(request) { const parameterBuilder = new RequestParameterBuilder(request.correlationId, this.performanceClient); if (request.embeddedClientId) { parameterBuilder.addBrokerParameters({ brokerClientId: this.config.authOptions.clientId, brokerRedirectUri: this.config.authOptions.redirectUri, }); } if (request.tokenQueryParameters) { parameterBuilder.addExtraQueryParameters(request.tokenQueryParameters); } parameterBuilder.addCorrelationId(request.correlationId); return parameterBuilder.createQueryString(); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ // Codes defined by MSAL const noTokensFound = "no_tokens_found"; const nativeAccountUnavailable = "native_account_unavailable"; const refreshTokenExpired = "refresh_token_expired"; // Codes potentially returned by server const interactionRequired = "interaction_required"; const consentRequired = "consent_required"; const loginRequired = "login_required"; const badToken = "bad_token"; var InteractionRequiredAuthErrorCodes = /*#__PURE__*/Object.freeze({ __proto__: null, badToken: badToken, consentRequired: consentRequired, interactionRequired: interactionRequired, loginRequired: loginRequired, nativeAccountUnavailable: nativeAccountUnavailable, noTokensFound: noTokensFound, refreshTokenExpired: refreshTokenExpired }); /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * InteractionRequiredServerErrorMessage contains string constants used by error codes and messages returned by the server indicating interaction is required */ const InteractionRequiredServerErrorMessage = [ interactionRequired, consentRequired, loginRequired, badToken, ]; const InteractionRequiredAuthSubErrorMessage = [ "message_only", "additional_action", "basic_action", "user_password_expired", "consent_required", "bad_token", ]; const InteractionRequiredAuthErrorMessages = { [noTokensFound]: "No refresh token found in the cache. Please sign-in.", [nativeAccountUnavailable]: "The requested account is not available in the native broker. It may have been deleted or logged out. Please sign-in again using an interactive API.", [refreshTokenExpired]: "Refresh token has expired.", [badToken]: "Identity provider returned bad_token due to an expired or invalid refresh token. Please invoke an interactive API to resolve.", }; /** * Interaction required errors defined by the SDK * @deprecated Use InteractionRequiredAuthErrorCodes instead */ const InteractionRequiredAuthErrorMessage = { noTokensFoundError: { code: noTokensFound, desc: InteractionRequiredAuthErrorMessages[noTokensFound], }, native_account_unavailable: { code: nativeAccountUnavailable, desc: InteractionRequiredAuthErrorMessages[nativeAccountUnavailable], }, bad_token: { code: badToken, desc: InteractionRequiredAuthErrorMessages[badToken], }, }; /** * Error thrown when user interaction is required. */ class InteractionRequiredAuthError extends AuthError { constructor(errorCode, errorMessage, subError, timestamp, traceId, correlationId, claims, errorNo) { super(errorCode, errorMessage, subError); Object.setPrototypeOf(this, InteractionRequiredAuthError.prototype); this.timestamp = timestamp || Constants$1.EMPTY_STRING; this.traceId = traceId || Constants$1.EMPTY_STRING; this.correlationId = correlationId || Constants$1.EMPTY_STRING; this.claims = claims || Constants$1.EMPTY_STRING; this.name = "InteractionRequiredAuthError"; this.errorNo = errorNo; } } /** * Helper function used to determine if an error thrown by the server requires interaction to resolve * @param errorCode * @param errorString * @param subError */ function isInteractionRequiredError(errorCode, errorString, subError) { const isInteractionRequiredErrorCode = !!errorCode && InteractionRequiredServerErrorMessage.indexOf(errorCode) > -1; const isInteractionRequiredSubError = !!subError && InteractionRequiredAuthSubErrorMessage.indexOf(subError) > -1; const isInteractionRequiredErrorDesc = !!errorString && InteractionRequiredServerErrorMessage.some((irErrorCode) => { return errorString.indexOf(irErrorCode) > -1; }); return (isInteractionRequiredErrorCode || isInteractionRequiredErrorDesc || isInteractionRequiredSubError); } /** * Creates an InteractionRequiredAuthError */ function createInteractionRequiredAuthError(errorCode) { return new InteractionRequiredAuthError(errorCode, InteractionRequiredAuthErrorMessages[errorCode]); } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Class which provides helpers for OAuth 2.0 protocol specific values */ class ProtocolUtils { /** * Appends user state with random guid, or returns random guid. * @param userState * @param randomGuid */ static setRequestState(cryptoObj, userState, meta) { const libraryState = ProtocolUtils.generateLibraryState(cryptoObj, meta); return userState ? `${libraryState}${Constants$1.RESOURCE_DELIM}${userState}` : libraryState; } /** * Generates the state value used by the common library. * @param randomGuid * @param cryptoObj */ static generateLibraryState(cryptoObj, meta) { if (!cryptoObj) { throw createClientAuthError(noCryptoObject); } // Create a state object containing a unique id and the timestamp of the request creation const stateObj = { id: cryptoObj.createNewGuid(), }; if (meta) { stateObj.meta = meta; } const stateString = JSON.stringify(stateObj); return cryptoObj.base64Encode(stateString); } /** * Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user. * @param state * @param cryptoObj */ static parseRequestState(cryptoObj, state) { if (!cryptoObj) { throw createClientAuthError(noCryptoObject); } if (!state) { throw createClientAuthError(invalidState); } try { // Split the state between library state and user passed state and decode them separately const splitState = state.split(Constants$1.RESOURCE_DELIM); const libraryState = splitState[0]; const userState = splitState.length > 1 ? splitState.slice(1).join(Constants$1.RESOURCE_DELIM) : Constants$1.EMPTY_STRING; const libraryStateString = cryptoObj.base64Decode(libraryState); const libraryStateObj = JSON.parse(libraryStateString); return { userRequestState: userState || Constants$1.EMPTY_STRING, libraryState: libraryStateObj, }; } catch (e) { throw createClientAuthError(invalidState); } } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const KeyLocation = { SW: "sw", UHW: "uhw", }; /** @internal */ class PopTokenGenerator { constructor(cryptoUtils, performanceClient) { this.cryptoUtils = cryptoUtils; this.performanceClient = performanceClient; } /** * Generates the req_cnf validated at the RP in the POP protocol for SHR parameters * and returns an object containing the keyid, the full req_cnf string and the req_cnf string hash * @param request * @returns */ async generateCnf(request, logger) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.PopTokenGenerateCnf, request.correlationId); const reqCnf = await invokeAsync(this.generateKid.bind(this), PerformanceEvents.PopTokenGenerateCnf, logger, this.performanceClient, request.correlationId)(request); const reqCnfString = this.cryptoUtils.base64UrlEncode(JSON.stringify(reqCnf)); return { kid: reqCnf.kid, reqCnfString, }; } /** * Generates key_id for a SHR token request * @param request * @returns */ async generateKid(request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.PopTokenGenerateKid, request.correlationId); const kidThumbprint = await this.cryptoUtils.getPublicKeyThumbprint(request); return { kid: kidThumbprint, xms_ksl: KeyLocation.SW, }; } /** * Signs the POP access_token with the local generated key-pair * @param accessToken * @param request * @returns */ async signPopToken(accessToken, keyId, request) { return this.signPayload(accessToken, keyId, request); } /** * Utility function to generate the signed JWT for an access_token * @param payload * @param kid * @param request * @param claims * @returns */ async signPayload(payload, keyId, request, claims) { // Deconstruct request to extract SHR parameters const { resourceRequestMethod, resourceRequestUri, shrClaims, shrNonce, shrOptions, } = request; const resourceUrlString = resourceRequestUri ? new UrlString(resourceRequestUri) : undefined; const resourceUrlComponents = resourceUrlString?.getUrlComponents(); return this.cryptoUtils.signJwt({ at: payload, ts: nowSeconds(), m: resourceRequestMethod?.toUpperCase(), u: resourceUrlComponents?.HostNameAndPort, nonce: shrNonce || this.cryptoUtils.createNewGuid(), p: resourceUrlComponents?.AbsolutePath, q: resourceUrlComponents?.QueryString ? [[], resourceUrlComponents.QueryString] : undefined, client_claims: shrClaims || undefined, ...claims, }, keyId, shrOptions, request.correlationId); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class instance helps track the memory changes facilitating * decisions to read from and write to the persistent cache */ class TokenCacheContext { constructor(tokenCache, hasChanged) { this.cache = tokenCache; this.hasChanged = hasChanged; } /** * boolean which indicates the changes in cache */ get cacheHasChanged() { return this.hasChanged; } /** * function to retrieve the token cache */ get tokenCache() { return this.cache; } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ function parseServerErrorNo(serverResponse) { const errorCodePrefix = "code="; const errorCodePrefixIndex = serverResponse.error_uri?.lastIndexOf(errorCodePrefix); return errorCodePrefixIndex && errorCodePrefixIndex >= 0 ? serverResponse.error_uri?.substring(errorCodePrefixIndex + errorCodePrefix.length) : undefined; } /** * Class that handles response parsing. * @internal */ class ResponseHandler { constructor(clientId, cacheStorage, cryptoObj, logger, serializableCache, persistencePlugin, performanceClient) { this.clientId = clientId; this.cacheStorage = cacheStorage; this.cryptoObj = cryptoObj; this.logger = logger; this.serializableCache = serializableCache; this.persistencePlugin = persistencePlugin; this.performanceClient = performanceClient; } /** * Function which validates server authorization code response. * @param serverResponseHash * @param requestState * @param cryptoObj */ validateServerAuthorizationCodeResponse(serverResponse, requestState) { if (!serverResponse.state || !requestState) { throw serverResponse.state ? createClientAuthError(stateNotFound, "Cached State") : createClientAuthError(stateNotFound, "Server State"); } let decodedServerResponseState; let decodedRequestState; try { decodedServerResponseState = decodeURIComponent(serverResponse.state); } catch (e) { throw createClientAuthError(invalidState, serverResponse.state); } try { decodedRequestState = decodeURIComponent(requestState); } catch (e) { throw createClientAuthError(invalidState, serverResponse.state); } if (decodedServerResponseState !== decodedRequestState) { throw createClientAuthError(stateMismatch); } // Check for error if (serverResponse.error || serverResponse.error_description || serverResponse.suberror) { const serverErrorNo = parseServerErrorNo(serverResponse); if (isInteractionRequiredError(serverResponse.error, serverResponse.error_description, serverResponse.suberror)) { throw new InteractionRequiredAuthError(serverResponse.error || "", serverResponse.error_description, serverResponse.suberror, serverResponse.timestamp || "", serverResponse.trace_id || "", serverResponse.correlation_id || "", serverResponse.claims || "", serverErrorNo); } throw new ServerError(serverResponse.error || "", serverResponse.error_description, serverResponse.suberror, serverErrorNo); } } /** * Function which validates server authorization token response. * @param serverResponse * @param refreshAccessToken */ validateTokenResponse(serverResponse, refreshAccessToken) { // Check for error if (serverResponse.error || serverResponse.error_description || serverResponse.suberror) { const errString = `Error(s): ${serverResponse.error_codes || Constants$1.NOT_AVAILABLE} - Timestamp: ${serverResponse.timestamp || Constants$1.NOT_AVAILABLE} - Description: ${serverResponse.error_description || Constants$1.NOT_AVAILABLE} - Correlation ID: ${serverResponse.correlation_id || Constants$1.NOT_AVAILABLE} - Trace ID: ${serverResponse.trace_id || Constants$1.NOT_AVAILABLE}`; const serverErrorNo = serverResponse.error_codes?.length ? serverResponse.error_codes[0] : undefined; const serverError = new ServerError(serverResponse.error, errString, serverResponse.suberror, serverErrorNo, serverResponse.status); // check if 500 error if (refreshAccessToken && serverResponse.status && serverResponse.status >= HttpStatus.SERVER_ERROR_RANGE_START && serverResponse.status <= HttpStatus.SERVER_ERROR_RANGE_END) { this.logger.warning(`executeTokenRequest:validateTokenResponse - AAD is currently unavailable and the access token is unable to be refreshed.\n${serverError}`); // don't throw an exception, but alert the user via a log that the token was unable to be refreshed return; // check if 400 error } else if (refreshAccessToken && serverResponse.status && serverResponse.status >= HttpStatus.CLIENT_ERROR_RANGE_START && serverResponse.status <= HttpStatus.CLIENT_ERROR_RANGE_END) { this.logger.warning(`executeTokenRequest:validateTokenResponse - AAD is currently available but is unable to refresh the access token.\n${serverError}`); // don't throw an exception, but alert the user via a log that the token was unable to be refreshed return; } if (isInteractionRequiredError(serverResponse.error, serverResponse.error_description, serverResponse.suberror)) { throw new InteractionRequiredAuthError(serverResponse.error, serverResponse.error_description, serverResponse.suberror, serverResponse.timestamp || Constants$1.EMPTY_STRING, serverResponse.trace_id || Constants$1.EMPTY_STRING, serverResponse.correlation_id || Constants$1.EMPTY_STRING, serverResponse.claims || Constants$1.EMPTY_STRING, serverErrorNo); } throw serverError; } } /** * Returns a constructed token response based on given string. Also manages the cache updates and cleanups. * @param serverTokenResponse * @param authority */ async handleServerTokenResponse(serverTokenResponse, authority, reqTimestamp, request, authCodePayload, userAssertionHash, handlingRefreshTokenResponse, forceCacheRefreshTokenResponse, serverRequestId) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.HandleServerTokenResponse, serverTokenResponse.correlation_id); // create an idToken object (not entity) let idTokenClaims; if (serverTokenResponse.id_token) { idTokenClaims = extractTokenClaims(serverTokenResponse.id_token || Constants$1.EMPTY_STRING, this.cryptoObj.base64Decode); // token nonce check (TODO: Add a warning if no nonce is given?) if (authCodePayload && authCodePayload.nonce) { if (idTokenClaims.nonce !== authCodePayload.nonce) { throw createClientAuthError(nonceMismatch); } } // token max_age check if (request.maxAge || request.maxAge === 0) { const authTime = idTokenClaims.auth_time; if (!authTime) { throw createClientAuthError(authTimeNotFound); } checkMaxAge(authTime, request.maxAge); } } // generate homeAccountId this.homeAccountIdentifier = AccountEntity.generateHomeAccountId(serverTokenResponse.client_info || Constants$1.EMPTY_STRING, authority.authorityType, this.logger, this.cryptoObj, idTokenClaims); // save the response tokens let requestStateObj; if (!!authCodePayload && !!authCodePayload.state) { requestStateObj = ProtocolUtils.parseRequestState(this.cryptoObj, authCodePayload.state); } // Add keyId from request to serverTokenResponse if defined serverTokenResponse.key_id = serverTokenResponse.key_id || request.sshKid || undefined; const cacheRecord = this.generateCacheRecord(serverTokenResponse, authority, reqTimestamp, request, idTokenClaims, userAssertionHash, authCodePayload); let cacheContext; try { if (this.persistencePlugin && this.serializableCache) { this.logger.verbose("Persistence enabled, calling beforeCacheAccess"); cacheContext = new TokenCacheContext(this.serializableCache, true); await this.persistencePlugin.beforeCacheAccess(cacheContext); } /* * When saving a refreshed tokens to the cache, it is expected that the account that was used is present in the cache. * If not present, we should return null, as it's the case that another application called removeAccount in between * the calls to getAllAccounts and acquireTokenSilent. We should not overwrite that removal, unless explicitly flagged by * the developer, as in the case of refresh token flow used in ADAL Node to MSAL Node migration. */ if (handlingRefreshTokenResponse && !forceCacheRefreshTokenResponse && cacheRecord.account) { const key = cacheRecord.account.generateAccountKey(); const account = this.cacheStorage.getAccount(key, this.logger); if (!account) { this.logger.warning("Account used to refresh tokens not in persistence, refreshed tokens will not be stored in the cache"); return await ResponseHandler.generateAuthenticationResult(this.cryptoObj, authority, cacheRecord, false, request, idTokenClaims, requestStateObj, undefined, serverRequestId); } } await this.cacheStorage.saveCacheRecord(cacheRecord, request.storeInCache, request.correlationId); } finally { if (this.persistencePlugin && this.serializableCache && cacheContext) { this.logger.verbose("Persistence enabled, calling afterCacheAccess"); await this.persistencePlugin.afterCacheAccess(cacheContext); } } return ResponseHandler.generateAuthenticationResult(this.cryptoObj, authority, cacheRecord, false, request, idTokenClaims, requestStateObj, serverTokenResponse, serverRequestId); } /** * Generates CacheRecord * @param serverTokenResponse * @param idTokenObj * @param authority */ generateCacheRecord(serverTokenResponse, authority, reqTimestamp, request, idTokenClaims, userAssertionHash, authCodePayload) { const env = authority.getPreferredCache(); if (!env) { throw createClientAuthError(invalidCacheEnvironment); } const claimsTenantId = getTenantIdFromIdTokenClaims(idTokenClaims); // IdToken: non AAD scenarios can have empty realm let cachedIdToken; let cachedAccount; if (serverTokenResponse.id_token && !!idTokenClaims) { cachedIdToken = createIdTokenEntity(this.homeAccountIdentifier, env, serverTokenResponse.id_token, this.clientId, claimsTenantId || ""); cachedAccount = buildAccountToCache(this.cacheStorage, authority, this.homeAccountIdentifier, this.cryptoObj.base64Decode, idTokenClaims, serverTokenResponse.client_info, env, claimsTenantId, authCodePayload, undefined, // nativeAccountId this.logger); } // AccessToken let cachedAccessToken = null; if (serverTokenResponse.access_token) { // If scopes not returned in server response, use request scopes const responseScopes = serverTokenResponse.scope ? ScopeSet.fromString(serverTokenResponse.scope) : new ScopeSet(request.scopes || []); /* * Use timestamp calculated before request * Server may return timestamps as strings, parse to numbers if so. */ const expiresIn = (typeof serverTokenResponse.expires_in === "string" ? parseInt(serverTokenResponse.expires_in, 10) : serverTokenResponse.expires_in) || 0; const extExpiresIn = (typeof serverTokenResponse.ext_expires_in === "string" ? parseInt(serverTokenResponse.ext_expires_in, 10) : serverTokenResponse.ext_expires_in) || 0; const refreshIn = (typeof serverTokenResponse.refresh_in === "string" ? parseInt(serverTokenResponse.refresh_in, 10) : serverTokenResponse.refresh_in) || undefined; const tokenExpirationSeconds = reqTimestamp + expiresIn; const extendedTokenExpirationSeconds = tokenExpirationSeconds + extExpiresIn; const refreshOnSeconds = refreshIn && refreshIn > 0 ? reqTimestamp + refreshIn : undefined; // non AAD scenarios can have empty realm cachedAccessToken = createAccessTokenEntity(this.homeAccountIdentifier, env, serverTokenResponse.access_token, this.clientId, claimsTenantId || authority.tenant || "", responseScopes.printScopes(), tokenExpirationSeconds, extendedTokenExpirationSeconds, this.cryptoObj.base64Decode, refreshOnSeconds, serverTokenResponse.token_type, userAssertionHash, serverTokenResponse.key_id, request.claims, request.requestedClaimsHash); } // refreshToken let cachedRefreshToken = null; if (serverTokenResponse.refresh_token) { let rtExpiresOn; if (serverTokenResponse.refresh_token_expires_in) { const rtExpiresIn = typeof serverTokenResponse.refresh_token_expires_in === "string" ? parseInt(serverTokenResponse.refresh_token_expires_in, 10) : serverTokenResponse.refresh_token_expires_in; rtExpiresOn = reqTimestamp + rtExpiresIn; } cachedRefreshToken = createRefreshTokenEntity(this.homeAccountIdentifier, env, serverTokenResponse.refresh_token, this.clientId, serverTokenResponse.foci, userAssertionHash, rtExpiresOn); } // appMetadata let cachedAppMetadata = null; if (serverTokenResponse.foci) { cachedAppMetadata = { clientId: this.clientId, environment: env, familyId: serverTokenResponse.foci, }; } return { account: cachedAccount, idToken: cachedIdToken, accessToken: cachedAccessToken, refreshToken: cachedRefreshToken, appMetadata: cachedAppMetadata, }; } /** * Creates an @AuthenticationResult from @CacheRecord , @IdToken , and a boolean that states whether or not the result is from cache. * * Optionally takes a state string that is set as-is in the response. * * @param cacheRecord * @param idTokenObj * @param fromTokenCache * @param stateString */ static async generateAuthenticationResult(cryptoObj, authority, cacheRecord, fromTokenCache, request, idTokenClaims, requestState, serverTokenResponse, requestId) { let accessToken = Constants$1.EMPTY_STRING; let responseScopes = []; let expiresOn = null; let extExpiresOn; let refreshOn; let familyId = Constants$1.EMPTY_STRING; if (cacheRecord.accessToken) { /* * if the request object has `popKid` property, `signPopToken` will be set to false and * the token will be returned unsigned */ if (cacheRecord.accessToken.tokenType === AuthenticationScheme.POP && !request.popKid) { const popTokenGenerator = new PopTokenGenerator(cryptoObj); const { secret, keyId } = cacheRecord.accessToken; if (!keyId) { throw createClientAuthError(keyIdMissing); } accessToken = await popTokenGenerator.signPopToken(secret, keyId, request); } else { accessToken = cacheRecord.accessToken.secret; } responseScopes = ScopeSet.fromString(cacheRecord.accessToken.target).asArray(); expiresOn = new Date(Number(cacheRecord.accessToken.expiresOn) * 1000); extExpiresOn = new Date(Number(cacheRecord.accessToken.extendedExpiresOn) * 1000); if (cacheRecord.accessToken.refreshOn) { refreshOn = new Date(Number(cacheRecord.accessToken.refreshOn) * 1000); } } if (cacheRecord.appMetadata) { familyId = cacheRecord.appMetadata.familyId === THE_FAMILY_ID ? THE_FAMILY_ID : ""; } const uid = idTokenClaims?.oid || idTokenClaims?.sub || ""; const tid = idTokenClaims?.tid || ""; // for hybrid + native bridge enablement, send back the native account Id if (serverTokenResponse?.spa_accountid && !!cacheRecord.account) { cacheRecord.account.nativeAccountId = serverTokenResponse?.spa_accountid; } const accountInfo = cacheRecord.account ? updateAccountTenantProfileData(cacheRecord.account.getAccountInfo(), undefined, // tenantProfile optional idTokenClaims, cacheRecord.idToken?.secret) : null; return { authority: authority.canonicalAuthority, uniqueId: uid, tenantId: tid, scopes: responseScopes, account: accountInfo, idToken: cacheRecord?.idToken?.secret || "", idTokenClaims: idTokenClaims || {}, accessToken: accessToken, fromCache: fromTokenCache, expiresOn: expiresOn, extExpiresOn: extExpiresOn, refreshOn: refreshOn, correlationId: request.correlationId, requestId: requestId || Constants$1.EMPTY_STRING, familyId: familyId, tokenType: cacheRecord.accessToken?.tokenType || Constants$1.EMPTY_STRING, state: requestState ? requestState.userRequestState : Constants$1.EMPTY_STRING, cloudGraphHostName: cacheRecord.account?.cloudGraphHostName || Constants$1.EMPTY_STRING, msGraphHost: cacheRecord.account?.msGraphHost || Constants$1.EMPTY_STRING, code: serverTokenResponse?.spa_code, fromNativeBroker: false, }; } } function buildAccountToCache(cacheStorage, authority, homeAccountId, base64Decode, idTokenClaims, clientInfo, environment, claimsTenantId, authCodePayload, nativeAccountId, logger) { logger?.verbose("setCachedAccount called"); // Check if base account is already cached const accountKeys = cacheStorage.getAccountKeys(); const baseAccountKey = accountKeys.find((accountKey) => { return accountKey.startsWith(homeAccountId); }); let cachedAccount = null; if (baseAccountKey) { cachedAccount = cacheStorage.getAccount(baseAccountKey, logger); } const baseAccount = cachedAccount || AccountEntity.createAccount({ homeAccountId, idTokenClaims, clientInfo, environment, cloudGraphHostName: authCodePayload?.cloud_graph_host_name, msGraphHost: authCodePayload?.msgraph_host, nativeAccountId: nativeAccountId, }, authority, base64Decode); const tenantProfiles = baseAccount.tenantProfiles || []; const tenantId = claimsTenantId || baseAccount.realm; if (tenantId && !tenantProfiles.find((tenantProfile) => { return tenantProfile.tenantId === tenantId; })) { const newTenantProfile = buildTenantProfile(homeAccountId, baseAccount.localAccountId, tenantId, idTokenClaims); tenantProfiles.push(newTenantProfile); } baseAccount.tenantProfiles = tenantProfiles; return baseAccount; } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ async function getClientAssertion(clientAssertion, clientId, tokenEndpoint) { if (typeof clientAssertion === "string") { return clientAssertion; } else { const config = { clientId: clientId, tokenEndpoint: tokenEndpoint, }; return clientAssertion(config); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Oauth2.0 Authorization Code client * @internal */ class AuthorizationCodeClient extends BaseClient { constructor(configuration, performanceClient) { super(configuration, performanceClient); // Flag to indicate if client is for hybrid spa auth code redemption this.includeRedirectUri = true; this.oidcDefaultScopes = this.config.authOptions.authority.options.OIDCOptions?.defaultScopes; } /** * Creates the URL of the authorization request letting the user input credentials and consent to the * application. The URL target the /authorize endpoint of the authority configured in the * application object. * * Once the user inputs their credentials and consents, the authority will send a response to the redirect URI * sent in the request and should contain an authorization code, which can then be used to acquire tokens via * acquireToken(AuthorizationCodeRequest) * @param request */ async getAuthCodeUrl(request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.GetAuthCodeUrl, request.correlationId); const queryString = await invokeAsync(this.createAuthCodeUrlQueryString.bind(this), PerformanceEvents.AuthClientCreateQueryString, this.logger, this.performanceClient, request.correlationId)(request); return UrlString.appendQueryString(this.authority.authorizationEndpoint, queryString); } /** * API to acquire a token in exchange of 'authorization_code` acquired by the user in the first leg of the * authorization_code_grant * @param request */ async acquireToken(request, authCodePayload) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientAcquireToken, request.correlationId); if (!request.code) { throw createClientAuthError(requestCannotBeMade); } const reqTimestamp = nowSeconds(); const response = await invokeAsync(this.executeTokenRequest.bind(this), PerformanceEvents.AuthClientExecuteTokenRequest, this.logger, this.performanceClient, request.correlationId)(this.authority, request); // Retrieve requestId from response headers const requestId = response.headers?.[HeaderNames.X_MS_REQUEST_ID]; const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin, this.performanceClient); // Validate response. This function throws a server error if an error is returned by the server. responseHandler.validateTokenResponse(response.body); return invokeAsync(responseHandler.handleServerTokenResponse.bind(responseHandler), PerformanceEvents.HandleServerTokenResponse, this.logger, this.performanceClient, request.correlationId)(response.body, this.authority, reqTimestamp, request, authCodePayload, undefined, undefined, undefined, requestId); } /** * Handles the hash fragment response from public client code request. Returns a code response used by * the client to exchange for a token in acquireToken. * @param hashFragment */ handleFragmentResponse(serverParams, cachedState) { // Handle responses. const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, null, null); // Get code response responseHandler.validateServerAuthorizationCodeResponse(serverParams, cachedState); // throw when there is no auth code in the response if (!serverParams.code) { throw createClientAuthError(authorizationCodeMissingFromServerResponse); } return serverParams; } /** * Used to log out the current user, and redirect the user to the postLogoutRedirectUri. * Default behaviour is to redirect the user to `window.location.href`. * @param authorityUri */ getLogoutUri(logoutRequest) { // Throw error if logoutRequest is null/undefined if (!logoutRequest) { throw createClientConfigurationError(logoutRequestEmpty); } const queryString = this.createLogoutUrlQueryString(logoutRequest); // Construct logout URI return UrlString.appendQueryString(this.authority.endSessionEndpoint, queryString); } /** * Executes POST request to token endpoint * @param authority * @param request */ async executeTokenRequest(authority, request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientExecuteTokenRequest, request.correlationId); const queryParametersString = this.createTokenQueryParameters(request); const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString); const requestBody = await invokeAsync(this.createTokenRequestBody.bind(this), PerformanceEvents.AuthClientCreateTokenRequestBody, this.logger, this.performanceClient, request.correlationId)(request); let ccsCredential = undefined; if (request.clientInfo) { try { const clientInfo = buildClientInfo(request.clientInfo, this.cryptoUtils.base64Decode); ccsCredential = { credential: `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`, type: CcsCredentialType.HOME_ACCOUNT_ID, }; } catch (e) { this.logger.verbose("Could not parse client info for CCS Header: " + e); } } const headers = this.createTokenRequestHeaders(ccsCredential || request.ccsCredential); const thumbprint = { clientId: request.tokenBodyParameters?.clientId || this.config.authOptions.clientId, authority: authority.canonicalAuthority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; return invokeAsync(this.executePostToTokenEndpoint.bind(this), PerformanceEvents.AuthorizationCodeClientExecutePostToTokenEndpoint, this.logger, this.performanceClient, request.correlationId)(endpoint, requestBody, headers, thumbprint, request.correlationId, PerformanceEvents.AuthorizationCodeClientExecutePostToTokenEndpoint); } /** * Generates a map for all the params to be sent to the service * @param request */ async createTokenRequestBody(request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientCreateTokenRequestBody, request.correlationId); const parameterBuilder = new RequestParameterBuilder(request.correlationId, this.performanceClient); parameterBuilder.addClientId(request.embeddedClientId || request.tokenBodyParameters?.[CLIENT_ID] || this.config.authOptions.clientId); /* * For hybrid spa flow, there will be a code but no verifier * In this scenario, don't include redirect uri as auth code will not be bound to redirect URI */ if (!this.includeRedirectUri) { // Just validate RequestValidator.validateRedirectUri(request.redirectUri); } else { // Validate and include redirect uri parameterBuilder.addRedirectUri(request.redirectUri); } // Add scope array, parameter builder will add default scopes and dedupe parameterBuilder.addScopes(request.scopes, true, this.oidcDefaultScopes); // add code: user set, not validated parameterBuilder.addAuthorizationCode(request.code); // Add library metadata parameterBuilder.addLibraryInfo(this.config.libraryInfo); parameterBuilder.addApplicationTelemetry(this.config.telemetry.application); parameterBuilder.addThrottling(); if (this.serverTelemetryManager && !isOidcProtocolMode(this.config)) { parameterBuilder.addServerTelemetry(this.serverTelemetryManager); } // add code_verifier if passed if (request.codeVerifier) { parameterBuilder.addCodeVerifier(request.codeVerifier); } if (this.config.clientCredentials.clientSecret) { parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret); } if (this.config.clientCredentials.clientAssertion) { const clientAssertion = this.config.clientCredentials.clientAssertion; parameterBuilder.addClientAssertion(await getClientAssertion(clientAssertion.assertion, this.config.authOptions.clientId, request.resourceRequestUri)); parameterBuilder.addClientAssertionType(clientAssertion.assertionType); } parameterBuilder.addGrantType(GrantType.AUTHORIZATION_CODE_GRANT); parameterBuilder.addClientInfo(); if (request.authenticationScheme === AuthenticationScheme.POP) { const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils, this.performanceClient); let reqCnfData; if (!request.popKid) { const generatedReqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger); reqCnfData = generatedReqCnfData.reqCnfString; } else { reqCnfData = this.cryptoUtils.encodeKid(request.popKid); } // SPA PoP requires full Base64Url encoded req_cnf string (unhashed) parameterBuilder.addPopToken(reqCnfData); } else if (request.authenticationScheme === AuthenticationScheme.SSH) { if (request.sshJwk) { parameterBuilder.addSshJwk(request.sshJwk); } else { throw createClientConfigurationError(missingSshJwk); } } if (!StringUtils.isEmptyObj(request.claims) || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } let ccsCred = undefined; if (request.clientInfo) { try { const clientInfo = buildClientInfo(request.clientInfo, this.cryptoUtils.base64Decode); ccsCred = { credential: `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`, type: CcsCredentialType.HOME_ACCOUNT_ID, }; } catch (e) { this.logger.verbose("Could not parse client info for CCS Header: " + e); } } else { ccsCred = request.ccsCredential; } // Adds these as parameters in the request instead of headers to prevent CORS preflight request if (this.config.systemOptions.preventCorsPreflight && ccsCred) { switch (ccsCred.type) { case CcsCredentialType.HOME_ACCOUNT_ID: try { const clientInfo = buildClientInfoFromHomeAccountId(ccsCred.credential); parameterBuilder.addCcsOid(clientInfo); } catch (e) { this.logger.verbose("Could not parse home account ID for CCS Header: " + e); } break; case CcsCredentialType.UPN: parameterBuilder.addCcsUpn(ccsCred.credential); break; } } if (request.embeddedClientId) { parameterBuilder.addBrokerParameters({ brokerClientId: this.config.authOptions.clientId, brokerRedirectUri: this.config.authOptions.redirectUri, }); } if (request.tokenBodyParameters) { parameterBuilder.addExtraQueryParameters(request.tokenBodyParameters); } // Add hybrid spa parameters if not already provided if (request.enableSpaAuthorizationCode && (!request.tokenBodyParameters || !request.tokenBodyParameters[RETURN_SPA_CODE])) { parameterBuilder.addExtraQueryParameters({ [RETURN_SPA_CODE]: "1", }); } return parameterBuilder.createQueryString(); } /** * This API validates the `AuthorizationCodeUrlRequest` and creates a URL * @param request */ async createAuthCodeUrlQueryString(request) { // generate the correlationId if not set by the user and add const correlationId = request.correlationId || this.config.cryptoInterface.createNewGuid(); this.performanceClient?.addQueueMeasurement(PerformanceEvents.AuthClientCreateQueryString, correlationId); const parameterBuilder = new RequestParameterBuilder(correlationId, this.performanceClient); parameterBuilder.addClientId(request.embeddedClientId || request.extraQueryParameters?.[CLIENT_ID] || this.config.authOptions.clientId); const requestScopes = [ ...(request.scopes || []), ...(request.extraScopesToConsent || []), ]; parameterBuilder.addScopes(requestScopes, true, this.oidcDefaultScopes); // validate the redirectUri (to be a non null value) parameterBuilder.addRedirectUri(request.redirectUri); parameterBuilder.addCorrelationId(correlationId); // add response_mode. If not passed in it defaults to query. parameterBuilder.addResponseMode(request.responseMode); // add response_type = code parameterBuilder.addResponseTypeCode(); // add library info parameters parameterBuilder.addLibraryInfo(this.config.libraryInfo); if (!isOidcProtocolMode(this.config)) { parameterBuilder.addApplicationTelemetry(this.config.telemetry.application); } // add client_info=1 parameterBuilder.addClientInfo(); if (request.codeChallenge && request.codeChallengeMethod) { parameterBuilder.addCodeChallengeParams(request.codeChallenge, request.codeChallengeMethod); } if (request.prompt) { parameterBuilder.addPrompt(request.prompt); } if (request.domainHint) { parameterBuilder.addDomainHint(request.domainHint); } // Add sid or loginHint with preference for login_hint claim (in request) -> sid -> loginHint (upn/email) -> username of AccountInfo object if (request.prompt !== PromptValue.SELECT_ACCOUNT) { // AAD will throw if prompt=select_account is passed with an account hint if (request.sid && request.prompt === PromptValue.NONE) { // SessionID is only used in silent calls this.logger.verbose("createAuthCodeUrlQueryString: Prompt is none, adding sid from request"); parameterBuilder.addSid(request.sid); } else if (request.account) { const accountSid = this.extractAccountSid(request.account); let accountLoginHintClaim = this.extractLoginHint(request.account); if (accountLoginHintClaim && request.domainHint) { this.logger.warning(`AuthorizationCodeClient.createAuthCodeUrlQueryString: "domainHint" param is set, skipping opaque "login_hint" claim. Please consider not passing domainHint`); accountLoginHintClaim = null; } // If login_hint claim is present, use it over sid/username if (accountLoginHintClaim) { this.logger.verbose("createAuthCodeUrlQueryString: login_hint claim present on account"); parameterBuilder.addLoginHint(accountLoginHintClaim); try { const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId); parameterBuilder.addCcsOid(clientInfo); } catch (e) { this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header"); } } else if (accountSid && request.prompt === PromptValue.NONE) { /* * If account and loginHint are provided, we will check account first for sid before adding loginHint * SessionId is only used in silent calls */ this.logger.verbose("createAuthCodeUrlQueryString: Prompt is none, adding sid from account"); parameterBuilder.addSid(accountSid); try { const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId); parameterBuilder.addCcsOid(clientInfo); } catch (e) { this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header"); } } else if (request.loginHint) { this.logger.verbose("createAuthCodeUrlQueryString: Adding login_hint from request"); parameterBuilder.addLoginHint(request.loginHint); parameterBuilder.addCcsUpn(request.loginHint); } else if (request.account.username) { // Fallback to account username if provided this.logger.verbose("createAuthCodeUrlQueryString: Adding login_hint from account"); parameterBuilder.addLoginHint(request.account.username); try { const clientInfo = buildClientInfoFromHomeAccountId(request.account.homeAccountId); parameterBuilder.addCcsOid(clientInfo); } catch (e) { this.logger.verbose("createAuthCodeUrlQueryString: Could not parse home account ID for CCS Header"); } } } else if (request.loginHint) { this.logger.verbose("createAuthCodeUrlQueryString: No account, adding login_hint from request"); parameterBuilder.addLoginHint(request.loginHint); parameterBuilder.addCcsUpn(request.loginHint); } } else { this.logger.verbose("createAuthCodeUrlQueryString: Prompt is select_account, ignoring account hints"); } if (request.nonce) { parameterBuilder.addNonce(request.nonce); } if (request.state) { parameterBuilder.addState(request.state); } if (request.claims || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } if (request.embeddedClientId) { parameterBuilder.addBrokerParameters({ brokerClientId: this.config.authOptions.clientId, brokerRedirectUri: this.config.authOptions.redirectUri, }); } this.addExtraQueryParams(request, parameterBuilder); if (request.nativeBroker) { // signal ests that this is a WAM call parameterBuilder.addNativeBroker(); // pass the req_cnf for POP if (request.authenticationScheme === AuthenticationScheme.POP) { const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils); // req_cnf is always sent as a string for SPAs let reqCnfData; if (!request.popKid) { const generatedReqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger); reqCnfData = generatedReqCnfData.reqCnfString; } else { reqCnfData = this.cryptoUtils.encodeKid(request.popKid); } parameterBuilder.addPopToken(reqCnfData); } } return parameterBuilder.createQueryString(); } /** * This API validates the `EndSessionRequest` and creates a URL * @param request */ createLogoutUrlQueryString(request) { const parameterBuilder = new RequestParameterBuilder(request.correlationId, this.performanceClient); if (request.postLogoutRedirectUri) { parameterBuilder.addPostLogoutRedirectUri(request.postLogoutRedirectUri); } if (request.correlationId) { parameterBuilder.addCorrelationId(request.correlationId); } if (request.idTokenHint) { parameterBuilder.addIdTokenHint(request.idTokenHint); } if (request.state) { parameterBuilder.addState(request.state); } if (request.logoutHint) { parameterBuilder.addLogoutHint(request.logoutHint); } this.addExtraQueryParams(request, parameterBuilder); return parameterBuilder.createQueryString(); } addExtraQueryParams(request, parameterBuilder) { const hasRequestInstanceAware = request.extraQueryParameters && request.extraQueryParameters.hasOwnProperty("instance_aware"); // Set instance_aware flag if config auth param is set if (!hasRequestInstanceAware && this.config.authOptions.instanceAware) { request.extraQueryParameters = request.extraQueryParameters || {}; request.extraQueryParameters["instance_aware"] = "true"; } if (request.extraQueryParameters) { parameterBuilder.addExtraQueryParameters(request.extraQueryParameters); } } /** * Helper to get sid from account. Returns null if idTokenClaims are not present or sid is not present. * @param account */ extractAccountSid(account) { return account.idTokenClaims?.sid || null; } extractLoginHint(account) { return account.idTokenClaims?.login_hint || null; } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const DEFAULT_REFRESH_TOKEN_EXPIRATION_OFFSET_SECONDS = 300; // 5 Minutes /** * OAuth2.0 refresh token client * @internal */ class RefreshTokenClient extends BaseClient { constructor(configuration, performanceClient) { super(configuration, performanceClient); } async acquireToken(request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireToken, request.correlationId); const reqTimestamp = nowSeconds(); const response = await invokeAsync(this.executeTokenRequest.bind(this), PerformanceEvents.RefreshTokenClientExecuteTokenRequest, this.logger, this.performanceClient, request.correlationId)(request, this.authority); // Retrieve requestId from response headers const requestId = response.headers?.[HeaderNames.X_MS_REQUEST_ID]; const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin); responseHandler.validateTokenResponse(response.body); return invokeAsync(responseHandler.handleServerTokenResponse.bind(responseHandler), PerformanceEvents.HandleServerTokenResponse, this.logger, this.performanceClient, request.correlationId)(response.body, this.authority, reqTimestamp, request, undefined, undefined, true, request.forceCache, requestId); } /** * Gets cached refresh token and attaches to request, then calls acquireToken API * @param request */ async acquireTokenByRefreshToken(request) { // Cannot renew token if no request object is given. if (!request) { throw createClientConfigurationError(tokenRequestEmpty); } this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireTokenByRefreshToken, request.correlationId); // We currently do not support silent flow for account === null use cases; This will be revisited for confidential flow usecases if (!request.account) { throw createClientAuthError(noAccountInSilentRequest); } // try checking if FOCI is enabled for the given application const isFOCI = this.cacheManager.isAppMetadataFOCI(request.account.environment); // if the app is part of the family, retrive a Family refresh token if present and make a refreshTokenRequest if (isFOCI) { try { return await invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, true); } catch (e) { const noFamilyRTInCache = e instanceof InteractionRequiredAuthError && e.errorCode === noTokensFound; const clientMismatchErrorWithFamilyRT = e instanceof ServerError && e.errorCode === Errors.INVALID_GRANT_ERROR && e.subError === Errors.CLIENT_MISMATCH_ERROR; // if family Refresh Token (FRT) cache acquisition fails or if client_mismatch error is seen with FRT, reattempt with application Refresh Token (ART) if (noFamilyRTInCache || clientMismatchErrorWithFamilyRT) { return invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, false); // throw in all other cases } else { throw e; } } } // fall back to application refresh token acquisition return invokeAsync(this.acquireTokenWithCachedRefreshToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, this.logger, this.performanceClient, request.correlationId)(request, false); } /** * makes a network call to acquire tokens by exchanging RefreshToken available in userCache; throws if refresh token is not cached * @param request */ async acquireTokenWithCachedRefreshToken(request, foci) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken, request.correlationId); // fetches family RT or application RT based on FOCI value const refreshToken = invoke(this.cacheManager.getRefreshToken.bind(this.cacheManager), PerformanceEvents.CacheManagerGetRefreshToken, this.logger, this.performanceClient, request.correlationId)(request.account, foci, undefined, this.performanceClient, request.correlationId); if (!refreshToken) { throw createInteractionRequiredAuthError(noTokensFound); } if (refreshToken.expiresOn && isTokenExpired(refreshToken.expiresOn, request.refreshTokenExpirationOffsetSeconds || DEFAULT_REFRESH_TOKEN_EXPIRATION_OFFSET_SECONDS)) { throw createInteractionRequiredAuthError(refreshTokenExpired); } // attach cached RT size to the current measurement const refreshTokenRequest = { ...request, refreshToken: refreshToken.secret, authenticationScheme: request.authenticationScheme || AuthenticationScheme.BEARER, ccsCredential: { credential: request.account.homeAccountId, type: CcsCredentialType.HOME_ACCOUNT_ID, }, }; try { return await invokeAsync(this.acquireToken.bind(this), PerformanceEvents.RefreshTokenClientAcquireToken, this.logger, this.performanceClient, request.correlationId)(refreshTokenRequest); } catch (e) { if (e instanceof InteractionRequiredAuthError && e.subError === badToken) { // Remove bad refresh token from cache this.logger.verbose("acquireTokenWithRefreshToken: bad refresh token, removing from cache"); const badRefreshTokenKey = generateCredentialKey(refreshToken); this.cacheManager.removeRefreshToken(badRefreshTokenKey); } throw e; } } /** * Constructs the network message and makes a NW call to the underlying secure token service * @param request * @param authority */ async executeTokenRequest(request, authority) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientExecuteTokenRequest, request.correlationId); const queryParametersString = this.createTokenQueryParameters(request); const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString); const requestBody = await invokeAsync(this.createTokenRequestBody.bind(this), PerformanceEvents.RefreshTokenClientCreateTokenRequestBody, this.logger, this.performanceClient, request.correlationId)(request); const headers = this.createTokenRequestHeaders(request.ccsCredential); const thumbprint = { clientId: request.tokenBodyParameters?.clientId || this.config.authOptions.clientId, authority: authority.canonicalAuthority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; return invokeAsync(this.executePostToTokenEndpoint.bind(this), PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint, this.logger, this.performanceClient, request.correlationId)(endpoint, requestBody, headers, thumbprint, request.correlationId, PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint); } /** * Helper function to create the token request body * @param request */ async createTokenRequestBody(request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.RefreshTokenClientCreateTokenRequestBody, request.correlationId); const correlationId = request.correlationId; const parameterBuilder = new RequestParameterBuilder(correlationId, this.performanceClient); parameterBuilder.addClientId(request.embeddedClientId || request.tokenBodyParameters?.[CLIENT_ID] || this.config.authOptions.clientId); if (request.redirectUri) { parameterBuilder.addRedirectUri(request.redirectUri); } parameterBuilder.addScopes(request.scopes, true, this.config.authOptions.authority.options.OIDCOptions?.defaultScopes); parameterBuilder.addGrantType(GrantType.REFRESH_TOKEN_GRANT); parameterBuilder.addClientInfo(); parameterBuilder.addLibraryInfo(this.config.libraryInfo); parameterBuilder.addApplicationTelemetry(this.config.telemetry.application); parameterBuilder.addThrottling(); if (this.serverTelemetryManager && !isOidcProtocolMode(this.config)) { parameterBuilder.addServerTelemetry(this.serverTelemetryManager); } parameterBuilder.addRefreshToken(request.refreshToken); if (this.config.clientCredentials.clientSecret) { parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret); } if (this.config.clientCredentials.clientAssertion) { const clientAssertion = this.config.clientCredentials.clientAssertion; parameterBuilder.addClientAssertion(await getClientAssertion(clientAssertion.assertion, this.config.authOptions.clientId, request.resourceRequestUri)); parameterBuilder.addClientAssertionType(clientAssertion.assertionType); } if (request.authenticationScheme === AuthenticationScheme.POP) { const popTokenGenerator = new PopTokenGenerator(this.cryptoUtils, this.performanceClient); let reqCnfData; if (!request.popKid) { const generatedReqCnfData = await invokeAsync(popTokenGenerator.generateCnf.bind(popTokenGenerator), PerformanceEvents.PopTokenGenerateCnf, this.logger, this.performanceClient, request.correlationId)(request, this.logger); reqCnfData = generatedReqCnfData.reqCnfString; } else { reqCnfData = this.cryptoUtils.encodeKid(request.popKid); } // SPA PoP requires full Base64Url encoded req_cnf string (unhashed) parameterBuilder.addPopToken(reqCnfData); } else if (request.authenticationScheme === AuthenticationScheme.SSH) { if (request.sshJwk) { parameterBuilder.addSshJwk(request.sshJwk); } else { throw createClientConfigurationError(missingSshJwk); } } if (!StringUtils.isEmptyObj(request.claims) || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } if (this.config.systemOptions.preventCorsPreflight && request.ccsCredential) { switch (request.ccsCredential.type) { case CcsCredentialType.HOME_ACCOUNT_ID: try { const clientInfo = buildClientInfoFromHomeAccountId(request.ccsCredential.credential); parameterBuilder.addCcsOid(clientInfo); } catch (e) { this.logger.verbose("Could not parse home account ID for CCS Header: " + e); } break; case CcsCredentialType.UPN: parameterBuilder.addCcsUpn(request.ccsCredential.credential); break; } } if (request.embeddedClientId) { parameterBuilder.addBrokerParameters({ brokerClientId: this.config.authOptions.clientId, brokerRedirectUri: this.config.authOptions.redirectUri, }); } if (request.tokenBodyParameters) { parameterBuilder.addExtraQueryParameters(request.tokenBodyParameters); } return parameterBuilder.createQueryString(); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** @internal */ class SilentFlowClient extends BaseClient { constructor(configuration, performanceClient) { super(configuration, performanceClient); } /** * Retrieves a token from cache if it is still valid, or uses the cached refresh token to renew * the given token and returns the renewed token * @param request */ async acquireToken(request) { try { const [authResponse, cacheOutcome] = await this.acquireCachedToken({ ...request, scopes: request.scopes?.length ? request.scopes : [...OIDC_DEFAULT_SCOPES], }); // if the token is not expired but must be refreshed; get a new one in the background if (cacheOutcome === CacheOutcome.PROACTIVELY_REFRESHED) { this.logger.info("SilentFlowClient:acquireCachedToken - Cached access token's refreshOn property has been exceeded'. It's not expired, but must be refreshed."); // refresh the access token in the background const refreshTokenClient = new RefreshTokenClient(this.config, this.performanceClient); refreshTokenClient .acquireTokenByRefreshToken(request) .catch(() => { // do nothing, this is running in the background and no action is to be taken upon success or failure }); } // return the cached token return authResponse; } catch (e) { if (e instanceof ClientAuthError && e.errorCode === tokenRefreshRequired) { const refreshTokenClient = new RefreshTokenClient(this.config, this.performanceClient); return refreshTokenClient.acquireTokenByRefreshToken(request); } else { throw e; } } } /** * Retrieves token from cache or throws an error if it must be refreshed. * @param request */ async acquireCachedToken(request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.SilentFlowClientAcquireCachedToken, request.correlationId); let lastCacheOutcome = CacheOutcome.NOT_APPLICABLE; if (request.forceRefresh || (!this.config.cacheOptions.claimsBasedCachingEnabled && !StringUtils.isEmptyObj(request.claims))) { // Must refresh due to present force_refresh flag. this.setCacheOutcome(CacheOutcome.FORCE_REFRESH_OR_CLAIMS, request.correlationId); throw createClientAuthError(tokenRefreshRequired); } // We currently do not support silent flow for account === null use cases; This will be revisited for confidential flow usecases if (!request.account) { throw createClientAuthError(noAccountInSilentRequest); } const requestTenantId = request.account.tenantId || getTenantFromAuthorityString(request.authority); const tokenKeys = this.cacheManager.getTokenKeys(); const cachedAccessToken = this.cacheManager.getAccessToken(request.account, request, tokenKeys, requestTenantId, this.performanceClient, request.correlationId); if (!cachedAccessToken) { // must refresh due to non-existent access_token this.setCacheOutcome(CacheOutcome.NO_CACHED_ACCESS_TOKEN, request.correlationId); throw createClientAuthError(tokenRefreshRequired); } else if (wasClockTurnedBack(cachedAccessToken.cachedAt) || isTokenExpired(cachedAccessToken.expiresOn, this.config.systemOptions.tokenRenewalOffsetSeconds)) { // must refresh due to the expires_in value this.setCacheOutcome(CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED, request.correlationId); throw createClientAuthError(tokenRefreshRequired); } else if (cachedAccessToken.refreshOn && isTokenExpired(cachedAccessToken.refreshOn, 0)) { // must refresh (in the background) due to the refresh_in value lastCacheOutcome = CacheOutcome.PROACTIVELY_REFRESHED; // don't throw ClientAuthError.createRefreshRequiredError(), return cached token instead } const environment = request.authority || this.authority.getPreferredCache(); const cacheRecord = { account: this.cacheManager.readAccountFromCache(request.account), accessToken: cachedAccessToken, idToken: this.cacheManager.getIdToken(request.account, tokenKeys, requestTenantId, this.performanceClient, request.correlationId), refreshToken: null, appMetadata: this.cacheManager.readAppMetadataFromCache(environment), }; this.setCacheOutcome(lastCacheOutcome, request.correlationId); if (this.config.serverTelemetryManager) { this.config.serverTelemetryManager.incrementCacheHits(); } return [ await invokeAsync(this.generateResultFromCacheRecord.bind(this), PerformanceEvents.SilentFlowClientGenerateResultFromCacheRecord, this.logger, this.performanceClient, request.correlationId)(cacheRecord, request), lastCacheOutcome, ]; } setCacheOutcome(cacheOutcome, correlationId) { this.serverTelemetryManager?.setCacheOutcome(cacheOutcome); this.performanceClient?.addFields({ cacheOutcome: cacheOutcome, }, correlationId); if (cacheOutcome !== CacheOutcome.NOT_APPLICABLE) { this.logger.info(`Token refresh is required due to cache outcome: ${cacheOutcome}`); } } /** * Helper function to build response object from the CacheRecord * @param cacheRecord */ async generateResultFromCacheRecord(cacheRecord, request) { this.performanceClient?.addQueueMeasurement(PerformanceEvents.SilentFlowClientGenerateResultFromCacheRecord, request.correlationId); let idTokenClaims; if (cacheRecord.idToken) { idTokenClaims = extractTokenClaims(cacheRecord.idToken.secret, this.config.cryptoInterface.base64Decode); } // token max_age check if (request.maxAge || request.maxAge === 0) { const authTime = idTokenClaims?.auth_time; if (!authTime) { throw createClientAuthError(authTimeNotFound); } checkMaxAge(authTime, request.maxAge); } return ResponseHandler.generateAuthenticationResult(this.cryptoUtils, this.authority, cacheRecord, true, request, idTokenClaims); } } /*! @azure/msal-common v14.16.0 2024-11-19 */ /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const skuGroupSeparator = ","; const skuValueSeparator = "|"; function makeExtraSkuString(params) { const { skus, libraryName, libraryVersion, extensionName, extensionVersion, } = params; const skuMap = new Map([ [0, [libraryName, libraryVersion]], [2, [extensionName, extensionVersion]], ]); let skuArr = []; if (skus?.length) { skuArr = skus.split(skuGroupSeparator); // Ignore invalid input sku param if (skuArr.length < 4) { return skus; } } else { skuArr = Array.from({ length: 4 }, () => skuValueSeparator); } skuMap.forEach((value, key) => { if (value.length === 2 && value[0]?.length && value[1]?.length) { setSku({ skuArr, index: key, skuName: value[0], skuVersion: value[1], }); } }); return skuArr.join(skuGroupSeparator); } function setSku(params) { const { skuArr, index, skuName, skuVersion } = params; if (index >= skuArr.length) { return; } skuArr[index] = [skuName, skuVersion].join(skuValueSeparator); } /** @internal */ class ServerTelemetryManager { constructor(telemetryRequest, cacheManager) { this.cacheOutcome = CacheOutcome.NOT_APPLICABLE; this.cacheManager = cacheManager; this.apiId = telemetryRequest.apiId; this.correlationId = telemetryRequest.correlationId; this.wrapperSKU = telemetryRequest.wrapperSKU || Constants$1.EMPTY_STRING; this.wrapperVer = telemetryRequest.wrapperVer || Constants$1.EMPTY_STRING; this.telemetryCacheKey = SERVER_TELEM_CONSTANTS.CACHE_KEY + Separators.CACHE_KEY_SEPARATOR + telemetryRequest.clientId; } /** * API to add MSER Telemetry to request */ generateCurrentRequestHeaderValue() { const request = `${this.apiId}${SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR}${this.cacheOutcome}`; const platformFieldsArr = [this.wrapperSKU, this.wrapperVer]; const nativeBrokerErrorCode = this.getNativeBrokerErrorCode(); if (nativeBrokerErrorCode?.length) { platformFieldsArr.push(`broker_error=${nativeBrokerErrorCode}`); } const platformFields = platformFieldsArr.join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR); const regionDiscoveryFields = this.getRegionDiscoveryFields(); const requestWithRegionDiscoveryFields = [ request, regionDiscoveryFields, ].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR); return [ SERVER_TELEM_CONSTANTS.SCHEMA_VERSION, requestWithRegionDiscoveryFields, platformFields, ].join(SERVER_TELEM_CONSTANTS.CATEGORY_SEPARATOR); } /** * API to add MSER Telemetry for the last failed request */ generateLastRequestHeaderValue() { const lastRequests = this.getLastRequests(); const maxErrors = ServerTelemetryManager.maxErrorsToSend(lastRequests); const failedRequests = lastRequests.failedRequests .slice(0, 2 * maxErrors) .join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR); const errors = lastRequests.errors .slice(0, maxErrors) .join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR); const errorCount = lastRequests.errors.length; // Indicate whether this header contains all data or partial data const overflow = maxErrors < errorCount ? SERVER_TELEM_CONSTANTS.OVERFLOW_TRUE : SERVER_TELEM_CONSTANTS.OVERFLOW_FALSE; const platformFields = [errorCount, overflow].join(SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR); return [ SERVER_TELEM_CONSTANTS.SCHEMA_VERSION, lastRequests.cacheHits, failedRequests, errors, platformFields, ].join(SERVER_TELEM_CONSTANTS.CATEGORY_SEPARATOR); } /** * API to cache token failures for MSER data capture * @param error */ cacheFailedRequest(error) { const lastRequests = this.getLastRequests(); if (lastRequests.errors.length >= SERVER_TELEM_CONSTANTS.MAX_CACHED_ERRORS) { // Remove a cached error to make room, first in first out lastRequests.failedRequests.shift(); // apiId lastRequests.failedRequests.shift(); // correlationId lastRequests.errors.shift(); } lastRequests.failedRequests.push(this.apiId, this.correlationId); if (error instanceof Error && !!error && error.toString()) { if (error instanceof AuthError) { if (error.subError) { lastRequests.errors.push(error.subError); } else if (error.errorCode) { lastRequests.errors.push(error.errorCode); } else { lastRequests.errors.push(error.toString()); } } else { lastRequests.errors.push(error.toString()); } } else { lastRequests.errors.push(SERVER_TELEM_CONSTANTS.UNKNOWN_ERROR); } this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests); return; } /** * Update server telemetry cache entry by incrementing cache hit counter */ incrementCacheHits() { const lastRequests = this.getLastRequests(); lastRequests.cacheHits += 1; this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests); return lastRequests.cacheHits; } /** * Get the server telemetry entity from cache or initialize a new one */ getLastRequests() { const initialValue = { failedRequests: [], errors: [], cacheHits: 0, }; const lastRequests = this.cacheManager.getServerTelemetry(this.telemetryCacheKey); return lastRequests || initialValue; } /** * Remove server telemetry cache entry */ clearTelemetryCache() { const lastRequests = this.getLastRequests(); const numErrorsFlushed = ServerTelemetryManager.maxErrorsToSend(lastRequests); const errorCount = lastRequests.errors.length; if (numErrorsFlushed === errorCount) { // All errors were sent on last request, clear Telemetry cache this.cacheManager.removeItem(this.telemetryCacheKey); } else { // Partial data was flushed to server, construct a new telemetry cache item with errors that were not flushed const serverTelemEntity = { failedRequests: lastRequests.failedRequests.slice(numErrorsFlushed * 2), errors: lastRequests.errors.slice(numErrorsFlushed), cacheHits: 0, }; this.cacheManager.setServerTelemetry(this.telemetryCacheKey, serverTelemEntity); } } /** * Returns the maximum number of errors that can be flushed to the server in the next network request * @param serverTelemetryEntity */ static maxErrorsToSend(serverTelemetryEntity) { let i; let maxErrors = 0; let dataSize = 0; const errorCount = serverTelemetryEntity.errors.length; for (i = 0; i < errorCount; i++) { // failedRequests parameter contains pairs of apiId and correlationId, multiply index by 2 to preserve pairs const apiId = serverTelemetryEntity.failedRequests[2 * i] || Constants$1.EMPTY_STRING; const correlationId = serverTelemetryEntity.failedRequests[2 * i + 1] || Constants$1.EMPTY_STRING; const errorCode = serverTelemetryEntity.errors[i] || Constants$1.EMPTY_STRING; // Count number of characters that would be added to header, each character is 1 byte. Add 3 at the end to account for separators dataSize += apiId.toString().length + correlationId.toString().length + errorCode.length + 3; if (dataSize < SERVER_TELEM_CONSTANTS.MAX_LAST_HEADER_BYTES) { // Adding this entry to the header would still keep header size below the limit maxErrors += 1; } else { break; } } return maxErrors; } /** * Get the region discovery fields * * @returns string */ getRegionDiscoveryFields() { const regionDiscoveryFields = []; regionDiscoveryFields.push(this.regionUsed || Constants$1.EMPTY_STRING); regionDiscoveryFields.push(this.regionSource || Constants$1.EMPTY_STRING); regionDiscoveryFields.push(this.regionOutcome || Constants$1.EMPTY_STRING); return regionDiscoveryFields.join(","); } /** * Update the region discovery metadata * * @param regionDiscoveryMetadata * @returns void */ updateRegionDiscoveryMetadata(regionDiscoveryMetadata) { this.regionUsed = regionDiscoveryMetadata.region_used; this.regionSource = regionDiscoveryMetadata.region_source; this.regionOutcome = regionDiscoveryMetadata.region_outcome; } /** * Set cache outcome */ setCacheOutcome(cacheOutcome) { this.cacheOutcome = cacheOutcome; } setNativeBrokerErrorCode(errorCode) { const lastRequests = this.getLastRequests(); lastRequests.nativeBrokerErrorCode = errorCode; this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests); } getNativeBrokerErrorCode() { return this.getLastRequests().nativeBrokerErrorCode; } clearNativeBrokerErrorCode() { const lastRequests = this.getLastRequests(); delete lastRequests.nativeBrokerErrorCode; this.cacheManager.setServerTelemetry(this.telemetryCacheKey, lastRequests); } static makeExtraSkuString(params) { return makeExtraSkuString(params); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class deserializes cache entities read from the file into in-memory object types defined internally * @internal */ class Deserializer { /** * Parse the JSON blob in memory and deserialize the content * @param cachedJson - JSON blob cache */ static deserializeJSONBlob(jsonFile) { const deserializedCache = !jsonFile ? {} : JSON.parse(jsonFile); return deserializedCache; } /** * Deserializes accounts to AccountEntity objects * @param accounts - accounts of type SerializedAccountEntity */ static deserializeAccounts(accounts) { const accountObjects = {}; if (accounts) { Object.keys(accounts).map(function (key) { const serializedAcc = accounts[key]; const mappedAcc = { homeAccountId: serializedAcc.home_account_id, environment: serializedAcc.environment, realm: serializedAcc.realm, localAccountId: serializedAcc.local_account_id, username: serializedAcc.username, authorityType: serializedAcc.authority_type, name: serializedAcc.name, clientInfo: serializedAcc.client_info, lastModificationTime: serializedAcc.last_modification_time, lastModificationApp: serializedAcc.last_modification_app, tenantProfiles: serializedAcc.tenantProfiles?.map((serializedTenantProfile) => { return JSON.parse(serializedTenantProfile); }), }; const account = new AccountEntity(); CacheManager.toObject(account, mappedAcc); accountObjects[key] = account; }); } return accountObjects; } /** * Deserializes id tokens to IdTokenEntity objects * @param idTokens - credentials of type SerializedIdTokenEntity */ static deserializeIdTokens(idTokens) { const idObjects = {}; if (idTokens) { Object.keys(idTokens).map(function (key) { const serializedIdT = idTokens[key]; const idToken = { homeAccountId: serializedIdT.home_account_id, environment: serializedIdT.environment, credentialType: serializedIdT.credential_type, clientId: serializedIdT.client_id, secret: serializedIdT.secret, realm: serializedIdT.realm, }; idObjects[key] = idToken; }); } return idObjects; } /** * Deserializes access tokens to AccessTokenEntity objects * @param accessTokens - access tokens of type SerializedAccessTokenEntity */ static deserializeAccessTokens(accessTokens) { const atObjects = {}; if (accessTokens) { Object.keys(accessTokens).map(function (key) { const serializedAT = accessTokens[key]; const accessToken = { homeAccountId: serializedAT.home_account_id, environment: serializedAT.environment, credentialType: serializedAT.credential_type, clientId: serializedAT.client_id, secret: serializedAT.secret, realm: serializedAT.realm, target: serializedAT.target, cachedAt: serializedAT.cached_at, expiresOn: serializedAT.expires_on, extendedExpiresOn: serializedAT.extended_expires_on, refreshOn: serializedAT.refresh_on, keyId: serializedAT.key_id, tokenType: serializedAT.token_type, requestedClaims: serializedAT.requestedClaims, requestedClaimsHash: serializedAT.requestedClaimsHash, userAssertionHash: serializedAT.userAssertionHash, }; atObjects[key] = accessToken; }); } return atObjects; } /** * Deserializes refresh tokens to RefreshTokenEntity objects * @param refreshTokens - refresh tokens of type SerializedRefreshTokenEntity */ static deserializeRefreshTokens(refreshTokens) { const rtObjects = {}; if (refreshTokens) { Object.keys(refreshTokens).map(function (key) { const serializedRT = refreshTokens[key]; const refreshToken = { homeAccountId: serializedRT.home_account_id, environment: serializedRT.environment, credentialType: serializedRT.credential_type, clientId: serializedRT.client_id, secret: serializedRT.secret, familyId: serializedRT.family_id, target: serializedRT.target, realm: serializedRT.realm, }; rtObjects[key] = refreshToken; }); } return rtObjects; } /** * Deserializes appMetadata to AppMetaData objects * @param appMetadata - app metadata of type SerializedAppMetadataEntity */ static deserializeAppMetadata(appMetadata) { const appMetadataObjects = {}; if (appMetadata) { Object.keys(appMetadata).map(function (key) { const serializedAmdt = appMetadata[key]; appMetadataObjects[key] = { clientId: serializedAmdt.client_id, environment: serializedAmdt.environment, familyId: serializedAmdt.family_id, }; }); } return appMetadataObjects; } /** * Deserialize an inMemory Cache * @param jsonCache - JSON blob cache */ static deserializeAllCache(jsonCache) { return { accounts: jsonCache.Account ? this.deserializeAccounts(jsonCache.Account) : {}, idTokens: jsonCache.IdToken ? this.deserializeIdTokens(jsonCache.IdToken) : {}, accessTokens: jsonCache.AccessToken ? this.deserializeAccessTokens(jsonCache.AccessToken) : {}, refreshTokens: jsonCache.RefreshToken ? this.deserializeRefreshTokens(jsonCache.RefreshToken) : {}, appMetadata: jsonCache.AppMetadata ? this.deserializeAppMetadata(jsonCache.AppMetadata) : {}, }; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Warning: This set of exports is purely intended to be used by other MSAL libraries, and should be considered potentially unstable. We strongly discourage using them directly, you do so at your own risk. * Breaking changes to these APIs will be shipped under a minor version, instead of a major version. */ var internals = /*#__PURE__*/Object.freeze({ __proto__: null, Deserializer: Deserializer, Serializer: Serializer }); /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ // MSI Constants. Docs for MSI are available here https://docs.microsoft.com/azure/app-service/overview-managed-identity const AUTHORIZATION_HEADER_NAME = "Authorization"; const METADATA_HEADER_NAME = "Metadata"; const APP_SERVICE_SECRET_HEADER_NAME = "X-IDENTITY-HEADER"; const SERVICE_FABRIC_SECRET_HEADER_NAME = "secret"; const API_VERSION_QUERY_PARAMETER_NAME = "api-version"; const RESOURCE_BODY_OR_QUERY_PARAMETER_NAME = "resource"; const DEFAULT_MANAGED_IDENTITY_ID = "system_assigned_managed_identity"; const MANAGED_IDENTITY_DEFAULT_TENANT = "managed_identity"; const DEFAULT_AUTHORITY_FOR_MANAGED_IDENTITY = `https://login.microsoftonline.com/${MANAGED_IDENTITY_DEFAULT_TENANT}/`; /** * Managed Identity Environment Variable Names */ const ManagedIdentityEnvironmentVariableNames = { AZURE_POD_IDENTITY_AUTHORITY_HOST: "AZURE_POD_IDENTITY_AUTHORITY_HOST", IDENTITY_ENDPOINT: "IDENTITY_ENDPOINT", IDENTITY_HEADER: "IDENTITY_HEADER", IDENTITY_SERVER_THUMBPRINT: "IDENTITY_SERVER_THUMBPRINT", IMDS_ENDPOINT: "IMDS_ENDPOINT", MSI_ENDPOINT: "MSI_ENDPOINT", }; /** * Managed Identity Source Names * @public */ const ManagedIdentitySourceNames = { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", SERVICE_FABRIC: "ServiceFabric", }; /** * Managed Identity Ids */ const ManagedIdentityIdType = { SYSTEM_ASSIGNED: "system-assigned", USER_ASSIGNED_CLIENT_ID: "user-assigned-client-id", USER_ASSIGNED_RESOURCE_ID: "user-assigned-resource-id", USER_ASSIGNED_OBJECT_ID: "user-assigned-object-id", }; /** * http methods */ const HttpMethod = { GET: "get", POST: "post", }; const ProxyStatus = { SUCCESS: HttpStatus.SUCCESS, SUCCESS_RANGE_START: HttpStatus.SUCCESS_RANGE_START, SUCCESS_RANGE_END: HttpStatus.SUCCESS_RANGE_END, SERVER_ERROR: HttpStatus.SERVER_ERROR, }; /** * Constants used for region discovery */ const REGION_ENVIRONMENT_VARIABLE = "REGION_NAME"; const MSAL_FORCE_REGION = "MSAL_FORCE_REGION"; /** * Constant used for PKCE */ const RANDOM_OCTET_SIZE = 32; /** * Constants used in PKCE */ const Hash = { SHA256: "sha256", }; /** * Constants for encoding schemes */ const CharSet = { CV_CHARSET: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~", }; /** * Constants */ const Constants = { MSAL_SKU: "msal.js.node", JWT_BEARER_ASSERTION_TYPE: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer", AUTHORIZATION_PENDING: "authorization_pending", HTTP_PROTOCOL: "http://", LOCALHOST: "localhost", }; /** * API Codes for Telemetry purposes. * Before adding a new code you must claim it in the MSAL Telemetry tracker as these number spaces are shared across all MSALs * 0-99 Silent Flow * 600-699 Device Code Flow * 800-899 Auth Code Flow */ const ApiId = { acquireTokenSilent: 62, acquireTokenByUsernamePassword: 371, acquireTokenByDeviceCode: 671, acquireTokenByClientCredential: 771, acquireTokenByCode: 871, acquireTokenByRefreshToken: 872, }; /** * JWT constants */ const JwtConstants = { ALGORITHM: "alg", RSA_256: "RS256", PSS_256: "PS256", X5T_256: "x5t#S256", X5T: "x5t", X5C: "x5c", AUDIENCE: "aud", EXPIRATION_TIME: "exp", ISSUER: "iss", SUBJECT: "sub", NOT_BEFORE: "nbf", JWT_ID: "jti", }; const LOOPBACK_SERVER_CONSTANTS = { INTERVAL_MS: 100, TIMEOUT_MS: 5000, }; const AZURE_ARC_SECRET_FILE_MAX_SIZE_BYTES = 4096; // 4 KB const MANAGED_IDENTITY_MAX_RETRIES = 3; const MANAGED_IDENTITY_RETRY_DELAY = 1000; const MANAGED_IDENTITY_HTTP_STATUS_CODES_TO_RETRY_ON = [ HttpStatus.NOT_FOUND, HttpStatus.REQUEST_TIMEOUT, HttpStatus.TOO_MANY_REQUESTS, HttpStatus.SERVER_ERROR, HttpStatus.SERVICE_UNAVAILABLE, HttpStatus.GATEWAY_TIMEOUT, ]; /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class NetworkUtils { static getNetworkResponse(headers, body, statusCode) { return { headers: headers, body: body, status: statusCode, }; } /* * Utility function that converts a URL object into an ordinary options object as expected by the * http.request and https.request APIs. * https://github.com/nodejs/node/blob/main/lib/internal/url.js#L1090 */ static urlToHttpOptions(url) { const options = { protocol: url.protocol, hostname: url.hostname && url.hostname.startsWith("[") ? url.hostname.slice(1, -1) : url.hostname, hash: url.hash, search: url.search, pathname: url.pathname, path: `${url.pathname || ""}${url.search || ""}`, href: url.href, }; if (url.port !== "") { options.port = Number(url.port); } if (url.username || url.password) { options.auth = `${decodeURIComponent(url.username)}:${decodeURIComponent(url.password)}`; } return options; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class implements the API for network requests. */ class HttpClient { constructor(proxyUrl, customAgentOptions) { this.proxyUrl = proxyUrl || ""; this.customAgentOptions = customAgentOptions || {}; } /** * Http Get request * @param url * @param options */ async sendGetRequestAsync(url, options, timeout) { if (this.proxyUrl) { return networkRequestViaProxy(url, this.proxyUrl, HttpMethod.GET, options, this.customAgentOptions, timeout); } else { return networkRequestViaHttps(url, HttpMethod.GET, options, this.customAgentOptions, timeout); } } /** * Http Post request * @param url * @param options */ async sendPostRequestAsync(url, options) { if (this.proxyUrl) { return networkRequestViaProxy(url, this.proxyUrl, HttpMethod.POST, options, this.customAgentOptions); } else { return networkRequestViaHttps(url, HttpMethod.POST, options, this.customAgentOptions); } } } const networkRequestViaProxy = (destinationUrlString, proxyUrlString, httpMethod, options, agentOptions, timeout) => { const destinationUrl = new URL(destinationUrlString); const proxyUrl = new URL(proxyUrlString); // "method: connect" must be used to establish a connection to the proxy const headers = options?.headers || {}; const tunnelRequestOptions = { host: proxyUrl.hostname, port: proxyUrl.port, method: "CONNECT", path: destinationUrl.hostname, headers: headers, }; if (agentOptions && Object.keys(agentOptions).length) { tunnelRequestOptions.agent = new http.Agent(agentOptions); } // compose a request string for the socket let postRequestStringContent = ""; if (httpMethod === HttpMethod.POST) { const body = options?.body || ""; postRequestStringContent = "Content-Type: application/x-www-form-urlencoded\r\n" + `Content-Length: ${body.length}\r\n` + `\r\n${body}`; } else { // optional timeout is only for get requests (regionDiscovery, for example) if (timeout) { tunnelRequestOptions.timeout = timeout; } } const outgoingRequestString = `${httpMethod.toUpperCase()} ${destinationUrl.href} HTTP/1.1\r\n` + `Host: ${destinationUrl.host}\r\n` + "Connection: close\r\n" + postRequestStringContent + "\r\n"; return new Promise((resolve, reject) => { const request = http.request(tunnelRequestOptions); if (timeout) { request.on("timeout", () => { request.destroy(); reject(new Error("Request time out")); }); } request.end(); // establish connection to the proxy request.on("connect", (response, socket) => { const proxyStatusCode = response?.statusCode || ProxyStatus.SERVER_ERROR; if (proxyStatusCode < ProxyStatus.SUCCESS_RANGE_START || proxyStatusCode > ProxyStatus.SUCCESS_RANGE_END) { request.destroy(); socket.destroy(); reject(new Error(`Error connecting to proxy. Http status code: ${response.statusCode}. Http status message: ${response?.statusMessage || "Unknown"}`)); } // make a request over an HTTP tunnel socket.write(outgoingRequestString); const data = []; socket.on("data", (chunk) => { data.push(chunk); }); socket.on("end", () => { // combine all received buffer streams into one buffer, and then into a string const dataString = Buffer.concat([...data]).toString(); // separate each line into it's own entry in an arry const dataStringArray = dataString.split("\r\n"); // the first entry will contain the statusCode and statusMessage const httpStatusCode = parseInt(dataStringArray[0].split(" ")[1]); // remove "HTTP/1.1" and the status code to get the status message const statusMessage = dataStringArray[0] .split(" ") .slice(2) .join(" "); // the last entry will contain the body const body = dataStringArray[dataStringArray.length - 1]; // everything in between the first and last entries are the headers const headersArray = dataStringArray.slice(1, dataStringArray.length - 2); // build an object out of all the headers const entries = new Map(); headersArray.forEach((header) => { /** * the header might look like "Content-Length: 1531", but that is just a string * it needs to be converted to a key/value pair * split the string at the first instance of ":" * there may be more than one ":" if the value of the header is supposed to be a JSON object */ const headerKeyValue = header.split(new RegExp(/:\s(.*)/s)); const headerKey = headerKeyValue[0]; let headerValue = headerKeyValue[1]; // check if the value of the header is supposed to be a JSON object try { const object = JSON.parse(headerValue); // if it is, then convert it from a string to a JSON object if (object && typeof object === "object") { headerValue = object; } } catch (e) { // otherwise, leave it as a string } entries.set(headerKey, headerValue); }); const headers = Object.fromEntries(entries); const parsedHeaders = headers; const networkResponse = NetworkUtils.getNetworkResponse(parsedHeaders, parseBody(httpStatusCode, statusMessage, parsedHeaders, body), httpStatusCode); if ((httpStatusCode < HttpStatus.SUCCESS_RANGE_START || httpStatusCode > HttpStatus.SUCCESS_RANGE_END) && // do not destroy the request for the device code flow networkResponse.body["error"] !== Constants.AUTHORIZATION_PENDING) { request.destroy(); } resolve(networkResponse); }); socket.on("error", (chunk) => { request.destroy(); socket.destroy(); reject(new Error(chunk.toString())); }); }); request.on("error", (chunk) => { request.destroy(); reject(new Error(chunk.toString())); }); }); }; const networkRequestViaHttps = (urlString, httpMethod, options, agentOptions, timeout) => { const isPostRequest = httpMethod === HttpMethod.POST; const body = options?.body || ""; const url = new URL(urlString); const headers = options?.headers || {}; const customOptions = { method: httpMethod, headers: headers, ...NetworkUtils.urlToHttpOptions(url), }; if (agentOptions && Object.keys(agentOptions).length) { customOptions.agent = new https.Agent(agentOptions); } if (isPostRequest) { // needed for post request to work customOptions.headers = { ...customOptions.headers, "Content-Length": body.length, }; } else { // optional timeout is only for get requests (regionDiscovery, for example) if (timeout) { customOptions.timeout = timeout; } } return new Promise((resolve, reject) => { let request; // managed identity sources use http instead of https if (customOptions.protocol === "http:") { request = http.request(customOptions); } else { request = https.request(customOptions); } if (isPostRequest) { request.write(body); } if (timeout) { request.on("timeout", () => { request.destroy(); reject(new Error("Request time out")); }); } request.end(); request.on("response", (response) => { const headers = response.headers; const statusCode = response.statusCode; const statusMessage = response.statusMessage; const data = []; response.on("data", (chunk) => { data.push(chunk); }); response.on("end", () => { // combine all received buffer streams into one buffer, and then into a string const body = Buffer.concat([...data]).toString(); const parsedHeaders = headers; const networkResponse = NetworkUtils.getNetworkResponse(parsedHeaders, parseBody(statusCode, statusMessage, parsedHeaders, body), statusCode); if ((statusCode < HttpStatus.SUCCESS_RANGE_START || statusCode > HttpStatus.SUCCESS_RANGE_END) && // do not destroy the request for the device code flow networkResponse.body["error"] !== Constants.AUTHORIZATION_PENDING) { request.destroy(); } resolve(networkResponse); }); }); request.on("error", (chunk) => { request.destroy(); reject(new Error(chunk.toString())); }); }); }; /** * Check if extra parsing is needed on the repsonse from the server * @param statusCode {number} the status code of the response from the server * @param statusMessage {string | undefined} the status message of the response from the server * @param headers {Record} the headers of the response from the server * @param body {string} the body from the response of the server * @returns {Object} JSON parsed body or error object */ const parseBody = (statusCode, statusMessage, headers, body) => { /* * Informational responses (100 – 199) * Successful responses (200 – 299) * Redirection messages (300 – 399) * Client error responses (400 – 499) * Server error responses (500 – 599) */ let parsedBody; try { parsedBody = JSON.parse(body); } catch (error) { let errorType; let errorDescriptionHelper; if (statusCode >= HttpStatus.CLIENT_ERROR_RANGE_START && statusCode <= HttpStatus.CLIENT_ERROR_RANGE_END) { errorType = "client_error"; errorDescriptionHelper = "A client"; } else if (statusCode >= HttpStatus.SERVER_ERROR_RANGE_START && statusCode <= HttpStatus.SERVER_ERROR_RANGE_END) { errorType = "server_error"; errorDescriptionHelper = "A server"; } else { errorType = "unknown_error"; errorDescriptionHelper = "An unknown"; } parsedBody = { error: errorType, error_description: `${errorDescriptionHelper} error occured.\nHttp status code: ${statusCode}\nHttp status message: ${statusMessage || "Unknown"}\nHeaders: ${JSON.stringify(headers)}`, }; } return parsedBody; }; /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const invalidFileExtension = "invalid_file_extension"; const invalidFilePath = "invalid_file_path"; const invalidManagedIdentityIdType = "invalid_managed_identity_id_type"; const invalidSecret = "invalid_secret"; const missingId = "missing_client_id"; const networkUnavailable = "network_unavailable"; const platformNotSupported = "platform_not_supported"; const unableToCreateAzureArc = "unable_to_create_azure_arc"; const unableToCreateCloudShell = "unable_to_create_cloud_shell"; const unableToCreateSource = "unable_to_create_source"; const unableToReadSecretFile = "unable_to_read_secret_file"; const userAssignedNotAvailableAtRuntime = "user_assigned_not_available_at_runtime"; const wwwAuthenticateHeaderMissing = "www_authenticate_header_missing"; const wwwAuthenticateHeaderUnsupportedFormat = "www_authenticate_header_unsupported_format"; const MsiEnvironmentVariableUrlMalformedErrorCodes = { [ManagedIdentityEnvironmentVariableNames.AZURE_POD_IDENTITY_AUTHORITY_HOST]: "azure_pod_identity_authority_host_url_malformed", [ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT]: "identity_endpoint_url_malformed", [ManagedIdentityEnvironmentVariableNames.IMDS_ENDPOINT]: "imds_endpoint_url_malformed", [ManagedIdentityEnvironmentVariableNames.MSI_ENDPOINT]: "msi_endpoint_url_malformed", }; /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * ManagedIdentityErrorMessage class containing string constants used by error codes and messages. */ const ManagedIdentityErrorMessages = { [invalidFileExtension]: "The file path in the WWW-Authenticate header does not contain a .key file.", [invalidFilePath]: "The file path in the WWW-Authenticate header is not in a valid Windows or Linux Format.", [invalidManagedIdentityIdType]: "More than one ManagedIdentityIdType was provided.", [invalidSecret]: "The secret in the file on the file path in the WWW-Authenticate header is greater than 4096 bytes.", [platformNotSupported]: "The platform is not supported by Azure Arc. Azure Arc only supports Windows and Linux.", [missingId]: "A ManagedIdentityId id was not provided.", [MsiEnvironmentVariableUrlMalformedErrorCodes .AZURE_POD_IDENTITY_AUTHORITY_HOST]: `The Managed Identity's '${ManagedIdentityEnvironmentVariableNames.AZURE_POD_IDENTITY_AUTHORITY_HOST}' environment variable is malformed.`, [MsiEnvironmentVariableUrlMalformedErrorCodes .IDENTITY_ENDPOINT]: `The Managed Identity's '${ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT}' environment variable is malformed.`, [MsiEnvironmentVariableUrlMalformedErrorCodes .IMDS_ENDPOINT]: `The Managed Identity's '${ManagedIdentityEnvironmentVariableNames.IMDS_ENDPOINT}' environment variable is malformed.`, [MsiEnvironmentVariableUrlMalformedErrorCodes .MSI_ENDPOINT]: `The Managed Identity's '${ManagedIdentityEnvironmentVariableNames.MSI_ENDPOINT}' environment variable is malformed.`, [networkUnavailable]: "Authentication unavailable. The request to the managed identity endpoint timed out.", [unableToCreateAzureArc]: "Azure Arc Managed Identities can only be system assigned.", [unableToCreateCloudShell]: "Cloud Shell Managed Identities can only be system assigned.", [unableToCreateSource]: "Unable to create a Managed Identity source based on environment variables.", [unableToReadSecretFile]: "Unable to read the secret file.", [userAssignedNotAvailableAtRuntime]: "Service Fabric user assigned managed identity ClientId or ResourceId is not configurable at runtime.", [wwwAuthenticateHeaderMissing]: "A 401 response was received form the Azure Arc Managed Identity, but the www-authenticate header is missing.", [wwwAuthenticateHeaderUnsupportedFormat]: "A 401 response was received form the Azure Arc Managed Identity, but the www-authenticate header is in an unsupported format.", }; class ManagedIdentityError extends AuthError { constructor(errorCode) { super(errorCode, ManagedIdentityErrorMessages[errorCode]); this.name = "ManagedIdentityError"; Object.setPrototypeOf(this, ManagedIdentityError.prototype); } } function createManagedIdentityError(errorCode) { return new ManagedIdentityError(errorCode); } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class ManagedIdentityId { get id() { return this._id; } set id(value) { this._id = value; } get idType() { return this._idType; } set idType(value) { this._idType = value; } constructor(managedIdentityIdParams) { const userAssignedClientId = managedIdentityIdParams?.userAssignedClientId; const userAssignedResourceId = managedIdentityIdParams?.userAssignedResourceId; const userAssignedObjectId = managedIdentityIdParams?.userAssignedObjectId; if (userAssignedClientId) { if (userAssignedResourceId || userAssignedObjectId) { throw createManagedIdentityError(invalidManagedIdentityIdType); } this.id = userAssignedClientId; this.idType = ManagedIdentityIdType.USER_ASSIGNED_CLIENT_ID; } else if (userAssignedResourceId) { if (userAssignedClientId || userAssignedObjectId) { throw createManagedIdentityError(invalidManagedIdentityIdType); } this.id = userAssignedResourceId; this.idType = ManagedIdentityIdType.USER_ASSIGNED_RESOURCE_ID; } else if (userAssignedObjectId) { if (userAssignedClientId || userAssignedResourceId) { throw createManagedIdentityError(invalidManagedIdentityIdType); } this.id = userAssignedObjectId; this.idType = ManagedIdentityIdType.USER_ASSIGNED_OBJECT_ID; } else { this.id = DEFAULT_MANAGED_IDENTITY_ID; this.idType = ManagedIdentityIdType.SYSTEM_ASSIGNED; } } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class LinearRetryPolicy { constructor(maxRetries, retryDelay, httpStatusCodesToRetryOn) { this.maxRetries = maxRetries; this.retryDelay = retryDelay; this.httpStatusCodesToRetryOn = httpStatusCodesToRetryOn; } retryAfterMillisecondsToSleep(retryHeader) { if (!retryHeader) { return 0; } // retry-after header is in seconds let millisToSleep = Math.round(parseFloat(retryHeader) * 1000); /* * retry-after header is in HTTP Date format * , :: GMT */ if (isNaN(millisToSleep)) { millisToSleep = Math.max(0, // .valueOf() is needed to subtract dates in TypeScript new Date(retryHeader).valueOf() - new Date().valueOf()); } return millisToSleep; } async pauseForRetry(httpStatusCode, currentRetry, retryAfterHeader) { if (this.httpStatusCodesToRetryOn.includes(httpStatusCode) && currentRetry < this.maxRetries) { const retryAfterDelay = this.retryAfterMillisecondsToSleep(retryAfterHeader); await new Promise((resolve) => { // retryAfterHeader value of 0 evaluates to false, and this.retryDelay will be used return setTimeout(resolve, retryAfterDelay || this.retryDelay); }); return true; } return false; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class HttpClientWithRetries { constructor(httpClientNoRetries, retryPolicy) { this.httpClientNoRetries = httpClientNoRetries; this.retryPolicy = retryPolicy; } async sendNetworkRequestAsyncHelper(httpMethod, url, options) { if (httpMethod === HttpMethod.GET) { return this.httpClientNoRetries.sendGetRequestAsync(url, options); } else { return this.httpClientNoRetries.sendPostRequestAsync(url, options); } } async sendNetworkRequestAsync(httpMethod, url, options) { // the underlying network module (custom or HttpClient) will make the call let response = await this.sendNetworkRequestAsyncHelper(httpMethod, url, options); let currentRetry = 0; while (await this.retryPolicy.pauseForRetry(response.status, currentRetry, response.headers[HeaderNames.RETRY_AFTER])) { response = await this.sendNetworkRequestAsyncHelper(httpMethod, url, options); currentRetry++; } return response; } async sendGetRequestAsync(url, options) { return this.sendNetworkRequestAsync(HttpMethod.GET, url, options); } async sendPostRequestAsync(url, options) { return this.sendNetworkRequestAsync(HttpMethod.POST, url, options); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * NodeAuthErrorMessage class containing string constants used by error codes and messages. */ const NodeAuthErrorMessage = { invalidLoopbackAddressType: { code: "invalid_loopback_server_address_type", desc: "Loopback server address is not type string. This is unexpected.", }, unableToLoadRedirectUri: { code: "unable_to_load_redirectUrl", desc: "Loopback server callback was invoked without a url. This is unexpected.", }, noAuthCodeInResponse: { code: "no_auth_code_in_response", desc: "No auth code found in the server response. Please check your network trace to determine what happened.", }, noLoopbackServerExists: { code: "no_loopback_server_exists", desc: "No loopback server exists yet.", }, loopbackServerAlreadyExists: { code: "loopback_server_already_exists", desc: "Loopback server already exists. Cannot create another.", }, loopbackServerTimeout: { code: "loopback_server_timeout", desc: "Timed out waiting for auth code listener to be registered.", }, stateNotFoundError: { code: "state_not_found", desc: "State not found. Please verify that the request originated from msal.", }, thumbprintMissing: { code: "thumbprint_missing_from_client_certificate", desc: "Client certificate does not contain a SHA-1 or SHA-256 thumbprint.", }, }; class NodeAuthError extends AuthError { constructor(errorCode, errorMessage) { super(errorCode, errorMessage); this.name = "NodeAuthError"; } /** * Creates an error thrown if loopback server address is of type string. */ static createInvalidLoopbackAddressTypeError() { return new NodeAuthError(NodeAuthErrorMessage.invalidLoopbackAddressType.code, `${NodeAuthErrorMessage.invalidLoopbackAddressType.desc}`); } /** * Creates an error thrown if the loopback server is unable to get a url. */ static createUnableToLoadRedirectUrlError() { return new NodeAuthError(NodeAuthErrorMessage.unableToLoadRedirectUri.code, `${NodeAuthErrorMessage.unableToLoadRedirectUri.desc}`); } /** * Creates an error thrown if the server response does not contain an auth code. */ static createNoAuthCodeInResponseError() { return new NodeAuthError(NodeAuthErrorMessage.noAuthCodeInResponse.code, `${NodeAuthErrorMessage.noAuthCodeInResponse.desc}`); } /** * Creates an error thrown if the loopback server has not been spun up yet. */ static createNoLoopbackServerExistsError() { return new NodeAuthError(NodeAuthErrorMessage.noLoopbackServerExists.code, `${NodeAuthErrorMessage.noLoopbackServerExists.desc}`); } /** * Creates an error thrown if a loopback server already exists when attempting to create another one. */ static createLoopbackServerAlreadyExistsError() { return new NodeAuthError(NodeAuthErrorMessage.loopbackServerAlreadyExists.code, `${NodeAuthErrorMessage.loopbackServerAlreadyExists.desc}`); } /** * Creates an error thrown if the loopback server times out registering the auth code listener. */ static createLoopbackServerTimeoutError() { return new NodeAuthError(NodeAuthErrorMessage.loopbackServerTimeout.code, `${NodeAuthErrorMessage.loopbackServerTimeout.desc}`); } /** * Creates an error thrown when the state is not present. */ static createStateNotFoundError() { return new NodeAuthError(NodeAuthErrorMessage.stateNotFoundError.code, NodeAuthErrorMessage.stateNotFoundError.desc); } /** * Creates an error thrown when client certificate was provided, but neither the SHA-1 or SHA-256 thumbprints were provided */ static createThumbprintMissingError() { return new NodeAuthError(NodeAuthErrorMessage.thumbprintMissing.code, NodeAuthErrorMessage.thumbprintMissing.desc); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const DEFAULT_AUTH_OPTIONS = { clientId: Constants$1.EMPTY_STRING, authority: Constants$1.DEFAULT_AUTHORITY, clientSecret: Constants$1.EMPTY_STRING, clientAssertion: Constants$1.EMPTY_STRING, clientCertificate: { thumbprint: Constants$1.EMPTY_STRING, thumbprintSha256: Constants$1.EMPTY_STRING, privateKey: Constants$1.EMPTY_STRING, x5c: Constants$1.EMPTY_STRING, }, knownAuthorities: [], cloudDiscoveryMetadata: Constants$1.EMPTY_STRING, authorityMetadata: Constants$1.EMPTY_STRING, clientCapabilities: [], protocolMode: ProtocolMode.AAD, azureCloudOptions: { azureCloudInstance: AzureCloudInstance.None, tenant: Constants$1.EMPTY_STRING, }, skipAuthorityMetadataCache: false, }; const DEFAULT_CACHE_OPTIONS = { claimsBasedCachingEnabled: false, }; const DEFAULT_LOGGER_OPTIONS = { loggerCallback: () => { // allow users to not set logger call back }, piiLoggingEnabled: false, logLevel: exports.LogLevel.Info, }; const DEFAULT_SYSTEM_OPTIONS = { loggerOptions: DEFAULT_LOGGER_OPTIONS, networkClient: new HttpClient(), proxyUrl: Constants$1.EMPTY_STRING, customAgentOptions: {}, disableInternalRetries: false, }; const DEFAULT_TELEMETRY_OPTIONS = { application: { appName: Constants$1.EMPTY_STRING, appVersion: Constants$1.EMPTY_STRING, }, }; /** * Sets the default options when not explicitly configured from app developer * * @param auth - Authentication options * @param cache - Cache options * @param system - System options * @param telemetry - Telemetry options * * @returns Configuration * @internal */ function buildAppConfiguration({ auth, broker, cache, system, telemetry, }) { const systemOptions = { ...DEFAULT_SYSTEM_OPTIONS, networkClient: new HttpClient(system?.proxyUrl, system?.customAgentOptions), loggerOptions: system?.loggerOptions || DEFAULT_LOGGER_OPTIONS, disableInternalRetries: system?.disableInternalRetries || false, }; // if client certificate was provided, ensure that at least one of the SHA-1 or SHA-256 thumbprints were provided if (!!auth.clientCertificate && !!!auth.clientCertificate.thumbprint && !!!auth.clientCertificate.thumbprintSha256) { throw NodeAuthError.createStateNotFoundError(); } return { auth: { ...DEFAULT_AUTH_OPTIONS, ...auth }, broker: { ...broker }, cache: { ...DEFAULT_CACHE_OPTIONS, ...cache }, system: { ...systemOptions, ...system }, telemetry: { ...DEFAULT_TELEMETRY_OPTIONS, ...telemetry }, }; } function buildManagedIdentityConfiguration({ managedIdentityIdParams, system, }) { const managedIdentityId = new ManagedIdentityId(managedIdentityIdParams); const loggerOptions = system?.loggerOptions || DEFAULT_LOGGER_OPTIONS; let networkClient; // use developer provided network client if passed in if (system?.networkClient) { networkClient = system.networkClient; // otherwise, create a new one } else { networkClient = new HttpClient(system?.proxyUrl, system?.customAgentOptions); } // wrap the network client with a retry policy if the developer has not disabled the option to do so if (!system?.disableInternalRetries) { const linearRetryPolicy = new LinearRetryPolicy(MANAGED_IDENTITY_MAX_RETRIES, MANAGED_IDENTITY_RETRY_DELAY, MANAGED_IDENTITY_HTTP_STATUS_CODES_TO_RETRY_ON); networkClient = new HttpClientWithRetries(networkClient, linearRetryPolicy); } return { managedIdentityId: managedIdentityId, system: { loggerOptions, networkClient, }, }; } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class GuidGenerator { /** * * RFC4122: The version 4 UUID is meant for generating UUIDs from truly-random or pseudo-random numbers. * uuidv4 generates guids from cryprtographically-string random */ generateGuid() { return uuid.v4(); } /** * verifies if a string is GUID * @param guid */ isGuid(guid) { const regexGuid = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i; return regexGuid.test(guid); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class EncodingUtils { /** * 'utf8': Multibyte encoded Unicode characters. Many web pages and other document formats use UTF-8. * 'base64': Base64 encoding. * * @param str text */ static base64Encode(str, encoding) { return Buffer.from(str, encoding).toString("base64"); } /** * encode a URL * @param str */ static base64EncodeUrl(str, encoding) { return EncodingUtils.base64Encode(str, encoding) .replace(/=/g, Constants$1.EMPTY_STRING) .replace(/\+/g, "-") .replace(/\//g, "_"); } /** * 'utf8': Multibyte encoded Unicode characters. Many web pages and other document formats use UTF-8. * 'base64': Base64 encoding. * * @param base64Str Base64 encoded text */ static base64Decode(base64Str) { return Buffer.from(base64Str, "base64").toString("utf8"); } /** * @param base64Str Base64 encoded Url */ static base64DecodeUrl(base64Str) { let str = base64Str.replace(/-/g, "+").replace(/_/g, "/"); while (str.length % 4) { str += "="; } return EncodingUtils.base64Decode(str); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class HashUtils { /** * generate 'SHA256' hash * @param buffer */ sha256(buffer) { return crypto.createHash(Hash.SHA256).update(buffer).digest(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * https://tools.ietf.org/html/rfc7636#page-8 */ class PkceGenerator { constructor() { this.hashUtils = new HashUtils(); } /** * generates the codeVerfier and the challenge from the codeVerfier * reference: https://tools.ietf.org/html/rfc7636#section-4.1 and https://tools.ietf.org/html/rfc7636#section-4.2 */ async generatePkceCodes() { const verifier = this.generateCodeVerifier(); const challenge = this.generateCodeChallengeFromVerifier(verifier); return { verifier, challenge }; } /** * generates the codeVerfier; reference: https://tools.ietf.org/html/rfc7636#section-4.1 */ generateCodeVerifier() { const charArr = []; const maxNumber = 256 - (256 % CharSet.CV_CHARSET.length); while (charArr.length <= RANDOM_OCTET_SIZE) { const byte = crypto.randomBytes(1)[0]; if (byte >= maxNumber) { /* * Ignore this number to maintain randomness. * Including it would result in an unequal distribution of characters after doing the modulo */ continue; } const index = byte % CharSet.CV_CHARSET.length; charArr.push(CharSet.CV_CHARSET[index]); } const verifier = charArr.join(Constants$1.EMPTY_STRING); return EncodingUtils.base64EncodeUrl(verifier); } /** * generate the challenge from the codeVerfier; reference: https://tools.ietf.org/html/rfc7636#section-4.2 * @param codeVerifier */ generateCodeChallengeFromVerifier(codeVerifier) { return EncodingUtils.base64EncodeUrl(this.hashUtils.sha256(codeVerifier).toString("base64"), "base64"); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class implements MSAL node's crypto interface, which allows it to perform base64 encoding and decoding, generating cryptographically random GUIDs and * implementing Proof Key for Code Exchange specs for the OAuth Authorization Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636). * @public */ class CryptoProvider { constructor() { // Browser crypto needs to be validated first before any other classes can be set. this.pkceGenerator = new PkceGenerator(); this.guidGenerator = new GuidGenerator(); this.hashUtils = new HashUtils(); } /** * base64 URL safe encoded string */ base64UrlEncode() { throw new Error("Method not implemented."); } /** * Stringifies and base64Url encodes input public key * @param inputKid - public key id * @returns Base64Url encoded public key */ encodeKid() { throw new Error("Method not implemented."); } /** * Creates a new random GUID - used to populate state and nonce. * @returns string (GUID) */ createNewGuid() { return this.guidGenerator.generateGuid(); } /** * Encodes input string to base64. * @param input - string to be encoded */ base64Encode(input) { return EncodingUtils.base64Encode(input); } /** * Decodes input string from base64. * @param input - string to be decoded */ base64Decode(input) { return EncodingUtils.base64Decode(input); } /** * Generates PKCE codes used in Authorization Code Flow. */ generatePkceCodes() { return this.pkceGenerator.generatePkceCodes(); } /** * Generates a keypair, stores it and returns a thumbprint - not yet implemented for node */ getPublicKeyThumbprint() { throw new Error("Method not implemented."); } /** * Removes cryptographic keypair from key store matching the keyId passed in * @param kid - public key id */ removeTokenBindingKey() { throw new Error("Method not implemented."); } /** * Removes all cryptographic keys from Keystore */ clearKeystore() { throw new Error("Method not implemented."); } /** * Signs the given object as a jwt payload with private key retrieved by given kid - currently not implemented for node */ signJwt() { throw new Error("Method not implemented."); } /** * Returns the SHA-256 hash of an input string */ async hashString(plainText) { return EncodingUtils.base64EncodeUrl(this.hashUtils.sha256(plainText).toString("base64"), "base64"); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class implements Storage for node, reading cache from user specified storage location or an extension library * @public */ class NodeStorage extends CacheManager { constructor(logger, clientId, cryptoImpl, staticAuthorityOptions) { super(clientId, cryptoImpl, logger, staticAuthorityOptions); this.cache = {}; this.changeEmitters = []; this.logger = logger; } /** * Queue up callbacks * @param func - a callback function for cache change indication */ registerChangeEmitter(func) { this.changeEmitters.push(func); } /** * Invoke the callback when cache changes */ emitChange() { this.changeEmitters.forEach((func) => func.call(null)); } /** * Converts cacheKVStore to InMemoryCache * @param cache - key value store */ cacheToInMemoryCache(cache) { const inMemoryCache = { accounts: {}, idTokens: {}, accessTokens: {}, refreshTokens: {}, appMetadata: {}, }; for (const key in cache) { const value = cache[key]; if (typeof value !== "object") { continue; } if (value instanceof AccountEntity) { inMemoryCache.accounts[key] = value; } else if (isIdTokenEntity(value)) { inMemoryCache.idTokens[key] = value; } else if (isAccessTokenEntity(value)) { inMemoryCache.accessTokens[key] = value; } else if (isRefreshTokenEntity(value)) { inMemoryCache.refreshTokens[key] = value; } else if (isAppMetadataEntity(key, value)) { inMemoryCache.appMetadata[key] = value; } else { continue; } } return inMemoryCache; } /** * converts inMemoryCache to CacheKVStore * @param inMemoryCache - kvstore map for inmemory */ inMemoryCacheToCache(inMemoryCache) { // convert in memory cache to a flat Key-Value map let cache = this.getCache(); cache = { ...cache, ...inMemoryCache.accounts, ...inMemoryCache.idTokens, ...inMemoryCache.accessTokens, ...inMemoryCache.refreshTokens, ...inMemoryCache.appMetadata, }; // convert in memory cache to a flat Key-Value map return cache; } /** * gets the current in memory cache for the client */ getInMemoryCache() { this.logger.trace("Getting in-memory cache"); // convert the cache key value store to inMemoryCache const inMemoryCache = this.cacheToInMemoryCache(this.getCache()); return inMemoryCache; } /** * sets the current in memory cache for the client * @param inMemoryCache - key value map in memory */ setInMemoryCache(inMemoryCache) { this.logger.trace("Setting in-memory cache"); // convert and append the inMemoryCache to cacheKVStore const cache = this.inMemoryCacheToCache(inMemoryCache); this.setCache(cache); this.emitChange(); } /** * get the current cache key-value store */ getCache() { this.logger.trace("Getting cache key-value store"); return this.cache; } /** * sets the current cache (key value store) * @param cacheMap - key value map */ setCache(cache) { this.logger.trace("Setting cache key value store"); this.cache = cache; // mark change in cache this.emitChange(); } /** * Gets cache item with given key. * @param key - lookup key for the cache entry */ getItem(key) { this.logger.tracePii(`Item key: ${key}`); // read cache const cache = this.getCache(); return cache[key]; } /** * Gets cache item with given key-value * @param key - lookup key for the cache entry * @param value - value of the cache entry */ setItem(key, value) { this.logger.tracePii(`Item key: ${key}`); // read cache const cache = this.getCache(); cache[key] = value; // write to cache this.setCache(cache); } getAccountKeys() { const inMemoryCache = this.getInMemoryCache(); const accountKeys = Object.keys(inMemoryCache.accounts); return accountKeys; } getTokenKeys() { const inMemoryCache = this.getInMemoryCache(); const tokenKeys = { idToken: Object.keys(inMemoryCache.idTokens), accessToken: Object.keys(inMemoryCache.accessTokens), refreshToken: Object.keys(inMemoryCache.refreshTokens), }; return tokenKeys; } /** * fetch the account entity * @param accountKey - lookup key to fetch cache type AccountEntity */ getAccount(accountKey) { const accountEntity = this.getCachedAccountEntity(accountKey); if (accountEntity && AccountEntity.isAccountEntity(accountEntity)) { return this.updateOutdatedCachedAccount(accountKey, accountEntity); } return null; } /** * Reads account from cache, builds it into an account entity and returns it. * @param accountKey - lookup key to fetch cache type AccountEntity * @returns */ getCachedAccountEntity(accountKey) { const cachedAccount = this.getItem(accountKey); return cachedAccount ? Object.assign(new AccountEntity(), this.getItem(accountKey)) : null; } /** * set account entity * @param account - cache value to be set of type AccountEntity */ setAccount(account) { const accountKey = account.generateAccountKey(); this.setItem(accountKey, account); } /** * fetch the idToken credential * @param idTokenKey - lookup key to fetch cache type IdTokenEntity */ getIdTokenCredential(idTokenKey) { const idToken = this.getItem(idTokenKey); if (isIdTokenEntity(idToken)) { return idToken; } return null; } /** * set idToken credential * @param idToken - cache value to be set of type IdTokenEntity */ setIdTokenCredential(idToken) { const idTokenKey = generateCredentialKey(idToken); this.setItem(idTokenKey, idToken); } /** * fetch the accessToken credential * @param accessTokenKey - lookup key to fetch cache type AccessTokenEntity */ getAccessTokenCredential(accessTokenKey) { const accessToken = this.getItem(accessTokenKey); if (isAccessTokenEntity(accessToken)) { return accessToken; } return null; } /** * set accessToken credential * @param accessToken - cache value to be set of type AccessTokenEntity */ setAccessTokenCredential(accessToken) { const accessTokenKey = generateCredentialKey(accessToken); this.setItem(accessTokenKey, accessToken); } /** * fetch the refreshToken credential * @param refreshTokenKey - lookup key to fetch cache type RefreshTokenEntity */ getRefreshTokenCredential(refreshTokenKey) { const refreshToken = this.getItem(refreshTokenKey); if (isRefreshTokenEntity(refreshToken)) { return refreshToken; } return null; } /** * set refreshToken credential * @param refreshToken - cache value to be set of type RefreshTokenEntity */ setRefreshTokenCredential(refreshToken) { const refreshTokenKey = generateCredentialKey(refreshToken); this.setItem(refreshTokenKey, refreshToken); } /** * fetch appMetadata entity from the platform cache * @param appMetadataKey - lookup key to fetch cache type AppMetadataEntity */ getAppMetadata(appMetadataKey) { const appMetadata = this.getItem(appMetadataKey); if (isAppMetadataEntity(appMetadataKey, appMetadata)) { return appMetadata; } return null; } /** * set appMetadata entity to the platform cache * @param appMetadata - cache value to be set of type AppMetadataEntity */ setAppMetadata(appMetadata) { const appMetadataKey = generateAppMetadataKey(appMetadata); this.setItem(appMetadataKey, appMetadata); } /** * fetch server telemetry entity from the platform cache * @param serverTelemetrykey - lookup key to fetch cache type ServerTelemetryEntity */ getServerTelemetry(serverTelemetrykey) { const serverTelemetryEntity = this.getItem(serverTelemetrykey); if (serverTelemetryEntity && isServerTelemetryEntity(serverTelemetrykey, serverTelemetryEntity)) { return serverTelemetryEntity; } return null; } /** * set server telemetry entity to the platform cache * @param serverTelemetryKey - lookup key to fetch cache type ServerTelemetryEntity * @param serverTelemetry - cache value to be set of type ServerTelemetryEntity */ setServerTelemetry(serverTelemetryKey, serverTelemetry) { this.setItem(serverTelemetryKey, serverTelemetry); } /** * fetch authority metadata entity from the platform cache * @param key - lookup key to fetch cache type AuthorityMetadataEntity */ getAuthorityMetadata(key) { const authorityMetadataEntity = this.getItem(key); if (authorityMetadataEntity && isAuthorityMetadataEntity(key, authorityMetadataEntity)) { return authorityMetadataEntity; } return null; } /** * Get all authority metadata keys */ getAuthorityMetadataKeys() { return this.getKeys().filter((key) => { return this.isAuthorityMetadata(key); }); } /** * set authority metadata entity to the platform cache * @param key - lookup key to fetch cache type AuthorityMetadataEntity * @param metadata - cache value to be set of type AuthorityMetadataEntity */ setAuthorityMetadata(key, metadata) { this.setItem(key, metadata); } /** * fetch throttling entity from the platform cache * @param throttlingCacheKey - lookup key to fetch cache type ThrottlingEntity */ getThrottlingCache(throttlingCacheKey) { const throttlingCache = this.getItem(throttlingCacheKey); if (throttlingCache && isThrottlingEntity(throttlingCacheKey, throttlingCache)) { return throttlingCache; } return null; } /** * set throttling entity to the platform cache * @param throttlingCacheKey - lookup key to fetch cache type ThrottlingEntity * @param throttlingCache - cache value to be set of type ThrottlingEntity */ setThrottlingCache(throttlingCacheKey, throttlingCache) { this.setItem(throttlingCacheKey, throttlingCache); } /** * Removes the cache item from memory with the given key. * @param key - lookup key to remove a cache entity * @param inMemory - key value map of the cache */ removeItem(key) { this.logger.tracePii(`Item key: ${key}`); // read inMemoryCache let result = false; const cache = this.getCache(); if (!!cache[key]) { delete cache[key]; result = true; } // write to the cache after removal if (result) { this.setCache(cache); this.emitChange(); } return result; } /** * Remove account entity from the platform cache if it's outdated * @param accountKey - lookup key to fetch cache type AccountEntity */ removeOutdatedAccount(accountKey) { this.removeItem(accountKey); } /** * Checks whether key is in cache. * @param key - look up key for a cache entity */ containsKey(key) { return this.getKeys().includes(key); } /** * Gets all keys in window. */ getKeys() { this.logger.trace("Retrieving all cache keys"); // read cache const cache = this.getCache(); return [...Object.keys(cache)]; } /** * Clears all cache entries created by MSAL (except tokens). */ clear() { this.logger.trace("Clearing cache entries created by MSAL"); // read inMemoryCache const cacheKeys = this.getKeys(); // delete each element cacheKeys.forEach((key) => { this.removeItem(key); }); this.emitChange(); } /** * Initialize in memory cache from an exisiting cache vault * @param cache - blob formatted cache (JSON) */ static generateInMemoryCache(cache) { return Deserializer.deserializeAllCache(Deserializer.deserializeJSONBlob(cache)); } /** * retrieves the final JSON * @param inMemoryCache - itemised cache read from the JSON */ static generateJsonCache(inMemoryCache) { return Serializer.serializeAllCache(inMemoryCache); } /** * Updates a credential's cache key if the current cache key is outdated */ updateCredentialCacheKey(currentCacheKey, credential) { const updatedCacheKey = generateCredentialKey(credential); if (currentCacheKey !== updatedCacheKey) { const cacheItem = this.getItem(currentCacheKey); if (cacheItem) { this.removeItem(currentCacheKey); this.setItem(updatedCacheKey, cacheItem); this.logger.verbose(`Updated an outdated ${credential.credentialType} cache key`); return updatedCacheKey; } else { this.logger.error(`Attempted to update an outdated ${credential.credentialType} cache key but no item matching the outdated key was found in storage`); } } return currentCacheKey; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const defaultSerializedCache = { Account: {}, IdToken: {}, AccessToken: {}, RefreshToken: {}, AppMetadata: {}, }; /** * In-memory token cache manager * @public */ class TokenCache { constructor(storage, logger, cachePlugin) { this.cacheHasChanged = false; this.storage = storage; this.storage.registerChangeEmitter(this.handleChangeEvent.bind(this)); if (cachePlugin) { this.persistence = cachePlugin; } this.logger = logger; } /** * Set to true if cache state has changed since last time serialize or writeToPersistence was called */ hasChanged() { return this.cacheHasChanged; } /** * Serializes in memory cache to JSON */ serialize() { this.logger.trace("Serializing in-memory cache"); let finalState = Serializer.serializeAllCache(this.storage.getInMemoryCache()); // if cacheSnapshot not null or empty, merge if (this.cacheSnapshot) { this.logger.trace("Reading cache snapshot from disk"); finalState = this.mergeState(JSON.parse(this.cacheSnapshot), finalState); } else { this.logger.trace("No cache snapshot to merge"); } this.cacheHasChanged = false; return JSON.stringify(finalState); } /** * Deserializes JSON to in-memory cache. JSON should be in MSAL cache schema format * @param cache - blob formatted cache */ deserialize(cache) { this.logger.trace("Deserializing JSON to in-memory cache"); this.cacheSnapshot = cache; if (this.cacheSnapshot) { this.logger.trace("Reading cache snapshot from disk"); const deserializedCache = Deserializer.deserializeAllCache(this.overlayDefaults(JSON.parse(this.cacheSnapshot))); this.storage.setInMemoryCache(deserializedCache); } else { this.logger.trace("No cache snapshot to deserialize"); } } /** * Fetches the cache key-value map */ getKVStore() { return this.storage.getCache(); } /** * API that retrieves all accounts currently in cache to the user */ async getAllAccounts() { this.logger.trace("getAllAccounts called"); let cacheContext; try { if (this.persistence) { cacheContext = new TokenCacheContext(this, false); await this.persistence.beforeCacheAccess(cacheContext); } return this.storage.getAllAccounts(); } finally { if (this.persistence && cacheContext) { await this.persistence.afterCacheAccess(cacheContext); } } } /** * Returns the signed in account matching homeAccountId. * (the account object is created at the time of successful login) * or null when no matching account is found * @param homeAccountId - unique identifier for an account (uid.utid) */ async getAccountByHomeId(homeAccountId) { const allAccounts = await this.getAllAccounts(); if (homeAccountId && allAccounts && allAccounts.length) { return (allAccounts.filter((accountObj) => accountObj.homeAccountId === homeAccountId)[0] || null); } else { return null; } } /** * Returns the signed in account matching localAccountId. * (the account object is created at the time of successful login) * or null when no matching account is found * @param localAccountId - unique identifier of an account (sub/obj when homeAccountId cannot be populated) */ async getAccountByLocalId(localAccountId) { const allAccounts = await this.getAllAccounts(); if (localAccountId && allAccounts && allAccounts.length) { return (allAccounts.filter((accountObj) => accountObj.localAccountId === localAccountId)[0] || null); } else { return null; } } /** * API to remove a specific account and the relevant data from cache * @param account - AccountInfo passed by the user */ async removeAccount(account) { this.logger.trace("removeAccount called"); let cacheContext; try { if (this.persistence) { cacheContext = new TokenCacheContext(this, true); await this.persistence.beforeCacheAccess(cacheContext); } await this.storage.removeAccount(AccountEntity.generateAccountCacheKey(account)); } finally { if (this.persistence && cacheContext) { await this.persistence.afterCacheAccess(cacheContext); } } } /** * Called when the cache has changed state. */ handleChangeEvent() { this.cacheHasChanged = true; } /** * Merge in memory cache with the cache snapshot. * @param oldState - cache before changes * @param currentState - current cache state in the library */ mergeState(oldState, currentState) { this.logger.trace("Merging in-memory cache with cache snapshot"); const stateAfterRemoval = this.mergeRemovals(oldState, currentState); return this.mergeUpdates(stateAfterRemoval, currentState); } /** * Deep update of oldState based on newState values * @param oldState - cache before changes * @param newState - updated cache */ mergeUpdates(oldState, newState) { Object.keys(newState).forEach((newKey) => { const newValue = newState[newKey]; // if oldState does not contain value but newValue does, add it if (!oldState.hasOwnProperty(newKey)) { if (newValue !== null) { oldState[newKey] = newValue; } } else { // both oldState and newState contain the key, do deep update const newValueNotNull = newValue !== null; const newValueIsObject = typeof newValue === "object"; const newValueIsNotArray = !Array.isArray(newValue); const oldStateNotUndefinedOrNull = typeof oldState[newKey] !== "undefined" && oldState[newKey] !== null; if (newValueNotNull && newValueIsObject && newValueIsNotArray && oldStateNotUndefinedOrNull) { this.mergeUpdates(oldState[newKey], newValue); } else { oldState[newKey] = newValue; } } }); return oldState; } /** * Removes entities in oldState that the were removed from newState. If there are any unknown values in root of * oldState that are not recognized, they are left untouched. * @param oldState - cache before changes * @param newState - updated cache */ mergeRemovals(oldState, newState) { this.logger.trace("Remove updated entries in cache"); const accounts = oldState.Account ? this.mergeRemovalsDict(oldState.Account, newState.Account) : oldState.Account; const accessTokens = oldState.AccessToken ? this.mergeRemovalsDict(oldState.AccessToken, newState.AccessToken) : oldState.AccessToken; const refreshTokens = oldState.RefreshToken ? this.mergeRemovalsDict(oldState.RefreshToken, newState.RefreshToken) : oldState.RefreshToken; const idTokens = oldState.IdToken ? this.mergeRemovalsDict(oldState.IdToken, newState.IdToken) : oldState.IdToken; const appMetadata = oldState.AppMetadata ? this.mergeRemovalsDict(oldState.AppMetadata, newState.AppMetadata) : oldState.AppMetadata; return { ...oldState, Account: accounts, AccessToken: accessTokens, RefreshToken: refreshTokens, IdToken: idTokens, AppMetadata: appMetadata, }; } /** * Helper to merge new cache with the old one * @param oldState - cache before changes * @param newState - updated cache */ mergeRemovalsDict(oldState, newState) { const finalState = { ...oldState }; Object.keys(oldState).forEach((oldKey) => { if (!newState || !newState.hasOwnProperty(oldKey)) { delete finalState[oldKey]; } }); return finalState; } /** * Helper to overlay as a part of cache merge * @param passedInCache - cache read from the blob */ overlayDefaults(passedInCache) { this.logger.trace("Overlaying input cache with the default cache"); return { Account: { ...defaultSerializedCache.Account, ...passedInCache.Account, }, IdToken: { ...defaultSerializedCache.IdToken, ...passedInCache.IdToken, }, AccessToken: { ...defaultSerializedCache.AccessToken, ...passedInCache.AccessToken, }, RefreshToken: { ...defaultSerializedCache.RefreshToken, ...passedInCache.RefreshToken, }, AppMetadata: { ...defaultSerializedCache.AppMetadata, ...passedInCache.AppMetadata, }, }; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Client assertion of type jwt-bearer used in confidential client flows * @public */ class ClientAssertion { /** * Initialize the ClientAssertion class from the clientAssertion passed by the user * @param assertion - refer https://tools.ietf.org/html/rfc7521 */ static fromAssertion(assertion) { const clientAssertion = new ClientAssertion(); clientAssertion.jwt = assertion; return clientAssertion; } /** * @deprecated Use fromCertificateWithSha256Thumbprint instead, with a SHA-256 thumprint * Initialize the ClientAssertion class from the certificate passed by the user * @param thumbprint - identifier of a certificate * @param privateKey - secret key * @param publicCertificate - electronic document provided to prove the ownership of the public key */ static fromCertificate(thumbprint, privateKey, publicCertificate) { const clientAssertion = new ClientAssertion(); clientAssertion.privateKey = privateKey; clientAssertion.thumbprint = thumbprint; clientAssertion.useSha256 = false; if (publicCertificate) { clientAssertion.publicCertificate = this.parseCertificate(publicCertificate); } return clientAssertion; } /** * Initialize the ClientAssertion class from the certificate passed by the user * @param thumbprint - identifier of a certificate * @param privateKey - secret key * @param publicCertificate - electronic document provided to prove the ownership of the public key */ static fromCertificateWithSha256Thumbprint(thumbprint, privateKey, publicCertificate) { const clientAssertion = new ClientAssertion(); clientAssertion.privateKey = privateKey; clientAssertion.thumbprint = thumbprint; clientAssertion.useSha256 = true; if (publicCertificate) { clientAssertion.publicCertificate = this.parseCertificate(publicCertificate); } return clientAssertion; } /** * Update JWT for certificate based clientAssertion, if passed by the user, uses it as is * @param cryptoProvider - library's crypto helper * @param issuer - iss claim * @param jwtAudience - aud claim */ getJwt(cryptoProvider, issuer, jwtAudience) { // if assertion was created from certificate, check if jwt is expired and create new one. if (this.privateKey && this.thumbprint) { if (this.jwt && !this.isExpired() && issuer === this.issuer && jwtAudience === this.jwtAudience) { return this.jwt; } return this.createJwt(cryptoProvider, issuer, jwtAudience); } /* * if assertion was created by caller, then we just append it. It is up to the caller to * ensure that it contains necessary claims and that it is not expired. */ if (this.jwt) { return this.jwt; } throw createClientAuthError(invalidAssertion); } /** * JWT format and required claims specified: https://tools.ietf.org/html/rfc7523#section-3 */ createJwt(cryptoProvider, issuer, jwtAudience) { this.issuer = issuer; this.jwtAudience = jwtAudience; const issuedAt = nowSeconds(); this.expirationTime = issuedAt + 600; const algorithm = this.useSha256 ? JwtConstants.PSS_256 : JwtConstants.RSA_256; const header = { alg: algorithm, }; const thumbprintHeader = this.useSha256 ? JwtConstants.X5T_256 : JwtConstants.X5T; Object.assign(header, { [thumbprintHeader]: EncodingUtils.base64EncodeUrl(this.thumbprint, "hex"), }); if (this.publicCertificate) { Object.assign(header, { [JwtConstants.X5C]: this.publicCertificate, }); } const payload = { [JwtConstants.AUDIENCE]: this.jwtAudience, [JwtConstants.EXPIRATION_TIME]: this.expirationTime, [JwtConstants.ISSUER]: this.issuer, [JwtConstants.SUBJECT]: this.issuer, [JwtConstants.NOT_BEFORE]: issuedAt, [JwtConstants.JWT_ID]: cryptoProvider.createNewGuid(), }; this.jwt = jwt.sign(payload, this.privateKey, { header }); return this.jwt; } /** * Utility API to check expiration */ isExpired() { return this.expirationTime < nowSeconds(); } /** * Extracts the raw certs from a given certificate string and returns them in an array. * @param publicCertificate - electronic document provided to prove the ownership of the public key */ static parseCertificate(publicCertificate) { /** * This is regex to identify the certs in a given certificate string. * We want to look for the contents between the BEGIN and END certificate strings, without the associated newlines. * The information in parens "(.+?)" is the capture group to represent the cert we want isolated. * "." means any string character, "+" means match 1 or more times, and "?" means the shortest match. * The "g" at the end of the regex means search the string globally, and the "s" enables the "." to match newlines. */ const regexToFindCerts = /-----BEGIN CERTIFICATE-----\r*\n(.+?)\r*\n-----END CERTIFICATE-----/gs; const certs = []; let matches; while ((matches = regexToFindCerts.exec(publicCertificate)) !== null) { // matches[1] represents the first parens capture group in the regex. certs.push(matches[1].replace(/\r*\n/g, Constants$1.EMPTY_STRING)); } return certs; } } /* eslint-disable header/header */ const name = "@azure/msal-node"; const version = "2.16.2"; /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Oauth2.0 Password grant client * Note: We are only supporting public clients for password grant and for purely testing purposes * @public */ class UsernamePasswordClient extends BaseClient { constructor(configuration) { super(configuration); } /** * API to acquire a token by passing the username and password to the service in exchage of credentials * password_grant * @param request - CommonUsernamePasswordRequest */ async acquireToken(request) { this.logger.info("in acquireToken call in username-password client"); const reqTimestamp = nowSeconds(); const response = await this.executeTokenRequest(this.authority, request); const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin); // Validate response. This function throws a server error if an error is returned by the server. responseHandler.validateTokenResponse(response.body); const tokenResponse = responseHandler.handleServerTokenResponse(response.body, this.authority, reqTimestamp, request); return tokenResponse; } /** * Executes POST request to token endpoint * @param authority - authority object * @param request - CommonUsernamePasswordRequest provided by the developer */ async executeTokenRequest(authority, request) { const queryParametersString = this.createTokenQueryParameters(request); const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString); const requestBody = await this.createTokenRequestBody(request); const headers = this.createTokenRequestHeaders({ credential: request.username, type: CcsCredentialType.UPN, }); const thumbprint = { clientId: this.config.authOptions.clientId, authority: authority.canonicalAuthority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; return this.executePostToTokenEndpoint(endpoint, requestBody, headers, thumbprint, request.correlationId); } /** * Generates a map for all the params to be sent to the service * @param request - CommonUsernamePasswordRequest provided by the developer */ async createTokenRequestBody(request) { const parameterBuilder = new RequestParameterBuilder(); parameterBuilder.addClientId(this.config.authOptions.clientId); parameterBuilder.addUsername(request.username); parameterBuilder.addPassword(request.password); parameterBuilder.addScopes(request.scopes); parameterBuilder.addResponseTypeForTokenAndIdToken(); parameterBuilder.addGrantType(GrantType.RESOURCE_OWNER_PASSWORD_GRANT); parameterBuilder.addClientInfo(); parameterBuilder.addLibraryInfo(this.config.libraryInfo); parameterBuilder.addApplicationTelemetry(this.config.telemetry.application); parameterBuilder.addThrottling(); if (this.serverTelemetryManager) { parameterBuilder.addServerTelemetry(this.serverTelemetryManager); } const correlationId = request.correlationId || this.config.cryptoInterface.createNewGuid(); parameterBuilder.addCorrelationId(correlationId); if (this.config.clientCredentials.clientSecret) { parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret); } const clientAssertion = this.config.clientCredentials.clientAssertion; if (clientAssertion) { parameterBuilder.addClientAssertion(await getClientAssertion(clientAssertion.assertion, this.config.authOptions.clientId, request.resourceRequestUri)); parameterBuilder.addClientAssertionType(clientAssertion.assertionType); } if (!StringUtils.isEmptyObj(request.claims) || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } if (this.config.systemOptions.preventCorsPreflight && request.username) { parameterBuilder.addCcsUpn(request.username); } return parameterBuilder.createQueryString(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Base abstract class for all ClientApplications - public and confidential * @public */ class ClientApplication { /** * Constructor for the ClientApplication */ constructor(configuration) { this.config = buildAppConfiguration(configuration); this.cryptoProvider = new CryptoProvider(); this.logger = new Logger(this.config.system.loggerOptions, name, version); this.storage = new NodeStorage(this.logger, this.config.auth.clientId, this.cryptoProvider, buildStaticAuthorityOptions(this.config.auth)); this.tokenCache = new TokenCache(this.storage, this.logger, this.config.cache.cachePlugin); } /** * Creates the URL of the authorization request, letting the user input credentials and consent to the * application. The URL targets the /authorize endpoint of the authority configured in the * application object. * * Once the user inputs their credentials and consents, the authority will send a response to the redirect URI * sent in the request and should contain an authorization code, which can then be used to acquire tokens via * `acquireTokenByCode(AuthorizationCodeRequest)`. */ async getAuthCodeUrl(request) { this.logger.info("getAuthCodeUrl called", request.correlationId); const validRequest = { ...request, ...(await this.initializeBaseRequest(request)), responseMode: request.responseMode || ResponseMode.QUERY, authenticationScheme: AuthenticationScheme.BEARER, }; const authClientConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, validRequest.redirectUri, undefined, undefined, request.azureCloudOptions); const authorizationCodeClient = new AuthorizationCodeClient(authClientConfig); this.logger.verbose("Auth code client created", validRequest.correlationId); return authorizationCodeClient.getAuthCodeUrl(validRequest); } /** * Acquires a token by exchanging the Authorization Code received from the first step of OAuth2.0 * Authorization Code flow. * * `getAuthCodeUrl(AuthorizationCodeUrlRequest)` can be used to create the URL for the first step of OAuth2.0 * Authorization Code flow. Ensure that values for redirectUri and scopes in AuthorizationCodeUrlRequest and * AuthorizationCodeRequest are the same. */ async acquireTokenByCode(request, authCodePayLoad) { this.logger.info("acquireTokenByCode called"); if (request.state && authCodePayLoad) { this.logger.info("acquireTokenByCode - validating state"); this.validateState(request.state, authCodePayLoad.state || ""); // eslint-disable-next-line no-param-reassign authCodePayLoad = { ...authCodePayLoad, state: "" }; } const validRequest = { ...request, ...(await this.initializeBaseRequest(request)), authenticationScheme: AuthenticationScheme.BEARER, }; const serverTelemetryManager = this.initializeServerTelemetryManager(ApiId.acquireTokenByCode, validRequest.correlationId); try { const authClientConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, validRequest.redirectUri, serverTelemetryManager, undefined, request.azureCloudOptions); const authorizationCodeClient = new AuthorizationCodeClient(authClientConfig); this.logger.verbose("Auth code client created", validRequest.correlationId); return await authorizationCodeClient.acquireToken(validRequest, authCodePayLoad); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } serverTelemetryManager.cacheFailedRequest(e); throw e; } } /** * Acquires a token by exchanging the refresh token provided for a new set of tokens. * * This API is provided only for scenarios where you would like to migrate from ADAL to MSAL. Otherwise, it is * recommended that you use `acquireTokenSilent()` for silent scenarios. When using `acquireTokenSilent()`, MSAL will * handle the caching and refreshing of tokens automatically. */ async acquireTokenByRefreshToken(request) { this.logger.info("acquireTokenByRefreshToken called", request.correlationId); const validRequest = { ...request, ...(await this.initializeBaseRequest(request)), authenticationScheme: AuthenticationScheme.BEARER, }; const serverTelemetryManager = this.initializeServerTelemetryManager(ApiId.acquireTokenByRefreshToken, validRequest.correlationId); try { const refreshTokenClientConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, validRequest.redirectUri || "", serverTelemetryManager, undefined, request.azureCloudOptions); const refreshTokenClient = new RefreshTokenClient(refreshTokenClientConfig); this.logger.verbose("Refresh token client created", validRequest.correlationId); return await refreshTokenClient.acquireToken(validRequest); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } serverTelemetryManager.cacheFailedRequest(e); throw e; } } /** * Acquires a token silently when a user specifies the account the token is requested for. * * This API expects the user to provide an account object and looks into the cache to retrieve the token if present. * There is also an optional "forceRefresh" boolean the user can send to bypass the cache for access_token and id_token. * In case the refresh_token is expired or not found, an error is thrown * and the guidance is for the user to call any interactive token acquisition API (eg: `acquireTokenByCode()`). */ async acquireTokenSilent(request) { const validRequest = { ...request, ...(await this.initializeBaseRequest(request)), forceRefresh: request.forceRefresh || false, }; const serverTelemetryManager = this.initializeServerTelemetryManager(ApiId.acquireTokenSilent, validRequest.correlationId, validRequest.forceRefresh); try { const silentFlowClientConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, validRequest.redirectUri || "", serverTelemetryManager, undefined, request.azureCloudOptions); const silentFlowClient = new SilentFlowClient(silentFlowClientConfig); this.logger.verbose("Silent flow client created", validRequest.correlationId); return await silentFlowClient.acquireToken(validRequest); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } serverTelemetryManager.cacheFailedRequest(e); throw e; } } /** * Acquires tokens with password grant by exchanging client applications username and password for credentials * * The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely. * More details on this recommendation at https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 * Microsoft's documentation and recommendations are at: * https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword * * @param request - UsenamePasswordRequest */ async acquireTokenByUsernamePassword(request) { this.logger.info("acquireTokenByUsernamePassword called", request.correlationId); const validRequest = { ...request, ...(await this.initializeBaseRequest(request)), }; const serverTelemetryManager = this.initializeServerTelemetryManager(ApiId.acquireTokenByUsernamePassword, validRequest.correlationId); try { const usernamePasswordClientConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, "", serverTelemetryManager, undefined, request.azureCloudOptions); const usernamePasswordClient = new UsernamePasswordClient(usernamePasswordClientConfig); this.logger.verbose("Username password client created", validRequest.correlationId); return await usernamePasswordClient.acquireToken(validRequest); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } serverTelemetryManager.cacheFailedRequest(e); throw e; } } /** * Gets the token cache for the application. */ getTokenCache() { this.logger.info("getTokenCache called"); return this.tokenCache; } /** * Validates OIDC state by comparing the user cached state with the state received from the server. * * This API is provided for scenarios where you would use OAuth2.0 state parameter to mitigate against * CSRF attacks. * For more information about state, visit https://datatracker.ietf.org/doc/html/rfc6819#section-3.6. * @param state - Unique GUID generated by the user that is cached by the user and sent to the server during the first leg of the flow * @param cachedState - This string is sent back by the server with the authorization code */ validateState(state, cachedState) { if (!state) { throw NodeAuthError.createStateNotFoundError(); } if (state !== cachedState) { throw createClientAuthError(stateMismatch); } } /** * Returns the logger instance */ getLogger() { return this.logger; } /** * Replaces the default logger set in configurations with new Logger with new configurations * @param logger - Logger instance */ setLogger(logger) { this.logger = logger; } /** * Builds the common configuration to be passed to the common component based on the platform configurarion * @param authority - user passed authority in configuration * @param serverTelemetryManager - initializes servertelemetry if passed */ async buildOauthClientConfiguration(authority, requestCorrelationId, redirectUri, serverTelemetryManager, azureRegionConfiguration, azureCloudOptions) { this.logger.verbose("buildOauthClientConfiguration called", requestCorrelationId); // precedence - azureCloudInstance + tenant >> authority and request >> config const userAzureCloudOptions = azureCloudOptions ? azureCloudOptions : this.config.auth.azureCloudOptions; // using null assertion operator as we ensure that all config values have default values in buildConfiguration() const discoveredAuthority = await this.createAuthority(authority, requestCorrelationId, azureRegionConfiguration, userAzureCloudOptions); this.logger.info(`Building oauth client configuration with the following authority: ${discoveredAuthority.tokenEndpoint}.`, requestCorrelationId); serverTelemetryManager?.updateRegionDiscoveryMetadata(discoveredAuthority.regionDiscoveryMetadata); const clientConfiguration = { authOptions: { clientId: this.config.auth.clientId, authority: discoveredAuthority, clientCapabilities: this.config.auth.clientCapabilities, redirectUri, }, loggerOptions: { logLevel: this.config.system.loggerOptions.logLevel, loggerCallback: this.config.system.loggerOptions.loggerCallback, piiLoggingEnabled: this.config.system.loggerOptions.piiLoggingEnabled, correlationId: requestCorrelationId, }, cacheOptions: { claimsBasedCachingEnabled: this.config.cache.claimsBasedCachingEnabled, }, cryptoInterface: this.cryptoProvider, networkInterface: this.config.system.networkClient, storageInterface: this.storage, serverTelemetryManager: serverTelemetryManager, clientCredentials: { clientSecret: this.clientSecret, clientAssertion: await this.getClientAssertion(discoveredAuthority), }, libraryInfo: { sku: Constants.MSAL_SKU, version: version, cpu: process.arch || Constants$1.EMPTY_STRING, os: process.platform || Constants$1.EMPTY_STRING, }, telemetry: this.config.telemetry, persistencePlugin: this.config.cache.cachePlugin, serializableCache: this.tokenCache, }; return clientConfiguration; } async getClientAssertion(authority) { if (this.developerProvidedClientAssertion) { this.clientAssertion = ClientAssertion.fromAssertion(await getClientAssertion(this.developerProvidedClientAssertion, this.config.auth.clientId, authority.tokenEndpoint)); } return (this.clientAssertion && { assertion: this.clientAssertion.getJwt(this.cryptoProvider, this.config.auth.clientId, authority.tokenEndpoint), assertionType: Constants.JWT_BEARER_ASSERTION_TYPE, }); } /** * Generates a request with the default scopes & generates a correlationId. * @param authRequest - BaseAuthRequest for initialization */ async initializeBaseRequest(authRequest) { this.logger.verbose("initializeRequestScopes called", authRequest.correlationId); // Default authenticationScheme to Bearer, log that POP isn't supported yet if (authRequest.authenticationScheme && authRequest.authenticationScheme === AuthenticationScheme.POP) { this.logger.verbose("Authentication Scheme 'pop' is not supported yet, setting Authentication Scheme to 'Bearer' for request", authRequest.correlationId); } authRequest.authenticationScheme = AuthenticationScheme.BEARER; // Set requested claims hash if claims-based caching is enabled and claims were requested if (this.config.cache.claimsBasedCachingEnabled && authRequest.claims && // Checks for empty stringified object "{}" which doesn't qualify as requested claims !StringUtils.isEmptyObj(authRequest.claims)) { authRequest.requestedClaimsHash = await this.cryptoProvider.hashString(authRequest.claims); } return { ...authRequest, scopes: [ ...((authRequest && authRequest.scopes) || []), ...OIDC_DEFAULT_SCOPES, ], correlationId: (authRequest && authRequest.correlationId) || this.cryptoProvider.createNewGuid(), authority: authRequest.authority || this.config.auth.authority, }; } /** * Initializes the server telemetry payload * @param apiId - Id for a specific request * @param correlationId - GUID * @param forceRefresh - boolean to indicate network call */ initializeServerTelemetryManager(apiId, correlationId, forceRefresh) { const telemetryPayload = { clientId: this.config.auth.clientId, correlationId: correlationId, apiId: apiId, forceRefresh: forceRefresh || false, }; return new ServerTelemetryManager(telemetryPayload, this.storage); } /** * Create authority instance. If authority not passed in request, default to authority set on the application * object. If no authority set in application object, then default to common authority. * @param authorityString - authority from user configuration */ async createAuthority(authorityString, requestCorrelationId, azureRegionConfiguration, azureCloudOptions) { this.logger.verbose("createAuthority called", requestCorrelationId); // build authority string based on auth params - azureCloudInstance is prioritized if provided const authorityUrl = Authority.generateAuthority(authorityString, azureCloudOptions); const authorityOptions = { protocolMode: this.config.auth.protocolMode, knownAuthorities: this.config.auth.knownAuthorities, cloudDiscoveryMetadata: this.config.auth.cloudDiscoveryMetadata, authorityMetadata: this.config.auth.authorityMetadata, azureRegionConfiguration, skipAuthorityMetadataCache: this.config.auth.skipAuthorityMetadataCache, }; return createDiscoveredInstance(authorityUrl, this.config.system.networkClient, this.storage, authorityOptions, this.logger, requestCorrelationId); } /** * Clear the cache */ clearCache() { this.storage.clear(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class LoopbackClient { /** * Spins up a loopback server which returns the server response when the localhost redirectUri is hit * @param successTemplate * @param errorTemplate * @returns */ async listenForAuthCode(successTemplate, errorTemplate) { if (this.server) { throw NodeAuthError.createLoopbackServerAlreadyExistsError(); } return new Promise((resolve, reject) => { this.server = http.createServer((req, res) => { const url = req.url; if (!url) { res.end(errorTemplate || "Error occurred loading redirectUrl"); reject(NodeAuthError.createUnableToLoadRedirectUrlError()); return; } else if (url === Constants$1.FORWARD_SLASH) { res.end(successTemplate || "Auth code was successfully acquired. You can close this window now."); return; } const redirectUri = this.getRedirectUri(); const parsedUrl = new URL(url, redirectUri); const authCodeResponse = getDeserializedResponse(parsedUrl.search) || {}; if (authCodeResponse.code) { res.writeHead(HttpStatus.REDIRECT, { location: redirectUri, }); // Prevent auth code from being saved in the browser history res.end(); } if (authCodeResponse.error) { res.end(errorTemplate || `Error occurred: ${authCodeResponse.error}`); } resolve(authCodeResponse); }); this.server.listen(0, "127.0.0.1"); // Listen on any available port }); } /** * Get the port that the loopback server is running on * @returns */ getRedirectUri() { if (!this.server || !this.server.listening) { throw NodeAuthError.createNoLoopbackServerExistsError(); } const address = this.server.address(); if (!address || typeof address === "string" || !address.port) { this.closeServer(); throw NodeAuthError.createInvalidLoopbackAddressTypeError(); } const port = address && address.port; return `${Constants.HTTP_PROTOCOL}${Constants.LOCALHOST}:${port}`; } /** * Close the loopback server */ closeServer() { if (this.server) { // Only stops accepting new connections, server will close once open/idle connections are closed. this.server.close(); if (typeof this.server.closeAllConnections === "function") { /* * Close open/idle connections. This API is available in Node versions 18.2 and higher */ this.server.closeAllConnections(); } this.server.unref(); this.server = undefined; } } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * OAuth2.0 Device code client * @public */ class DeviceCodeClient extends BaseClient { constructor(configuration) { super(configuration); } /** * Gets device code from device code endpoint, calls back to with device code response, and * polls token endpoint to exchange device code for tokens * @param request - developer provided CommonDeviceCodeRequest */ async acquireToken(request) { const deviceCodeResponse = await this.getDeviceCode(request); request.deviceCodeCallback(deviceCodeResponse); const reqTimestamp = nowSeconds(); const response = await this.acquireTokenWithDeviceCode(request, deviceCodeResponse); const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin); // Validate response. This function throws a server error if an error is returned by the server. responseHandler.validateTokenResponse(response); return responseHandler.handleServerTokenResponse(response, this.authority, reqTimestamp, request); } /** * Creates device code request and executes http GET * @param request - developer provided CommonDeviceCodeRequest */ async getDeviceCode(request) { const queryParametersString = this.createExtraQueryParameters(request); const endpoint = UrlString.appendQueryString(this.authority.deviceCodeEndpoint, queryParametersString); const queryString = this.createQueryString(request); const headers = this.createTokenRequestHeaders(); const thumbprint = { clientId: this.config.authOptions.clientId, authority: request.authority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; return this.executePostRequestToDeviceCodeEndpoint(endpoint, queryString, headers, thumbprint, request.correlationId); } /** * Creates query string for the device code request * @param request - developer provided CommonDeviceCodeRequest */ createExtraQueryParameters(request) { const parameterBuilder = new RequestParameterBuilder(); if (request.extraQueryParameters) { parameterBuilder.addExtraQueryParameters(request.extraQueryParameters); } return parameterBuilder.createQueryString(); } /** * Executes POST request to device code endpoint * @param deviceCodeEndpoint - token endpoint * @param queryString - string to be used in the body of the request * @param headers - headers for the request * @param thumbprint - unique request thumbprint * @param correlationId - correlation id to be used in the request */ async executePostRequestToDeviceCodeEndpoint(deviceCodeEndpoint, queryString, headers, thumbprint, correlationId) { const { body: { user_code: userCode, device_code: deviceCode, verification_uri: verificationUri, expires_in: expiresIn, interval, message, }, } = await this.sendPostRequest(thumbprint, deviceCodeEndpoint, { body: queryString, headers: headers, }, correlationId); return { userCode, deviceCode, verificationUri, expiresIn, interval, message, }; } /** * Create device code endpoint query parameters and returns string * @param request - developer provided CommonDeviceCodeRequest */ createQueryString(request) { const parameterBuilder = new RequestParameterBuilder(); parameterBuilder.addScopes(request.scopes); parameterBuilder.addClientId(this.config.authOptions.clientId); if (request.extraQueryParameters) { parameterBuilder.addExtraQueryParameters(request.extraQueryParameters); } if (request.claims || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } return parameterBuilder.createQueryString(); } /** * Breaks the polling with specific conditions * @param deviceCodeExpirationTime - expiration time for the device code request * @param userSpecifiedTimeout - developer provided timeout, to be compared against deviceCodeExpirationTime * @param userSpecifiedCancelFlag - boolean indicating the developer would like to cancel the request */ continuePolling(deviceCodeExpirationTime, userSpecifiedTimeout, userSpecifiedCancelFlag) { if (userSpecifiedCancelFlag) { this.logger.error("Token request cancelled by setting DeviceCodeRequest.cancel = true"); throw createClientAuthError(deviceCodePollingCancelled); } else if (userSpecifiedTimeout && userSpecifiedTimeout < deviceCodeExpirationTime && nowSeconds() > userSpecifiedTimeout) { this.logger.error(`User defined timeout for device code polling reached. The timeout was set for ${userSpecifiedTimeout}`); throw createClientAuthError(userTimeoutReached); } else if (nowSeconds() > deviceCodeExpirationTime) { if (userSpecifiedTimeout) { this.logger.verbose(`User specified timeout ignored as the device code has expired before the timeout elapsed. The user specified timeout was set for ${userSpecifiedTimeout}`); } this.logger.error(`Device code expired. Expiration time of device code was ${deviceCodeExpirationTime}`); throw createClientAuthError(deviceCodeExpired); } return true; } /** * Creates token request with device code response and polls token endpoint at interval set by the device code response * @param request - developer provided CommonDeviceCodeRequest * @param deviceCodeResponse - DeviceCodeResponse returned by the security token service device code endpoint */ async acquireTokenWithDeviceCode(request, deviceCodeResponse) { const queryParametersString = this.createTokenQueryParameters(request); const endpoint = UrlString.appendQueryString(this.authority.tokenEndpoint, queryParametersString); const requestBody = this.createTokenRequestBody(request, deviceCodeResponse); const headers = this.createTokenRequestHeaders(); const userSpecifiedTimeout = request.timeout ? nowSeconds() + request.timeout : undefined; const deviceCodeExpirationTime = nowSeconds() + deviceCodeResponse.expiresIn; const pollingIntervalMilli = deviceCodeResponse.interval * 1000; /* * Poll token endpoint while (device code is not expired AND operation has not been cancelled by * setting CancellationToken.cancel = true). POST request is sent at interval set by pollingIntervalMilli */ while (this.continuePolling(deviceCodeExpirationTime, userSpecifiedTimeout, request.cancel)) { const thumbprint = { clientId: this.config.authOptions.clientId, authority: request.authority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; const response = await this.executePostToTokenEndpoint(endpoint, requestBody, headers, thumbprint, request.correlationId); if (response.body && response.body.error) { // user authorization is pending. Sleep for polling interval and try again if (response.body.error === Constants$1.AUTHORIZATION_PENDING) { this.logger.info("Authorization pending. Continue polling."); await delay(pollingIntervalMilli); } else { // for any other error, throw this.logger.info("Unexpected error in polling from the server"); throw createAuthError(postRequestFailed, response.body.error); } } else { this.logger.verbose("Authorization completed successfully. Polling stopped."); return response.body; } } /* * The above code should've thrown by this point, but to satisfy TypeScript, * and in the rare case the conditionals in continuePolling() may not catch everything... */ this.logger.error("Polling stopped for unknown reasons."); throw createClientAuthError(deviceCodeUnknownError); } /** * Creates query parameters and converts to string. * @param request - developer provided CommonDeviceCodeRequest * @param deviceCodeResponse - DeviceCodeResponse returned by the security token service device code endpoint */ createTokenRequestBody(request, deviceCodeResponse) { const requestParameters = new RequestParameterBuilder(); requestParameters.addScopes(request.scopes); requestParameters.addClientId(this.config.authOptions.clientId); requestParameters.addGrantType(GrantType.DEVICE_CODE_GRANT); requestParameters.addDeviceCode(deviceCodeResponse.deviceCode); const correlationId = request.correlationId || this.config.cryptoInterface.createNewGuid(); requestParameters.addCorrelationId(correlationId); requestParameters.addClientInfo(); requestParameters.addLibraryInfo(this.config.libraryInfo); requestParameters.addApplicationTelemetry(this.config.telemetry.application); requestParameters.addThrottling(); if (this.serverTelemetryManager) { requestParameters.addServerTelemetry(this.serverTelemetryManager); } if (!StringUtils.isEmptyObj(request.claims) || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { requestParameters.addClaims(request.claims, this.config.authOptions.clientCapabilities); } return requestParameters.createQueryString(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * This class is to be used to acquire tokens for public client applications (desktop, mobile). Public client applications * are not trusted to safely store application secrets, and therefore can only request tokens in the name of an user. * @public */ class PublicClientApplication extends ClientApplication { /** * Important attributes in the Configuration object for auth are: * - clientID: the application ID of your application. You can obtain one by registering your application with our Application registration portal. * - authority: the authority URL for your application. * * AAD authorities are of the form https://login.microsoftonline.com/\{Enter_the_Tenant_Info_Here\}. * - If your application supports Accounts in one organizational directory, replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant name (for example, contoso.microsoft.com). * - If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations. * - If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common. * - To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers. * * Azure B2C authorities are of the form https://\{instance\}/\{tenant\}/\{policy\}. Each policy is considered * its own authority. You will have to set the all of the knownAuthorities at the time of the client application * construction. * * ADFS authorities are of the form https://\{instance\}/adfs. */ constructor(configuration) { super(configuration); if (this.config.broker.nativeBrokerPlugin) { if (this.config.broker.nativeBrokerPlugin.isBrokerAvailable) { this.nativeBrokerPlugin = this.config.broker.nativeBrokerPlugin; this.nativeBrokerPlugin.setLogger(this.config.system.loggerOptions); } else { this.logger.warning("NativeBroker implementation was provided but the broker is unavailable."); } } this.skus = ServerTelemetryManager.makeExtraSkuString({ libraryName: Constants.MSAL_SKU, libraryVersion: version, }); } /** * Acquires a token from the authority using OAuth2.0 device code flow. * This flow is designed for devices that do not have access to a browser or have input constraints. * The authorization server issues a DeviceCode object with a verification code, an end-user code, * and the end-user verification URI. The DeviceCode object is provided through a callback, and the end-user should be * instructed to use another device to navigate to the verification URI to input credentials. * Since the client cannot receive incoming requests, it polls the authorization server repeatedly * until the end-user completes input of credentials. */ async acquireTokenByDeviceCode(request) { this.logger.info("acquireTokenByDeviceCode called", request.correlationId); const validRequest = Object.assign(request, await this.initializeBaseRequest(request)); const serverTelemetryManager = this.initializeServerTelemetryManager(ApiId.acquireTokenByDeviceCode, validRequest.correlationId); try { const deviceCodeConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, "", serverTelemetryManager, undefined, request.azureCloudOptions); const deviceCodeClient = new DeviceCodeClient(deviceCodeConfig); this.logger.verbose("Device code client created", validRequest.correlationId); return await deviceCodeClient.acquireToken(validRequest); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } serverTelemetryManager.cacheFailedRequest(e); throw e; } } /** * Acquires a token interactively via the browser by requesting an authorization code then exchanging it for a token. */ async acquireTokenInteractive(request) { const correlationId = request.correlationId || this.cryptoProvider.createNewGuid(); this.logger.trace("acquireTokenInteractive called", correlationId); const { openBrowser, successTemplate, errorTemplate, windowHandle, loopbackClient: customLoopbackClient, ...remainingProperties } = request; if (this.nativeBrokerPlugin) { const brokerRequest = { ...remainingProperties, clientId: this.config.auth.clientId, scopes: request.scopes || OIDC_DEFAULT_SCOPES, redirectUri: `${Constants.HTTP_PROTOCOL}${Constants.LOCALHOST}`, authority: request.authority || this.config.auth.authority, correlationId: correlationId, extraParameters: { ...remainingProperties.extraQueryParameters, ...remainingProperties.tokenQueryParameters, [X_CLIENT_EXTRA_SKU]: this.skus, }, accountId: remainingProperties.account?.nativeAccountId, }; return this.nativeBrokerPlugin.acquireTokenInteractive(brokerRequest, windowHandle); } const { verifier, challenge } = await this.cryptoProvider.generatePkceCodes(); const loopbackClient = customLoopbackClient || new LoopbackClient(); let authCodeResponse = {}; let authCodeListenerError = null; try { const authCodeListener = loopbackClient .listenForAuthCode(successTemplate, errorTemplate) .then((response) => { authCodeResponse = response; }) .catch((e) => { // Store the promise instead of throwing so we can control when its thrown authCodeListenerError = e; }); // Wait for server to be listening const redirectUri = await this.waitForRedirectUri(loopbackClient); const validRequest = { ...remainingProperties, correlationId: correlationId, scopes: request.scopes || OIDC_DEFAULT_SCOPES, redirectUri: redirectUri, responseMode: ResponseMode.QUERY, codeChallenge: challenge, codeChallengeMethod: CodeChallengeMethodValues.S256, }; const authCodeUrl = await this.getAuthCodeUrl(validRequest); await openBrowser(authCodeUrl); await authCodeListener; if (authCodeListenerError) { throw authCodeListenerError; } if (authCodeResponse.error) { throw new ServerError(authCodeResponse.error, authCodeResponse.error_description, authCodeResponse.suberror); } else if (!authCodeResponse.code) { throw NodeAuthError.createNoAuthCodeInResponseError(); } const clientInfo = authCodeResponse.client_info; const tokenRequest = { code: authCodeResponse.code, codeVerifier: verifier, clientInfo: clientInfo || Constants$1.EMPTY_STRING, ...validRequest, }; return await this.acquireTokenByCode(tokenRequest); // Await this so the server doesn't close prematurely } finally { loopbackClient.closeServer(); } } /** * Returns a token retrieved either from the cache or by exchanging the refresh token for a fresh access token. If brokering is enabled the token request will be serviced by the broker. * @param request - developer provided SilentFlowRequest * @returns */ async acquireTokenSilent(request) { const correlationId = request.correlationId || this.cryptoProvider.createNewGuid(); this.logger.trace("acquireTokenSilent called", correlationId); if (this.nativeBrokerPlugin) { const brokerRequest = { ...request, clientId: this.config.auth.clientId, scopes: request.scopes || OIDC_DEFAULT_SCOPES, redirectUri: `${Constants.HTTP_PROTOCOL}${Constants.LOCALHOST}`, authority: request.authority || this.config.auth.authority, correlationId: correlationId, extraParameters: { ...request.tokenQueryParameters, [X_CLIENT_EXTRA_SKU]: this.skus, }, accountId: request.account.nativeAccountId, forceRefresh: request.forceRefresh || false, }; return this.nativeBrokerPlugin.acquireTokenSilent(brokerRequest); } return super.acquireTokenSilent(request); } /** * Removes cache artifacts associated with the given account * @param request - developer provided SignOutRequest * @returns */ async signOut(request) { if (this.nativeBrokerPlugin && request.account.nativeAccountId) { const signoutRequest = { clientId: this.config.auth.clientId, accountId: request.account.nativeAccountId, correlationId: request.correlationId || this.cryptoProvider.createNewGuid(), }; await this.nativeBrokerPlugin.signOut(signoutRequest); } await this.getTokenCache().removeAccount(request.account); } /** * Returns all cached accounts for this application. If brokering is enabled this request will be serviced by the broker. * @returns */ async getAllAccounts() { if (this.nativeBrokerPlugin) { const correlationId = this.cryptoProvider.createNewGuid(); return this.nativeBrokerPlugin.getAllAccounts(this.config.auth.clientId, correlationId); } return this.getTokenCache().getAllAccounts(); } /** * Attempts to retrieve the redirectUri from the loopback server. If the loopback server does not start listening for requests within the timeout this will throw. * @param loopbackClient - developer provided custom loopback server implementation * @returns */ async waitForRedirectUri(loopbackClient) { return new Promise((resolve, reject) => { let ticks = 0; const id = setInterval(() => { if (LOOPBACK_SERVER_CONSTANTS.TIMEOUT_MS / LOOPBACK_SERVER_CONSTANTS.INTERVAL_MS < ticks) { clearInterval(id); reject(NodeAuthError.createLoopbackServerTimeoutError()); return; } try { const r = loopbackClient.getRedirectUri(); clearInterval(id); resolve(r); return; } catch (e) { if (e instanceof AuthError && e.errorCode === NodeAuthErrorMessage.noLoopbackServerExists.code) { // Loopback server is not listening yet ticks++; return; } clearInterval(id); reject(e); return; } }, LOOPBACK_SERVER_CONSTANTS.INTERVAL_MS); }); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * OAuth2.0 client credential grant * @public */ class ClientCredentialClient extends BaseClient { constructor(configuration, appTokenProvider) { super(configuration); this.appTokenProvider = appTokenProvider; } /** * Public API to acquire a token with ClientCredential Flow for Confidential clients * @param request - CommonClientCredentialRequest provided by the developer */ async acquireToken(request) { if (request.skipCache || request.claims) { return this.executeTokenRequest(request, this.authority); } const [cachedAuthenticationResult, lastCacheOutcome] = await this.getCachedAuthenticationResult(request, this.config, this.cryptoUtils, this.authority, this.cacheManager, this.serverTelemetryManager); if (cachedAuthenticationResult) { // if the token is not expired but must be refreshed; get a new one in the background if (lastCacheOutcome === CacheOutcome.PROACTIVELY_REFRESHED) { this.logger.info("ClientCredentialClient:getCachedAuthenticationResult - Cached access token's refreshOn property has been exceeded'. It's not expired, but must be refreshed."); // refresh the access token in the background const refreshAccessToken = true; await this.executeTokenRequest(request, this.authority, refreshAccessToken); } // return the cached token return cachedAuthenticationResult; } else { return this.executeTokenRequest(request, this.authority); } } /** * looks up cache if the tokens are cached already */ async getCachedAuthenticationResult(request, config, cryptoUtils, authority, cacheManager, serverTelemetryManager) { const clientConfiguration = config; const managedIdentityConfiguration = config; let lastCacheOutcome = CacheOutcome.NOT_APPLICABLE; // read the user-supplied cache into memory, if applicable let cacheContext; if (clientConfiguration.serializableCache && clientConfiguration.persistencePlugin) { cacheContext = new TokenCacheContext(clientConfiguration.serializableCache, false); await clientConfiguration.persistencePlugin.beforeCacheAccess(cacheContext); } const cachedAccessToken = this.readAccessTokenFromCache(authority, managedIdentityConfiguration.managedIdentityId?.id || clientConfiguration.authOptions.clientId, new ScopeSet(request.scopes || []), cacheManager); if (clientConfiguration.serializableCache && clientConfiguration.persistencePlugin && cacheContext) { await clientConfiguration.persistencePlugin.afterCacheAccess(cacheContext); } // must refresh due to non-existent access_token if (!cachedAccessToken) { serverTelemetryManager?.setCacheOutcome(CacheOutcome.NO_CACHED_ACCESS_TOKEN); return [null, CacheOutcome.NO_CACHED_ACCESS_TOKEN]; } // must refresh due to the expires_in value if (isTokenExpired(cachedAccessToken.expiresOn, clientConfiguration.systemOptions?.tokenRenewalOffsetSeconds || DEFAULT_TOKEN_RENEWAL_OFFSET_SEC)) { serverTelemetryManager?.setCacheOutcome(CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED); return [null, CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED]; } // must refresh (in the background) due to the refresh_in value if (cachedAccessToken.refreshOn && isTokenExpired(cachedAccessToken.refreshOn.toString(), 0)) { lastCacheOutcome = CacheOutcome.PROACTIVELY_REFRESHED; serverTelemetryManager?.setCacheOutcome(CacheOutcome.PROACTIVELY_REFRESHED); } return [ await ResponseHandler.generateAuthenticationResult(cryptoUtils, authority, { account: null, idToken: null, accessToken: cachedAccessToken, refreshToken: null, appMetadata: null, }, true, request), lastCacheOutcome, ]; } /** * Reads access token from the cache */ readAccessTokenFromCache(authority, id, scopeSet, cacheManager) { const accessTokenFilter = { homeAccountId: Constants$1.EMPTY_STRING, environment: authority.canonicalAuthorityUrlComponents.HostNameAndPort, credentialType: CredentialType.ACCESS_TOKEN, clientId: id, realm: authority.tenant, target: ScopeSet.createSearchScopes(scopeSet.asArray()), }; const accessTokens = cacheManager.getAccessTokensByFilter(accessTokenFilter); if (accessTokens.length < 1) { return null; } else if (accessTokens.length > 1) { throw createClientAuthError(multipleMatchingTokens); } return accessTokens[0]; } /** * Makes a network call to request the token from the service * @param request - CommonClientCredentialRequest provided by the developer * @param authority - authority object */ async executeTokenRequest(request, authority, refreshAccessToken) { let serverTokenResponse; let reqTimestamp; if (this.appTokenProvider) { this.logger.info("Using appTokenProvider extensibility."); const appTokenPropviderParameters = { correlationId: request.correlationId, tenantId: this.config.authOptions.authority.tenant, scopes: request.scopes, claims: request.claims, }; reqTimestamp = nowSeconds(); const appTokenProviderResult = await this.appTokenProvider(appTokenPropviderParameters); serverTokenResponse = { access_token: appTokenProviderResult.accessToken, expires_in: appTokenProviderResult.expiresInSeconds, refresh_in: appTokenProviderResult.refreshInSeconds, token_type: AuthenticationScheme.BEARER, }; } else { const queryParametersString = this.createTokenQueryParameters(request); const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString); const requestBody = await this.createTokenRequestBody(request); const headers = this.createTokenRequestHeaders(); const thumbprint = { clientId: this.config.authOptions.clientId, authority: request.authority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; this.logger.info("Sending token request to endpoint: " + authority.tokenEndpoint); reqTimestamp = nowSeconds(); const response = await this.executePostToTokenEndpoint(endpoint, requestBody, headers, thumbprint, request.correlationId); serverTokenResponse = response.body; serverTokenResponse.status = response.status; } const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin); responseHandler.validateTokenResponse(serverTokenResponse, refreshAccessToken); const tokenResponse = await responseHandler.handleServerTokenResponse(serverTokenResponse, this.authority, reqTimestamp, request); return tokenResponse; } /** * generate the request to the server in the acceptable format * @param request - CommonClientCredentialRequest provided by the developer */ async createTokenRequestBody(request) { const parameterBuilder = new RequestParameterBuilder(); parameterBuilder.addClientId(this.config.authOptions.clientId); parameterBuilder.addScopes(request.scopes, false); parameterBuilder.addGrantType(GrantType.CLIENT_CREDENTIALS_GRANT); parameterBuilder.addLibraryInfo(this.config.libraryInfo); parameterBuilder.addApplicationTelemetry(this.config.telemetry.application); parameterBuilder.addThrottling(); if (this.serverTelemetryManager) { parameterBuilder.addServerTelemetry(this.serverTelemetryManager); } const correlationId = request.correlationId || this.config.cryptoInterface.createNewGuid(); parameterBuilder.addCorrelationId(correlationId); if (this.config.clientCredentials.clientSecret) { parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret); } // Use clientAssertion from request, fallback to client assertion in base configuration const clientAssertion = request.clientAssertion || this.config.clientCredentials.clientAssertion; if (clientAssertion) { parameterBuilder.addClientAssertion(await getClientAssertion(clientAssertion.assertion, this.config.authOptions.clientId, request.resourceRequestUri)); parameterBuilder.addClientAssertionType(clientAssertion.assertionType); } if (!StringUtils.isEmptyObj(request.claims) || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } return parameterBuilder.createQueryString(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * On-Behalf-Of client * @public */ class OnBehalfOfClient extends BaseClient { constructor(configuration) { super(configuration); } /** * Public API to acquire tokens with on behalf of flow * @param request - developer provided CommonOnBehalfOfRequest */ async acquireToken(request) { this.scopeSet = new ScopeSet(request.scopes || []); // generate the user_assertion_hash for OBOAssertion this.userAssertionHash = await this.cryptoUtils.hashString(request.oboAssertion); if (request.skipCache || request.claims) { return this.executeTokenRequest(request, this.authority, this.userAssertionHash); } try { return await this.getCachedAuthenticationResult(request); } catch (e) { // Any failure falls back to interactive request, once we implement distributed cache, we plan to handle `createRefreshRequiredError` to refresh using the RT return await this.executeTokenRequest(request, this.authority, this.userAssertionHash); } } /** * look up cache for tokens * Find idtoken in the cache * Find accessToken based on user assertion and account info in the cache * Please note we are not yet supported OBO tokens refreshed with long lived RT. User will have to send a new assertion if the current access token expires * This is to prevent security issues when the assertion changes over time, however, longlived RT helps retaining the session * @param request - developer provided CommonOnBehalfOfRequest */ async getCachedAuthenticationResult(request) { // look in the cache for the access_token which matches the incoming_assertion const cachedAccessToken = this.readAccessTokenFromCacheForOBO(this.config.authOptions.clientId, request); if (!cachedAccessToken) { // Must refresh due to non-existent access_token. this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.NO_CACHED_ACCESS_TOKEN); this.logger.info("SilentFlowClient:acquireCachedToken - No access token found in cache for the given properties."); throw createClientAuthError(tokenRefreshRequired); } else if (isTokenExpired(cachedAccessToken.expiresOn, this.config.systemOptions.tokenRenewalOffsetSeconds)) { // Access token expired, will need to renewed this.serverTelemetryManager?.setCacheOutcome(CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED); this.logger.info(`OnbehalfofFlow:getCachedAuthenticationResult - Cached access token is expired or will expire within ${this.config.systemOptions.tokenRenewalOffsetSeconds} seconds.`); throw createClientAuthError(tokenRefreshRequired); } // fetch the idToken from cache const cachedIdToken = this.readIdTokenFromCacheForOBO(cachedAccessToken.homeAccountId); let idTokenClaims; let cachedAccount = null; if (cachedIdToken) { idTokenClaims = extractTokenClaims(cachedIdToken.secret, EncodingUtils.base64Decode); const localAccountId = idTokenClaims.oid || idTokenClaims.sub; const accountInfo = { homeAccountId: cachedIdToken.homeAccountId, environment: cachedIdToken.environment, tenantId: cachedIdToken.realm, username: Constants$1.EMPTY_STRING, localAccountId: localAccountId || Constants$1.EMPTY_STRING, }; cachedAccount = this.cacheManager.readAccountFromCache(accountInfo); } // increment telemetry cache hit counter if (this.config.serverTelemetryManager) { this.config.serverTelemetryManager.incrementCacheHits(); } return ResponseHandler.generateAuthenticationResult(this.cryptoUtils, this.authority, { account: cachedAccount, accessToken: cachedAccessToken, idToken: cachedIdToken, refreshToken: null, appMetadata: null, }, true, request, idTokenClaims); } /** * read idtoken from cache, this is a specific implementation for OBO as the requirements differ from a generic lookup in the cacheManager * Certain use cases of OBO flow do not expect an idToken in the cache/or from the service * @param atHomeAccountId - account id */ readIdTokenFromCacheForOBO(atHomeAccountId) { const idTokenFilter = { homeAccountId: atHomeAccountId, environment: this.authority.canonicalAuthorityUrlComponents.HostNameAndPort, credentialType: CredentialType.ID_TOKEN, clientId: this.config.authOptions.clientId, realm: this.authority.tenant, }; const idTokenMap = this.cacheManager.getIdTokensByFilter(idTokenFilter); // When acquiring a token on behalf of an application, there might not be an id token in the cache if (Object.values(idTokenMap).length < 1) { return null; } return Object.values(idTokenMap)[0]; } /** * Fetches the cached access token based on incoming assertion * @param clientId - client id * @param request - developer provided CommonOnBehalfOfRequest */ readAccessTokenFromCacheForOBO(clientId, request) { 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 = { credentialType: credentialType, clientId, target: ScopeSet.createSearchScopes(this.scopeSet.asArray()), tokenType: authScheme, keyId: request.sshKid, requestedClaimsHash: request.requestedClaimsHash, userAssertionHash: this.userAssertionHash, }; const accessTokens = this.cacheManager.getAccessTokensByFilter(accessTokenFilter); const numAccessTokens = accessTokens.length; if (numAccessTokens < 1) { return null; } else if (numAccessTokens > 1) { throw createClientAuthError(multipleMatchingTokens); } return accessTokens[0]; } /** * Make a network call to the server requesting credentials * @param request - developer provided CommonOnBehalfOfRequest * @param authority - authority object */ async executeTokenRequest(request, authority, userAssertionHash) { const queryParametersString = this.createTokenQueryParameters(request); const endpoint = UrlString.appendQueryString(authority.tokenEndpoint, queryParametersString); const requestBody = await this.createTokenRequestBody(request); const headers = this.createTokenRequestHeaders(); const thumbprint = { clientId: this.config.authOptions.clientId, authority: request.authority, scopes: request.scopes, claims: request.claims, authenticationScheme: request.authenticationScheme, resourceRequestMethod: request.resourceRequestMethod, resourceRequestUri: request.resourceRequestUri, shrClaims: request.shrClaims, sshKid: request.sshKid, }; const reqTimestamp = nowSeconds(); const response = await this.executePostToTokenEndpoint(endpoint, requestBody, headers, thumbprint, request.correlationId); const responseHandler = new ResponseHandler(this.config.authOptions.clientId, this.cacheManager, this.cryptoUtils, this.logger, this.config.serializableCache, this.config.persistencePlugin); responseHandler.validateTokenResponse(response.body); const tokenResponse = await responseHandler.handleServerTokenResponse(response.body, this.authority, reqTimestamp, request, undefined, userAssertionHash); return tokenResponse; } /** * generate a server request in accepable format * @param request - developer provided CommonOnBehalfOfRequest */ async createTokenRequestBody(request) { const parameterBuilder = new RequestParameterBuilder(); parameterBuilder.addClientId(this.config.authOptions.clientId); parameterBuilder.addScopes(request.scopes); parameterBuilder.addGrantType(GrantType.JWT_BEARER); parameterBuilder.addClientInfo(); parameterBuilder.addLibraryInfo(this.config.libraryInfo); parameterBuilder.addApplicationTelemetry(this.config.telemetry.application); parameterBuilder.addThrottling(); if (this.serverTelemetryManager) { parameterBuilder.addServerTelemetry(this.serverTelemetryManager); } const correlationId = request.correlationId || this.config.cryptoInterface.createNewGuid(); parameterBuilder.addCorrelationId(correlationId); parameterBuilder.addRequestTokenUse(ON_BEHALF_OF); parameterBuilder.addOboAssertion(request.oboAssertion); if (this.config.clientCredentials.clientSecret) { parameterBuilder.addClientSecret(this.config.clientCredentials.clientSecret); } const clientAssertion = this.config.clientCredentials.clientAssertion; if (clientAssertion) { parameterBuilder.addClientAssertion(await getClientAssertion(clientAssertion.assertion, this.config.authOptions.clientId, request.resourceRequestUri)); parameterBuilder.addClientAssertionType(clientAssertion.assertionType); } if (request.claims || (this.config.authOptions.clientCapabilities && this.config.authOptions.clientCapabilities.length > 0)) { parameterBuilder.addClaims(request.claims, this.config.authOptions.clientCapabilities); } return parameterBuilder.createQueryString(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ // AADAuthorityConstants /** * This class is to be used to acquire tokens for confidential client applications (webApp, webAPI). Confidential client applications * will configure application secrets, client certificates/assertions as applicable * @public */ class ConfidentialClientApplication extends ClientApplication { /** * Constructor for the ConfidentialClientApplication * * Required attributes in the Configuration object are: * - clientID: the application ID of your application. You can obtain one by registering your application with our application registration portal * - authority: the authority URL for your application. * - client credential: Must set either client secret, certificate, or assertion for confidential clients. You can obtain a client secret from the application registration portal. * * In Azure AD, authority is a URL indicating of the form https://login.microsoftonline.com/\{Enter_the_Tenant_Info_Here\}. * If your application supports Accounts in one organizational directory, replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant name (for example, contoso.microsoft.com). * If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations. * If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common. * To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers. * * In Azure B2C, authority is of the form https://\{instance\}/tfp/\{tenant\}/\{policyName\}/ * Full B2C functionality will be available in this library in future versions. * * @param Configuration - configuration object for the MSAL ConfidentialClientApplication instance */ constructor(configuration) { super(configuration); this.setClientCredential(); this.appTokenProvider = undefined; } /** * This extensibility point only works for the client_credential flow, i.e. acquireTokenByClientCredential and * is meant for Azure SDK to enhance Managed Identity support. * * @param IAppTokenProvider - Extensibility interface, which allows the app developer to return a token from a custom source. */ SetAppTokenProvider(provider) { this.appTokenProvider = provider; } /** * Acquires tokens from the authority for the application (not for an end user). */ async acquireTokenByClientCredential(request) { this.logger.info("acquireTokenByClientCredential called", request.correlationId); // If there is a client assertion present in the request, it overrides the one present in the client configuration let clientAssertion; if (request.clientAssertion) { clientAssertion = { assertion: await getClientAssertion(request.clientAssertion, this.config.auth.clientId // tokenEndpoint will be undefined. resourceRequestUri is omitted in ClientCredentialRequest ), assertionType: Constants.JWT_BEARER_ASSERTION_TYPE, }; } const baseRequest = await this.initializeBaseRequest(request); // valid base request should not contain oidc scopes in this grant type const validBaseRequest = { ...baseRequest, scopes: baseRequest.scopes.filter((scope) => !OIDC_DEFAULT_SCOPES.includes(scope)), }; const validRequest = { ...request, ...validBaseRequest, clientAssertion, }; /* * valid request should not have "common" or "organizations" in lieu of the tenant_id in the authority in the auth configuration * example authority: "https://login.microsoftonline.com/TenantId", */ const authority = new UrlString(validRequest.authority); const tenantId = authority.getUrlComponents().PathSegments[0]; if (Object.values(AADAuthorityConstants).includes(tenantId)) { throw createClientAuthError(missingTenantIdError); } /* * if this env variable is set, and the developer provided region isn't defined and isn't "DisableMsalForceRegion", * MSAL shall opt-in to ESTS-R with the value of this variable */ const ENV_MSAL_FORCE_REGION = process.env[MSAL_FORCE_REGION]; let region; if (validRequest.azureRegion !== "DisableMsalForceRegion") { if (!validRequest.azureRegion && ENV_MSAL_FORCE_REGION) { region = ENV_MSAL_FORCE_REGION; } else { region = validRequest.azureRegion; } } const azureRegionConfiguration = { azureRegion: region, environmentRegion: process.env[REGION_ENVIRONMENT_VARIABLE], }; const serverTelemetryManager = this.initializeServerTelemetryManager(ApiId.acquireTokenByClientCredential, validRequest.correlationId, validRequest.skipCache); try { const clientCredentialConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, "", serverTelemetryManager, azureRegionConfiguration, request.azureCloudOptions); const clientCredentialClient = new ClientCredentialClient(clientCredentialConfig, this.appTokenProvider); this.logger.verbose("Client credential client created", validRequest.correlationId); return await clientCredentialClient.acquireToken(validRequest); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } serverTelemetryManager.cacheFailedRequest(e); throw e; } } /** * Acquires tokens from the authority for the application. * * Used in scenarios where the current app is a middle-tier service which was called with a token * representing an end user. The current app can use the token (oboAssertion) to request another * token to access downstream web API, on behalf of that user. * * The current middle-tier app has no user interaction to obtain consent. * See how to gain consent upfront for your middle-tier app from this article. * https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application */ async acquireTokenOnBehalfOf(request) { this.logger.info("acquireTokenOnBehalfOf called", request.correlationId); const validRequest = { ...request, ...(await this.initializeBaseRequest(request)), }; try { const onBehalfOfConfig = await this.buildOauthClientConfiguration(validRequest.authority, validRequest.correlationId, "", undefined, undefined, request.azureCloudOptions); const oboClient = new OnBehalfOfClient(onBehalfOfConfig); this.logger.verbose("On behalf of client created", validRequest.correlationId); return await oboClient.acquireToken(validRequest); } catch (e) { if (e instanceof AuthError) { e.setCorrelationId(validRequest.correlationId); } throw e; } } setClientCredential() { const clientSecretNotEmpty = !!this.config.auth.clientSecret; const clientAssertionNotEmpty = !!this.config.auth.clientAssertion; const certificateNotEmpty = (!!this.config.auth.clientCertificate?.thumbprint || !!this.config.auth.clientCertificate?.thumbprintSha256) && !!this.config.auth.clientCertificate?.privateKey; /* * If app developer configures this callback, they don't need a credential * i.e. AzureSDK can get token from Managed Identity without a cert / secret */ if (this.appTokenProvider) { return; } // Check that at most one credential is set on the application if ((clientSecretNotEmpty && clientAssertionNotEmpty) || (clientAssertionNotEmpty && certificateNotEmpty) || (clientSecretNotEmpty && certificateNotEmpty)) { throw createClientAuthError(invalidClientCredential); } if (this.config.auth.clientSecret) { this.clientSecret = this.config.auth.clientSecret; return; } if (this.config.auth.clientAssertion) { this.developerProvidedClientAssertion = this.config.auth.clientAssertion; return; } if (!certificateNotEmpty) { throw createClientAuthError(invalidClientCredential); } else { this.clientAssertion = !!this.config.auth.clientCertificate .thumbprintSha256 ? ClientAssertion.fromCertificateWithSha256Thumbprint(this.config.auth.clientCertificate.thumbprintSha256, this.config.auth.clientCertificate.privateKey, this.config.auth.clientCertificate.x5c) : ClientAssertion.fromCertificate( // guaranteed to be a string, due to prior error checking in this function this.config.auth.clientCertificate.thumbprint, this.config.auth.clientCertificate.privateKey, this.config.auth.clientCertificate.x5c); } } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Managed Identity User Assigned Id Query Parameter Names */ const ManagedIdentityUserAssignedIdQueryParameterNames = { MANAGED_IDENTITY_CLIENT_ID: "client_id", MANAGED_IDENTITY_OBJECT_ID: "object_id", MANAGED_IDENTITY_RESOURCE_ID: "mi_res_id", }; class BaseManagedIdentitySource { constructor(logger, nodeStorage, networkClient, cryptoProvider) { this.logger = logger; this.nodeStorage = nodeStorage; this.networkClient = networkClient; this.cryptoProvider = cryptoProvider; } async getServerTokenResponseAsync(response, // eslint-disable-next-line @typescript-eslint/no-unused-vars _networkClient, // eslint-disable-next-line @typescript-eslint/no-unused-vars _networkRequest, // eslint-disable-next-line @typescript-eslint/no-unused-vars _networkRequestOptions) { return this.getServerTokenResponse(response); } getServerTokenResponse(response) { let refreshIn, expiresIn; if (response.body.expires_on) { expiresIn = response.body.expires_on - nowSeconds(); // compute refresh_in as 1/2 of expires_in, but only if expires_in > 2h if (expiresIn > 2 * 3600) { refreshIn = expiresIn / 2; } } const serverTokenResponse = { status: response.status, // success access_token: response.body.access_token, expires_in: expiresIn, scope: response.body.resource, token_type: response.body.token_type, refresh_in: refreshIn, // error correlation_id: response.body.correlation_id || response.body.correlationId, error: typeof response.body.error === "string" ? response.body.error : response.body.error?.code, error_description: response.body.message || (typeof response.body.error === "string" ? response.body.error_description : response.body.error?.message), error_codes: response.body.error_codes, timestamp: response.body.timestamp, trace_id: response.body.trace_id, }; return serverTokenResponse; } async acquireTokenWithManagedIdentity(managedIdentityRequest, managedIdentityId, fakeAuthority, refreshAccessToken) { const networkRequest = this.createRequest(managedIdentityRequest.resource, managedIdentityId); const headers = networkRequest.headers; headers[HeaderNames.CONTENT_TYPE] = Constants$1.URL_FORM_CONTENT_TYPE; const networkRequestOptions = { headers }; if (Object.keys(networkRequest.bodyParameters).length) { networkRequestOptions.body = networkRequest.computeParametersBodyString(); } const reqTimestamp = nowSeconds(); let response; try { // Sources that send POST requests: Cloud Shell if (networkRequest.httpMethod === HttpMethod.POST) { response = await this.networkClient.sendPostRequestAsync(networkRequest.computeUri(), networkRequestOptions); // Sources that send GET requests: App Service, Azure Arc, IMDS, Service Fabric } else { response = await this.networkClient.sendGetRequestAsync(networkRequest.computeUri(), networkRequestOptions); } } catch (error) { if (error instanceof AuthError) { throw error; } else { throw createClientAuthError(networkError); } } const responseHandler = new ResponseHandler(managedIdentityId.id, this.nodeStorage, this.cryptoProvider, this.logger, null, null); const serverTokenResponse = await this.getServerTokenResponseAsync(response, this.networkClient, networkRequest, networkRequestOptions); responseHandler.validateTokenResponse(serverTokenResponse, refreshAccessToken); // caches the token return responseHandler.handleServerTokenResponse(serverTokenResponse, fakeAuthority, reqTimestamp, managedIdentityRequest); } getManagedIdentityUserAssignedIdQueryParameterKey(managedIdentityIdType) { switch (managedIdentityIdType) { case ManagedIdentityIdType.USER_ASSIGNED_CLIENT_ID: this.logger.info("[Managed Identity] Adding user assigned client id to the request."); return ManagedIdentityUserAssignedIdQueryParameterNames.MANAGED_IDENTITY_CLIENT_ID; case ManagedIdentityIdType.USER_ASSIGNED_RESOURCE_ID: this.logger.info("[Managed Identity] Adding user assigned resource id to the request."); return ManagedIdentityUserAssignedIdQueryParameterNames.MANAGED_IDENTITY_RESOURCE_ID; case ManagedIdentityIdType.USER_ASSIGNED_OBJECT_ID: this.logger.info("[Managed Identity] Adding user assigned object id to the request."); return ManagedIdentityUserAssignedIdQueryParameterNames.MANAGED_IDENTITY_OBJECT_ID; default: throw createManagedIdentityError(invalidManagedIdentityIdType); } } } BaseManagedIdentitySource.getValidatedEnvVariableUrlString = (envVariableStringName, envVariable, sourceName, logger) => { try { return new UrlString(envVariable).urlString; } catch (error) { logger.info(`[Managed Identity] ${sourceName} managed identity is unavailable because the '${envVariableStringName}' environment variable is malformed.`); throw createManagedIdentityError(MsiEnvironmentVariableUrlMalformedErrorCodes[envVariableStringName]); } }; /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ class ManagedIdentityRequestParameters { constructor(httpMethod, endpoint) { this.httpMethod = httpMethod; this._baseEndpoint = endpoint; this.headers = {}; this.bodyParameters = {}; this.queryParameters = {}; } computeUri() { const parameterBuilder = new RequestParameterBuilder(); if (this.queryParameters) { parameterBuilder.addExtraQueryParameters(this.queryParameters); } const queryParametersString = parameterBuilder.createQueryString(); return UrlString.appendQueryString(this._baseEndpoint, queryParametersString); } computeParametersBodyString() { const parameterBuilder = new RequestParameterBuilder(); if (this.bodyParameters) { parameterBuilder.addExtraQueryParameters(this.bodyParameters); } return parameterBuilder.createQueryString(); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ // MSI Constants. Docs for MSI are available here https://docs.microsoft.com/azure/app-service/overview-managed-identity const APP_SERVICE_MSI_API_VERSION = "2019-08-01"; /** * Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/AppServiceManagedIdentitySource.cs */ class AppService extends BaseManagedIdentitySource { constructor(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint, identityHeader) { super(logger, nodeStorage, networkClient, cryptoProvider); this.identityEndpoint = identityEndpoint; this.identityHeader = identityHeader; } static getEnvironmentVariables() { const identityEndpoint = process.env[ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT]; const identityHeader = process.env[ManagedIdentityEnvironmentVariableNames.IDENTITY_HEADER]; return [identityEndpoint, identityHeader]; } static tryCreate(logger, nodeStorage, networkClient, cryptoProvider) { const [identityEndpoint, identityHeader] = AppService.getEnvironmentVariables(); // if either of the identity endpoint or identity header variables are undefined, this MSI provider is unavailable. if (!identityEndpoint || !identityHeader) { logger.info(`[Managed Identity] ${ManagedIdentitySourceNames.APP_SERVICE} managed identity is unavailable because one or both of the '${ManagedIdentityEnvironmentVariableNames.IDENTITY_HEADER}' and '${ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT}' environment variables are not defined.`); return null; } const validatedIdentityEndpoint = AppService.getValidatedEnvVariableUrlString(ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT, identityEndpoint, ManagedIdentitySourceNames.APP_SERVICE, logger); logger.info(`[Managed Identity] Environment variables validation passed for ${ManagedIdentitySourceNames.APP_SERVICE} managed identity. Endpoint URI: ${validatedIdentityEndpoint}. Creating ${ManagedIdentitySourceNames.APP_SERVICE} managed identity.`); return new AppService(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint, identityHeader); } createRequest(resource, managedIdentityId) { const request = new ManagedIdentityRequestParameters(HttpMethod.GET, this.identityEndpoint); request.headers[APP_SERVICE_SECRET_HEADER_NAME] = this.identityHeader; request.queryParameters[API_VERSION_QUERY_PARAMETER_NAME] = APP_SERVICE_MSI_API_VERSION; request.queryParameters[RESOURCE_BODY_OR_QUERY_PARAMETER_NAME] = resource; if (managedIdentityId.idType !== ManagedIdentityIdType.SYSTEM_ASSIGNED) { request.queryParameters[this.getManagedIdentityUserAssignedIdQueryParameterKey(managedIdentityId.idType)] = managedIdentityId.id; } // bodyParameters calculated in BaseManagedIdentity.acquireTokenWithManagedIdentity return request; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ const ARC_API_VERSION = "2019-11-01"; const DEFAULT_AZURE_ARC_IDENTITY_ENDPOINT = "http://127.0.0.1:40342/metadata/identity/oauth2/token"; const HIMDS_EXECUTABLE_HELPER_STRING = "N/A: himds executable exists"; const SUPPORTED_AZURE_ARC_PLATFORMS = { win32: `${process.env["ProgramData"]}\\AzureConnectedMachineAgent\\Tokens\\`, linux: "/var/opt/azcmagent/tokens/", }; const AZURE_ARC_FILE_DETECTION = { win32: `${process.env["ProgramFiles"]}\\AzureConnectedMachineAgent\\himds.exe`, linux: "/opt/azcmagent/bin/himds", }; /** * Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/AzureArcManagedIdentitySource.cs */ class AzureArc extends BaseManagedIdentitySource { constructor(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint) { super(logger, nodeStorage, networkClient, cryptoProvider); this.identityEndpoint = identityEndpoint; } static getEnvironmentVariables() { let identityEndpoint = process.env[ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT]; let imdsEndpoint = process.env[ManagedIdentityEnvironmentVariableNames.IMDS_ENDPOINT]; // if either of the identity or imds endpoints are undefined, check if the himds executable exists if (!identityEndpoint || !imdsEndpoint) { // get the expected Windows or Linux file path of the himds executable const fileDetectionPath = AZURE_ARC_FILE_DETECTION[process.platform]; try { /* * check if the himds executable exists and its permissions allow it to be read * returns undefined if true, throws an error otherwise */ fs.accessSync(fileDetectionPath, fs.constants.F_OK | fs.constants.R_OK); identityEndpoint = DEFAULT_AZURE_ARC_IDENTITY_ENDPOINT; imdsEndpoint = HIMDS_EXECUTABLE_HELPER_STRING; } catch (err) { /* * do nothing * accessSync returns undefined on success, and throws an error on failure */ } } return [identityEndpoint, imdsEndpoint]; } static tryCreate(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) { const [identityEndpoint, imdsEndpoint] = AzureArc.getEnvironmentVariables(); // if either of the identity or imds endpoints are undefined (even after himds file detection) if (!identityEndpoint || !imdsEndpoint) { logger.info(`[Managed Identity] ${ManagedIdentitySourceNames.AZURE_ARC} managed identity is unavailable through environment variables because one or both of '${ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT}' and '${ManagedIdentityEnvironmentVariableNames.IMDS_ENDPOINT}' are not defined. ${ManagedIdentitySourceNames.AZURE_ARC} managed identity is also unavailable through file detection.`); return null; } // check if the imds endpoint is set to the default for file detection if (imdsEndpoint === HIMDS_EXECUTABLE_HELPER_STRING) { logger.info(`[Managed Identity] ${ManagedIdentitySourceNames.AZURE_ARC} managed identity is available through file detection. Defaulting to known ${ManagedIdentitySourceNames.AZURE_ARC} endpoint: ${DEFAULT_AZURE_ARC_IDENTITY_ENDPOINT}. Creating ${ManagedIdentitySourceNames.AZURE_ARC} managed identity.`); } else { // otherwise, both the identity and imds endpoints are defined without file detection; validate them const validatedIdentityEndpoint = AzureArc.getValidatedEnvVariableUrlString(ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT, identityEndpoint, ManagedIdentitySourceNames.AZURE_ARC, logger); // remove trailing slash validatedIdentityEndpoint.endsWith("/") ? validatedIdentityEndpoint.slice(0, -1) : validatedIdentityEndpoint; AzureArc.getValidatedEnvVariableUrlString(ManagedIdentityEnvironmentVariableNames.IMDS_ENDPOINT, imdsEndpoint, ManagedIdentitySourceNames.AZURE_ARC, logger); logger.info(`[Managed Identity] Environment variables validation passed for ${ManagedIdentitySourceNames.AZURE_ARC} managed identity. Endpoint URI: ${validatedIdentityEndpoint}. Creating ${ManagedIdentitySourceNames.AZURE_ARC} managed identity.`); } if (managedIdentityId.idType !== ManagedIdentityIdType.SYSTEM_ASSIGNED) { throw createManagedIdentityError(unableToCreateAzureArc); } return new AzureArc(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint); } createRequest(resource) { const request = new ManagedIdentityRequestParameters(HttpMethod.GET, this.identityEndpoint.replace("localhost", "127.0.0.1")); request.headers[METADATA_HEADER_NAME] = "true"; request.queryParameters[API_VERSION_QUERY_PARAMETER_NAME] = ARC_API_VERSION; request.queryParameters[RESOURCE_BODY_OR_QUERY_PARAMETER_NAME] = resource; // bodyParameters calculated in BaseManagedIdentity.acquireTokenWithManagedIdentity return request; } async getServerTokenResponseAsync(originalResponse, networkClient, networkRequest, networkRequestOptions) { let retryResponse; if (originalResponse.status === HttpStatus.UNAUTHORIZED) { const wwwAuthHeader = originalResponse.headers["www-authenticate"]; if (!wwwAuthHeader) { throw createManagedIdentityError(wwwAuthenticateHeaderMissing); } if (!wwwAuthHeader.includes("Basic realm=")) { throw createManagedIdentityError(wwwAuthenticateHeaderUnsupportedFormat); } const secretFilePath = wwwAuthHeader.split("Basic realm=")[1]; // throw an error if the managed identity application is not being run on Windows or Linux if (!SUPPORTED_AZURE_ARC_PLATFORMS.hasOwnProperty(process.platform)) { throw createManagedIdentityError(platformNotSupported); } // get the expected Windows or Linux file path const expectedSecretFilePath = SUPPORTED_AZURE_ARC_PLATFORMS[process.platform]; // throw an error if the file in the file path is not a .key file const fileName = path.basename(secretFilePath); if (!fileName.endsWith(".key")) { throw createManagedIdentityError(invalidFileExtension); } /* * throw an error if the file path from the www-authenticate header does not match the * expected file path for the platform (Windows or Linux) the managed identity application * is running on */ if (expectedSecretFilePath + fileName !== secretFilePath) { throw createManagedIdentityError(invalidFilePath); } let secretFileSize; // attempt to get the secret file's size, in bytes try { secretFileSize = await fs.statSync(secretFilePath).size; } catch (e) { throw createManagedIdentityError(unableToReadSecretFile); } // throw an error if the secret file's size is greater than 4096 bytes if (secretFileSize > AZURE_ARC_SECRET_FILE_MAX_SIZE_BYTES) { throw createManagedIdentityError(invalidSecret); } // attempt to read the contents of the secret file let secret; try { secret = fs.readFileSync(secretFilePath, "utf-8"); } catch (e) { throw createManagedIdentityError(unableToReadSecretFile); } const authHeaderValue = `Basic ${secret}`; this.logger.info(`[Managed Identity] Adding authorization header to the request.`); networkRequest.headers[AUTHORIZATION_HEADER_NAME] = authHeaderValue; try { retryResponse = await networkClient.sendGetRequestAsync(networkRequest.computeUri(), networkRequestOptions); } catch (error) { if (error instanceof AuthError) { throw error; } else { throw createClientAuthError(networkError); } } } return this.getServerTokenResponse(retryResponse || originalResponse); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/CloudShellManagedIdentitySource.cs */ class CloudShell extends BaseManagedIdentitySource { constructor(logger, nodeStorage, networkClient, cryptoProvider, msiEndpoint) { super(logger, nodeStorage, networkClient, cryptoProvider); this.msiEndpoint = msiEndpoint; } static getEnvironmentVariables() { const msiEndpoint = process.env[ManagedIdentityEnvironmentVariableNames.MSI_ENDPOINT]; return [msiEndpoint]; } static tryCreate(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) { const [msiEndpoint] = CloudShell.getEnvironmentVariables(); // if the msi endpoint environment variable is undefined, this MSI provider is unavailable. if (!msiEndpoint) { logger.info(`[Managed Identity] ${ManagedIdentitySourceNames.CLOUD_SHELL} managed identity is unavailable because the '${ManagedIdentityEnvironmentVariableNames.MSI_ENDPOINT} environment variable is not defined.`); return null; } const validatedMsiEndpoint = CloudShell.getValidatedEnvVariableUrlString(ManagedIdentityEnvironmentVariableNames.MSI_ENDPOINT, msiEndpoint, ManagedIdentitySourceNames.CLOUD_SHELL, logger); logger.info(`[Managed Identity] Environment variable validation passed for ${ManagedIdentitySourceNames.CLOUD_SHELL} managed identity. Endpoint URI: ${validatedMsiEndpoint}. Creating ${ManagedIdentitySourceNames.CLOUD_SHELL} managed identity.`); if (managedIdentityId.idType !== ManagedIdentityIdType.SYSTEM_ASSIGNED) { throw createManagedIdentityError(unableToCreateCloudShell); } return new CloudShell(logger, nodeStorage, networkClient, cryptoProvider, msiEndpoint); } createRequest(resource) { const request = new ManagedIdentityRequestParameters(HttpMethod.POST, this.msiEndpoint); request.headers[METADATA_HEADER_NAME] = "true"; request.bodyParameters[RESOURCE_BODY_OR_QUERY_PARAMETER_NAME] = resource; return request; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ // IMDS constants. Docs for IMDS are available here https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-use-vm-token#get-a-token-using-http const IMDS_TOKEN_PATH = "/metadata/identity/oauth2/token"; const DEFAULT_IMDS_ENDPOINT = `http://169.254.169.254${IMDS_TOKEN_PATH}`; const IMDS_API_VERSION = "2018-02-01"; // Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ImdsManagedIdentitySource.cs class Imds extends BaseManagedIdentitySource { constructor(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint) { super(logger, nodeStorage, networkClient, cryptoProvider); this.identityEndpoint = identityEndpoint; } static tryCreate(logger, nodeStorage, networkClient, cryptoProvider) { let validatedIdentityEndpoint; if (process.env[ManagedIdentityEnvironmentVariableNames .AZURE_POD_IDENTITY_AUTHORITY_HOST]) { logger.info(`[Managed Identity] Environment variable ${ManagedIdentityEnvironmentVariableNames.AZURE_POD_IDENTITY_AUTHORITY_HOST} for ${ManagedIdentitySourceNames.IMDS} returned endpoint: ${process.env[ManagedIdentityEnvironmentVariableNames .AZURE_POD_IDENTITY_AUTHORITY_HOST]}`); validatedIdentityEndpoint = Imds.getValidatedEnvVariableUrlString(ManagedIdentityEnvironmentVariableNames.AZURE_POD_IDENTITY_AUTHORITY_HOST, `${process.env[ManagedIdentityEnvironmentVariableNames .AZURE_POD_IDENTITY_AUTHORITY_HOST]}${IMDS_TOKEN_PATH}`, ManagedIdentitySourceNames.IMDS, logger); } else { logger.info(`[Managed Identity] Unable to find ${ManagedIdentityEnvironmentVariableNames.AZURE_POD_IDENTITY_AUTHORITY_HOST} environment variable for ${ManagedIdentitySourceNames.IMDS}, using the default endpoint.`); validatedIdentityEndpoint = DEFAULT_IMDS_ENDPOINT; } return new Imds(logger, nodeStorage, networkClient, cryptoProvider, validatedIdentityEndpoint); } createRequest(resource, managedIdentityId) { const request = new ManagedIdentityRequestParameters(HttpMethod.GET, this.identityEndpoint); request.headers[METADATA_HEADER_NAME] = "true"; request.queryParameters[API_VERSION_QUERY_PARAMETER_NAME] = IMDS_API_VERSION; request.queryParameters[RESOURCE_BODY_OR_QUERY_PARAMETER_NAME] = resource; if (managedIdentityId.idType !== ManagedIdentityIdType.SYSTEM_ASSIGNED) { request.queryParameters[this.getManagedIdentityUserAssignedIdQueryParameterKey(managedIdentityId.idType)] = managedIdentityId.id; } // bodyParameters calculated in BaseManagedIdentity.acquireTokenWithManagedIdentity return request; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ // MSI Constants. Docs for MSI are available here https://docs.microsoft.com/azure/app-service/overview-managed-identity const SERVICE_FABRIC_MSI_API_VERSION = "2019-07-01-preview"; /** * Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ServiceFabricManagedIdentitySource.cs */ class ServiceFabric extends BaseManagedIdentitySource { constructor(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint, identityHeader) { super(logger, nodeStorage, networkClient, cryptoProvider); this.identityEndpoint = identityEndpoint; this.identityHeader = identityHeader; } static getEnvironmentVariables() { const identityEndpoint = process.env[ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT]; const identityHeader = process.env[ManagedIdentityEnvironmentVariableNames.IDENTITY_HEADER]; const identityServerThumbprint = process.env[ManagedIdentityEnvironmentVariableNames .IDENTITY_SERVER_THUMBPRINT]; return [identityEndpoint, identityHeader, identityServerThumbprint]; } static tryCreate(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) { const [identityEndpoint, identityHeader, identityServerThumbprint] = ServiceFabric.getEnvironmentVariables(); /* * if either of the identity endpoint, identity header, or identity server thumbprint * environment variables are undefined, this MSI provider is unavailable. */ if (!identityEndpoint || !identityHeader || !identityServerThumbprint) { logger.info(`[Managed Identity] ${ManagedIdentitySourceNames.SERVICE_FABRIC} managed identity is unavailable because one or all of the '${ManagedIdentityEnvironmentVariableNames.IDENTITY_HEADER}', '${ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT}' or '${ManagedIdentityEnvironmentVariableNames.IDENTITY_SERVER_THUMBPRINT}' environment variables are not defined.`); return null; } const validatedIdentityEndpoint = ServiceFabric.getValidatedEnvVariableUrlString(ManagedIdentityEnvironmentVariableNames.IDENTITY_ENDPOINT, identityEndpoint, ManagedIdentitySourceNames.SERVICE_FABRIC, logger); logger.info(`[Managed Identity] Environment variables validation passed for ${ManagedIdentitySourceNames.SERVICE_FABRIC} managed identity. Endpoint URI: ${validatedIdentityEndpoint}. Creating ${ManagedIdentitySourceNames.SERVICE_FABRIC} managed identity.`); if (managedIdentityId.idType !== ManagedIdentityIdType.SYSTEM_ASSIGNED) { logger.warning(`[Managed Identity] ${ManagedIdentitySourceNames.SERVICE_FABRIC} user assigned managed identity is configured in the cluster, not during runtime. See also: https://learn.microsoft.com/en-us/azure/service-fabric/configure-existing-cluster-enable-managed-identity-token-service.`); } return new ServiceFabric(logger, nodeStorage, networkClient, cryptoProvider, identityEndpoint, identityHeader); } createRequest(resource, managedIdentityId) { const request = new ManagedIdentityRequestParameters(HttpMethod.GET, this.identityEndpoint); request.headers[SERVICE_FABRIC_SECRET_HEADER_NAME] = this.identityHeader; request.queryParameters[API_VERSION_QUERY_PARAMETER_NAME] = SERVICE_FABRIC_MSI_API_VERSION; request.queryParameters[RESOURCE_BODY_OR_QUERY_PARAMETER_NAME] = resource; if (managedIdentityId.idType !== ManagedIdentityIdType.SYSTEM_ASSIGNED) { request.queryParameters[this.getManagedIdentityUserAssignedIdQueryParameterKey(managedIdentityId.idType)] = managedIdentityId.id; } // bodyParameters calculated in BaseManagedIdentity.acquireTokenWithManagedIdentity return request; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /* * Class to initialize a managed identity and identify the service. * Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ManagedIdentityClient.cs */ class ManagedIdentityClient { constructor(logger, nodeStorage, networkClient, cryptoProvider) { this.logger = logger; this.nodeStorage = nodeStorage; this.networkClient = networkClient; this.cryptoProvider = cryptoProvider; } async sendManagedIdentityTokenRequest(managedIdentityRequest, managedIdentityId, fakeAuthority, refreshAccessToken) { if (!ManagedIdentityClient.identitySource) { ManagedIdentityClient.identitySource = this.selectManagedIdentitySource(this.logger, this.nodeStorage, this.networkClient, this.cryptoProvider, managedIdentityId); } return ManagedIdentityClient.identitySource.acquireTokenWithManagedIdentity(managedIdentityRequest, managedIdentityId, fakeAuthority, refreshAccessToken); } allEnvironmentVariablesAreDefined(environmentVariables) { return Object.values(environmentVariables).every((environmentVariable) => { return environmentVariable !== undefined; }); } /** * Determine the Managed Identity Source based on available environment variables. This API is consumed by ManagedIdentityApplication's getManagedIdentitySource. * @returns ManagedIdentitySourceNames - The Managed Identity source's name */ getManagedIdentitySource() { ManagedIdentityClient.sourceName = this.allEnvironmentVariablesAreDefined(ServiceFabric.getEnvironmentVariables()) ? ManagedIdentitySourceNames.SERVICE_FABRIC : this.allEnvironmentVariablesAreDefined(AppService.getEnvironmentVariables()) ? ManagedIdentitySourceNames.APP_SERVICE : this.allEnvironmentVariablesAreDefined(CloudShell.getEnvironmentVariables()) ? ManagedIdentitySourceNames.CLOUD_SHELL : this.allEnvironmentVariablesAreDefined(AzureArc.getEnvironmentVariables()) ? ManagedIdentitySourceNames.AZURE_ARC : ManagedIdentitySourceNames.DEFAULT_TO_IMDS; return ManagedIdentityClient.sourceName; } /** * Tries to create a managed identity source for all sources * @returns the managed identity Source */ selectManagedIdentitySource(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) { const source = ServiceFabric.tryCreate(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) || AppService.tryCreate(logger, nodeStorage, networkClient, cryptoProvider) || CloudShell.tryCreate(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) || AzureArc.tryCreate(logger, nodeStorage, networkClient, cryptoProvider, managedIdentityId) || Imds.tryCreate(logger, nodeStorage, networkClient, cryptoProvider); if (!source) { throw createManagedIdentityError(unableToCreateSource); } return source; } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Class to initialize a managed identity and identify the service * @public */ class ManagedIdentityApplication { constructor(configuration) { // undefined config means the managed identity is system-assigned this.config = buildManagedIdentityConfiguration(configuration || {}); this.logger = new Logger(this.config.system.loggerOptions, name, version); const fakeStatusAuthorityOptions = { canonicalAuthority: Constants$1.DEFAULT_AUTHORITY, }; if (!ManagedIdentityApplication.nodeStorage) { ManagedIdentityApplication.nodeStorage = new NodeStorage(this.logger, this.config.managedIdentityId.id, DEFAULT_CRYPTO_IMPLEMENTATION, fakeStatusAuthorityOptions); } this.networkClient = this.config.system.networkClient; this.cryptoProvider = new CryptoProvider(); const fakeAuthorityOptions = { protocolMode: ProtocolMode.AAD, knownAuthorities: [DEFAULT_AUTHORITY_FOR_MANAGED_IDENTITY], cloudDiscoveryMetadata: "", authorityMetadata: "", }; this.fakeAuthority = new Authority(DEFAULT_AUTHORITY_FOR_MANAGED_IDENTITY, this.networkClient, ManagedIdentityApplication.nodeStorage, fakeAuthorityOptions, this.logger, this.cryptoProvider.createNewGuid(), // correlationID undefined, true); this.fakeClientCredentialClient = new ClientCredentialClient({ authOptions: { clientId: this.config.managedIdentityId.id, authority: this.fakeAuthority, }, }); this.managedIdentityClient = new ManagedIdentityClient(this.logger, ManagedIdentityApplication.nodeStorage, this.networkClient, this.cryptoProvider); } /** * Acquire an access token from the cache or the managed identity * @param managedIdentityRequest - the ManagedIdentityRequestParams object passed in by the developer * @returns the access token */ async acquireToken(managedIdentityRequestParams) { if (!managedIdentityRequestParams.resource) { throw createClientConfigurationError(urlEmptyError); } const managedIdentityRequest = { forceRefresh: managedIdentityRequestParams.forceRefresh, resource: managedIdentityRequestParams.resource.replace("/.default", ""), scopes: [ managedIdentityRequestParams.resource.replace("/.default", ""), ], authority: this.fakeAuthority.canonicalAuthority, correlationId: this.cryptoProvider.createNewGuid(), }; if (managedIdentityRequestParams.claims || managedIdentityRequest.forceRefresh) { // make a network call to the managed identity source return this.managedIdentityClient.sendManagedIdentityTokenRequest(managedIdentityRequest, this.config.managedIdentityId, this.fakeAuthority); } const [cachedAuthenticationResult, lastCacheOutcome] = await this.fakeClientCredentialClient.getCachedAuthenticationResult(managedIdentityRequest, this.config, this.cryptoProvider, this.fakeAuthority, ManagedIdentityApplication.nodeStorage); if (cachedAuthenticationResult) { // if the token is not expired but must be refreshed; get a new one in the background if (lastCacheOutcome === CacheOutcome.PROACTIVELY_REFRESHED) { this.logger.info("ClientCredentialClient:getCachedAuthenticationResult - Cached access token's refreshOn property has been exceeded'. It's not expired, but must be refreshed."); // make a network call to the managed identity source; refresh the access token in the background const refreshAccessToken = true; await this.managedIdentityClient.sendManagedIdentityTokenRequest(managedIdentityRequest, this.config.managedIdentityId, this.fakeAuthority, refreshAccessToken); } return cachedAuthenticationResult; } else { // make a network call to the managed identity source return this.managedIdentityClient.sendManagedIdentityTokenRequest(managedIdentityRequest, this.config.managedIdentityId, this.fakeAuthority); } } /** * Determine the Managed Identity Source based on available environment variables. This API is consumed by Azure Identity SDK. * @returns ManagedIdentitySourceNames - The Managed Identity source's name */ getManagedIdentitySource() { return (ManagedIdentityClient.sourceName || this.managedIdentityClient.getManagedIdentitySource()); } } /* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ /** * Cache plugin that serializes data to the cache and deserializes data from the cache * @public */ class DistributedCachePlugin { constructor(client, partitionManager) { this.client = client; this.partitionManager = partitionManager; } /** * Deserializes the cache before accessing it * @param cacheContext - TokenCacheContext */ async beforeCacheAccess(cacheContext) { const partitionKey = await this.partitionManager.getKey(); const cacheData = await this.client.get(partitionKey); cacheContext.tokenCache.deserialize(cacheData); } /** * Serializes the cache after accessing it * @param cacheContext - TokenCacheContext */ async afterCacheAccess(cacheContext) { if (cacheContext.cacheHasChanged) { const kvStore = cacheContext.tokenCache.getKVStore(); const accountEntities = Object.values(kvStore).filter((value) => AccountEntity.isAccountEntity(value)); let partitionKey; if (accountEntities.length > 0) { const accountEntity = accountEntities[0]; partitionKey = await this.partitionManager.extractKey(accountEntity); } else { partitionKey = await this.partitionManager.getKey(); } await this.client.set(partitionKey, cacheContext.tokenCache.serialize()); } } } exports.AuthError = AuthError; exports.AuthErrorCodes = AuthErrorCodes; exports.AuthErrorMessage = AuthErrorMessage; exports.AzureCloudInstance = AzureCloudInstance; exports.ClientApplication = ClientApplication; exports.ClientAssertion = ClientAssertion; exports.ClientAuthError = ClientAuthError; exports.ClientAuthErrorCodes = ClientAuthErrorCodes; exports.ClientAuthErrorMessage = ClientAuthErrorMessage; exports.ClientConfigurationError = ClientConfigurationError; exports.ClientConfigurationErrorCodes = ClientConfigurationErrorCodes; exports.ClientConfigurationErrorMessage = ClientConfigurationErrorMessage; exports.ClientCredentialClient = ClientCredentialClient; exports.ConfidentialClientApplication = ConfidentialClientApplication; exports.CryptoProvider = CryptoProvider; exports.DeviceCodeClient = DeviceCodeClient; exports.DistributedCachePlugin = DistributedCachePlugin; exports.InteractionRequiredAuthError = InteractionRequiredAuthError; exports.InteractionRequiredAuthErrorCodes = InteractionRequiredAuthErrorCodes; exports.InteractionRequiredAuthErrorMessage = InteractionRequiredAuthErrorMessage; exports.Logger = Logger; exports.ManagedIdentityApplication = ManagedIdentityApplication; exports.ManagedIdentitySourceNames = ManagedIdentitySourceNames; exports.NodeStorage = NodeStorage; exports.OnBehalfOfClient = OnBehalfOfClient; exports.PromptValue = PromptValue; exports.ProtocolMode = ProtocolMode; exports.PublicClientApplication = PublicClientApplication; exports.ResponseMode = ResponseMode; exports.ServerError = ServerError; exports.TokenCache = TokenCache; exports.TokenCacheContext = TokenCacheContext; exports.UsernamePasswordClient = UsernamePasswordClient; exports.internals = internals; exports.version = version; //# sourceMappingURL=msal-node.cjs.map