@alessiofrittoli/crypto-cipher 3.0.0-alpha.3 → 3.0.0

package/dist/{index-B9WIVWrs.d.mts → index-DWiR3kkc.d.mts}

@@ -41,6 +41,7 @@ declare namespace Cph {
         /** The Additional Authentication Data. */
         aad?: Uint8Array;
     }
+    /** The RSA Private Key. */
     type PrivateKey = KeyLike | {
         key: KeyLike;
         passphrase?: string;
@@ -137,19 +138,36 @@ declare class Cipher {
         readonly max: 128;
         readonly default: 32;
     };
+    /**
+     * Cipher algorithm name.
+     *
+     */
     static readonly ALGORITHM: {
+        /** AES 128 bit Cipher Block Chaining. */
         readonly AES_128_CBC: "aes-128-cbc";
+        /** AES 192 bit Cipher Block Chaining. */
         readonly AES_192_CBC: "aes-192-cbc";
+        /** AES 256 bit Cipher Block Chaining. */
         readonly AES_256_CBC: "aes-256-cbc";
+        /** AES 128 bit AEAD Counter with CBC-MAC. */
         readonly AES_128_CCM: "aes-128-ccm";
+        /** AES 192 bit AEAD Counter with CBC-MAC. */
         readonly AES_192_CCM: "aes-192-ccm";
+        /** AES 256 bit AEAD Counter with CBC-MAC. */
         readonly AES_256_CCM: "aes-256-ccm";
+        /** AES 128 bit AEAD Galois/Counter Mode. */
         readonly AES_128_GCM: "aes-128-gcm";
+        /** AES 192 bit AEAD Galois/Counter Mode. */
         readonly AES_192_GCM: "aes-192-gcm";
+        /** AES 256 bit AEAD Galois/Counter Mode. */
         readonly AES_256_GCM: "aes-256-gcm";
+        /** AES 128 bit AEAD Offset Codebook Mode. */
         readonly AES_128_OCB: "aes-128-ocb";
+        /** AES 192 bit AEAD Offset Codebook Mode. */
         readonly AES_192_OCB: "aes-192-ocb";
+        /** AES 256 bit AEAD Offset Codebook Mode. */
         readonly AES_256_OCB: "aes-256-ocb";
+        /** AES 256 bit AEAD. */
         readonly CHACHA_20_POLY: "chacha20-poly1305";
     };
     /**
@@ -168,49 +186,49 @@ declare class Cipher {
     /**
      * Encrypt in-memory data buffer.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.StreamEncrypt()} or {@link Cipher.HybridStreamEncrypt()} methods for large data encryption.
+     * ⚠️ This is not suitable for large data encryption. Use {@link Cipher.stream.Encrypt()} or {@link Cipher.stream.HybridEncrypt()} methods for large data encryption.
      *
      * @param	data	The data to encrypt.
      * @param	secret	The secret key used to encrypt the `data`.
-     * @param	options	( Optional ) Additional options.
+     * @param	options	(Optional) Additional options.
      * @returns	The encrypted result Buffer.
      */
     static Encrypt(data: CoerceToUint8ArrayInput, secret: CoerceToUint8ArrayInput, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Decrypt in-memory data buffer.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.StreamDecrypt()} or {@link Cipher.HybridStreamDecrypt()} methods for large data decryption.
+     * ⚠️ This is not suitable for large data decryption. Use {@link Cipher.stream.Decrypt()} or {@link Cipher.stream.HybridDecrypt()} methods for large data decryption.
      *
      * @param	data	The data to decrypt.
      * @param	secret	The secret key used to decrypt the `data`.
-     * @param	options	( Optional ) Additional options. Must be the same used while encrypting data.
+     * @param	options	(Optional) Additional options. Must be the same used while encrypting data.
      * @returns	The decrypted data Buffer.
      */
     static Decrypt(data: CoerceToUint8ArrayInput, secret: CoerceToUint8ArrayInput, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Encrypt in-memory data using hybrid encryption.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.HybridStreamEncrypt()} method for large data encryption.
+     * ⚠️ This is not suitable for large data encryption. Use {@link Cipher.stream.HybridEncrypt()} method for large data encryption.
      *
-     * @param	data		The data to encrypt.
-     * @param	publicKey	The public key.
-     * @param	options		( Optional ) Additional options.
+     * @param	data	The data to encrypt.
+     * @param	key		The RSA Public Key.
+     * @param	options	(Optional) Additional options.
      *
      * @returns	The encrypted result Buffer.
      */
-    static HybridEncrypt(data: CoerceToUint8ArrayInput, publicKey: crypto.KeyLike, options?: Cph.Options): Buffer<ArrayBuffer>;
+    static HybridEncrypt(data: CoerceToUint8ArrayInput, key: crypto.KeyLike, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Decrypt in-memory data using hybrid decryption.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.stream.HybridDecrypt()} method for large data encryption.
+     * ⚠️ This is not suitable for large data decryption. Use {@link Cipher.stream.HybridDecrypt()} method for large data decryption.
      *
-     * @param	data		The encrypted data to decrypt.
-     * @param	privateKey	The private key.
-     * @param	options		( Optional ) Additional options.
+     * @param	data	The encrypted data to decrypt.
+     * @param	key		The RSA Private Key.
+     * @param	options	(Optional) Additional options.
      *
      * @returns	The encrypted result Buffer.
      */
-    static HybridDecrypt(data: CoerceToUint8ArrayInput, privateKey: Cph.PrivateKey, options?: Cph.Options): Buffer<ArrayBuffer>;
+    static HybridDecrypt(data: CoerceToUint8ArrayInput, key: Cph.PrivateKey, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Cipher stream based functions.
      *
@@ -237,21 +255,21 @@ declare class Cipher {
         /**
          * Encrypt stream data using hybrid encryption.
          *
-         * @param	publicKey	The public key.
-         * @param	options		An object defining required options. See {@link Cph.Stream.EncryptOptions} for more info.
+         * @param	key		The RSA Public Key.
+         * @param	options	An object defining required options. See {@link Cph.Stream.EncryptOptions} for more info.
          *
          * @returns	A new Promise that resolves `void` once stream encryption is completed.
          */
-        HybridEncrypt(publicKey: crypto.KeyLike, options: Cph.Stream.EncryptOptions): Promise<void>;
+        HybridEncrypt(key: crypto.KeyLike, options: Cph.Stream.EncryptOptions): Promise<void>;
         /**
          * Decrypt stream data using hybrid decryption.
          *
-         * @param	privateKey	The private key.
-         * @param	options		An object defining required options. See {@link Cph.Stream.DecryptOptions} for more info.
+         * @param	key		The private key.
+         * @param	options	An object defining required options. See {@link Cph.Stream.DecryptOptions} for more info.
          *
          * @returns	A new Promise that resolves `void` once stream decryption is completed.
          */
-        HybridDecrypt(privateKey: Cph.PrivateKey, options: Cph.Stream.DecryptOptions): Promise<void>;
+        HybridDecrypt(key: Cph.PrivateKey, options: Cph.Stream.DecryptOptions): Promise<void>;
         /**
          * Handle pipe flow to encrypt a Stream.
          *
@@ -283,17 +301,11 @@ declare class Cipher {
      *
      * @returns An object with the generated `Key`, `IV`, `salt` and resolved `options`.
      */
-    static NewKeyIV<T extends Cph.ResolvedOptions = Cph.ResolvedOptions>(options?: Cph.NewKeyIVOptions): {
-        options: T;
-        Key: NonSharedBuffer;
-        IV: NonSharedBuffer;
-        AAD: Uint8Array<ArrayBufferLike> | NonSharedBuffer;
-        salt: NonSharedBuffer;
-    };
+    private static NewKeyIV;
     /**
      * Resolves the given `options` with `Cipher` defaults and constraints.
      *
-     * @param options ( Optional ) Additional options.
+     * @param options (Optional) Additional options.
      * @returns The given `options` with `Cipher` defaults and constraints.
      */
     private static ResolveOptions;
@@ -301,29 +313,17 @@ declare class Cipher {
      * Get the Initialization Vector length based on the given algorithm.
      *
      * @param	algorithm The algorithm in use.
-     * @param	options ( Optional ) Additional options.
+     * @param	options (Optional) Additional options.
      * @returns	The Initialization Vector length based on the given algorithm
      */
-    static GetIVLength(algorithm?: Cph.Options['algorithm'], options?: Cph.Options): number;
+    private static GetIVLength;
     /**
      * Ensure correct key length based on the given algorithm.
      *
      * @param	algorithm The AES algorithm name.
      * @returns	An object with validated `algorithm` and `keyLength`.
      */
-    static GetKeyLength(algorithm?: Cph.Options['algorithm']): {
-        readonly algorithm: "chacha20-poly1305";
-        readonly keyLength: number;
-    } | {
-        readonly algorithm: "aes-128-cbc" | "aes-128-ccm" | "aes-128-gcm" | "aes-128-ocb";
-        readonly keyLength: number;
-    } | {
-        readonly algorithm: "aes-192-cbc" | "aes-192-ccm" | "aes-192-gcm" | "aes-192-ocb";
-        readonly keyLength: number;
-    } | {
-        readonly algorithm: "aes-256-cbc" | "aes-256-ccm" | "aes-256-gcm" | "aes-256-ocb";
-        readonly keyLength: number;
-    };
+    private static GetKeyLength;
     /**
      * Check if the given algorithm is a Cipher AES-GCM algorithm.
      *

package/dist/{index-B9WIVWrs.d.ts → index-DWiR3kkc.d.ts}

@@ -41,6 +41,7 @@ declare namespace Cph {
         /** The Additional Authentication Data. */
         aad?: Uint8Array;
     }
+    /** The RSA Private Key. */
     type PrivateKey = KeyLike | {
         key: KeyLike;
         passphrase?: string;
@@ -137,19 +138,36 @@ declare class Cipher {
         readonly max: 128;
         readonly default: 32;
     };
+    /**
+     * Cipher algorithm name.
+     *
+     */
     static readonly ALGORITHM: {
+        /** AES 128 bit Cipher Block Chaining. */
         readonly AES_128_CBC: "aes-128-cbc";
+        /** AES 192 bit Cipher Block Chaining. */
         readonly AES_192_CBC: "aes-192-cbc";
+        /** AES 256 bit Cipher Block Chaining. */
         readonly AES_256_CBC: "aes-256-cbc";
+        /** AES 128 bit AEAD Counter with CBC-MAC. */
         readonly AES_128_CCM: "aes-128-ccm";
+        /** AES 192 bit AEAD Counter with CBC-MAC. */
         readonly AES_192_CCM: "aes-192-ccm";
+        /** AES 256 bit AEAD Counter with CBC-MAC. */
         readonly AES_256_CCM: "aes-256-ccm";
+        /** AES 128 bit AEAD Galois/Counter Mode. */
         readonly AES_128_GCM: "aes-128-gcm";
+        /** AES 192 bit AEAD Galois/Counter Mode. */
         readonly AES_192_GCM: "aes-192-gcm";
+        /** AES 256 bit AEAD Galois/Counter Mode. */
         readonly AES_256_GCM: "aes-256-gcm";
+        /** AES 128 bit AEAD Offset Codebook Mode. */
         readonly AES_128_OCB: "aes-128-ocb";
+        /** AES 192 bit AEAD Offset Codebook Mode. */
         readonly AES_192_OCB: "aes-192-ocb";
+        /** AES 256 bit AEAD Offset Codebook Mode. */
         readonly AES_256_OCB: "aes-256-ocb";
+        /** AES 256 bit AEAD. */
         readonly CHACHA_20_POLY: "chacha20-poly1305";
     };
     /**
@@ -168,49 +186,49 @@ declare class Cipher {
     /**
      * Encrypt in-memory data buffer.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.StreamEncrypt()} or {@link Cipher.HybridStreamEncrypt()} methods for large data encryption.
+     * ⚠️ This is not suitable for large data encryption. Use {@link Cipher.stream.Encrypt()} or {@link Cipher.stream.HybridEncrypt()} methods for large data encryption.
      *
      * @param	data	The data to encrypt.
      * @param	secret	The secret key used to encrypt the `data`.
-     * @param	options	( Optional ) Additional options.
+     * @param	options	(Optional) Additional options.
      * @returns	The encrypted result Buffer.
      */
     static Encrypt(data: CoerceToUint8ArrayInput, secret: CoerceToUint8ArrayInput, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Decrypt in-memory data buffer.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.StreamDecrypt()} or {@link Cipher.HybridStreamDecrypt()} methods for large data decryption.
+     * ⚠️ This is not suitable for large data decryption. Use {@link Cipher.stream.Decrypt()} or {@link Cipher.stream.HybridDecrypt()} methods for large data decryption.
      *
      * @param	data	The data to decrypt.
      * @param	secret	The secret key used to decrypt the `data`.
-     * @param	options	( Optional ) Additional options. Must be the same used while encrypting data.
+     * @param	options	(Optional) Additional options. Must be the same used while encrypting data.
      * @returns	The decrypted data Buffer.
      */
     static Decrypt(data: CoerceToUint8ArrayInput, secret: CoerceToUint8ArrayInput, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Encrypt in-memory data using hybrid encryption.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.HybridStreamEncrypt()} method for large data encryption.
+     * ⚠️ This is not suitable for large data encryption. Use {@link Cipher.stream.HybridEncrypt()} method for large data encryption.
      *
-     * @param	data		The data to encrypt.
-     * @param	publicKey	The public key.
-     * @param	options		( Optional ) Additional options.
+     * @param	data	The data to encrypt.
+     * @param	key		The RSA Public Key.
+     * @param	options	(Optional) Additional options.
      *
      * @returns	The encrypted result Buffer.
      */
-    static HybridEncrypt(data: CoerceToUint8ArrayInput, publicKey: crypto.KeyLike, options?: Cph.Options): Buffer<ArrayBuffer>;
+    static HybridEncrypt(data: CoerceToUint8ArrayInput, key: crypto.KeyLike, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Decrypt in-memory data using hybrid decryption.
      *
-     * ⚠️ This is not suitable for large data. Use {@link Cipher.stream.HybridDecrypt()} method for large data encryption.
+     * ⚠️ This is not suitable for large data decryption. Use {@link Cipher.stream.HybridDecrypt()} method for large data decryption.
      *
-     * @param	data		The encrypted data to decrypt.
-     * @param	privateKey	The private key.
-     * @param	options		( Optional ) Additional options.
+     * @param	data	The encrypted data to decrypt.
+     * @param	key		The RSA Private Key.
+     * @param	options	(Optional) Additional options.
      *
      * @returns	The encrypted result Buffer.
      */
-    static HybridDecrypt(data: CoerceToUint8ArrayInput, privateKey: Cph.PrivateKey, options?: Cph.Options): Buffer<ArrayBuffer>;
+    static HybridDecrypt(data: CoerceToUint8ArrayInput, key: Cph.PrivateKey, options?: Cph.Options): Buffer<ArrayBuffer>;
     /**
      * Cipher stream based functions.
      *
@@ -237,21 +255,21 @@ declare class Cipher {
         /**
          * Encrypt stream data using hybrid encryption.
          *
-         * @param	publicKey	The public key.
-         * @param	options		An object defining required options. See {@link Cph.Stream.EncryptOptions} for more info.
+         * @param	key		The RSA Public Key.
+         * @param	options	An object defining required options. See {@link Cph.Stream.EncryptOptions} for more info.
          *
          * @returns	A new Promise that resolves `void` once stream encryption is completed.
          */
-        HybridEncrypt(publicKey: crypto.KeyLike, options: Cph.Stream.EncryptOptions): Promise<void>;
+        HybridEncrypt(key: crypto.KeyLike, options: Cph.Stream.EncryptOptions): Promise<void>;
         /**
          * Decrypt stream data using hybrid decryption.
          *
-         * @param	privateKey	The private key.
-         * @param	options		An object defining required options. See {@link Cph.Stream.DecryptOptions} for more info.
+         * @param	key		The private key.
+         * @param	options	An object defining required options. See {@link Cph.Stream.DecryptOptions} for more info.
          *
          * @returns	A new Promise that resolves `void` once stream decryption is completed.
          */
-        HybridDecrypt(privateKey: Cph.PrivateKey, options: Cph.Stream.DecryptOptions): Promise<void>;
+        HybridDecrypt(key: Cph.PrivateKey, options: Cph.Stream.DecryptOptions): Promise<void>;
         /**
          * Handle pipe flow to encrypt a Stream.
          *
@@ -283,17 +301,11 @@ declare class Cipher {
      *
      * @returns An object with the generated `Key`, `IV`, `salt` and resolved `options`.
      */
-    static NewKeyIV<T extends Cph.ResolvedOptions = Cph.ResolvedOptions>(options?: Cph.NewKeyIVOptions): {
-        options: T;
-        Key: NonSharedBuffer;
-        IV: NonSharedBuffer;
-        AAD: Uint8Array<ArrayBufferLike> | NonSharedBuffer;
-        salt: NonSharedBuffer;
-    };
+    private static NewKeyIV;
     /**
      * Resolves the given `options` with `Cipher` defaults and constraints.
      *
-     * @param options ( Optional ) Additional options.
+     * @param options (Optional) Additional options.
      * @returns The given `options` with `Cipher` defaults and constraints.
      */
     private static ResolveOptions;
@@ -301,29 +313,17 @@ declare class Cipher {
      * Get the Initialization Vector length based on the given algorithm.
      *
      * @param	algorithm The algorithm in use.
-     * @param	options ( Optional ) Additional options.
+     * @param	options (Optional) Additional options.
      * @returns	The Initialization Vector length based on the given algorithm
      */
-    static GetIVLength(algorithm?: Cph.Options['algorithm'], options?: Cph.Options): number;
+    private static GetIVLength;
     /**
      * Ensure correct key length based on the given algorithm.
      *
      * @param	algorithm The AES algorithm name.
      * @returns	An object with validated `algorithm` and `keyLength`.
      */
-    static GetKeyLength(algorithm?: Cph.Options['algorithm']): {
-        readonly algorithm: "chacha20-poly1305";
-        readonly keyLength: number;
-    } | {
-        readonly algorithm: "aes-128-cbc" | "aes-128-ccm" | "aes-128-gcm" | "aes-128-ocb";
-        readonly keyLength: number;
-    } | {
-        readonly algorithm: "aes-192-cbc" | "aes-192-ccm" | "aes-192-gcm" | "aes-192-ocb";
-        readonly keyLength: number;
-    } | {
-        readonly algorithm: "aes-256-cbc" | "aes-256-ccm" | "aes-256-gcm" | "aes-256-ocb";
-        readonly keyLength: number;
-    };
+    private static GetKeyLength;
     /**
      * Check if the given algorithm is a Cipher AES-GCM algorithm.
      *

package/dist/index.d.mts

@@ -1,4 +1,4 @@
 import 'crypto';
 import '@alessiofrittoli/crypto-buffer';
-export { a as Cipher } from './index-B9WIVWrs.mjs';
+export { a as Cipher } from './index-DWiR3kkc.mjs';
 import 'stream';

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import 'crypto';
 import '@alessiofrittoli/crypto-buffer';
-export { a as Cipher } from './index-B9WIVWrs.js';
+export { a as Cipher } from './index-DWiR3kkc.js';
 import 'stream';

package/dist/types.d.mts

@@ -1,4 +1,4 @@
 import 'crypto';
 import 'stream';
 import '@alessiofrittoli/crypto-buffer';
-export { C as Cph } from './index-B9WIVWrs.mjs';
+export { C as Cph } from './index-DWiR3kkc.mjs';

package/dist/types.d.ts

@@ -1,4 +1,4 @@
 import 'crypto';
 import 'stream';
 import '@alessiofrittoli/crypto-buffer';
-export { C as Cph } from './index-B9WIVWrs.js';
+export { C as Cph } from './index-DWiR3kkc.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alessiofrittoli/crypto-cipher",
-	"version": "3.0.0-alpha.3",
+	"version": "3.0.0",
 	"description": "Node.js Cipher cryptograph utility library",
 	"author": {
 		"name": "Alessio Frittoli",
@@ -19,9 +19,14 @@
 		"cryptography",
 		"cipher",
 		"aes",
+		"aead",
 		"hybrid-encryption",
 		"stream-encrypt",
-		"stream-decrypt"
+		"stream-decrypt",
+		"ccm",
+		"gcm",
+		"ocb",
+		"cbc"
 	],
 	"homepage": "https://github.com/alessiofrittoli/crypto-cipher#readme",
 	"bugs": {
@@ -113,6 +118,6 @@
 	"dependencies": {
 		"@alessiofrittoli/crypto-buffer": "^3.10.0",
 		"@alessiofrittoli/math-utils": "^1.17.0",
-		"@alessiofrittoli/stream-reader": "2.7.0-alpha.2"
+		"@alessiofrittoli/stream-reader": "3.0.0"
 	}
 }