@azure/msal-common 14.0.2 → 14.0.3

package/src/network/ThrottlingUtils.ts

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { NetworkResponse } from "./NetworkManager";
+import { ServerAuthorizationTokenResponse } from "../response/ServerAuthorizationTokenResponse";
+import {
+    HeaderNames,
+    ThrottlingConstants,
+    Constants,
+} from "../utils/Constants";
+import { CacheManager } from "../cache/CacheManager";
+import { ServerError } from "../error/ServerError";
+import { RequestThumbprint } from "./RequestThumbprint";
+import { ThrottlingEntity } from "../cache/entities/ThrottlingEntity";
+import { BaseAuthRequest } from "../request/BaseAuthRequest";
+
+/** @internal */
+export class ThrottlingUtils {
+    /**
+     * Prepares a RequestThumbprint to be stored as a key.
+     * @param thumbprint
+     */
+    static generateThrottlingStorageKey(thumbprint: RequestThumbprint): string {
+        return `${ThrottlingConstants.THROTTLING_PREFIX}.${JSON.stringify(
+            thumbprint
+        )}`;
+    }
+
+    /**
+     * Performs necessary throttling checks before a network request.
+     * @param cacheManager
+     * @param thumbprint
+     */
+    static preProcess(
+        cacheManager: CacheManager,
+        thumbprint: RequestThumbprint
+    ): void {
+        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.EMPTY_STRING,
+                value.errorMessage,
+                value.subError
+            );
+        }
+    }
+
+    /**
+     * Performs necessary throttling checks after a network request.
+     * @param cacheManager
+     * @param thumbprint
+     * @param response
+     */
+    static postProcess(
+        cacheManager: CacheManager,
+        thumbprint: RequestThumbprint,
+        response: NetworkResponse<ServerAuthorizationTokenResponse>
+    ): void {
+        if (
+            ThrottlingUtils.checkResponseStatus(response) ||
+            ThrottlingUtils.checkResponseForRetryAfter(response)
+        ) {
+            const thumbprintValue: ThrottlingEntity = {
+                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: NetworkResponse<ServerAuthorizationTokenResponse>
+    ): boolean {
+        return (
+            response.status === 429 ||
+            (response.status >= 500 && response.status < 600)
+        );
+    }
+
+    /**
+     * Checks a NetworkResponse object's RetryAfter header
+     * @param response
+     */
+    static checkResponseForRetryAfter(
+        response: NetworkResponse<ServerAuthorizationTokenResponse>
+    ): boolean {
+        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: number): number {
+        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: CacheManager,
+        clientId: string,
+        request: BaseAuthRequest,
+        homeAccountIdentifier?: string
+    ): void {
+        const thumbprint: RequestThumbprint = {
+            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);
+    }
+}

package/src/packageMetadata.ts

@@ -0,0 +1,3 @@
+/* eslint-disable header/header */
+export const name = "@azure/msal-common";
+export const version = "14.0.3";

package/src/request/AuthenticationHeaderParser.ts

@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ClientConfigurationError } from "../error/ClientConfigurationError";
+import { Constants, HeaderNames } from "../utils/Constants";
+
+type WWWAuthenticateChallenges = {
+    nonce?: string;
+};
+
+type AuthenticationInfoChallenges = {
+    nextnonce?: string;
+};
+
+/**
+ * This is a helper class that parses supported HTTP response authentication headers to extract and return
+ * header challenge values that can be used outside the basic authorization flows.
+ */
+export class AuthenticationHeaderParser {
+    private headers: Record<string, string>;
+
+    constructor(headers: Record<string, string>) {
+        this.headers = headers;
+    }
+
+    /**
+     * This method parses the SHR nonce value out of either the Authentication-Info or WWW-Authenticate authentication headers.
+     * @returns
+     */
+    getShrNonce(): string {
+        // Attempt to parse nonce from Authentiacation-Info
+        const authenticationInfo = this.headers[HeaderNames.AuthenticationInfo];
+        if (authenticationInfo) {
+            const authenticationInfoChallenges =
+                this.parseChallenges<AuthenticationInfoChallenges>(
+                    authenticationInfo
+                );
+            if (authenticationInfoChallenges.nextnonce) {
+                return authenticationInfoChallenges.nextnonce;
+            }
+            throw ClientConfigurationError.createInvalidAuthenticationHeaderError(
+                HeaderNames.AuthenticationInfo,
+                "nextnonce challenge is missing."
+            );
+        }
+
+        // Attempt to parse nonce from WWW-Authenticate
+        const wwwAuthenticate = this.headers[HeaderNames.WWWAuthenticate];
+        if (wwwAuthenticate) {
+            const wwwAuthenticateChallenges =
+                this.parseChallenges<WWWAuthenticateChallenges>(
+                    wwwAuthenticate
+                );
+            if (wwwAuthenticateChallenges.nonce) {
+                return wwwAuthenticateChallenges.nonce;
+            }
+            throw ClientConfigurationError.createInvalidAuthenticationHeaderError(
+                HeaderNames.WWWAuthenticate,
+                "nonce challenge is missing."
+            );
+        }
+
+        // If neither header is present, throw missing headers error
+        throw ClientConfigurationError.createMissingNonceAuthenticationHeadersError();
+    }
+
+    /**
+     * Parses an HTTP header's challenge set into a key/value map.
+     * @param header
+     * @returns
+     */
+    private parseChallenges<T>(header: string): T {
+        const schemeSeparator = header.indexOf(" ");
+        const challenges = header.substr(schemeSeparator + 1).split(",");
+        const challengeMap = {} as T;
+
+        challenges.forEach((challenge: string) => {
+            const [key, value] = challenge.split("=");
+            // Remove escaped quotation marks (', ") from challenge string to keep only the challenge value
+            challengeMap[key] = unescape(
+                value.replace(/['"]+/g, Constants.EMPTY_STRING)
+            );
+        });
+
+        return challengeMap;
+    }
+}

package/src/request/BaseAuthRequest.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthenticationScheme } from "../utils/Constants";
+import { AzureCloudOptions } from "../config/ClientConfiguration";
+import { StringDict } from "../utils/MsalTypes";
+import { StoreInCache } from "./StoreInCache";
+
+/**
+ * BaseAuthRequest
+ * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. Defaults to https://login.microsoftonline.com/common. If using the same authority for all request, authority should set on client application object and not request, to avoid resolving authority endpoints multiple times.
+ * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - scopes                  - Array of scopes the application is requesting access to.
+ * - authenticationScheme    - The type of token retrieved. Defaults to "Bearer". Can also be type "pop" or "SSH".
+ * - claims                  - A stringified claims request which will be added to all /authorize and /token calls
+ * - shrClaims               - A stringified claims object which will be added to a Signed HTTP Request
+ * - shrNonce                - A server-generated timestamp that has been encrypted and base64URL encoded, which will be added to a Signed HTTP Request.
+ * - 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.
+ * - sshJwk                  - A stringified JSON Web Key representing a public key that can be signed by an SSH certificate.
+ * - sshKid                  - Key ID that uniquely identifies the SSH public key mentioned above.
+ * - azureCloudOptions       - Convenience string enums for users to provide public/sovereign cloud ids
+ * - requestedClaimsHash     - SHA 256 hash string of the requested claims string, used as part of an access token cache key so tokens can be filtered by requested claims
+ * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
+ * - storeInCache            - Object containing boolean values indicating whether to store tokens in the cache or not (default is true)
+ */
+export type BaseAuthRequest = {
+    authority: string;
+    correlationId: string;
+    scopes: Array<string>;
+    authenticationScheme?: AuthenticationScheme;
+    claims?: string;
+    shrClaims?: string;
+    shrNonce?: string;
+    resourceRequestMethod?: string;
+    resourceRequestUri?: string;
+    sshJwk?: string;
+    sshKid?: string;
+    azureCloudOptions?: AzureCloudOptions;
+    requestedClaimsHash?: string;
+    maxAge?: number;
+    tokenQueryParameters?: StringDict;
+    storeInCache?: StoreInCache;
+};

package/src/request/CommonAuthorizationCodeRequest.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { StringDict } from "../utils/MsalTypes";
+import { CcsCredential } from "../account/CcsCredential";
+
+/**
+ * Request object passed by user to acquire a token from the server exchanging a valid authorization code (second leg of OAuth2.0 Authorization Code flow)
+ *
+ * - 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
+ * - 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.
+ * - redirectUri             - The redirect URI of your app, where the authority will redirect to after the user inputs credentials and consents. It must exactly match one of the redirect URIs you registered in the portal
+ * - code                    - The authorization_code that the user acquired in the first leg of the flow.
+ * - codeVerifier            - The same code_verifier that was used to obtain the authorization_code. Required if PKCE was used in the authorization code grant request.For more information, see the PKCE RFC: https://tools.ietf.org/html/rfc7636
+ * - 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.
+ * - enableSpaAuthCode       - Enables the acqusition of a spa authorization code (confidential clients only)
+ * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
+ */
+export type CommonAuthorizationCodeRequest = BaseAuthRequest & {
+    code: string;
+    redirectUri: string;
+    codeVerifier?: string;
+    tokenBodyParameters?: StringDict;
+    enableSpaAuthorizationCode?: boolean;
+    clientInfo?: string;
+    ccsCredential?: CcsCredential;
+};

package/src/request/CommonAuthorizationUrlRequest.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ResponseMode } from "../utils/Constants";
+import { StringDict } from "../utils/MsalTypes";
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { AccountInfo } from "../account/AccountInfo";
+
+/**
+ * Request object passed by user to retrieve a Code from the server (first leg of authorization code grant flow)
+ *
+ * - 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
+ * - 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.
+ * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
+ * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
+ * - responseMode               - Specifies the method that should be used to send the authentication result to your app. Can be query, form_post, or fragment. If no value is passed in, it defaults to query.
+ * - codeChallenge              - Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF:https://tools.ietf.org/html/rfc7636
+ * - codeChallengeMethod        - The method used to encode the code verifier for the code challenge parameter. Can be "plain" or "S256". If excluded, code challenge is assumed to be plaintext. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636
+ * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
+ * - prompt                     - Indicates the type of user interaction that is required.
+ *          login: will force the user to enter their credentials on that request, negating single-sign on
+ *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
+ *          consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
+ *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
+ *          create: will direct the user to the account creation experience instead of the log in experience
+ *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
+ * - account                    - AccountInfo obtained from a getAccount API. Will be used in certain scenarios to generate login_hint if both loginHint and sid params are not provided.
+ * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred_username claim.
+ * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
+ * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
+ * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
+ * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
+ * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
+ * - 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.
+ */
+export type CommonAuthorizationUrlRequest = BaseAuthRequest & {
+    redirectUri: string;
+    responseMode: ResponseMode;
+    account?: AccountInfo;
+    codeChallenge?: string;
+    codeChallengeMethod?: string;
+    domainHint?: string;
+    extraQueryParameters?: StringDict;
+    extraScopesToConsent?: Array<string>;
+    loginHint?: string;
+    nonce?: string;
+    prompt?: string;
+    sid?: string;
+    state?: string;
+    nativeBroker?: boolean;
+};

