react-native-quick-crypto 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Marc Rousavy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,84 @@
+# ⚡️ react-native-quick-crypto
+
+A fast implementation of Node's `crypto` module written in C/C++ JSI.
+
+QuickCrypto can be used as a drop-in replacement for your Web3/Crypto apps to speed up all cryptography functions.
+
+For example, creating a Wallet using ethers.js uses complex algorithms to generate a private-key/mnemonic-phrase pair:
+
+```ts
+const start = performance.now()
+const wallet = ethers.Wallet.createRandom()
+const end = performance.now()
+console.log(`Creating a Wallet took ${end - start}ms.`)
+```
+
+**Without** react-native-crypto 🐢:
+
+```
+Creating a Wallet took 31.3582738422ms
+```
+
+**With** react-native-crypto ⚡️:
+
+```
+Creating a Wallet took 2.47425001859ms
+```
+
+---
+
+## Installation
+
+### React Native
+
+```sh
+yarn add react-native-quick-crypto
+cd ios && pod install
+```
+
+### Expo
+
+```sh
+expo install react-native-quick-crypto
+expo prebuild
+```
+
+## Usage
+
+In your `metro.config.js`, add a module resolver to replace `crypto` with `react-native-quick-crypto`:
+
+```diff
++const path = require('path');
+
+ module.exports = {
++  resolver: {
++    extraNodeModules: {
++      crypto: path.resolve(__dirname, './node_modules/react-native-quick-crypto'),
++    },
++  },
+   ...
+```
+
+Now, all imports for `crypto` will be resolved as `react-native-quick-crypto` instead.
+
+---
+
+## Sponsors
+
+- TODO: List sponsors here
+
+## Limitations
+
+As the library uses JSI for synchronous native methods access, remote debugging (e.g. with Chrome) is no longer possible. Instead, you should use [Flipper](https://fbflipper.com).
+
+## Adopting at scale
+
+react-native-quick-crypto was built at Margelo, an elite app development agency. For enterprise support or other business inquiries, contact us at <a href="mailto:hello@margelo.io?subject=Adopting react-native-quick-crypto at scale">hello@margelo.io</a>!
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT

package/android/CMakeLists.txt

@@ -0,0 +1,117 @@
+cmake_minimum_required(VERSION 3.9.0)
+
+set (PACKAGE_NAME "react-native-quick-crypto")
+set (BUILD_DIR ${CMAKE_SOURCE_DIR}/build)
+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")
+
+include_directories(
+        ../cpp
+        "${NODE_MODULES_DIR}/react-native/React"
+        "${NODE_MODULES_DIR}/react-native/React/Base"
+        "${NODE_MODULES_DIR}/react-native/ReactAndroid/src/main/jni"
+        "${NODE_MODULES_DIR}/react-native/ReactAndroid/src/main/java/com/facebook/react/turbomodule/core/jni"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/callinvoker"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/jsi"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/turbomodule/core"
+        "${NODE_MODULES_DIR}/react-native/ReactCommon/react/nativemodule/core"
+        "${LIBFBJNI_INCLUDES}"
+)
+
+if(${REACT_NATIVE_VERSION} LESS 66)
+        set (
+                INCLUDE_JSI_CPP
+                "${NODE_MODULES_DIR}/react-native/ReactCommon/jsi/jsi/jsi.cpp"
+        )
+endif()
+
+add_library(reactnativequickcrypto  # <-- Library name
+        SHARED
+        "src/main/cpp/cpp-adapter.cpp"
+        "../cpp/MGLQuickCryptoHostObject.cpp"
+        "../cpp/JSIUtils/MGLTypedArray.cpp"
+        "../cpp/Utils/MGLDispatchQueue.cpp"
+        "../cpp/JSIUtils/MGLThreadAwareHostObject.cpp"
+        "../cpp/JSIUtils/MGLSmartHostObject.cpp"
+        "../cpp/HMAC/MGLHmacInstaller.cpp"
+        "../cpp/HMAC/MGLHmacHostObject.cpp"
+        "../cpp/fastpbkdf2/MGLPbkdf2HostObject.cpp"
+        "../cpp/fastpbkdf2/fastpbkdf2.c"
+        "../cpp/Random/MGLRandomHostObject.cpp"
+        "../cpp/Hash/MGLHashInstaller.cpp"
+        "../cpp/Hash/MGLHashHostObject.cpp"
+        "../cpp/Cipher/MGLCipherHostObject.cpp"
+        "../cpp/Cipher/MGLCreateCipherInstaller.cpp"
+        "../cpp/Cipher/MGLCreateDecipherInstaller.cpp"
+        ${INCLUDE_JSI_CPP} # only on older RN versions
+)
+
+set_target_properties(
+        reactnativequickcrypto PROPERTIES
+        CXX_STANDARD 17
+        CXX_EXTENSIONS OFF
+        POSITION_INDEPENDENT_CODE ON
+)
+
+file (GLOB LIBRN_DIR "${PREBUILT_DIR}/${ANDROID_ABI}")
+
+find_library(
+        log-lib
+        log
+)
+find_library(
+        REACT_NATIVE_JNI_LIB
+        reactnativejni
+        PATHS ${LIBRN_DIR}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+find_library(
+        FBJNI_LIB
+        fbjni
+        PATHS ${LIBRN_SO}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+find_library(
+        TURBOMODULES_LIB
+        turbomodulejsijni
+        PATHS ${LIBRN_DIR}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+find_library(
+        REACT_LIB
+        react_nativemodule_core
+        PATHS ${LIBRN_DIR}
+        NO_CMAKE_FIND_ROOT_PATH
+)
+
+if(${REACT_NATIVE_VERSION} LESS 66)
+        # JSI lib didn't exist on RN 0.65 and before. Simply omit it.
+        set (JSI_LIB "")
+else()
+        # RN 0.66 distributes libjsi.so, can be used instead of compiling jsi.cpp manually.
+        find_library(
+                JSI_LIB
+                jsi
+                PATHS ${LIBRN_DIR}
+                NO_CMAKE_FIND_ROOT_PATH
+        )
+endif()
+
+find_package(openssl REQUIRED CONFIG)
+
+target_link_libraries(
+        reactnativequickcrypto
+        ${TURBOMODULES_LIB}
+        ${FBJNI_LIB}
+        ${log-lib}
+        ${JSI_LIB}
+        ${REACT_NATIVE_JNI_LIB}
+        ${REACT_LIB}
+        android
+        openssl::crypto
+)

package/android/build.gradle

@@ -0,0 +1,367 @@
+import groovy.json.JsonSlurper
+import org.apache.tools.ant.filters.ReplaceTokens
+import java.nio.file.Paths
+
+static def findNodeModules(baseDir) {
+  def basePath = baseDir.toPath().normalize()
+  // Node's module resolution algorithm searches up to the root directory,
+  // after which the base path will be null
+  while (basePath) {
+    def nodeModulesPath = Paths.get(basePath.toString(), "node_modules")
+    def reactNativePath = Paths.get(nodeModulesPath.toString(), "react-native")
+    if (nodeModulesPath.toFile().exists() && reactNativePath.toFile().exists()) {
+      return nodeModulesPath.toString()
+    }
+    basePath = basePath.getParent()
+  }
+  throw new GradleException("QuickCrypto: Failed to find node_modules/ path!")
+}
+
+def nodeModules = findNodeModules(projectDir)
+logger.warn("QuickCrypto: node_modules/ found at: ${nodeModules}")
+
+buildscript {
+  repositories {
+    google()
+    jcenter()
+    maven {
+      url "https://plugins.gradle.org/m2/"
+    }
+  }
+
+  dependencies {
+    classpath 'com.android.tools.build:gradle:4.2.2'
+    classpath 'de.undercouch:gradle-download-task:4.1.2'
+  }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'de.undercouch.download'
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['QuickCrypto_' + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['QuickCrypto_' + name]).toInteger()
+}
+
+def reactNativeArchitectures() {
+    def value = project.getProperties().get("reactNativeArchitectures")
+    return value ? value.split(",") : ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]
+}
+
+def sourceBuild = false
+def defaultDir = null
+def androidSourcesDir = null
+def androidSourcesName = 'React Native sources'
+
+if (rootProject.ext.has('reactNativeAndroidRoot')) {
+  defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
+  androidSourcesDir = defaultDir.parentFile.toString()
+} else if (findProject(':ReactAndroid') != null) {
+    sourceBuild = true
+    defaultDir = project(':ReactAndroid').projectDir
+    androidSourcesDir = defaultDir.parentFile.toString()
+} else {
+  defaultDir = file("$nodeModules/react-native/android")
+  androidSourcesDir = defaultDir.parentFile.toString()
+}
+
+if (!defaultDir.exists()) {
+    throw new GradleException(
+      "${project.name}: React Native android directory (node_modules/react-native/android) does not exist! Resolved node_modules to: ${nodeModules}"
+    )
+}
+
+def prebuiltDir = sourceBuild
+    ? "$nodeModules/react-native/ReactAndroid/src/main/jni/prebuilt/lib"
+    : "$buildDir/react-native-0*/jni"
+
+
+def reactProperties = new Properties()
+file("$nodeModules/react-native/ReactAndroid/gradle.properties").withInputStream { reactProperties.load(it) }
+def REACT_NATIVE_VERSION = reactProperties.getProperty("VERSION_NAME").split("\\.")[1].toInteger()
+
+android {
+  compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')
+  buildToolsVersion getExtOrDefault('buildToolsVersion')
+  ndkVersion getExtOrDefault('ndkVersion')
+
+  defaultConfig {
+    minSdkVersion 21
+    targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
+    versionCode 1
+    versionName "1.0"
+    externalNativeBuild {
+      cmake {
+        cppFlags "-fexceptions", "-frtti", "-std=c++1y", "-DONANDROID"
+        arguments '-DANDROID_STL=c++_shared',
+                  "-DREACT_NATIVE_VERSION=${REACT_NATIVE_VERSION}",
+                  "-DNODE_MODULES_DIR=${nodeModules}",
+                  "-DPREBUILT_DIR=${prebuiltDir}"
+      }
+    }
+    ndk {
+      abiFilters (*reactNativeArchitectures())
+    }
+  }
+
+  dexOptions {
+    javaMaxHeapSize "4g"
+  }
+
+  externalNativeBuild {
+    cmake {
+      path "CMakeLists.txt"
+    }
+  }
+
+  packagingOptions {
+    excludes = ["**/libc++_shared.so", "**/libfbjni.so", "**/libreactnativejni.so", "**/libjsi.so", "**/MANIFEST.MF", ""]
+    doNotStrip '**/*.so'
+  }
+
+  buildTypes {
+    debug {
+      packagingOptions {
+        doNotStrip '**/*.so'
+      }
+      minifyEnabled false
+      debuggable true
+      jniDebuggable true
+      renderscriptDebuggable true
+    }
+
+    release {
+      minifyEnabled false
+    }
+  }
+  lintOptions {
+    disable 'GradleCompatible'
+  }
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  configurations {
+    extractHeaders
+    extractJNI
+  }
+
+  buildFeatures {
+    prefab true
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+
+  maven {
+    url defaultDir.toString()
+    name androidSourcesName
+  }
+}
+
+dependencies {
+  // https://mvnrepository.com/artifact/com.android.ndk.thirdparty/openssl
+  implementation 'com.android.ndk.thirdparty:openssl:1.1.1l-beta-1'
+  // noinspection GradleDynamicVersion
+  implementation 'com.facebook.react:react-native:+'
+
+  //noinspection GradleDynamicVersion
+  extractHeaders("com.facebook.fbjni:fbjni:+:headers")
+  //noinspection GradleDynamicVersion
+  extractJNI("com.facebook.fbjni:fbjni:+")
+
+  if (!sourceBuild) {
+    def rnAAR = fileTree("${defaultDir.toString()}").matching({ it.include "**/**/*.aar" }).singleFile
+    extractJNI(files(rnAAR))
+  }
+}
+
+// third-party-ndk deps headers
+// mostly a copy of https://github.com/software-mansion/react-native-reanimated/blob/master/android/build.gradle#L115
+
+def downloadsDir = new File("$buildDir/downloads")
+def thirdPartyNdkDir = new File("$buildDir/third-party-ndk")
+def thirdPartyVersionsFile = new File("${androidSourcesDir.toString()}/ReactAndroid/gradle.properties")
+def thirdPartyVersions = new Properties()
+thirdPartyVersions.load(new FileInputStream(thirdPartyVersionsFile))
+
+def BOOST_VERSION = thirdPartyVersions["BOOST_VERSION"]
+def boost_file = new File(downloadsDir, "boost_${BOOST_VERSION}.tar.gz")
+def DOUBLE_CONVERSION_VERSION = thirdPartyVersions["DOUBLE_CONVERSION_VERSION"]
+def double_conversion_file = new File(downloadsDir, "double-conversion-${DOUBLE_CONVERSION_VERSION}.tar.gz")
+def FOLLY_VERSION = thirdPartyVersions["FOLLY_VERSION"]
+def folly_file = new File(downloadsDir, "folly-${FOLLY_VERSION}.tar.gz")
+def GLOG_VERSION = thirdPartyVersions["GLOG_VERSION"]
+def glog_file = new File(downloadsDir, "glog-${GLOG_VERSION}.tar.gz")
+
+task createNativeDepsDirectories {
+  doLast {
+    downloadsDir.mkdirs()
+    thirdPartyNdkDir.mkdirs()
+  }
+}
+
+task downloadBoost(dependsOn: createNativeDepsDirectories, type: Download) {
+  src("https://github.com/react-native-community/boost-for-react-native/releases/download/v${BOOST_VERSION.replace("_", ".")}-0/boost_${BOOST_VERSION}.tar.gz")
+  onlyIfNewer(true)
+  overwrite(false)
+  dest(boost_file)
+}
+
+task prepareBoost(dependsOn: downloadBoost, type: Copy) {
+  from(tarTree(resources.gzip(downloadBoost.dest)))
+  from("src/main/jni/third-party/boost/Android.mk")
+  include("Android.mk", "boost_${BOOST_VERSION}/boost/**/*.hpp", "boost/boost/**/*.hpp")
+  includeEmptyDirs = false
+  into("$thirdPartyNdkDir") // /boost_X_XX_X
+  doLast {
+    file("$thirdPartyNdkDir/boost_${BOOST_VERSION}").renameTo("$thirdPartyNdkDir/boost")
+  }
+}
+
+task downloadDoubleConversion(dependsOn: createNativeDepsDirectories, type: Download) {
+  src("https://github.com/google/double-conversion/archive/v${DOUBLE_CONVERSION_VERSION}.tar.gz")
+  onlyIfNewer(true)
+  overwrite(false)
+  dest(double_conversion_file)
+}
+
+task prepareDoubleConversion(dependsOn: downloadDoubleConversion, type: Copy) {
+  from(tarTree(downloadDoubleConversion.dest))
+  from("src/main/jni/third-party/double-conversion/Android.mk")
+  include("double-conversion-${DOUBLE_CONVERSION_VERSION}/src/**/*", "Android.mk")
+  filesMatching("*/src/**/*", { fname -> fname.path = "double-conversion/${fname.name}" })
+  includeEmptyDirs = false
+  into("$thirdPartyNdkDir/double-conversion")
+}
+
+task downloadFolly(dependsOn: createNativeDepsDirectories, type: Download) {
+  src("https://github.com/facebook/folly/archive/v${FOLLY_VERSION}.tar.gz")
+  onlyIfNewer(true)
+  overwrite(false)
+  dest(folly_file)
+}
+
+task prepareFolly(dependsOn: downloadFolly, type: Copy) {
+  from(tarTree(downloadFolly.dest))
+  from("src/main/jni/third-party/folly/Android.mk")
+  include("folly-${FOLLY_VERSION}/folly/**/*", "Android.mk")
+  eachFile { fname -> fname.path = (fname.path - "folly-${FOLLY_VERSION}/") }
+  includeEmptyDirs = false
+  into("$thirdPartyNdkDir/folly")
+}
+
+task downloadGlog(dependsOn: createNativeDepsDirectories, type: Download) {
+  src("https://github.com/google/glog/archive/v${GLOG_VERSION}.tar.gz")
+  onlyIfNewer(true)
+  overwrite(false)
+  dest(glog_file)
+}
+
+task prepareGlog(dependsOn: downloadGlog, type: Copy) {
+  from(tarTree(downloadGlog.dest))
+  from("src/main/jni/third-party/glog/")
+  include("glog-${GLOG_VERSION}/src/**/*", "Android.mk", "config.h")
+  includeEmptyDirs = false
+  filesMatching("**/*.h.in") {
+    filter(ReplaceTokens, tokens: [
+      ac_cv_have_unistd_h           : "1",
+      ac_cv_have_stdint_h           : "1",
+      ac_cv_have_systypes_h         : "1",
+      ac_cv_have_inttypes_h         : "1",
+      ac_cv_have_libgflags          : "0",
+      ac_google_start_namespace     : "namespace google {",
+      ac_cv_have_uint16_t           : "1",
+      ac_cv_have_u_int16_t          : "1",
+      ac_cv_have___uint16           : "0",
+      ac_google_end_namespace       : "}",
+      ac_cv_have___builtin_expect   : "1",
+      ac_google_namespace           : "google",
+      ac_cv___attribute___noinline  : "__attribute__ ((noinline))",
+      ac_cv___attribute___noreturn  : "__attribute__ ((noreturn))",
+      ac_cv___attribute___printf_4_5: "__attribute__((__format__ (__printf__, 4, 5)))"
+    ])
+    it.path = (it.name - ".in")
+  }
+  into("$thirdPartyNdkDir/glog")
+
+  doLast {
+    copy {
+      from(fileTree(dir: "$thirdPartyNdkDir/glog", includes: ["stl_logging.h", "logging.h", "raw_logging.h", "vlog_is_on.h", "**/src/glog/log_severity.h"]).files)
+      includeEmptyDirs = false
+      into("$thirdPartyNdkDir/glog/exported/glog")
+    }
+  }
+}
+
+task prepareThirdPartyNdkHeaders {
+  if (!boost_file.exists()) {
+    dependsOn(prepareBoost)
+  }
+  if (!double_conversion_file.exists()) {
+    dependsOn(prepareDoubleConversion)
+  }
+  if (!folly_file.exists()) {
+    dependsOn(prepareFolly)
+  }
+  if (!glog_file.exists()) {
+    dependsOn(prepareGlog)
+  }
+}
+
+prepareThirdPartyNdkHeaders.mustRunAfter createNativeDepsDirectories
+
+task extractAARHeaders {
+  doLast {
+    configurations.extractHeaders.files.each {
+      def file = it.absoluteFile
+      copy {
+        from zipTree(file)
+        into "$buildDir/$file.name"
+        include "**/*.h"
+      }
+    }
+  }
+}
+extractAARHeaders.mustRunAfter prepareThirdPartyNdkHeaders
+
+task extractJNIFiles {
+  doLast {
+    configurations.extractJNI.files.each {
+      def file = it.absoluteFile
+
+      copy {
+        from zipTree(file)
+        into "$buildDir/$file.name"
+        include "jni/**/*"
+      }
+    }
+  }
+}
+extractJNIFiles.mustRunAfter extractAARHeaders
+
+def nativeBuildDependsOn(dependsOnTask, variant) {
+  def buildTasks = tasks.findAll({ task ->
+      !task.name.contains("Clean") && (task.name.contains("externalNative") || task.name.contains("CMake")) })
+  if (variant != null) {
+    buildTasks = buildTasks.findAll({ task -> task.name.contains(variant) })
+  }
+  buildTasks.forEach { task -> task.dependsOn(dependsOnTask) }
+}
+
+afterEvaluate {
+  if (sourceBuild) {
+    nativeBuildDependsOn(":ReactAndroid:packageReactNdkDebugLibsForBuck", "Debug")
+    nativeBuildDependsOn(":ReactAndroid:packageReactNdkReleaseLibsForBuck", "Rel")
+  } else {
+    nativeBuildDependsOn(extractAARHeaders, null)
+    nativeBuildDependsOn(extractJNIFiles, null)
+    nativeBuildDependsOn(prepareThirdPartyNdkHeaders, null)
+  }
+}

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.9-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

package/android/gradle.properties

@@ -0,0 +1,6 @@
+QuickCrypto_compileSdkVersion=30
+QuickCrypto_buildToolsVersion=30.0.2
+QuickCrypto_targetSdkVersion=30
+android.useAndroidX=true
+# Enables Prefab
+android.enablePrefab=true