aboutsummaryrefslogtreecommitdiff
path: root/test/js/third_party/jsonwebtoken/claim-sub.test.js
blob: 6846a688db3d78542574a1a99ad942dcdaa2dede (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
"use strict";

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

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

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

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

    it('should error when "sub" is in payload', function (done) {
      signWithSubject("foo", { sub: "bar" }, err => {
        testUtils.asyncCheck(done, () => {
          expect(err).toBeInstanceOf(Error);
          expect(err).toHaveProperty(
            "message",
            'Bad "options.subject" option. The payload already has an "sub" property.',
          );
        });
      });
    });

    it("should error with a string payload", function (done) {
      signWithSubject("foo", "a string payload", err => {
        testUtils.asyncCheck(done, () => {
          expect(err).toBeInstanceOf(Error);
          expect(err).toHaveProperty("message", "invalid subject option for string payload");
        });
      });
    });

    it("should error with a Buffer payload", function (done) {
      signWithSubject("foo", new Buffer("a Buffer payload"), err => {
        testUtils.asyncCheck(done, () => {
          expect(err).toBeInstanceOf(Error);
          expect(err).toHaveProperty("message", "invalid subject option for object payload");
        });
      });
    });
  });

  describe('when signing and verifying a token with "subject" option', function () {
    it('should verify with a string "subject"', function (done) {
      signWithSubject("foo", {}, (e1, token) => {
        testUtils.verifyJWTHelper(token, "secret", { subject: "foo" }, (e2, decoded) => {
          testUtils.asyncCheck(done, () => {
            expect(e1).toBeNull();
            expect(e2).toBeNull();
            expect(decoded).toHaveProperty("sub", "foo");
          });
        });
      });
    });

    it('should verify with a string "sub"', function (done) {
      signWithSubject(undefined, { sub: "foo" }, (e1, token) => {
        testUtils.verifyJWTHelper(token, "secret", { subject: "foo" }, (e2, decoded) => {
          testUtils.asyncCheck(done, () => {
            expect(e1).toBeNull();
            expect(e2).toBeNull();
            expect(decoded).toHaveProperty("sub", "foo");
          });
        });
      });
    });

    it('should not verify "sub" if verify "subject" option not provided', function (done) {
      signWithSubject(undefined, { sub: "foo" }, (e1, token) => {
        testUtils.verifyJWTHelper(token, "secret", {}, (e2, decoded) => {
          testUtils.asyncCheck(done, () => {
            expect(e1).toBeNull();
            expect(e2).toBeNull();
            expect(decoded).toHaveProperty("sub", "foo");
          });
        });
      });
    });

    it('should error if "sub" does not match verify "subject" option', function (done) {
      signWithSubject(undefined, { sub: "foo" }, (e1, token) => {
        testUtils.verifyJWTHelper(token, "secret", { subject: "bar" }, e2 => {
          testUtils.asyncCheck(done, () => {
            expect(e1).toBeNull();
            expect(e2).toBeInstanceOf(jwt.JsonWebTokenError);
            expect(e2).toHaveProperty("message", "jwt subject invalid. expected: bar");
          });
        });
      });
    });

    it('should error without "sub" and with verify "subject" option', function (done) {
      signWithSubject(undefined, {}, (e1, token) => {
        testUtils.verifyJWTHelper(token, "secret", { subject: "foo" }, e2 => {
          testUtils.asyncCheck(done, () => {
            expect(e1).toBeNull();
            expect(e2).toBeInstanceOf(jwt.JsonWebTokenError);
            expect(e2).toHaveProperty("message", "jwt subject invalid. expected: foo");
          });
        });
      });
    });
  });
});