https://github.com/z3ntl3/next-jwt
NPM library to manage & validate encrypted JSON Web Tokens within simplicity
https://github.com/z3ntl3/next-jwt
api encryption json jwt npm reference token web
Last synced: about 2 months ago
JSON representation
NPM library to manage & validate encrypted JSON Web Tokens within simplicity
- Host: GitHub
- URL: https://github.com/z3ntl3/next-jwt
- Owner: Z3NTL3
- License: gpl-3.0
- Created: 2022-12-13T11:41:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-08T12:34:53.000Z (over 3 years ago)
- Last Synced: 2025-04-02T20:05:19.153Z (about 1 year ago)
- Topics: api, encryption, json, jwt, npm, reference, token, web
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/nextjwt
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# next-jwt
NPM library to manage & validate encrypted JSON Web Tokens within simplicity
**Built on top of:** ``jose`` package.
##### API INFO
Public Key needs to be in ``PKCS8``
Private Key needs to be in ``SPKI``
**Used Algorithm:** ``RSA``
**Encryption:** ``A256GCM``
**Hash:** ``SHA512``
#### Supports
- Custom JWT Claims Object
- Issuer
- Audience
- Expiration TimeStamp
- Issued at timestamp
- Encryption
# Example
```js
const { JWT } = require('nextjwt')
const { readFileSync } = require('node:fs')
async function test(){
let jwt = new JWT(
readFileSync('test/pub.pem','utf-8'),
readFileSync('test/priv.pem','utf-8')
)
await jwt.loadKey();
let jwtToken = await jwt.genToken({ uid: 1, name: "efdal" },2,'h','Pix4','api-access');
console.log("Enc Token:\n", jwtToken);
console.log(); // seperator line
let decrypted = await jwt.decrypt(jwtToken);
console.log("Decrypted:\n", decrypted);
}test()
```
### API
```js
/*
* Programmed by Z3NTL3 (Efdal) GNU license see LICENSE file
*/
import jose = require("jose");
interface Keys {
priv: jose.KeyLike;
pub: jose.KeyLike;
}
interface User {
uid: number;
name: string;
}
type validID = "h" | "m" | "s"
class JWT {
pub: any;
priv: any;
secret: any;
/**
* @author Z3NTL3 (Efdal)
* @param publicKey Public Key as String
* @param privateKey Private key as String
*/
constructor(publicKey: string, privateKey: string) {
this.pub = publicKey;
this.priv = privateKey;
}
/**
* @author Z3NTL3 (Efdal)
* @description Initialization part
*/
loadKey(): Promise {
return new Promise(async (resolve) => {
this.secret = await jose.generateSecret("HS512");
let privK = await jose.importPKCS8(String(this.priv), "HS512");
let pubK = await jose.importSPKI(String(this.pub), "HS512");
this.priv = privK;
this.pub = pubK;
return resolve({ priv: privK, pub: pubK });
});
}
/**
* @author Z3NTL3 (Efdal)
* @description Encrypted JWT token
*/
genToken(claims: User, expiration: Number, expUnit: validID, issuer: string, audience: string): Promise {
return new Promise(async (resolve) => {
const jwt = await new jose.EncryptJWT({ claims })
.setProtectedHeader({ alg: "RSA1_5", enc: "A256GCM" })
.setIssuedAt()
.setIssuer(issuer)
.setAudience(audience)
.setExpirationTime(`${expiration}${expUnit}`)
.encrypt(this.priv, this.secret);
return resolve(jwt);
});
}
/**
* @author Z3NTL3 (Efdal)
* @param token JWT token
* @returns Decrypted JWT results
*/
decrypt(token: string): Promise {
return new Promise(async (resolve) => {
const jwt = await jose.jwtDecrypt(token, this.priv, this.secret);
return resolve(jwt);
});
}
}
export { JWT };
```
# NPM Lib
``npm i nextjwt``