feat: Add Windows support to openvpn_flutter by Spokplacenta · Pull Request #147 · nizwar/openvpn_flutter

Spokplacenta · 2025-12-22T17:05:40Z

Add Windows Support to openvpn_flutter

Summary

This PR adds comprehensive Windows support to the openvpn_flutter plugin, allowing Flutter applications to connect to OpenVPN servers on Windows platforms.

Key Features

1. Windows Binary Management

Embedded Binary: Uses openvpn.exe.bin from assets (assets/openvpn/windows/)
Binary Source: The binary was extracted from official OpenVPN MSI installers available at https://openvpn.net/client/
Asset Loading: Automatically loads and extracts the embedded binary on first use
Binary Extraction: Copies the embedded binary to a temporary location for execution

2. Windows Plugin Implementation

Rust FFI Layer: Native Windows plugin implemented in Rust for process management
C++ Bridge: C++ wrapper connecting Flutter MethodChannels to Rust FFI
Process Management: Launches and monitors openvpn.exe process
Output Parsing: Parses OpenVPN output for connection stages and statistics
Event Streaming: Real-time VPN stage updates via EventChannel

3. Dart API Integration

Platform Detection: Automatically detects Windows platform
Binary Preparation: Loads embedded openvpn.exe.bin from assets and extracts it for use
Status Monitoring: Provides detailed connection status (bytes in/out, packets, timestamps)
Error Handling: Comprehensive error handling for missing binaries and connection failures

4. Technical Implementation

Rust Components

lib.rs: FFI interface exposing C-compatible functions
openvpn.rs: OpenVPN process management and output parsing
manager.rs: Thread-safe singleton for OpenVPN manager
error.rs: Custom error types using thiserror

C++ Components

openvpn_flutter_plugin.h/cpp: Flutter plugin bridge
CMake integration for building Rust library

Dart Components

windows_binary_manager.dart: Embedded binary loading and management
windows_tap_manager.dart: TAP adapter management (optional)
vpn_engine.dart: Windows-specific integration

Files Changed

New Files

lib/src/windows_binary_manager.dart - Embedded binary loading and management
lib/src/windows_tap_manager.dart - TAP adapter management
windows/rust/ - Rust implementation
windows/openvpn_flutter_plugin.h/cpp - C++ bridge
windows/CMakeLists.txt - Build configuration
assets/openvpn/windows/openvpn.exe.bin - Embedded OpenVPN binary
test_integration/ - Integration test application

Modified Files

lib/src/vpn_engine.dart - Windows platform support
pubspec.yaml - Windows platform entry and dependencies
android/build.gradle - Updated NDK version and OpenVPN library

Dependencies Added

path_provider: ^2.1.1 - For file system access
path: ^1.8.3 - For path manipulation

Rust Dependencies

tokio - Async runtime
anyhow - Error handling
thiserror - Custom errors
serde / serde_json - JSON serialization
tempfile - Temporary file management
chrono - Timestamp handling

Testing

An integration test application is included in test_integration/ demonstrating:

Embedded binary loading
VPN connection establishment
Status monitoring
Connection teardown

Breaking Changes

None. This is a purely additive feature that doesn't affect existing Android/iOS functionality.

Compatibility

Windows: Windows 10/11 (x64)
Flutter: >=2.5.0
Dart: >=2.15.0 <4.0.0

Notes

The plugin uses the embedded openvpn.exe.bin from assets
The binary was extracted from official OpenVPN MSI installers available at https://openvpn.net/client/
Binary is extracted to a temporary location on first use
Temporary config and auth files are created per connection
Process monitoring handles connection lifecycle

Related Issues

This PR addresses the need for Windows support in the openvpn_flutter plugin.

…ndling. Update dependencies in pubspec.yaml.

…ntegration

…lutter_plugin)

…IN_TARGET_NAME

- Correction de l'erreur CMake avec add_custom_command POST_BUILD qui rÃ©fÃ©renÃ§ait une cible inexistante - Remplacement par set(openvpn_flutter_bundled_libraries) pour laisser Flutter gÃ©rer l'installation - Ajout des rÃ©pertoires d'inclusion cpp_client_wrapper/include pour trouver les headers Flutter - Correction des noms de fichiers header (tirets -> underscores) pour correspondre aux fichiers rÃ©els

- Ajout de l'hÃ©ritage public Plugin pour permettre l'utilisation avec AddPlugin()

- Utilisation de file(TO_CMAKE_PATH) pour normaliser les chemins Windows - Ajout d'un message STATUS quand les artefacts prÃ©compilÃ©s sont trouvÃ©s - Correction de la vÃ©rification d'existence des fichiers

