react-native-quick-crypto 0.3.1 → 0.4.1

package/README.md

@@ -9,11 +9,10 @@ A fast implementation of Node's `crypto` module.
 Unlike any other current JS-based polyfills, react-native-quick-crypto is written in C/C++ JSI and provides much greater performance - especially on mobile devices.
 QuickCrypto can be used as a drop-in replacement for your Web3/Crypto apps to speed up common cryptography functions.
 
-* 🏎️ Up to 300x faster than all other solutions
+* 🏎️ Up to 58x faster than all other solutions
 * ⚡️ Lightning fast implementation with pure C++ and JSI, instead of JS
 * 🧪 Well tested in JS and C++ (OpenSSL)
 * 💰 Made for crypto apps and Wallets
-* 🤌 Up to 5x smaller in JS-bundle size
 * 🔢 Secure native compiled cryptography
 * 🔁 Easy drop-in replacement for [crypto-browserify](https://github.com/crypto-browserify/crypto-browserify) or [react-native-crypto](https://github.com/tradle/react-native-crypto)
 
@@ -23,19 +22,19 @@ For example, creating a Wallet using ethers.js uses complex algorithms to genera
 const start = performance.now()
 const wallet = ethers.Wallet.createRandom()
 const end = performance.now()
-console.log(`Creating a Wallet took ${end - start}ms.`)
+console.log(`Creating a Wallet took ${end - start} ms.`)
 ```
 
 **Without** react-native-crypto 🐢:
 
 ```
-Creating a Wallet took xxxms
+Creating a Wallet took 16862 ms
 ```
 
 **With** react-native-crypto ⚡️:
 
 ```
-Creating a Wallet took yyyms
+Creating a Wallet took 289 ms
 ```
 
 ---
@@ -89,7 +88,12 @@ Now, all imports for `crypto` will be resolved as `react-native-quick-crypto` in
 
 ## Sponsors
 
-- TODO: List sponsors here
+<div align="center">
+
+<img width="350" src="./img/sponsors/litentry.png" align="center"><br/>
+<a href="https://litentry.com"><b>Litentry</b></a> - A decentralized identity aggregator, providing the structure and tools to empower you and your identity.
+
+</div>
 
 ## Limitations
 

package/android/CMakeLists.txt

@@ -6,8 +6,8 @@ file (GLOB LIBFBJNI_INCLUDES "${BUILD_DIR}/fbjni-*-headers.jar/")
 file (GLOB LIBRN_SO "${BUILD_DIR}/react-native-0*/jni/${ANDROID_ABI}")
 set (CMAKE_CXX_STANDARD 17)
 # TODO(osp) remove before release
-set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -g")
-set (CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g")
+#set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -g")
+#set (CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g")
 
 include_directories(
         ../cpp
@@ -48,6 +48,14 @@ add_library(reactnativequickcrypto  # <-- Library name
         "../cpp/Cipher/MGLCipherHostObject.cpp"
         "../cpp/Cipher/MGLCreateCipherInstaller.cpp"
         "../cpp/Cipher/MGLCreateDecipherInstaller.cpp"
+        "../cpp/MGLKeys.cpp"
+        "../cpp/Utils/MGLUtils.cpp"
+        "../cpp/Cipher/MGLRsa.cpp"
+        "../cpp/Cipher/MGLGenerateKeyPairInstaller.cpp"
+        "../cpp/Cipher/MGLGenerateKeyPairSyncInstaller.cpp"
+        "../cpp/Sig/MGLSignInstaller.cpp"
+        "../cpp/Sig/MGLVerifyInstaller.cpp"
+        "../cpp/Sig/MGLSignHostObjects.cpp"
         ${INCLUDE_JSI_CPP} # only on older RN versions
 )
 

package/android/gradle.properties

@@ -3,4 +3,4 @@ QuickCrypto_buildToolsVersion=30.0.2
 QuickCrypto_targetSdkVersion=30
 android.useAndroidX=true
 # Enables Prefab
-android.enablePrefab=true
+#android.enablePrefab=true

package/android/src/main/AndroidManifest.xml

@@ -1,4 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.reactnativebignumber">
+          package="com.margelo.quickcrypto">
 
 </manifest>

package/android/src/main/cpp/cpp-adapter.cpp

@@ -10,7 +10,7 @@ using namespace facebook;
 class CryptoCppAdapter : public jni::HybridClass<CryptoCppAdapter> {
  public:
   static auto constexpr kJavaDescriptor =
-      "Lcom/reactnativequickcrypto/QuickCryptoModule;";
+      "Lcom/margelo/quickcrypto/QuickCryptoModule;";
 
   static jni::local_ref<jni::HybridClass<CryptoCppAdapter>::jhybriddata>
   initHybrid(jni::alias_ref<jhybridobject> jThis) {

package/android/src/main/java/com/margelo/quickcrypto/QuickCryptoModule.java

@@ -0,0 +1,70 @@
+package com.margelo.quickcrypto;
+
+import android.util.Log;
+
+import androidx.annotation.NonNull;
+
+import com.facebook.jni.HybridData;
+import com.facebook.proguard.annotations.DoNotStrip;
+import com.facebook.react.bridge.JavaScriptContextHolder;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.module.annotations.ReactModule;
+import com.facebook.react.turbomodule.core.CallInvokerHolderImpl;
+
+@ReactModule(name = QuickCryptoModule.NAME)
+public class QuickCryptoModule extends ReactContextBaseJavaModule {
+  public static final String NAME = "QuickCrypto";
+
+  @DoNotStrip
+  private HybridData mHybridData;
+
+  private native HybridData initHybrid();
+
+  public QuickCryptoModule(ReactApplicationContext reactContext) {
+    super(reactContext);
+  }
+
+  @NonNull
+  @Override
+  public String getName() {
+    return NAME;
+  }
+
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  public boolean install() {
+    try {
+      if (mHybridData != null) {
+        return false;
+      }
+      Log.i(NAME, "Loading C++ library...");
+      System.loadLibrary("reactnativequickcrypto");
+
+      JavaScriptContextHolder jsContext = getReactApplicationContext().getJavaScriptContextHolder();
+      CallInvokerHolderImpl jsCallInvokerHolder = (CallInvokerHolderImpl) getReactApplicationContext()
+                                                  .getCatalystInstance()
+                                                  .getJSCallInvokerHolder();
+
+
+      Log.i(NAME, "Installing JSI Bindings for react-native-quick-crypto...");
+      mHybridData = initHybrid();
+      nativeInstall(jsContext.get(), jsCallInvokerHolder);
+      Log.i(NAME, "Successfully installed JSI Bindings for react-native-quick-crypto!");
+
+      return true;
+    } catch (Exception exception) {
+      Log.e(NAME, "Failed to install JSI Bindings for react-native-quick-crypto!", exception);
+      return false;
+    }
+  }
+
+  public void destroy() {
+    if (mHybridData == null) {
+      return;
+    }
+    mHybridData.resetNative();
+  }
+
+  private native void nativeInstall(long jsiPtr, CallInvokerHolderImpl jsCallInvokerHolder);
+}

package/android/src/main/java/com/{reactnativequickcrypto → margelo/quickcrypto}/QuickCryptoPackage.java

@@ -1,4 +1,4 @@
-package com.reactnativequickcrypto;
+package com.margelo.quickcrypto;
 
 import androidx.annotation.NonNull;
 
@@ -10,17 +10,16 @@ import com.facebook.react.uimanager.ViewManager;
 import java.util.Collections;
 import java.util.List;
 
-
 public class QuickCryptoPackage implements ReactPackage {
-@NonNull
-@Override
-public List<NativeModule> createNativeModules(@NonNull ReactApplicationContext reactContext) {
-  return Collections.singletonList(new QuickCryptoModule(reactContext));
-}
+  @NonNull
+  @Override
+  public List<NativeModule> createNativeModules(@NonNull ReactApplicationContext reactContext) {
+    return Collections.singletonList(new QuickCryptoModule(reactContext));
+  }
 
-@NonNull
-@Override
-public List<ViewManager> createViewManagers(@NonNull ReactApplicationContext reactContext) {
-  return Collections.emptyList();
-}
+  @NonNull
+  @Override
+  public List<ViewManager> createViewManagers(@NonNull ReactApplicationContext reactContext) {
+    return Collections.emptyList();
+  }
 }

package/cpp/Cipher/MGLCipherHostObject.cpp

@@ -252,7 +252,7 @@ void MGLCipherHostObject::installMethods() {
           // On the node version there are several layers of wrapping and errors
           // are not immediately surfaced On our version we can simply throw an
           // error as soon as something goes wrong
-          throw jsi::JSError(runtime, 'kErrorState');
+          throw jsi::JSError(runtime, "kErrorState");
         }
 
         const int mode = EVP_CIPHER_CTX_mode(ctx_);
@@ -502,10 +502,9 @@ void MGLCipherHostObject::installMethods() {
         }
 
         if (!is_valid) {
-          jsi::detail::throwJSError(
-              runtime, "Invalid authentication tag length" + tag_len);
-          throw jsi::JSError(runtime,
-                             "Invalid authentication tag length: " + tag_len);
+          jsi::detail::throwJSError(runtime,
+                                    "Invalid authentication tag length");
+          throw jsi::JSError(runtime, "Invalid authentication tag length");
         }
 
         auth_tag_len_ = tag_len;

package/cpp/Cipher/MGLCreateCipherInstaller.cpp

@@ -3,14 +3,12 @@
 
 #include <memory>
 
+#include "MGLCipherHostObject.h"
 #ifdef ANDROID
 #include "JSIUtils/MGLJSIMacros.h"
 #else
 #include "MGLJSIMacros.h"
 #endif
-#include "MGLCipherHostObject.h"
-
-using namespace facebook;
 
 namespace margelo {
 

package/cpp/Cipher/MGLGenerateKeyPairInstaller.h

@@ -13,14 +13,17 @@
 
 #include <memory>
 
+#include "MGLKeys.h"
+
 #ifdef ANDROID
+#include "Cipher/MGLRsa.h"
 #include "JSIUtils/MGLSmartHostObject.h"
+#include "Utils/MGLUtils.h"
 #else
-#include "MGLSmartHostObject.h"
-#endif
-#include "MGLCipherKeys.h"
 #include "MGLRsa.h"
+#include "MGLSmartHostObject.h"
 #include "MGLUtils.h"
+#endif
 
 namespace margelo {
 

package/cpp/Cipher/MGLGenerateKeyPairSyncInstaller.h

@@ -13,13 +13,15 @@
 #include <memory>
 
 #ifdef ANDROID
+#include "Cipher/MGLRsa.h"
 #include "JSIUtils/MGLSmartHostObject.h"
+#include "Utils/MGLUtils.h"
 #else
-#include "MGLSmartHostObject.h"
-#endif
-#include "MGLCipherKeys.h"
 #include "MGLRsa.h"
+#include "MGLSmartHostObject.h"
 #include "MGLUtils.h"
+#endif
+#include "MGLKeys.h"
 
 namespace margelo {
 

package/cpp/Cipher/MGLPublicCipher.h

@@ -14,7 +14,7 @@
 #include <optional>
 #include <vector>
 
-#include "MGLCipherKeys.h"
+#include "MGLKeys.h"
 #ifdef ANDROID
 #include "JSIUtils/MGLJSIUtils.h"
 #include "JSIUtils/MGLTypedArray.h"

package/cpp/Cipher/MGLPublicCipherInstaller.h

@@ -18,7 +18,7 @@
 #include <utility>
 #include <vector>
 
-#include "MGLCipherKeys.h"
+#include "MGLKeys.h"
 #include "MGLPublicCipher.h"
 
 #ifdef ANDROID

package/cpp/Cipher/MGLRsa.h

@@ -14,8 +14,12 @@
 #include <optional>
 #include <utility>
 
-#include "MGLCipherKeys.h"
+#include "MGLKeys.h"
+#ifdef ANDROID
+#include "Utils/MGLUtils.h"
+#else
 #include "MGLUtils.h"
+#endif
 
 namespace margelo {
 

package/cpp/JSIUtils/MGLJSIMacros.h

@@ -1,14 +1,36 @@
-//
-// Created by Szymon on 24/02/2022.
-//
-
 #ifndef MGL_JSIMACROS_H
 #define MGL_JSIMACROS_H
 
 #include <utility>
 
-// if you want to create a new marco use (https://godbolt.org) provide flag -E
-// in right panel
+// Windows 8+ does not like abort() in Release mode
+#ifdef _WIN32
+#define ABORT_NO_BACKTRACE() _exit(134)
+#else
+#define ABORT_NO_BACKTRACE() abort()
+#endif
+
+struct AssertionInfo {
+  const char *file_line;  // filename:line
+  const char *message;
+  const char *function;
+};
+
+inline void Abort() {
+  //  DumpBacktrace(stderr);
+  fflush(stderr);
+  ABORT_NO_BACKTRACE();
+}
+
+inline void Assert(const AssertionInfo &info) {
+  //  std::string name = GetHumanReadableProcessName();
+
+  fprintf(stderr, "%s:%s%s Assertion `%s' failed.\n", info.file_line,
+          info.function, *info.function ? ":" : "", info.message);
+  fflush(stderr);
+
+  Abort();
+}
 
 #define HOST_LAMBDA(name, body) HOST_LAMBDA_CAP(name, [=], body)
 
