搜尋套件、儲存庫與 APP 分類

套件詳情v0.1.3

wireguard_flutter

Wireguard Flutter SDK

AndroidiOSmacOSWindowsLinux
近 30 天下載
872
喜歡數
36
Pub 分數
120

安裝套件

flutter pub add wireguard_flutter

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

Wireguard Flutter SDK 為 Flutter 應用程式提供安全、高效率的 VPN 連線。它提供 WireGuard 協定的跨平台實作,讓開發者能將加密網路隧道整合至 Android、iOS、macOS、Windows 與 Linux 應用中。該 SDK 簡化設定管理與隧道生命週期控制,非常適合注重隱私或企業級網路功能的應用。此 SDK 以效能與安全性為設計核心,底層使用原生 WireGuard 實作。

適用情境

  • 安全的應用程式到伺服器通訊
  • 行動應用程式中的私人網路存取
  • 企業級遠端存取
  • 設備之間的加密資料傳輸
  • 繞過地區限制

主要特色

  • 跨平台支援
  • 原生 WireGuard 集成
  • 輕鬆隧道設定
  • 低延遲連接
  • 強大的加密標準

適合對象

  • 開發安全訊息應用的開發者
  • 需要私有網絡訪問的團隊
  • 需要加密資料通道的應用程式
  • 注重隱私的應用程式
  • 網路基礎設施工具

使用建議

  • 需要平台特定的設定才能進行高級配置
  • 某些平台可能需要額外的權限
  • 不適用於非VPN使用案例
  • 依賴穩定的原生 WireGuard 庫
  • 邊緣情況的文件有限

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

wireguard_flutter

A flutter plugin to setup and control VPN connection via Wireguard tunnel.

Contributing to wireguard_flutter

Thank you for your interest in contributing to wireguard_flutter! We appreciate your help in making this project better.

Before you start contributing, please take a moment to read the following guidelines.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution:
    git checkout -b feature/your-feature-name
    
  4. Make your changes and ensure that the code follows the project's coding standards.
  5. Commit your changes with a descriptive commit message:
    git commit -m "Add your descriptive message here"
    
  6. Push your changes to your forked repository:
    git push origin feature/your-feature-name
    
  7. Open a pull request in the original repository and provide a detailed description of your changes.

Usage

To use this plugin, add wireguard_flutter or visit Flutter Tutorial.

flutter pub add wireguard_flutter
Initialize

Initialize a wireguard instance with a valid name using initialize:

final wireguard = WireGuardFlutter.instance;

// initialize the interface
await wireguard.initialize(interfaceName: 'wg0');

and declare the .conf data:

const String conf = '''[Interface]
PrivateKey = 0IZmHsxiNQ54TsUs0EQ71JNsa5f70zVf1LmDvON1CXc=
Address = 10.8.0.4/32
DNS = 1.1.1.1


[Peer]
PublicKey = 6uZg6T0J1bHuEmdqPx8OmxQ2ebBJ8TnVpnCdV8jHliQ=
PresharedKey = As6JiXcYcqwjSHxSOrmQT13uGVlBG90uXZWmtaezZVs=
AllowedIPs = 0.0.0.0/0, ::/0
PersistentKeepalive = 0
Endpoint = 38.180.13.85:51820''';

For more info on the configuration data, see the documentation with examples.

Connect

After initializing, connect using startVpn:

await wireguard.startVpn(
  serverAddress: address, // the server address (e.g 'demo.wireguard.com:51820')
  wgQuickConfig: conf, // the quick-config file
  providerBundleIdentifier: 'com.example', // your app identifier
);
Disconnect

After connecting, disconnect using stopVpn:

await wireguard.stopVpn();
Stage

Listen to stage change using vpnStageSnapshot:

wireguard.vpnStageSnapshot.listen((event) {
  debugPrint("status changed $event");
});

Or get the current stage using getStage:

final stage = await wireguard.stage();

The available stages are:

Code Description
connecting The interface is connecting
connected The interface is connected
disconnecting The interface is disconnecting
disconnected The interface is disconnected
waitingConnection Waiting for a user interaction
authenticating Authenticating with the server
reconnect Reconnecting the the interface
noConnection Any connection has not been made
preparing Preparing to connect
denied The connection has been denied by the system, usually by refused permissions
exiting Exiting the interface

Supported Platforms

Android iOS macOS Windows Linux
Version SDK 21+ 15.0+ 12+ 7+ Any
Windows

On Windows, the app must be run as administrator to be able to create and manipulate the tunnel. To debug the app, run flutter run from an elevated command prompt. To run the app normally, the system will request your app to be run as administrator. No code changes or external dependencies are required.

Linux
Install dependencies

The required dependencies need to be installed: wireguard and wireguard-tools.

On Ubuntu/Debian, use the following command to install the dependencies:

sudo apt install wireguard wireguard-tools openresolv

For other Linux distros, see this.

[!NOTE]

If openresolv is not installed in the system, configuration files with a DNS provided may not connect. See this issue for more information.

Initializing

When wireguard.initialize is called, the application will request your user password ([sudo] password for <user>:). This is necessary because wireguard must run as a root to be able to create AND manipulate the tunnels. This is true for either debug and release modes or a distributed executable.

[!CAUTION]

Do not run the app in root mode (e.g sudo ./executable, sudo flutter run), otherwise the connection will not be established.

FAQ & Troubleshooting

Linux error resolvconf: command not found

On Linux, you may receive the error resolvconf: command not found. This is because wireguard tried to adjust the nameserver. Make sure to install openresolv or not provide the "DNS" field.


"WireGuard" is a registered trademark of Jason A. Donenfeld.

Fork from mysteriumnetwork tunnel.

Many Thanks for Bruno D'Luka for help me.

所屬分類

依賴

依賴清單 3 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。