@digitaldefiance/ecies-lib 1.1.23 → 1.1.24

package/{dist/index.d.ts → src/index.ts}

@@ -13,4 +13,3 @@ export * from './secure-string';
 export * from './services';
 export * from './types';
 export * from './utils';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/checksum-config.ts

@@ -0,0 +1,4 @@
+export interface IChecksumConfig {
+  algorithm: string;
+  encoding: 'hex' | 'base64';
+}

package/src/interfaces/checksum-consts.ts

@@ -0,0 +1,13 @@
+export interface IChecksumConsts {
+  /** Default hash bits for SHA3 */
+  SHA3_DEFAULT_HASH_BITS: number;
+
+  /** Length of a SHA3 checksum buffer in bytes */
+  SHA3_BUFFER_LENGTH: number;
+
+  /** Algorithm name for checksums */
+  ALGORITHM: string;
+
+  /** Encoding for checksums */
+  ENCODING: 'hex' | 'base64';
+}

package/src/interfaces/constants.ts

@@ -0,0 +1,48 @@
+import { Pbkdf2Profiles } from '../pbkdf2-profiles';
+import { IChecksumConsts } from './checksum-consts';
+import { IECIESConstants } from './ecies-consts';
+import { IPBkdf2Consts } from './pbkdf2-consts';
+
+export interface IConstants {
+  UINT8_SIZE: number;
+  UINT16_SIZE: number;
+  UINT16_MAX: number;
+  UINT32_SIZE: number;
+  UINT32_MAX: number;
+  UINT64_SIZE: number;
+  UINT64_MAX: bigint;
+  HEX_RADIX: number;
+  GUID_SIZE: number;
+
+  /**
+   * The length of a raw object ID (not the hex string representation)
+   */
+  OBJECT_ID_LENGTH: number;
+
+  CHECKSUM: IChecksumConsts;
+  ECIES: IECIESConstants;
+  PBKDF2: IPBkdf2Consts;
+  PBKDF2_PROFILES: Pbkdf2Profiles;
+
+  /**
+   * Number of rounds for bcrypt hashing. Higher values increase security but also consume more CPU resources.
+   */
+  BcryptRounds: number;
+  /**
+   * Minimum password length
+   */
+  PasswordMinLength: number;
+  /**
+   * The regular expression for valid passwords.
+   */
+  PasswordRegex: RegExp;
+  /**
+   * The regular expression for valid mnemonic phrases.
+   * BIP39
+   */
+  MnemonicRegex: RegExp;
+  /**
+   * The regular expression for valid HMAC keys.
+   */
+  HmacRegex: RegExp;
+}

package/src/interfaces/ecies-config.ts

@@ -0,0 +1,8 @@
+export interface IECIESConfig {
+  curveName: string;
+  primaryKeyDerivationPath: string;
+  mnemonicStrength: number;
+  symmetricAlgorithm: string;
+  symmetricKeyBits: number;
+  symmetricKeyMode: string;
+}

package/src/interfaces/ecies-consts.ts

@@ -0,0 +1,70 @@
+import { CipherGCMTypes } from 'crypto';
+export interface IECIESConstants {
+  /** 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;
+
+  SYMMETRIC_ALGORITHM_CONFIGURATION: CipherGCMTypes;
+
+  /** 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;
+
+  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;
+    MODE: string;
+    KEY_BITS: number;
+    KEY_SIZE: number; // KEY_BITS / 8
+  };
+
+  IV_SIZE: number;
+  AUTH_TAG_SIZE: number;
+  MAX_RAW_DATA_SIZE: number; // 2^53 - 1 (max safe integer for JS)
+
+  /**
+   * Message encrypts without data length or crc
+   */
+  SIMPLE: {
+    FIXED_OVERHEAD_SIZE: number; // type (1) + public key (65) + IV (16) + auth tag (16)
+    DATA_LENGTH_SIZE: number;
+  };
+
+  /**
+   * Message encrypts like single but with data Length and crc
+   */
+  SINGLE: {
+    FIXED_OVERHEAD_SIZE: number; // type (1) + public key (65) + IV (16) + auth tag (16) + data length (8) + crc16 (2)
+    DATA_LENGTH_SIZE: number;
+  };
+
+  /**
+   * Message encrypts for multiple recipients
+   */
+  MULTIPLE: {
+    FIXED_OVERHEAD_SIZE: number;
+    ENCRYPTED_KEY_SIZE: number;
+    MAX_RECIPIENTS: number;
+    RECIPIENT_ID_SIZE: number;
+    RECIPIENT_COUNT_SIZE: number;
+    DATA_LENGTH_SIZE: number;
+  };
+
+  ENCRYPTION_TYPE: {
+    SIMPLE: number;
+    SINGLE: number;
+    MULTIPLE: number;
+  };
+}

