jwt.js 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. // src/utils/jwt/jwt.ts
  2. import { decodeBase64Url, encodeBase64Url } from "../../utils/encode.js";
  3. import { AlgorithmTypes } from "./jwa.js";
  4. import { signing, verifying } from "./jws.js";
  5. import {
  6. JwtAlgorithmMismatch,
  7. JwtAlgorithmNotAllowed,
  8. JwtAlgorithmRequired,
  9. JwtHeaderInvalid,
  10. JwtHeaderRequiresKid,
  11. JwtPayloadRequiresAud,
  12. JwtSymmetricAlgorithmNotAllowed,
  13. JwtTokenAudience,
  14. JwtTokenExpired,
  15. JwtTokenInvalid,
  16. JwtTokenIssuedAt,
  17. JwtTokenIssuer,
  18. JwtTokenNotBefore,
  19. JwtTokenSignatureMismatched
  20. } from "./types.js";
  21. import { utf8Decoder, utf8Encoder } from "./utf8.js";
  22. var encodeJwtPart = (part) => encodeBase64Url(utf8Encoder.encode(JSON.stringify(part)).buffer).replace(/=/g, "");
  23. var encodeSignaturePart = (buf) => encodeBase64Url(buf).replace(/=/g, "");
  24. var decodeJwtPart = (part) => JSON.parse(utf8Decoder.decode(decodeBase64Url(part)));
  25. function isTokenHeader(obj) {
  26. if (typeof obj === "object" && obj !== null) {
  27. const objWithAlg = obj;
  28. return "alg" in objWithAlg && Object.values(AlgorithmTypes).includes(objWithAlg.alg) && (!("typ" in objWithAlg) || objWithAlg.typ === "JWT");
  29. }
  30. return false;
  31. }
  32. var sign = async (payload, privateKey, alg = "HS256") => {
  33. const encodedPayload = encodeJwtPart(payload);
  34. let encodedHeader;
  35. if (typeof privateKey === "object" && "alg" in privateKey) {
  36. alg = privateKey.alg;
  37. encodedHeader = encodeJwtPart({ alg, typ: "JWT", kid: privateKey.kid });
  38. } else {
  39. encodedHeader = encodeJwtPart({ alg, typ: "JWT" });
  40. }
  41. const partialToken = `${encodedHeader}.${encodedPayload}`;
  42. const signaturePart = await signing(privateKey, alg, utf8Encoder.encode(partialToken));
  43. const signature = encodeSignaturePart(signaturePart);
  44. return `${partialToken}.${signature}`;
  45. };
  46. var verify = async (token, publicKey, algOrOptions) => {
  47. if (!algOrOptions) {
  48. throw new JwtAlgorithmRequired();
  49. }
  50. const {
  51. alg,
  52. iss,
  53. nbf = true,
  54. exp = true,
  55. iat = true,
  56. aud
  57. } = typeof algOrOptions === "string" ? { alg: algOrOptions } : algOrOptions;
  58. if (!alg) {
  59. throw new JwtAlgorithmRequired();
  60. }
  61. const tokenParts = token.split(".");
  62. if (tokenParts.length !== 3) {
  63. throw new JwtTokenInvalid(token);
  64. }
  65. const { header, payload } = decode(token);
  66. if (!isTokenHeader(header)) {
  67. throw new JwtHeaderInvalid(header);
  68. }
  69. if (header.alg !== alg) {
  70. throw new JwtAlgorithmMismatch(alg, header.alg);
  71. }
  72. const now = Math.floor(Date.now() / 1e3);
  73. if (nbf && payload.nbf && payload.nbf > now) {
  74. throw new JwtTokenNotBefore(token);
  75. }
  76. if (exp && payload.exp && payload.exp <= now) {
  77. throw new JwtTokenExpired(token);
  78. }
  79. if (iat && payload.iat && now < payload.iat) {
  80. throw new JwtTokenIssuedAt(now, payload.iat);
  81. }
  82. if (iss) {
  83. if (!payload.iss) {
  84. throw new JwtTokenIssuer(iss, null);
  85. }
  86. if (typeof iss === "string" && payload.iss !== iss) {
  87. throw new JwtTokenIssuer(iss, payload.iss);
  88. }
  89. if (iss instanceof RegExp && !iss.test(payload.iss)) {
  90. throw new JwtTokenIssuer(iss, payload.iss);
  91. }
  92. }
  93. if (aud) {
  94. if (!payload.aud) {
  95. throw new JwtPayloadRequiresAud(payload);
  96. }
  97. const audiences = Array.isArray(payload.aud) ? payload.aud : [payload.aud];
  98. const matched = audiences.some(
  99. (payloadAud) => aud instanceof RegExp ? aud.test(payloadAud) : typeof aud === "string" ? payloadAud === aud : Array.isArray(aud) && aud.includes(payloadAud)
  100. );
  101. if (!matched) {
  102. throw new JwtTokenAudience(aud, payload.aud);
  103. }
  104. }
  105. const headerPayload = token.substring(0, token.lastIndexOf("."));
  106. const verified = await verifying(
  107. publicKey,
  108. alg,
  109. decodeBase64Url(tokenParts[2]),
  110. utf8Encoder.encode(headerPayload)
  111. );
  112. if (!verified) {
  113. throw new JwtTokenSignatureMismatched(token);
  114. }
  115. return payload;
  116. };
  117. var symmetricAlgorithms = [
  118. AlgorithmTypes.HS256,
  119. AlgorithmTypes.HS384,
  120. AlgorithmTypes.HS512
  121. ];
  122. var verifyWithJwks = async (token, options, init) => {
  123. const verifyOpts = options.verification || {};
  124. const header = decodeHeader(token);
  125. if (!isTokenHeader(header)) {
  126. throw new JwtHeaderInvalid(header);
  127. }
  128. if (!header.kid) {
  129. throw new JwtHeaderRequiresKid(header);
  130. }
  131. if (symmetricAlgorithms.includes(header.alg)) {
  132. throw new JwtSymmetricAlgorithmNotAllowed(header.alg);
  133. }
  134. if (!options.allowedAlgorithms.includes(header.alg)) {
  135. throw new JwtAlgorithmNotAllowed(header.alg, options.allowedAlgorithms);
  136. }
  137. let verifyKeys = options.keys ? [...options.keys] : void 0;
  138. if (options.jwks_uri) {
  139. const response = await fetch(options.jwks_uri, init);
  140. if (!response.ok) {
  141. throw new Error(`failed to fetch JWKS from ${options.jwks_uri}`);
  142. }
  143. const data = await response.json();
  144. if (!data.keys) {
  145. throw new Error('invalid JWKS response. "keys" field is missing');
  146. }
  147. if (!Array.isArray(data.keys)) {
  148. throw new Error('invalid JWKS response. "keys" field is not an array');
  149. }
  150. verifyKeys ??= [];
  151. verifyKeys.push(...data.keys);
  152. } else if (!verifyKeys) {
  153. throw new Error('verifyWithJwks requires options for either "keys" or "jwks_uri" or both');
  154. }
  155. const matchingKey = verifyKeys.find((key) => key.kid === header.kid);
  156. if (!matchingKey) {
  157. throw new JwtTokenInvalid(token);
  158. }
  159. if (matchingKey.alg && matchingKey.alg !== header.alg) {
  160. throw new JwtAlgorithmMismatch(matchingKey.alg, header.alg);
  161. }
  162. return await verify(token, matchingKey, {
  163. alg: header.alg,
  164. ...verifyOpts
  165. });
  166. };
  167. var decode = (token) => {
  168. const parts = token.split(".");
  169. if (parts.length !== 3) {
  170. throw new JwtTokenInvalid(token);
  171. }
  172. try {
  173. const header = decodeJwtPart(parts[0]);
  174. const payload = decodeJwtPart(parts[1]);
  175. return {
  176. header,
  177. payload
  178. };
  179. } catch {
  180. throw new JwtTokenInvalid(token);
  181. }
  182. };
  183. var decodeHeader = (token) => {
  184. const parts = token.split(".");
  185. if (parts.length !== 3) {
  186. throw new JwtTokenInvalid(token);
  187. }
  188. try {
  189. return decodeJwtPart(parts[0]);
  190. } catch {
  191. throw new JwtTokenInvalid(token);
  192. }
  193. };
  194. export {
  195. decode,
  196. decodeHeader,
  197. isTokenHeader,
  198. sign,
  199. verify,
  200. verifyWithJwks
  201. };