@@ -34,4 +56,45 @@
           const jsi::Value *arguments, size_t count)          \
       ->jsi::Value
 
+// Macros stolen from Node
+#define ABORT() node::Abort()
+
+#define ERROR_AND_ABORT(expr)                                                 \
+  do {                                                                        \
+    /* Make sure that this struct does not end up in inline code, but      */ \
+    /* rather in a read-only data section when modifying this code.        */ \
+    static const AssertionInfo args = {__FILE__ ":" STRINGIFY(__LINE__),      \
+                                       #expr, PRETTY_FUNCTION_NAME};          \
+    Assert(args);                                                             \
+  } while (0)
+#ifdef __GNUC__
+#define LIKELY(expr) __builtin_expect(!!(expr), 1)
+#define UNLIKELY(expr) __builtin_expect(!!(expr), 0)
+#define PRETTY_FUNCTION_NAME __PRETTY_FUNCTION__
+#else
+#define LIKELY(expr) expr
+#define UNLIKELY(expr) expr
+#define PRETTY_FUNCTION_NAME ""
+#endif
+
+#define STRINGIFY_(x) #x
+#define STRINGIFY(x) STRINGIFY_(x)
+
+#define CHECK(expr)          \
+  do {                       \
+    if (UNLIKELY(!(expr))) { \
+      ERROR_AND_ABORT(expr); \
+    }                        \
+  } while (0)
+
+#define CHECK_EQ(a, b) CHECK((a) == (b))
+#define CHECK_GE(a, b) CHECK((a) >= (b))
+#define CHECK_GT(a, b) CHECK((a) > (b))
+#define CHECK_LE(a, b) CHECK((a) <= (b))
+#define CHECK_LT(a, b) CHECK((a) < (b))
+#define CHECK_NE(a, b) CHECK((a) != (b))
+#define CHECK_NULL(val) CHECK((val) == nullptr)
+#define CHECK_NOT_NULL(val) CHECK((val) != nullptr)
+#define CHECK_IMPLIES(a, b) CHECK(!(a) || (b))
+
 #endif  // MGL_JSIMACROS_H

package/cpp/{Cipher/MGLCipherKeys.cpp → MGLKeys.cpp}

@@ -5,7 +5,7 @@
 //  Created by Oscar on 20.06.22.
 //
 
-#include "MGLCipherKeys.h"
+#include "MGLKeys.h"
 
 #include <jsi/jsi.h>
 #include <openssl/bio.h>
@@ -15,12 +15,16 @@
 #include <utility>
 #include <vector>
 
+#ifdef ANDROID
+#include "JSIUtils/MGLJSIMacros.h"
+#include "JSIUtils/MGLJSIUtils.h"
+#include "JSIUtils/MGLTypedArray.h"
+#include "Utils/MGLUtils.h"
+#else
+#include "MGLJSIMacros.h"
 #include "MGLJSIUtils.h"
 #include "MGLTypedArray.h"
 #include "MGLUtils.h"
-#ifdef ANDROID
-#else
-#include "logs.h"
 #endif
 
 namespace margelo {
@@ -33,8 +37,8 @@ void GetKeyFormatAndTypeFromJs(AsymmetricKeyEncodingConfig* config,
   // During key pair generation, it is possible not to specify a key encoding,
   // which will lead to a key object being returned.
   if (args[*offset].isUndefined()) {
-    //    CHECK_EQ(context, kKeyContextGenerate);
-    //    CHECK(args[*offset + 1].IsUndefined());
+    CHECK_EQ(context, kKeyContextGenerate);
+    CHECK(args[*offset + 1].isUndefined());
     config->output_key_object_ = true;
   } else {
     config->output_key_object_ = false;
@@ -44,16 +48,13 @@ void GetKeyFormatAndTypeFromJs(AsymmetricKeyEncodingConfig* config,
     config->format_ = static_cast<PKFormatType>((int)args[*offset].getNumber());
 
     if (args[*offset + 1].isNumber()) {
-      config->type_ = std::optional<PKEncodingType>(
-          static_cast<PKEncodingType>((int)args[*offset + 1].getNumber()));
+      config->type_ =
+          static_cast<PKEncodingType>((int)args[*offset + 1].getNumber());
     } else {
-      // TODO(osp) implement checks
-      //      CHECK(
-      //            (context == kKeyContextInput &&
-      //             config->format_ == kKeyFormatPEM) ||
-      //            (context == kKeyContextGenerate &&
-      //             config->format_ == kKeyFormatJWK));
-      //      CHECK(args[*offset + 1]->IsNullOrUndefined());
+      CHECK(
+          (context == kKeyContextInput && config->format_ == kKeyFormatPEM) ||
+          (context == kKeyContextGenerate && config->format_ == kKeyFormatJWK));
+      CHECK(args[*offset + 1].isUndefined());
       config->type_ = std::nullopt;
     }
   }
@@ -193,11 +194,10 @@ ParseKeyResult ParsePrivateKey(EVPKeyPointer* pkey,
     pkey->reset(PEM_read_bio_PrivateKey(bio.get(), nullptr, PasswordCallback,
                                         &passphrase));
   } else {
-    //    CHECK_EQ(config.format_, kKeyFormatDER);
+    CHECK_EQ(config.format_, kKeyFormatDER);
 
     if (!config.type_.has_value()) {
-      // TODO(osp) need to implement end of the world exception
-      //      throw new crashing exception
+      throw new std::runtime_error("ParsePrivateKey key config has no type!");
     }
 
     if (config.type_.value() == kKeyEncodingPKCS1) {
@@ -216,7 +216,7 @@ ParseKeyResult ParsePrivateKey(EVPKeyPointer* pkey,
         if (p8inf) pkey->reset(EVP_PKCS82PKEY(p8inf.get()));
       }
     } else {
-      //      CHECK_EQ(config.type_.ToChecked(), kKeyEncodingSEC1);
+      CHECK_EQ(config.type_.value(), kKeyEncodingSEC1);
       const unsigned char* p = reinterpret_cast<const unsigned char*>(key);
       pkey->reset(d2i_PrivateKey(EVP_PKEY_EC, nullptr, &p, key_len));
     }
@@ -692,36 +692,34 @@ PublicKeyEncodingConfig ManagedEVPPKey::GetPublicKeyEncodingFromJs(
   return result;
 }
 
-// TODO(osp) I never quite manage to figure out whether this is really necessary
-// maybe is other crypto function, leaving it for future uncommenting
-// ManagedEVPPKey ManagedEVPPKey::GetPrivateKeyFromJs(
-//                                                   const
-//                                                   FunctionCallbackInfo<Value>&
-//                                                   args, unsigned int*
-//                                                   offset, bool
-//                                                   allow_key_object) {
-//  if (args[*offset]->IsString() || IsAnyByteSource(args[*offset])) {
-//    Environment* env = Environment::GetCurrent(args);
-//    ByteSource key = ByteSource::FromStringOrBuffer(env, args[(*offset)++]);
-//    NonCopyableMaybe<PrivateKeyEncodingConfig> config =
-//    GetPrivateKeyEncodingFromJs(args, offset, kKeyContextInput);
-//    if (config.IsEmpty())
-//      return ManagedEVPPKey();
-//
-//    EVPKeyPointer pkey;
-//    ParseKeyResult ret =
-//    ParsePrivateKey(&pkey, config.Release(), key.data<char>(), key.size());
-//    return GetParsedKey(env, std::move(pkey), ret,
-//                        "Failed to read private key");
-//  } else {
-//    CHECK(args[*offset]->IsObject() && allow_key_object);
-//    KeyObjectHandle* key;
-//    ASSIGN_OR_RETURN_UNWRAP(&key, args[*offset].As<Object>(),
-//    ManagedEVPPKey()); CHECK_EQ(key->Data()->GetKeyType(), kKeyTypePrivate);
-//    (*offset) += 4;
-//    return key->Data()->GetAsymmetricKey();
-//  }
-//}
+ManagedEVPPKey ManagedEVPPKey::GetPrivateKeyFromJs(jsi::Runtime& runtime,
+                                                   const jsi::Value* args,
+                                                   unsigned int* offset,
+                                                   bool allow_key_object) {
+  if (args[*offset].isString() ||
+      args[*offset].asObject(runtime).isArrayBuffer(runtime)) {
+    ByteSource key = ByteSource::FromStringOrBuffer(runtime, args[*offset]);
+    (*offset)++;
+    NonCopyableMaybe<PrivateKeyEncodingConfig> config =
+        GetPrivateKeyEncodingFromJs(runtime, args, offset, kKeyContextInput);
+    if (config.IsEmpty()) return ManagedEVPPKey();
+
+    EVPKeyPointer pkey;
+    ParseKeyResult ret =
+        ParsePrivateKey(&pkey, config.Release(), key.data<char>(), key.size());
+    return GetParsedKey(runtime, std::move(pkey), ret,
+                        "Failed to read private key");
+  } else {
+    //    CHECK(args[*offset]->IsObject() && allow_key_object);
+    //    KeyObjectHandle* key;
+    //    ASSIGN_OR_RETURN_UNWRAP(&key, args[*offset].As<Object>(),
+    //    ManagedEVPPKey()); CHECK_EQ(key->Data()->GetKeyType(),
+    //    kKeyTypePrivate);
+    //    (*offset) += 4;
+    //    return key->Data()->GetAsymmetricKey();
+    throw jsi::JSError(runtime, "KeyObject are not currently supported");
+  }
+}
 
 ManagedEVPPKey ManagedEVPPKey::GetPublicOrPrivateKeyFromJs(
     jsi::Runtime& runtime, const jsi::Value* args, unsigned int* offset) {