@azure/msal-common 14.1.0 → 14.2.0-alpha.0

package/dist/crypto/ICrypto.d.ts

@@ -1,59 +1,59 @@
-import { BaseAuthRequest } from "../request/BaseAuthRequest";
-import { SignedHttpRequest } from "./SignedHttpRequest";
-/**
- * The PkceCodes type describes the structure
- * of objects that contain PKCE code
- * challenge and verifier pairs
- */
-export type PkceCodes = {
-    verifier: string;
-    challenge: string;
-};
-export type SignedHttpRequestParameters = Pick<BaseAuthRequest, "resourceRequestMethod" | "resourceRequestUri" | "shrClaims" | "shrNonce"> & {
-    correlationId?: string;
-};
-/**
- * Interface for crypto functions used by library
- */
-export interface ICrypto {
-    /**
-     * Creates a guid randomly.
-     */
-    createNewGuid(): string;
-    /**
-     * base64 Encode string
-     * @param input
-     */
-    base64Encode(input: string): string;
-    /**
-     * base64 decode string
-     * @param input
-     */
-    base64Decode(input: string): string;
-    /**
-     * Generates an JWK RSA S256 Thumbprint
-     * @param request
-     */
-    getPublicKeyThumbprint(request: SignedHttpRequestParameters): Promise<string>;
-    /**
-     * Removes cryptographic keypair from key store matching the keyId passed in
-     * @param kid
-     */
-    removeTokenBindingKey(kid: string): Promise<boolean>;
-    /**
-     * Removes all cryptographic keys from IndexedDB storage
-     */
-    clearKeystore(): Promise<boolean>;
-    /**
-     * Returns a signed proof-of-possession token with a given acces token that contains a cnf claim with the required kid.
-     * @param accessToken
-     */
-    signJwt(payload: SignedHttpRequest, kid: string, correlationId?: string): Promise<string>;
-    /**
-     * Returns the SHA-256 hash of an input string
-     * @param plainText
-     */
-    hashString(plainText: string): Promise<string>;
-}
-export declare const DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto;
+import { BaseAuthRequest } from "../request/BaseAuthRequest";
+import { SignedHttpRequest } from "./SignedHttpRequest";
+/**
+ * The PkceCodes type describes the structure
+ * of objects that contain PKCE code
+ * challenge and verifier pairs
+ */
+export type PkceCodes = {
+    verifier: string;
+    challenge: string;
+};
+export type SignedHttpRequestParameters = Pick<BaseAuthRequest, "resourceRequestMethod" | "resourceRequestUri" | "shrClaims" | "shrNonce"> & {
+    correlationId?: string;
+};
+/**
+ * Interface for crypto functions used by library
+ */
+export interface ICrypto {
+    /**
+     * Creates a guid randomly.
+     */
+    createNewGuid(): string;
+    /**
+     * base64 Encode string
+     * @param input
+     */
+    base64Encode(input: string): string;
+    /**
+     * base64 decode string
+     * @param input
+     */
+    base64Decode(input: string): string;
+    /**
+     * Generates an JWK RSA S256 Thumbprint
+     * @param request
+     */
+    getPublicKeyThumbprint(request: SignedHttpRequestParameters): Promise<string>;
+    /**
+     * Removes cryptographic keypair from key store matching the keyId passed in
+     * @param kid
+     */
+    removeTokenBindingKey(kid: string): Promise<boolean>;
+    /**
+     * Removes all cryptographic keys from IndexedDB storage
+     */
+    clearKeystore(): Promise<boolean>;
+    /**
+     * Returns a signed proof-of-possession token with a given acces token that contains a cnf claim with the required kid.
+     * @param accessToken
+     */
+    signJwt(payload: SignedHttpRequest, kid: string, correlationId?: string): Promise<string>;
+    /**
+     * Returns the SHA-256 hash of an input string
+     * @param plainText
+     */
+    hashString(plainText: string): Promise<string>;
+}
+export declare const DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto;
 //# sourceMappingURL=ICrypto.d.ts.map

package/dist/crypto/ICrypto.mjs

