@digitaldefiance/node-ecies-lib 4.4.8 → 4.4.10

package/src/interfaces/ecies-consts.ts

@@ -1,99 +0,0 @@
-export interface IECIESConsts {
-  /** The elliptic curve to use for all ECDSA operations */
-  CURVE_NAME: string;
-
-  /** The primary key derivation path for HD wallets */
-  PRIMARY_KEY_DERIVATION_PATH: string;
-
-  /** Length of ECDSA signatures in bytes */
-  SIGNATURE_SIZE: number;
-
-  /** Length of raw public keys in bytes (without 0x04 prefix) */
-  RAW_PUBLIC_KEY_LENGTH: number;
-
-  /** Length of public keys in bytes (with 0x04 prefix) */
-  PUBLIC_KEY_LENGTH: number; // RAW_PUBLIC_KEY_LENGTH + 1
-
-  PUBLIC_KEY_MAGIC: number;
-
-  /** Mnemonic strength in bits. This will produce a 32-bit key for ECDSA */
-  MNEMONIC_STRENGTH: number;
-
-  /** Symmetric encryption algorithm configuration */
-  SYMMETRIC: {
-    ALGORITHM: string;
-    KEY_BITS: number;
-    KEY_SIZE: number; // KEY_BITS / 8
-    MODE: string;
-  };
-
-  /**
-   * Length of the initialization vector
-   */
-  IV_SIZE: number;
-  /**
-   * Length of the authentication tag
-   */
-  AUTH_TAG_SIZE: number;
-
-  /**
-   * Maximum length of the data that can be encrypted
-   */
-  MAX_RAW_DATA_SIZE: number;
-
-  SIMPLE: {
-    /**
-     * Length of the type (1) + public key (65) + IV (16) + auth tag (16)
-     */
-    FIXED_OVERHEAD_SIZE: number;
-    /**
-     * Length of the data length (0 for simple encryption)
-     */
-    DATA_LENGTH_SIZE: number;
-  };
-
-  /**
-   * ECIES single recipient
-   */
-  SINGLE: {
-    /**
-     * Length of the IV + auth tag + data length + crc16
-     */
-    FIXED_OVERHEAD_SIZE: number;
-    /**
-     * Length of the data length
-     */
-    DATA_LENGTH_SIZE: number;
-  };
-
-  /**
-   * ECIES multiple recipient
-   */
-  MULTIPLE: {
-    /**
-     * Length of the IV + auth tag + data length + recipient count for the overall message
-     */
-    FIXED_OVERHEAD_SIZE: number;
-    /**
-     * Length of the encrypted key for each recipient
-     */
-    ENCRYPTED_KEY_SIZE: number;
-    /**
-     * Maximum number of recipients for a single message
-     * This is limited by the size of the value used to store the recipient count in the header
-     */
-    MAX_RECIPIENTS: number;
-    /**
-     * Length of the recipient ID
-     */
-    RECIPIENT_ID_SIZE: number;
-    /**
-     * Length of the recipient count
-     */
-    RECIPIENT_COUNT_SIZE: number;
-    /**
-     * Length of the data length
-     */
-    DATA_LENGTH_SIZE: number;
-  };
-}

package/src/interfaces/encrypted-chunk.ts

@@ -1,12 +0,0 @@
-export interface IChunkMetadata {
-  totalChunks?: number;
-  originalSize?: number;
-  recipientCount?: number;
-}
-
-export interface IEncryptedChunk {
-  index: number;
-  data: Buffer;
-  isLast: boolean;
-  metadata?: IChunkMetadata;
-}

package/src/interfaces/encryption-consts.ts

@@ -1,10 +0,0 @@
-export interface IEncryptionConsts {
-  /**
-   * The size of the encryption type in bytes
-   */
-  ENCRYPTION_TYPE_SIZE: number;
-  /**
-   * The size of the recipient ID in bytes
-   */
-  RECIPIENT_ID_SIZE: number;
-}

package/src/interfaces/keypair-buffer-with-un-encrypted-private-key.ts

@@ -1,7 +0,0 @@
-import type { ISimplePublicKeyOnlyBuffer } from './simple-public-key-only-buffer';
-
-export interface IKeyPairBufferWithUnEncryptedPrivateKey
-  extends ISimplePublicKeyOnlyBuffer {
-  publicKey: Buffer;
-  privateKey: Buffer;
-}

package/src/interfaces/keyring-consts.ts

