Foundation-Devices/tor flutter_rust_bridge migration + Cypher Stack tor fixes/features

.envrc

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
+#
+# SPDX-License-Identifier: MIT
+
+use flake

.flutter-plugins-dependencies

@@ -0,0 +1 @@
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"/home/icota/.pub-cache/hosted/pub.dev/path_provider_foundation-2.5.1/","shared_darwin_source":true,"native_build":true,"dependencies":[],"dev_dependency":false},{"name":"rust_lib_tor","path":"/home/icota/Code/tor/rust_builder/","native_build":true,"dependencies":[],"dev_dependency":false}],"android":[{"name":"path_provider_android","path":"/home/icota/.pub-cache/hosted/pub.dev/path_provider_android-2.2.22/","native_build":true,"dependencies":[],"dev_dependency":false},{"name":"rust_lib_tor","path":"/home/icota/Code/tor/rust_builder/","native_build":true,"dependencies":[],"dev_dependency":false}],"macos":[{"name":"path_provider_foundation","path":"/home/icota/.pub-cache/hosted/pub.dev/path_provider_foundation-2.5.1/","shared_darwin_source":true,"native_build":true,"dependencies":[],"dev_dependency":false},{"name":"rust_lib_tor","path":"/home/icota/Code/tor/rust_builder/","native_build":true,"dependencies":[],"dev_dependency":false}],"linux":[{"name":"path_provider_linux","path":"/home/icota/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[],"dev_dependency":false},{"name":"rust_lib_tor","path":"/home/icota/Code/tor/rust_builder/","native_build":true,"dependencies":[],"dev_dependency":false}],"windows":[{"name":"path_provider_windows","path":"/home/icota/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[],"dev_dependency":false},{"name":"rust_lib_tor","path":"/home/icota/Code/tor/rust_builder/","native_build":true,"dependencies":[],"dev_dependency":false}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"rust_lib_tor","dependencies":[]}],"date_created":"2026-02-19 09:24:05.451601","version":"3.35.7","swift_package_manager_enabled":{"ios":false,"macos":false}}

.github/workflows/check.yml

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: 2022 Foundation Devices Inc.
+#
+# SPDX-License-Identifier: MIT
+
+name: Check
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: REUSE Compliance Check
+        uses: fsfe/reuse-action@v1
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: rustfmt, clippy
+
+      - uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+          flutter-version: '3.35.1'
+
+      - name: Install dependencies
+        run: flutter pub get
+
+      - name: Verify Dart formatting
+        run: dart format --output=none --set-exit-if-changed .
+
+      - name: Verify Rust formatting
+        run: cargo fmt --manifest-path rust/Cargo.toml --all -- --check
+
+      - name: Run Rust tests
+        run: cargo test --manifest-path rust/Cargo.toml
+
+      - name: Analyze Dart project source
+        run: flutter analyze
+
+#      - name: Run Dart tests
+#        run: flutter test

.gitignore

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
+#
+# SPDX-License-Identifier: MIT
+
 # Miscellaneous
 *.class
 *.log
@@ -30,5 +34,7 @@ migrate_working_dir/
 build/
 
 rust/target/.rustc_info.json
-rust/target/debug/
-rust/target/CACHEDIR.TAG
+rust/target/debug
+
+# direnv
+.direnv/

.reuse/dep5

