Compare commits
40 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
7027999975
|
|||
|
166b074782
|
|||
|
decbd238e9
|
|||
|
894ac2c9f5
|
|||
|
1394e4e33d
|
|||
|
47028970b4
|
|||
|
6ac43d493d
|
|||
|
cc66bd9c47
|
|||
|
a8f95f1c6d
|
|||
|
|
b2886c0778 | ||
|
76b7fcef27
|
|||
|
3b5d8bcde8
|
|||
|
e22c509852
|
|||
| 7ed375e876 | |||
| de658122b9 | |||
|
|
10dcf2f01b | ||
|
1de6acbfff
|
|||
|
b002db4547
|
|||
|
1bdbd0a5c5
|
|||
|
883ec55b73
|
|||
|
|
c515fb76e6 | ||
|
ec41207832
|
|||
|
e64e89f325
|
|||
|
fb573d928a
|
|||
|
382ad66ea9
|
|||
|
ffc1e87b32
|
|||
|
decfa65391
|
|||
|
|
67f1a8e5ed | ||
|
fe1baf46b4
|
|||
|
81f9eafd86
|
|||
|
747931ba69
|
|||
|
261069d5cb
|
|||
|
7466a881a0
|
|||
|
81dde823d3
|
|||
|
210b733591
|
|||
|
bf11705d11
|
|||
|
99d172179e
|
|||
|
63de8056a5
|
|||
|
b953f4165a
|
|||
|
c9da88c4bb
|
10
.editorconfig
Normal file
10
.editorconfig
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = false
|
||||||
|
|
||||||
|
[src/**/*.ts]
|
||||||
|
charset = utf-8
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
28
.github/workflows/publish.yml
vendored
28
.github/workflows/publish.yml
vendored
@@ -2,29 +2,29 @@ name: Publish
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
types: [created]
|
types: [published]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-npm:
|
publish:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v1
|
- uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 12
|
node-version: 16
|
||||||
registry-url: https://registry.npmjs.org/
|
registry-url: https://registry.npmjs.org/
|
||||||
- run: npm publish --access public
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
- name: Build
|
||||||
|
run: npm run build
|
||||||
|
- name: Publish to npmjs
|
||||||
|
run: npm publish --tag latest --access public
|
||||||
env:
|
env:
|
||||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
publish-gpr:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-node@v1
|
|
||||||
with:
|
with:
|
||||||
node-version: 12
|
|
||||||
registry-url: https://npm.pkg.github.com/
|
registry-url: https://npm.pkg.github.com/
|
||||||
- run: npm publish --access public
|
- name: Publish to GPR
|
||||||
|
run: npm publish --tag latest --access public
|
||||||
env:
|
env:
|
||||||
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||||
|
|||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -142,3 +142,7 @@ dist
|
|||||||
.yarn/build-state.yml
|
.yarn/build-state.yml
|
||||||
.yarn/install-state.gz
|
.yarn/install-state.gz
|
||||||
.pnp.*
|
.pnp.*
|
||||||
|
|
||||||
|
# Custom
|
||||||
|
/index.js
|
||||||
|
/index.d.ts
|
||||||
7
.npmignore
Normal file
7
.npmignore
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
.github/
|
||||||
|
src/
|
||||||
|
test/
|
||||||
|
.nvmrc
|
||||||
|
index.test.js
|
||||||
|
tsconfig.json
|
||||||
|
.editorconfig
|
||||||
18
README.md
18
README.md
@@ -16,7 +16,7 @@ A lightweight JWT implementation with ZERO dependencies for Cloudflare Workers.
|
|||||||
## Install
|
## Install
|
||||||
|
|
||||||
```
|
```
|
||||||
npm i -D @tsndr/cloudflare-worker-jwt
|
npm i @tsndr/cloudflare-worker-jwt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -24,9 +24,9 @@ npm i -D @tsndr/cloudflare-worker-jwt
|
|||||||
|
|
||||||
### Basic Example
|
### Basic Example
|
||||||
|
|
||||||
```javascript
|
```typescript
|
||||||
async () => {
|
async () => {
|
||||||
const jwt = require('@tsndr/cloudflare-worker-jwt')
|
import jwt from '@tsndr/cloudflare-worker-jwt'
|
||||||
|
|
||||||
// Creating a token
|
// Creating a token
|
||||||
const token = await jwt.sign({ name: 'John Doe', email: 'john.doe@gmail.com' }, 'secret')
|
const token = await jwt.sign({ name: 'John Doe', email: 'john.doe@gmail.com' }, 'secret')
|
||||||
@@ -45,9 +45,9 @@ async () => {
|
|||||||
|
|
||||||
### Restrict Timeframe
|
### Restrict Timeframe
|
||||||
|
|
||||||
```javascript
|
```typescript
|
||||||
async () => {
|
async () => {
|
||||||
const jwt = require('@tsndr/cloudflare-worker-jwt')
|
import jwt from '@tsndr/cloudflare-worker-jwt'
|
||||||
|
|
||||||
// Creating a token
|
// Creating a token
|
||||||
const token = await jwt.sign({
|
const token = await jwt.sign({
|
||||||
@@ -84,7 +84,7 @@ Signs a payload and returns the token.
|
|||||||
|
|
||||||
#### Arguments
|
#### Arguments
|
||||||
|
|
||||||
Argument | Type | Satus | Default | Description
|
Argument | Type | Status | Default | Description
|
||||||
----------- | -------- | -------- | ------- | -----------
|
----------- | -------- | -------- | ------- | -----------
|
||||||
`payload` | `object` | required | - | The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
|
`payload` | `object` | required | - | The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
|
||||||
`secret` | `string` | required | - | A string which is used to sign the payload.
|
`secret` | `string` | required | - | A string which is used to sign the payload.
|
||||||
@@ -100,11 +100,11 @@ Returns token as a `string`.
|
|||||||
|
|
||||||
Verifies the integrity of the token and returns a boolean value.
|
Verifies the integrity of the token and returns a boolean value.
|
||||||
|
|
||||||
Argument | Type | Satus | Default | Description
|
Argument | Type | Status | Default | Description
|
||||||
----------- | -------- | -------- | ------- | -----------
|
----------- | -------- | -------- | ------- | -----------
|
||||||
`token` | `string` | required | - | The token string generated by `jwt.sign()`.
|
`token` | `string` | required | - | The token string generated by `jwt.sign()`.
|
||||||
`secret` | `string` | required | - | The string which was used to sign the payload.
|
`secret` | `string` | required | - | The string which was used to sign the payload.
|
||||||
`options` | `object` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` and `throwError`. (See [Available Algorithms](#available-algorithms))
|
`options` | `object` | optional | `{ algorithm: 'HS256', skipValidation: false, throwError: false }` | The options object supporting `algorithm`, `skipValidation` and `throwError`. (See [Available Algorithms](#available-algorithms))
|
||||||
|
|
||||||
#### `throws`
|
#### `throws`
|
||||||
If `options.throwError` is `true` and the token is invalid, an error will be thrown.
|
If `options.throwError` is `true` and the token is invalid, an error will be thrown.
|
||||||
@@ -119,7 +119,7 @@ Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherw
|
|||||||
|
|
||||||
Returns the payload **without** verifying the integrity of the token. Please use `jwt.verify()` first to keep your application secure!
|
Returns the payload **without** verifying the integrity of the token. Please use `jwt.verify()` first to keep your application secure!
|
||||||
|
|
||||||
Argument | Type | Satus | Default | Description
|
Argument | Type | Status | Default | Description
|
||||||
----------- | -------- | -------- | ------- | -----------
|
----------- | -------- | -------- | ------- | -----------
|
||||||
`token` | `string` | required | - | The token string generated by `jwt.sign()`.
|
`token` | `string` | required | - | The token string generated by `jwt.sign()`.
|
||||||
|
|
||||||
|
|||||||
60
index.d.ts
vendored
60
index.d.ts
vendored
@@ -1,60 +0,0 @@
|
|||||||
/**
|
|
||||||
* JWT
|
|
||||||
*
|
|
||||||
* @class
|
|
||||||
* @constructor
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
declare class JWT {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Signs a payload and returns the token
|
|
||||||
*
|
|
||||||
* @param {object} payload The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
|
|
||||||
* @param {string} secret A string which is used to sign the payload.
|
|
||||||
* @param {JWTSignOptions | JWTAlgorithm} options The options object or the algorithm.
|
|
||||||
* @throws {Error} If there's a validation issue.
|
|
||||||
* @returns {Promise<string>} Returns token as a `string`.
|
|
||||||
*/
|
|
||||||
sign(payload: object, secret: string, options?: JWTSignOptions | JWTAlgorithm): Promise<string>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Verifies the integrity of the token and returns a boolean value.
|
|
||||||
*
|
|
||||||
* @param {string} token The token string generated by `jwt.sign()`.
|
|
||||||
* @param {string} secret The string which was used to sign the payload.
|
|
||||||
* @param {JWTVerifyOptions | JWTAlgorithm} options The options object or the algorithm.
|
|
||||||
* @throws {Error | string} Throws an error `string` if the token is invalid or an `Error-Object` if there's a validation issue.
|
|
||||||
* @returns {Promise<boolean>} Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`.
|
|
||||||
*/
|
|
||||||
verify(token: string, secret: string, options?: JWTVerifyOptions | JWTAlgorithm): Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the payload **without** verifying the integrity of the token. Please use `jwt.verify()` first to keep your application secure!
|
|
||||||
*
|
|
||||||
* @param {string} token The token string generated by `jwt.sign()`.
|
|
||||||
* @returns {JWTDecodeReturn} Returns an `object` containing `header` and `payload`.
|
|
||||||
*/
|
|
||||||
decode(token: string): JWTDecodeReturn
|
|
||||||
}
|
|
||||||
declare const _exports: JWT
|
|
||||||
|
|
||||||
type JWTAlgorithm = 'ES256' | 'ES384' | 'ES512' | 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512'
|
|
||||||
|
|
||||||
type JWTSignOptions = {
|
|
||||||
algorithm?: JWTAlgorithm,
|
|
||||||
keyid?: string
|
|
||||||
header?: object
|
|
||||||
}
|
|
||||||
|
|
||||||
type JWTVerifyOptions = {
|
|
||||||
algorithm?: JWTAlgorithm
|
|
||||||
throwError?: boolean
|
|
||||||
}
|
|
||||||
|
|
||||||
type JWTDecodeReturn = {
|
|
||||||
header: object,
|
|
||||||
payload: object
|
|
||||||
}
|
|
||||||
|
|
||||||
export = _exports
|
|
||||||
126
index.js
126
index.js
@@ -1,126 +0,0 @@
|
|||||||
class Base64URL {
|
|
||||||
static parse(s) {
|
|
||||||
return new Uint8Array(Array.prototype.map.call(atob(s.replace(/-/g, '+').replace(/_/g, '/').replace(/\s/g, '')), c => c.charCodeAt(0)))
|
|
||||||
}
|
|
||||||
static stringify(a) {
|
|
||||||
return btoa(String.fromCharCode.apply(0, a)).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class JWT {
|
|
||||||
constructor() {
|
|
||||||
if (typeof crypto === 'undefined' || !crypto.subtle)
|
|
||||||
throw new Error('Crypto not supported!')
|
|
||||||
this.algorithms = {
|
|
||||||
ES256: { name: 'ECDSA', namedCurve: 'P-256', hash: { name: 'SHA-256' } },
|
|
||||||
ES384: { name: 'ECDSA', namedCurve: 'P-384', hash: { name: 'SHA-384' } },
|
|
||||||
ES512: { name: 'ECDSA', namedCurve: 'P-521', hash: { name: 'SHA-512' } },
|
|
||||||
HS256: { name: 'HMAC', hash: { name: 'SHA-256' } },
|
|
||||||
HS384: { name: 'HMAC', hash: { name: 'SHA-384' } },
|
|
||||||
HS512: { name: 'HMAC', hash: { name: 'SHA-512' } },
|
|
||||||
RS256: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-256' } },
|
|
||||||
RS384: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-384' } },
|
|
||||||
RS512: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-512' } },
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_utf8ToUint8Array(str) {
|
|
||||||
return Base64URL.parse(btoa(unescape(encodeURIComponent(str))))
|
|
||||||
}
|
|
||||||
_str2ab(str) {
|
|
||||||
const buf = new ArrayBuffer(str.length);
|
|
||||||
const bufView = new Uint8Array(buf);
|
|
||||||
for (let i = 0, strLen = str.length; i < strLen; i++) {
|
|
||||||
bufView[i] = str.charCodeAt(i);
|
|
||||||
}
|
|
||||||
return buf;
|
|
||||||
}
|
|
||||||
_decodePayload(raw) {
|
|
||||||
switch (raw.length % 4) {
|
|
||||||
case 0:
|
|
||||||
break
|
|
||||||
case 2:
|
|
||||||
raw += '=='
|
|
||||||
break
|
|
||||||
case 3:
|
|
||||||
raw += '='
|
|
||||||
break
|
|
||||||
default:
|
|
||||||
throw new Error('Illegal base64url string!')
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
return JSON.parse(decodeURIComponent(escape(atob(raw))))
|
|
||||||
} catch {
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
async sign(payload, secret, options = { algorithm: 'HS256', header: { typ: 'JWT' } }) {
|
|
||||||
if (typeof options === 'string')
|
|
||||||
options = { algorithm: options, header: { typ: 'JWT' } }
|
|
||||||
if (payload === null || typeof payload !== 'object')
|
|
||||||
throw new Error('payload must be an object')
|
|
||||||
if (typeof secret !== 'string')
|
|
||||||
throw new Error('secret must be a string')
|
|
||||||
if (typeof options.algorithm !== 'string')
|
|
||||||
throw new Error('options.algorithm must be a string')
|
|
||||||
const importAlgorithm = this.algorithms[options.algorithm]
|
|
||||||
if (!importAlgorithm)
|
|
||||||
throw new Error('algorithm not found')
|
|
||||||
payload.iat = Math.floor(Date.now() / 1000)
|
|
||||||
const payloadAsJSON = JSON.stringify(payload)
|
|
||||||
const partialToken = `${Base64URL.stringify(this._utf8ToUint8Array(JSON.stringify({ ...options.header, alg: options.algorithm, kid: options.keyid })))}.${Base64URL.stringify(this._utf8ToUint8Array(payloadAsJSON))}`
|
|
||||||
let keyFormat = 'raw'
|
|
||||||
let keyData
|
|
||||||
if (secret.startsWith('-----BEGIN')) {
|
|
||||||
keyFormat = 'pkcs8'
|
|
||||||
keyData = this._str2ab(atob(secret.replace(/-----BEGIN.*?-----/g, '').replace(/-----END.*?-----/g, '').replace(/\s/g, '')))
|
|
||||||
} else
|
|
||||||
keyData = this._utf8ToUint8Array(secret)
|
|
||||||
const key = await crypto.subtle.importKey(keyFormat, keyData, importAlgorithm, false, ['sign'])
|
|
||||||
const signature = await crypto.subtle.sign(importAlgorithm, key, this._utf8ToUint8Array(partialToken))
|
|
||||||
return `${partialToken}.${Base64URL.stringify(new Uint8Array(signature))}`
|
|
||||||
}
|
|
||||||
async verify(token, secret, options = { algorithm: 'HS256', throwError: false }) {
|
|
||||||
if (typeof options === 'string')
|
|
||||||
options = { algorithm: options }
|
|
||||||
if (typeof token !== 'string')
|
|
||||||
throw new Error('token must be a string')
|
|
||||||
if (typeof secret !== 'string')
|
|
||||||
throw new Error('secret must be a string')
|
|
||||||
if (typeof options.algorithm !== 'string')
|
|
||||||
throw new Error('options.algorithm must be a string')
|
|
||||||
const tokenParts = token.split('.')
|
|
||||||
if (tokenParts.length !== 3)
|
|
||||||
throw new Error('token must consist of 3 parts')
|
|
||||||
const importAlgorithm = this.algorithms[options.algorithm]
|
|
||||||
if (!importAlgorithm)
|
|
||||||
throw new Error('algorithm not found')
|
|
||||||
const { payload } = this.decode(token)
|
|
||||||
if (payload.nbf && payload.nbf > Math.floor(Date.now() / 1000)) {
|
|
||||||
if (options.throwError)
|
|
||||||
throw 'NOT_YET_VALID'
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
if (payload.exp && payload.exp <= Math.floor(Date.now() / 1000)) {
|
|
||||||
if (options.throwError)
|
|
||||||
throw 'EXPIRED'
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
let keyFormat = 'raw'
|
|
||||||
let keyData
|
|
||||||
if (secret.startsWith('-----BEGIN')) {
|
|
||||||
keyFormat = 'spki'
|
|
||||||
keyData = this._str2ab(atob(secret.replace(/-----BEGIN.*?-----/g, '').replace(/-----END.*?-----/g, '').replace(/\s/g, '')))
|
|
||||||
} else
|
|
||||||
keyData = this._utf8ToUint8Array(secret)
|
|
||||||
const key = await crypto.subtle.importKey(keyFormat, keyData, importAlgorithm, false, ['verify'])
|
|
||||||
return await crypto.subtle.verify(importAlgorithm, key, Base64URL.parse(tokenParts[2]), this._utf8ToUint8Array(`${tokenParts[0]}.${tokenParts[1]}`))
|
|
||||||
}
|
|
||||||
decode(token) {
|
|
||||||
return {
|
|
||||||
header: this._decodePayload(token.split('.')[0].replace(/-/g, '+').replace(/_/g, '/')),
|
|
||||||
payload: this._decodePayload(token.split('.')[1].replace(/-/g, '+').replace(/_/g, '/'))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = new JWT
|
|
||||||
@@ -3,17 +3,29 @@ Object.defineProperty(global, 'crypto', {
|
|||||||
value: { subtle }
|
value: { subtle }
|
||||||
})
|
})
|
||||||
|
|
||||||
const JWT = require('./index')
|
const jwt = require('./index.js')
|
||||||
const oneDay = (60 * 60 * 24)
|
const oneDay = (60 * 60 * 24)
|
||||||
const now = Date.now() / 1000
|
const now = Date.now() / 1000
|
||||||
|
const algorithms = [
|
||||||
|
'ES256',
|
||||||
|
'ES384',
|
||||||
|
'ES512',
|
||||||
|
'HS256',
|
||||||
|
'HS384',
|
||||||
|
'HS512',
|
||||||
|
'RS256',
|
||||||
|
'RS384',
|
||||||
|
'RS512'
|
||||||
|
]
|
||||||
|
|
||||||
const secrets = {}
|
const secrets = {}
|
||||||
|
|
||||||
// Keypairs
|
// Keypairs
|
||||||
for (const algorithm of Object.keys(JWT.algorithms)) {
|
for (const algorithm of algorithms) {
|
||||||
if (algorithm.startsWith('HS'))
|
if (algorithm.startsWith('HS')) {
|
||||||
|
//secrets[algorithm] = 'c2VjcmV0'
|
||||||
secrets[algorithm] = 'secret'
|
secrets[algorithm] = 'secret'
|
||||||
else if (algorithm.startsWith('RS')) {
|
} else if (algorithm.startsWith('RS')) {
|
||||||
secrets[algorithm] = {
|
secrets[algorithm] = {
|
||||||
public: `-----BEGIN PUBLIC KEY-----
|
public: `-----BEGIN PUBLIC KEY-----
|
||||||
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo
|
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo
|
||||||
@@ -111,18 +123,19 @@ const testPayload = {
|
|||||||
test.each(Object.entries(secrets))(`Self test: %s`, async (algorithm, key) => {
|
test.each(Object.entries(secrets))(`Self test: %s`, async (algorithm, key) => {
|
||||||
let privateKey = key
|
let privateKey = key
|
||||||
let publicKey = key
|
let publicKey = key
|
||||||
|
|
||||||
if (typeof key === 'object') {
|
if (typeof key === 'object') {
|
||||||
privateKey = key.private
|
privateKey = key.private
|
||||||
publicKey = key.public
|
publicKey = key.public
|
||||||
}
|
}
|
||||||
|
|
||||||
const token = await JWT.sign(testPayload, privateKey, { algorithm })
|
const token = await jwt.sign(testPayload, privateKey, { algorithm })
|
||||||
expect(token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/)
|
expect(token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/)
|
||||||
|
|
||||||
const verified = await JWT.verify(token, publicKey, { algorithm })
|
const verified = await jwt.verify(token, publicKey, { algorithm })
|
||||||
expect(verified).toBeTruthy()
|
expect(verified).toBeTruthy()
|
||||||
|
|
||||||
const { payload } = JWT.decode(token)
|
const { payload } = jwt.decode(token)
|
||||||
expect({
|
expect({
|
||||||
sub: payload.sub,
|
sub: payload.sub,
|
||||||
name: payload.name
|
name: payload.name
|
||||||
@@ -147,17 +160,16 @@ const externalTokens = {
|
|||||||
|
|
||||||
test.each(Object.entries(externalTokens))('Verify external tokens: %s', async (algorithm, token) => {
|
test.each(Object.entries(externalTokens))('Verify external tokens: %s', async (algorithm, token) => {
|
||||||
const key = secrets[algorithm]
|
const key = secrets[algorithm]
|
||||||
let privateKey = key
|
|
||||||
let publicKey = key
|
|
||||||
if (typeof key === 'object') {
|
|
||||||
privateKey = key.private
|
|
||||||
publicKey = key.public
|
|
||||||
}
|
|
||||||
|
|
||||||
const verified = await JWT.verify(token, publicKey, { algorithm })
|
let publicKey = key
|
||||||
|
|
||||||
|
if (typeof key === 'object')
|
||||||
|
publicKey = key.public
|
||||||
|
|
||||||
|
const verified = await jwt.verify(token, publicKey, { algorithm })
|
||||||
expect(verified).toBeTruthy()
|
expect(verified).toBeTruthy()
|
||||||
|
|
||||||
const { payload } = JWT.decode(token)
|
const { payload } = jwt.decode(token)
|
||||||
expect({
|
expect({
|
||||||
sub: payload.sub,
|
sub: payload.sub,
|
||||||
name: payload.name
|
name: payload.name
|
||||||
|
|||||||
7324
package-lock.json
generated
7324
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
10
package.json
10
package.json
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@tsndr/cloudflare-worker-jwt",
|
"name": "@tsndr/cloudflare-worker-jwt",
|
||||||
"version": "1.4.3",
|
"version": "2.2.5",
|
||||||
"description": "A lightweight JWT implementation with ZERO dependencies for Cloudflare Worker",
|
"description": "A lightweight JWT implementation with ZERO dependencies for Cloudflare Worker",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
|
"types": "index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "jest"
|
"build": "tsc",
|
||||||
|
"test": "jest"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -24,6 +26,8 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/tsndr/cloudflare-worker-jwt#readme",
|
"homepage": "https://github.com/tsndr/cloudflare-worker-jwt#readme",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"jest": "^28.1.0"
|
"@cloudflare/workers-types": "^4.20231002.0",
|
||||||
|
"jest": "^29.7.0",
|
||||||
|
"typescript": "^5.2.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
318
src/index.ts
Normal file
318
src/index.ts
Normal file
@@ -0,0 +1,318 @@
|
|||||||
|
if (typeof crypto === 'undefined' || !crypto.subtle)
|
||||||
|
throw new Error('SubtleCrypto not supported!')
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtAlgorithm
|
||||||
|
* @type {'ES256'|'ES384'|'ES512'|'HS256'|'HS384'|'HS512'|'RS256'|'RS384'|'RS512'}
|
||||||
|
*/
|
||||||
|
export type JwtAlgorithm = 'ES256'|'ES384'|'ES512'|'HS256'|'HS384'|'HS512'|'RS256'|'RS384'|'RS512'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtAlgorithms
|
||||||
|
*/
|
||||||
|
export interface JwtAlgorithms {
|
||||||
|
[key: string]: SubtleCryptoImportKeyAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtHeader
|
||||||
|
* @prop {string} [typ] Type
|
||||||
|
*/
|
||||||
|
export interface JwtHeader {
|
||||||
|
/**
|
||||||
|
* Type (default: `"JWT"`)
|
||||||
|
*
|
||||||
|
* @default "JWT"
|
||||||
|
*/
|
||||||
|
typ?: string
|
||||||
|
|
||||||
|
[key: string]: any
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtPayload
|
||||||
|
* @prop {string} [iss] Issuer
|
||||||
|
* @prop {string} [sub] Subject
|
||||||
|
* @prop {string | string[]} [aud] Audience
|
||||||
|
* @prop {string} [exp] Expiration Time
|
||||||
|
* @prop {string} [nbf] Not Before
|
||||||
|
* @prop {string} [iat] Issued At
|
||||||
|
* @prop {string} [jti] JWT ID
|
||||||
|
*/
|
||||||
|
export interface JwtPayload {
|
||||||
|
/** Issuer */
|
||||||
|
iss?: string
|
||||||
|
|
||||||
|
/** Subject */
|
||||||
|
sub?: string
|
||||||
|
|
||||||
|
/** Audience */
|
||||||
|
aud?: string | string[]
|
||||||
|
|
||||||
|
/** Expiration Time */
|
||||||
|
exp?: number
|
||||||
|
|
||||||
|
/** Not Before */
|
||||||
|
nbf?: number
|
||||||
|
|
||||||
|
/** Issued At */
|
||||||
|
iat?: number
|
||||||
|
|
||||||
|
/** JWT ID */
|
||||||
|
jti?: string
|
||||||
|
|
||||||
|
[key: string]: any
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtOptions
|
||||||
|
* @prop {JwtAlgorithm | string} algorithm
|
||||||
|
*/
|
||||||
|
export interface JwtOptions {
|
||||||
|
algorithm?: JwtAlgorithm | string
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtSignOptions
|
||||||
|
* @extends JwtOptions
|
||||||
|
* @prop {JwtHeader} [header]
|
||||||
|
*/
|
||||||
|
export interface JwtSignOptions extends JwtOptions {
|
||||||
|
header?: JwtHeader
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtVerifyOptions
|
||||||
|
* @extends JwtOptions
|
||||||
|
* @prop {boolean} [throwError=false] If `true` throw error if checks fail. (default: `false`)
|
||||||
|
*/
|
||||||
|
export interface JwtVerifyOptions extends JwtOptions {
|
||||||
|
/**
|
||||||
|
* If `true` all expiry checks will be skipped
|
||||||
|
*/
|
||||||
|
skipValidation?: boolean
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If `true` throw error if checks fail. (default: `false`)
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
throwError?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef JwtData
|
||||||
|
* @prop {JwtHeader} header
|
||||||
|
* @prop {JwtPayload} payload
|
||||||
|
*/
|
||||||
|
export interface JwtData {
|
||||||
|
header: JwtHeader
|
||||||
|
payload: JwtPayload
|
||||||
|
}
|
||||||
|
|
||||||
|
function base64UrlParse(s: string): Uint8Array {
|
||||||
|
// @ts-ignore
|
||||||
|
return new Uint8Array(Array.prototype.map.call(atob(s.replace(/-/g, '+').replace(/_/g, '/').replace(/\s/g, '')), c => c.charCodeAt(0)))
|
||||||
|
// return new Uint8Array(Array.from(atob(s.replace(/-/g, '+').replace(/_/g, '/').replace(/\s/g, ''))).map(c => c.charCodeAt(0)))
|
||||||
|
}
|
||||||
|
|
||||||
|
function base64UrlStringify(a: Uint8Array): string {
|
||||||
|
// @ts-ignore
|
||||||
|
return btoa(String.fromCharCode.apply(0, a)).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
|
||||||
|
// return btoa(String.fromCharCode.apply(0, Array.from(a))).replace(/=/g, '').replace(/\+/g, '-').replace(/\//g, '_')
|
||||||
|
}
|
||||||
|
|
||||||
|
const algorithms: JwtAlgorithms = {
|
||||||
|
ES256: { name: 'ECDSA', namedCurve: 'P-256', hash: { name: 'SHA-256' } },
|
||||||
|
ES384: { name: 'ECDSA', namedCurve: 'P-384', hash: { name: 'SHA-384' } },
|
||||||
|
ES512: { name: 'ECDSA', namedCurve: 'P-521', hash: { name: 'SHA-512' } },
|
||||||
|
HS256: { name: 'HMAC', hash: { name: 'SHA-256' } },
|
||||||
|
HS384: { name: 'HMAC', hash: { name: 'SHA-384' } },
|
||||||
|
HS512: { name: 'HMAC', hash: { name: 'SHA-512' } },
|
||||||
|
RS256: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-256' } },
|
||||||
|
RS384: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-384' } },
|
||||||
|
RS512: { name: 'RSASSA-PKCS1-v1_5', hash: { name: 'SHA-512' } }
|
||||||
|
}
|
||||||
|
|
||||||
|
function _utf8ToUint8Array(str: string): Uint8Array {
|
||||||
|
return base64UrlParse(btoa(unescape(encodeURIComponent(str))))
|
||||||
|
}
|
||||||
|
|
||||||
|
function _str2ab(str: string): ArrayBuffer {
|
||||||
|
str = atob(str)
|
||||||
|
|
||||||
|
const buf = new ArrayBuffer(str.length);
|
||||||
|
const bufView = new Uint8Array(buf);
|
||||||
|
|
||||||
|
for (let i = 0, strLen = str.length; i < strLen; i++) {
|
||||||
|
bufView[i] = str.charCodeAt(i);
|
||||||
|
}
|
||||||
|
|
||||||
|
return buf;
|
||||||
|
}
|
||||||
|
|
||||||
|
function _decodePayload(raw: string): JwtHeader | JwtPayload | null {
|
||||||
|
switch (raw.length % 4) {
|
||||||
|
case 0:
|
||||||
|
break
|
||||||
|
case 2:
|
||||||
|
raw += '=='
|
||||||
|
break
|
||||||
|
case 3:
|
||||||
|
raw += '='
|
||||||
|
break
|
||||||
|
default:
|
||||||
|
throw new Error('Illegal base64url string!')
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return JSON.parse(decodeURIComponent(escape(atob(raw))))
|
||||||
|
} catch {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Signs a payload and returns the token
|
||||||
|
*
|
||||||
|
* @param {JwtPayload} payload The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
|
||||||
|
* @param {string | JsonWebKey} secret A string which is used to sign the payload.
|
||||||
|
* @param {JwtSignOptions | JwtAlgorithm | string} [options={ algorithm: 'HS256', header: { typ: 'JWT' } }] The options object or the algorithm.
|
||||||
|
* @throws {Error} If there's a validation issue.
|
||||||
|
* @returns {Promise<string>} Returns token as a `string`.
|
||||||
|
*/
|
||||||
|
export async function sign(payload: JwtPayload, secret: string | JsonWebKey, options: JwtSignOptions | JwtAlgorithm = { algorithm: 'HS256', header: { typ: 'JWT' } }): Promise<string> {
|
||||||
|
if (typeof options === 'string')
|
||||||
|
options = { algorithm: options, header: { typ: 'JWT' } }
|
||||||
|
|
||||||
|
options = { algorithm: 'HS256', header: { typ: 'JWT' }, ...options }
|
||||||
|
|
||||||
|
if (payload === null || typeof payload !== 'object')
|
||||||
|
throw new Error('payload must be an object')
|
||||||
|
|
||||||
|
if (typeof secret !== 'string' && typeof secret !== 'object')
|
||||||
|
throw new Error('secret must be a string or a JWK object')
|
||||||
|
|
||||||
|
if (typeof options.algorithm !== 'string')
|
||||||
|
throw new Error('options.algorithm must be a string')
|
||||||
|
|
||||||
|
const algorithm: SubtleCryptoImportKeyAlgorithm = algorithms[options.algorithm]
|
||||||
|
|
||||||
|
if (!algorithm)
|
||||||
|
throw new Error('algorithm not found')
|
||||||
|
|
||||||
|
if (!payload.iat)
|
||||||
|
payload.iat = Math.floor(Date.now() / 1000)
|
||||||
|
|
||||||
|
const payloadAsJSON = JSON.stringify(payload)
|
||||||
|
const partialToken = `${base64UrlStringify(_utf8ToUint8Array(JSON.stringify({ ...options.header, alg: options.algorithm })))}.${base64UrlStringify(_utf8ToUint8Array(payloadAsJSON))}`
|
||||||
|
|
||||||
|
let keyFormat = 'raw'
|
||||||
|
let keyData
|
||||||
|
|
||||||
|
if (typeof secret === 'object') {
|
||||||
|
keyFormat = 'jwk'
|
||||||
|
keyData = secret
|
||||||
|
} else if (typeof secret === 'string' && secret.startsWith('-----BEGIN')) {
|
||||||
|
keyFormat = 'pkcs8'
|
||||||
|
keyData = _str2ab(secret.replace(/-----BEGIN.*?-----/g, '').replace(/-----END.*?-----/g, '').replace(/\s/g, ''))
|
||||||
|
} else
|
||||||
|
keyData = _utf8ToUint8Array(secret)
|
||||||
|
|
||||||
|
const key = await crypto.subtle.importKey(keyFormat, keyData, algorithm, false, ['sign'])
|
||||||
|
const signature = await crypto.subtle.sign(algorithm, key, _utf8ToUint8Array(partialToken))
|
||||||
|
|
||||||
|
return `${partialToken}.${base64UrlStringify(new Uint8Array(signature))}`
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Verifies the integrity of the token and returns a boolean value.
|
||||||
|
*
|
||||||
|
* @param {string} token The token string generated by `jwt.sign()`.
|
||||||
|
* @param {string | JsonWebKey} secret The string which was used to sign the payload.
|
||||||
|
* @param {JWTVerifyOptions | JWTAlgorithm} options The options object or the algorithm.
|
||||||
|
* @throws {Error | string} Throws an error `string` if the token is invalid or an `Error-Object` if there's a validation issue.
|
||||||
|
* @returns {Promise<boolean>} Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`.
|
||||||
|
*/
|
||||||
|
export async function verify(token: string, secret: string | JsonWebKey, options: JwtVerifyOptions | JwtAlgorithm = { algorithm: 'HS256', skipValidation: false, throwError: false }): Promise<boolean> {
|
||||||
|
if (typeof options === 'string')
|
||||||
|
options = { algorithm: options, throwError: false }
|
||||||
|
|
||||||
|
options = { algorithm: 'HS256', skipValidation: false, throwError: false, ...options }
|
||||||
|
|
||||||
|
if (typeof token !== 'string')
|
||||||
|
throw new Error('token must be a string')
|
||||||
|
|
||||||
|
if (typeof secret !== 'string' && typeof secret !== 'object')
|
||||||
|
throw new Error('secret must be a string or a JWK object')
|
||||||
|
|
||||||
|
if (typeof options.algorithm !== 'string')
|
||||||
|
throw new Error('options.algorithm must be a string')
|
||||||
|
|
||||||
|
const tokenParts = token.split('.')
|
||||||
|
|
||||||
|
if (tokenParts.length !== 3)
|
||||||
|
throw new Error('token must consist of 3 parts')
|
||||||
|
|
||||||
|
const algorithm: SubtleCryptoImportKeyAlgorithm = algorithms[options.algorithm]
|
||||||
|
|
||||||
|
if (!algorithm)
|
||||||
|
throw new Error('algorithm not found')
|
||||||
|
|
||||||
|
const { payload } = decode(token)
|
||||||
|
|
||||||
|
if (!options.skipValidation && !payload) {
|
||||||
|
if (options.throwError)
|
||||||
|
throw 'PARSE_ERROR'
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!options.skipValidation && payload.nbf && payload.nbf > Math.floor(Date.now() / 1000)) {
|
||||||
|
if (options.throwError)
|
||||||
|
throw 'NOT_YET_VALID'
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!options.skipValidation && payload.exp && payload.exp <= Math.floor(Date.now() / 1000)) {
|
||||||
|
if (options.throwError)
|
||||||
|
throw 'EXPIRED'
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
let keyFormat = 'raw'
|
||||||
|
let keyData
|
||||||
|
|
||||||
|
if (typeof secret === 'object') {
|
||||||
|
keyFormat = 'jwk';
|
||||||
|
keyData = secret;
|
||||||
|
} else if (typeof secret === 'string' && secret.startsWith('-----BEGIN')) {
|
||||||
|
keyFormat = 'spki'
|
||||||
|
keyData = _str2ab(secret.replace(/-----BEGIN.*?-----/g, '').replace(/-----END.*?-----/g, '').replace(/\s/g, ''))
|
||||||
|
} else
|
||||||
|
keyData = _utf8ToUint8Array(secret)
|
||||||
|
|
||||||
|
const key = await crypto.subtle.importKey(keyFormat, keyData, algorithm, false, ['verify'])
|
||||||
|
|
||||||
|
return await crypto.subtle.verify(algorithm, key, base64UrlParse(tokenParts[2]), _utf8ToUint8Array(`${tokenParts[0]}.${tokenParts[1]}`))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the payload **without** verifying the integrity of the token. Please use `jwt.verify()` first to keep your application secure!
|
||||||
|
*
|
||||||
|
* @param {string} token The token string generated by `jwt.sign()`.
|
||||||
|
* @returns {JwtData} Returns an `object` containing `header` and `payload`.
|
||||||
|
*/
|
||||||
|
export function decode(token: string): JwtData {
|
||||||
|
return {
|
||||||
|
header: _decodePayload(token.split('.')[0].replace(/-/g, '+').replace(/_/g, '/')) as JwtHeader,
|
||||||
|
payload: _decodePayload(token.split('.')[1].replace(/-/g, '+').replace(/_/g, '/')) as JwtPayload
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default {
|
||||||
|
sign,
|
||||||
|
verify,
|
||||||
|
decode
|
||||||
|
}
|
||||||
27
tsconfig.json
Normal file
27
tsconfig.json
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"outDir": ".",
|
||||||
|
"module": "commonjs",
|
||||||
|
"target": "esnext",
|
||||||
|
"lib": ["esnext"],
|
||||||
|
"declaration": true,
|
||||||
|
"strict": true,
|
||||||
|
"noImplicitAny": true,
|
||||||
|
"strictNullChecks": true,
|
||||||
|
"strictFunctionTypes": true,
|
||||||
|
"strictBindCallApply": true,
|
||||||
|
"strictPropertyInitialization": true,
|
||||||
|
"noImplicitThis": true,
|
||||||
|
"alwaysStrict": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"noImplicitReturns": true,
|
||||||
|
"noFallthroughCasesInSwitch": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"preserveConstEnums": true,
|
||||||
|
"moduleResolution": "node",
|
||||||
|
"types": ["@cloudflare/workers-types"]
|
||||||
|
},
|
||||||
|
"include": ["src"],
|
||||||
|
"exclude": ["node_modules"]
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user