… absolus - Conversion en chemin absolu pour une dÃ©tection plus fiable des fichiers prebuilt - Correction du problÃ¨me de dÃ©tection des artefacts Rust sur Windows

…s Rust

- file(GLOB) fonctionne mieux que EXISTS avec les liens symboliques sur Windows - Correction de la dÃ©tection des artefacts Rust prÃ©compilÃ©s

…bsolue - VÃ©rification EXISTS avec chemin relatif plus fiable avec les liens symboliques - Conversion en chemin absolu seulement aprÃ¨s confirmation de l'existence

- StreamHandler est une classe abstraite et ne peut pas Ãªtre instanciÃ©e directement - StreamHandlerFunctions est la classe helper fournie par Flutter pour utiliser des fonctions - Ajout de l'include event_stream_handler_functions.h

- Rust gÃ©nÃ¨re openvpn_flutter_rust.dll.lib et non openvpn_flutter_rust.lib - Correction du nom de fichier pour correspondre Ã la sortie de Rust

…egistrant - Permet Ã generated_plugin_registrant.cc de trouver openvpn_flutter_plugin.h - Correction de l'erreur d'inclusion du header

- CrÃ©ation du sous-rÃ©pertoire openvpn_flutter avec le header - Permet Ã generated_plugin_registrant.cc de trouver openvpn_flutter/openvpn_flutter_plugin.h

- Ajout de la dÃ©claration OpenvpnFlutterPluginRegisterWithRegistrar - Permet Ã generated_plugin_registrant.cc de trouver la fonction

…tion C

…ktopPluginRegistrarRef - Ã‰vite la redÃ©finition du type - Utilise le type officiel de Flutter

…6.16 amd64

…fÃ©rÃ©

…rÃ©pertoire de build

…d_16kb

…into dev_branch # Conflicts: # example/pubspec.lock

Spokplacenta · 2026-01-20T09:36:01Z

Hi @nizwar, would you have some time to review this PR ?

…t to prebuilt Rust binaries for Windows consumers and fall back to cargo builds only when artifacts are missing or explicitly disabled. Add CI verification to keep committed prebuilt artifacts in sync with Rust sources.

Replace strict prebuilt artifact diff checks with drift detection and patch upload in CI, because Windows Rust binaries can vary between environments. Keep artifact generation/upload and document the new drift handling flow for maintainers.

Refactor the release workflow to build Android APKs and Windows Rust prebuilt binaries in dedicated jobs, then publish both artifact sets in a single GitHub Release. Restrict publishing to version tags to avoid creating releases on regular branch pushes.

…sole window for OpenVPN on Windows

…rror detection

… adapter release, and improve error detection for TAP/TUN issues

…flutter into dev_branch

…ndows build

…connection handling in Rust code

…ebug and release builds

…DME, and remove TAP management code

…ion status

… elevation and updating error classification

… handling in OpenVPN process management

…onality and adjusting connection timeout settings

nizwar and others added 30 commits August 29, 2025 02:24

Upgrade openvpn with android 16kb

44b2bf0

Enhance Windows support by adding binary management and connection ha…

dd4efdb

…ndling. Update dependencies in pubspec.yaml.

fix: simplifie la recherche du binaire Windows

d2a1ee0

feat(windows): ship prebuilt rust binaries

0321664

feat(windows): mise à jour OpenVPN et support du binaire embarqué

d9dd715

refactor(windows): improve CMake configuration for Flutter and Rust i…

fe274db

…ntegration

fix(windows): utiliser le nom de cible attendu par Flutter (openvpn_f…

c31914c

…lutter_plugin)

fix(windows): remplacer toutes les références à PROJECT_NAME par PLUG…

4a69378

…IN_TARGET_NAME

fix: faire hÃ©riter OpenvpnFlutterPlugin de flutter::Plugin

8ad3509

- Ajout de l'hÃ©ritage public Plugin pour permettre l'utilisation avec AddPlugin()

fix: utilisation de get_filename_component pour rÃ©soudre les chemins…

efb5dd3

… absolus - Conversion en chemin absolu pour une dÃ©tection plus fiable des fichiers prebuilt - Correction du problÃ¨me de dÃ©tection des artefacts Rust sur Windows

fix: utilisation de file(GLOB) pour dÃ©tecter les fichiers prebuilt

44c9729

- file(GLOB) fonctionne mieux que EXISTS avec les liens symboliques sur Windows - Correction de la dÃ©tection des artefacts Rust prÃ©compilÃ©s

fix: vÃ©rification d'existence avec chemin relatif avant conversion a…

d394ae8

…bsolue - VÃ©rification EXISTS avec chemin relatif plus fiable avec les liens symboliques - Conversion en chemin absolu seulement aprÃ¨s confirmation de l'existence

