Merge pull request #7393 from BitGo/ANT-1086

feat: support original url for hmac calculation

Author: bdesoky

modules/sdk-hmac/src/hmac.ts

@@ -28,22 +28,23 @@ export function calculateHMAC(key: string | BinaryLike | KeyObject, message: str
  * @param statusCode Only set for HTTP responses, leave blank for requests
  * @param method request method
  * @param authVersion authentication version (2 or 3)
+ * @param useOriginalPath whether to use the original urlPath without parsing (default false)
  * @returns {string | Buffer}
  */
-export function calculateHMACSubject<T extends string | Buffer = string>({
-  urlPath,
-  text,
-  timestamp,
-  statusCode,
-  method,
-  authVersion,
-}: CalculateHmacSubjectOptions<T>): T {
+export function calculateHMACSubject<T extends string | Buffer = string>(
+  { urlPath, text, timestamp, statusCode, method, authVersion }: CalculateHmacSubjectOptions<T>,
+  useOriginalPath = false
+): T {
   /* Normalize legacy 'del' to 'delete' for backward compatibility */
   if (method === 'del') {
     method = 'delete';
   }
-  const urlDetails = urlLib.parse(urlPath);
-  const queryPath = urlDetails.query && urlDetails.query.length > 0 ? urlDetails.path : urlDetails.pathname;
+
+  let queryPath: string | null = urlPath;
+  if (!useOriginalPath) {
+    const urlDetails = urlLib.parse(urlPath);
+    queryPath = urlDetails.query && urlDetails.query.length > 0 ? urlDetails.path : urlDetails.pathname;
+  }
 
   let prefixedText: string;
   if (statusCode !== undefined && isFinite(statusCode) && Number.isInteger(statusCode)) {

modules/sdk-hmac/test/hmac.ts

@@ -61,6 +61,35 @@ describe('HMAC Utility Functions', () => {
       ).to.equal(expectedSubject);
     });
 
+    it('should calculate the correct subject for a request with a trailing ? when useOriginalPath is true', () => {
+      const expectedSubject = 'GET|1672531200000|3.0|/api/test?|body-content';
+      expect(
+        calculateHMACSubject(
+          {
+            urlPath: '/api/test?',
+            text: 'body-content',
+            timestamp: MOCK_TIMESTAMP,
+            method: 'get',
+            authVersion: 3,
+          },
+          true
+        )
+      ).to.equal(expectedSubject);
+    });
+
+    it('should calculate the correct subject for a request with a trailing ? when useOriginalPath is false', () => {
+      const expectedSubject = 'GET|1672531200000|3.0|/api/test|body-content';
+      expect(
+        calculateHMACSubject({
+          urlPath: '/api/test?',
+          text: 'body-content',
+          timestamp: MOCK_TIMESTAMP,
+          method: 'get',
+          authVersion: 3,
+        })
+      ).to.equal(expectedSubject);
+    });
+
     it('should include statusCode for a response', () => {
       const expectedSubject = 'GET|1672531200000|/api/test|200|response-body';
       expect(