2.4.7

This reverts commit 4ceac0270f.

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: latest
+          registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test

.gitignore

@@ -145,4 +145,6 @@ dist
 
 # Custom
 /index.js
-/index.d.ts
+/index.d.ts
+/utils.js
+/utils.d.ts

.npmignore

@@ -1,7 +1,11 @@
-.github/
-src/
 .editorconfig
-index.spec.js
+.github/
-index.test.js
+.gitignore
-jest.config.ts
+.nvmrc
-tsconfig.json
+coverage/
+vite.config.ts
+src/
+tests/
+tsconfig.json
+utils.*
+*.tgz

jest.config.ts

@@ -1,9 +0,0 @@
-import type { Config } from 'jest'
-
-const config: Config = {
-	preset: 'ts-jest',
-	testEnvironment: 'node',
-	verbose: true
-}
-
-export default config

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsndr/cloudflare-worker-jwt",
-  "version": "2.4.0",
+  "version": "2.4.7",
   "description": "A lightweight JWT implementation with ZERO dependencies for Cloudflare Worker",
   "type": "module",
   "exports": "./index.js",
@@ -9,8 +9,8 @@
     "node": ">=18"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc & esbuild --bundle --target=esnext --platform=neutral --outfile=index.js src/index.ts & wait",
-    "test": "jest"
+    "test": "vitest"
   },
   "repository": {
     "type": "git",
@@ -30,13 +30,11 @@
   },
   "homepage": "https://github.com/tsndr/cloudflare-worker-jwt#readme",
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20231025.0",
+    "@cloudflare/workers-types": "^4.20240208.0",
-    "@jest/globals": "^29.7.0",
+    "@edge-runtime/vm": "^3.2.0",
-    "@types/jest": "^29.5.8",
+    "@types/node": "^20.11.19",
-    "@types/node": "^20.9.0",
+    "ts-node": "^10.9.2",
-    "jest": "^29.7.0",
+    "typescript": "^5.3.3",
-    "ts-jest": "^29.1.1",
+    "vitest": "^1.3.1"
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
   }
 }

src/index.ts

@@ -1,3 +1,12 @@
+import {
+    textToArrayBuffer,
+    arrayBufferToBase64Url,
+    base64UrlToArrayBuffer,
+    textToBase64Url,
+    importKey,
+    decodePayload
+} from "./utils"
+
 if (typeof crypto === 'undefined' || !crypto.subtle)
     throw new Error('SubtleCrypto not supported!')
 
@@ -25,6 +34,13 @@ export type JwtHeader<T = {}> = {
      * @default "JWT"
      */
     typ?: string
+
+    /**
+     * Algorithm (default: `"HS256"`)
+     *
+     * @default "HS256"
+     */
+    alg?: JwtAlgorithm
 } & T
 
 /**
@@ -37,7 +53,7 @@ export type JwtHeader<T = {}> = {
  * @prop {string} [iat] Issued At
  * @prop {string} [jti] JWT ID
  */
