Add the ability to provide arbitrary custom header claims

cross-org · Jul 22, 2024 · 0850760 · 0850760
1 parent 51da4ac
commit 0850760
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/mod.test.ts b/mod.test.ts
@@ -136,7 +136,7 @@ test("signJWT() supports additional header claims", async () => {
     const payload = { foo: "bar", baz: 42 };
     const jwtString = await signJWT(payload, privateKey, {
         algorithm: algorithm,
-        additionalHeaderClaims: { typ: "JOSE", kid: "abc123" },
+        additionalHeaderClaims: { typ: "JOSE", kid: "abc123", someOther: [1, 2, 3] },
     });
 
     const unsafeHeader = unsafeParseJOSEHeader(jwtString);
@@ -145,7 +145,7 @@ test("signJWT() supports additional header claims", async () => {
 
     assertEquals(unsafePayload, payload);
     assertEquals(decodedPayload, payload);
-    const expectedHeader: JOSEHeader = { alg: algorithm, typ: "JOSE", kid: "abc123" };
+    const expectedHeader: JOSEHeader = { alg: algorithm, typ: "JOSE", kid: "abc123", someOther: [1, 2, 3] };
     assertEquals(unsafeHeader, expectedHeader);
 });
 

diff --git a/src/standardclaims.ts b/src/standardclaims.ts
@@ -30,6 +30,12 @@ export interface JOSEHeader {
      * (see RFC 7519 section 5.1, RFC 7515 section 4.1.9, RFC 7516 section 4.1.11)
      */
     typ?: string;
+
+    /**
+     * Allows for the inclusion of other header properties with string keys and values of any type.
+     */
+    // deno-lint-ignore no-explicit-any
+    [key: string]: any;
 }
 
 /**