Added Constants for Encoding Types

change/@azure-msal-common-d94419f4-a31a-4b99-a40d-f04a808bb1e2.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Added Constants for Encoding Types #7766",
+  "packageName": "@azure/msal-common",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@azure-msal-node-cf9e46ab-4d75-4cae-80c0-661642f44975.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "Added Constants for Encoding Types #7766",
+  "packageName": "@azure/msal-node",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

lib/msal-common/apiReview/msal-common.api.md

@@ -2221,7 +2221,9 @@ const emptyInputScopeSet = "empty_input_scopeset";
 //
 // @public (undocumented)
 export const EncodingTypes: {
+    readonly BASE64: "base64";
     readonly HEX: "hex";
+    readonly UTF8: "utf-8";
 };
 
 // @public (undocumented)

lib/msal-common/src/utils/Constants.ts

@@ -382,6 +382,8 @@ export const ONE_DAY_IN_MS = 86400000;
 export const DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = 300;
 
 export const EncodingTypes = {
+    BASE64: "base64",
     HEX: "hex",
+    UTF8: "utf-8",
 } as const;
 export type EncodingTypes = (typeof EncodingTypes)[keyof typeof EncodingTypes];

lib/msal-common/test/client/ClientTestUtils.ts

@@ -29,7 +29,7 @@ import {
     createClientAuthError,
 } from "../../src/error/ClientAuthError.js";
 import { ServerTelemetryManager } from "../../src/telemetry/server/ServerTelemetryManager.js";
-import { Constants } from "../../src/utils/Constants.js";
+import { Constants, EncodingTypes } from "../../src/utils/Constants.js";
 import { AuthorityOptions } from "../../src/authority/AuthorityOptions.js";
 import { TokenKeys } from "../../src/cache/utils/CacheTypes.js";
 
