@vvlad1973/crypto 2.1.1

package/src/crypto.ts

@@ -0,0 +1,141 @@
+import {
+  createCipheriv,
+  createDecipheriv,
+  randomBytes,
+  pbkdf2Sync,
+} from 'crypto';
+
+/**
+ * Checks if an object is an instance of Crypto.
+ * @param {any} object - The object to check.
+ * @returns {boolean} Returns true if the object is an instance of Crypto, false otherwise.
+ */
+export function isCrypto(object: any): object is Crypto {
+  return (
+    typeof object === 'object' &&
+    object !== null &&
+    typeof object['encrypt'] === 'function' &&
+    typeof object['decrypt'] === 'function'
+  );
+}
+
+/**
+ * Interface representing the set of parameters to create an instance of the Crypto class.
+ * @interface CryptoOptions
+ * @property {string} password - The password used for key derivation.
+ * @property {string} salt - The salt used for key derivation.
+ * @property {string} [algorithm='sha512'] - The hash algorithm to use for key derivation.
+ * @property {number} [iterations=1000] - The number of iterations to use for key derivation.
+ * @property {number} [keyLength=32] - The length of the derived key in bytes.
+ * @property {number|Buffer} [iv] - The initialization vector for the AES encryption.
+ */
+export interface CryptoOptions {
+  password: string;
+  salt: string;
+  algorithm?: string;
+  iterations?: number;
+  keyLength?: number;
+  iv?: number | Buffer;
+}
+
+/**
+ * Class representing a cryptographic utility for encrypting and decrypting text.
+ * @class
+ * @param {string|CryptoOptions} passwordOrOptions - The password used for key derivation or an options object.
+ * @param {string} salt - The salt used for key derivation.
+ * @param {string} [algorithm='sha512'] - The hash algorithm to use for key derivation.
+ * @param {number} [iterations=1000] - The number of iterations to use for key derivation.
+ * @param {number} [keyLength=32] - The length of the derived key in bytes.
+ * @param {number|Buffer} [iv] - The initialization vector for the AES encryption.
+ */
+export class Crypto {
+  private iv: Buffer;
+  private key: Buffer;
+
+  constructor(
+    password: string,
+    salt: string,
+    algorithm?: string,
+    iterations?: number,
+    keyLength?: number,
+    iv?: number | Buffer
+  );
+  constructor(options: CryptoOptions);
+
+  constructor(
+    passwordOrOptions: string | CryptoOptions,
+    salt?: string,
+    algorithm: string = 'sha512',
+    iterations: number = 1000,
+    keyLength: number = 32,
+    iv: number | Buffer = randomBytes(16)
+  ) {
+    let password: string;
+
+    if (typeof passwordOrOptions === 'string') {
+      password = passwordOrOptions;
+      this.iv = typeof iv === 'number' ? this.convertNumberToIV(iv) : iv;
+    } else {
+      ({
+        password,
+        salt,
+        algorithm = 'sha512',
+        iterations = 1000,
+        keyLength = 32,
+        iv = randomBytes(16),
+      } = passwordOrOptions);
+      this.iv =
+        typeof passwordOrOptions.iv === 'number'
+          ? this.convertNumberToIV(passwordOrOptions.iv)
+          : passwordOrOptions.iv ?? randomBytes(16);
+    }
+
+    this.key = pbkdf2Sync(password, salt!, iterations, keyLength, algorithm);
+  }
+
+  private convertNumberToIV(iv: number): Buffer {
+    // Создаем Buffer размером 16 байт, заполняя его значением iv
+    const buffer = Buffer.alloc(16);
+    buffer.writeUInt32BE(iv, 12); // Записываем iv в последний 4 байта Buffer'а
+    return buffer;
+  }
+
+  /**
+   * Encrypt a text string.
+   * @param {string} text - The plain text to encrypt.
+   * @returns {string} The encrypted text as a hex string.
+   */
+  public encrypt(text: string): string {
+    const cipher = createCipheriv('aes-256-ctr', this.key, this.iv);
+    const encrypted = Buffer.concat([
+      cipher.update(text, 'utf8'),
+      cipher.final(),
+    ]);
+    return encrypted.toString('hex');
+  }
+
+  /**
+   * Decrypt an encrypted text string.
+   * @param {string} text - The encrypted text as a hex string.
+   * @returns {string} The decrypted plain text.
+   */
+  public decrypt(text: string): string {
+    const encryptedText = Buffer.from(text, 'hex');
+    const decipher = createDecipheriv('aes-256-ctr', this.key, this.iv);
+    const decrypted = Buffer.concat([
+      decipher.update(encryptedText),
+      decipher.final(),
+    ]);
+    return decrypted.toString('utf8');
+  }
+
+  /**
+   * Returns a UUID ver.4 string.
+   * @returns {string} UUID ver.4 string.
+   */
+  public static getUUID(): string {
+    return crypto.randomUUID();
+  }
+}
+
+export default Crypto;

package/src/index.ts

@@ -0,0 +1,2 @@
+export { default } from './crypto.js';
+export * from './crypto.js';

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "outDir": "./dist",
+    "declaration": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "./src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "coverage",
+    "docs"
+  ]
+}

package/typedoc.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "out": "docs",
+  "exclude": ["**/__tests__/**"],
+  "excludePrivate": true,
+  "excludeProtected": false,
+  "excludeExternals": true,
+  "readme": "README.md",
+  "name": "@vvlad1973/crypto",
+  "includeVersion": true,
+  "sort": ["source-order"],
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": true
+  },
+  "plugin": []
+}

package/vitest.config.ts

@@ -0,0 +1,36 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  resolve: {
+    extensions: ['.ts', '.js']
+  },
+  test: {
+    environment: 'node',
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'html', 'lcov', 'json'],
+      reportsDirectory: './coverage',
+      clean: true,
+      exclude: [
+        'node_modules/**',
+        'dist/**',
+        'docs/**',
+        'coverage/**',
+        '**/__tests__/**',
+        '**/*.test.ts',
+        '**/*.spec.ts',
+        '**/*.config.ts',
+        '**/index.ts'
+      ],
+      include: ['src/crypto.ts'],
+      thresholds: {
+        lines: 90,
+        functions: 85,
+        branches: 90,
+        statements: 90
+      }
+    },
+    include: ['src/**/__tests__/**/*.test.ts'],
+    exclude: ['node_modules', 'dist', 'docs']
+  }
+});