@@ -1,5 +0,0 @@
-export interface IKeyringConsts {
-  ALGORITHM: string;
-  KEY_BITS: number;
-  MODE: string;
-}

package/src/interfaces/member.ts

@@ -1,76 +0,0 @@
-import type {
-  EmailString,
-  MemberType,
-  SecureBuffer,
-  SecureString,
-} from '@digitaldefiance/ecies-lib';
-import type { Wallet } from '@ethereumjs/wallet';
-import type { Types } from '@digitaldefiance/mongoose-types';
-import type { SignatureBuffer } from '../types';
-import type { IEncryptedChunk } from './encrypted-chunk';
-import type { IStreamProgress } from './stream-progress';
-
-/**
- * Interface representing a member with cryptographic capabilities.
- * This interface defines the contract for member operations without
- * referencing concrete class implementations.
- */
-export interface IMember<
-  TID extends string | Types.ObjectId | Buffer | Uint8Array = Buffer
-> {
-  // Required properties
-  readonly id: TID;
-  readonly type: MemberType;
-  readonly name: string;
-  readonly email: EmailString;
-  readonly publicKey: Buffer;
-  readonly creatorId: TID;
-  readonly dateCreated: Date;
-  readonly dateUpdated: Date;
-
-  // Optional private data properties
-  readonly privateKey: SecureBuffer | undefined;
-  readonly wallet: Wallet;
-
-  // State properties
-  readonly hasPrivateKey: boolean;
-
-  // Key management methods
-  unloadPrivateKey(): void;
-  unloadWallet(): void;
-  unloadWalletAndPrivateKey(): void;
-  loadWallet(mnemonic: SecureString): void;
-  loadPrivateKey(privateKey: SecureBuffer): void;
-
-  // Cryptographic methods
-  sign(data: Buffer): SignatureBuffer;
-  signData(data: Buffer): SignatureBuffer;
-  verify(signature: SignatureBuffer, data: Buffer): boolean;
-  verifySignature(data: Buffer, signature: Buffer, publicKey: Buffer): boolean;
-
-  // Encryption/Decryption methods
-  encryptDataStream(
-    source: AsyncIterable<Buffer>,
-    options?: {
-      recipientPublicKey?: Buffer;
-      onProgress?: (progress: IStreamProgress) => void;
-      signal?: AbortSignal;
-    }
-  ): AsyncGenerator<IEncryptedChunk, void, unknown>;
-
-  decryptDataStream(
-    source: AsyncIterable<Buffer>,
-    options?: {
-      onProgress?: (progress: IStreamProgress) => void;
-      signal?: AbortSignal;
-    }
-  ): AsyncGenerator<Buffer, void, unknown>;
-
-  encryptData(data: string | Buffer, recipientPublicKey?: Buffer): Buffer;
-
-  decryptData(encryptedData: Buffer): Buffer;
-
-  // Serialization methods
-  toJson(): string;
-  dispose(): void;
-}

package/src/interfaces/multi-encrypted-parsed-header.ts

@@ -1,28 +0,0 @@
-import { Types } from '@digitaldefiance/mongoose-types';
-
-export interface IMultiEncryptedParsedHeader {
-  /**
-   * The length of the data before encryption
-   */
-  readonly dataLength: number;
-  /**
-   * The number of recipients
-   */
-  readonly recipientCount: number;
-  /**
-   * The IDs of the recipients
-   */
-  readonly recipientIds: Buffer[];
-  /**
-   * An encrypted version of the symmetric key for each recipient
-   */
-  readonly recipientKeys: Buffer[];
-  /**
-   * The size of the header, up to the encrypted message start (excludes encrypted message IV+auth tag)
-   */
-  readonly headerSize: number;
-  /**
-   * The ephemeral public key used for encryption
-   */
-  readonly ephemeralPublicKey?: Buffer;
-}

package/src/interfaces/multi-recipient-chunk.ts

