パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.1.3

wireguard_flutter

Wireguard Flutter SDK

AndroidiOSmacOSWindowsLinux
30日間ダウンロード
872
いいね数
36
Pub ポイント
120

パッケージをインストール

flutter pub add wireguard_flutter

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Wireguard Flutter SDK は、Flutter アプリケーションにおける安全で高性能な VPN 接続を可能にします。この SDK は、Android、iOS、macOS、Windows、Linux に対応する WireGuard プロトコルのクロスプラットフォーム実装を提供し、開発者が暗号化されたネットワークトンネルをアプリに統合できるようにします。設定管理とトンネルのライフサイクル制御を簡素化しており、プライバシー重視またはエンタープライズグレードのネットワーキング機能に最適です。パフォーマンスとセキュリティを念頭に設計されており、裏ではネイティブな 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 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。