encrypt-rsa 3.1.0 → 3.2.0

package/README.md

@@ -4,16 +4,16 @@
 
 ## Installation
 ```bash
-npm install node-rsa
+npm install encrypt-rsa
 // OR
-yarn add node-rsa
+yarn add encrypt-rsa
 ```
 
 ## Usage
 **Importing the Library**
 
 ```ts
-import NodeRSA from 'node-rsa';
+import NodeRSA from 'encrypt-rsa';
 ```
 
 ## Creating an Instance
@@ -174,6 +174,31 @@ const decryptedCredentials = nodeRSA.decryptStringWithRsaPrivateKey({ text: encr
 console.log('Decrypted Credentials:', decryptedCredentials);
 ```
 
+### Buffer Encryption/Decryption Methods:
+
+1. `encryptBufferWithRsaPublicKey`: Converts a buffer to Base64 and then encrypts the Base64 string.
+2. `decryptBufferWithRsaPrivateKey`: Decrypts the Base64 string and converts it back to a buffer.
+
+#### Example Usage
+```ts
+const nodeRSA = new NodeRSA();
+
+// Generate keys
+const { publicKey, privateKey } = nodeRSA.createPrivateAndPublicKeys();
+
+// Example buffer
+const buffer = Buffer.from('This is some binary data');
+
+// Encrypt the buffer
+const encryptedBuffer = nodeRSA.encryptBufferWithRsaPublicKey(buffer, publicKey);
+console.log('Encrypted Buffer:', encryptedBuffer);
+
+// Decrypt back to buffer
+const decryptedBuffer = nodeRSA.decryptBufferWithRsaPrivateKey(encryptedBuffer, privateKey);
+console.log('Decrypted Buffer:', decryptedBuffer.toString());  // should log: 'This is some binary data'
+```
+
+
 #### Digital Signatures
 
 Although not directly covered by the current implementation, RSA can also be used for creating and verifying digital signatures to ensure data integrity and authenticity.
@@ -185,7 +210,7 @@ We welcome contributions to the NodeRSA library! If you'd like to contribute, pl
 1. Fork the repository on GitHub.
 2. Clone your forked repository to your local machine.
 ```bash
-git clone https://github.com/your-username/node-rsa.git
+git clone git@github.com:miladezzat/encrypt-rsa.git
 ```
 3. Create a new branch for your feature or bugfix.
 ```bash

package/build/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { parametersOfDecrypt, parametersOfDecryptPublic, parametersOfEncrypt, parametersOfEncryptPrivate, returnCreateKeys } from './utils/types';
 declare class NodeRSA {
     private publicKey;
@@ -10,5 +11,7 @@ declare class NodeRSA {
     encrypt(args: parametersOfEncryptPrivate): string;
     decrypt(args: parametersOfDecryptPublic): string;
     createPrivateAndPublicKeys(modulusLength?: number): returnCreateKeys;
+    encryptBufferWithRsaPublicKey(buffer: Buffer, publicKey?: string): string;
+    decryptBufferWithRsaPrivateKey(encryptedText: string, privateKey?: string): Buffer;
 }
 export default NodeRSA;

package/build/index.js

@@ -47,6 +47,16 @@ var NodeRSA = /** @class */ (function () {
         if (modulusLength === void 0) { modulusLength = this.modulusLength; }
         return (0, createPrivateAndPublicKeys_1.default)(modulusLength);
     };
+    // Encrypt buffer using RSA public key (new)
+    NodeRSA.prototype.encryptBufferWithRsaPublicKey = function (buffer, publicKey) {
+        var base64String = buffer.toString(this.keyBase64);
+        return this.encryptStringWithRsaPublicKey({ text: base64String, publicKey: publicKey });
+    };
+    // Decrypt buffer using RSA private key (new)
+    NodeRSA.prototype.decryptBufferWithRsaPrivateKey = function (encryptedText, privateKey) {
+        var decryptedBase64 = this.decryptStringWithRsaPrivateKey({ text: encryptedText, privateKey: privateKey });
+        return Buffer.from(decryptedBase64, this.keyBase64);
+    };
     return NodeRSA;
 }());
 exports.default = NodeRSA;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "encrypt-rsa",
-  "version": "3.1.0",
+  "version": "3.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",
@@ -55,6 +55,7 @@
     "private key",
     "rsa",
     "node-rsa",
+    "encrypt-rsa",
     "encrypt",
     "encrypt by public key",
     "decrypt by private key",