diff --git a/app/android/app/src/main/AndroidManifest.xml b/app/android/app/src/main/AndroidManifest.xml
index 6d3c2292..24d5a69d 100644
--- a/app/android/app/src/main/AndroidManifest.xml
+++ b/app/android/app/src/main/AndroidManifest.xml
@@ -212,10 +212,6 @@
android:foregroundServiceType="mediaPlayback"
android:exported="false" />
-
-
- r'9ded7af1d745e25c59e22edecea582e25230e5e7';
+ r'e4c5e35b9aab2aae60e3f09a99472f98a7beb69e';
abstract class _$ProxySettingsReplication extends $Notifier {
void build();
diff --git a/app/lib/features/tor/data/models/moat.dart b/app/lib/features/tor/data/models/moat.dart
new file mode 100644
index 00000000..f58e65e6
--- /dev/null
+++ b/app/lib/features/tor/data/models/moat.dart
@@ -0,0 +1,177 @@
+/*
+ * Copyright (c) 2024-2025 Fabian Freund.
+ *
+ * This file is part of WebLibre
+ * (see https://weblibre.eu).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see .
+ */
+import 'package:json_annotation/json_annotation.dart';
+
+part 'moat.g.dart';
+
+enum MoatTransportType {
+ obfs4('obfs4'),
+ snowflake('snowflake'),
+ meek('meek'),
+ meekAzure('meek-azure'),
+ webtunnel('webtunnel');
+
+ const MoatTransportType(this.value);
+ final String value;
+
+ @override
+ String toString() => value;
+
+ static MoatTransportType? fromString(String value) {
+ for (final transport in MoatTransportType.values) {
+ if (transport.value == value) return transport;
+ }
+ return null;
+ }
+}
+
+@JsonSerializable()
+class SettingsRequest {
+ final String? country;
+ @JsonKey(toJson: _transportsToJson, fromJson: _transportsFromJson)
+ final List transports;
+
+ const SettingsRequest({
+ this.country,
+ this.transports = const [
+ MoatTransportType.obfs4,
+ MoatTransportType.snowflake,
+ MoatTransportType.webtunnel,
+ ],
+ });
+
+ static List _transportsToJson(List transports) =>
+ transports.map((t) => t.value).toList();
+
+ static List _transportsFromJson(List json) => json
+ .cast()
+ .map((s) => MoatTransportType.fromString(s))
+ .where((t) => t != null)
+ .cast()
+ .toList();
+
+ factory SettingsRequest.fromJson(Map json) =>
+ _$SettingsRequestFromJson(json);
+
+ Map toJson() => _$SettingsRequestToJson(this);
+}
+
+@JsonSerializable()
+class SettingsResponse {
+ final List? settings;
+ final String? country;
+ final List? errors;
+
+ const SettingsResponse({this.settings, this.country, this.errors});
+
+ factory SettingsResponse.fromJson(Map json) =>
+ _$SettingsResponseFromJson(json);
+
+ Map toJson() => _$SettingsResponseToJson(this);
+}
+
+@JsonSerializable()
+class Setting {
+ @JsonKey(name: 'bridges')
+ final Bridge bridge;
+
+ const Setting({required this.bridge});
+
+ factory Setting.fromJson(Map json) =>
+ _$SettingFromJson(json);
+
+ Map toJson() => _$SettingToJson(this);
+}
+
+@JsonSerializable()
+class Bridge {
+ @JsonKey(toJson: _transportToJson, fromJson: _transportFromJson)
+ final MoatTransportType type;
+ final String source;
+ @JsonKey(name: 'bridge_strings')
+ final List? bridges;
+
+ const Bridge({required this.type, required this.source, this.bridges});
+
+ static String _transportToJson(MoatTransportType transport) =>
+ transport.value;
+
+ static MoatTransportType _transportFromJson(dynamic json) =>
+ MoatTransportType.fromString(json as String)!;
+
+ factory Bridge.fromJson(Map json) => _$BridgeFromJson(json);
+
+ Map toJson() => _$BridgeToJson(this);
+}
+
+@JsonSerializable()
+class MoatError implements Exception {
+ final String? id;
+ final String? type;
+ final String? version;
+ final int? code;
+ final String? status;
+ final String? detail;
+
+ const MoatError({
+ this.id,
+ this.type,
+ this.version,
+ this.code,
+ this.status,
+ this.detail,
+ });
+
+ factory MoatError.fromJson(Map json) =>
+ _$MoatErrorFromJson(json);
+
+ Map toJson() => _$MoatErrorToJson(this);
+
+ @override
+ String toString() {
+ if (detail != null && detail!.isNotEmpty) {
+ return detail!;
+ }
+ return '$code $status';
+ }
+}
+
+@JsonSerializable()
+class BuiltInBridges {
+ final List meek;
+
+ @JsonKey(name: 'meek-azure')
+ final List meekAzure;
+
+ final List obfs4;
+ final List snowflake;
+
+ const BuiltInBridges({
+ required this.meek,
+ required this.meekAzure,
+ required this.obfs4,
+ required this.snowflake,
+ });
+
+ factory BuiltInBridges.fromJson(Map json) =>
+ _$BuiltInBridgesFromJson(json);
+
+ Map toJson() => _$BuiltInBridgesToJson(this);
+}
diff --git a/app/lib/features/tor/data/models/moat.g.dart b/app/lib/features/tor/data/models/moat.g.dart
new file mode 100644
index 00000000..e0eab57d
--- /dev/null
+++ b/app/lib/features/tor/data/models/moat.g.dart
@@ -0,0 +1,102 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+
+part of 'moat.dart';
+
+// **************************************************************************
+// JsonSerializableGenerator
+// **************************************************************************
+
+SettingsRequest _$SettingsRequestFromJson(Map json) =>
+ SettingsRequest(
+ country: json['country'] as String?,
+ transports: json['transports'] == null
+ ? const [
+ MoatTransportType.obfs4,
+ MoatTransportType.snowflake,
+ MoatTransportType.webtunnel,
+ ]
+ : SettingsRequest._transportsFromJson(json['transports'] as List),
+ );
+
+Map _$SettingsRequestToJson(SettingsRequest instance) =>
+ {
+ 'country': instance.country,
+ 'transports': SettingsRequest._transportsToJson(instance.transports),
+ };
+
+SettingsResponse _$SettingsResponseFromJson(Map json) =>
+ SettingsResponse(
+ settings: (json['settings'] as List?)
+ ?.map((e) => Setting.fromJson(e as Map))
+ .toList(),
+ country: json['country'] as String?,
+ errors: (json['errors'] as List?)
+ ?.map((e) => MoatError.fromJson(e as Map))
+ .toList(),
+ );
+
+Map _$SettingsResponseToJson(SettingsResponse instance) =>
+ {
+ 'settings': instance.settings?.map((e) => e.toJson()).toList(),
+ 'country': instance.country,
+ 'errors': instance.errors?.map((e) => e.toJson()).toList(),
+ };
+
+Setting _$SettingFromJson(Map json) =>
+ Setting(bridge: Bridge.fromJson(json['bridges'] as Map));
+
+Map _$SettingToJson(Setting instance) => {
+ 'bridges': instance.bridge.toJson(),
+};
+
+Bridge _$BridgeFromJson(Map json) => Bridge(
+ type: Bridge._transportFromJson(json['type']),
+ source: json['source'] as String,
+ bridges: (json['bridge_strings'] as List?)
+ ?.map((e) => e as String)
+ .toList(),
+);
+
+Map _$BridgeToJson(Bridge instance) => {
+ 'type': Bridge._transportToJson(instance.type),
+ 'source': instance.source,
+ 'bridge_strings': instance.bridges,
+};
+
+MoatError _$MoatErrorFromJson(Map json) => MoatError(
+ id: json['id'] as String?,
+ type: json['type'] as String?,
+ version: json['version'] as String?,
+ code: (json['code'] as num?)?.toInt(),
+ status: json['status'] as String?,
+ detail: json['detail'] as String?,
+);
+
+Map _$MoatErrorToJson(MoatError instance) => {
+ 'id': instance.id,
+ 'type': instance.type,
+ 'version': instance.version,
+ 'code': instance.code,
+ 'status': instance.status,
+ 'detail': instance.detail,
+};
+
+BuiltInBridges _$BuiltInBridgesFromJson(Map json) =>
+ BuiltInBridges(
+ meek: (json['meek'] as List).map((e) => e as String).toList(),
+ meekAzure: (json['meek-azure'] as List)
+ .map((e) => e as String)
+ .toList(),
+ obfs4: (json['obfs4'] as List).map((e) => e as String).toList(),
+ snowflake: (json['snowflake'] as List)
+ .map((e) => e as String)
+ .toList(),
+ );
+
+Map _$BuiltInBridgesToJson(BuiltInBridges instance) =>
+ {
+ 'meek': instance.meek,
+ 'meek-azure': instance.meekAzure,
+ 'obfs4': instance.obfs4,
+ 'snowflake': instance.snowflake,
+ };
diff --git a/app/lib/features/tor/data/services/builtin_bridges.dart b/app/lib/features/tor/data/services/builtin_bridges.dart
index 67facec5..3e7a34d8 100644
--- a/app/lib/features/tor/data/services/builtin_bridges.dart
+++ b/app/lib/features/tor/data/services/builtin_bridges.dart
@@ -23,8 +23,8 @@ import 'dart:io';
import 'package:flutter/services.dart' show rootBundle;
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart' as path_provider;
-import 'package:pluggable_transports_proxy/pluggable_transports_proxy.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
+import 'package:weblibre/features/tor/data/models/moat.dart';
part 'builtin_bridges.g.dart';
diff --git a/app/lib/features/tor/data/services/moat_api.dart b/app/lib/features/tor/data/services/moat_api.dart
new file mode 100644
index 00000000..a7db217b
--- /dev/null
+++ b/app/lib/features/tor/data/services/moat_api.dart
@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2024-2025 Fabian Freund.
+ *
+ * This file is part of WebLibre
+ * (see https://weblibre.eu).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see .
+ */
+import 'dart:convert';
+
+import 'package:http/http.dart' as http;
+import 'package:weblibre/features/tor/data/models/moat.dart';
+
+class MoatApi {
+ static const String _baseUrl =
+ 'https://bridges.torproject.org/moat/circumvention/';
+
+ final http.Client _client;
+
+ MoatApi(this._client);
+
+ Future settings([SettingsRequest? request]) async {
+ final response = await _post(
+ 'settings',
+ request ?? const SettingsRequest(),
+ );
+ return SettingsResponse.fromJson(
+ jsonDecode(response.body) as Map,
+ );
+ }
+
+ Future defaults([SettingsRequest? request]) async {
+ final response = await _post(
+ 'defaults',
+ request ?? const SettingsRequest(),
+ );
+ return SettingsResponse.fromJson(
+ jsonDecode(response.body) as Map,
+ );
+ }
+
+ Future> map() async {
+ final response = await _get('map');
+ final Map data =
+ jsonDecode(response.body) as Map;
+ return data.map(
+ (key, value) => MapEntry(
+ key,
+ SettingsResponse.fromJson(value as Map),
+ ),
+ );
+ }
+
+ Future builtin() async {
+ final response = await _get('builtin');
+ return BuiltInBridges.fromJson(
+ jsonDecode(response.body) as Map,
+ );
+ }
+
+ Future> countries() async {
+ final response = await _get('countries');
+ return List.from(jsonDecode(response.body) as List);
+ }
+
+ Future _get(String endpoint) async {
+ final uri = Uri.parse('$_baseUrl$endpoint');
+ return await _client
+ .get(uri, headers: _headers)
+ .timeout(const Duration(seconds: 15));
+ }
+
+ Future _post(String endpoint, Object body) async {
+ final uri = Uri.parse('$_baseUrl$endpoint');
+ return await _client
+ .post(uri, headers: _headers, body: jsonEncode(body))
+ .timeout(const Duration(seconds: 15));
+ }
+
+ Map get _headers => {
+ 'Content-Type': 'application/vnd.api+json',
+ 'Accept': 'application/vnd.api+json',
+ };
+
+ void dispose() {
+ _client.close();
+ }
+}
diff --git a/app/lib/features/tor/data/services/moat_service.dart b/app/lib/features/tor/data/services/moat_service.dart
new file mode 100644
index 00000000..285429d4
--- /dev/null
+++ b/app/lib/features/tor/data/services/moat_service.dart
@@ -0,0 +1,184 @@
+/*
+ * Copyright (c) 2024-2025 Fabian Freund.
+ *
+ * This file is part of WebLibre
+ * (see https://weblibre.eu).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see .
+ */
+import 'dart:io';
+
+import 'package:flutter_tor/flutter_tor.dart';
+import 'package:http/io_client.dart';
+import 'package:socks5_proxy/socks_client.dart';
+import 'package:weblibre/features/tor/data/models/moat.dart';
+import 'package:weblibre/features/tor/data/services/moat_api.dart';
+
+const String _meekParameters =
+ 'url=https://1723079976.rsc.cdn77.org;front=www.phpmyadmin.net';
+
+const defaultBridges = [MoatTransportType.obfs4, MoatTransportType.snowflake];
+
+/// Manages MOAT API connections with persistent proxy setup.
+class MoatService {
+ MoatApi? _api;
+
+ /// Initializes the MeekLite proxy and MOAT API connection.
+ /// Must be called before using other methods.
+ Future initialize() async {
+ if (_api != null) return;
+
+ final port = await IPtProxyController().start(TransportType.meek, "");
+
+ final httpClient = HttpClient();
+ SocksTCPClient.assignToHttpClient(httpClient, [
+ ProxySettings(
+ InternetAddress.loopbackIPv4,
+ port,
+ username: _meekParameters,
+ password: '\u0000',
+ ),
+ ]);
+
+ _api = MoatApi(IOClient(httpClient));
+ }
+
+ /// Disposes the API connection and stops the MeekLite proxy.
+ /// Should be called when done using the client.
+ Future dispose() async {
+ if (_api == null) return;
+
+ _api!.dispose();
+ await IPtProxyController().stop(TransportType.meek);
+ _api = null;
+ }
+
+ /// Ensures the client is initialized before API calls.
+ void _ensureInitialized() {
+ if (_api == null) {
+ throw StateError(
+ 'MoatClient must be initialized before use. Call initialize() first.',
+ );
+ }
+ }
+
+ /// Handles MOAT API errors and determines if PT is required.
+ bool _handleMoatErrors(List? errors) {
+ if (errors == null || errors.isEmpty) return false;
+
+ final error = errors.first;
+ if (error.code == 404 || error.code == 406) {
+ // 404: Needs transport, but not the available ones
+ // 406: No country from IP address
+ return true;
+ }
+ throw error;
+ }
+
+ /// Converts BuiltInBridges to Settings for requested transports.
+ static List convertBuiltinToSettings(
+ BuiltInBridges builtinBridges, {
+ List transports = defaultBridges,
+ }) {
+ final settings = [];
+
+ for (final transport in transports) {
+ final bridgeStrings = switch (transport) {
+ MoatTransportType.obfs4 => builtinBridges.obfs4,
+ MoatTransportType.snowflake => builtinBridges.snowflake,
+ MoatTransportType.meek => builtinBridges.meek,
+ MoatTransportType.meekAzure => builtinBridges.meekAzure,
+ MoatTransportType.webtunnel => [], // Not available in builtin
+ };
+
+ if (bridgeStrings.isNotEmpty) {
+ settings.add(
+ Setting(
+ bridge: Bridge(
+ type: transport,
+ source: 'builtin',
+ bridges: bridgeStrings,
+ ),
+ ),
+ );
+ }
+ }
+
+ return settings;
+ }
+
+ /// Gets built-in bridges from the MOAT service endpoint.
+ Future getBuiltinBridges({
+ List transports = defaultBridges,
+ }) async {
+ _ensureInitialized();
+
+ final builtinBridges = await _api!.builtin();
+ return builtinBridges;
+ }
+
+ /// Tries to automatically configure Pluggable Transports.
+ Future?> autoConf({
+ String? country,
+ bool cannotConnectWithoutPt = false,
+ List transports = defaultBridges,
+ }) async {
+ _ensureInitialized();
+
+ bool localCannotConnectWithoutPt = cannotConnectWithoutPt;
+ final request = SettingsRequest(country: country, transports: transports);
+
+ var response = await _api!.settings(request);
+
+ if (_handleMoatErrors(response.errors)) {
+ localCannotConnectWithoutPt = true;
+ }
+
+ final hasSettings = response.settings?.isNotEmpty ?? false;
+ if (!hasSettings && !localCannotConnectWithoutPt) {
+ return null;
+ }
+
+ if (hasSettings) {
+ return response.settings;
+ }
+
+ response = await _api!.defaults(SettingsRequest(transports: transports));
+ return response.settings;
+ }
+
+ Future?> getDefaultBridges({
+ List transports = defaultBridges,
+ }) async {
+ _ensureInitialized();
+
+ final response = await _api!.defaults(
+ SettingsRequest(transports: transports),
+ );
+
+ return response.settings;
+ }
+
+ /// Gets the list of supported countries from the MOAT service.
+ Future> getCountries() async {
+ _ensureInitialized();
+ return await _api!.countries();
+ }
+
+ /// Gets the country-to-settings map from the MOAT service.
+ Future> getMap() async {
+ _ensureInitialized();
+ return await _api!.map();
+ }
+}
diff --git a/app/lib/features/tor/domain/repositories/builtin_bridges.dart b/app/lib/features/tor/domain/repositories/builtin_bridges.dart
index 2e5ac81b..37684955 100644
--- a/app/lib/features/tor/domain/repositories/builtin_bridges.dart
+++ b/app/lib/features/tor/domain/repositories/builtin_bridges.dart
@@ -17,10 +17,11 @@
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*/
-import 'package:pluggable_transports_proxy/pluggable_transports_proxy.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:weblibre/core/logger.dart';
+import 'package:weblibre/features/tor/data/models/moat.dart';
import 'package:weblibre/features/tor/data/services/builtin_bridges.dart';
+import 'package:weblibre/features/tor/data/services/moat_service.dart';
part 'builtin_bridges.g.dart';
diff --git a/app/lib/features/tor/domain/services/tor_proxy.dart b/app/lib/features/tor/domain/services/tor_proxy.dart
index b0ca92aa..a3476211 100644
--- a/app/lib/features/tor/domain/services/tor_proxy.dart
+++ b/app/lib/features/tor/domain/services/tor_proxy.dart
@@ -18,107 +18,34 @@
* along with this program. If not, see .
*/
import 'dart:async';
-import 'dart:ui';
import 'package:collection/collection.dart';
-import 'package:flutter_background_service/flutter_background_service.dart';
+import 'package:flutter_tor/flutter_tor.dart';
import 'package:nullability/nullability.dart';
-import 'package:pluggable_transports_proxy/pluggable_transports_proxy.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:rxdart/rxdart.dart';
import 'package:weblibre/core/logger.dart';
-import 'package:weblibre/features/geckoview/features/browser/domain/providers/lifecycle.dart';
+import 'package:weblibre/features/tor/data/models/moat.dart';
+import 'package:weblibre/features/tor/data/services/moat_service.dart';
import 'package:weblibre/features/tor/domain/repositories/builtin_bridges.dart';
-import 'package:weblibre/features/tor/utils/tor_entrypoint.dart';
import 'package:weblibre/features/user/data/models/tor_settings.dart';
import 'package:weblibre/features/user/domain/repositories/tor_settings.dart';
part 'tor_proxy.g.dart';
-class _TorService {
- final service = FlutterBackgroundService();
-
- final _portSubject = BehaviorSubject.seeded(null);
-
- ValueStream get portStream => _portSubject.stream;
-
- Future startOrReconfigure({
- ProxyType? proxyType,
- String? bridgeLines,
- }) async {
- await service.startService();
- service.invoke('startOrReconfigure', {
- if (proxyType != null) 'proxyType': proxyType.name,
- if (bridgeLines != null) 'bridgeLines': bridgeLines,
- });
- }
-
- Future reconfigure({ProxyType? proxyType, String? bridgeLines}) async {
- service.invoke('reconfigure', {
- if (proxyType != null) 'proxyType': proxyType.name,
- if (bridgeLines != null) 'bridgeLines': bridgeLines,
- });
- }
-
- Future requestSync() async {
- service.invoke("sync");
- }
-
- Future sendHeartbeat() async {
- service.invoke("heartbeat");
- }
-
- Future stop() async {
- service.invoke("stop");
- }
-
- Future initializeService() async {
- await service.configure(
- iosConfiguration: IosConfiguration(autoStart: false),
- androidConfiguration: AndroidConfiguration(
- autoStart: false,
- onStart: onStart,
- isForegroundMode: true,
- autoStartOnBoot: false,
- initialNotificationTitle: 'Tor Service',
- initialNotificationContent: 'Running in background',
- ),
- );
-
- service.on('portUpdate').listen((data) {
- final port = data!['port'] as int;
- _portSubject.add((port > -1) ? port : null);
- });
- }
-
- Future dispose() async {
- await stop();
- await _portSubject.close();
- }
-}
-
@Riverpod(keepAlive: true)
class TorProxyService extends _$TorProxyService {
- final _tor = _TorService();
+ final _tor = FlutterTor();
+ late StreamController _statusSyncController;
- Timer? _heartbeatUpdate;
- //This is managed by widget state changes to resume a timer
- bool _timerPaused = false;
+ Future startOrReconfigure({
+ required bool reconfigureIfRunning,
+ }) async {
+ final currentStatus = await _tor.getStatus();
- void _enableHeartbeatTimer() {
- _heartbeatUpdate?.cancel();
- _timerPaused = false;
- _heartbeatUpdate = Timer.periodic(const Duration(seconds: 30), (
- timer,
- ) async {
- await _tor.sendHeartbeat();
- });
- }
-
- Future startOrReconfigure({bool forceReconnect = false}) async {
- final currentPort = await requestSync();
-
- if (currentPort == null || forceReconnect) {
+ if (!currentStatus.isRunning ||
+ currentStatus.socksPort == null ||
+ reconfigureIfRunning) {
state = const AsyncLoading();
final torSettings = await ref
@@ -153,10 +80,10 @@ class TorProxyService extends _$TorProxyService {
setting = config.mapNotNull(
(config) =>
config.firstWhereOrNull(
- (setting) => setting.bridge.type == TransportType.obfs4,
+ (setting) => setting.bridge.type == MoatTransportType.obfs4,
) ??
config.firstWhereOrNull(
- (setting) => setting.bridge.type == TransportType.snowflake,
+ (setting) => setting.bridge.type == MoatTransportType.snowflake,
),
);
} else if (torSettings.config != TorConnectionConfig.direct) {
@@ -186,8 +113,9 @@ class TorProxyService extends _$TorProxyService {
switch (torSettings.config) {
TorConnectionConfig.auto => throw UnimplementedError(),
TorConnectionConfig.direct => throw UnimplementedError(),
- TorConnectionConfig.obfs4 => TransportType.obfs4,
- TorConnectionConfig.snowflake => TransportType.snowflake,
+ TorConnectionConfig.obfs4 => MoatTransportType.obfs4,
+ TorConnectionConfig.snowflake =>
+ MoatTransportType.snowflake,
},
),
);
@@ -198,96 +126,44 @@ class TorProxyService extends _$TorProxyService {
}
}
- if (setting != null) {
- switch (setting.bridge.type) {
- case TransportType.obfs4:
- await _tor.startOrReconfigure(
- proxyType: ProxyType.obfs4,
- bridgeLines: setting.bridge.bridges?.join('\n'),
- );
- case TransportType.snowflake:
- await _tor.startOrReconfigure(
- proxyType: ProxyType.snowflake,
- bridgeLines: setting.bridge.bridges?.join('\n'),
- );
- case TransportType.meek:
- case TransportType.meekAzure:
- case TransportType.webtunnel:
- throw UnimplementedError();
- }
- } else {
- await _tor.startOrReconfigure();
- }
+ final config = TorConfiguration(
+ transport: switch (setting?.bridge.type) {
+ MoatTransportType.obfs4 => TransportType.obfs4,
+ MoatTransportType.snowflake => TransportType.snowflake,
+ MoatTransportType.meek => TransportType.meek,
+ MoatTransportType.meekAzure => TransportType.meekAzure,
+ MoatTransportType.webtunnel => TransportType.webtunnel,
+ null => TransportType.none,
+ },
+ bridgeLines: setting?.bridge.bridges ?? [],
+ );
- _enableHeartbeatTimer();
+ await _tor.start(config);
+ return _tor.getStatus();
}
+
+ return currentStatus;
}
- Future requestSync() async {
- final nextPortUpdate = _tor.portStream.first;
-
- await _tor.requestSync();
- return nextPortUpdate;
+ Future requestSync() async {
+ final status = await _tor.getStatus();
+ _statusSyncController.add(status);
+ return status;
}
Future disconnect() async {
- state = const AsyncLoading();
-
- _heartbeatUpdate?.cancel();
- _heartbeatUpdate = null;
- _timerPaused = false;
-
await _tor.stop();
}
@override
- Future build() async {
- final portSub = _tor.portStream.distinct().listen((port) {
- state = AsyncData(port);
- });
-
- await _tor.initializeService();
-
- if (!ref.mounted) return null;
-
- ref.listen(
- fireImmediately: true,
- browserViewLifecycleProvider,
- (previous, next) {
- switch (next) {
- case AppLifecycleState.resumed:
- if (_timerPaused) {
- _enableHeartbeatTimer();
- }
- case AppLifecycleState.detached:
- case AppLifecycleState.inactive:
- case AppLifecycleState.hidden:
- case AppLifecycleState.paused:
- case null:
- if (_heartbeatUpdate?.isActive == true) {
- _heartbeatUpdate?.cancel();
- _timerPaused = true;
- }
- }
- },
- onError: (error, stackTrace) {
- logger.e(
- 'Error listening to browserViewLifecycleProvider',
- error: error,
- stackTrace: stackTrace,
- );
- },
- );
+ Stream build() {
+ _statusSyncController = StreamController();
ref.onDispose(() async {
- _heartbeatUpdate?.cancel();
- _heartbeatUpdate = null;
- _timerPaused = false;
-
- await portSub.cancel();
- await _tor.dispose();
+ await _statusSyncController.close();
+ await _tor.stop();
});
- return _tor.portStream.valueOrNull;
+ return MergeStream([_tor.statusStream, _statusSyncController.stream]);
}
}
diff --git a/app/lib/features/tor/domain/services/tor_proxy.g.dart b/app/lib/features/tor/domain/services/tor_proxy.g.dart
index 7aaccafc..8507a073 100644
--- a/app/lib/features/tor/domain/services/tor_proxy.g.dart
+++ b/app/lib/features/tor/domain/services/tor_proxy.g.dart
@@ -13,7 +13,7 @@ part of 'tor_proxy.dart';
final torProxyServiceProvider = TorProxyServiceProvider._();
final class TorProxyServiceProvider
- extends $AsyncNotifierProvider {
+ extends $StreamNotifierProvider {
TorProxyServiceProvider._()
: super(
from: null,
@@ -33,19 +33,19 @@ final class TorProxyServiceProvider
TorProxyService create() => TorProxyService();
}
-String _$torProxyServiceHash() => r'c63adf96d7b0a865917b8d902071a0b3ae4dfcc6';
+String _$torProxyServiceHash() => r'be69327bdef8feaa2a43bd83f20168988dcdd228';
-abstract class _$TorProxyService extends $AsyncNotifier {
- FutureOr build();
+abstract class _$TorProxyService extends $StreamNotifier {
+ Stream build();
@$mustCallSuper
@override
void runBuild() {
- final ref = this.ref as $Ref, int?>;
+ final ref = this.ref as $Ref, TorStatus>;
final element =
ref.element
as $ClassProviderElement<
- AnyNotifier, int?>,
- AsyncValue,
+ AnyNotifier, TorStatus>,
+ AsyncValue,
Object?,
Object?
>;
diff --git a/app/lib/features/tor/presentation/controllers/start_tor_proxy.dart b/app/lib/features/tor/presentation/controllers/start_tor_proxy.dart
index 81b9b984..0b7a00bc 100644
--- a/app/lib/features/tor/presentation/controllers/start_tor_proxy.dart
+++ b/app/lib/features/tor/presentation/controllers/start_tor_proxy.dart
@@ -31,11 +31,11 @@ class StartProxyController extends _$StartProxyController {
// ignore: document_ignores is used for dialog
// ignore: avoid_build_context_in_providers
Future maybeStartProxy(BuildContext context) async {
- final torProxyRunning = await ref
+ final currentStatus = await ref
.read(torProxyServiceProvider.notifier)
.requestSync();
- if (torProxyRunning == null) {
+ if (!currentStatus.isRunning) {
if (context.mounted) {
final result = await showDialog(
context: context,
@@ -47,7 +47,7 @@ class StartProxyController extends _$StartProxyController {
if (result == true) {
final connection = ref
.read(torProxyServiceProvider.notifier)
- .startOrReconfigure();
+ .startOrReconfigure(reconfigureIfRunning: false);
ref
.read(overlayControllerProvider.notifier)
@@ -59,9 +59,6 @@ class StartProxyController extends _$StartProxyController {
await connection;
}
}
- } else {
- //Reconfigure
- await ref.read(torProxyServiceProvider.notifier).startOrReconfigure();
}
}
diff --git a/app/lib/features/tor/presentation/controllers/start_tor_proxy.g.dart b/app/lib/features/tor/presentation/controllers/start_tor_proxy.g.dart
index 9fb99b65..cec88072 100644
--- a/app/lib/features/tor/presentation/controllers/start_tor_proxy.g.dart
+++ b/app/lib/features/tor/presentation/controllers/start_tor_proxy.g.dart
@@ -42,7 +42,7 @@ final class StartProxyControllerProvider
}
String _$startProxyControllerHash() =>
- r'86a015a0c257ea18ad23aa28bdd43d289b6bfc64';
+ r'13c6ad9611a2f9525689d370a0511274aa9c0f03';
abstract class _$StartProxyController extends $Notifier {
void build();
diff --git a/app/lib/features/tor/presentation/screens/tor_proxy.dart b/app/lib/features/tor/presentation/screens/tor_proxy.dart
index 959f9abc..54b90714 100644
--- a/app/lib/features/tor/presentation/screens/tor_proxy.dart
+++ b/app/lib/features/tor/presentation/screens/tor_proxy.dart
@@ -19,6 +19,7 @@
*/
import 'package:fading_scroll/fading_scroll.dart';
import 'package:flutter/material.dart';
+import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:flutter_material_design_icons/flutter_material_design_icons.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:weblibre/core/design/app_colors.dart';
@@ -34,7 +35,32 @@ class TorProxyScreen extends HookConsumerWidget {
@override
Widget build(BuildContext context, WidgetRef ref) {
- final torProxyPort = ref.watch(torProxyServiceProvider);
+ final bootstrapProgress = ref.watch(
+ torProxyServiceProvider.select(
+ (value) => value.value?.bootstrapProgress ?? 0,
+ ),
+ );
+
+ final torPendingRequest = useState(null);
+ ref.listen(torProxyServiceProvider, (previous, next) {
+ if (next.hasValue && torPendingRequest.value != null) {
+ if (next.requireValue.isRunning != previous?.value?.isRunning ||
+ next.requireValue.bootstrapProgress !=
+ previous?.value?.bootstrapProgress) {
+ torPendingRequest.value = null;
+ }
+ }
+ });
+
+ final torIsRunning = ref.watch(
+ torProxyServiceProvider.select(
+ (value) => value.value?.isRunning ?? false,
+ ),
+ );
+
+ final torIsBusy =
+ torPendingRequest.value != null ||
+ bootstrapProgress > 0 && bootstrapProgress < 100;
final torSettings = ref.watch(torSettingsWithDefaultsProvider);
useOnInitialization(() async {
@@ -43,9 +69,10 @@ class TorProxyScreen extends HookConsumerWidget {
ref.listen(torSettingsRepositoryProvider, (previous, next) async {
final torService = ref.read(torProxyServiceProvider.notifier);
+ final currentStatus = await torService.requestSync();
- if (await torService.requestSync() != null) {
- await torService.startOrReconfigure();
+ if (currentStatus.isRunning) {
+ await torService.startOrReconfigure(reconfigureIfRunning: true);
}
});
@@ -110,17 +137,23 @@ class TorProxyScreen extends HookConsumerWidget {
}
return null; // Use the default color.
}),
- value: torProxyPort.value != null,
+ value: torPendingRequest.value ?? torIsRunning,
title: const Text('Tor™ Proxy'),
secondary: const Icon(MdiIcons.power),
- onChanged: torProxyPort.isLoading
+ onChanged: torIsBusy
? null
: (value) async {
if (value) {
+ torPendingRequest.value = true;
+
await ref
.read(torProxyServiceProvider.notifier)
- .startOrReconfigure();
+ .startOrReconfigure(
+ reconfigureIfRunning: false,
+ );
} else {
+ torPendingRequest.value = false;
+
await ref
.read(torProxyServiceProvider.notifier)
.disconnect();
@@ -259,7 +292,7 @@ class TorProxyScreen extends HookConsumerWidget {
secondary: const Icon(
MdiIcons.arrowDecisionAuto,
),
- onChanged: torProxyPort.isLoading
+ onChanged: torIsBusy
? null
: (value) async {
await ref
@@ -291,7 +324,7 @@ class TorProxyScreen extends HookConsumerWidget {
left: 56,
right: 24,
),
- onChanged: torProxyPort.isLoading
+ onChanged: torIsBusy
? null
: (value) async {
await ref
@@ -330,7 +363,7 @@ class TorProxyScreen extends HookConsumerWidget {
children: [
RadioListTile.adaptive(
value: TorConnectionConfig.direct,
- enabled: !torProxyPort.isLoading,
+ enabled: !torIsBusy,
contentPadding: const EdgeInsets.only(
left: 56,
right: 24,
@@ -342,7 +375,7 @@ class TorProxyScreen extends HookConsumerWidget {
),
RadioListTile.adaptive(
value: TorConnectionConfig.obfs4,
- enabled: !torProxyPort.isLoading,
+ enabled: !torIsBusy,
contentPadding: const EdgeInsets.only(
left: 56,
right: 24,
@@ -354,7 +387,7 @@ class TorProxyScreen extends HookConsumerWidget {
),
RadioListTile.adaptive(
value: TorConnectionConfig.snowflake,
- enabled: !torProxyPort.isLoading,
+ enabled: !torIsBusy,
contentPadding: const EdgeInsets.only(
left: 56,
right: 24,
@@ -378,7 +411,7 @@ class TorProxyScreen extends HookConsumerWidget {
left: 56,
right: 24,
),
- onChanged: torProxyPort.isLoading
+ onChanged: torIsBusy
? null
: (value) async {
if (value != null) {
@@ -413,23 +446,24 @@ class TorProxyScreen extends HookConsumerWidget {
child: Column(
mainAxisSize: MainAxisSize.min,
children: [
- if (torProxyPort.isLoading)
- const Column(
+ if (torIsBusy)
+ Column(
mainAxisSize: MainAxisSize.min,
children: [
- SizedBox(height: 8),
+ const SizedBox(height: 8),
LinearProgressIndicator(
backgroundColor: AppColors.torBackgroundGrey,
color: AppColors.torActiveGreen,
+ value: bootstrapProgress / 100,
),
- SizedBox(height: 8),
- Text(
+ const SizedBox(height: 8),
+ const Text(
'Establishing connection...',
style: TextStyle(color: Colors.white),
),
],
- ),
- if (torProxyPort.value != null)
+ )
+ else if (torIsRunning)
Padding(
padding: const EdgeInsets.only(top: 24.0),
child: Row(
diff --git a/app/lib/features/tor/utils/tor_entrypoint.dart b/app/lib/features/tor/utils/tor_entrypoint.dart
deleted file mode 100644
index 72fae3ba..00000000
--- a/app/lib/features/tor/utils/tor_entrypoint.dart
+++ /dev/null
@@ -1,156 +0,0 @@
-/*
- * Copyright (c) 2024-2025 Fabian Freund.
- *
- * This file is part of WebLibre
- * (see https://weblibre.eu).
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see .
- */
-import 'dart:async';
-
-import 'package:collection/collection.dart';
-import 'package:flutter_background_service/flutter_background_service.dart';
-import 'package:pluggable_transports_proxy/pluggable_transports_proxy.dart';
-import 'package:tor/tor.dart';
-
-@pragma('vm:entry-point')
-Future onStart(ServiceInstance service) async {
- Timer? timeout;
- final startedProxyType = {};
-
- Tor.init();
-
- final portSub = Tor.instance.events.stream.listen((port) {
- service.invoke('portUpdate', {'port': port});
- });
-
- Future stopProxies() async {
- for (final proxyType in startedProxyType) {
- await IPtProxyController().stop(proxyType);
- }
- startedProxyType.clear();
- }
-
- Future stopService() async {
- timeout?.cancel();
- timeout = null;
-
- Tor.instance.stop();
- await stopProxies();
-
- service.invoke('portUpdate', {'port': -1});
-
- await portSub.cancel();
-
- await service.stopSelf();
- }
-
- void addHeartbeat() {
- timeout?.cancel();
- //Kill service after 1 hour of inactivity
- timeout = Timer(const Duration(hours: 1), () async {
- // logger.i('Terminating tor due to timeout');
- await stopService();
- });
- }
-
- Future startService(ProxyType? proxyType, String? bridgeLines) async {
- if (proxyType != null) {
- final port = await IPtProxyController().start(proxyType, "");
- startedProxyType.add(proxyType);
-
- switch (proxyType) {
- case ProxyType.obfs4:
- await Tor.instance.start(obfs4Port: port, bridgeLines: bridgeLines);
- case ProxyType.meekLite:
- throw UnimplementedError();
- case ProxyType.webtunnel:
- throw UnimplementedError();
- case ProxyType.snowflake:
- await Tor.instance.start(
- snowflakePort: port,
- bridgeLines: bridgeLines,
- );
- }
- } else {
- await Tor.instance.start();
- }
- }
-
- Future reconfigureService(
- ProxyType? proxyType,
- String? bridgeLines,
- ) async {
- if (Tor.instance.hasClient) {
- await stopProxies();
-
- if (proxyType != null) {
- final port = await IPtProxyController().start(proxyType, "");
- startedProxyType.add(proxyType);
-
- switch (proxyType) {
- case ProxyType.obfs4:
- await Tor.instance.reconfigure(
- obfs4Port: port,
- bridgeLines: bridgeLines,
- );
- case ProxyType.meekLite:
- throw UnimplementedError();
- case ProxyType.webtunnel:
- throw UnimplementedError();
- case ProxyType.snowflake:
- await Tor.instance.reconfigure(
- snowflakePort: port,
- bridgeLines: bridgeLines,
- );
- }
- } else {
- await Tor.instance.reconfigure();
- }
- }
- }
-
- service.on("startOrReconfigure").listen((event) async {
- final proxyType = ProxyType.values.firstWhereOrNull(
- (x) => x.name == event?['proxyType'],
- );
-
- await reconfigureService(proxyType, event?['bridgeLines'] as String?);
-
- if (!Tor.instance.hasClient) {
- await startService(proxyType, event?['bridgeLines'] as String?);
- }
- });
-
- service.on("reconfigure").listen((event) async {
- final proxyType = ProxyType.values.firstWhereOrNull(
- (x) => x.name == event?['proxyType'],
- );
-
- await reconfigureService(proxyType, event?['bridgeLines'] as String?);
- });
-
- service.on("heartbeat").listen((event) {
- // logger.d('Received tor heartbeat');
- addHeartbeat();
- });
-
- service.on("sync").listen((event) {
- service.invoke('portUpdate', {'port': Tor.instance.port});
- });
-
- service.on("stop").listen((event) async {
- await stopService();
- });
-}
diff --git a/app/lib/presentation/controllers/website_title.dart b/app/lib/presentation/controllers/website_title.dart
index 5a6b4cf6..562f2f06 100644
--- a/app/lib/presentation/controllers/website_title.dart
+++ b/app/lib/presentation/controllers/website_title.dart
@@ -93,7 +93,9 @@ Future pageInfo(
(tabState.isPrivate == false &&
torSettings.proxyRegularTabsMode == TorRegularTabProxyMode.all) ||
(tabState.isPrivate == true && torSettings.proxyPrivateTabsTor)) {
- proxyPort = await ref.read(torProxyServiceProvider.future);
+ proxyPort = await ref.read(
+ torProxyServiceProvider.selectAsync((value) => value.socksPort),
+ );
if (proxyPort == null) {
throw Exception('Could not proxy request');
diff --git a/app/lib/presentation/controllers/website_title.g.dart b/app/lib/presentation/controllers/website_title.g.dart
index 49b3c9f1..0ae20567 100644
--- a/app/lib/presentation/controllers/website_title.g.dart
+++ b/app/lib/presentation/controllers/website_title.g.dart
@@ -162,7 +162,7 @@ final class PageInfoProvider
}
}
-String _$pageInfoHash() => r'89b1cd86bb7ed7cfe507650cca33d6b6b72ca770';
+String _$pageInfoHash() => r'19116a520df214240254f95989818c1ac3bde6f6';
final class PageInfoFamily extends $Family
with
diff --git a/app/pubspec.yaml b/app/pubspec.yaml
index 7f78773c..f9cfa065 100644
--- a/app/pubspec.yaml
+++ b/app/pubspec.yaml
@@ -26,7 +26,6 @@ dependencies:
flutter:
sdk: flutter
flutter_auto_size_text: ^4.1.0
- flutter_background_service: ^5.1.0
flutter_hooks: ^0.21.3+1
flutter_markdown: ^0.7.7+1
flutter_material_design_icons: ^1.1.7447
@@ -35,6 +34,8 @@ dependencies:
flutter_reorderable_grid_view: ^5.5.2
flutter_slidable: ^4.0.3
flutter_svg: ^2.2.3
+ flutter_tor:
+ path: ../packages/flutter_tor
go_router: ^17.0.1
google_fonts: ^6.3.3
graphview: ^1.5.1
@@ -58,8 +59,6 @@ dependencies:
path: ^1.9.1
path_provider: ^2.1.5
permission_handler: ^12.0.1
- pluggable_transports_proxy:
- path: ../packages/pluggable_transports_proxy
pretty_qr_code: ^3.5.0
quick_actions: ^1.1.0
riverpod: ^3.1.0
@@ -85,8 +84,6 @@ dependencies:
synchronized: ^3.4.0
text_scroll: ^0.2.1
timeago: ^3.7.1
- tor:
- path: ../packages/tor
uri_to_file:
git:
url: https://github.com/FaFre/uri-to-file.git
diff --git a/packages/flutter_tor/.gitignore b/packages/flutter_tor/.gitignore
new file mode 100644
index 00000000..b9d7f25b
--- /dev/null
+++ b/packages/flutter_tor/.gitignore
@@ -0,0 +1,33 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.build/
+.buildlog/
+.history
+.svn/
+.swiftpm/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.flutter-plugins-dependencies
+/build/
+/coverage/
diff --git a/packages/flutter_tor/.metadata b/packages/flutter_tor/.metadata
new file mode 100644
index 00000000..7a9751c8
--- /dev/null
+++ b/packages/flutter_tor/.metadata
@@ -0,0 +1,30 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+ revision: "f6ff1529fd6d8af5f706051d9251ac9231c83407"
+ channel: "stable"
+
+project_type: plugin
+
+# Tracks metadata for the flutter migrate command
+migration:
+ platforms:
+ - platform: root
+ create_revision: f6ff1529fd6d8af5f706051d9251ac9231c83407
+ base_revision: f6ff1529fd6d8af5f706051d9251ac9231c83407
+ - platform: android
+ create_revision: f6ff1529fd6d8af5f706051d9251ac9231c83407
+ base_revision: f6ff1529fd6d8af5f706051d9251ac9231c83407
+
+ # User provided section
+
+ # List of Local paths (relative to this file) that should be
+ # ignored by the migrate tool.
+ #
+ # Files that are not part of the templates will be ignored by default.
+ unmanaged_files:
+ - 'lib/main.dart'
+ - 'ios/Runner.xcodeproj/project.pbxproj'
diff --git a/packages/flutter_tor/CHANGELOG.md b/packages/flutter_tor/CHANGELOG.md
new file mode 100644
index 00000000..41cc7d81
--- /dev/null
+++ b/packages/flutter_tor/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.
diff --git a/packages/flutter_tor/LICENSE b/packages/flutter_tor/LICENSE
new file mode 100644
index 00000000..ba75c69f
--- /dev/null
+++ b/packages/flutter_tor/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/packages/flutter_tor/README.md b/packages/flutter_tor/README.md
new file mode 100644
index 00000000..3f3fa485
--- /dev/null
+++ b/packages/flutter_tor/README.md
@@ -0,0 +1,215 @@
+# flutter_tor
+
+A Flutter plugin for running Tor with pluggable transports on Android. This plugin provides a simple SOCKS5 proxy interface to the Tor network with support for multiple transport types and country-based node selection.
+
+## Features
+
+- **Multiple Transport Types**: Direct connection, obfs4, Snowflake, Meek, WebTunnel, and custom bridges
+- **SOCKS5 Proxy**: Returns a random local port for SOCKS5 connections
+- **Country Selection**: Configure entry and exit node countries
+- **Background Service**: Keeps Tor running even when app is backgrounded
+- **Log Streaming**: Real-time log messages from Tor
+- **Bootstrap Progress**: Track connection progress (0-100%)
+- **New Identity**: Request new Tor circuits on demand
+
+## Supported Platforms
+
+- ✅ Android
+- ❌ iOS (not yet implemented)
+
+## Installation
+
+Add to your `pubspec.yaml`:
+
+```yaml
+dependencies:
+ flutter_tor:
+ path: ../flutter_tor # Update path as needed
+```
+
+## Usage
+
+### Basic Example
+
+```dart
+import 'package:flutter_tor/flutter_tor.dart';
+
+final tor = FlutterTor();
+
+// Start Tor with direct connection
+final result = await tor.start(TorConfiguration(
+ transport: TransportType.none,
+ bridgeLines: [],
+));
+
+print('SOCKS proxy running on port ${result.socksPort}');
+```
+
+### With Snowflake Bridge
+
+```dart
+final result = await tor.start(TorConfiguration(
+ transport: TransportType.snowflake,
+ bridgeLines: [
+ 'snowflake 192.0.2.3:1 2B280B23E1107BB62ABFC40DDCC8824814F5...',
+ ],
+));
+```
+
+### With Country Selection
+
+```dart
+final result = await tor.start(TorConfiguration(
+ transport: TransportType.obfs4,
+ bridgeLines: ['obfs4 ...'],
+ entryNodeCountries: 'de,fr,nl', // Entry via Germany, France, or Netherlands
+ exitNodeCountries: 'ch,is', // Exit via Switzerland or Iceland
+ strictNodes: false, // Allow fallback if specified countries unavailable
+));
+```
+
+### Listening to Logs
+
+```dart
+tor.logStream.listen((log) {
+ print('[${log.severity}] ${log.message}');
+});
+
+tor.bootstrapProgressStream.listen((progress) {
+ print('Bootstrap: $progress%');
+});
+
+tor.statusStream.listen((status) {
+ print('Tor running: ${status.isRunning}');
+ print('SOCKS port: ${status.socksPort}');
+});
+```
+
+### Stop/Restart with Different Config
+
+```dart
+// Stop Tor
+await tor.stop();
+
+// Start again with different config
+await tor.start(TorConfiguration(
+ transport: TransportType.meek,
+ bridgeLines: ['meek_lite ...'],
+ exitNodeCountries: 'se,no',
+));
+```
+
+### Request New Identity
+
+```dart
+// Get a new Tor circuit
+await tor.requestNewIdentity();
+```
+
+## Transport Types
+
+| Transport | Description |
+|-----------|-------------|
+| `none` | Direct Tor connection (no bridges) |
+| `obfs4` | obfs4 pluggable transport |
+| `snowflake` | Snowflake (default broker) |
+| `snowflakeAmp` | Snowflake via AMP cache |
+| `meek` | Meek pluggable transport |
+| `meekAzure` | Meek via Azure CDN |
+| `webtunnel` | WebTunnel pluggable transport |
+| `custom` | Custom bridge lines (auto-detected) |
+
+## Permissions
+
+The plugin requires the following Android permissions (automatically added):
+
+- `INTERNET` - Network access
+- `ACCESS_NETWORK_STATE` - Network state detection
+- `FOREGROUND_SERVICE` - Keep Tor running in background
+- `FOREGROUND_SERVICE_SPECIAL_USE` - Android 14+ requirement
+- `POST_NOTIFICATIONS` - Android 13+ for foreground service notification
+
+## Architecture
+
+This plugin is a simplified version of Orbot, extracting only the core Tor + Pluggable Transport functionality:
+
+- **No VPN mode** - Only SOCKS5 proxy
+- **No per-app routing** - Use the SOCKS proxy directly
+- **Foreground Service** - Keeps Tor running with a notification
+- **Pigeon Communication** - Type-safe Flutter ↔ Native communication
+
+## Building from Source
+
+### Prerequisites
+
+1. Clone with submodules:
+ ```bash
+ git clone --recursive https://github.com/yourusername/orbot
+ cd orbot/flutter_tor
+ ```
+
+2. Install dependencies:
+ ```bash
+ flutter pub get
+ ```
+
+3. Generate Pigeon code:
+ ```bash
+ flutter pub run pigeon --input pigeons/tor_api.dart
+ ```
+
+### Run Example
+
+```bash
+cd example
+flutter run
+```
+
+## Dependencies
+
+- **tor-android** (0.4.8.21.1) - Native Tor binaries
+- **jtorctl** (0.4.5.7) - Tor control protocol
+- **IPtProxy** (4.3.0) - Pluggable transports (obfs4, snowflake, meek, webtunnel)
+- **Pigeon** (22.6.3) - Flutter ↔ Native communication
+
+## Size Impact
+
+- APK size increase: ~18-22MB (Tor binaries + IPtProxy for all ABIs)
+- Supports: armeabi-v7a, arm64-v8a, x86, x86_64
+
+## Limitations
+
+- Android only (iOS not implemented)
+- No VPN mode (SOCKS5 proxy only)
+- No HTTP proxy (SOCKS5 only)
+- GeoIP files may not be available (country selection optional)
+
+## Troubleshooting
+
+### Tor fails to start
+
+- Check logStream for error messages
+- Ensure bridge lines are valid for the selected transport
+- Verify network connectivity
+- Try with TransportType.none first
+
+### Country selection not working
+
+- GeoIP files must be available (check logs)
+- Country codes must be ISO 3166-1 alpha-2 (e.g., "US", "DE")
+- Use strictNodes: false to allow fallback
+
+### App crashes on startup
+
+- Ensure all submodules are initialized: `git submodule update --init --recursive`
+- Check Android Studio build output for missing dependencies
+
+## Contributing
+
+This plugin is part of the Orbot project. See the main repository for contribution guidelines.
+
+## License
+
+Copyright © 2009-2025, Nathan Freitas, The Guardian Project
+
+See LICENSE file for details.
diff --git a/packages/flutter_tor/analysis_options.yaml b/packages/flutter_tor/analysis_options.yaml
new file mode 100644
index 00000000..a5744c1c
--- /dev/null
+++ b/packages/flutter_tor/analysis_options.yaml
@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/packages/flutter_tor/android/.gitignore b/packages/flutter_tor/android/.gitignore
new file mode 100644
index 00000000..161bdcda
--- /dev/null
+++ b/packages/flutter_tor/android/.gitignore
@@ -0,0 +1,9 @@
+*.iml
+.gradle
+/local.properties
+/.idea/workspace.xml
+/.idea/libraries
+.DS_Store
+/build
+/captures
+.cxx
diff --git a/packages/flutter_tor/android/build.gradle b/packages/flutter_tor/android/build.gradle
new file mode 100644
index 00000000..0ceb3083
--- /dev/null
+++ b/packages/flutter_tor/android/build.gradle
@@ -0,0 +1,80 @@
+group = "eu.weblibre.flutter_tor"
+version = "1.0-SNAPSHOT"
+
+buildscript {
+ ext.kotlin_version = "2.2.20"
+ repositories {
+ google()
+ mavenCentral()
+ }
+
+ dependencies {
+ classpath("com.android.tools.build:gradle:8.11.1")
+ classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")
+ }
+}
+
+allprojects {
+ repositories {
+ google()
+ mavenCentral()
+ maven { url = uri("https://jitpack.io") }
+ maven { url = uri("https://raw.githubusercontent.com/guardianproject/gpmaven/master") }
+ }
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+android {
+ namespace = "eu.weblibre.flutter_tor"
+
+ compileSdk = 36
+
+ compileOptions {
+ sourceCompatibility = JavaVersion.VERSION_17
+ targetCompatibility = JavaVersion.VERSION_17
+ }
+
+ kotlinOptions {
+ jvmTarget = JavaVersion.VERSION_17
+ }
+
+ sourceSets {
+ main.java.srcDirs += "src/main/kotlin"
+ test.java.srcDirs += "src/test/kotlin"
+ }
+
+ defaultConfig {
+ minSdk = 24
+ }
+
+ dependencies {
+ // Tor core libraries
+ implementation("info.guardianproject:tor-android:0.4.8.21.1")
+ implementation("info.guardianproject:jtorctl:0.4.5.7")
+
+ // Pluggable transports
+ implementation("com.netzarchitekten:IPtProxy:4.3.0")
+
+ // Coroutines for async operations
+ implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
+ implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.10.2")
+
+ // Testing
+ 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
+ }
+ }
+ }
+}
diff --git a/packages/flutter_tor/android/settings.gradle b/packages/flutter_tor/android/settings.gradle
new file mode 100644
index 00000000..18d8872f
--- /dev/null
+++ b/packages/flutter_tor/android/settings.gradle
@@ -0,0 +1 @@
+rootProject.name = 'flutter_tor'
diff --git a/packages/flutter_tor/android/src/main/AndroidManifest.xml b/packages/flutter_tor/android/src/main/AndroidManifest.xml
new file mode 100644
index 00000000..f447f7f2
--- /dev/null
+++ b/packages/flutter_tor/android/src/main/AndroidManifest.xml
@@ -0,0 +1,29 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+