cryptography_flutter 2.1.0 and a new test suite: fixes lots of issues.

Author: terrier989

cryptography_flutter/.gitignore

@@ -1,17 +1,3 @@
-# See https://www.dartlang.org/guides/libraries/private-files
-
-# Files and directories created by pub
-.dart_tool/
-.packages
-.pub/
-build/
-# If you're building an application, you may want to check-in your pubspec.lock
-pubspec.lock
-
-# Directory created by dartdoc
-# If you don't generate documentation locally you can remove this line.
-doc/api/
-
 # Miscellaneous
 *.class
 *.log
@@ -22,6 +8,7 @@ doc/api/
 .buildlog/
 .history
 .svn/
+migrate_working_dir/
 
 # IntelliJ related
 *.iml
@@ -35,16 +22,18 @@ doc/api/
 .vscode/
 
 # Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
 **/doc/api/
 **/ios/Flutter/.last_build_id
+.dart_tool/
 .flutter-plugins
 .flutter-plugins-dependencies
+.packages
 .pub-cache/
+.pub/
 /build/
 
-# Web related
-lib/generated_plugin_registrant.dart
-
 # Symbolication related
 app.*.symbols
 

cryptography_flutter/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.1.0
+* Many, major bug fixes.
+* Some breaking changes to the API, but we decided not to increment the major version because we
+  don't expect them to affect many developers (while we do want the bug fixes to reach everyone who
+  uses the package).
+* Many new features.
+* We have a completely new test suite that ensures correctness and also reports performance with
+  different input sizes.
+
 ## 2.0.2
 
 * Fixes ["cryptography_flutter: Fix propagating error to Flutter + fix fallback to non-plugin encrypt/decrypt"](https://github.com/dint-dev/cryptography/pull/76)

cryptography_flutter/README.md

@@ -1,45 +1,47 @@
 [![Pub Package](https://img.shields.io/pub/v/cryptography_flutter.svg)](https://pub.dev/packages/cryptography_flutter)
-[![Github Actions CI](https://github.com/dint-dev/cryptography/workflows/Dart%20CI/badge.svg)](https://github.com/dint-dev/cryptography/actions?query=workflow%3A%22Dart+CI%22)
+[![Github Actions CI](https://github.com/dint-dev/cryptography/workflows/Dart%20CI/badge.svg)](https://github.com/dint-dev/cryptography/actions)
 
 # Overview
 
 This is a version of the package [cryptography](https://pub.dev/packages/cryptography) that
 optimizes performance of some cryptographic algorithms by using native APIs of Android, iOS, and
 Mac OS X. You must use asynchronous methods to get the performance boost.
 
-Maintained by Gohilla Ltd. Licensed under the [Apache License 2.0](LICENSE).
+Maintained by Gohilla. Licensed under the [Apache License 2.0](LICENSE).
 
-## Optimized algorithms
-### In Android
-  * [AesCbc()](https://pub.dev/documentation/cryptography/latest/cryptography/AesCbc-class.html)
-  * [AesCtr()](https://pub.dev/documentation/cryptography/latest/cryptography/AesCtr-class.html)
-  * [AesGcm()](https://pub.dev/documentation/cryptography/latest/cryptography/AesGcm-class.html)
-  * [Chacha20.poly1305()](https://pub.dev/documentation/cryptography/latest/cryptography/Chacha20-class.html)
+## General behavior
+This package contains two kinds of classes:
+  * Classes such as [FlutterChacha20](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterChacha20-class.html)
+    use operating system APIs in Android / iOS / Mac OS X. If the operating system does not support
+    the algorithm, the background implementation (such as `BackgroundChacha20`) or a pure Dart
+    implementation (such as [DartChacha20](https://pub.dev/documentation/cryptography/latest/cryptography.dart/DartChacha20-class.html))
+    when available.
+  * Classes such as [BackgroundChacha20](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundChacha20-class.html)
+    move the computation away from the UI isolate using [compute](https://api.flutter.dev/flutter/foundation/compute-constant.html)
+    ("package:flutter/foundation.dart").
 
-### In iOS and Mac OS X
-  * [AesGcm()](https://pub.dev/documentation/cryptography/latest/cryptography/AesGcm-class.html)
-  * [Chacha20.poly1305()](https://pub.dev/documentation/cryptography/latest/cryptography/Chacha20-class.html)
-
-## Links
-  * [Github project](https://github.com/dint-dev/cryptography)
-  * [Issue tracker](https://github.com/dint-dev/cryptography/issues)
-  * [Pub package](https://pub.dev/packages/cryptography_flutter)
-  * [API reference](https://pub.dev/documentation/cryptography_flutter/latest/)
+Both compute very small inputs in the same isolate if the overhead of message passing does not
+make sense. For example, if you encrypt a 16 byte message, the computation is done in the same
+isolate. Too large inputs are also computed in the same isolate (because you probably should not
+allocate a gigabyte cross-isolate message on a mobile phone). We also have a queue to prevent memory
+exhaustion that could happen if you send lots of requests concurrently (something we observed
+during testing).
 
 # Getting started
 In _pubspec.yaml_:
 ```yaml
 dependencies:
-  cryptography: ^2.0.5
-  cryptography_flutter: ^2.0.2
+  cryptography: ^2.1.0
+  cryptography_flutter: ^2.1.0
 ```
 
 Then just use:
 ```dart
 import 'package:cryptography_flutter/cryptography_flutter.dart';
 
 void main() {
-  // Enable Flutter cryptography
+  // Enable use of operating system APIs.
+  // This is an optional performance optimization.
   FlutterCryptography.enable();
 
   // ....
@@ -48,6 +50,61 @@ void main() {
 
 For APIs, read documentation for [package:cryptography](https://pub.dev/packages/cryptography).
 
+# Optimizations by platform
+## In iOS and Mac OS X
+Calling `FlutterCryptography.enable()` enables:
+  * [FlutterAesGcm](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterAesGcm-class.html)
+    * Our benchmarks have shown up to ~50 times better performance.
+  * [FlutterChacha20](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterChacha20-class.html)
+    * Our benchmarks have shown up to ~10 times better performance.
+  * [FlutterEd25519](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterEd25519-class.html)
+    * Our benchmarks have shown up to ~10 times better performance.
+  * [FlutterX25519](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterX25519-class.html)
+    * Our benchmarks have shown up to ~10 times better performance.
+
+By default, maximum input size is 100 MB.
+
+## In Android
+We have observe problems with some Android devices. Therefore we have disabled some optimizations
+until we have time to investigate the problems.
+
+Calling `FlutterCryptography.enable()` enables:
+* [FlutterAesGcm](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterAesGcm-class.html) 
+  * Our benchmarks have shown up to ~50 times better performance.
+* [FlutterChacha20](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/FlutterChacha20-class.html)
+  * Our benchmarks have shown up to ~10 times better performance.
+* [BackgroundEd25519](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundEd25519-class.html)
+* [BackgroundX25519](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundX25519-class.html)
+
+By default, maximum input size is 20 MB because of memory allocation crashes we observed during
+testing.
+
+## In other platforms
+In browsers, nothing is changed.
+
+In Windows, Linux, and other platforms:
+* [BackgroundAesGcm](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundAesGcm-class.html)
+* [BackgroundChacha20](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundChacha20-class.html)
+* [BackgroundEd25519](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundEd25519-class.html)
+* [BackgroundX25519](https://pub.dev/documentation/cryptography_flutter/latest/cryptography_flutter/BackgroundX25519-class.html)
+
+## Links
+* [Github project](https://github.com/dint-dev/cryptography)
+* [Issue tracker](https://github.com/dint-dev/cryptography/issues)
+* [Pub package](https://pub.dev/packages/cryptography_flutter)
+* [API reference](https://pub.dev/documentation/cryptography_flutter/latest/)
+
+
 # Contributing?
-Test the plugin by running integration tests in
-_cryptography_flutter/example/_ (see README in the directory).
+This is how you run the tests:
+```
+./tool/test.sh
+```
+
+Alternatively:
+```
+flutter test --no-pub
+cd example
+flutter test --no-pub integration_test
+```
+

cryptography_flutter/android/.gitignore

@@ -1,8 +1,13 @@
-*.iml
-.gradle
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
 /local.properties
-/.idea/workspace.xml
-/.idea/libraries
-.DS_Store
-/build
-/captures
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks

cryptography_flutter/android/build.gradle

@@ -2,43 +2,50 @@ group 'dev.dint.cryptography_flutter'
 version '1.0-SNAPSHOT'
 
 buildscript {
-    ext.kotlin_version = '1.4.20'
+    ext.kotlin_version = '1.7.10'
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.1'
+        classpath 'com.android.tools.build:gradle:7.2.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
 
-rootProject.allprojects {
+allprojects {
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 }
 
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 31
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
     }
+
     defaultConfig {
         minSdkVersion 21
     }
-    lintOptions {
-        disable 'InvalidPackage'
-    }
 }
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation "androidx.security:security-crypto:1.1.0-alpha03"
-}
+    implementation "androidx.security:security-crypto:1.1.0-alpha05"
+}

cryptography_flutter/android/src/main/AndroidManifest.xml

@@ -1 +1,2 @@
-<manifest package="dev.dint.cryptography_flutter"></manifest>
+<manifest package="dev.dint.cryptography_flutter">
+</manifest>