@elysiajs/jwt 0.0.0-experimental.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.js +23 -0
- package/CHANGELOG.md +4 -0
- package/LICENSE +7 -0
- package/README.md +104 -0
- package/build/es/index.js +54 -0
- package/build/es/index.js.map +1 -0
- package/build/index.js +62 -0
- package/build/index.js.map +1 -0
- package/package.json +56 -0
- package/src/index.ts +157 -0
- package/test/index.test.ts +50 -0
package/.eslintrc.js
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
module.exports = {
|
|
2
|
+
"env": {
|
|
3
|
+
"es2021": true,
|
|
4
|
+
"node": true
|
|
5
|
+
},
|
|
6
|
+
"extends": [
|
|
7
|
+
"eslint:recommended",
|
|
8
|
+
"plugin:@typescript-eslint/recommended"
|
|
9
|
+
],
|
|
10
|
+
"parser": "@typescript-eslint/parser",
|
|
11
|
+
"parserOptions": {
|
|
12
|
+
"ecmaVersion": "latest",
|
|
13
|
+
"sourceType": "module"
|
|
14
|
+
},
|
|
15
|
+
"plugins": [
|
|
16
|
+
"@typescript-eslint"
|
|
17
|
+
],
|
|
18
|
+
"rules": {
|
|
19
|
+
"@typescript-eslint/ban-types": 'off',
|
|
20
|
+
'@typescript-eslint/no-explicit-any': 'off'
|
|
21
|
+
},
|
|
22
|
+
"ignorePatterns": ["example/*", "tests/**/*"]
|
|
23
|
+
}
|
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright 2022 saltyAom
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# @elysiajs/static
|
|
2
|
+
Plugin for [Elysia](https://github.com/elysiajs/elysia) for using JWT Authentication.
|
|
3
|
+
|
|
4
|
+
## Installation
|
|
5
|
+
```bash
|
|
6
|
+
bun add @elysiajs/jwt
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
```typescript
|
|
11
|
+
import { Elysia, t } from 'elysia'
|
|
12
|
+
import { jwt } from '@elysiajs/jwt'
|
|
13
|
+
import { cookie } from '@elysiajs/cookie'
|
|
14
|
+
|
|
15
|
+
const app = new Elysia()
|
|
16
|
+
.use(
|
|
17
|
+
jwt({
|
|
18
|
+
name: 'jwt',
|
|
19
|
+
// This should be Environment Variable
|
|
20
|
+
secret: 'MY_SECRETS'
|
|
21
|
+
})
|
|
22
|
+
)
|
|
23
|
+
.use(cookie())
|
|
24
|
+
.get('/sign/:name', async ({ jwt, cookie, setCookie, params }) => {
|
|
25
|
+
setCookie('auth', await jwt.sign(params), {
|
|
26
|
+
httpOnly: true
|
|
27
|
+
})
|
|
28
|
+
|
|
29
|
+
return `Sign in as ${params.name}`
|
|
30
|
+
})
|
|
31
|
+
.get('/profile', async ({ jwt, set, cookie: { auth } }) => {
|
|
32
|
+
const profile = await jwt.verify(auth)
|
|
33
|
+
|
|
34
|
+
if (!profile) {
|
|
35
|
+
set.status = 401
|
|
36
|
+
return 'Unauthorized'
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
return `Hello ${profile.name}`
|
|
40
|
+
})
|
|
41
|
+
.listen(8080)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Config
|
|
45
|
+
This package extends [jose](https://github.com/panva/jose), most config is inherited from Jose.
|
|
46
|
+
|
|
47
|
+
Below are configurable properties for using JWT plugin
|
|
48
|
+
|
|
49
|
+
### name
|
|
50
|
+
Name to decorate method as:
|
|
51
|
+
|
|
52
|
+
For example, `jwt` will decorate Context with `Context.jwt`
|
|
53
|
+
|
|
54
|
+
### secret
|
|
55
|
+
JWT secret key
|
|
56
|
+
|
|
57
|
+
### schema
|
|
58
|
+
Type strict validation for JWT payload
|
|
59
|
+
|
|
60
|
+
## Jose's config
|
|
61
|
+
Below is the config inherits from [jose](https://github.com/panva/jose)
|
|
62
|
+
|
|
63
|
+
### alg
|
|
64
|
+
@default 'HS256'
|
|
65
|
+
|
|
66
|
+
Algorithm to sign JWT with
|
|
67
|
+
|
|
68
|
+
### crit
|
|
69
|
+
Critical Header Parameter.
|
|
70
|
+
|
|
71
|
+
### iss
|
|
72
|
+
JWT Issuer
|
|
73
|
+
|
|
74
|
+
@see [RFC7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
|
|
75
|
+
|
|
76
|
+
### sub
|
|
77
|
+
JWT Subject
|
|
78
|
+
|
|
79
|
+
@see [RFC7519#section-4.1.2](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2)
|
|
80
|
+
|
|
81
|
+
### aud
|
|
82
|
+
JWT Audience
|
|
83
|
+
|
|
84
|
+
@see [RFC7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
|
|
85
|
+
|
|
86
|
+
### jti
|
|
87
|
+
JWT ID
|
|
88
|
+
|
|
89
|
+
@see [RFC7519#section-4.1.7](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7)
|
|
90
|
+
|
|
91
|
+
### nbf
|
|
92
|
+
JWT Not Before
|
|
93
|
+
|
|
94
|
+
@see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
|
|
95
|
+
|
|
96
|
+
### exp
|
|
97
|
+
JWT Expiration Time
|
|
98
|
+
|
|
99
|
+
@see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
|
|
100
|
+
|
|
101
|
+
### iat
|
|
102
|
+
JWT Issued At
|
|
103
|
+
|
|
104
|
+
@see [RFC7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { createValidationError as t, getSchemaValidator as r } from 'elysia/src/utils';
|
|
2
|
+
import { SignJWT as e, jwtVerify as i } from 'jose';
|
|
3
|
+
import { Type as n } from '@sinclair/typebox';
|
|
4
|
+
export const jwt = ({ name: o , secret: a , alg: p = 'HS256' , crit: s , schema: l , nbf: c , exp: d , ...f })=>(u)=>{
|
|
5
|
+
if (!a) throw Error("Secret can't be empty");
|
|
6
|
+
let g = new TextEncoder().encode(a), m = l ? r(n.Union([
|
|
7
|
+
l,
|
|
8
|
+
n.Object({
|
|
9
|
+
iss: n.Optional(n.String()),
|
|
10
|
+
sub: n.Optional(n.String()),
|
|
11
|
+
aud: n.Optional(n.Union([
|
|
12
|
+
n.String(),
|
|
13
|
+
n.Array(n.String())
|
|
14
|
+
])),
|
|
15
|
+
jti: n.Optional(n.String()),
|
|
16
|
+
nbf: n.Optional(n.Union([
|
|
17
|
+
n.String(),
|
|
18
|
+
n.Number()
|
|
19
|
+
])),
|
|
20
|
+
exp: n.Optional(n.Union([
|
|
21
|
+
n.String(),
|
|
22
|
+
n.Number()
|
|
23
|
+
])),
|
|
24
|
+
iat: n.Optional(n.String())
|
|
25
|
+
})
|
|
26
|
+
])) : void 0;
|
|
27
|
+
return u.decorate(o, {
|
|
28
|
+
sign (t) {
|
|
29
|
+
let r = new e({
|
|
30
|
+
...f,
|
|
31
|
+
...t,
|
|
32
|
+
nbf: void 0,
|
|
33
|
+
exp: void 0
|
|
34
|
+
}).setProtectedHeader({
|
|
35
|
+
alg: p,
|
|
36
|
+
crit: s
|
|
37
|
+
});
|
|
38
|
+
return c && (r = r.setNotBefore(c)), d && (r = r.setExpirationTime(d)), r.sign(g);
|
|
39
|
+
},
|
|
40
|
+
async verify (r) {
|
|
41
|
+
if (!r) return !1;
|
|
42
|
+
try {
|
|
43
|
+
let e = (await i(r, g)).payload;
|
|
44
|
+
if (m && !m.Check(e)) throw t('JWT', m, e);
|
|
45
|
+
return e;
|
|
46
|
+
} catch (n) {
|
|
47
|
+
return !1;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
});
|
|
51
|
+
};
|
|
52
|
+
export default jwt;
|
|
53
|
+
|
|
54
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import type { Elysia, Context, UnwrapSchema } from 'elysia'\nimport { createValidationError, getSchemaValidator } from 'elysia/src/utils'\n\nimport {\n SignJWT,\n jwtVerify,\n type JWTPayload,\n type JWSHeaderParameters\n} from 'jose'\n\nimport { Type as t } from '@sinclair/typebox'\nimport type { Static, TObject, TSchema } from '@sinclair/typebox'\n\nexport interface JWTPayloadSpec {\n iss?: string\n sub?: string\n aud?: string | string[]\n jti?: string\n nbf?: number\n exp?: number\n iat?: number\n}\n\nexport interface JWTOption<\n Name extends string = string,\n Schema extends TSchema | undefined = undefined\n> extends JWSHeaderParameters,\n Omit<JWTPayload, 'nbf' | 'exp'> {\n /**\n * Name to decorate method as\n *\n * ---\n * @example\n * For example, `jwt` will decorate Context with `Context.jwt`\n *\n * ```typescript\n * app\n * .decorate({\n * name: 'myJWTNamespace',\n * secret: process.env.JWT_SECRETS\n * })\n * .get('/sign/:name', ({ myJWTNamespace, params }) => {\n * return myJWTNamespace.sign(params)\n * })\n * ```\n */\n name: Name\n /**\n * JWT Secret\n */\n secret: string\n /**\n * Type strict validation for JWT payload\n */\n schema?: Schema\n\n /**\n * JWT Not Before\n *\n * @see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)\n */\n\n nbf?: string | number\n /**\n * JWT Expiration Time\n *\n * @see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)\n */\n exp?: string | number\n}\n\nexport const jwt =\n <\n Name extends string = string,\n Schema extends TSchema | undefined = undefined\n >({\n name,\n secret,\n // Start JWT Header\n alg = 'HS256',\n crit,\n schema,\n // End JWT Header\n // Start JWT Payload\n nbf,\n exp,\n ...payload\n }: // End JWT Payload\n JWTOption<Name, Schema>) =>\n (app: Elysia) => {\n if (!secret) throw new Error(\"Secret can't be empty\")\n\n const key = new TextEncoder().encode(secret)\n\n const validator = schema\n ? getSchemaValidator(\n t.Union([\n schema,\n t.Object({\n iss: t.Optional(t.String()),\n sub: t.Optional(t.String()),\n aud: t.Optional(\n t.Union([t.String(), t.Array(t.String())])\n ),\n jti: t.Optional(t.String()),\n nbf: t.Optional(t.Union([t.String(), t.Number()])),\n exp: t.Optional(t.Union([t.String(), t.Number()])),\n iat: t.Optional(t.String())\n })\n ])\n )\n : undefined\n\n return app.decorate(name, {\n sign: (\n morePayload: UnwrapSchema<Schema, Record<string, string>> &\n JWTPayloadSpec\n ) => {\n let jwt = new SignJWT({\n ...payload,\n ...morePayload,\n nbf: undefined,\n exp: undefined\n }).setProtectedHeader({\n alg,\n crit\n })\n\n if (nbf) jwt = jwt.setNotBefore(nbf)\n if (exp) jwt = jwt.setExpirationTime(exp)\n\n return jwt.sign(key)\n },\n verify: async (\n jwt?: string\n ): Promise<\n | (UnwrapSchema<Schema, Record<string, string>> &\n JWTPayloadSpec)\n | false\n > => {\n if (!jwt) return false\n\n try {\n const data: any = (await jwtVerify(jwt, key)).payload\n\n if (validator && !validator!.Check(data))\n throw createValidationError('JWT', validator, data)\n\n return data\n } catch (_) {\n return false\n }\n }\n })\n }\n\nexport default jwt\n"],"names":["createValidationError","getSchemaValidator","SignJWT","jwtVerify","Type","t","jwt","name","secret","alg","crit","schema","nbf","exp","payload","app","Error","key","TextEncoder","encode","validator","Union","Object","iss","Optional","String","sub","aud","Array","jti","Number","iat","undefined","decorate","sign","morePayload","setProtectedHeader","setNotBefore","setExpirationTime","verify","data","Check","_"],"mappings":"AACA,SAASA,yBAAAA,CAAqB,EAAEC,sBAAAA,CAAkB,QAAQ,mBAAkB;AAE5E,SACIC,WAAAA,CAAO,EACPC,aAAAA,CAAS,QAGN,OAAM;AAEb,SAASC,QAAQC,CAAC,QAAQ,oBAAmB;AA6D7C,OAAO,MAAMC,MACT,CAGE,EACEC,MAAAA,EAAI,EACJC,QAAAA,EAAM,EAENC,KAAAA,IAAM,OAAO,CAAA,EACbC,MAAAA,EAAI,EACJC,QAAAA,EAAM,EAGNC,KAAAA,EAAG,EACHC,KAAAA,EAAG,EACH,GAAGC,GAEgB,GACvB,CAACC,IAAgB;QACb,IAAI,CAACP,GAAQ,MAAM,AAAIQ,MAAM,yBAAwB;QAErD,IAAMC,IAAM,IAAIC,cAAcC,MAAM,CAACX,IAE/BY,IAAYT,IACZV,EACII,EAAEgB,KAAK,CAAC;YACJV;YACAN,EAAEiB,MAAM,CAAC;gBACLC,KAAKlB,EAAEmB,QAAQ,CAACnB,EAAEoB,MAAM;gBACxBC,KAAKrB,EAAEmB,QAAQ,CAACnB,EAAEoB,MAAM;gBACxBE,KAAKtB,EAAEmB,QAAQ,CACXnB,EAAEgB,KAAK,CAAC;oBAAChB,EAAEoB,MAAM;oBAAIpB,EAAEuB,KAAK,CAACvB,EAAEoB,MAAM;iBAAI;gBAE7CI,KAAKxB,EAAEmB,QAAQ,CAACnB,EAAEoB,MAAM;gBACxBb,KAAKP,EAAEmB,QAAQ,CAACnB,EAAEgB,KAAK,CAAC;oBAAChB,EAAEoB,MAAM;oBAAIpB,EAAEyB,MAAM;iBAAG;gBAChDjB,KAAKR,EAAEmB,QAAQ,CAACnB,EAAEgB,KAAK,CAAC;oBAAChB,EAAEoB,MAAM;oBAAIpB,EAAEyB,MAAM;iBAAG;gBAChDC,KAAK1B,EAAEmB,QAAQ,CAACnB,EAAEoB,MAAM;YAC5B;SACH,KAELO,KAAAA,CAAS;QAEf,OAAOjB,EAAIkB,QAAQ,CAAC1B,GAAM;YACtB2B,MACIC,GAEC;gBACD,IAAI7B,IAAM,IAAIJ,EAAQ;oBAClB,GAAGY,CAAO;oBACV,GAAGqB,CAAW;oBACdvB,KAAKoB,KAAAA;oBACLnB,KAAKmB,KAAAA;gBACT,GAAGI,kBAAkB,CAAC;oBAClB3B,KAAAA;oBACAC,MAAAA;gBACJ;gBAKA,OAHIE,KAAKN,CAAAA,IAAMA,EAAI+B,YAAY,CAACzB,EAAG,GAC/BC,KAAKP,CAAAA,IAAMA,EAAIgC,iBAAiB,CAACzB,EAAG,GAEjCP,EAAI4B,IAAI,CAACjB;YACpB;YACQ,MAARsB,QACIjC,GAKC;gBACD,IAAI,CAACA,GAAK,OAAO,CAAA;gBAEjB,IAAI;oBACA,IAAMkC,IAAY,AAAC,CAAA,MAAMrC,EAAUG,GAAKW,EAAG,EAAGH,OAAO;oBAErD,IAAIM,KAAa,CAACA,EAAWqB,KAAK,CAACD,IAC/B,MAAMxC,EAAsB,OAAOoB,GAAWoB,GAAK;oBAEvD,OAAOA;gBACX,EAAE,OAAOE,GAAG;oBACR,OAAO,CAAA;gBACX;YACJ;QACJ;IACJ,EAAC;AAEL,eAAepC,IAAG"}
|
package/build/index.js
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: !0
|
|
4
|
+
}), function(e, t) {
|
|
5
|
+
for(var r in t)Object.defineProperty(e, r, {
|
|
6
|
+
enumerable: !0,
|
|
7
|
+
get: t[r]
|
|
8
|
+
});
|
|
9
|
+
}(exports, {
|
|
10
|
+
jwt: ()=>i,
|
|
11
|
+
default: ()=>n
|
|
12
|
+
});
|
|
13
|
+
const e = require("elysia/src/utils"), t = require("jose"), r = require("@sinclair/typebox"), i = ({ name: i , secret: n , alg: p = 'HS256' , crit: o , schema: y , nbf: a , exp: T , ...l })=>(s)=>{
|
|
14
|
+
if (!n) throw Error("Secret can't be empty");
|
|
15
|
+
let u = new TextEncoder().encode(n), c = y ? (0, e.getSchemaValidator)(r.Type.Union([
|
|
16
|
+
y,
|
|
17
|
+
r.Type.Object({
|
|
18
|
+
iss: r.Type.Optional(r.Type.String()),
|
|
19
|
+
sub: r.Type.Optional(r.Type.String()),
|
|
20
|
+
aud: r.Type.Optional(r.Type.Union([
|
|
21
|
+
r.Type.String(),
|
|
22
|
+
r.Type.Array(r.Type.String())
|
|
23
|
+
])),
|
|
24
|
+
jti: r.Type.Optional(r.Type.String()),
|
|
25
|
+
nbf: r.Type.Optional(r.Type.Union([
|
|
26
|
+
r.Type.String(),
|
|
27
|
+
r.Type.Number()
|
|
28
|
+
])),
|
|
29
|
+
exp: r.Type.Optional(r.Type.Union([
|
|
30
|
+
r.Type.String(),
|
|
31
|
+
r.Type.Number()
|
|
32
|
+
])),
|
|
33
|
+
iat: r.Type.Optional(r.Type.String())
|
|
34
|
+
})
|
|
35
|
+
])) : void 0;
|
|
36
|
+
return s.decorate(i, {
|
|
37
|
+
sign (e) {
|
|
38
|
+
let r = new t.SignJWT({
|
|
39
|
+
...l,
|
|
40
|
+
...e,
|
|
41
|
+
nbf: void 0,
|
|
42
|
+
exp: void 0
|
|
43
|
+
}).setProtectedHeader({
|
|
44
|
+
alg: p,
|
|
45
|
+
crit: o
|
|
46
|
+
});
|
|
47
|
+
return a && (r = r.setNotBefore(a)), T && (r = r.setExpirationTime(T)), r.sign(u);
|
|
48
|
+
},
|
|
49
|
+
async verify (r) {
|
|
50
|
+
if (!r) return !1;
|
|
51
|
+
try {
|
|
52
|
+
let i = (await (0, t.jwtVerify)(r, u)).payload;
|
|
53
|
+
if (c && !c.Check(i)) throw (0, e.createValidationError)('JWT', c, i);
|
|
54
|
+
return i;
|
|
55
|
+
} catch (n) {
|
|
56
|
+
return !1;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
});
|
|
60
|
+
}, n = i;
|
|
61
|
+
|
|
62
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Elysia, Context, UnwrapSchema } from 'elysia'\nimport { createValidationError, getSchemaValidator } from 'elysia/src/utils'\n\nimport {\n SignJWT,\n jwtVerify,\n type JWTPayload,\n type JWSHeaderParameters\n} from 'jose'\n\nimport { Type as t } from '@sinclair/typebox'\nimport type { Static, TObject, TSchema } from '@sinclair/typebox'\n\nexport interface JWTPayloadSpec {\n iss?: string\n sub?: string\n aud?: string | string[]\n jti?: string\n nbf?: number\n exp?: number\n iat?: number\n}\n\nexport interface JWTOption<\n Name extends string = string,\n Schema extends TSchema | undefined = undefined\n> extends JWSHeaderParameters,\n Omit<JWTPayload, 'nbf' | 'exp'> {\n /**\n * Name to decorate method as\n *\n * ---\n * @example\n * For example, `jwt` will decorate Context with `Context.jwt`\n *\n * ```typescript\n * app\n * .decorate({\n * name: 'myJWTNamespace',\n * secret: process.env.JWT_SECRETS\n * })\n * .get('/sign/:name', ({ myJWTNamespace, params }) => {\n * return myJWTNamespace.sign(params)\n * })\n * ```\n */\n name: Name\n /**\n * JWT Secret\n */\n secret: string\n /**\n * Type strict validation for JWT payload\n */\n schema?: Schema\n\n /**\n * JWT Not Before\n *\n * @see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)\n */\n\n nbf?: string | number\n /**\n * JWT Expiration Time\n *\n * @see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)\n */\n exp?: string | number\n}\n\nexport const jwt =\n <\n Name extends string = string,\n Schema extends TSchema | undefined = undefined\n >({\n name,\n secret,\n // Start JWT Header\n alg = 'HS256',\n crit,\n schema,\n // End JWT Header\n // Start JWT Payload\n nbf,\n exp,\n ...payload\n }: // End JWT Payload\n JWTOption<Name, Schema>) =>\n (app: Elysia) => {\n if (!secret) throw new Error(\"Secret can't be empty\")\n\n const key = new TextEncoder().encode(secret)\n\n const validator = schema\n ? getSchemaValidator(\n t.Union([\n schema,\n t.Object({\n iss: t.Optional(t.String()),\n sub: t.Optional(t.String()),\n aud: t.Optional(\n t.Union([t.String(), t.Array(t.String())])\n ),\n jti: t.Optional(t.String()),\n nbf: t.Optional(t.Union([t.String(), t.Number()])),\n exp: t.Optional(t.Union([t.String(), t.Number()])),\n iat: t.Optional(t.String())\n })\n ])\n )\n : undefined\n\n return app.decorate(name, {\n sign: (\n morePayload: UnwrapSchema<Schema, Record<string, string>> &\n JWTPayloadSpec\n ) => {\n let jwt = new SignJWT({\n ...payload,\n ...morePayload,\n nbf: undefined,\n exp: undefined\n }).setProtectedHeader({\n alg,\n crit\n })\n\n if (nbf) jwt = jwt.setNotBefore(nbf)\n if (exp) jwt = jwt.setExpirationTime(exp)\n\n return jwt.sign(key)\n },\n verify: async (\n jwt?: string\n ): Promise<\n | (UnwrapSchema<Schema, Record<string, string>> &\n JWTPayloadSpec)\n | false\n > => {\n if (!jwt) return false\n\n try {\n const data: any = (await jwtVerify(jwt, key)).payload\n\n if (validator && !validator!.Check(data))\n throw createValidationError('JWT', validator, data)\n\n return data\n } catch (_) {\n return false\n }\n }\n })\n }\n\nexport default jwt\n"],"names":["jwt","name","secret","alg","crit","schema","nbf","exp","payload","app","Error","key","TextEncoder","encode","validator","getSchemaValidator","t","Union","Object","iss","Optional","String","sub","aud","Array","jti","Number","iat","undefined","decorate","sign","morePayload","SignJWT","setProtectedHeader","setNotBefore","setExpirationTime","verify","data","jwtVerify","Check","createValidationError","_"],"mappings":"AAAA;;;;;;;;;IAuEaA,GAAG,MAAHA;IAqFb,OAAkB,MAAlB;;kBA3J0D,iCAOnD,qBAEmB,sBA6DbA,IACT,CAGE,EACEC,MAAAA,EAAI,EACJC,QAAAA,EAAM,EAENC,KAAAA,IAAM,OAAO,CAAA,EACbC,MAAAA,EAAI,EACJC,QAAAA,EAAM,EAGNC,KAAAA,EAAG,EACHC,KAAAA,EAAG,EACH,GAAGC,GAEgB,GACvB,CAACC,IAAgB;QACb,IAAI,CAACP,GAAQ,MAAM,AAAIQ,MAAM,yBAAwB;QAErD,IAAMC,IAAM,IAAIC,cAAcC,MAAM,CAACX,IAE/BY,IAAYT,IACZU,IAAAA,oBAAkB,EACdC,MAAC,CAACC,KAAK,CAAC;YACJZ;YACAW,MAAC,CAACE,MAAM,CAAC;gBACLC,KAAKH,MAAC,CAACI,QAAQ,CAACJ,MAAC,CAACK,MAAM;gBACxBC,KAAKN,MAAC,CAACI,QAAQ,CAACJ,MAAC,CAACK,MAAM;gBACxBE,KAAKP,MAAC,CAACI,QAAQ,CACXJ,MAAC,CAACC,KAAK,CAAC;oBAACD,MAAC,CAACK,MAAM;oBAAIL,MAAC,CAACQ,KAAK,CAACR,MAAC,CAACK,MAAM;iBAAI;gBAE7CI,KAAKT,MAAC,CAACI,QAAQ,CAACJ,MAAC,CAACK,MAAM;gBACxBf,KAAKU,MAAC,CAACI,QAAQ,CAACJ,MAAC,CAACC,KAAK,CAAC;oBAACD,MAAC,CAACK,MAAM;oBAAIL,MAAC,CAACU,MAAM;iBAAG;gBAChDnB,KAAKS,MAAC,CAACI,QAAQ,CAACJ,MAAC,CAACC,KAAK,CAAC;oBAACD,MAAC,CAACK,MAAM;oBAAIL,MAAC,CAACU,MAAM;iBAAG;gBAChDC,KAAKX,MAAC,CAACI,QAAQ,CAACJ,MAAC,CAACK,MAAM;YAC5B;SACH,KAELO,KAAAA,CAAS;QAEf,OAAOnB,EAAIoB,QAAQ,CAAC5B,GAAM;YACtB6B,MACIC,GAEC;gBACD,IAAI/B,IAAM,IAAIgC,SAAO,CAAC;oBAClB,GAAGxB,CAAO;oBACV,GAAGuB,CAAW;oBACdzB,KAAKsB,KAAAA;oBACLrB,KAAKqB,KAAAA;gBACT,GAAGK,kBAAkB,CAAC;oBAClB9B,KAAAA;oBACAC,MAAAA;gBACJ;gBAKA,OAHIE,KAAKN,CAAAA,IAAMA,EAAIkC,YAAY,CAAC5B,EAAG,GAC/BC,KAAKP,CAAAA,IAAMA,EAAImC,iBAAiB,CAAC5B,EAAG,GAEjCP,EAAI8B,IAAI,CAACnB;YACpB;YACQ,MAARyB,QACIpC,GAKC;gBACD,IAAI,CAACA,GAAK,OAAO,CAAA;gBAEjB,IAAI;oBACA,IAAMqC,IAAY,AAAC,CAAA,MAAMC,IAAAA,WAAS,EAACtC,GAAKW,EAAG,EAAGH,OAAO;oBAErD,IAAIM,KAAa,CAACA,EAAWyB,KAAK,CAACF,IAC/B,MAAMG,IAAAA,uBAAqB,EAAC,OAAO1B,GAAWuB,GAAK;oBAEvD,OAAOA;gBACX,EAAE,OAAOI,GAAG;oBACR,OAAO,CAAA;gBACX;YACJ;QACJ;IACJ,GAEJ,IAAezC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@elysiajs/jwt",
|
|
3
|
+
"description": "Plugin for Elysia for using JWT Authentication",
|
|
4
|
+
"version": "0.0.0-experimental.0",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "saltyAom",
|
|
7
|
+
"url": "https://github.com/SaltyAom",
|
|
8
|
+
"email": "saltyaom@gmail.com"
|
|
9
|
+
},
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "https://github.com/elysiajs/elysia-jwt"
|
|
13
|
+
},
|
|
14
|
+
"main": "build/index.js",
|
|
15
|
+
"module": "build/es/index.js",
|
|
16
|
+
"esnext": "build/es/index.js",
|
|
17
|
+
"types": "src/index.ts",
|
|
18
|
+
"typings": "src/index.ts",
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"jose": "^4.11.0"
|
|
21
|
+
},
|
|
22
|
+
"devDependencies": {
|
|
23
|
+
"@elysiajs/cookie": "^0.0.0-experimental.3",
|
|
24
|
+
"@sinclair/typebox": "0.25.8",
|
|
25
|
+
"@swc/cli": "^0.1.57",
|
|
26
|
+
"@swc/core": "^1.3.11",
|
|
27
|
+
"@types/cookie": "^0.5.1",
|
|
28
|
+
"@types/cookie-signature": "^1.0.4",
|
|
29
|
+
"@types/node": "^18.11.7",
|
|
30
|
+
"bun-types": "^0.2.2",
|
|
31
|
+
"eslint": "^8.26.0",
|
|
32
|
+
"elysia": "^0.0.0-experimental.56",
|
|
33
|
+
"nodemon": "^2.0.20",
|
|
34
|
+
"typescript": "^4.8.4"
|
|
35
|
+
},
|
|
36
|
+
"peerDependencies": {
|
|
37
|
+
"elysia": "^0.0.0-experimental.56"
|
|
38
|
+
},
|
|
39
|
+
"bugs": "https://github.com/elysiajs/elysia-jwt/issues",
|
|
40
|
+
"homepage": "https://github.com/elysiajs/elysia-jwt",
|
|
41
|
+
"keywords": [
|
|
42
|
+
"kingworld",
|
|
43
|
+
"jwt",
|
|
44
|
+
"auth",
|
|
45
|
+
"authentication"
|
|
46
|
+
],
|
|
47
|
+
"license": "MIT",
|
|
48
|
+
"scripts": {
|
|
49
|
+
"dev": "nodemon --config nodemon.json",
|
|
50
|
+
"test": "bun wiptest",
|
|
51
|
+
"build": "npm run build:main && npm run build:es",
|
|
52
|
+
"build:main": "swc src --config-file .cjs.swcrc -d build",
|
|
53
|
+
"build:es": "swc src --config-file .es.swcrc -d build/es",
|
|
54
|
+
"release": "npm run build && npm run test && npm publish --access public"
|
|
55
|
+
}
|
|
56
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import type { Elysia, Context, UnwrapSchema } from 'elysia'
|
|
2
|
+
import { createValidationError, getSchemaValidator } from 'elysia/src/utils'
|
|
3
|
+
|
|
4
|
+
import {
|
|
5
|
+
SignJWT,
|
|
6
|
+
jwtVerify,
|
|
7
|
+
type JWTPayload,
|
|
8
|
+
type JWSHeaderParameters
|
|
9
|
+
} from 'jose'
|
|
10
|
+
|
|
11
|
+
import { Type as t } from '@sinclair/typebox'
|
|
12
|
+
import type { Static, TObject, TSchema } from '@sinclair/typebox'
|
|
13
|
+
|
|
14
|
+
export interface JWTPayloadSpec {
|
|
15
|
+
iss?: string
|
|
16
|
+
sub?: string
|
|
17
|
+
aud?: string | string[]
|
|
18
|
+
jti?: string
|
|
19
|
+
nbf?: number
|
|
20
|
+
exp?: number
|
|
21
|
+
iat?: number
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface JWTOption<
|
|
25
|
+
Name extends string = string,
|
|
26
|
+
Schema extends TSchema | undefined = undefined
|
|
27
|
+
> extends JWSHeaderParameters,
|
|
28
|
+
Omit<JWTPayload, 'nbf' | 'exp'> {
|
|
29
|
+
/**
|
|
30
|
+
* Name to decorate method as
|
|
31
|
+
*
|
|
32
|
+
* ---
|
|
33
|
+
* @example
|
|
34
|
+
* For example, `jwt` will decorate Context with `Context.jwt`
|
|
35
|
+
*
|
|
36
|
+
* ```typescript
|
|
37
|
+
* app
|
|
38
|
+
* .decorate({
|
|
39
|
+
* name: 'myJWTNamespace',
|
|
40
|
+
* secret: process.env.JWT_SECRETS
|
|
41
|
+
* })
|
|
42
|
+
* .get('/sign/:name', ({ myJWTNamespace, params }) => {
|
|
43
|
+
* return myJWTNamespace.sign(params)
|
|
44
|
+
* })
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
name: Name
|
|
48
|
+
/**
|
|
49
|
+
* JWT Secret
|
|
50
|
+
*/
|
|
51
|
+
secret: string
|
|
52
|
+
/**
|
|
53
|
+
* Type strict validation for JWT payload
|
|
54
|
+
*/
|
|
55
|
+
schema?: Schema
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* JWT Not Before
|
|
59
|
+
*
|
|
60
|
+
* @see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
|
|
61
|
+
*/
|
|
62
|
+
|
|
63
|
+
nbf?: string | number
|
|
64
|
+
/**
|
|
65
|
+
* JWT Expiration Time
|
|
66
|
+
*
|
|
67
|
+
* @see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
|
|
68
|
+
*/
|
|
69
|
+
exp?: string | number
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export const jwt =
|
|
73
|
+
<
|
|
74
|
+
Name extends string = string,
|
|
75
|
+
Schema extends TSchema | undefined = undefined
|
|
76
|
+
>({
|
|
77
|
+
name,
|
|
78
|
+
secret,
|
|
79
|
+
// Start JWT Header
|
|
80
|
+
alg = 'HS256',
|
|
81
|
+
crit,
|
|
82
|
+
schema,
|
|
83
|
+
// End JWT Header
|
|
84
|
+
// Start JWT Payload
|
|
85
|
+
nbf,
|
|
86
|
+
exp,
|
|
87
|
+
...payload
|
|
88
|
+
}: // End JWT Payload
|
|
89
|
+
JWTOption<Name, Schema>) =>
|
|
90
|
+
(app: Elysia) => {
|
|
91
|
+
if (!secret) throw new Error("Secret can't be empty")
|
|
92
|
+
|
|
93
|
+
const key = new TextEncoder().encode(secret)
|
|
94
|
+
|
|
95
|
+
const validator = schema
|
|
96
|
+
? getSchemaValidator(
|
|
97
|
+
t.Union([
|
|
98
|
+
schema,
|
|
99
|
+
t.Object({
|
|
100
|
+
iss: t.Optional(t.String()),
|
|
101
|
+
sub: t.Optional(t.String()),
|
|
102
|
+
aud: t.Optional(
|
|
103
|
+
t.Union([t.String(), t.Array(t.String())])
|
|
104
|
+
),
|
|
105
|
+
jti: t.Optional(t.String()),
|
|
106
|
+
nbf: t.Optional(t.Union([t.String(), t.Number()])),
|
|
107
|
+
exp: t.Optional(t.Union([t.String(), t.Number()])),
|
|
108
|
+
iat: t.Optional(t.String())
|
|
109
|
+
})
|
|
110
|
+
])
|
|
111
|
+
)
|
|
112
|
+
: undefined
|
|
113
|
+
|
|
114
|
+
return app.decorate(name, {
|
|
115
|
+
sign: (
|
|
116
|
+
morePayload: UnwrapSchema<Schema, Record<string, string>> &
|
|
117
|
+
JWTPayloadSpec
|
|
118
|
+
) => {
|
|
119
|
+
let jwt = new SignJWT({
|
|
120
|
+
...payload,
|
|
121
|
+
...morePayload,
|
|
122
|
+
nbf: undefined,
|
|
123
|
+
exp: undefined
|
|
124
|
+
}).setProtectedHeader({
|
|
125
|
+
alg,
|
|
126
|
+
crit
|
|
127
|
+
})
|
|
128
|
+
|
|
129
|
+
if (nbf) jwt = jwt.setNotBefore(nbf)
|
|
130
|
+
if (exp) jwt = jwt.setExpirationTime(exp)
|
|
131
|
+
|
|
132
|
+
return jwt.sign(key)
|
|
133
|
+
},
|
|
134
|
+
verify: async (
|
|
135
|
+
jwt?: string
|
|
136
|
+
): Promise<
|
|
137
|
+
| (UnwrapSchema<Schema, Record<string, string>> &
|
|
138
|
+
JWTPayloadSpec)
|
|
139
|
+
| false
|
|
140
|
+
> => {
|
|
141
|
+
if (!jwt) return false
|
|
142
|
+
|
|
143
|
+
try {
|
|
144
|
+
const data: any = (await jwtVerify(jwt, key)).payload
|
|
145
|
+
|
|
146
|
+
if (validator && !validator!.Check(data))
|
|
147
|
+
throw createValidationError('JWT', validator, data)
|
|
148
|
+
|
|
149
|
+
return data
|
|
150
|
+
} catch (_) {
|
|
151
|
+
return false
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
})
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export default jwt
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { Elysia, t } from 'elysia'
|
|
2
|
+
import { jwt } from '../src'
|
|
3
|
+
|
|
4
|
+
import { describe, expect, it } from 'bun:test'
|
|
5
|
+
|
|
6
|
+
const req = (path: string) => new Request(path)
|
|
7
|
+
const post = (path: string, body = {}) =>
|
|
8
|
+
new Request(path, {
|
|
9
|
+
method: 'POST',
|
|
10
|
+
headers: {
|
|
11
|
+
'Content-Type': 'application/json'
|
|
12
|
+
},
|
|
13
|
+
body: JSON.stringify(body)
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
describe('Static Plugin', () => {
|
|
17
|
+
it('sign JWT', async () => {
|
|
18
|
+
const app = new Elysia()
|
|
19
|
+
.use(
|
|
20
|
+
jwt({
|
|
21
|
+
name: 'jwt',
|
|
22
|
+
secret: 'A'
|
|
23
|
+
})
|
|
24
|
+
)
|
|
25
|
+
.post('/validate', ({ jwt, body }) => jwt.sign(body), {
|
|
26
|
+
schema: {
|
|
27
|
+
body: t.Object({
|
|
28
|
+
name: t.String()
|
|
29
|
+
})
|
|
30
|
+
}
|
|
31
|
+
})
|
|
32
|
+
.post('/validate', ({ jwt, body: { name } }) => jwt.verify(name), {
|
|
33
|
+
schema: {
|
|
34
|
+
body: t.Object({ name: t.String() })
|
|
35
|
+
}
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
const name = 'Shirokami'
|
|
39
|
+
|
|
40
|
+
const _sign = post('/sign', { name })
|
|
41
|
+
const token = await _sign.text()
|
|
42
|
+
|
|
43
|
+
const _verified = post('/verify', { name })
|
|
44
|
+
const signed = (await _verified.json()) as {
|
|
45
|
+
name: string
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
expect(name).toBe(signed.name)
|
|
49
|
+
})
|
|
50
|
+
})
|