fix(signature-v4): getCanonicalHeaders ignores undefined header values (

#3789)
aws · Jul 12, 2022 · 78690d3 · 78690d3
1 parent b43e0b5
commit 78690d3
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/packages/signature-v4/src/getCanonicalHeaders.spec.ts b/packages/signature-v4/src/getCanonicalHeaders.spec.ts
@@ -1,4 +1,5 @@
 import { HttpRequest } from "@aws-sdk/protocol-http";
+import { HeaderBag } from "@aws-sdk/types";
 
 import { ALWAYS_UNSIGNABLE_HEADERS } from "./constants";
 import { getCanonicalHeaders } from "./getCanonicalHeaders";
@@ -49,6 +50,24 @@ describe("getCanonicalHeaders", () => {
     });
   });
 
+  it("should ignore headers with undefined values", () => {
+    const headers: HeaderBag = {
+      "x-amz-user-agent": "aws-sdk-js-v3",
+      host: "foo.us-east-1.amazonaws.com",
+    };
+
+    (headers.foo as any) = undefined;
+    const request = new HttpRequest({
+      method: "POST",
+      protocol: "https:",
+      path: "/",
+      headers,
+      hostname: "foo.us-east-1.amazonaws.com",
+    });
+
+    expect(getCanonicalHeaders(request)).toEqual(headers);
+  });
+
   it("should allow specifying custom unsignable headers", () => {
     const request = new HttpRequest({
       method: "POST",

diff --git a/packages/signature-v4/src/getCanonicalHeaders.ts b/packages/signature-v4/src/getCanonicalHeaders.ts
@@ -12,6 +12,10 @@ export const getCanonicalHeaders = (
 ): HeaderBag => {
   const canonical: HeaderBag = {};
   for (const headerName of Object.keys(headers).sort()) {
+    if (!headers[headerName]) {
+      continue;
+    }
+
     const canonicalHeaderName = headerName.toLowerCase();
     if (
       canonicalHeaderName in ALWAYS_UNSIGNABLE_HEADERS ||