@@ -1,35 +0,0 @@
-export interface IMultiRecipientChunkHeader {
-  chunkIndex: number;
-  flags: number;
-  recipientCount: number;
-  magic?: number;
-  version?: number;
-  originalSize?: number;
-  encryptedSize?: number;
-}
-
-export interface IMultiRecipientChunk {
-  header: IMultiRecipientChunkHeader;
-  data: Buffer;
-  isLast?: boolean;
-  recipientCount?: number;
-  index?: number;
-}
-
-export interface IMultiRecipientConstants {
-  MAGIC: number;
-  VERSION: number;
-  HEADER_SIZE: number;
-  KEY_SIZE_BYTES: number;
-  FLAG_IS_LAST: number;
-  MAX_RECIPIENTS: number;
-}
-
-export const getMultiRecipientConstants = (recipientIdSize: number): IMultiRecipientConstants => ({
-  MAGIC: 0x45434945, // 'ECIE'
-  VERSION: 1,
-  HEADER_SIZE: 64, // Fixed header size before recipient list
-  KEY_SIZE_BYTES: 2, // Size of the key size field
-  FLAG_IS_LAST: 1,
-  MAX_RECIPIENTS: 65535,
-});

package/src/interfaces/pbkdf2-result.ts

@@ -1,5 +0,0 @@
-export interface IPbkdf2Result {
-  salt: Buffer;
-  hash: Buffer;
-  iterations: number;
-}

package/src/interfaces/signing-key-private-key-info.ts

@@ -1,12 +0,0 @@
-import type { ec } from 'elliptic';
-import type { IKeyPairBufferWithUnEncryptedPrivateKey } from './keypair-buffer-with-un-encrypted-private-key';
-
-export interface ISigningKeyPrivateKeyInfo
-  extends IKeyPairBufferWithUnEncryptedPrivateKey {
-  keyPair: ec.KeyPair;
-  publicKey: Buffer;
-  privateKey: Buffer;
-  seedHex: string;
-  entropy: string;
-  mnemonic: string;
-}

package/src/interfaces/simple-public-key-only-buffer.ts

@@ -1,3 +0,0 @@
-export interface ISimplePublicKeyOnlyBuffer {
-  publicKey: Buffer;
-}

package/src/interfaces/simple-public-key-only.ts

@@ -1,3 +0,0 @@
-export interface ISimplePublicKeyOnly {
-  publicKey: string;
-}

package/src/interfaces/single-encrypted-parsed-header.ts

@@ -1,35 +0,0 @@
-import { EciesEncryptionTypeEnum } from '@digitaldefiance/ecies-lib';
-
-/**
- * Interface for encrypted messages
- */
-export interface ISingleEncryptedParsedHeader {
-  /**
-   * The optional preamble, if specified/relevant
-   */
-  readonly preamble?: Buffer;
-  /**
-   * The encryption type used to encrypt the data
-   */
-  readonly encryptionType: EciesEncryptionTypeEnum;
-  /**
-   * The ephemeral public key used to encrypt the data
-   */
-  readonly ephemeralPublicKey: Buffer;
-  /**
-   * The initialization vector used to encrypt the data
-   */
-  readonly iv: Buffer;
-  /**
-   * The authentication tag used to encrypt the data
-   */
-  readonly authTag: Buffer;
-  /**
-   * The length of the encrypted data
-   */
-  readonly dataLength: number;
-  /**
-   * The size of the encrypted data header
-   */
-  readonly headerSize: number;
-}

package/src/interfaces/stream-config.ts

@@ -1,9 +0,0 @@
-export interface IStreamConfig {
-  chunkSize: number;
-  includeChecksums: boolean;
-}
-
-export const DEFAULT_STREAM_CONFIG: IStreamConfig = {
-  chunkSize: 65536, // 64KB
-  includeChecksums: false,
-};

package/src/interfaces/stream-progress.ts

@@ -1,7 +0,0 @@
-export interface IStreamProgress {
-  processedBytes: number;
-  totalBytes: number;
-  percentComplete: number;
-  throughputBytesPerSec: number;
-  estimatedTimeRemainingMs: number;
-}

package/src/interfaces/wrapped-key-consts.ts

@@ -1,6 +0,0 @@
-export interface IWrappedKeyConsts {
-  SALT_SIZE: number;
-  IV_SIZE: number;
-  MASTER_KEY_SIZE: number;
-  MIN_ITERATIONS: number;
-}

package/src/lib/crypto-container.ts

