Sync with Foundation-Devices/tor: Change package name and author

.github/workflows/check.yml

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: 2022 Foundation Devices Inc.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+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.16.3'
+
+      - 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

@@ -30,3 +30,4 @@ migrate_working_dir/
 build/
 
 rust/target/.rustc_info.json
+rust/target/debug

.gitignore.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

.reuse/dep5

@@ -0,0 +1,20 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: tor
+Upstream-Contact: Igor Cota <[email protected]>
+Source: https://github.com/Foundation-Devices/tor
+
+Files: cargokit/*
+Copyright: 2022 Matej Knopp
+License: MIT
+
+Files: lib/generated*
+Copyright: 2024 Foundation Devices Inc.
+License: GPL-3.0-or-later
+
+Files: rust/target/*
+Copyright: 2024 Foundation Devices Inc.
+License: GPL-3.0-or-later
+
+Files: CHANGELOG.md
+Copyright: 2024 Foundation Devices Inc.
+License: GPL-3.0-or-later

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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.

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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

@@ -31,11 +31,10 @@ git subtree pull --prefix cargokit https://github.com/irondash/cargokit.git main
 
 ## Development
 
-To generate `tor-ffi.h` C bindings for Rust, `cbindgen --config cbindgen.toml --crate tor-ffi --output target/tor-ffi.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`
+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.

README.md.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

analysis_options.yaml

@@ -1,4 +1,9 @@
+# SPDX-FileCopyrightText: 2022 Foundation Devices Inc.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 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*'
+    - 'cargokit'

android/.gitignore.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

android/build.gradle

@@ -1,6 +1,6 @@
 // The Android Gradle Plugin builds the native code with the Android NDK.
 
-group 'com.cypherstack.tor_ffi_plugin'
+group 'com.foundationdevices.tor'
 version '1.0'
 
 buildscript {
@@ -26,7 +26,7 @@ apply plugin: 'com.android.library'
 
 android {
     if (project.android.hasProperty("namespace")) {
-        namespace 'com.cypherstack.tor_ffi_plugin'
+        namespace 'com.foundationdevices.tor'
     }
     // Bumping the plugin compileSdkVersion requires all clients of this plugin
     // to bump the version in their app.
@@ -46,5 +46,5 @@ apply from: "../cargokit/gradle/plugin.gradle"
 
 cargokit {
     manifestDir = "../rust"
-    libname = "tor_ffi_plugin"
+    libname = "tor"
 }

android/build.gradle.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

android/settings.gradle

@@ -1 +1 @@
-rootProject.name = 'tor_ffi_plugin'
+rootProject.name = 'tor'

android/settings.gradle.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

android/src/main/AndroidManifest.xml

@@ -1,3 +1,3 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-  package="com.cypherstack.tor_ffi_plugin">
+  package="com.foundationdevices.tor">
 </manifest>

android/src/main/AndroidManifest.xml.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

cargokit/build_pod.sh

@@ -37,10 +37,22 @@ export CARGOKIT_TOOL_TEMP_DIR=$TARGET_TEMP_DIR/build_tool
 # Directory inside root project. Not necessarily the top level directory of root project.
 export CARGOKIT_ROOT_PROJECT_DIR=$SRCROOT
 
+FLUTTER_EXPORT_BUILD_ENVIRONMENT=(
+  "$PODS_ROOT/../Flutter/ephemeral/flutter_export_environment.sh" # macOS
+  "$PODS_ROOT/../Flutter/flutter_export_environment.sh" # iOS
+)
+
+for path in "${FLUTTER_EXPORT_BUILD_ENVIRONMENT[@]}"
+do
+  if [[ -f "$path" ]]; then
+    source "$path"
+  fi
+done
+
 "$BASEDIR/run_build_tool.sh" build-pod "$@"
 
 # Make a symlink from built framework to phony file, which will be used as input to
 # build script. This should force rebuild (podspec currently doesn't support alwaysOutOfDate
 # attribute on custom build phase)
-ln -Fs "${BUILT_PRODUCTS_DIR}/${EXECUTABLE_PATH}" "${BUILT_PRODUCTS_DIR}/cargokit_phony"
+ln -Fs "$OBJROOT/XCBuildData/build.db" "${BUILT_PRODUCTS_DIR}/cargokit_phony"
 ln -Fs "${BUILT_PRODUCTS_DIR}/${EXECUTABLE_PATH}" "${BUILT_PRODUCTS_DIR}/cargokit_phony_out"

cargokit/build_tool/lib/src/builder.dart

@@ -116,14 +116,14 @@ class RustBuilder {
     Rustup rustup,
   ) {
     final toolchain = _toolchain;
-    if (!rustup.installedToolchains.any((i) => i.startsWith('$toolchain-'))) {
+    if (rustup.installedTargets(toolchain) == null) {
       rustup.installToolchain(toolchain);
     }
     if (toolchain == 'nightly') {
       rustup.installRustSrcForNightly();
     }
-    if (!rustup.installedTargets.contains(target.rust)) {
-      rustup.installTarget(target.rust);
+    if (!rustup.installedTargets(toolchain)!.contains(target.rust)) {
+      rustup.installTarget(target.rust, toolchain: toolchain);
     }
   }
 

cargokit/build_tool/lib/src/rustup.dart

@@ -1,41 +1,90 @@
 import 'dart:io';
 
+import 'package:collection/collection.dart';
 import 'package:path/path.dart' as path;
 
 import 'util.dart';
 
-class Rustup {
-  final List<String> installedTargets;
-  final List<String> installedToolchains;
+class _Toolchain {
+  _Toolchain(
+    this.name,
+    this.targets,
+  );
 
-  Rustup()
-      : installedTargets = _getInstalledTargets(),
-        installedToolchains = _getInstalledToolchains();
+  final String name;
+  final List<String> targets;
+}
 
-  void installTarget(String target) {
-    log.info("Installing Rust target: $target");
-    runCommand("rustup", ['target', 'add', target]);
-    installedTargets.add(target);
+class Rustup {
+  List<String>? installedTargets(String toolchain) {
+    final targets = _installedTargets(toolchain);
+    return targets != null ? List.unmodifiable(targets) : null;
   }
 
   void installToolchain(String toolchain) {
     log.info("Installing Rust toolchain: $toolchain");
     runCommand("rustup", ['toolchain', 'install', toolchain]);
-    installedToolchains.add(toolchain);
+    _installedToolchains
+        .add(_Toolchain(toolchain, _getInstalledTargets(toolchain)));
   }
 
-  static List<String> _getInstalledToolchains() {
+  void installTarget(
+    String target, {
+    required String toolchain,
+  }) {
+    log.info("Installing Rust target: $target");
+    runCommand("rustup", [
+      'target',
+      'add',
+      '--toolchain',
+      toolchain,
+      target,
+    ]);
+    _installedTargets(toolchain)?.add(target);
+  }
+
+  final List<_Toolchain> _installedToolchains;
+
+  Rustup() : _installedToolchains = _getInstalledToolchains();
+
+  List<String>? _installedTargets(String toolchain) => _installedToolchains
+      .firstWhereOrNull(
+          (e) => e.name == toolchain || e.name.startsWith('$toolchain-'))
+      ?.targets;
+
+  static List<_Toolchain> _getInstalledToolchains() {
+    String extractToolchainName(String line) {
+      // ignore (default) after toolchain name
+      final parts = line.split(' ');
+      return parts[0];
+    }
+
     final res = runCommand("rustup", ['toolchain', 'list']);
     final lines = res.stdout
         .toString()
         .split('\n')
         .where((e) => e.isNotEmpty)
+        .map(extractToolchainName)
+        .toList(growable: true);
+
+    return lines
+        .map(
+          (name) => _Toolchain(
+            name,
+            _getInstalledTargets(name),
+          ),
+        )
         .toList(growable: true);
-    return lines;
   }
 
-  static List<String> _getInstalledTargets() {
-    final res = runCommand("rustup", ['target', 'list', '--installed']);
+  static List<String> _getInstalledTargets(String toolchain) {
+    final res = runCommand("rustup", [
+      'target',
+      'list',
+      '--toolchain',
+      toolchain,
+      '--installed',
+    ]);
     final lines = res.stdout
         .toString()
         .split('\n')

example/.gitignore.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

example/README.md.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

example/analysis_options.yaml

@@ -1,29 +1,5 @@
-# This file configures the analyzer, which statically analyzes Dart code to
-# check for errors, warnings, and lints.
-#
-# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
-# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
-# invoked from the command line by running `flutter analyze`.
-
-# The following line activates a set of recommended lints for Flutter apps,
-# packages, and plugins designed to encourage good coding practices.
 include: package:flutter_lints/flutter.yaml
 
 linter:
-  # The lint rules applied to this project can be customized in the
-  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
-  # included above or to enable additional rules. A list of all available lints
-  # and their documentation is published at
-  # https://dart-lang.github.io/linter/lints/index.html.
-  #
-  # Instead of disabling a lint rule for the entire project in the
-  # section below, it can also be suppressed for a single line of code
-  # or a specific dart file by using the `// ignore: name_of_lint` and
-  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
-  # producing the lint.
   rules:
-    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
-    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
-
-# Additional information about this file can be found at
-# https://dart.dev/guides/language/analysis-options
+    avoid_print: false

example/analysis_options.yaml.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

example/android/.gitignore.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Foundation Devices Inc.
+
+SPDX-License-Identifier: GPL-3.0-or-later

example/android/app/build.gradle

@@ -26,7 +26,7 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    namespace "com.cypherstack.tor_ffi_plugin_example"
+    namespace "com.foundationdevices.tor_example"
     compileSdkVersion flutter.compileSdkVersion
     ndkVersion flutter.ndkVersion
 
@@ -45,7 +45,7 @@ android {
 
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
-        applicationId "com.cypherstack.tor_ffi_plugin_example"
+        applicationId "com.foundationdevices.tor_example"
         // You can update the following values to match your application needs.
         // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
         minSdkVersion flutter.minSdkVersion