jssign 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Sahil Aggawal, <aggarwalsahil2004@gmail.com>
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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

@@ -0,0 +1,61 @@
+# JSSign
+A better, faster, lighter and more secure alternative to [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)
+## Features
+- Encrypt data using a secret
+- Decrypt a token with secret to retrive data back
+## Installation
+To install JSSign
+```bash
+  # with npm:
+  npm install jssign --save
+
+  # with yarn:
+  yarn add jssign
+```
+## Usage
+`JSSign` exports different functions for data encryption for different use cases:
+### Faster Usage
+For a faster (but less secure) encoding and decoding of data using a secret, `JSSign` exports the following functions:
+- `sign(data, secret, options)`: returns encoded token
+- `verify(token, secret)`: returns decoded data
+```javascript
+import { sign, verify } from 'jssign'
+
+const secret = 'top-secret'
+const token = sign({ foo: 'bar' }, secret, { sl: 16 }) // no expiration
+const data = verify(token, secret)
+
+console.log(data) // { foo: 'bar' }
+```
+`data` can be an object literal, buffer or string representing valid JSON.
+
+`secret` can be a string
+
+`options`:
+- `expiresIn` can be a numeric value representing time in ms (no expiration by default).
+- `sl` can be a numberic value representing salt length (default value is `8`). Salt is a random string which is added on top of data to keep the token different everytime even for the same data.
+
+### More secure Usage
+For a more secure (but slower) encryption and decryption of data using a secret, `JSSign` exports the following functions that uses [sjcl](https://www.npmjs.com/package/sjcl) under the hood:
+- `encrypt(data, secret, options)`: return encrypted token
+- `decrypt(token, secret)`: returns decrypted data
+```javascript
+import { encrypt, decrypt } from 'jssign'
+
+const secret = 'top-secret'
+const token = encrypt({ id: 'confidential_data' }, secret, { expiresIn: 180000 }) // will expire after 30 minutes of token creation
+const data = decrypt(token, secret)
+
+console.log(data) // { id: 'confidential_data' }
+```
+`data` can be an object literal, buffer or string representing valid JSON.
+
+`secret` can be a string
+
+`options`:
+- `expiresIn` can be a numeric value representing time in ms (no expiration by default).
+## Used By
+- [CloudBreeze](https://cloudbreeze.vercel.app/)
+- [NewsDose](https://newsdoseweb.netlify.app/)
+## Author
+[Sahil Aggarwal](https://www.github.com/SahilAggarwal2004)

package/build/cjs/index.d.ts

@@ -0,0 +1,10 @@
+declare function sign(data: any, secret: string, { expiresIn, sl }?: {
+    expiresIn: number;
+    sl: number;
+}): string;
+declare function verify(token: string, secret: string): any;
+declare function encrypt(data: any, secret: string, { expiresIn }?: {
+    expiresIn: number;
+}): string;
+declare function decrypt(token: string, secret: string): any;
+export { sign, verify, encrypt, decrypt };

package/build/cjs/index.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decrypt = exports.encrypt = exports.verify = exports.sign = void 0;
+const sjcl_1 = __importDefault(require("sjcl"));
+const defaults = { v: 1, iter: 10000, ks: 128, ts: 64, mode: "ccm", adata: "", cipher: "aes" };
+const characters = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '-', '/', '*', '~', '!', '@', '#', '$', '%', '^', '&'];
+const randomNumber = (min = 0, max = Number.MAX_SAFE_INTEGER) => min + Math.floor(Math.random() * (max - min + 1));
+const randomElement = (array) => array[randomNumber(0, array.length - 1)];
+const textToChars = (text) => text.split('').map(c => c.charCodeAt(0));
+const byteHex = (n) => ("0" + Number(n).toString(16)).slice(-2);
+const stringFromCode = (code) => String.fromCharCode(code);
+function genSalt(length) {
+    let salt = randomElement(characters);
+    for (let i = 1; i < length; i++)
+        salt += randomElement(characters);
+    return salt;
+}
+function encode(data, secret) {
+    const applySecret = (code) => textToChars(secret).reduce((a, b) => a ^ b, code);
+    return data.toString().split('').map(textToChars).map(applySecret).map(byteHex).join('');
+}
+function decode(token, secret) {
+    const applySecret = (code) => textToChars(secret).reduce((a, b) => a ^ b, code);
+    return token.match(/.{1,2}/g).map((hex) => parseInt(hex, 16)).map(applySecret).map(stringFromCode).join('');
+}
+function sign(data, secret, { expiresIn = 0, sl = 8 } = { expiresIn: 0, sl: 8 }) {
+    const salt = genSalt(sl);
+    const token = encode(JSON.stringify({ data, iat: Date.now(), exp: expiresIn }), secret + salt);
+    const signature = encode(salt, secret);
+    return `${token}.${signature}`;
+}
+exports.sign = sign;
+function verify(token, secret) {
+    try {
+        const [dataStr, signature] = token.split('.');
+        const salt = decode(signature, secret);
+        const { data, iat, exp } = JSON.parse(decode(dataStr, secret + salt));
+        if (!exp || Date.now() < iat + exp)
+            return data;
+        throw new Error();
+    }
+    catch (_a) {
+        throw new Error('Invalid token or secret!');
+    }
+}
+exports.verify = verify;
+function encrypt(data, secret, { expiresIn = 0 } = { expiresIn: 0 }) {
+    const { ct, iv, salt } = JSON.parse(sjcl_1.default.encrypt(secret, JSON.stringify({ data, iat: Date.now(), exp: expiresIn })));
+    return `${ct}.${iv}.${salt}`;
+}
+exports.encrypt = encrypt;
+function decrypt(token, secret) {
+    try {
+        const [ct, iv, salt] = token.split('.');
+        token = JSON.stringify(Object.assign({ ct, iv, salt }, defaults));
+        const { data, iat, exp } = JSON.parse(sjcl_1.default.decrypt(secret, token));
+        if (!exp || Date.now() < iat + exp)
+            return data;
+        throw new Error();
+    }
+    catch (_a) {
+        throw new Error('Invalid token or secret!');
+    }
+}
+exports.decrypt = decrypt;

package/build/esm/index.d.ts

@@ -0,0 +1,10 @@
+declare function sign(data: any, secret: string, { expiresIn, sl }?: {
+    expiresIn: number;
+    sl: number;
+}): string;
+declare function verify(token: string, secret: string): any;
+declare function encrypt(data: any, secret: string, { expiresIn }?: {
+    expiresIn: number;
+}): string;
+declare function decrypt(token: string, secret: string): any;
+export { sign, verify, encrypt, decrypt };

package/build/esm/index.js

@@ -0,0 +1,59 @@
+import sjcl from 'sjcl';
+const defaults = { v: 1, iter: 10000, ks: 128, ts: 64, mode: "ccm", adata: "", cipher: "aes" };
+const characters = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '-', '/', '*', '~', '!', '@', '#', '$', '%', '^', '&'];
+const randomNumber = (min = 0, max = Number.MAX_SAFE_INTEGER) => min + Math.floor(Math.random() * (max - min + 1));
+const randomElement = (array) => array[randomNumber(0, array.length - 1)];
+const textToChars = (text) => text.split('').map(c => c.charCodeAt(0));
+const byteHex = (n) => ("0" + Number(n).toString(16)).slice(-2);
+const stringFromCode = (code) => String.fromCharCode(code);
+function genSalt(length) {
+    let salt = randomElement(characters);
+    for (let i = 1; i < length; i++)
+        salt += randomElement(characters);
+    return salt;
+}
+function encode(data, secret) {
+    const applySecret = (code) => textToChars(secret).reduce((a, b) => a ^ b, code);
+    return data.toString().split('').map(textToChars).map(applySecret).map(byteHex).join('');
+}
+function decode(token, secret) {
+    const applySecret = (code) => textToChars(secret).reduce((a, b) => a ^ b, code);
+    return token.match(/.{1,2}/g).map((hex) => parseInt(hex, 16)).map(applySecret).map(stringFromCode).join('');
+}
+function sign(data, secret, { expiresIn = 0, sl = 8 } = { expiresIn: 0, sl: 8 }) {
+    const salt = genSalt(sl);
+    const token = encode(JSON.stringify({ data, iat: Date.now(), exp: expiresIn }), secret + salt);
+    const signature = encode(salt, secret);
+    return `${token}.${signature}`;
+}
+function verify(token, secret) {
+    try {
+        const [dataStr, signature] = token.split('.');
+        const salt = decode(signature, secret);
+        const { data, iat, exp } = JSON.parse(decode(dataStr, secret + salt));
+        if (!exp || Date.now() < iat + exp)
+            return data;
+        throw new Error();
+    }
+    catch (_a) {
+        throw new Error('Invalid token or secret!');
+    }
+}
+function encrypt(data, secret, { expiresIn = 0 } = { expiresIn: 0 }) {
+    const { ct, iv, salt } = JSON.parse(sjcl.encrypt(secret, JSON.stringify({ data, iat: Date.now(), exp: expiresIn })));
+    return `${ct}.${iv}.${salt}`;
+}
+function decrypt(token, secret) {
+    try {
+        const [ct, iv, salt] = token.split('.');
+        token = JSON.stringify(Object.assign({ ct, iv, salt }, defaults));
+        const { data, iat, exp } = JSON.parse(sjcl.decrypt(secret, token));
+        if (!exp || Date.now() < iat + exp)
+            return data;
+        throw new Error();
+    }
+    catch (_a) {
+        throw new Error('Invalid token or secret!');
+    }
+}
+export { sign, verify, encrypt, decrypt };

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "jssign",
+  "version": "0.1.0",
+  "description": "A token generator library to encode and decode data using a secret key",
+  "main": "./build/cjs/index.js",
+  "module": "./build/esm/index.js",
+  "scripts": {
+    "esm": "tsc",
+    "cjs": "tsc --module commonjs --outDir build/cjs",
+    "build": "npm i && npm run esm && npm run cjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SahilAggarwal2004/jssign.git"
+  },
+  "keywords": ["jssign", "jss", "javascript", "sign", "javascriptsign", "token", "encryption", "decryption", "jsonwebtoken", "sjcl"],
+  "author": "Sahil Aggarwal",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/SahilAggarwal2004/jssign/issues"
+  },
+  "homepage": "https://github.com/SahilAggarwal2004/jssign#readme",
+  "dependencies": {
+    "sjcl": "^1.0.8"
+  },
+  "devDependencies": {
+    "@types/sjcl": "^1.0.30"
+  }
+}