package/src/request/CommonClientCredentialRequest.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { AzureRegion } from "../authority/AzureRegion";
+import { ClientAssertion } from "../account/ClientCredentials";
+
+/**
+ * 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

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { DeviceCodeResponse } from "../response/DeviceCodeResponse";
+import { StringDict } from "../utils/MsalTypes";
+import { BaseAuthRequest } from "./BaseAuthRequest";
+
+/**
+ * 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"
+> & {
+    deviceCodeCallback: (response: DeviceCodeResponse) => void;
+    cancel?: boolean;
+    timeout?: number;
+    extraQueryParameters?: StringDict;
+};

package/src/request/CommonEndSessionRequest.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AccountInfo } from "../account/AccountInfo";
+import { StringDict } from "../utils/MsalTypes";
+
+/**
+ * CommonEndSessionRequest
+ * - account                - Account object that will be logged out of. All tokens tied to this account will be cleared.
+ * - postLogoutRedirectUri  - URI to navigate to after logout page.
+ * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - idTokenHint            - ID Token used by B2C to validate logout if required by the policy
+ * - state                  - A value included in the request to the logout endpoint which will be returned in the query string upon post logout redirection
+ * - logoutHint             - A string that specifies the account that is being logged out in order to skip the server account picker on logout
+ * - extraQueryParameters   - String to string map of custom query parameters added to the /authorize call
+ */
+export type CommonEndSessionRequest = {
+    correlationId: string;
+    account?: AccountInfo | null;
+    postLogoutRedirectUri?: string | null;
+    idTokenHint?: string;
+    state?: string;
+    logoutHint?: string;
+    extraQueryParameters?: StringDict;
+};

