@edirect/encrypt-modules 11.0.50 → 11.0.51

package/dist/README.md

@@ -1,34 +1,149 @@
 # @edirect/encrypt-modules
 
-Encryption utilities and modules for Edirect applications. Provides services and helpers for encrypting and decrypting data, including support for PGP and other algorithms.
+Encryption utilities for eDirect NestJS applications. Provides four NestJS modules for different encryption algorithms: **PGP**, **Binary PGP**, **AES-256**, and **RSA** — plus a **ZIP** module for password-protected archive creation.
 
 ## Features
 
-- PGP encryption and decryption helpers
-- Utilities for secure data handling
-- Integrates with NestJS and other Edirect modules
+- **PGP** encryption/decryption using OpenPGP.js (`openpgp`)
+- **Binary PGP** for binary data encryption
+- **AES-256-CBC** (and other AES variants) using Node.js native `crypto`
+- **RSA** encryption/decryption using `node-rsa`
+- **ZIP** password-protected archive creation
+- NestJS module integration for each encryption type
 
 ## Installation
 
-```bash
+```sh
+pnpm add @edirect/encrypt-modules
+# or
 npm install @edirect/encrypt-modules
 ```
 
-## Usage
+## Available Modules
 
-Import and use the encryption services in your application:
+### PGP Encryption (`PgpEncryptModule`)
 
-```typescript
+Asymmetric encryption using OpenPGP keys:
+
+```ts
+import { Module } from '@nestjs/common';
+import { PgpEncryptModule } from '@edirect/encrypt-modules';
+
+@Module({
+  imports: [PgpEncryptModule],
+})
+export class AppModule {}
+```
+
+```ts
+import { Injectable } from '@nestjs/common';
 import { PgpEncryptService } from '@edirect/encrypt-modules';
 
-const encrypted = await PgpEncryptService.encrypt(data, publicKey);
-const decrypted = await PgpEncryptService.decrypt(
+@Injectable()
+export class SecureDataService {
+  constructor(private readonly pgp: PgpEncryptService) {}
+
+  async encryptPayload(data: string, publicKey: string): Promise<string> {
+    return this.pgp.encrypt(publicKey, data);
+  }
+
+  async decryptPayload(
+    encryptedData: string,
+    privateKey: string,
+    passphrase?: string
+  ): Promise<string> {
+    return this.pgp.decrypt(privateKey, encryptedData, passphrase);
+  }
+}
+```
+
+**`PgpEncryptService` API:**
+
+| Method    | Signature                                                                       | Description                          |
+| --------- | ------------------------------------------------------------------------------- | ------------------------------------ |
+| `encrypt` | `(pgpKey: string, dataToEncrypt: string): Promise<string>`                      | Encrypt data using a PGP public key  |
+| `decrypt` | `(pgpKey: string, encryptedData: string, passphrase?: string): Promise<string>` | Decrypt data using a PGP private key |
+
+### AES Encryption (`AesEncryptModule`)
+
+Symmetric encryption using Node.js `crypto`:
+
+```ts
+import { AesEncryptModule } from '@edirect/encrypt-modules';
+
+@Module({ imports: [AesEncryptModule] })
+export class AppModule {}
+```
+
+```ts
+import { AesEncryptService } from '@edirect/encrypt-modules';
+
+// Default: AES-256-CBC
+const encrypted = aesService.encrypt(
+  'secret data',
+  'my-32-char-passphrase-here!!!!!'
+);
+const decrypted = aesService.decrypt(
   encrypted,
-  privateKey,
-  passphrase
+  'my-32-char-passphrase-here!!!!!'
 );
+
+// With custom IV and encoding
+const encrypted2 = aesService.encrypt('data', passphrase, {
+  iv: customIv,
+  encryptionMethod: 'aes-256-cbc',
+  outputEncoding: 'base64',
+});
 ```
 
-## Environment Variables
+**`AesEncryptService` API:**
+
+| Method    | Signature                                                                                             | Description                |
+| --------- | ----------------------------------------------------------------------------------------------------- | -------------------------- |
+| `encrypt` | `(message: string, passphrase: CipherKey, options?: IaesEncryptOptionalParameters): string`           | Synchronous AES encryption |
+| `decrypt` | `(encryptedMessage: string, passphrase: BinaryLike, options?: IaesDecryptOptionalParameters): string` | Synchronous AES decryption |
+
+### RSA Encryption (`RsaEncryptModule`)
+
+Asymmetric encryption using `node-rsa`:
+
+```ts
+import { RsaEncryptModule } from '@edirect/encrypt-modules';
+
+@Module({ imports: [RsaEncryptModule] })
+export class AppModule {}
+```
+
+```ts
+import { RsaEncryptService } from '@edirect/encrypt-modules';
+
+const encrypted = rsaService.encrypt(data, 512, 'utf8');
+const decrypted = rsaService.decrypt(encrypted, privateKey, 'utf8');
+```
+
+### ZIP with Password (`ZipEncryptModule`)
+
+Create password-protected ZIP archives:
+
+```ts
+import { ZipEncryptModule } from '@edirect/encrypt-modules';
+
+@Module({ imports: [ZipEncryptModule] })
+export class AppModule {}
+```
+
+## AES Optional Parameters
+
+| Option             | Type               | Default         | Description                        |
+| ------------------ | ------------------ | --------------- | ---------------------------------- |
+| `iv`               | `BinaryLike`       | Random          | Initialization vector              |
+| `encryptionMethod` | `string`           | `'aes-256-cbc'` | Cipher algorithm                   |
+| `inputEncoding`    | `Encoding`         | `'utf8'`        | Input data encoding                |
+| `outputEncoding`   | `Encoding`         | `'hex'`         | Output encoding for encrypted data |
+| `options`          | `TransformOptions` | —               | Additional stream options          |
+
+## Security Notes
 
-This package does not require environment variables by default, but you may provide keys or secrets via environment variables as needed for your encryption setup.
+- Never hardcode encryption keys in source code. Use environment variables.
+- For PGP keys, store them in secure secret management (e.g., Kubernetes Secrets, AWS Secrets Manager).
+- AES keys must be exactly 32 bytes for AES-256. Use a key derivation function (KDF) if your passphrase is shorter.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/encrypt-modules",
-  "version": "11.0.46",
+  "version": "11.0.51",
   "description": "Encrypt Modules",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
@@ -17,7 +17,7 @@
     "dist"
   ],
   "dependencies": {
-    "@nestjs/common": "^11.1.12",
+    "@nestjs/common": "^11.1.17",
     "archiver": "7.0.1",
     "archiver-zip-encrypted": "^2.0.0",
     "node-rsa": "1.1.1",
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "@types/archiver": "^7.0.0",
-    "@types/node": "^25.0.10",
+    "@types/node": "^25.4.0",
     "@types/node-rsa": "^1.1.4",
     "@types/stream-buffers": "^3.0.8"
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/encrypt-modules",
-  "version": "11.0.50",
+  "version": "11.0.51",
   "description": "Encrypt Modules",
   "packageScope": "@edirect",
   "main": "./dist/src/index.js",
@@ -18,7 +18,7 @@
     "dist"
   ],
   "dependencies": {
-    "@nestjs/common": "^11.1.16",
+    "@nestjs/common": "^11.1.17",
     "archiver": "7.0.1",
     "archiver-zip-encrypted": "^2.0.0",
     "node-rsa": "1.1.1",
@@ -50,4 +50,4 @@
       }
     }
   }
-}
+}