@meebon/meebon-crypto 1.0.0 → 1.1.0

package/README.md

@@ -2,8 +2,6 @@
 
 ## install package
 
-
 ```bash
-npm i -g @meebon/meebon_package_template
+npm i @meebon/meebon-crypto
 ```
-

package/dist/ExpressEncryptionMiddleware.d.ts

@@ -0,0 +1,8 @@
+import { Request, Response, NextFunction } from 'express';
+import { MeebonCryptoKeyPair } from '../types/global';
+/**
+ * Middleware Function for Encryption and Decryption
+ */
+declare const encryptionMiddleware: ({ privateKey, publicKey, }: MeebonCryptoKeyPair) => (req: Request, res: Response, next: NextFunction) => Response<any, Record<string, any>> | undefined;
+export default encryptionMiddleware;
+//# sourceMappingURL=ExpressEncryptionMiddleware.d.ts.map

package/dist/ExpressEncryptionMiddleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressEncryptionMiddleware.d.ts","sourceRoot":"","sources":["../lib/ExpressEncryptionMiddleware.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD;;GAEG;AACH,QAAA,MAAM,oBAAoB,+BAAgC,mBAAmB,WAC9D,OAAO,OAAO,QAAQ,QAAQ,YAAY,mDAyBxD,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/MeebonCrypto.d.ts

@@ -1,5 +1,5 @@
 import forge from 'node-forge';