-export type JwtPayload<T = {}> = {
+export type JwtPayload<T = { [key: string]: any }> = {
     /** Issuer */
     iss?: string
 
@@ -58,8 +74,6 @@ export type JwtPayload<T = {}> = {
 
     /** JWT ID */
     jti?: string
-
-    [key: string]: any
 } & T
 
 /**
@@ -115,101 +129,6 @@ const algorithms: JwtAlgorithms = {
     RS512: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-512' } }
 }
 
-function bytesToByteString(bytes: Uint8Array): string {
-    let byteStr = ''
-    for (let i = 0; i < bytes.byteLength; i++) {
-        byteStr += String.fromCharCode(bytes[i])
-    }
-    return byteStr
-}
-
-function byteStringToBytes(byteStr: string): Uint8Array {
-    let bytes = new Uint8Array(byteStr.length)
-    for (let i = 0; i < byteStr.length; i++) {
-        bytes[i] = byteStr.charCodeAt(i)
-    }
-    return bytes
-}
-
-function arrayBufferToBase64String(arrayBuffer: ArrayBuffer): string {
-    return btoa(bytesToByteString(new Uint8Array(arrayBuffer)))
-}
-
-function base64StringToArrayBuffer(b64str: string): ArrayBuffer {
-    return byteStringToBytes(atob(b64str)).buffer
-}
-
-function textToArrayBuffer(str: string): ArrayBuffer {
-    return byteStringToBytes(decodeURI(encodeURIComponent(str)))
-}
-
-// @ts-ignore
-function arrayBufferToText(arrayBuffer: ArrayBuffer): string {
-    return bytesToByteString(new Uint8Array(arrayBuffer))
-}
-
-function arrayBufferToBase64Url(arrayBuffer: ArrayBuffer): string {
-    return arrayBufferToBase64String(arrayBuffer).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
-}
-
-function base64UrlToArrayBuffer(b64url: string): ArrayBuffer {
-    return base64StringToArrayBuffer(b64url.replace(/-/g, '+').replace(/_/g, '/').replace(/\s/g, ''))
-}
-
-function textToBase64Url(str: string): string {
-    const encoder = new TextEncoder();
-    const charCodes = encoder.encode(str);
-    const binaryStr = String.fromCharCode(...charCodes);
-    return btoa(binaryStr).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
-}
-
-function pemToBinary(pem: string): ArrayBuffer {
-    return base64StringToArrayBuffer(pem.replace(/-+(BEGIN|END).*/g, '').replace(/\s/g, ''))
-}
-
-async function importTextSecret(key: string, algorithm: SubtleCryptoImportKeyAlgorithm): Promise<CryptoKey> {
-    return await crypto.subtle.importKey("raw", textToArrayBuffer(key), algorithm, true, ["verify", "sign"])
-}
-
-async function importJwk(key: JsonWebKey, algorithm: SubtleCryptoImportKeyAlgorithm): Promise<CryptoKey> {
-    return await crypto.subtle.importKey("jwk", key, algorithm, true, ["verify", "sign"])
-}
-
-async function importPublicKey(key: string, algorithm: SubtleCryptoImportKeyAlgorithm): Promise<CryptoKey> {
-    return await crypto.subtle.importKey("spki", pemToBinary(key), algorithm, true, ["verify"])
-}
-
-async function importPrivateKey(key: string, algorithm: SubtleCryptoImportKeyAlgorithm): Promise<CryptoKey> {
-    return await crypto.subtle.importKey("pkcs8", pemToBinary(key), algorithm, true, ["sign"])
-}
-
-async function importKey(key: string | JsonWebKey, algorithm: SubtleCryptoImportKeyAlgorithm): Promise<CryptoKey> {
-    if (typeof key === 'object')
-        return importJwk(key, algorithm)
-
-    if (typeof key !== 'string')
-        throw new Error('Unsupported key type!')
-
-    if (key.includes('PUBLIC'))
-        return importPublicKey(key, algorithm)
-
-    if (key.includes('PRIVATE'))
-        return importPrivateKey(key, algorithm)
-
-    return importTextSecret(key, algorithm)
-}
-
-function decodePayload<T = any>(raw: string): T | undefined {
-    try {
-        const bytes = Array.from(atob(raw), char => char.charCodeAt(0));
-        const decodedString = new TextDecoder('utf-8').decode(new Uint8Array(bytes));
-
-        return JSON.parse(decodedString);
-    } catch {
-        return
-    }
-}
-
 /**
  * Signs a payload and returns the token
  *
@@ -244,7 +163,7 @@ export async function sign<Payload = {}, Header = {}>(payload: JwtPayload<Payloa
 
     const partialToken = `${textToBase64Url(JSON.stringify({ ...options.header, alg: options.algorithm }))}.${textToBase64Url(JSON.stringify(payload))}`
 
-    const key = secret instanceof CryptoKey ? secret : await importKey(secret, algorithm)
+    const key = secret instanceof CryptoKey ? secret : await importKey(secret, algorithm, ['sign'])
     const signature = await crypto.subtle.sign(algorithm, key, textToArrayBuffer(partialToken))
 
     return `${partialToken}.${arrayBufferToBase64Url(signature)}`
@@ -284,7 +203,13 @@ export async function verify(token: string, secret: string | JsonWebKey | Crypto
     if (!algorithm)
         throw new Error('algorithm not found')
 
-    const { payload } = decode(token)
+    const { header, payload } = decode(token)
+
+    if (header?.alg !== options.algorithm) {
+        if (options.throwError)
+            throw new Error('ALG_MISMATCH')
+        return false
+    }
 
     try {
         if (!payload)
@@ -296,13 +221,12 @@ export async function verify(token: string, secret: string | JsonWebKey | Crypto
         if (payload.exp && payload.exp <= Math.floor(Date.now() / 1000))
             throw new Error('EXPIRED')
 
-        const key = secret instanceof CryptoKey ? secret : await importKey(secret, algorithm)
+        const key = secret instanceof CryptoKey ? secret : await importKey(secret, algorithm, ['verify'])
 
         return await crypto.subtle.verify(algorithm, key, base64UrlToArrayBuffer(tokenParts[2]), textToArrayBuffer(`${tokenParts[0]}.${tokenParts[1]}`))
     } catch(err) {
         if (options.throwError)
             throw err
-
         return false
     }
 }

src/test.ts

@@ -0,0 +1,3 @@
+import { sign } from './index'
+
+console.log(await sign())

src/utils.ts

@@ -0,0 +1,94 @@
+export function bytesToByteString(bytes: Uint8Array): string {
+    let byteStr = ''
+    for (let i = 0; i < bytes.byteLength; i++) {
+        byteStr += String.fromCharCode(bytes[i])
+    }
+    return byteStr
+}
+
+export function byteStringToBytes(byteStr: string): Uint8Array {
+    let bytes = new Uint8Array(byteStr.length)
+    for (let i = 0; i < byteStr.length; i++) {
+        bytes[i] = byteStr.charCodeAt(i)
+    }
+    return bytes
+}
+
+export function arrayBufferToBase64String(arrayBuffer: ArrayBuffer): string {
+    return btoa(bytesToByteString(new Uint8Array(arrayBuffer)))
+}
+
+export function base64StringToArrayBuffer(b64str: string): ArrayBuffer {
+    return byteStringToBytes(atob(b64str)).buffer
+}
+
+export function textToArrayBuffer(str: string): ArrayBuffer {
+    return byteStringToBytes(decodeURI(encodeURIComponent(str)))
+}
+
+export function arrayBufferToText(arrayBuffer: ArrayBuffer): string {
+    return bytesToByteString(new Uint8Array(arrayBuffer))
+}
+
+export function arrayBufferToBase64Url(arrayBuffer: ArrayBuffer): string {
+    return arrayBufferToBase64String(arrayBuffer).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
+}
+
+export function base64UrlToArrayBuffer(b64url: string): ArrayBuffer {
+    return base64StringToArrayBuffer(b64url.replace(/-/g, '+').replace(/_/g, '/').replace(/\s/g, ''))
+}
+
+export function textToBase64Url(str: string): string {
+    const encoder = new TextEncoder();
+    const charCodes = encoder.encode(str);
+    const binaryStr = String.fromCharCode(...charCodes);
+    return btoa(binaryStr).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
+}
+
+export function pemToBinary(pem: string): ArrayBuffer {
+    return base64StringToArrayBuffer(pem.replace(/-+(BEGIN|END).*/g, '').replace(/\s/g, ''))
+}
+
+type KeyUsages = 'sign' | 'verify';
+export async function importTextSecret(key: string, algorithm: SubtleCryptoImportKeyAlgorithm, keyUsages: KeyUsages[]): Promise<CryptoKey> {
+    return await crypto.subtle.importKey("raw", textToArrayBuffer(key), algorithm, true, keyUsages)
+}
+
+export async function importJwk(key: JsonWebKey, algorithm: SubtleCryptoImportKeyAlgorithm, keyUsages: KeyUsages[]): Promise<CryptoKey> {
+    return await crypto.subtle.importKey("jwk", key, algorithm, true, keyUsages)
+}
+
+export async function importPublicKey(key: string, algorithm: SubtleCryptoImportKeyAlgorithm, keyUsages: KeyUsages[]): Promise<CryptoKey> {
+    return await crypto.subtle.importKey("spki", pemToBinary(key), algorithm, true, keyUsages)
+}
+
+export async function importPrivateKey(key: string, algorithm: SubtleCryptoImportKeyAlgorithm, keyUsages: KeyUsages[]): Promise<CryptoKey> {
+    return await crypto.subtle.importKey("pkcs8", pemToBinary(key), algorithm, true, keyUsages)
+}
+
+export async function importKey(key: string | JsonWebKey, algorithm: SubtleCryptoImportKeyAlgorithm, keyUsages: KeyUsages[]): Promise<CryptoKey> {
+    if (typeof key === 'object')
+        return importJwk(key, algorithm, keyUsages)
+
+    if (typeof key !== 'string')
+        throw new Error('Unsupported key type!')
+
+    if (key.includes('PUBLIC'))
+        return importPublicKey(key, algorithm, keyUsages)
+
+    if (key.includes('PRIVATE'))
+        return importPrivateKey(key, algorithm, keyUsages)
+
+    return importTextSecret(key, algorithm, keyUsages)
+}
+
+export function decodePayload<T = any>(raw: string): T | undefined {
+    try {
+        const bytes = Array.from(atob(raw), char => char.charCodeAt(0));
+        const decodedString = new TextDecoder('utf-8').decode(new Uint8Array(bytes));
+
+        return JSON.parse(decodedString);
+    } catch {
+        return
+    }
+}