@@ -1,32 +0,0 @@
-import { ECIESService } from '../services/ecies';
-import { Pbkdf2Service } from '../services/pbkdf2';
-import { AESGCMService } from '../services/aes-gcm';
-import { IConstants } from '../interfaces/constants';
-import { Constants } from '../constants';
-
-export enum CryptoServiceKey {
-  ECIES = 'ecies',
-  PBKDF2 = 'pbkdf2',
-  AES_GCM = 'aes-gcm',
-}
-
-export class CryptoContainer {
-  private services = new Map<CryptoServiceKey, unknown>();
-
-  private constructor(config: IConstants) {
-    this.services.set(CryptoServiceKey.ECIES, new ECIESService(undefined, config.ECIES));
-    this.services.set(
-      CryptoServiceKey.PBKDF2,
-      new Pbkdf2Service(config.PBKDF2_PROFILES, config.ECIES, config.PBKDF2)
-    );
-    this.services.set(CryptoServiceKey.AES_GCM, new AESGCMService(config));
-  }
-
-  static create(config: IConstants = Constants): CryptoContainer {
-    return new CryptoContainer(config);
-  }
-
-  get<T>(key: CryptoServiceKey): T {
-    return this.services.get(key) as T;
-  }
-}

package/src/lib/invariant-validator.ts

@@ -1,124 +0,0 @@
-import { 
-  InvariantValidator as BaseInvariantValidator,
-  IInvariant 
-} from '@digitaldefiance/ecies-lib';
-import { TranslatableGenericError } from '@digitaldefiance/i18n-lib';
-import { IConstants } from '../interfaces/constants';
-import { RecipientIdConsistencyInvariant } from './invariants/recipient-id-consistency';
-import { NodeEciesStringKey, NodeEciesComponentId } from '../i18n/node-keys';
-import { getNodeEciesI18nEngine } from '../i18n/node-ecies-i18n-setup';
-
-/**
- * Node.js-specific invariant validator.
- * 
- * Extends the base ecies-lib validator with Node.js-specific invariants.
- * Validates configuration consistency to prevent bugs like the 12 vs 32-byte
- * recipient ID discrepancy.
- * 
- * @example
- * ```typescript
- * import { InvariantValidator } from '@digitaldefiance/node-ecies-lib';
- * import { MyCustomInvariant } from './my-invariants';
- * 
- * // Register a custom invariant
- * InvariantValidator.registerInvariant(new MyCustomInvariant());
- * 
- * // Validate configuration
- * InvariantValidator.validateAll(config); // throws if any invariant fails
- * ```
- */
-export class InvariantValidator {
-  /**
-   * Node-specific invariants registered by default.
-   */
-  private static readonly NODE_DEFAULT_INVARIANTS: IInvariant[] = [
-    new RecipientIdConsistencyInvariant(),
-  ];
-
-  private static customInvariants: IInvariant[] = [];
-
-  /**
-   * Register a custom invariant to be checked during validation.
-   * 
-   * @param invariant - The invariant to register
-   */
-  static registerInvariant(invariant: IInvariant): void {
-    this.customInvariants.push(invariant);
-    // Also register with base validator for consistency
-    BaseInvariantValidator.registerInvariant(invariant);
-  }
-
-  /**
-   * Unregister a custom invariant by name.
-   * 
-   * @param name - The name of the invariant to unregister
-   * @returns true if the invariant was found and removed, false otherwise
-   */
-  static unregisterInvariant(name: string): boolean {
-    const index = this.customInvariants.findIndex((inv) => inv.name === name);
-    if (index === -1) {
-      return false;
-    }
-    this.customInvariants.splice(index, 1);
-    return true;
-  }
-
-  /**
-   * Get all registered invariants (default + custom).
-   */
-  static getAllInvariants(): readonly IInvariant[] {
-    return [...this.NODE_DEFAULT_INVARIANTS, ...this.customInvariants];
-  }
-
-  /**
-   * Validate all registered invariants against a configuration.
-   * 
-   * This checks both:
-   * - Base ecies-lib invariants (via BaseInvariantValidator)
-   * - Node-specific invariants
-   * 
-   * @param config - The configuration to validate
-   * @throws Error if any invariant check fails
-   */
-  static validateAll(config: IConstants): void {
-    const failures: string[] = [];
-
-    // First, validate base ecies-lib invariants, excluding the one we are replacing
-    const baseInvariants = BaseInvariantValidator.getAllInvariants();
-    for (const invariant of baseInvariants) {
-      if (invariant.name === 'RecipientIdConsistency') {
-        continue;
-      }
-      if (!invariant.check(config)) {
-        failures.push(invariant.errorMessage(config));
-      }
-    }
-
-    // Then validate Node-specific invariants
-    for (const invariant of this.getAllInvariants()) {
-      if (!invariant.check(config)) {
-        failures.push(invariant.errorMessage(config));
-      }
-    }
-
-    if (failures.length > 0) {
-      const engine = getNodeEciesI18nEngine();
-      throw TranslatableGenericError.withEngine(
-        engine,
-        NodeEciesComponentId,
-        NodeEciesStringKey.Error_Invariant_ConfigurationValidationFailedTemplate,
-        { failures: failures.join('\n\n') },
-        undefined,
-        { invariantCount: failures.length }
-      );
-    }
-  }
-
-  /**
-   * Clear all custom invariants.
-   * Default invariants are not affected.
-   */
-  static clearCustomInvariants(): void {
-    this.customInvariants = [];
-  }
-}

