react-native-quick-crypto 0.7.3 → 1.0.0-beta.2

package/nitrogen/generated/ios/QuickCrypto-Swift-Cxx-Umbrella.hpp

@@ -0,0 +1,29 @@
+///
+/// QuickCrypto-Swift-Cxx-Umbrella.hpp
+/// Tue Aug 13 2024
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/react-native-nitro
+/// Copyright © 2024 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+// Forward declarations of C++ defined types
+// Forward declaration of `ArrayBuffer` to properly resolve imports.
+namespace NitroModules { class ArrayBuffer; }
+
+// Include C++ defined types
+#include <NitroModules/ArrayBuffer.hpp>
+
+// C++ helpers for Swift
+#include "QuickCrypto-Swift-Cxx-Bridge.hpp"
+
+// Forward declarations of Swift defined types
+
+
+// Include Swift defined types
+#if __has_include("QuickCrypto-Swift.h")
+#include "QuickCrypto-Swift.h"
+#else
+#error QuickCrypto's autogenerated Swift header cannot be found! Make sure the Swift module's name is actually "QuickCrypto", and try building the app first.
+#endif

package/nitrogen/generated/shared/c++/HybridRandomSpec.cpp

@@ -0,0 +1,23 @@
+///
+/// HybridRandomSpec.cpp
+/// Tue Aug 13 2024
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/react-native-nitro
+/// Copyright © 2024 Marc Rousavy @ Margelo
+///
+
+#include "HybridRandomSpec.hpp"
+
+namespace margelo::nitro::crypto {
+
+  void HybridRandomSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("randomFill", &HybridRandomSpec::randomFill);
+      prototype.registerHybridMethod("randomFillSync", &HybridRandomSpec::randomFillSync);
+    });
+  }
+
+} // namespace margelo::nitro::crypto

package/nitrogen/generated/shared/c++/HybridRandomSpec.hpp

