bun.sh/test/js/third_party/jsonwebtoken/header-kid.test.js

"use strict";

import { describe, expect, it } from "bun:test";
import jwt from "jsonwebtoken";
import util from "util";
import testUtils from "./test-utils";

function signWithKeyId(keyid, payload, callback) {
  const options = { algorithm: "HS256" };
  if (keyid !== undefined) {
    options.keyid = keyid;
  }
  testUtils.signJWTHelper(payload, "secret", options, callback);
}

describe("keyid", function () {
  describe('`jwt.sign` "keyid" option validation', function () {
    [true, false, null, -1, 0, 1, -1.1, 1.1, -Infinity, Infinity, NaN, [], ["foo"], {}, { foo: "bar" }].forEach(
      keyid => {
        it(`should error with with value ${util.inspect(keyid)}`, function (done) {
          signWithKeyId(keyid, {}, err => {
            testUtils.asyncCheck(done, () => {
              expect(err).toBeInstanceOf(Error);
              expect(err).toHaveProperty("message", '"keyid" must be a string');
            });
          });
        });
      },
    );

    // undefined needs special treatment because {} is not the same as {keyid: undefined}
    it("should error with with value undefined", function (done) {
      testUtils.signJWTHelper({}, "secret", { keyid: undefined, algorithm: "HS256" }, err => {
        testUtils.asyncCheck(done, () => {
          expect(err).toBeInstanceOf(Error);
          expect(err).toHaveProperty("message", '"keyid" must be a string');
        });
      });
    });
  });

  describe("when signing a token", function () {
    it('should not add "kid" header when "keyid" option not provided', function (done) {
      signWithKeyId(undefined, {}, (err, token) => {
        testUtils.asyncCheck(done, () => {
          const decoded = jwt.decode(token, { complete: true });
          expect(err).toBeNull();
          expect(decoded.header).not.toHaveProperty("kid");
        });
      });
    });

    it('should add "kid" header when "keyid" option is provided and an object payload', function (done) {
      signWithKeyId("foo", {}, (err, token) => {
        testUtils.asyncCheck(done, () => {
          const decoded = jwt.decode(token, { complete: true });
          expect(err).toBeNull();
          expect(decoded.header).toHaveProperty("kid", "foo");
        });
      });
    });

    it('should add "kid" header when "keyid" option is provided and a Buffer payload', function (done) {
      signWithKeyId("foo", new Buffer("a Buffer payload"), (err, token) => {
        testUtils.asyncCheck(done, () => {
          const decoded = jwt.decode(token, { complete: true });
          expect(err).toBeNull();
          expect(decoded.header).toHaveProperty("kid", "foo");
        });
      });
    });

    it('should add "kid" header when "keyid" option is provided and a string payload', function (done) {
      signWithKeyId("foo", "a string payload", (err, token) => {
        testUtils.asyncCheck(done, () => {
          const decoded = jwt.decode(token, { complete: true });
          expect(err).toBeNull();
          expect(decoded.header).toHaveProperty("kid", "foo");
        });
      });
    });
  });
});