package/src/lib/invariants/recipient-id-consistency.ts

@@ -1,77 +0,0 @@
-import { BaseInvariant } from '@digitaldefiance/ecies-lib';
-import { IConstants } from '../../interfaces/constants';
-import { NodeEciesStringKey } from '../../i18n/node-keys';
-import { getNodeEciesTranslation } from '../../i18n/ecies-i18n-factory';
-
-/**
- * Node.js-specific recipient ID consistency invariant.
- * 
- * Extends the base ecies-lib invariant to also validate node-specific
- * ENCRYPTION.RECIPIENT_ID_SIZE constant.
- * 
- * This invariant would have caught the 12 vs 32 byte discrepancy.
- * 
- * Checks:
- * - MEMBER_ID_LENGTH === idProvider.byteLength
- * - ECIES.MULTIPLE.RECIPIENT_ID_SIZE === idProvider.byteLength
- * - ENCRYPTION.RECIPIENT_ID_SIZE === idProvider.byteLength (Node-specific)
- * - All values must be in sync
- */
-export class RecipientIdConsistencyInvariant extends BaseInvariant {
-  constructor() {
-    super(
-      'NodeRecipientIdConsistency',
-      'All recipient ID size configurations must match the ID provider byte length (including Node-specific ENCRYPTION constant)'
-    );
-  }
-
-  check(config: IConstants): boolean {
-    const baseChecks = 
-      config.MEMBER_ID_LENGTH === config.idProvider.byteLength &&
-      config.ECIES.MULTIPLE.RECIPIENT_ID_SIZE === config.idProvider.byteLength;
-    
-    // ENCRYPTION is node-specific and may not exist in all configs
-    if (config.ENCRYPTION && 'RECIPIENT_ID_SIZE' in config.ENCRYPTION) {
-      return baseChecks && config.ENCRYPTION.RECIPIENT_ID_SIZE === config.idProvider.byteLength;
-    }
-    
-    return baseChecks;
-  }
-
-  errorMessage(config: IConstants): string {
-    const issues: string[] = [];
-
-    if (config.MEMBER_ID_LENGTH !== config.idProvider.byteLength) {
-      issues.push(
-        getNodeEciesTranslation(NodeEciesStringKey.Error_Invariant_MemberIdLengthMismatchTemplate, {
-          actual: config.MEMBER_ID_LENGTH,
-          expected: config.idProvider.byteLength,
-        })
-      );
-    }
-
-    if (config.ECIES.MULTIPLE.RECIPIENT_ID_SIZE !== config.idProvider.byteLength) {
-      issues.push(
-        getNodeEciesTranslation(NodeEciesStringKey.Error_Invariant_EciesMultipleRecipientIdSizeMismatchTemplate, {
-          actual: config.ECIES.MULTIPLE.RECIPIENT_ID_SIZE,
-          expected: config.idProvider.byteLength,
-        })
-      );
-    }
-
-    if (config.ENCRYPTION && 'RECIPIENT_ID_SIZE' in config.ENCRYPTION) {
-      if (config.ENCRYPTION.RECIPIENT_ID_SIZE !== config.idProvider.byteLength) {
-        issues.push(
-          getNodeEciesTranslation(NodeEciesStringKey.Error_Invariant_EncryptionRecipientIdSizeMismatchTemplate, {
-            actual: config.ENCRYPTION.RECIPIENT_ID_SIZE,
-            expected: config.idProvider.byteLength,
-          })
-        );
-      }
-    }
-
-    return getNodeEciesTranslation(NodeEciesStringKey.Error_Invariant_NodeRecipientIdConsistency_FailedTemplate, {
-      issues: issues.join('\n  '),
-    });
-  }
-}