@azure/msal-common 15.13.3 → 16.0.0-beta.0

package/lib/types/request/CommonClientCredentialRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommonClientCredentialRequest.d.ts","sourceRoot":"","sources":["../../../src/request/CommonClientCredentialRequest.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,MAAM,6BAA6B,GAAG,eAAe,GAAG;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,eAAe,CAAC,EAAE,eAAe,CAAC;CACrC,CAAC"}

package/lib/types/request/CommonDeviceCodeRequest.d.ts

@@ -1,22 +0,0 @@
-import { DeviceCodeResponse } from "../response/DeviceCodeResponse.js";
-import { StringDict } from "../utils/MsalTypes.js";
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-/**
- * Parameters for Oauth2 device code flow.
- * - scopes                     - Array of scopes the application is requesting access to.
- * - authority:                 - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. If authority is set on client application object, this will override that value. Overriding the value will cause for authority validation to happen each time. If the same authority will be used for all request, set on the application object instead of the requests.
- * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - deviceCodeCallback         - Callback containing device code response. Message should be shown to end user. End user can then navigate to the verification_uri, input the user_code, and input credentials.
- * - cancel                     - Boolean to cancel polling of device code endpoint. While the user authenticates on a separate device, MSAL polls the the token endpoint of security token service for the interval specified in the device code response (usually 15 minutes). To stop polling and cancel the request, set cancel=true.
- * - resourceRequestMethod      - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
- * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
- * - timeout                    - Timeout period in seconds which the user explicitly configures for the polling of the device code endpoint. At the end of this period; assuming the device code has not expired yet; the device code polling is stopped and the request cancelled. The device code expiration window will always take precedence over this set period.
- * - extraQueryParameters       - String to string map of custom query parameters added to the query string
- */
-export type CommonDeviceCodeRequest = Omit<BaseAuthRequest, "tokenQueryParameters" | "tokenBodyParameters"> & {
-    deviceCodeCallback: (response: DeviceCodeResponse) => void;
-    cancel?: boolean;
-    timeout?: number;
-    extraQueryParameters?: StringDict;
-};
-//# sourceMappingURL=CommonDeviceCodeRequest.d.ts.map

package/lib/types/request/CommonDeviceCodeRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommonDeviceCodeRequest.d.ts","sourceRoot":"","sources":["../../../src/request/CommonDeviceCodeRequest.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;GAWG;AAEH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACtC,eAAe,EACf,sBAAsB,GAAG,qBAAqB,CACjD,GAAG;IACA,kBAAkB,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAC3D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,UAAU,CAAC;CACrC,CAAC"}

package/lib/types/request/CommonOnBehalfOfRequest.d.ts

@@ -1,14 +0,0 @@
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-/**
- * - scopes                  - Array of scopes the application is requesting access to.
- * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
- * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - oboAssertion            - The access token that was sent to the middle-tier API. This token must have an audience of the app making this OBO request.
- * - skipCache               - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
- * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
- */
-export type CommonOnBehalfOfRequest = BaseAuthRequest & {
-    oboAssertion: string;
-    skipCache?: boolean;
-};
-//# sourceMappingURL=CommonOnBehalfOfRequest.d.ts.map

package/lib/types/request/CommonOnBehalfOfRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommonOnBehalfOfRequest.d.ts","sourceRoot":"","sources":["../../../src/request/CommonOnBehalfOfRequest.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC"}

package/lib/types/request/CommonUsernamePasswordRequest.d.ts

@@ -1,18 +0,0 @@
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-/**
- * CommonUsernamePassword parameters passed by the user to retrieve credentials
- * Note: The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely. This flow is added for internal testing.
- *
- * - scopes                 - Array of scopes the application is requesting access to.
- * - claims                 - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
- * - authority              - Url of the authority which the application acquires tokens from.
- * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - username               - username of the client
- * - password               - credentials
- * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
- */
-export type CommonUsernamePasswordRequest = BaseAuthRequest & {
-    username: string;
-    password: string;
-};
-//# sourceMappingURL=CommonUsernamePasswordRequest.d.ts.map

package/lib/types/request/CommonUsernamePasswordRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CommonUsernamePasswordRequest.d.ts","sourceRoot":"","sources":["../../../src/request/CommonUsernamePasswordRequest.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,6BAA6B,GAAG,eAAe,GAAG;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/src/client/BaseClient.ts