package/src/request/CommonOnBehalfOfRequest.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { BaseAuthRequest } from "./BaseAuthRequest";
+
+/**
+ * - 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/CommonRefreshTokenRequest.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { CcsCredential } from "../account/CcsCredential";
+
+/**
+ * CommonRefreshTokenRequest
+ * - 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
+ * - 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.
+ * - refreshToken            - A refresh token returned from a previous request to the Identity provider.
+ * - 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.
+ * - forceCache              - Force MSAL to cache a refresh token flow response when there is no account in the cache. Used for migration scenarios.
+ * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
+ */
+export type CommonRefreshTokenRequest = BaseAuthRequest & {
+    refreshToken: string;
+    ccsCredential?: CcsCredential;
+    forceCache?: boolean;
+};

package/src/request/CommonSilentFlowRequest.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AccountInfo } from "../account/AccountInfo";
+import { BaseAuthRequest } from "./BaseAuthRequest";
+
+/**
+ * SilentFlow parameters passed by the user to retrieve credentials silently
+ * - 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.
+ * - account                - Account entity to lookup the credentials.
+ * - forceRefresh           - Forces silent requests to make network calls if 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.
+ * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
+ */
+export type CommonSilentFlowRequest = BaseAuthRequest & {
+    account: AccountInfo;
+    forceRefresh: boolean;
+};

package/src/request/CommonUsernamePasswordRequest.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { BaseAuthRequest } from "./BaseAuthRequest";
+
+/**
+ * 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;
+};

package/src/request/NativeRequest.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { StringDict } from "../utils/MsalTypes";
+
+export type NativeRequest = {
+    clientId: string;
+    authority: string;
+    correlationId: string;
+    redirectUri: string;
+    scopes: Array<string>;
+    claims?: string;
+    authenticationScheme?: string;
+    resourceRequestMethod?: string;
+    resourceRequestUri?: string;
+    shrNonce?: string;
+    accountId?: string;
+    forceRefresh?: boolean;
+    extraParameters?: StringDict;
+    extraScopesToConsent?: Array<string>;
+    loginHint?: string;
+    prompt?: string;
+};

package/src/request/NativeSignOutRequest.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export type NativeSignOutRequest = {
+    clientId: string;
+    accountId: string;
+    correlationId: string;
+};