fix: correction du nom de la bibliothÃ¨que d'import Rust

bc17766

- Rust gÃ©nÃ¨re openvpn_flutter_rust.dll.lib et non openvpn_flutter_rust.lib - Correction du nom de fichier pour correspondre Ã la sortie de Rust

fix: ajout du rÃ©pertoire source aux includes pour generated_plugin_r…

10fb72d

…egistrant - Permet Ã generated_plugin_registrant.cc de trouver openvpn_flutter_plugin.h - Correction de l'erreur d'inclusion du header

fix: crÃ©ation de la structure de rÃ©pertoires attendue par Flutter

e01bac2

- CrÃ©ation du sous-rÃ©pertoire openvpn_flutter avec le header - Permet Ã generated_plugin_registrant.cc de trouver openvpn_flutter/openvpn_flutter_plugin.h

fix: ajout de la dÃ©claration de la fonction C exportÃ©e dans le header

30998f5

- Ajout de la dÃ©claration OpenvpnFlutterPluginRegisterWithRegistrar - Permet Ã generated_plugin_registrant.cc de trouver la fonction

fix: utilisation du header flutter_plugin_registrar.h pour FlutterDes…

ac64b44

…ktopPluginRegistrarRef - Ã‰vite la redÃ©finition du type - Utilise le type officiel de Flutter

feat: remplacer le binaire OpenVPN factice par le binaire officiel 2.…

843b484

…6.16 amd64

chore: supprimer l'ancien binaire OpenVPN factice

1bb6389

feat: ajouter le binaire OpenVPN 2.6.16 amd64 officiel

7c40923

fix: corriger le chemin de l'asset OpenVPN pour les plugins Flutter

84bba4c

fix: corriger les erreurs de linting pour la variable data nullable

3daf690

Anthony MARCHAND and others added 5 commits November 24, 2025 18:12

test: add Windows integration test application

a209eef

merge: intégrer les modifications Android 16kb depuis upstream/androi…

de2e67c

…d_16kb

Merge branch 'dev_branch' of github.com:Spokplacenta/openvpn_flutter …

fe7d51e

…into dev_branch # Conflicts: # example/pubspec.lock

Spokplacenta mentioned this pull request Dec 23, 2025

Window Support? #26

Open

Spokplacenta and others added 16 commits March 13, 2026 16:56

feat: add OpenVPN runtime DLLs and update README for Windows integration

5ec0d65

refactor: encapsulate environment variable retrieval and suppress con…

a2533fd

…sole window for OpenVPN on Windows

refactor: disable runInShell for TAP management and enhance OpenVPN e…

8b10f11

…rror detection

refactor: increase wait times for OpenVPN process termination and TAP…

6a0731b

… adapter release, and improve error detection for TAP/TUN issues

Merge branch 'dev_branch' of https://github.com/Spokplacenta/openvpn_…

2ef4d32

…flutter into dev_branch

chore: remove generated Rust target files and cache directory from Wi…

c0e22c4

…ndows build

chore: update dependencies in pubspec.lock files and improve OpenVPN …

3e04aa8

…connection handling in Rust code

chore: update Windows prebuilt Rust DLLs for x86_64-pc-windows-msvc d…

ffd9914

…ebug and release builds

refactor: replace TAP with Wintun for Windows integration, update REA…

0fb428a

…DME, and remove TAP management code

feat: implement Windows stage polling and logging for OpenVPN connect…

6ca71a1

…ion status

feat: enhance OpenVPN driver strategy for Windows by checking process…

2e7b381

… elevation and updating error classification

feat: add IPC client for OpenVPN service on Windows and enhance error…

48bfde4

… handling in OpenVPN process management

refactor: improve OpenVPN service management by adding restart functi…

2af2988

…onality and adjusting connection timeout settings

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Windows support to openvpn_flutter#147

feat: Add Windows support to openvpn_flutter#147
Spokplacenta wants to merge 51 commits into
nizwar:masterfrom
Spokplacenta:dev_branch

Spokplacenta commented Dec 22, 2025

Uh oh!

Spokplacenta commented Jan 20, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Spokplacenta commented Dec 22, 2025

Add Windows Support to openvpn_flutter

Summary

Key Features

1. Windows Binary Management

2. Windows Plugin Implementation

3. Dart API Integration

4. Technical Implementation

Rust Components

C++ Components

Dart Components

Files Changed

New Files

Modified Files

Dependencies Added

Rust Dependencies

Testing

Breaking Changes

Compatibility

Notes

Related Issues

Uh oh!

Spokplacenta commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Spokplacenta commented Jan 20, 2026 •

edited

Loading