@@ -196,18 +196,21 @@ export const mockCrypto = {
         return RANDOM_TEST_GUID;
     },
     base64Decode(input: string): string {
-        return Buffer.from(input, "base64").toString("utf8");
+        return Buffer.from(input, EncodingTypes.BASE64).toString("utf8");
     },
     base64Encode(input: string): string {
-        return Buffer.from(input, "utf-8").toString("base64");
+        return Buffer.from(input, EncodingTypes.UTF8).toString(
+            EncodingTypes.BASE64
+        );
     },
     base64UrlEncode(input: string): string {
-        return Buffer.from(input, "utf-8").toString("base64url");
+        return Buffer.from(input, EncodingTypes.UTF8).toString("base64url");
     },
     encodeKid(input: string): string {
-        return Buffer.from(JSON.stringify({ kid: input }), "utf-8").toString(
-            "base64url"
-        );
+        return Buffer.from(
+            JSON.stringify({ kid: input }),
+            EncodingTypes.UTF8
+        ).toString("base64url");
     },
     async getPublicKeyThumbprint(): Promise<string> {
         return TEST_POP_VALUES.KID;

lib/msal-node/src/client/ClientAssertion.ts

@@ -9,6 +9,7 @@ import {
     Constants,
     createClientAuthError,
     ClientAuthErrorCodes,
+    EncodingTypes,
 } from "@azure/msal-common/node";
 import { CryptoProvider } from "../crypto/CryptoProvider.js";
 import { EncodingUtils } from "../utils/EncodingUtils.js";
@@ -145,7 +146,7 @@ export class ClientAssertion {
         Object.assign(header, {
             [thumbprintHeader]: EncodingUtils.base64EncodeUrl(
                 this.thumbprint,
-                "hex"
+                EncodingTypes.HEX
             ),
         } as Partial<jwt.JwtHeader>);
 

lib/msal-node/src/client/ManagedIdentitySources/AzureArc.ts

@@ -13,6 +13,7 @@ import {
     NetworkRequestOptions,
     Logger,
     ServerAuthorizationTokenResponse,
+    EncodingTypes,
 } from "@azure/msal-common/node";
 import { ManagedIdentityRequestParameters } from "../../config/ManagedIdentityRequestParameters.js";
 import { BaseManagedIdentitySource } from "./BaseManagedIdentitySource.js";
@@ -290,7 +291,7 @@ export class AzureArc extends BaseManagedIdentitySource {
             // attempt to read the contents of the secret file
             let secret;
             try {
-                secret = readFileSync(secretFilePath, "utf-8");
+                secret = readFileSync(secretFilePath, EncodingTypes.UTF8);
             } catch (e) {
                 throw createManagedIdentityError(
                     ManagedIdentityErrorCodes.unableToReadSecretFile

lib/msal-node/src/crypto/CryptoProvider.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ICrypto, PkceCodes } from "@azure/msal-common/node";
+import { EncodingTypes, ICrypto, PkceCodes } from "@azure/msal-common/node";
 import { GuidGenerator } from "./GuidGenerator.js";
 import { EncodingUtils } from "../utils/EncodingUtils.js";
 import { PkceGenerator } from "./PkceGenerator.js";
@@ -106,8 +106,8 @@ export class CryptoProvider implements ICrypto {
      */
     async hashString(plainText: string): Promise<string> {
         return EncodingUtils.base64EncodeUrl(
-            this.hashUtils.sha256(plainText).toString("base64"),
-            "base64"
+            this.hashUtils.sha256(plainText).toString(EncodingTypes.BASE64),
+            EncodingTypes.BASE64
         );
     }
 }

lib/msal-node/src/crypto/PkceGenerator.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { Constants, PkceCodes } from "@azure/msal-common/node";
+import { Constants, EncodingTypes, PkceCodes } from "@azure/msal-common/node";
 import { CharSet, RANDOM_OCTET_SIZE } from "../utils/Constants.js";
 import { EncodingUtils } from "../utils/EncodingUtils.js";
 import { HashUtils } from "./HashUtils.js";
@@ -56,8 +56,8 @@ export class PkceGenerator {
      */
     private generateCodeChallengeFromVerifier(codeVerifier: string): string {
         return EncodingUtils.base64EncodeUrl(
-            this.hashUtils.sha256(codeVerifier).toString("base64"),
-            "base64"
+            this.hashUtils.sha256(codeVerifier).toString(EncodingTypes.BASE64),
+            EncodingTypes.BASE64
         );
     }
 }

lib/msal-node/src/utils/EncodingUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { Constants } from "@azure/msal-common/node";
+import { Constants, EncodingTypes } from "@azure/msal-common/node";
 
 export class EncodingUtils {
     /**
@@ -13,7 +13,7 @@ export class EncodingUtils {
      * @param str text
      */
     static base64Encode(str: string, encoding?: BufferEncoding): string {
-        return Buffer.from(str, encoding).toString("base64");
+        return Buffer.from(str, encoding).toString(EncodingTypes.BASE64);
     }
 
     /**
@@ -34,7 +34,7 @@ export class EncodingUtils {
      * @param base64Str Base64 encoded text
      */
     static base64Decode(base64Str: string): string {
-        return Buffer.from(base64Str, "base64").toString("utf8");
+        return Buffer.from(base64Str, EncodingTypes.BASE64).toString("utf8");
     }
 
     /**

lib/msal-node/test/cache/TokenCache.spec.ts

@@ -9,6 +9,7 @@ import {
     TokenCacheContext,
     ICachePlugin,
     buildStaticAuthorityOptions,
+    EncodingTypes,
 } from "@azure/msal-common";
 import { NodeStorage } from "../../src/cache/NodeStorage.js";
 import { TokenCache } from "../../src/cache/TokenCache.js";
@@ -129,7 +130,7 @@ describe("TokenCache tests", () => {
             context.tokenCache.deserialize(
                 await promises.readFile(
                     "./test/cache/cache-test-files/cache-unrecognized-entities.json",
-                    "utf-8"
+                    EncodingTypes.UTF8
                 )
             );
         };
@@ -194,9 +195,11 @@ describe("TokenCache tests", () => {
                 if (context.hasChanged == true) {
                     throw new Error("hasChanged should be false");
                 }
-                return promises.readFile(cachePath, "utf-8").then((data) => {
-                    context.tokenCache.deserialize(data);
-                });
+                return promises
+                    .readFile(cachePath, EncodingTypes.UTF8)
+                    .then((data) => {
+                        context.tokenCache.deserialize(data);
+                    });
             }
         );
 
@@ -251,7 +254,7 @@ describe("TokenCache tests", () => {
         const cachePath = "./test/cache/cache-test-files/default-cache.json";
         const beforeCacheAccess = async (context: TokenCacheContext) => {
             context.tokenCache.deserialize(
-                await promises.readFile(cachePath, "utf-8")
+                await promises.readFile(cachePath, EncodingTypes.UTF8)
             );
         };
         const afterCacheAccess = async (context: TokenCacheContext) => {

lib/msal-node/test/client/ClientAssertion.spec.ts

@@ -12,7 +12,7 @@ import { CryptoProvider } from "../../src/crypto/CryptoProvider.js";
 import { EncodingUtils } from "../../src/utils/EncodingUtils.js";
 import { JwtConstants } from "../../src/utils/Constants.js";
 import { getClientAssertionCallback } from "./ClientTestUtils.js";
-import { getClientAssertion } from "@azure/msal-common";
+import { EncodingTypes, getClientAssertion } from "@azure/msal-common";
 import jwt from "jsonwebtoken";
 
 jest.mock("jsonwebtoken");
@@ -65,7 +65,7 @@ describe("Client assertion test", () => {
                 [JwtConstants.ALGORITHM]: JwtConstants.RSA_256,
                 [JwtConstants.X5T]: EncodingUtils.base64EncodeUrl(
                     TEST_CONSTANTS.THUMBPRINT,
-                    "hex"
+                    EncodingTypes.HEX
                 ),
             },
         };
@@ -95,7 +95,7 @@ describe("Client assertion test", () => {
                 [JwtConstants.ALGORITHM]: JwtConstants.PSS_256,
                 [JwtConstants.X5T_256]: EncodingUtils.base64EncodeUrl(
                     TEST_CONSTANTS.THUMBPRINT256,
-                    "hex"
+                    EncodingTypes.HEX
                 ),
             },
         };
@@ -125,7 +125,7 @@ describe("Client assertion test", () => {
                 [JwtConstants.ALGORITHM]: JwtConstants.RSA_256,
                 [JwtConstants.X5T]: EncodingUtils.base64EncodeUrl(
                     TEST_CONSTANTS.THUMBPRINT,
-                    "hex"
+                    EncodingTypes.HEX
                 ),
                 [JwtConstants.X5C]: TEST_CONSTANTS.X5C_FROM_PUBLIC_CERTIFICATE,
             },
@@ -157,7 +157,7 @@ describe("Client assertion test", () => {
                 [JwtConstants.ALGORITHM]: JwtConstants.PSS_256,
                 [JwtConstants.X5T_256]: EncodingUtils.base64EncodeUrl(
                     TEST_CONSTANTS.THUMBPRINT256,
-                    "hex"
+                    EncodingTypes.HEX
                 ),
                 [JwtConstants.X5C]: TEST_CONSTANTS.X5C_FROM_PUBLIC_CERTIFICATE,
             },

lib/msal-node/test/utils/CryptoKeys.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { EncodingTypes } from "@azure/msal-common";
 import crypto from "crypto";
 
 export class CryptoKeys {
@@ -28,6 +29,6 @@ export class CryptoKeys {
         this._thumbprint = crypto
             .createHash("sha512")
             .update(publicKey)
-            .digest("hex");
+            .digest(EncodingTypes.HEX);
     }
 }