encrypt-rsa 1.0.10 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+### 1.2.0 (2022-02-09)
+
+##### Documentation Changes
+
+*  set docs ([6f1fa5e3](https://github.com/miladezzat/encrypt-rsa/commit/6f1fa5e38e7d1ef0576a8e49501766f540715477))
+
+### 1.1.0 (2021-07-21)
+
+##### Documentation Changes
+
+*  ✏️ update docs for creating keys ([cebb2758](https://github.com/miladezzat/encrypt-rsa/commit/cebb2758ac55478d46f0ae6228a10f8f1f78b8c3))
+
+##### New Features
+
+*  🎸 add create public and private keys ([74c51131](https://github.com/miladezzat/encrypt-rsa/commit/74c51131a858ad28cdda605b479b6bd21297e730))
+
+#### 1.0.12 (2021-07-20)
+
+##### Chores
+
+*  🤖 update keywords ([b435e3ba](https://github.com/miladezzat/encrypt-rsa/commit/b435e3ba757a80dd66b95ed8a8a668952b66558e))
+
+#### 1.0.11 (2021-07-20)
+
+##### Bug Fixes
+
+*  🐛 solve docs ([8a08c44e](https://github.com/miladezzat/encrypt-rsa/commit/8a08c44e767d5dcd242b5a5806602468cb663ec1))
+
 #### 1.0.10 (2021-07-20)
 
 ##### Documentation Changes

package/README.md

@@ -2,12 +2,13 @@
 # Encrypt By RSA Algorithm
 
 [![npm version](https://badge.fury.io/js/encrypt-rsa.svg)](https://badge.fury.io/js/encrypt-rsa) 
+![https://img.shields.io/npm/dm/encrypt-rsa.svg](https://img.shields.io/npm/dm/encrypt-rsa.svg)
 
 > RSA is a public-key cryptosystem that is widely used for secure data transmission. It is also one of the oldest. The acronym RSA comes from the surnames of Ron Rivest, Adi Shamir and Leonard Adleman, who publicly described the algorithm in 1977. [Wikipedia](https://en.wikipedia.org/wiki/RSA_(cryptosystem))
 
 RSA algorithm is asymmetric cryptography algorithm. Asymmetric actually means that it works on two different keys i.e. Public Key and Private Key. As the name describes that the Public Key is given to everyone and Private key is kept private.
 
-### For more explanation about RSA Algorithm visit [https://milad-ezzat.vercel.app/rsa-encryption-algorithm](https://milad-ezzat.vercel.app/rsa-encryption-algorithm)
+### For more explanation about RSA Algorithm visit [https://milad-ezzat.vercel.app/posts/rsa-encryption-algorithm](https://milad-ezzat.vercel.app/posts/rsa-encryption-algorithm)
 
 1. [Installation](#installation)
 2. [Usage](#usage)
@@ -32,8 +33,19 @@ import NodeRSA from 'encrypt-rsa';
 
 const NodeRSA = require('encrypt-rsa').default;
 
+const fs = require('fs'); // Or import * as fs from 'fs';
+
 const nodeRSA = new NodeRSA();
 
+// create public and private keys
+
+const { privateKey, publicKey } = nodeRSA.createPrivateAndPublicKeys()
+
+// to save your keys
+fs.writeFileSync('./private-key', privateKey);
+fs.writeFileSync('./public-key', publicKey);
+
+
 // you must have 'public-key' file the key you want to encrypt by it
 
 const encryptedText = nodeRSA.encryptStringWithRsaPublicKey({ 
@@ -58,4 +70,5 @@ console.log({ decryptedText });
 // result: { decryptedText: 'hello' }
 
 ```
-for more information about RSA [https://simple.wikipedia.org/wiki/RSA_algorithm](https://simple.wikipedia.org/wiki/RSA_algorithm)
+for more information about RSA:
+[https://simple.wikipedia.org/wiki/RSA_algorithm](https://simple.wikipedia.org/wiki/RSA_algorithm)

package/build/index.d.ts

@@ -1,16 +1,14 @@
-declare type parameters = {
-    text: string;
-    keyPath: string;
-};
+import { parametersOfEncryptAndDecrypt, returnCreateKeys } from './utils/types';
 declare class NodeRSA {
     private publicKeyPath;
     private privateKeyPath;
+    private modulusLength;
     /**
      *
      * @param publicKeyPath this should be absolute path
      * @param privateKeyPath this should be absolute path
      */
-    constructor(publicKeyPath?: string, privateKeyPath?: string);
+    constructor(publicKeyPath?: string, privateKeyPath?: string, modulusLength?: number);
     /**
      *
      * @param {Object} args
@@ -19,7 +17,7 @@ declare class NodeRSA {
      *
      * @returns {String}
      */
-    encryptStringWithRsaPublicKey(args: parameters): string;
+    encryptStringWithRsaPublicKey(args: parametersOfEncryptAndDecrypt): string;
     /**
      *
      * @param {Object} args
@@ -28,6 +26,7 @@ declare class NodeRSA {
      *
      * @returns {String}
      */
-    decryptStringWithRsaPrivateKey(args: parameters): string;
+    decryptStringWithRsaPrivateKey(args: parametersOfEncryptAndDecrypt): string;
+    createPrivateAndPublicKeys(modulusLength?: number): returnCreateKeys;
 }
 export default NodeRSA;

package/build/index.js

@@ -3,17 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var crypto_1 = require("crypto");
 var fs_1 = require("fs");
 var path_1 = require("path");
+var generateKeyPairSync = require('crypto').generateKeyPairSync;
 var NodeRSA = /** @class */ (function () {
     /**
      *
      * @param publicKeyPath this should be absolute path
      * @param privateKeyPath this should be absolute path
      */
-    function NodeRSA(publicKeyPath, privateKeyPath) {
+    function NodeRSA(publicKeyPath, privateKeyPath, modulusLength) {
         if (publicKeyPath === void 0) { publicKeyPath = ''; }
         if (privateKeyPath === void 0) { privateKeyPath = ''; }
         this.publicKeyPath = publicKeyPath;
         this.privateKeyPath = privateKeyPath;
+        this.modulusLength = modulusLength || 2048;
     }
     /**
      *
@@ -47,6 +49,21 @@ var NodeRSA = /** @class */ (function () {
         var decrypted = crypto_1.privateDecrypt(privateKey, buffer);
         return decrypted.toString('utf8');
     };
+    NodeRSA.prototype.createPrivateAndPublicKeys = function (modulusLength) {
+        if (modulusLength === void 0) { modulusLength = this.modulusLength; }
+        var _a = generateKeyPairSync('rsa', {
+            modulusLength: modulusLength,
+            publicKeyEncoding: {
+                type: 'spki',
+                format: 'pem',
+            },
+            privateKeyEncoding: {
+                type: 'pkcs8',
+                format: 'pem',
+            },
+        }), privateKey = _a.privateKey, publicKey = _a.publicKey;
+        return { privateKey: privateKey, publicKey: publicKey };
+    };
     return NodeRSA;
 }());
 exports.default = NodeRSA;

package/build/utils/types.d.ts

@@ -0,0 +1,8 @@
+export declare type returnCreateKeys = {
+    privateKey: string;
+    publicKey: string;
+};
+export declare type parametersOfEncryptAndDecrypt = {
+    text: string;
+    keyPath: string;
+};

package/build/utils/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "encrypt-rsa",
-  "version": "1.0.10",
+  "version": "1.2.0",
   "description": "this is a little module use to encrypt and decrypt strings with RSA keys (public and private keys)",
   "main": "./build/index.js",
   "module": "./build/index.js",
@@ -14,7 +14,8 @@
     "depcheck": "./node_modules/.bin/depcheck",
     "prepare": "husky install",
     "build": "tsc",
-    "git-cz": "./node_modules/.bin/git-cz",
+    "commit": "./node_modules/.bin/git-cz",
+    "docs:serve": "docsify serve docs",
     "_postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
@@ -32,6 +33,7 @@
     "@typescript-eslint/parser": "^4.28.3",
     "chai": "^4.3.4",
     "commitizen": "^4.2.4",
+    "docsify-cli": "^4.4.3",
     "cz-conventional-changelog": "^3.3.0",
     "depcheck": "^1.4.2",
     "eslint": "^7.31.0",
@@ -55,7 +57,11 @@
     "node-rsa",
     "encrypt",
     "encrypt by public key",
-    "decrypt by private key"
+    "decrypt by private key",
+    "rsa encryption",
+    "node-rsa typescript",
+    "Crypto-js RSA",
+    "Javascript RSA encryption"
   ],
   "author": "Milad E. Fahmy <miladezzat.f@gmail.com> (https://milad-ezzat.vercel.app)",
   "config": {
@@ -74,5 +80,5 @@
   "bugs": {
     "url": "https://github.com/miladezzat/encrypt-rsa/issues"
   },
-  "homepage": "https://milad-ezzat.vercel.app"
+  "homepage": "https://miladezzat.github.io/encrypt-rsa/"
 }