@@ -1,37 +1,37 @@
-/*! @azure/msal-common v14.1.0 2023-10-05 */
+/*! @azure/msal-common v14.2.0-alpha.0 2023-12-07 */
 'use strict';
 import { createClientAuthError } from '../error/ClientAuthError.mjs';
 import { methodNotImplemented } from '../error/ClientAuthErrorCodes.mjs';
 
-/*
- * 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);
-    },
-    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);
-    },
+/*
+ * 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);
+    },
+    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);
+    },
 };
 
 export { DEFAULT_CRYPTO_IMPLEMENTATION };

package/dist/crypto/IGuidGenerator.d.ts

@@ -1,5 +1,5 @@
-export interface IGuidGenerator {
-    generateGuid(): string;
-    isGuid(guid: string): boolean;
-}
+export interface IGuidGenerator {
+    generateGuid(): string;
+    isGuid(guid: string): boolean;
+}
 //# sourceMappingURL=IGuidGenerator.d.ts.map

package/dist/crypto/JoseHeader.d.ts

@@ -1,23 +1,23 @@
-import { JsonTypes } from "../utils/Constants";
-export type JoseHeaderOptions = {
-    typ?: JsonTypes;
-    alg?: string;
-    kid?: string;
-};
-/** @internal */
-export declare class JoseHeader {
-    typ?: JsonTypes;
-    alg?: string;
-    kid?: string;
-    constructor(options: JoseHeaderOptions);
-    /**
-     * Builds SignedHttpRequest formatted JOSE Header from the
-     * JOSE Header options provided or previously set on the object and returns
-     * the stringified header object.
-     * Throws if keyId or algorithm aren't provided since they are required for Access Token Binding.
-     * @param shrHeaderOptions
-     * @returns
-     */
-    static getShrHeaderString(shrHeaderOptions: JoseHeaderOptions): string;
-}
+import { JsonTypes } from "../utils/Constants";
+export type JoseHeaderOptions = {
+    typ?: JsonTypes;
+    alg?: string;
+    kid?: string;
+};
+/** @internal */
+export declare class JoseHeader {
+    typ?: JsonTypes;
+    alg?: string;
+    kid?: string;
+    constructor(options: JoseHeaderOptions);
+    /**
+     * Builds SignedHttpRequest formatted JOSE Header from the
+     * JOSE Header options provided or previously set on the object and returns
+     * the stringified header object.
+     * Throws if keyId or algorithm aren't provided since they are required for Access Token Binding.
+     * @param shrHeaderOptions
+     * @returns
+     */
+    static getShrHeaderString(shrHeaderOptions: JoseHeaderOptions): string;
+}
 //# sourceMappingURL=JoseHeader.d.ts.map

package/dist/crypto/JoseHeader.mjs

@@ -1,45 +1,45 @@
-/*! @azure/msal-common v14.1.0 2023-10-05 */
+/*! @azure/msal-common v14.2.0-alpha.0 2023-12-07 */
 'use strict';
 import { createJoseHeaderError } from '../error/JoseHeaderError.mjs';
 import { JsonTypes } from '../utils/Constants.mjs';
 import { missingKidError, missingAlgError } from '../error/JoseHeaderErrorCodes.mjs';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/** @internal */