@@ -1,320 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import {
-    ClientConfiguration,
-    buildClientConfiguration,
-    CommonClientConfiguration,
-} from "../config/ClientConfiguration.js";
-import {
-    INetworkModule,
-    NetworkRequestOptions,
-} from "../network/INetworkModule.js";
-import { NetworkResponse } from "../network/NetworkResponse.js";
-import { ICrypto } from "../crypto/ICrypto.js";
-import { Authority } from "../authority/Authority.js";
-import { Logger } from "../logger/Logger.js";
-import { Constants, HeaderNames } from "../utils/Constants.js";
-import { ServerAuthorizationTokenResponse } from "../response/ServerAuthorizationTokenResponse.js";
-import { CacheManager } from "../cache/CacheManager.js";
-import { ServerTelemetryManager } from "../telemetry/server/ServerTelemetryManager.js";
-import { RequestThumbprint } from "../network/RequestThumbprint.js";
-import { version, name } from "../packageMetadata.js";
-import { CcsCredential, CcsCredentialType } from "../account/CcsCredential.js";
-import { buildClientInfoFromHomeAccountId } from "../account/ClientInfo.js";
-import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient.js";
-import * as RequestParameterBuilder from "../request/RequestParameterBuilder.js";
-import * as UrlUtils from "../utils/UrlUtils.js";
-import { BaseAuthRequest } from "../request/BaseAuthRequest.js";
-import { createDiscoveredInstance } from "../authority/AuthorityFactory.js";
-import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent.js";
-import { ThrottlingUtils } from "../network/ThrottlingUtils.js";
-import { AuthError } from "../error/AuthError.js";
-import {
-    ClientAuthErrorCodes,
-    createClientAuthError,
-} from "../error/ClientAuthError.js";
-import { NetworkError } from "../error/NetworkError.js";
-import { invokeAsync } from "../utils/FunctionWrappers.js";
-
-/**
- * Base application class which will construct requests to send to and handle responses from the Microsoft STS using the authorization code flow.
- * @internal
- */
-export abstract class BaseClient {
-    // Logger object
-    public logger: Logger;
-
-    // Application config
-    protected config: CommonClientConfiguration;
-
-    // Crypto Interface
-    protected cryptoUtils: ICrypto;
-
-    // Storage Interface
-    protected cacheManager: CacheManager;
-
-    // Network Interface
-    protected networkClient: INetworkModule;
-
-    // Server Telemetry Manager
-    protected serverTelemetryManager: ServerTelemetryManager | null;
-
-    // Default authority object
-    public authority: Authority;
-
-    // Performance telemetry client
-    protected performanceClient?: IPerformanceClient;
-
-    protected constructor(
-        configuration: ClientConfiguration,
-        performanceClient?: IPerformanceClient
-    ) {
-        // Set the configuration
-        this.config = buildClientConfiguration(configuration);
-
-        // Initialize the logger
-        this.logger = new Logger(this.config.loggerOptions, name, version);
-
-        // 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
-     */
-    protected createTokenRequestHeaders(
-        ccsCred?: CcsCredential
-    ): Record<string, string> {
-        const headers: Record<string, string> = {};
-        headers[HeaderNames.CONTENT_TYPE] = Constants.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
-     */
-    protected async executePostToTokenEndpoint(
-        tokenEndpoint: string,
-        queryString: string,
-        headers: Record<string, string>,
-        thumbprint: RequestThumbprint,
-        correlationId: string,
-        queuedEvent?: string
-    ): Promise<NetworkResponse<ServerAuthorizationTokenResponse>> {
-        if (queuedEvent) {
-            this.performanceClient?.addQueueMeasurement(
-                queuedEvent,
-                correlationId
-            );
-        }
-
-        const response =
-            await this.sendPostRequest<ServerAuthorizationTokenResponse>(
-                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<T extends ServerAuthorizationTokenResponse>(
-        thumbprint: RequestThumbprint,
-        tokenEndpoint: string,
-        options: NetworkRequestOptions,
-        correlationId: string
-    ): Promise<NetworkResponse<T>> {
-        ThrottlingUtils.preProcess(
-            this.cacheManager,
-            thumbprint,
-            correlationId
-        );
-
-        let response;
-        try {
-            response = await invokeAsync(
-                this.networkClient.sendPostRequestAsync.bind(
-                    this.networkClient
-                )<T>,
-                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(ClientAuthErrorCodes.networkError);
-            }
-        }
-
-        ThrottlingUtils.postProcess(
-            this.cacheManager,
-            thumbprint,
-            response,
-            correlationId
-        );
-
-        return response;
-    }
-
-    /**
-     * Updates the authority object of the client. Endpoint discovery must be completed.
-     * @param updatedAuthority
-     */
-    async updateAuthority(
-        cloudInstanceHostname: string,
-        correlationId: string
-    ): Promise<void> {
-        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: BaseAuthRequest): string {
-        const parameters = new Map<string, string>();
-
-        if (request.embeddedClientId) {
-            RequestParameterBuilder.addBrokerParameters(
-                parameters,
-                this.config.authOptions.clientId,
-                this.config.authOptions.redirectUri
-            );
-        }
-
-        if (request.tokenQueryParameters) {
-            RequestParameterBuilder.addExtraQueryParameters(
-                parameters,
-                request.tokenQueryParameters
-            );
-        }
-
-        RequestParameterBuilder.addCorrelationId(
-            parameters,
-            request.correlationId
-        );
-
-        RequestParameterBuilder.instrumentBrokerParams(
-            parameters,
-            request.correlationId,
-            this.performanceClient
-        );
-        return UrlUtils.mapToQueryString(parameters);
-    }
-}

package/src/request/CommonClientCredentialRequest.ts

@@ -1,23 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-import { AzureRegion } from "../authority/AzureRegion.js";
-import { ClientAssertion } from "../account/ClientCredentials.js";
-
-/**
- * CommonClientCredentialRequest
- * - scopes                             - Array of scopes the application is requesting access to.
- * - authority                          - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
- * - correlationId                      - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - skipCache                          - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
- * - preferredAzureRegionOptions        - Options of the user's preferred azure region
- * - tokenQueryParameters               - String to string map of custom query parameters added to the /token call
- */
-export type CommonClientCredentialRequest = BaseAuthRequest & {
-    skipCache?: boolean;
-    azureRegion?: AzureRegion;
-    clientAssertion?: ClientAssertion;
-};

package/src/request/CommonDeviceCodeRequest.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { DeviceCodeResponse } from "../response/DeviceCodeResponse.js";
-import { StringDict } from "../utils/MsalTypes.js";
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-
-/**
- * Parameters for Oauth2 device code flow.
- * - scopes                     - Array of scopes the application is requesting access to.
- * - authority:                 - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. If authority is set on client application object, this will override that value. Overriding the value will cause for authority validation to happen each time. If the same authority will be used for all request, set on the application object instead of the requests.
- * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - deviceCodeCallback         - Callback containing device code response. Message should be shown to end user. End user can then navigate to the verification_uri, input the user_code, and input credentials.
- * - cancel                     - Boolean to cancel polling of device code endpoint. While the user authenticates on a separate device, MSAL polls the the token endpoint of security token service for the interval specified in the device code response (usually 15 minutes). To stop polling and cancel the request, set cancel=true.
- * - resourceRequestMethod      - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
- * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
- * - timeout                    - Timeout period in seconds which the user explicitly configures for the polling of the device code endpoint. At the end of this period; assuming the device code has not expired yet; the device code polling is stopped and the request cancelled. The device code expiration window will always take precedence over this set period.
- * - extraQueryParameters       - String to string map of custom query parameters added to the query string
- */
-// export type CommonDeviceCodeRequest = BaseAuthRequest &  {
-export type CommonDeviceCodeRequest = Omit<
-    BaseAuthRequest,
-    "tokenQueryParameters" | "tokenBodyParameters"
-> & {
-    deviceCodeCallback: (response: DeviceCodeResponse) => void;
-    cancel?: boolean;
-    timeout?: number;
-    extraQueryParameters?: StringDict;
-};

package/src/request/CommonOnBehalfOfRequest.ts

@@ -1,19 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-
-/**
- * - scopes                  - Array of scopes the application is requesting access to.
- * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
- * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - oboAssertion            - The access token that was sent to the middle-tier API. This token must have an audience of the app making this OBO request.
- * - skipCache               - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
- * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
- */
-export type CommonOnBehalfOfRequest = BaseAuthRequest & {
-    oboAssertion: string;
-    skipCache?: boolean;
-};

package/src/request/CommonUsernamePasswordRequest.ts

@@ -1,23 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { BaseAuthRequest } from "./BaseAuthRequest.js";
-
-/**
- * CommonUsernamePassword parameters passed by the user to retrieve credentials
- * Note: The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely. This flow is added for internal testing.
- *
- * - scopes                 - Array of scopes the application is requesting access to.
- * - claims                 - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
- * - authority              - Url of the authority which the application acquires tokens from.
- * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - username               - username of the client
- * - password               - credentials
- * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
- */
-export type CommonUsernamePasswordRequest = BaseAuthRequest & {
-    username: string;
-    password: string;
-};