@digitaldefiance/node-ecies-lib 1.1.21 → 1.1.22

package/README.md

@@ -265,6 +265,10 @@ Please read the contributing guidelines in the main repository.
 
 ## ChangeLog
 
+### Version 1.1.22
+
+- Upgrade to es2022/nx monorepo
+
 ### Version 1.1.21
 
 - Upgrade pbkdf2service to plugini18n

package/package.json

@@ -1,45 +1,24 @@
 {
   "name": "@digitaldefiance/node-ecies-lib",
-  "version": "1.1.21",
+  "version": "1.1.22",
   "description": "Digital Defiance Node ECIES Library",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {
-    "build": "yarn tsc",
-    "test": "yarn jest --detectOpenHandles",
-    "test:stream": "yarn jest --detectOpenHandles --runInBand --outputStyle=stream",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint src/**/*.ts --fix",
+    "build": "npx nx build digitaldefiance-node-ecies-lib",
+    "test": "npx nx test digitaldefiance-node-ecies-lib",
+    "test:stream": "npx nx test digitaldefiance-node-ecies-lib --output-style=stream",
+    "lint": "npx nx lint digitaldefiance-node-ecies-lib",
+    "lint:fix": "npx nx lint digitaldefiance-node-ecies-lib --fix",
     "prettier:check": "prettier --check 'src/**/*.{ts,tsx}'",
     "prettier:fix": "prettier --write 'src/**/*.{ts,tsx}'",
-    "format": "yarn prettier:fix && yarn lint:fix",
-    "prepublishOnly": "yarn build",
+    "format": "npx nx format:write --projects=digitaldefiance-node-ecies-lib",
+    "format:check": "npx nx format:check --projects=digitaldefiance-node-ecies-lib",
+    "prepublishOnly": "npx nx build digitaldefiance-node-ecies-lib",
     "publish:public": "npm publish --access public"
   },
-  "devDependencies": {
-    "@babel/core": "^7.28.4",
-    "@babel/preset-env": "^7.28.3",
-    "@babel/preset-typescript": "^7.27.1",
-    "@types/babel__core": "^7",
-    "@types/babel__preset-env": "^7",
-    "@types/jest": "^29.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.31.1",
-    "@typescript-eslint/parser": "^8.31.1",
-    "babel-jest": "^30.1.2",
-    "eslint": "^9.8.0",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-prettier": "^5.3.1",
-    "jest": "^29.0.0",
-    "jest-resolver-enhanced": "^1.1.0",
-    "jest-util": "^30.0.5",
-    "prettier": "^2.6.2",
-    "prettier-plugin-organize-imports": "^4.1.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.9.2"
-  },
   "files": [
-    "dist",
+    "src",
     "README.md"
   ],
   "keywords": [
@@ -52,8 +31,8 @@
   "license": "MIT",
   "packageManager": "yarn@4.10.3",
   "dependencies": {
-    "@digitaldefiance/ecies-lib": "1.1.23",
-    "@digitaldefiance/i18n-lib": "1.3.12",
+    "@digitaldefiance/ecies-lib": "1.1.24",
+    "@digitaldefiance/i18n-lib": "1.3.13",
     "@ethereumjs/wallet": "^10.0.0",
     "@noble/curves": "^2.0.1",
     "@noble/hashes": "^2.0.1",

package/src/constants.ts

@@ -0,0 +1,182 @@
+import {
+  Constants as BaseConstants,
+  GUID_SIZE,
+  IPBkdf2Consts,
+  getRuntimeConfiguration,
+  registerRuntimeConfiguration,
+} from '@digitaldefiance/ecies-lib';
+import { CipherGCMTypes } from 'crypto';
+import { ObjectId } from 'mongodb';
+import { IChecksumConsts } from './interfaces/checksum-consts';
+import { IConstants } from './interfaces/constants';
+import { IEncryptionConsts } from './interfaces/encryption-consts';
+import { IKeyringConsts } from './interfaces/keyring-consts';
+import { PbkdfProfiles } from './interfaces/pbkdf-profiles';
+import { IWrappedKeyConsts } from './interfaces/wrapped-key-consts';
+import { Pbkdf2ProfileEnum as NodePbkdf2ProfileEnum } from './enumerations/pbkdf2-profile';
+import { getEciesPluginI18nEngine, NodeEciesComponentId, NodeEciesStringKey } from './i18n';
+
+/**
+ * Constants for checksum operations
+ * These values are critical for data integrity and MUST NOT be changed
+ * in an already established system as it will break all existing checksums.
+ */
+export const NODE_RUNTIME_CONFIGURATION_KEY = Symbol.for(
+  'digitaldefiance.node.ecies.defaults',
+);
+
+type NodeRuntimeConfiguration = ReturnType<typeof getRuntimeConfiguration>;
+type NodeRuntimeOverrides = Parameters<
+  typeof registerRuntimeConfiguration
+>[1];
+
+export const NODE_DEFAULTS_OVERRIDES: NodeRuntimeOverrides = Object.freeze({
+  PBKDF2: {
+    ALGORITHM: 'sha256',
+  },
+});
+
+let runtimeDefaults: NodeRuntimeConfiguration = registerRuntimeConfiguration(
+  NODE_RUNTIME_CONFIGURATION_KEY,
+  NODE_DEFAULTS_OVERRIDES,
+);
+
+export function getNodeRuntimeConfiguration(): NodeRuntimeConfiguration {
+  return runtimeDefaults;
+}
+
+export function registerNodeRuntimeConfiguration(
+  configOrOverrides?: NodeRuntimeOverrides | NodeRuntimeConfiguration,
+  options?: Parameters<typeof registerRuntimeConfiguration>[2],
+): NodeRuntimeConfiguration {
+  runtimeDefaults = registerRuntimeConfiguration(
+    NODE_RUNTIME_CONFIGURATION_KEY,
+    configOrOverrides,
+    options,
+  );
+  return runtimeDefaults;
+}
+
+export const CHECKSUM: IChecksumConsts = runtimeDefaults.CHECKSUM;
+
+export const KEYRING: IKeyringConsts = Object.freeze({
+  ALGORITHM: 'aes' as const,
+  KEY_BITS: 256 as const,
+  MODE: 'gcm' as const,
+} as const);
+
+export const PBKDF2: IPBkdf2Consts = runtimeDefaults.PBKDF2;
+
+export const PBKDF2_PROFILES: PbkdfProfiles = Object.freeze({
+  // Align browser password profile with high security expectations (sha512, 64-byte salt/hash, 2M iterations)
+  [NodePbkdf2ProfileEnum.BROWSER_PASSWORD]: Object.freeze({
+    saltBytes: 64,
+    iterations: 2000000,
+    algorithm: 'sha512',
+    hashBytes: 64,
+  }),
+  // High security profile (sha512, 64-byte salt/hash, 2M iterations)
+  [NodePbkdf2ProfileEnum.HIGH_SECURITY]: Object.freeze({
+    saltBytes: 64,
+    iterations: 2000000,
+    algorithm: 'sha512',
+    hashBytes: 64,
+  }),
+  // Fast test profile (small salt and iterations for speed)
+  [NodePbkdf2ProfileEnum.TEST_FAST]: Object.freeze({
+    saltBytes: 16,
+    iterations: 500,
+    algorithm: 'sha256',
+    hashBytes: 32,
+  }),
+  [NodePbkdf2ProfileEnum.USER_LOGIN]: Object.freeze({
+    saltBytes: 32,
+    iterations: 1304000,
+    algorithm: 'sha256',
+    hashBytes: 32,
+  }),
+  [NodePbkdf2ProfileEnum.KEY_WRAPPING]: Object.freeze({
+    saltBytes: 32,
+    iterations: 100000,
+    algorithm: 'sha256',
+    hashBytes: 32,
+  }),
+  [NodePbkdf2ProfileEnum.BACKUP_CODES]: Object.freeze({
+    saltBytes: 32,
+    iterations: 1304000,
+    algorithm: 'sha256',
+    hashBytes: 32,
+  }),
+} as const);
+
+export const WRAPPED_KEY: IWrappedKeyConsts = Object.freeze({
+  SALT_SIZE: PBKDF2.SALT_BYTES, // Use PBKDF2 standard salt size
+  IV_SIZE: 16 as const,
+  MASTER_KEY_SIZE: 32 as const,
+  MIN_ITERATIONS: 100000 as const, // Keep lower for key-wrapping operations
+} as const);
+
+export const KEYRING_ALGORITHM_CONFIGURATION =
+  `${KEYRING.ALGORITHM}-${KEYRING.KEY_BITS}-${KEYRING.MODE}` as CipherGCMTypes;
+
+/**
+ * Constants for encrypted data
+ */
+export const ENCRYPTION: IEncryptionConsts = Object.freeze({
+  ENCRYPTION_TYPE_SIZE: 1 as const,
+  RECIPIENT_ID_SIZE: GUID_SIZE,
+} as const);
+
+const objectIdLength = Buffer.from(new ObjectId().toHexString(), 'hex').length;
+export const Constants: IConstants = Object.freeze({
+  ...BaseConstants,
+  /**
+   * The length of a raw object ID (not the hex string representation)
+   */
+  OBJECT_ID_LENGTH: objectIdLength,
+  /**
+   * PBKDF2 constants
+   */
+  PBKDF2: PBKDF2,
+  /**
+   * PBKDF2 configuration profiles
+   */
+  PBKDF2_PROFILES: PBKDF2_PROFILES,
+  /**
+   * Key Wrapping Service constants
+   */
+  WRAPPED_KEY: WRAPPED_KEY,
+  /**
+   * Checksum constants used for data integrity
+   */
+  CHECKSUM: CHECKSUM,
+  /**
+   * Keyring constants used for key management
+   */
+  KEYRING: KEYRING,
+  /**
+   * Encryption constants used for encrypted data
+   */
+  ENCRYPTION: ENCRYPTION,
+  /**
+   * Algorithm configuration string for keyring operations
+   */
+  KEYRING_ALGORITHM_CONFIGURATION: KEYRING_ALGORITHM_CONFIGURATION,
+  PasswordRegex: runtimeDefaults.PasswordRegex,
+  MnemonicRegex: runtimeDefaults.MnemonicRegex,
+} as const);
+
+if (
+  CHECKSUM.SHA3_BUFFER_LENGTH !== CHECKSUM.SHA3_DEFAULT_HASH_BITS / 8 ||
+  CHECKSUM.SHA3_BUFFER_LENGTH !== CHECKSUM.SHA3_DEFAULT_HASH_BITS / 8
+) {
+  const pluginEngine = getEciesPluginI18nEngine();
+  throw new Error(pluginEngine.translate(NodeEciesComponentId, NodeEciesStringKey.Error_InvalidChecksumConstants));
+}
+
+if (objectIdLength !== 12) {
+  console.warn(
+    'ObjectID length may have changed, breaking encryption',
+    objectIdLength,
+  );
+}

package/src/enumerations/index.ts

@@ -0,0 +1 @@
+export * from './pbkdf2-profile';

package/src/enumerations/pbkdf2-profile.ts

@@ -0,0 +1,8 @@
+export enum Pbkdf2ProfileEnum {
+  USER_LOGIN = 'USER_LOGIN',
+  KEY_WRAPPING = 'KEY_WRAPPING',
+  BACKUP_CODES = 'BACKUP_CODES',
+  HIGH_SECURITY = 'HIGH_SECURITY',
+  BROWSER_PASSWORD = 'BROWSER_PASSWORD',
+  TEST_FAST = 'TEST_FAST',
+}