@@ -0,0 +1,56 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: tor_ffi_plugin
+Upstream-Contact: Igor Cota <igor@foundationdevices.com>
+Source: https://github.com/cypherstack/tor
+
+Files: cargokit/*
+Copyright: 2022 Matej Knopp
+License: MIT
+
+Files: lib/generated*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: lib/src/rust/*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: rust/src/frb_generated.rs
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: .flutter-plugins-dependencies
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: example/linux/flutter/generated*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files:  example/macos/Flutter/Generated*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: example/windows/flutter/generated*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: example/android/*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: rust/target/*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: CHANGELOG.md
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: flake.lock
+Copyright: 2024 Foundation Devices Inc.
+License: MIT
+
+Files: android/.gradle/*
+Copyright: 2024 Foundation Devices Inc.
+License: MIT

CHANGELOG.md

@@ -1,3 +1,41 @@
+<!--
+SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
+
+SPDX-License-Identifier: MIT
+-->
+
+## 0.0.9
+
+* Bumped arti to version 1.4.3
+
+## 0.0.8
+
+* Bumped arti to version 1.2.7
+
+## 0.0.7
+
+* Relicensed to MIT
+
+## 0.0.6
+
+* Pinned 'time' to a specific version
+
+## 0.0.5
+
+* Added rust-toolchain file
+
+## 0.0.4
+
+* Bumped arti to version 1.2.4
+
+## 0.0.3
+
+* Added functions to stop and restart the proxy.
+
+## 0.0.2
+
+* Fixed the Windows build.
+
 ## 0.0.1
 
-* TODO: Describe initial release.
+* Initial release.

LICENSE.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
+
+SPDX-License-Identifier: MIT

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Foundation Devices Inc.
+
+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.

README.md

@@ -1,7 +1,8 @@
 <!--
 SPDX-FileCopyrightText: 2022-2023 Foundation Devices Inc.
+SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
 
-SPDX-License-Identifier: GPL-3.0-or-later
+SPDX-License-Identifier: MIT
 -->
 
 # tor
@@ -12,7 +13,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 ### [Install rust](https://www.rust-lang.org/tools/install)
 
-Use `rustup`, not `homebrew`.  Install toolchain 1.74.
+Use `rustup`, not `homebrew`.
 
 ### Install cargo ndk
 
@@ -31,11 +32,10 @@ git subtree pull --prefix cargokit https://github.com/irondash/cargokit.git main
 
 ## Development
 
-To generate `tor_ffi_plugin.h` C bindings for Rust, `cbindgen --config cbindgen.toml --crate tor-ffi --output target/tor_ffi_plugin.h` or `cargo build` in `native/tor-ffi` to produce headers according to `build.rs`.
-To generate `tor_bindings_generated.dart` Dart bindings for C, `flutter pub run ffigen --config ffigen.yaml`.  You will probably need to manually edit the `Tor` class to be `final`.
+To (re)generate Dart bindings run `just generate`
 
 ## Example app
 
 `flutter run` in `example` to run the example app
 
-See `example/lib/main.dart` for usage.  Must run the build script for your platform first.
+See `example/lib/main.dart` for usage.

analysis_options.yaml

@@ -1,4 +1,12 @@
+# SPDX-FileCopyrightText: 2022 Foundation Devices Inc.
+# SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
+#
+# SPDX-License-Identifier: MIT
+
 include: package:flutter_lints/flutter.yaml
 
-# Additional information about this file can be found at
-# https://dart.dev/guides/language/analysis-options
+analyzer:
+  exclude:
+    - 'lib/generated*'
+    - 'lib/src/rust/**'
+    - 'cargokit/**'

android/.gitignore

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Foundation Devices Inc
+#
+# SPDX-License-Identifier: MIT
+
 *.iml
 .gradle
 /local.properties

android/build.gradle

@@ -1,77 +1,60 @@
+// SPDX-FileCopyrightText: 2024 Foundation Devices Inc.
+//
+// SPDX-License-Identifier: MIT
+
 // The Android Gradle Plugin builds the native code with the Android NDK.
 
 group 'com.cypherstack.tor_ffi_plugin'
 version '1.0'
 
 buildscript {
-    ext.kotlin_version = '1.8.0'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath("com.android.tools.build:gradle:8.1.0")
-        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")
+        // The Android Gradle Plugin knows how to build native code with the NDK.
+        classpath 'com.android.tools.build:gradle:7.3.0'
     }
 }
 
-allprojects {
+rootProject.allprojects {
     repositories {
         google()
         mavenCentral()
     }
 }
 
 apply plugin: 'com.android.library'
-apply plugin: 'kotlin-android'
 
 android {
     if (project.android.hasProperty("namespace")) {
         namespace 'com.cypherstack.tor_ffi_plugin'
     }
 
-    compileSdk = 34
+    // Bumping the plugin compileSdkVersion requires all clients of this plugin
+    // to bump the version in their app.
+    compileSdkVersion 33
 
-    compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
-    }
+    // Use the NDK version
+    // declared in /android/app/build.gradle file of the Flutter project.
+    // Replace it with a version number if this plugin requires a specfic NDK version.
+    // (e.g. ndkVersion "23.1.7779620")
+    ndkVersion android.ndkVersion
 
-    kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_1_8
-    }
-
-    sourceSets {
-        main.java.srcDirs += "src/main/kotlin"
-        test.java.srcDirs += "src/test/kotlin"
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
     }
 
     defaultConfig {
-        minSdk = 21
-    }
-
-    dependencies {
-        testImplementation("org.jetbrains.kotlin:kotlin-test")
-        testImplementation("org.mockito:mockito-core:5.0.0")
-    }
-
-    testOptions {
-        unitTests.all {
-            useJUnitPlatform()
-
-            testLogging {
-                events "passed", "skipped", "failed", "standardOut", "standardError"
-                outputs.upToDateWhen {false}
-                showStandardStreams = true
-            }
-        }
+        minSdkVersion 19
     }
 }
 
 apply from: "../cargokit/gradle/plugin.gradle"
-
 cargokit {
     manifestDir = "../rust"
-    libname = "tor_ffi_plugin"
-}
+    libname = "rust_lib_tor"
+}

android/settings.gradle

@@ -1 +1,5 @@
+// SPDX-FileCopyrightText: 2024 Foundation Devices Inc
+//
+// SPDX-License-Identifier: MIT
+
 rootProject.name = 'tor_ffi_plugin'

android/src/main/AndroidManifest.xml

@@ -1,3 +1,8 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-  package="com.cypherstack.tor_ffi_plugin">
+<!--
+SPDX-FileCopyrightText: 2024 Foundation Devices Inc
+
+SPDX-License-Identifier: MIT
+-->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 </manifest>