Compare commits
46 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
ec41207832
|
|||
|
e64e89f325
|
|||
|
fb573d928a
|
|||
|
382ad66ea9
|
|||
|
ffc1e87b32
|
|||
|
decfa65391
|
|||
|
|
67f1a8e5ed | ||
|
fe1baf46b4
|
|||
|
81f9eafd86
|
|||
|
747931ba69
|
|||
|
261069d5cb
|
|||
|
7466a881a0
|
|||
|
81dde823d3
|
|||
|
210b733591
|
|||
|
bf11705d11
|
|||
|
99d172179e
|
|||
|
63de8056a5
|
|||
|
b953f4165a
|
|||
|
c9da88c4bb
|
|||
|
21ec1b6f2a
|
|||
|
|
97df6e7f81 | ||
|
|
7198501a40 | ||
|
cb6209b1b6
|
|||
|
8f4e5e3199
|
|||
|
594cdd6c05
|
|||
|
f85abf30a8
|
|||
|
095b1d43f3
|
|||
|
0bc128fec1
|
|||
|
f846695242
|
|||
|
695e1c0dfe
|
|||
|
64da4c625f
|
|||
|
e4038ae0a7
|
|||
|
44329617de
|
|||
|
|
e7964b63c2 | ||
|
b733a0650d
|
|||
|
43879de15e
|
|||
|
0c8f476751
|
|||
|
3c5d178fec
|
|||
|
|
f12cafd9d0 | ||
| e0219ff21f | |||
|
|
bc7fa845ed | ||
|
|
5ee043e597 | ||
|
|
9c52217ca2 | ||
|
|
5160cfa416 | ||
| 430fa0eb84 | |||
| 4d4cf316d0 |
19
.github/workflows/lint.yml
vendored
19
.github/workflows/lint.yml
vendored
@@ -1,19 +0,0 @@
|
|||||||
name: Lint
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches: [ main ]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- name: Use Node.js
|
|
||||||
uses: actions/setup-node@v1
|
|
||||||
with:
|
|
||||||
node-version: 15.x
|
|
||||||
- run: npm ci
|
|
||||||
- run: npm run lint --if-present
|
|
||||||
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
|
||||||
6
.npmignore
Normal file
6
.npmignore
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
.github/
|
||||||
|
src/
|
||||||
|
test/
|
||||||
|
.nvmrc
|
||||||
|
index.test.js
|
||||||
|
tsconfig.json
|
||||||
58
README.md
58
README.md
@@ -8,6 +8,9 @@ A lightweight JWT implementation with ZERO dependencies for Cloudflare Workers.
|
|||||||
- [Install](#install)
|
- [Install](#install)
|
||||||
- [Examples](#examples)
|
- [Examples](#examples)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
|
- [Sign](#sign)
|
||||||
|
- [Verify](#verify)
|
||||||
|
- [Decode](#decode)
|
||||||
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
@@ -21,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')
|
||||||
@@ -36,15 +39,15 @@ async () => {
|
|||||||
return
|
return
|
||||||
|
|
||||||
// Decoding token
|
// Decoding token
|
||||||
const payload = jwt.decode(token)
|
const { payload } = jwt.decode(token)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 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({
|
||||||
@@ -62,56 +65,78 @@ async () => {
|
|||||||
return
|
return
|
||||||
|
|
||||||
// Decoding token
|
// Decoding token
|
||||||
const payload = jwt.decode(token) // { name: 'John Doe', email: 'john.doe@gmail.com', ... }
|
const { payload } = jwt.decode(token) // { name: 'John Doe', email: 'john.doe@gmail.com', ... }
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
- [Sign](#sign)
|
||||||
|
- [Verify](#verify)
|
||||||
|
- [Decode](#decode)
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
### `jwt.sign(payload, secret, [options])`
|
### Sign
|
||||||
|
#### `jwt.sign(payload, secret, [options])`
|
||||||
|
|
||||||
Signs a payload and returns the token.
|
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.
|
||||||
`options` | `object`, `string` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid` or just the algorithm string. (See [Available Algorithms](#available-algorithms))
|
`options` | `object` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid`. (See [Available Algorithms](#available-algorithms))
|
||||||
|
|
||||||
#### `return`
|
#### `return`
|
||||||
Returns token as a `string`.
|
Returns token as a `string`.
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
### `jwt.verify(token, secret, [options])`
|
### Verify
|
||||||
|
#### `jwt.verify(token, secret, [options])`
|
||||||
|
|
||||||
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.
|
||||||
`algorithm` | `object`, `string` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` or just the algorithm string. (See [Available Algorithms](#available-algorithms))
|
`options` | `object` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` and `throwError`. (See [Available Algorithms](#available-algorithms))
|
||||||
|
|
||||||
|
#### `throws`
|
||||||
|
If `options.throwError` is `true` and the token is invalid, an error will be thrown.
|
||||||
|
|
||||||
#### `return`
|
#### `return`
|
||||||
Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`.
|
Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`.
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
### `jwt.decode(token)`
|
### Decode
|
||||||
|
#### `jwt.decode(token)`
|
||||||
|
|
||||||
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()`.
|
||||||
|
|
||||||
#### `return`
|
#### `return`
|
||||||
Returns payload `object`.
|
Returns an `object` containing `header` and `payload`:
|
||||||
|
```javascript
|
||||||
|
{
|
||||||
|
header: {
|
||||||
|
alg: 'HS256',
|
||||||
|
typ: 'JWT'
|
||||||
|
},
|
||||||
|
payload: {
|
||||||
|
name: 'John Doe',
|
||||||
|
email: 'john.doe@gmail.com'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Available Algorithms
|
### Available Algorithms
|
||||||
- ES256
|
- ES256
|
||||||
@@ -120,3 +145,6 @@ Returns payload `object`.
|
|||||||
- HS256
|
- HS256
|
||||||
- HS384
|
- HS384
|
||||||
- HS512
|
- HS512
|
||||||
|
- RS256
|
||||||
|
- RS384
|
||||||
|
- RS512
|
||||||
|
|||||||
51
index.d.ts
vendored
51
index.d.ts
vendored
@@ -1,51 +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.
|
|
||||||
* @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.
|
|
||||||
* @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 {object | null} Returns payload `object`.
|
|
||||||
*/
|
|
||||||
decode(token: string): object | null
|
|
||||||
}
|
|
||||||
declare const _exports: JWT
|
|
||||||
|
|
||||||
type JWTAlgorithm = 'ES256' | 'ES384' | 'ES512' | 'HS256' | 'HS384' | 'HS512'
|
|
||||||
|
|
||||||
type JWTSignOptions = {
|
|
||||||
algorithm?: JWTAlgorithm,
|
|
||||||
keyid?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
type JWTVerifyOptions = {
|
|
||||||
algorithm?: JWTAlgorithm
|
|
||||||
}
|
|
||||||
|
|
||||||
export = _exports
|
|
||||||
115
index.js
115
index.js
@@ -1,115 +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 (!crypto || !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-512', 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' } }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_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' }) {
|
|
||||||
if (typeof options === 'string')
|
|
||||||
options = { algorithm: options }
|
|
||||||
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({ 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' }) {
|
|
||||||
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 have 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))
|
|
||||||
return false
|
|
||||||
if (payload.exp && payload.exp < Math.floor(Date.now() / 1000))
|
|
||||||
return false
|
|
||||||
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 res = await crypto.subtle.sign(importAlgorithm, key, this._utf8ToUint8Array(tokenParts.slice(0, 2).join('.')))
|
|
||||||
return Base64URL.stringify(new Uint8Array(res)) === tokenParts[2]
|
|
||||||
}
|
|
||||||
decode(token) {
|
|
||||||
return this._decodePayload(token.split('.')[1].replace(/-/g, '+').replace(/_/g, '/'))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = new JWT
|
|
||||||
180
index.test.js
Normal file
180
index.test.js
Normal file
@@ -0,0 +1,180 @@
|
|||||||
|
const { subtle } = require('node:crypto').webcrypto
|
||||||
|
Object.defineProperty(global, 'crypto', {
|
||||||
|
value: { subtle }
|
||||||
|
})
|
||||||
|
|
||||||
|
const jwt = require('./index.js')
|
||||||
|
const oneDay = (60 * 60 * 24)
|
||||||
|
const now = Date.now() / 1000
|
||||||
|
const algorithms = [
|
||||||
|
'ES256',
|
||||||
|
'ES384',
|
||||||
|
'ES512',
|
||||||
|
'HS256',
|
||||||
|
'HS384',
|
||||||
|
'HS512',
|
||||||
|
'RS256',
|
||||||
|
'RS384',
|
||||||
|
'RS512'
|
||||||
|
]
|
||||||
|
|
||||||
|
const secrets = {}
|
||||||
|
|
||||||
|
// Keypairs
|
||||||
|
for (const algorithm of algorithms) {
|
||||||
|
if (algorithm.startsWith('HS')) {
|
||||||
|
//secrets[algorithm] = 'c2VjcmV0'
|
||||||
|
secrets[algorithm] = 'secret'
|
||||||
|
} else if (algorithm.startsWith('RS')) {
|
||||||
|
secrets[algorithm] = {
|
||||||
|
public: `-----BEGIN PUBLIC KEY-----
|
||||||
|
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo
|
||||||
|
4lgOEePzNm0tRgeLezV6ffAt0gunVTLw7onLRnrq0/IzW7yWR7QkrmBL7jTKEn5u
|
||||||
|
+qKhbwKfBstIs+bMY2Zkp18gnTxKLxoS2tFczGkPLPgizskuemMghRniWaoLcyeh
|
||||||
|
kd3qqGElvW/VDL5AaWTg0nLVkjRo9z+40RQzuVaE8AkAFmxZzow3x+VJYKdjykkJ
|
||||||
|
0iT9wCS0DRTXu269V264Vf/3jvredZiKRkgwlL9xNAwxXFg0x/XFw005UWVRIkdg
|
||||||
|
cKWTjpBP2dPwVZ4WWC+9aGVd+Gyn1o0CLelf4rEjGoXbAAEgAqeGUxrcIlbjXfbc
|
||||||
|
mwIDAQAB
|
||||||
|
-----END PUBLIC KEY-----`,
|
||||||
|
private: `-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQC7VJTUt9Us8cKj
|
||||||
|
MzEfYyjiWA4R4/M2bS1GB4t7NXp98C3SC6dVMvDuictGeurT8jNbvJZHtCSuYEvu
|
||||||
|
NMoSfm76oqFvAp8Gy0iz5sxjZmSnXyCdPEovGhLa0VzMaQ8s+CLOyS56YyCFGeJZ
|
||||||
|
qgtzJ6GR3eqoYSW9b9UMvkBpZODSctWSNGj3P7jRFDO5VoTwCQAWbFnOjDfH5Ulg
|
||||||
|
p2PKSQnSJP3AJLQNFNe7br1XbrhV//eO+t51mIpGSDCUv3E0DDFcWDTH9cXDTTlR
|
||||||
|
ZVEiR2BwpZOOkE/Z0/BVnhZYL71oZV34bKfWjQIt6V/isSMahdsAASACp4ZTGtwi
|
||||||
|
VuNd9tybAgMBAAECggEBAKTmjaS6tkK8BlPXClTQ2vpz/N6uxDeS35mXpqasqskV
|
||||||
|
laAidgg/sWqpjXDbXr93otIMLlWsM+X0CqMDgSXKejLS2jx4GDjI1ZTXg++0AMJ8
|
||||||
|
sJ74pWzVDOfmCEQ/7wXs3+cbnXhKriO8Z036q92Qc1+N87SI38nkGa0ABH9CN83H
|
||||||
|
mQqt4fB7UdHzuIRe/me2PGhIq5ZBzj6h3BpoPGzEP+x3l9YmK8t/1cN0pqI+dQwY
|
||||||
|
dgfGjackLu/2qH80MCF7IyQaseZUOJyKrCLtSD/Iixv/hzDEUPfOCjFDgTpzf3cw
|
||||||
|
ta8+oE4wHCo1iI1/4TlPkwmXx4qSXtmw4aQPz7IDQvECgYEA8KNThCO2gsC2I9PQ
|
||||||
|
DM/8Cw0O983WCDY+oi+7JPiNAJwv5DYBqEZB1QYdj06YD16XlC/HAZMsMku1na2T
|
||||||
|
N0driwenQQWzoev3g2S7gRDoS/FCJSI3jJ+kjgtaA7Qmzlgk1TxODN+G1H91HW7t
|
||||||
|
0l7VnL27IWyYo2qRRK3jzxqUiPUCgYEAx0oQs2reBQGMVZnApD1jeq7n4MvNLcPv
|
||||||
|
t8b/eU9iUv6Y4Mj0Suo/AU8lYZXm8ubbqAlwz2VSVunD2tOplHyMUrtCtObAfVDU
|
||||||
|
AhCndKaA9gApgfb3xw1IKbuQ1u4IF1FJl3VtumfQn//LiH1B3rXhcdyo3/vIttEk
|
||||||
|
48RakUKClU8CgYEAzV7W3COOlDDcQd935DdtKBFRAPRPAlspQUnzMi5eSHMD/ISL
|
||||||
|
DY5IiQHbIH83D4bvXq0X7qQoSBSNP7Dvv3HYuqMhf0DaegrlBuJllFVVq9qPVRnK
|
||||||
|
xt1Il2HgxOBvbhOT+9in1BzA+YJ99UzC85O0Qz06A+CmtHEy4aZ2kj5hHjECgYEA
|
||||||
|
mNS4+A8Fkss8Js1RieK2LniBxMgmYml3pfVLKGnzmng7H2+cwPLhPIzIuwytXywh
|
||||||
|
2bzbsYEfYx3EoEVgMEpPhoarQnYPukrJO4gwE2o5Te6T5mJSZGlQJQj9q4ZB2Dfz
|
||||||
|
et6INsK0oG8XVGXSpQvQh3RUYekCZQkBBFcpqWpbIEsCgYAnM3DQf3FJoSnXaMhr
|
||||||
|
VBIovic5l0xFkEHskAjFTevO86Fsz1C2aSeRKSqGFoOQ0tmJzBEs1R6KqnHInicD
|
||||||
|
TQrKhArgLXX4v3CddjfTRJkFWDbE/CkvKZNOrcf1nhaGCPspRJj2KUkj1Fhl9Cnc
|
||||||
|
dn/RsYEONbwQSjIfMPkvxF+8HQ==
|
||||||
|
-----END PRIVATE KEY-----`
|
||||||
|
}
|
||||||
|
} else if (algorithm.startsWith('ES')) {
|
||||||
|
if (algorithm === 'ES256') {
|
||||||
|
secrets[algorithm] = {
|
||||||
|
public: `-----BEGIN PUBLIC KEY-----
|
||||||
|
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEEVs/o5+uQbTjL3chynL4wXgUg2R9
|
||||||
|
q9UU8I5mEovUf86QZ7kOBIjJwqnzD1omageEHWwHdBO6B+dFabmdT9POxg==
|
||||||
|
-----END PUBLIC KEY-----`,
|
||||||
|
private: `-----BEGIN PRIVATE KEY-----
|
||||||
|
MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgevZzL1gdAFr88hb2
|
||||||
|
OF/2NxApJCzGCEDdfSp6VQO30hyhRANCAAQRWz+jn65BtOMvdyHKcvjBeBSDZH2r
|
||||||
|
1RTwjmYSi9R/zpBnuQ4EiMnCqfMPWiZqB4QdbAd0E7oH50VpuZ1P087G
|
||||||
|
-----END PRIVATE KEY-----`
|
||||||
|
}
|
||||||
|
} else if (algorithm === 'ES384') {
|
||||||
|
secrets[algorithm] = {
|
||||||
|
public: `-----BEGIN PUBLIC KEY-----
|
||||||
|
MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEC1uWSXj2czCDwMTLWV5BFmwxdM6PX9p+
|
||||||
|
Pk9Yf9rIf374m5XP1U8q79dBhLSIuaojsvOT39UUcPJROSD1FqYLued0rXiooIii
|
||||||
|
1D3jaW6pmGVJFhodzC31cy5sfOYotrzF
|
||||||
|
-----END PUBLIC KEY-----`,
|
||||||
|
private: `-----BEGIN PRIVATE KEY-----
|
||||||
|
MIG2AgEAMBAGByqGSM49AgEGBSuBBAAiBIGeMIGbAgEBBDCAHpFQ62QnGCEvYh/p
|
||||||
|
E9QmR1C9aLcDItRbslbmhen/h1tt8AyMhskeenT+rAyyPhGhZANiAAQLW5ZJePZz
|
||||||
|
MIPAxMtZXkEWbDF0zo9f2n4+T1h/2sh/fviblc/VTyrv10GEtIi5qiOy85Pf1RRw
|
||||||
|
8lE5IPUWpgu553SteKigiKLUPeNpbqmYZUkWGh3MLfVzLmx85ii2vMU=
|
||||||
|
-----END PRIVATE KEY-----`
|
||||||
|
}
|
||||||
|
} else if (algorithm === 'ES512') {
|
||||||
|
secrets[algorithm] = {
|
||||||
|
public: `-----BEGIN PUBLIC KEY-----
|
||||||
|
MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBgc4HZz+/fBbC7lmEww0AO3NK9wVZ
|
||||||
|
PDZ0VEnsaUFLEYpTzb90nITtJUcPUbvOsdZIZ1Q8fnbquAYgxXL5UgHMoywAib47
|
||||||
|
6MkyyYgPk0BXZq3mq4zImTRNuaU9slj9TVJ3ScT3L1bXwVuPJDzpr5GOFpaj+WwM
|
||||||
|
Al8G7CqwoJOsW7Kddns=
|
||||||
|
-----END PUBLIC KEY-----`,
|
||||||
|
private: `-----BEGIN PRIVATE KEY-----
|
||||||
|
MIHuAgEAMBAGByqGSM49AgEGBSuBBAAjBIHWMIHTAgEBBEIBiyAa7aRHFDCh2qga
|
||||||
|
9sTUGINE5jHAFnmM8xWeT/uni5I4tNqhV5Xx0pDrmCV9mbroFtfEa0XVfKuMAxxf
|
||||||
|
Z6LM/yKhgYkDgYYABAGBzgdnP798FsLuWYTDDQA7c0r3BVk8NnRUSexpQUsRilPN
|
||||||
|
v3SchO0lRw9Ru86x1khnVDx+duq4BiDFcvlSAcyjLACJvjvoyTLJiA+TQFdmrear
|
||||||
|
jMiZNE25pT2yWP1NUndJxPcvVtfBW48kPOmvkY4WlqP5bAwCXwbsKrCgk6xbsp12
|
||||||
|
ew==
|
||||||
|
-----END PRIVATE KEY-----`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Payload
|
||||||
|
const testPayload = {
|
||||||
|
sub: "1234567890",
|
||||||
|
name: "John Doe"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Self test
|
||||||
|
test.each(Object.entries(secrets))(`Self test: %s`, async (algorithm, key) => {
|
||||||
|
let privateKey = key
|
||||||
|
let publicKey = key
|
||||||
|
|
||||||
|
if (typeof key === 'object') {
|
||||||
|
privateKey = key.private
|
||||||
|
publicKey = key.public
|
||||||
|
}
|
||||||
|
|
||||||
|
const token = await jwt.sign(testPayload, privateKey, { algorithm })
|
||||||
|
expect(token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/)
|
||||||
|
|
||||||
|
const verified = await jwt.verify(token, publicKey, { algorithm })
|
||||||
|
expect(verified).toBeTruthy()
|
||||||
|
|
||||||
|
const { payload } = jwt.decode(token)
|
||||||
|
expect({
|
||||||
|
sub: payload.sub,
|
||||||
|
name: payload.name
|
||||||
|
}).toMatchObject({
|
||||||
|
sub: testPayload.sub,
|
||||||
|
name: testPayload.name
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
// External token test
|
||||||
|
const externalTokens = {
|
||||||
|
ES256: 'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.Ri9u3ZJpyoHf1_i3KpVE5gMggyU3VMYPeEVktAsG1kGLOxFNJBXydQls3WFBaXXH2-sN74IMe-nDcM7NoJ6GMQ',
|
||||||
|
ES384: 'eyJhbGciOiJFUzM4NCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.6nmlvcCpsfENb6ssgX3rJ2XSjpFSXD1RPS1CK0iDZFdi6I6Gnmpi456RSW6-0XSSgq2E2XBcWCSYE6TeI63jOGZJTQ6-65g4sndbzBPqYPWbLny00NQ4MQgQXVu6tRzg',
|
||||||
|
ES512: 'eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.AbRwaCPJM2X3XjE2kInClHVGJNIcpL5C4a1ZrgwEM05RTryyNbazWRFbXAEDtHm8crvXpqw3a8JQwYDwvMyoOr4jAJ4RbhJitLgCGEzhKjvNy4xGrg3dV8gGEShFowgDfVz0KqHOX_Bc_DbyL-gtZPdfGTwT2upLkJE-lj47RStPDh0b',
|
||||||
|
HS256: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o',
|
||||||
|
HS384: 'eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.hO2sthNQUSfvI9ylUdMKDxcrm8jB3KL6Rtkd3FOskL-jVqYh2CK1es8FKCQO8_tW',
|
||||||
|
HS512: 'eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.wUVS6tazE2N98_J4SH_djkEe1igXPu0qILAvVXCiO6O20gdf5vZ2sYFWX3c-Hy6L4TD47b3DSAAO9XjSqpJfag',
|
||||||
|
RS256: 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.Eci61G6w4zh_u9oOCk_v1M_sKcgk0svOmW4ZsL-rt4ojGUH2QY110bQTYNwbEVlowW7phCg7vluX_MCKVwJkxJT6tMk2Ij3Plad96Jf2G2mMsKbxkC-prvjvQkBFYWrYnKWClPBRCyIcG0dVfBvqZ8Mro3t5bX59IKwQ3WZ7AtGBYz5BSiBlrKkp6J1UmP_bFV3eEzIHEFgzRa3pbr4ol4TK6SnAoF88rLr2NhEz9vpdHglUMlOBQiqcZwqrI-Z4XDyDzvnrpujIToiepq9bCimPgVkP54VoZzy-mMSGbthYpLqsL_4MQXaI1Uf_wKFAUuAtzVn4-ebgsKOpvKNzVA',
|
||||||
|
RS384: 'eyJhbGciOiJSUzM4NCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.oPvWzaCp8xUpt5mHhPSn0qLsZfCFj0NVmb4mz4dFQPCCMj-F5zVn9e3zZoj0lIXWM8rxB69QHC3Er47mtDt3BKgysTL3BvvV89kD6UjLoUcAI3lwj0mi7acLoE27i1_TnIBqWNRPAsdvTDawNE0_4lvI5bxEWQCqisJwxCoMDIeJsmDzfyApgU_SAFSVULxXwU2VewaxdQB-41OZdWwUEAxh81iB6DFWrqd2CaJkUYoWjgYpeWsyeC2m_-ECGrHGEz1nKTm9c7BaPxurz7fHD7RJd9Wpx-mKDVsfspO9quWb_OLeGGbxTtAomMvjQjut56kx2fqTleDnNDh_0GE88w',
|
||||||
|
RS512: 'eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.kEZmDAnHHU_0bcGXMd5LA7vF87yQgXNaioPHP4lU4O3JJYuZ54fJdv3HT58xk-MFEDuWro_5fvNIp2VM-PlkZvYWrhQkJ-c-seoSa3ANq_PciC3bGfzYHEdjAE71GrAMI4FlcAGsq3ChkOnCTFqjWDmVwaRYCgMsFQ-U5cjvFhndFMizrkRljTF4v5oFdWytV_J-UafPtNdQXcGND1M74DqObnTHhZHg8aDfNzZcvnIeKcDVGUlUEL5ia1kPMrVhCtOAOJmEU8ivCdWWzt-jMQBf7cZeoCzDKHG72ysTTCfRoBVc1_SrQTHcHDiiBeW9nCazMLkltyP5NeawR_RNlg'
|
||||||
|
}
|
||||||
|
|
||||||
|
test.each(Object.entries(externalTokens))('Verify external tokens: %s', async (algorithm, token) => {
|
||||||
|
const key = secrets[algorithm]
|
||||||
|
|
||||||
|
let publicKey = key
|
||||||
|
|
||||||
|
if (typeof key === 'object')
|
||||||
|
publicKey = key.public
|
||||||
|
|
||||||
|
const verified = await jwt.verify(token, publicKey, { algorithm })
|
||||||
|
expect(verified).toBeTruthy()
|
||||||
|
|
||||||
|
const { payload } = jwt.decode(token)
|
||||||
|
expect({
|
||||||
|
sub: payload.sub,
|
||||||
|
name: payload.name
|
||||||
|
}).toMatchObject({
|
||||||
|
sub: testPayload.sub,
|
||||||
|
name: testPayload.name
|
||||||
|
})
|
||||||
|
})
|
||||||
5943
package-lock.json
generated
5943
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.1.4",
|
"version": "2.1.2",
|
||||||
"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": {
|
||||||
"lint": "tslint index.js"
|
"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": {
|
||||||
"tslint": "^6.1.3"
|
"@cloudflare/workers-types": "^3.13.0",
|
||||||
|
"jest": "^28.1.1",
|
||||||
|
"typescript": "^4.7.4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
300
src/index.ts
Normal file
300
src/index.ts
Normal file
@@ -0,0 +1,300 @@
|
|||||||
|
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} [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
|
||||||
|
|
||||||
|
/** 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` 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} 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, 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')
|
||||||
|
throw new Error('secret must be a string')
|
||||||
|
|
||||||
|
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')
|
||||||
|
|
||||||
|
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 (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} 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, options: JwtVerifyOptions | JwtAlgorithm = { algorithm: 'HS256', throwError: false }): Promise<boolean> {
|
||||||
|
if (typeof options === 'string')
|
||||||
|
options = { algorithm: options, throwError: false }
|
||||||
|
|
||||||
|
options = { algorithm: 'HS256', throwError: false, ...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 algorithm: SubtleCryptoImportKeyAlgorithm = algorithms[options.algorithm]
|
||||||
|
|
||||||
|
if (!algorithm)
|
||||||
|
throw new Error('algorithm not found')
|
||||||
|
|
||||||
|
const { payload } = decode(token)
|
||||||
|
|
||||||
|
if (!payload) {
|
||||||
|
if (options.throwError)
|
||||||
|
throw 'PARSE_ERROR'
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
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 = _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"]
|
||||||
|
}
|
||||||
53
tslint.json
53
tslint.json
@@ -1,53 +0,0 @@
|
|||||||
{
|
|
||||||
"jsRules": {
|
|
||||||
"arrow-return-shorthand": [true, "multiline"],
|
|
||||||
"binary-expression-operand-order": true,
|
|
||||||
"class-name": true,
|
|
||||||
"comment-format": [true, "check-space"],
|
|
||||||
"curly": [true, "as-needed"],
|
|
||||||
"encoding": true,
|
|
||||||
"increment-decrement": [true, "allow-post"],
|
|
||||||
"indent": [true, "spaces", 2],
|
|
||||||
"linebreak-style": [true, "LF"],
|
|
||||||
"no-async-without-await": true,
|
|
||||||
"no-consecutive-blank-lines": [true, 2],
|
|
||||||
"no-duplicate-switch-case": true,
|
|
||||||
"no-duplicate-variable": [true, "check-parameters"],
|
|
||||||
"no-empty": true,
|
|
||||||
"no-eval": true,
|
|
||||||
"no-invalid-template-strings": true,
|
|
||||||
"no-invalid-this": true,
|
|
||||||
"no-irregular-whitespace": true,
|
|
||||||
"no-return-await": true,
|
|
||||||
"no-shadowed-variable": true,
|
|
||||||
"no-sparse-arrays": true,
|
|
||||||
"no-string-throw": true,
|
|
||||||
"no-tautology-expression": true,
|
|
||||||
"no-this-assignment": [true, {"allowed-names": ["^self$"], "allow-destructuring": true}],
|
|
||||||
"no-trailing-whitespace": [true, "ignore-comments", "ignore-jsdoc"],
|
|
||||||
"no-unnecessary-callback-wrapper": true,
|
|
||||||
"no-unnecessary-initializer": true,
|
|
||||||
"no-unsafe-finally": true,
|
|
||||||
"no-var-keyword": true,
|
|
||||||
"object-literal-key-quotes": [true, "consistent-as-needed"],
|
|
||||||
"one-line": [true, "check-catch", "check-finally", "check-else", "check-open-brace", "check-whitespace"],
|
|
||||||
"one-variable-per-declaration": [true, "ignore-for-loop"],
|
|
||||||
"ordered-imports": true,
|
|
||||||
"prefer-conditional-expression": [true, "check-else-if"],
|
|
||||||
"prefer-const": true,
|
|
||||||
"prefer-object-spread": true,
|
|
||||||
"prefer-switch": [true, {"min-cases": 3}],
|
|
||||||
"prefer-template": [true, "allow-single-concat"],
|
|
||||||
"prefer-while": true,
|
|
||||||
"quotemark": [true, "single"],
|
|
||||||
"semicolon": [true, "never"],
|
|
||||||
"space-before-function-paren": [true, "never"],
|
|
||||||
"static-this": true,
|
|
||||||
"trailing-comma": [true, {"multiline": "never", "singleline": "never"}],
|
|
||||||
"triple-equals": true,
|
|
||||||
"unnecessary-constructor": [true, {"check-super-calls": true}],
|
|
||||||
"unnecessary-else": [true, {"allow-else-if": true}],
|
|
||||||
"use-isnan": true,
|
|
||||||
"whitespace": [true, "check-branch", "check-decl", "check-operator", "check-module", "check-separator", "check-rest-spread", "check-type", "check-typecast", "check-type-operator", "check-preblock", "check-postbrace"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user