Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
kscryp - npm Package Compare versions
Comparing version 1.0.16 to 1.0.17
| { | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "Debug", | ||
| "type": "node", | ||
| "request": "launch", | ||
| "env": { | ||
| "CI": "true" | ||
| }, | ||
| "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/jest", | ||
| "args": [ | ||
| "test", | ||
| "--runInBand", | ||
| "--no-cache" | ||
| ], | ||
| "cwd": "${workspaceRoot}", | ||
| "console": "integratedTerminal", | ||
| "internalConsoleOptions": "neverOpen" | ||
| } | ||
| ] | ||
| } | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "type": "node", | ||
| "request": "launch", | ||
| "name": "Jest single run all tests", | ||
| "program": "${workspaceRoot}/node_modules/jest-cli/bin/jest.js", | ||
| "args": ["--verbose", "-i", "--no-cache"], | ||
| "console": "integratedTerminal", | ||
| "internalConsoleOptions": "neverOpen" | ||
| }, | ||
| { | ||
| "type": "node", | ||
| "request": "launch", | ||
| "name": "Jest watch all tests", | ||
| "program": "${workspaceRoot}/node_modules/jest-cli/bin/jest.js", | ||
| "args": ["--verbose", "-i", "--no-cache", "--watchAll"], | ||
| "console": "integratedTerminal", | ||
| "internalConsoleOptions": "neverOpen" | ||
| }, | ||
| { | ||
| "type": "node", | ||
| "request": "launch", | ||
| "name": "Jest watch current file", | ||
| "program": "${workspaceFolder}/node_modules/jest-cli/bin/jest", | ||
| "args": [ | ||
| "${fileBasename}", | ||
| "--verbose", | ||
| "-i", | ||
| "--no-cache", | ||
| "--watchAll" | ||
| ], | ||
| "console": "integratedTerminal", | ||
| "internalConsoleOptions": "neverOpen" | ||
| }, | ||
| { | ||
| "type": "node", | ||
| "request": "launch", | ||
| "name": "Jest debug current file", | ||
| "program": "${workspaceRoot}/node_modules/jest/bin/jest.js", | ||
| "args": [ | ||
| "--verbose", | ||
| "-i", | ||
| "--no-cache", | ||
| "--testPathPattern", | ||
| "${fileBasename}" | ||
| ], | ||
| "console": "integratedTerminal", | ||
| "internalConsoleOptions": "neverOpen" | ||
| } | ||
| ] | ||
| } |
111
doc/jwt.md
@@ -0,53 +1,102 @@ | ||
| ## JWT | ||
| ## JWT | ||
| JWT (JSON Web Tokens) is a method for securely transmitting information between parties as a JSON object. JWT is composed of three parts: the header, the payload, and the signature. The header contains information about the type of token and the cryptographic algorithm used to secure it. The payload contains the actual information being transmitted, such as a user ID or permissions. The signature is created by encoding the header and payload with a secret key, which ensures the integrity of the token and prevents tampering. JWTs are commonly used for authentication and authorization purposes, as they allow users to securely transmit information between different systems without the need for an actual session or cookie. | ||
| ### JWT Encode | ||
| ```js | ||
| ```js | ||
| const payload = { | ||
| userId: 11111, | ||
| domain: 33333 | ||
| userId: 11111, | ||
| domain: 33333, | ||
| }; | ||
| const config = { | ||
| privateKey: "ccb0eea8a", | ||
| expiresIn: "30y" | ||
| privateKey: "ccb0eea8a", | ||
| expiresIn: "30y", | ||
| }; | ||
| const jwtEnc = KsCryp.encode(payload, "jwt", config); | ||
| console.log( | ||
| jwtEnc === 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjExMTExLCJkb21haW4iOjMzMzMzLCJpYXQiOjE2ODE5MDE5ODMsImV4cCI6MjYyODYyOTk4M30.vTVf34ZTYcCmR9Hw2AbM4nodxN2ArVVe7rVTHsoi6ng', | ||
| ) | ||
| jwtEnc === | ||
| "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjExMTExLCJkb21haW4iOjMzMzMzLCJpYXQiOjE2ODE5MDE5ODMsImV4cCI6MjYyODYyOTk4M30.vTVf34ZTYcCmR9Hw2AbM4nodxN2ArVVe7rVTHsoi6ng" | ||
| ); | ||
| ``` | ||
| ### JWT Decode | ||
| ```js | ||
| ```js | ||
| const jwtDec = KsCryp.decode(jwtEnc, "jwt", config); | ||
| console.log( | ||
| jwtDec.userId === payload.userId, | ||
| jwtDec.domain === payload.domain | ||
| ) | ||
| console.log(jwtDec.userId === payload.userId, jwtDec.domain === payload.domain); | ||
| ``` | ||
| ### JWT Decode without private Key | ||
| ```js | ||
| const jwtStr = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJuYW1lIjoidGVzdDEiLCJpYXQiOjE2OTIyOTg2OTYsImV4cCI6MTY5MjMwMDQ5Nn0.XACLhB1ggc1wvEQxt6JQBuCaP9djw7OO8e85A7L9TzM"; | ||
| ### JWT Decode without Private Key | ||
| const jwtObj = KsCryp.decode(jwtStr, "jwt", { verify: false }); | ||
| ```js | ||
| const jwtStr = | ||
| "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJuYW1lIjoidGVzdDEiLCJpYXQiOjE2OTIyOTg2OTYsImV4cCI6MTY5MjMwMDQ5Nn0.XACLhB1ggc1wvEQxt6JQBuCaP9djw7OO8e85A7L9TzM"; | ||
| console.log( | ||
| jwtObj.name === "test1" | ||
| ) | ||
| const jwtObj = KsCryp.decode(jwtStr, "jwt", { verify: false }); | ||
| console.log(jwtObj.name === "test1"); | ||
| ``` | ||
| ### JWT Decode and Verify the token | ||
| ```js | ||
| const jwtStr = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJuYW1lIjoidGVzdDEiLCJpYXQiOjE2OTIyOTg2OTYsImV4cCI6MTY5MjMwMDQ5Nn0.XACLhB1ggc1wvEQxt6JQBuCaP9djw7OO8e85A7L9TzM"; | ||
| ### JWT Decode Token | ||
| const jwtObj = KsCryp.decode(jwtStr, "jwt", { verify: false, validate: true }); | ||
| ```js | ||
| const jwtStr = | ||
| "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. eyJuYW1lIjoidGVzdDEiLCJpYXQiOjE2OTIyOTg2OTYsImV4cCI6MTY5MjMwMDQ5Nn0.XACLhB1ggc1wvEQxt6JQBuCaP9djw7OO8e85A7L9TzM"; | ||
| console.log( | ||
| jwtObj.name === "test1", | ||
| jwtObj.sts === false, | ||
| jwtObj.exp === 1692300496, | ||
| jwtObj.iat === 1692298696 | ||
| ) | ||
| ``` | ||
| const jwtObj = KsCryp.decode(jwtStr, "jwt", { verify: false, validate: true }); | ||
| console.log( | ||
| jwtObj.name === "test1", | ||
| jwtObj.sts === false, | ||
| jwtObj.exp === 1692300496, | ||
| jwtObj.iat === 1692298696 | ||
| ); | ||
| ``` | ||
| ### JWT encode/decode using a x509 certificate | ||
| To implement JWT (JSON Web Tokens) in Node.js using asymmetric encryption, allowing for sharing the public key to verify the JWT, you can use this library for creating and verifying tokens, and also for handling cryptographic operations. Here's a step-by-step guide: | ||
| ```js | ||
| (async () => { | ||
| // First, you need to generate an RSA key pair consisting of a private key (for signing JWTs) and a public key (for verifying JWTs). You can use KsCryp x509 algorithm to generate the key pair: | ||
| const cert = await KsCryp.generate("x509", { | ||
| altNameIPs: ['127.0.0.1', '55.77.55.77'], | ||
| altNameURIs: ['http://localhost', 'https://test.com'], | ||
| validityDays: 300, | ||
| length: 2048, | ||
| data: { | ||
| commonName: 'my.test.com', | ||
| stateOrProvinceName: 'Barcelona', | ||
| countryName: 'ES', | ||
| localityName: 'Barcelona', | ||
| organizationName: 'Aircraft', | ||
| organizationNameShort: 'TesTas' | ||
| } | ||
| }); | ||
| // use the in memory private key to encode | ||
| const enc = KsCryp.encode(payload, "jwt", { | ||
| expiresIn: "30y", | ||
| algorithm: 'RS256', | ||
| privateKey: cert.privateKey, | ||
| }); | ||
| // use the in memory public key to decode | ||
| const dec = KsCryp.decode(enc, "jwt", { | ||
| algorithm: ['RS256'], | ||
| privateKey: cert.publicKey | ||
| }); | ||
| console.log( | ||
| typeof enc === "string", | ||
| typeof dec === "object", | ||
| cert.publicKey !== cert.privateKey, | ||
| dec.userId === payload.userId | ||
| ) | ||
| })() | ||
| ``` | ||
| ### JWT Supported algorithms | ||
| Array of supported algorithms. The following algorithms [are currently supported](https://www.npmjs.com/package/jsonwebtoken#algorithms-supported). |
| { | ||
| "name": "kscryp", | ||
| "version": "1.0.16", | ||
| "version": "1.0.17", | ||
| "description": "Cryptography package with support for: JWT, RSA, MD5, SHA, Base64, HEX, JSON, Basic", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -6,2 +6,3 @@ const KsDriver = require("../KsDriver"); | ||
| encode(data, options) { | ||
| options = options || {}; | ||
| try { | ||
@@ -11,2 +12,4 @@ const jwt = require('jsonwebtoken'); | ||
| return jwt.sign(data, options?.privateKey || "!ksike!", { | ||
| ...options?.extra, | ||
| algorithm: options?.algorithm || 'HS256', | ||
| expiresIn: options?.expiresIn || 60 * 60 | ||
@@ -17,2 +20,3 @@ }); | ||
| this.lib?.log && this.lib.log({ src: "kscryp:JWT:encode", data, error }); | ||
| options.error = error; | ||
| return null; | ||
@@ -23,2 +27,3 @@ } | ||
| decode(data, options) { | ||
| options = options || {}; | ||
| try { | ||
@@ -34,6 +39,10 @@ if (options?.verify === false) { | ||
| const jwt = require('jsonwebtoken'); | ||
| return jwt.verify(data, options?.privateKey || "!ksike!", options?.callback); | ||
| return jwt.verify(data, options?.privateKey || "!ksike!", { | ||
| ...options?.extra, | ||
| algorithm: options?.algorithm || ['HS256'] | ||
| }, options?.callback); | ||
| } | ||
| catch (error) { | ||
| this.lib?.log && this.lib.log({ src: "kscryp:JWT:encode", data, error }); | ||
| options.error = error; | ||
| return null; | ||
@@ -49,3 +58,4 @@ } | ||
| unpack(data) { | ||
| unpack(data, options) { | ||
| options = options || {}; | ||
| try { | ||
@@ -64,2 +74,3 @@ if (!data) { | ||
| this.lib?.log && this.lib.log({ src: "kscryp:JWT:encode", data, error }); | ||
| options.error = error; | ||
| return null; | ||
@@ -66,0 +77,0 @@ } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by8.78%
77706
- Number of package files
- increased by2.44%
42
- Lines of code
- increased by10.75%
1391
No dependency changes