tests/index.spec.ts

@@ -1,8 +1,5 @@
-import crypto from 'node:crypto'
+import { describe, expect, test } from 'vitest'
-Object.defineProperty(global, 'crypto', { value: { subtle: crypto.webcrypto.subtle }})
+import jwt, { JwtAlgorithm } from '../src/index'
-
-import { describe, expect, test } from '@jest/globals'
-import jwt, { JwtAlgorithm } from '.'
 
 type Dataset = {
     public: string
@@ -122,4 +119,4 @@ describe.each(Object.entries(data) as [JwtAlgorithm, Dataset][])('%s', (algorith
         const verified = await jwt.verify(token, data.public, algorithm)
         expect(verified).toBeTruthy()
     })
-})
+})

tests/utils.spec.ts

@@ -0,0 +1,81 @@
+import { describe, expect, test } from 'vitest'
+import {
+	bytesToByteString,
+	byteStringToBytes,
+	arrayBufferToBase64String,
+	base64StringToArrayBuffer,
+	textToArrayBuffer,
+	arrayBufferToText,
+	arrayBufferToBase64Url,
+	base64UrlToArrayBuffer,
+	textToBase64Url,
+	pemToBinary,
+	importTextSecret
+} from '../src/utils'
+
+describe('Converters', () => {
+	const testString = 'cloudflare-worker-jwt'
+	const testByteArray = [ 99, 108, 111, 117, 100, 102, 108, 97, 114, 101, 45, 119, 111, 114, 107, 101, 114, 45, 106, 119, 116 ]
+	const testUint8Array = new Uint8Array(testByteArray)
+	const testBase64String = 'Y2xvdWRmbGFyZS13b3JrZXItand0'
+	const testArrayBuffer = testUint8Array.buffer
+
+	test('bytesToByteString', () => {
+		expect(bytesToByteString(testUint8Array)).toStrictEqual(testString)
+	})
+
+	test('byteStringToBytes', () => {
+		expect(byteStringToBytes(testString)).toStrictEqual(testUint8Array)
+	})
+
+	test('arrayBufferToBase64String', () => {
+		expect(arrayBufferToBase64String(testArrayBuffer)).toStrictEqual(testBase64String)
+	})
+
+	test('base64StringToArrayBuffer', () => {
+		expect(base64StringToArrayBuffer(testBase64String)).toStrictEqual(testArrayBuffer)
+	})
+
+	test('textToArrayBuffer', () => {
+		expect(textToArrayBuffer(testString)).toStrictEqual(testUint8Array)
+	})
+
+	test('arrayBufferToText', () => {
+		expect(arrayBufferToText(testArrayBuffer)).toStrictEqual(testString)
+	})
+
+	test('arrayBufferToBase64Url', () => {
+		expect(arrayBufferToBase64Url(testArrayBuffer)).toStrictEqual(testBase64String)
+	})
+
+	test('base64UrlToArrayBuffer', () => {
+		expect(base64UrlToArrayBuffer(testBase64String)).toStrictEqual(testArrayBuffer)
+	})
+
+	test('textToBase64Url', () => {
+		expect(textToBase64Url(testString)).toStrictEqual(testBase64String)
+	})
+
+	test('pemToBinary', () => {
+		expect(pemToBinary(`-----BEGIN PUBLIC KEY-----\n${testBase64String}\n-----END PUBLIC KEY-----`)).toStrictEqual(testArrayBuffer)
+	})
+})
+
+describe('Imports', () => {
+	test('importTextSecret', async () => {
+		const testKey = 'cloudflare-worker-jwt'
+		const testAlgorithm = { name: 'HMAC', hash: { name: 'SHA-256' } }
+		const testCryptoKey = { type: 'secret', extractable: true, algorithm: { ...testAlgorithm, length: 168 }, usages: ['verify', 'sign'] }
+
+		expect(await importTextSecret(testKey, testAlgorithm, ['verify', 'sign'])).toMatchObject(testCryptoKey)
+	})
+
+	//test('importJwk', async () => {})
+	//test('importPublicKey', async () => {})
+	//test('importPrivateKey', async () => {})
+	//test('importKey', async () => {})
+})
+
+//describe('Payload', () => {
+//	test('decodePayload', () => {})
+//})

tsconfig.json

@@ -5,6 +5,7 @@
         "target": "esnext",
         "lib": ["esnext"],
         "declaration": true,
+        "emitDeclarationOnly": true,
         "strict": true,
         "noImplicitAny": true,
         "strictNullChecks": true,

vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+	test: {
+		environment: 'edge-runtime',
+		watch: false,
+		reporters: ['verbose']
+	}
+})