-class JoseHeader {
-    constructor(options) {
-        this.typ = options.typ;
-        this.alg = options.alg;
-        this.kid = options.kid;
-    }
-    /**
-     * Builds SignedHttpRequest formatted JOSE Header from the
-     * JOSE Header options provided or previously set on the object and returns
-     * the stringified header object.
-     * Throws if keyId or algorithm aren't provided since they are required for Access Token Binding.
-     * @param shrHeaderOptions
-     * @returns
-     */
-    static getShrHeaderString(shrHeaderOptions) {
-        // KeyID is required on the SHR header
-        if (!shrHeaderOptions.kid) {
-            throw createJoseHeaderError(missingKidError);
-        }
-        // Alg is required on the SHR header
-        if (!shrHeaderOptions.alg) {
-            throw createJoseHeaderError(missingAlgError);
-        }
-        const shrHeader = new JoseHeader({
-            // Access Token PoP headers must have type pop, but the type header can be overriden for special cases
-            typ: shrHeaderOptions.typ || JsonTypes.Pop,
-            kid: shrHeaderOptions.kid,
-            alg: shrHeaderOptions.alg,
-        });
-        return JSON.stringify(shrHeader);
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/** @internal */
+class JoseHeader {
+    constructor(options) {
+        this.typ = options.typ;
+        this.alg = options.alg;
+        this.kid = options.kid;
+    }
+    /**
+     * Builds SignedHttpRequest formatted JOSE Header from the
+     * JOSE Header options provided or previously set on the object and returns
+     * the stringified header object.
+     * Throws if keyId or algorithm aren't provided since they are required for Access Token Binding.
+     * @param shrHeaderOptions
+     * @returns
+     */
+    static getShrHeaderString(shrHeaderOptions) {
+        // KeyID is required on the SHR header
+        if (!shrHeaderOptions.kid) {
+            throw createJoseHeaderError(missingKidError);
+        }
+        // Alg is required on the SHR header
+        if (!shrHeaderOptions.alg) {
+            throw createJoseHeaderError(missingAlgError);
+        }
+        const shrHeader = new JoseHeader({
+            // Access Token PoP headers must have type pop, but the type header can be overriden for special cases
+            typ: shrHeaderOptions.typ || JsonTypes.Pop,
+            kid: shrHeaderOptions.kid,
+            alg: shrHeaderOptions.alg,
+        });
+        return JSON.stringify(shrHeader);
+    }
 }
 
 export { JoseHeader };

package/dist/crypto/PopTokenGenerator.d.ts

@@ -1,61 +1,61 @@
-import { ICrypto, SignedHttpRequestParameters } from "./ICrypto";
-import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
-import { Logger } from "../logger/Logger";
-/**
- * See eSTS docs for more info.
- * - A kid element, with the value containing an RFC 7638-compliant JWK thumbprint that is base64 encoded.
- * -  xms_ksl element, representing the storage location of the key's secret component on the client device. One of two values:
- *      - sw: software storage
- *      - uhw: hardware storage
- */
-type ReqCnf = {
-    kid: string;
-    xms_ksl: KeyLocation;
-};
-export type ReqCnfData = {
-    kid: string;
-    reqCnfString: string;
-    reqCnfHash: string;
-};
-declare const KeyLocation: {
-    readonly SW: "sw";
-    readonly UHW: "uhw";
-};
-export type KeyLocation = (typeof KeyLocation)[keyof typeof KeyLocation];
-/** @internal */
-export declare class PopTokenGenerator {
-    private cryptoUtils;
-    private performanceClient?;
-    constructor(cryptoUtils: ICrypto, performanceClient?: IPerformanceClient);
-    /**
-     * 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
-     */
-    generateCnf(request: SignedHttpRequestParameters, logger: Logger): Promise<ReqCnfData>;
-    /**
-     * Generates key_id for a SHR token request
-     * @param request
-     * @returns
-     */
-    generateKid(request: SignedHttpRequestParameters): Promise<ReqCnf>;
-    /**
-     * Signs the POP access_token with the local generated key-pair
-     * @param accessToken
-     * @param request
-     * @returns
-     */
-    signPopToken(accessToken: string, keyId: string, request: SignedHttpRequestParameters): Promise<string>;
-    /**
-     * Utility function to generate the signed JWT for an access_token
-     * @param payload
-     * @param kid
-     * @param request
-     * @param claims
-     * @returns
-     */
-    signPayload(payload: string, keyId: string, request: SignedHttpRequestParameters, claims?: object): Promise<string>;
-}
-export {};
+import { ICrypto, SignedHttpRequestParameters } from "./ICrypto";
+import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
+import { Logger } from "../logger/Logger";
+/**
+ * See eSTS docs for more info.
+ * - A kid element, with the value containing an RFC 7638-compliant JWK thumbprint that is base64 encoded.
+ * -  xms_ksl element, representing the storage location of the key's secret component on the client device. One of two values:
+ *      - sw: software storage
+ *      - uhw: hardware storage
+ */
+type ReqCnf = {
+    kid: string;
+    xms_ksl: KeyLocation;
+};
+export type ReqCnfData = {
+    kid: string;
+    reqCnfString: string;
+    reqCnfHash: string;
+};
+declare const KeyLocation: {
+    readonly SW: "sw";
+    readonly UHW: "uhw";
+};
+export type KeyLocation = (typeof KeyLocation)[keyof typeof KeyLocation];
+/** @internal */
+export declare class PopTokenGenerator {
+    private cryptoUtils;
+    private performanceClient?;
+    constructor(cryptoUtils: ICrypto, performanceClient?: IPerformanceClient);
+    /**
+     * 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
+     */
+    generateCnf(request: SignedHttpRequestParameters, logger: Logger): Promise<ReqCnfData>;
+    /**
+     * Generates key_id for a SHR token request
+     * @param request
+     * @returns
+     */
+    generateKid(request: SignedHttpRequestParameters): Promise<ReqCnf>;
+    /**
+     * Signs the POP access_token with the local generated key-pair
+     * @param accessToken
+     * @param request
+     * @returns
+     */
+    signPopToken(accessToken: string, keyId: string, request: SignedHttpRequestParameters): Promise<string>;
+    /**
+     * Utility function to generate the signed JWT for an access_token
+     * @param payload
+     * @param kid
+     * @param request
+     * @param claims
+     * @returns
+     */
+    signPayload(payload: string, keyId: string, request: SignedHttpRequestParameters, claims?: object): Promise<string>;
+}
+export {};
 //# sourceMappingURL=PopTokenGenerator.d.ts.map

package/dist/crypto/PopTokenGenerator.mjs

@@ -1,91 +1,91 @@
-/*! @azure/msal-common v14.1.0 2023-10-05 */
+/*! @azure/msal-common v14.2.0-alpha.0 2023-12-07 */
 'use strict';
 import { TimeUtils } from '../utils/TimeUtils.mjs';
 import { UrlString } from '../url/UrlString.mjs';
 import { PerformanceEvents } from '../telemetry/performance/PerformanceEvent.mjs';
 import { invokeAsync } from '../utils/FunctionWrappers.mjs';
 
-/*
- * 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.base64Encode(JSON.stringify(reqCnf));
-        return {
-            kid: reqCnf.kid,
-            reqCnfString,
-            reqCnfHash: await this.cryptoUtils.hashString(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, } = request;
-        const resourceUrlString = resourceRequestUri
-            ? new UrlString(resourceRequestUri)
-            : undefined;
-        const resourceUrlComponents = resourceUrlString?.getUrlComponents();
-        return await this.cryptoUtils.signJwt({
-            at: payload,
-            ts: TimeUtils.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, request.correlationId);
-    }
+/*
+ * 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.base64Encode(JSON.stringify(reqCnf));
+        return {
+            kid: reqCnf.kid,
+            reqCnfString,
+            reqCnfHash: await this.cryptoUtils.hashString(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, } = request;
+        const resourceUrlString = resourceRequestUri
+            ? new UrlString(resourceRequestUri)
+            : undefined;
+        const resourceUrlComponents = resourceUrlString?.getUrlComponents();
+        return await this.cryptoUtils.signJwt({
+            at: payload,
+            ts: TimeUtils.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, request.correlationId);
+    }
 }
 
 export { PopTokenGenerator };

package/dist/crypto/SignedHttpRequest.d.ts

@@ -1,12 +1,12 @@
-export type SignedHttpRequest = {
-    at?: string;
-    cnf?: object;
-    m?: string;
-    u?: string;
-    p?: string;
-    q?: [Array<string>, string];
-    ts?: number;
-    nonce?: string;
-    client_claims?: string;
-};
+export type SignedHttpRequest = {
+    at?: string;
+    cnf?: object;
+    m?: string;
+    u?: string;
+    p?: string;
+    q?: [Array<string>, string];
+    ts?: number;
+    nonce?: string;
+    client_claims?: string;
+};
 //# sourceMappingURL=SignedHttpRequest.d.ts.map