@@ -0,0 +1,62 @@
+///
+/// HybridRandomSpec.hpp
+/// Tue Aug 13 2024
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/react-native-nitro
+/// Copyright © 2024 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `ArrayBuffer` to properly resolve imports.
+namespace NitroModules { class ArrayBuffer; }
+
+#include <NitroModules/ArrayBuffer.hpp>
+
+namespace margelo::nitro::crypto {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `Random`
+   * Inherit this class to create instances of `HybridRandomSpec` in C++.
+   * @example
+   * ```cpp
+   * class HybridRandom: public HybridRandomSpec {
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridRandomSpec: public HybridObject {
+    public:
+      // Constructor
+      explicit HybridRandomSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridRandomSpec() { }
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual std::future<std::shared_ptr<ArrayBuffer>> randomFill(const std::shared_ptr<ArrayBuffer>& buffer, double offset, double size) = 0;
+      virtual std::shared_ptr<ArrayBuffer> randomFillSync(const std::shared_ptr<ArrayBuffer>& buffer, double offset, double size) = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "Random";
+  };
+
+} // namespace margelo::nitro::crypto

package/package.json

@@ -1,40 +1,41 @@
 {
   "name": "react-native-quick-crypto",
-  "version": "0.7.3",
+  "version": "1.0.0-beta.2",
   "description": "A fast implementation of Node's `crypto` module written in C/C++ JSI",
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
+  "type": "module",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
   "types": "lib/typescript/index.d.ts",
-  "react-native": "lib/module/index",
+  "react-native": "src/index",
   "source": "src/index",
   "files": [
     "src",
     "lib",
-    "android/src",
     "android/build.gradle",
     "android/gradle.properties",
     "android/CMakeLists.txt",
+    "android/src",
     "ios",
     "cpp",
-    "react-native-quick-crypto.podspec",
-    "!lib/typescript/example",
-    "!android/build",
-    "!ios/build",
+    "nitrogen",
+    "react-native.config.js",
+    "app.plugin.js",
+    "*.podspec",
+    "README.md",
     "!**/__tests__",
     "!**/__fixtures__",
     "!**/__mocks__"
   ],
   "scripts": {
+    "clean": "del-cli lib",
     "tsc": "tsc --noEmit",
     "typescript": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepare": "bob build",
-    "release": "release-it",
-    "example": "cd example && bun start",
-    "pods": "cd example && bun install && bun pods",
-    "bootstrap": "bun install && bun pods && bun example",
-    "test": "jest"
+    "lint-fix": "eslint \"**/*.{js,ts,tsx}\" --fix",
+    "prepare": "bun clean && bob build",
+    "release-it": "bun prepare && release-it",
+    "test": "jest",
+    "postinstall": "bun tsc"
   },
   "keywords": [
     "react-native",
@@ -50,7 +51,10 @@
     "type": "git",
     "url": "git+https://github.com/margelo/react-native-quick-crypto.git"
   },
-  "authors": "Szymon Kapała (szymon20000@gmail.com) & Marc Rousavy <me@mrousavy.com> (https://github.com/mrousavy)",
+  "authors": [
+    "Szymon Kapała <szymon20000@gmail.com>",
+    "Marc Rousavy <me@mrousavy.com> (https://github.com/mrousavy)"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/margelo/react-native-quick-crypto/issues"
@@ -60,109 +64,48 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@craftzdog/react-native-buffer": "^6.0.5",
-    "events": "^3.3.0",
-    "readable-stream": "^4.5.2",
-    "string_decoder": "^1.3.0",
-    "util": "^0.12.5"
+    "@craftzdog/react-native-buffer": "6.0.5",
+    "events": "3.3.0",
+    "react-native-nitro-modules": "0.4.0",
+    "react-native-quick-base64": "2.1.2",
+    "readable-stream": "4.5.2",
+    "string_decoder": "1.3.0",
+    "util": "0.12.5"
   },
   "devDependencies": {
-    "@jamesacarr/eslint-formatter-github-actions": "^0.2.0",
-    "@react-native/babel-preset": "^0.75.0-main",
-    "@react-native/eslint-config": "^0.75.0-main",
-    "@react-native/eslint-plugin": "^0.75.0-main",
-    "@release-it/conventional-changelog": "^8.0.1",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^22.0.0",
-    "@types/react": "^18.0.33",
-    "@types/readable-stream": "^4.0.11",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "react": "^18.2.0",
-    "react-native": "^0.72.7",
-    "react-native-builder-bob": "^0.29.0",
-    "release-it": "^17.2.0",
-    "sscrypto": "^1.1.1",
-    "typescript": "^5.1.6"
+    "@eslint/compat": "^1.1.1",
+    "@eslint/js": "10.0.0",
+    "@release-it/bumper": "6.0.1",
+    "@types/jest": "29.5.11",
+    "@types/node": "22.0.0",
+    "@types/react": "18.3.3",
+    "@types/readable-stream": "4.0.11",
+    "del-cli": "5.1.0",
+    "eslint": "9.9.0",
+    "eslint-plugin-react-native": "^4.1.0",
+    "jest": "29.7.0",
+    "nitro-codegen": "0.4.0",
+    "prettier": "3.2.5",
+    "react": "18.3.1",
+    "react-native": "0.74.5",
+    "react-native-builder-bob": "0.29.1",
+    "release-it": "17.6.0",
+    "typescript": "5.1.6",
+    "typescript-eslint": "^8.1.0"
   },
   "peerDependencies": {
     "react": "*",
     "react-native": "*"
   },
   "release-it": {
-    "git": {
-      "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
-    },
     "npm": {
       "publish": true
     },
+    "git": false,
     "github": {
-      "release": true
+      "release": false
     },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": {
-          "name": "conventionalcommits",
-          "types": [
-            {
-              "type": "feat",
-              "section": "✨ Features"
-            },
-            {
-              "type": "fix",
-              "section": "🐛 Bug Fixes"
-            },
-            {
-              "type": "perf",
-              "section": "💨 Performance Improvements"
-            },
-            {
-              "type": "chore(deps)",
-              "section": "🛠️ Dependency Upgrades"
-            },
-            {
-              "type": "docs",
-              "section": "📚 Documentation"
-            }
-          ]
-        }
-      }
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "@react-native",
-      "prettier"
-    ],
-    "rules": {
-      "no-dupe-class-members": "off",
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/"
-  ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
+    "plugins": {}
   },
   "react-native-builder-bob": {
     "source": "src",
@@ -173,7 +116,8 @@
       [
         "typescript",
         {
-          "project": "tsconfig.json"
+          "project": "tsconfig.json",
+          "tsc": "../../node_modules/.bin/tsc"
         }
       ]
     ]

package/src/index.ts

@@ -1,58 +1,45 @@
+// polyfill imports
 import { Buffer } from '@craftzdog/react-native-buffer';
-import * as pbkdf2 from './pbkdf2';
+
+// API imports
 import * as random from './random';
-import {
-  createCipher,
-  createCipheriv,
-  createDecipher,
-  createDecipheriv,
-  publicEncrypt,
-  publicDecrypt,
-  privateDecrypt,
-  generateKeyPair,
-  generateKeyPairSync,
-} from './Cipher';
-import { generateKey, generateKeySync } from './keygen';
-import { createSign, createVerify } from './sig';
-import { createHmac } from './Hmac';
-import { createHash } from './Hash';
-import { constants } from './constants';
-import { subtle } from './subtle';
-import { getCiphers, getHashes } from './Utils';
-import webcrypto from './webcrypto';
-import { createPrivateKey, createPublicKey, createSecretKey } from './keys';
+
+// utils import
+import { utils } from './utils';
 
 /**
- * Loosely matches Node.js {crypto} with some unimplemented functionality
+ * Loosely matches Node.js {crypto} with some unimplemented functionality.
+ * See `docs/implementation-coverage.md` for status.
  */
 const QuickCrypto = {
-  createHmac,
-  Hmac: createHmac,
-  Hash: createHash,
-  createHash,
-  createCipher,
-  createCipheriv,
-  createDecipher,
-  createDecipheriv,
-  createPublicKey,
-  createPrivateKey,
-  createSecretKey,
-  publicEncrypt,
-  publicDecrypt,
-  privateDecrypt,
-  generateKey,
-  generateKeyPair,
-  generateKeyPairSync,
-  generateKeySync,
-  createSign,
-  createVerify,
-  subtle,
-  constants,
-  ...pbkdf2,
+  // createHmac,
+  // Hmac: createHmac,
+  // Hash: createHash,
+  // createHash,
+  // createCipher,
+  // createCipheriv,
+  // createDecipher,
+  // createDecipheriv,
+  // createPublicKey,
+  // createPrivateKey,
+  // createSecretKey,
+  // publicEncrypt,
+  // publicDecrypt,
+  // privateDecrypt,
+  // generateKey,
+  // generateKeyPair,
+  // generateKeyPairSync,
+  // generateKeySync,
+  // createSign,
+  // createVerify,
+  // subtle,
+  // constants,
+  // ...pbkdf2,
   ...random,
-  getCiphers,
-  getHashes,
-  webcrypto,
+  // getCiphers,
+  // getHashes,
+  // webcrypto,
+  utils,
 };
 
 /**
@@ -66,6 +53,9 @@ export const install = () => {
   global.crypto = QuickCrypto;
 };
 
+// random, cipher, hash use nextTick
+global.process.nextTick = setImmediate;
+
 export default QuickCrypto;
 
 // Additional exports for CommonJS compatibility

package/src/random.ts

@@ -1,35 +1,43 @@
-import { NativeQuickCrypto } from './NativeQuickCrypto/NativeQuickCrypto';
 import { Buffer } from '@craftzdog/react-native-buffer';
-import type { TypedArray } from './Utils';
-
-const random = NativeQuickCrypto.random;
-
-type ArrayBufferView = TypedArray | DataView | ArrayBufferLike | Buffer;
+import type { ArrayBufferView, RandomCallback } from './utils/types';
+import { abvToArrayBuffer } from './utils/conversion';
+import { NitroModules } from 'react-native-nitro-modules';
+import type { Random } from './specs/random.nitro';
+
+// to use native bits in sub-functions, use getNative(). don't call it at top-level!
+let random: Random;
+function getNative(): Random {
+  if (random == null) {
+    // lazy-load the Nitro HybridObject
+    random = NitroModules.createHybridObject<Random>('Random');
+  }
+  return random;
+}
 
 export function randomFill<T extends ArrayBufferView>(
   buffer: T,
-  callback: (err: Error | null, buf: T) => void
+  callback: RandomCallback<T>
 ): void;
 
 export function randomFill<T extends ArrayBufferView>(
   buffer: T,
   offset: number,
-  callback: (err: Error | null, buf: T) => void
+  callback: RandomCallback<T>
 ): void;
 
 export function randomFill<T extends ArrayBufferView>(
   buffer: T,
   offset: number,
   size: number,
-  callback: (err: Error | null, buf: T) => void
+  callback: RandomCallback<T>
 ): void;
 
-export function randomFill(buffer: any, ...rest: any[]): void {
+export function randomFill(buffer: ArrayBufferView, ...rest: unknown[]): void {
   if (typeof rest[rest.length - 1] !== 'function') {
     throw new Error('No callback provided to randomFill');
   }
 
-  const callback = rest[rest.length - 1] as any as (
+  const callback = rest[rest.length - 1] as unknown as (
     err: Error | null,
     buf?: ArrayBuffer
   ) => void;
@@ -38,32 +46,23 @@ export function randomFill(buffer: any, ...rest: any[]): void {
   let size: number = buffer.byteLength;
 
   if (typeof rest[2] === 'function') {
-    offset = rest[0];
-    size = rest[1];
+    offset = rest[0] as number;
+    size = rest[1] as number;
   }
 
   if (typeof rest[1] === 'function') {
-    offset = rest[0];
+    offset = rest[0] as number;
   }
 
-  random
-    .randomFill(
-      Buffer.isBuffer(buffer)
-        ? buffer.buffer
-        : ArrayBuffer.isView(buffer)
-          ? buffer.buffer
-          : buffer,
-      offset,
-      size
-    )
-    .then(
-      () => {
-        callback(null, buffer);
-      },
-      (e: Error) => {
-        callback(e);
-      }
-    );
+  getNative();
+  random.randomFill(abvToArrayBuffer(buffer), offset, size).then(
+    (res: ArrayBuffer) => {
+      callback(null, res);
+    },
+    (e: Error) => {
+      callback(e);
+    }
+  );
 }
 
 export function randomFillSync<T extends ArrayBufferView>(
@@ -72,12 +71,15 @@ export function randomFillSync<T extends ArrayBufferView>(
   size?: number
 ): T;
 
-export function randomFillSync(buffer: any, offset: number = 0, size?: number) {
-  random.randomFillSync(
-    buffer.buffer ? buffer.buffer : buffer,
-    offset,
-    size ?? buffer.byteLength
-  );
+export function randomFillSync(
+  buffer: ArrayBufferView,
+  offset: number = 0,
+  size?: number
+) {
+  getNative();
+  buffer = abvToArrayBuffer(buffer);
+  const res = random.randomFillSync(buffer, offset, size ?? buffer.byteLength);
+  buffer = res;
   return buffer;
 }
 
@@ -99,11 +101,11 @@ export function randomBytes(
     return buf;
   }
 
-  randomFill(buf.buffer, 0, size, (error: Error | null) => {
+  randomFill(buf.buffer, 0, size, (error: Error | null, res: ArrayBuffer) => {
     if (error) {
       callback(error);
     }
-    callback(null, buf);
+    callback(null, Buffer.from(res));
   });
 }
 
@@ -126,7 +128,7 @@ const RAND_MAX = 0xffffffffffff;
 
 // Cache random data to use in randomInt. The cache size must be evenly
 // divisible by 6 because each attempt to obtain a random int uses 6 bytes.
-const randomCache = new Buffer(6 * 1024);
+let randomCache = new Buffer(6 * 1024);
 let randomCacheOffset = randomCache.length;
 let asyncCacheFillInProgress = false;
 const asyncCachePendingTasks: Task[] = [];
@@ -156,12 +158,12 @@ export function randomInt(
     typeof arg2 === 'undefined' || typeof arg2 === 'function';
 
   if (minNotSpecified) {
-    callback = arg2 as any as undefined | RandomIntCallback;
+    callback = arg2 as undefined | RandomIntCallback;
     max = arg1;
     min = 0;
   } else {
     min = arg1;
-    max = arg2 as any as number;
+    max = arg2 as number;
   }
   if (typeof callback !== 'undefined' && typeof callback !== 'function') {
     throw new TypeError('callback must be a function or undefined');
@@ -217,7 +219,7 @@ export function randomInt(
     if (x < randLimit) {
       const n = (x % range) + min;
       if (isSync) return n;
-      process.nextTick(callback as Function, undefined, n);
+      process.nextTick(callback as RandomIntCallback, undefined, n);
       return;
     }
   }
@@ -237,12 +239,15 @@ function asyncRefillRandomIntCache() {
   if (asyncCacheFillInProgress) return;
 
   asyncCacheFillInProgress = true;
-  randomFill(randomCache, (err) => {
+  randomFill(randomCache, (err, res) => {
     asyncCacheFillInProgress = false;
 
     const tasks = asyncCachePendingTasks;
     const errorReceiver = err && tasks.shift();
-    if (!err) randomCacheOffset = 0;
+    if (!err) {
+      randomCache = Buffer.from(res);
+      randomCacheOffset = 0;
+    }
 
     // Restart all pending tasks. If an error occurred, we only notify a single
     // callback (errorReceiver) about it. This way, every async call to
@@ -289,9 +294,7 @@ export function randomUUID() {
   randomFillSync(buffer, 0, size);
 
   // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
-  // eslint-disable-next-line no-bitwise
   buffer[6] = (buffer[6]! & 0x0f) | 0x40;
-  // eslint-disable-next-line no-bitwise
   buffer[8] = (buffer[8]! & 0x3f) | 0x80;
 
   return (

package/src/specs/random.nitro.ts

@@ -0,0 +1,14 @@
+import { type HybridObject } from 'react-native-nitro-modules';
+
+export interface Random extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  randomFill(
+    buffer: ArrayBuffer,
+    offset: number,
+    size: number
+  ): Promise<ArrayBuffer>;
+  randomFillSync(
+    buffer: ArrayBuffer,
+    offset: number,
+    size: number
+  ): ArrayBuffer;
+}

package/src/utils/conversion.ts

@@ -0,0 +1,16 @@
+import { Buffer } from '@craftzdog/react-native-buffer';
+import type { ArrayBufferView } from './types';
+
+export const abvToArrayBuffer = (buffer: ArrayBufferView) => {
+  if (Buffer.isBuffer(buffer)) {
+    return buffer.buffer;
+  }
+  if (ArrayBuffer.isView(buffer)) {
+    return buffer.buffer;
+  }
+  return buffer;
+};
+
+export function ab2str(buf: ArrayBuffer, encoding: string = 'hex') {
+  return Buffer.from(buf).toString(encoding);
+}

package/src/utils/index.ts

@@ -0,0 +1,6 @@
+import { ab2str, abvToArrayBuffer } from "./conversion";
+
+export const utils = {
+  ab2str,
+  abvToArrayBuffer,
+};