package/src/interfaces/ecies-file-service.ts

@@ -0,0 +1,6 @@
+export interface IEciesFileService {
+  encryptFile(file: File, recipientPublicKey: Uint8Array): Promise<Uint8Array>;
+  decryptFile(encryptedData: Uint8Array): Promise<Uint8Array>;
+  downloadEncryptedFile(encryptedData: Uint8Array, filename: string): void;
+  downloadDecryptedFile(decryptedData: Uint8Array, filename: string): void;
+}

package/src/interfaces/guid.ts

@@ -0,0 +1,53 @@
+import {
+  Base64Guid,
+  BigIntGuid,
+  // prettier-ignore
+  FullHexGuid,
+  RawGuidUint8Array,
+  ShortHexGuid,
+} from '../types';
+
+export interface IGuidV4 {
+  /**
+   * Returns the GUID as a raw buffer.
+   */
+  get asRawGuidUint8Array(): RawGuidUint8Array;
+  /**
+   * Returns the GUID as a full hex string.
+   */
+  get asFullHexGuid(): FullHexGuid;
+  /**
+   * Returns the GUID as a Uint8Array.
+   */
+  get asUint8Array(): Uint8Array;
+  /**
+   * Returns the GUID as a short hex string.
+   */
+  get asShortHexGuid(): ShortHexGuid;
+  /**
+   * Returns the GUID as a BigInt.
+   */
+  get asBigIntGuid(): BigIntGuid;
+  /**
+   * Returns the GUID as a Base64 string.
+   */
+  get asBase64Guid(): Base64Guid;
+
+  /**
+   * Returns the GUID as a base64 string
+   */
+  serialize(): string;
+  /**
+   * Returns the GUID as a JSON string
+   */
+  toJson(): string;
+  /**
+   * Returns the GUID as a Base64 string
+   */
+  toString(): Base64Guid;
+  /**
+   * Compares this GUID to another GUID
+   * @param other The GUID to compare to
+   */
+  equals(other: IGuidV4): boolean;
+}

package/{dist/interfaces/index.d.ts → src/interfaces/index.ts}

@@ -11,4 +11,3 @@ export * from './member-with-mnemonic';
 export * from './pbkdf2-config';
 export * from './pbkdf2-consts';
 export * from './pbkdf2-result';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/library-error.ts

@@ -0,0 +1,23 @@
+/**
+ * Standardized error interface for Digital Defiance libraries
+ * Ensures consistent error handling across the ecosystem
+ */
+export interface LibraryError extends Error {
+  /** The library that generated this error */
+  readonly library: string;
+  /** Unique error code for programmatic handling */
+  readonly errorCode: string;
+  /** HTTP-style status code */
+  readonly statusCode: number;
+}
+
+/**
+ * Interface for resources that can be disposed
+ * Ensures consistent memory management across libraries
+ */
+export interface DisposableResource {
+  /** Dispose of the resource and clean up memory */
+  dispose(): void;
+  /** Whether the resource has been disposed */
+  readonly isDisposed: boolean;
+}

package/src/interfaces/member-operational.ts