-import { MeebonCryptoProps } from '../types/global';
+import { MeebonCryptoKeyPair, MeebonCryptoProps } from '../types/global';
 export declare class MeebonCrypto {
     protected privateKeyPem: string;
     protected publicKeyPem: string;
@@ -7,8 +7,46 @@ export declare class MeebonCrypto {
     publicKey: forge.pki.rsa.PublicKey;
     protected schema: forge.pki.rsa.EncryptionScheme;
     private constructor();
-    static init({ privateKeyPem, publicKeyPem, schema }: MeebonCryptoProps): MeebonCrypto;
-    encrypt(planeText: string): string;
+    /**
+     * Initializes a new instance of MeebonCrypto.
+     * @param props - The crypto properties including keys and optional encryption scheme.
+     * @returns {MeebonCrypto} The initialized MeebonCrypto instance.
+     */
+    static init(props: MeebonCryptoProps): MeebonCrypto;
+    /**
+     * Encrypts data using the instance's public key.
+     * @param {string} plainText - The data to encrypt.
+     * @returns {string} The Base64-encoded encrypted data.
+     */
+    encrypt(plainText: string): string;
+    /**
+     * Decrypts data using the instance's private key.
+     * @param {string} encryptedData - The Base64-encoded encrypted data.
+     * @returns {string} The decrypted data.
+     */
     decrypt(encryptedData: string): string;
+    /**
+     * Generates an RSA key pair with the specified key size.
+     *
+     * @param {number} [length=3072] - The length of the RSA key in bits (defaults to 3072).
+     * @returns {MeebonCryptoKeyPair} An object containing the generated public and private keys in PEM format.
+     */
+    static generateKeyPair(length?: number): MeebonCryptoKeyPair;
+    /**
+     * Encrypts data with a provided public key.
+     * @param {string} data - The data to encrypt.
+     * @param {string} publicKey - The public key in PEM format.
+     * @param {string} [scheme='RSA-OAEP'] - The encryption scheme to use (defaults to 'RSA-OAEP').
+     * @returns {string} The Base64-encoded encrypted data.
+     */
+    static encryptData(data: string, publicKey: string, scheme?: forge.pki.rsa.EncryptionScheme): string;
+    /**
+     * Decrypts data with a provided private key.
+     * @param {string} encryptedData - The Base64-encoded encrypted data.
+     * @param {string} privateKey - The private key in PEM format.
+     * @param {string} [scheme='RSA-OAEP'] - The decryption scheme to use (defaults to 'RSA-OAEP').
+     * @returns {string} The decrypted data.
+     */
+    static decryptData(encryptedData: string, privateKey: string, scheme?: forge.pki.rsa.EncryptionScheme): string;
 }
 //# sourceMappingURL=MeebonCrypto.d.ts.map

package/dist/MeebonCrypto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MeebonCrypto.d.ts","sourceRoot":"","sources":["../lib/MeebonCrypto.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAIpD,qBAAa,YAAY;IACrB,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;IACrC,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC;IAE1C,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAEjD,OAAO;WASO,IAAI,CAAC,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,GAAG,YAAY;IAIrF,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAKlC,OAAO,CAAC,aAAa,EAAE,MAAM;CAMvC"}
+{"version":3,"file":"MeebonCrypto.d.ts","sourceRoot":"","sources":["../lib/MeebonCrypto.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzE,qBAAa,YAAY;IACvB,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;IACrC,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC;IAE1C,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAEjD,OAAO;IASP;;;;OAIG;WACW,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY;IAI1D;;;;OAIG;IACI,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAKzC;;;;OAIG;IACI,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAK7C;;;;;OAKG;WACW,eAAe,CAAC,MAAM,GAAE,MAAa,GAAG,mBAAmB;IAQzE;;;;;;OAMG;WACW,WAAW,CACvB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,gBAA6B,GAClD,MAAM;IAMT;;;;;;OAMG;WACW,WAAW,CACvB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,gBAA6B,GAClD,MAAM;CAKV"}

package/dist/index.js

@@ -13,17 +13,68 @@ var MeebonCrypto = class _MeebonCrypto {
     this.publicKey = forge.pki.publicKeyFromPem(publicKeyPem);
     this.schema = schema ?? "RSAES-PKCS1-V1_5";
   }
-  static init({ privateKeyPem, publicKeyPem, schema }) {
-    return new _MeebonCrypto({ privateKeyPem, publicKeyPem, schema });
+  /**
+   * Initializes a new instance of MeebonCrypto.
+   * @param props - The crypto properties including keys and optional encryption scheme.
+   * @returns {MeebonCrypto} The initialized MeebonCrypto instance.
+   */
+  static init(props) {
+    return new _MeebonCrypto(props);
   }
-  encrypt(planeText) {
-    const encrypted = this.publicKey.encrypt(planeText, this.schema);
-    return forge.util.encode64(encrypted);
+  /**
+   * Encrypts data using the instance's public key.
+   * @param {string} plainText - The data to encrypt.
+   * @returns {string} The Base64-encoded encrypted data.
+   */
+  encrypt(plainText) {
+    const encryptedBytes = this.publicKey.encrypt(plainText, this.schema);
+    return forge.util.encode64(encryptedBytes);
   }
+  /**
+   * Decrypts data using the instance's private key.
+   * @param {string} encryptedData - The Base64-encoded encrypted data.
+   * @returns {string} The decrypted data.
+   */
   decrypt(encryptedData) {
     const encryptedBytes = forge.util.decode64(encryptedData);
-    const decrypted = this.privateKey.decrypt(encryptedBytes, this.schema);
-    return decrypted;
+    return this.privateKey.decrypt(encryptedBytes, this.schema);
+  }
+  /**
+   * Generates an RSA key pair with the specified key size.
+   *
+   * @param {number} [length=3072] - The length of the RSA key in bits (defaults to 3072).
+   * @returns {MeebonCryptoKeyPair} An object containing the generated public and private keys in PEM format.
+   */
+  static generateKeyPair(length = 3072) {
+    const keyPair = forge.pki.rsa.generateKeyPair({ bits: length, e: 65537 });
+    return {
+      publicKey: forge.pki.publicKeyToPem(keyPair.publicKey),
+      privateKey: forge.pki.privateKeyToPem(keyPair.privateKey)
+    };
+  }
+  /**
+   * Encrypts data with a provided public key.
+   * @param {string} data - The data to encrypt.
+   * @param {string} publicKey - The public key in PEM format.
+   * @param {string} [scheme='RSA-OAEP'] - The encryption scheme to use (defaults to 'RSA-OAEP').
+   * @returns {string} The Base64-encoded encrypted data.
+   */
+  static encryptData(data, publicKey, scheme = "RSA-OAEP") {
+    const publicKeyObj = forge.pki.publicKeyFromPem(publicKey);
+    const encryptedBytes = publicKeyObj.encrypt(data, scheme);
+    return forge.util.encode64(encryptedBytes);
+  }
+  /**
+   * Decrypts data with a provided private key.
+   * @param {string} encryptedData - The Base64-encoded encrypted data.
+   * @param {string} privateKey - The private key in PEM format.
+   * @param {string} [scheme='RSA-OAEP'] - The decryption scheme to use (defaults to 'RSA-OAEP').
+   * @returns {string} The decrypted data.
+   */
+  static decryptData(encryptedData, privateKey, scheme = "RSA-OAEP") {
+    const privateKeyObj = forge.pki.privateKeyFromPem(privateKey);
+    const decodedBytes = forge.util.decode64(encryptedData);
+    return privateKeyObj.decrypt(decodedBytes, scheme);
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meebon/meebon-crypto",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "",
   "author": "kajalanS <103587022+kajalanS@users.noreply.github.com>",
   "homepage": "https://github.com/KsoftmHub/meebon-crypto?tab=readme-ov-file#getting-started",
@@ -45,6 +45,7 @@
   "devDependencies": {
     "@eslint/js": "^9.18.0",
     "@jest/globals": "^29.7.0",
+    "@types/express": "^5.0.0",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.10.5",
     "@types/node-forge": "^1.3.11",

package/types/global.d.ts

@@ -4,4 +4,9 @@ export interface MeebonCryptoProps {
     privateKeyPem: string;
     publicKeyPem: string;
     schema?: pki.rsa.EncryptionScheme;
+}
+
+export interface MeebonCryptoKeyPair {
+    privateKey: string;
+    publicKey: string;
 }

package/dist/types/global.d.ts

@@ -1,7 +0,0 @@
-import { pki } from "node-forge";
-
-export interface MeebonCryptoProps {
-    privateKeyPem: string;
-    publicKeyPem: string;
-    schema?: pki.rsa.EncryptionScheme;
-}