@@ -0,0 +1,54 @@
+import { Wallet } from '@ethereumjs/wallet';
+import { EmailString } from '../email-string';
+import MemberType from '../enumerations/member-type';
+import { GuidV4 } from '../guid';
+import { SecureBuffer } from '../secure-buffer';
+import { SecureString } from '../secure-string';
+import { SignatureUint8Array } from '../types';
+import { IECIESConstants } from './ecies-consts';
+
+/**
+ * Operational interface for member - defines getters and methods
+ */
+export interface IMemberOperational<
+  TID = GuidV4,
+  TData = Uint8Array,
+  TSignature = SignatureUint8Array,
+> {
+  // Required getters
+  get id(): TID;
+  get type(): MemberType;
+  get name(): string;
+  get email(): EmailString;
+  get publicKey(): Uint8Array;
+  get creatorId(): TID;
+  get dateCreated(): Date;
+  get dateUpdated(): Date;
+
+  // Optional private data getters
+  get privateKey(): SecureBuffer | undefined;
+  get wallet(): Wallet | undefined;
+
+  // State getters
+  get hasPrivateKey(): boolean;
+
+  // Methods
+  sign(data: TData): TSignature;
+  verify(signature: TSignature, data: TData): boolean;
+  encryptData(data: string | TData): Promise<TData>;
+  decryptData(encryptedData: TData): Promise<TData>;
+  toJson(): string;
+
+  // Private key management
+  loadWallet(mnemonic: SecureString, eciesParams?: IECIESConstants): void;
+  unloadPrivateKey(): void;
+  unloadWallet(): void;
+  unloadWalletAndPrivateKey(): void;
+}
+
+/**
+ * Extended operational interface for test members
+ */
+export interface ITestMemberOperational extends IMemberOperational {
+  get mnemonic(): SecureString | undefined;
+}

package/{dist/interfaces/member-storage.d.ts → src/interfaces/member-storage.ts}

@@ -1,21 +1,22 @@
 import { MemberType } from '../enumerations/member-type';
+
 /**
  * Storage format for member data - all serializable types
  */
 export interface IMemberStorageData {
-    id: string;
-    type: MemberType;
-    name: string;
-    email: string;
-    publicKey: string;
-    creatorId: string;
-    dateCreated: string;
-    dateUpdated: string;
+  id: string;
+  type: MemberType;
+  name: string;
+  email: string;
+  publicKey: string; // base64
+  creatorId: string;
+  dateCreated: string; // ISO string
+  dateUpdated: string; // ISO string
 }
+
 /**
  * Extended storage format for test member data
  */
 export interface ITestMemberStorageData extends IMemberStorageData {
-    mnemonic?: string;
+  mnemonic?: string;
 }
-//# sourceMappingURL=member-storage.d.ts.map

package/{dist/interfaces/member-with-mnemonic.d.ts → src/interfaces/member-with-mnemonic.ts}

@@ -1,7 +1,7 @@
 import { Member } from '../member';
 import { SecureString } from '../secure-string';
+
 export interface IMemberWithMnemonic {
-    member: Member;
-    mnemonic: SecureString;
+  member: Member;
+  mnemonic: SecureString;
 }
-//# sourceMappingURL=member-with-mnemonic.d.ts.map

package/src/interfaces/pbkdf2-config.ts

@@ -0,0 +1,6 @@
+export interface IPbkdf2Config {
+  hashBytes: number;
+  saltBytes: number;
+  iterations: number;
+  algorithm: string;
+}

package/src/interfaces/pbkdf2-consts.ts

@@ -0,0 +1,10 @@
+export interface IPBkdf2Consts {
+  /** Hash algorithm (sha512) */
+  ALGORITHM: string;
+
+  /** Number of bytes in a salt. */
+  SALT_BYTES: number;
+
+  /** Expected number of pbkdf2 iterations per second when hashing a password. */
+  ITERATIONS_PER_SECOND: number;
+}

package/src/interfaces/pbkdf2-result.ts

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