Flutter VPN管理插件wireguard_vpn的使用

wireguard_vpn 是一个 Flutter 插件，用于通过 WireGuard 激活和停用 VPN 连接。

Setup

Android 配置

1. 修改 android/app/build.gradle 文件中的 minSdkVersion 为 21：

   android {                    
       defaultConfig {
           minSdkVersion 21
       }                                
   }
   

2. 如果要在发布模式下运行应用，需要在 ./android/app/ 目录下添加一个名为 proguard-rules.pro 的文件，并包含以下内容：

   -keep class app.wachu.wireguard_vpn.** {*;}
   -keep class com.beust.klaxon.** {*;}
   

3. 或者，可以在 ./android/app/build.gradle 文件的 buildtypes release 下添加以下内容：

   shrinkResources false
   minifyEnabled false
   

感谢贡献者

感谢用户 ByteSizedMarius 对包在发布模式下的执行所做的贡献。感谢你！

Usage

添加依赖

在 pubspec.yaml 文件中添加 wireguard_vpn 依赖：

dependencies:
  wireguard_vpn: ^0.0.2 

导入包

在 Dart 文件中导入 wireguard_vpn 包：

import 'package:wireguard_vpn/wireguard_vpn.dart';

Activate and Deactivate VPN

使用 WireguardFlutterPlugin 类的 changeStateParams 方法来激活或停用 VPN 连接。该方法需要一个 SetStateParams 对象作为参数，该对象包含关于 VPN 隧道的信息。

bool vpnActivate = false;
String initName = "MyWireguardVPN";
String initAddress = "192.168.1.1/24";
String initDnsServer = "8.8.8.8";
String initPort = "51820";
String initAllowedIp = "0.0.0.0/0";
String initEndpoint = "vpn.example.com:51820";
String initPublicKey = "PUBLIC_KEY";
String initPrivateKey = "PRIVATE_KEY";
String presharedKey = "PRESHARED_KEY";

final _wireguardFlutterPlugin = WireguardFlutterPlugin();

void _activateVpn(bool value) async {
  final results = await _wireguardFlutterPlugin.changeStateParams(SetStateParams(
    state: !vpnActivate,
    tunnel: Tunnel(
        name: initName,
        address: initAddress,
        dnsServer: initDnsServer,
        listenPort: initPort,
        peerAllowedIp: initAllowedIp,
        peerEndpoint: initEndpoint,
        peerPublicKey: initPublicKey,
        privateKey: initPrivateKey,
        peerPresharedKey: presharedKey),
  ));
  setState(() {
    vpnActivate = results ?? false;
  });
}

Obtain Connection Statistics

使用 WireguardFlutterPlugin 类的 tunnelGetStats 方法来获取 VPN 连接的统计信息。该方法需要传入 VPN 隧道的名称。

String initName = "MyWireguardVPN";

final _wireguardFlutterPlugin = WireguardFlutterPlugin();

void _obtainStats() {
  Timer.periodic(const Duration(seconds: 1), (timer) async {
    final results = await _wireguardFlutterPlugin.tunnelGetStats(initName);
    setState(() {
      stats = results ?? Stats(totalDownload: 0, totalUpload: 0);
    });
  });
}

Complete Example

以下是一个完整的示例，展示了如何使用此插件激活和停用 VPN 连接以及获取连接统计信息：

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:wireguard_vpn/wireguard_vpn.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _wireguardFlutterPlugin = WireguardVpn();
  bool vpnActivate = false;
  Stats stats = Stats(totalDownload: 0, totalUpload: 0);
  final String initName = 'MyWireguardVPN';
  final String initAddress = "10.7.0.2/24";
  final String initPort = "51820";
  final String initDnsServer = "8.8.8.8, 8.8.4.4";
  final String initPrivateKey = "PRIVATE_KEY";
  final String initAllowedIp = "0.0.0.0/0, ::/0";
  final String initPublicKey = "PUBLIC_KEY";
  final String initEndpoint = "vpn.example.com:51820";
  final String presharedKey = 'PRESHARED_KEY';

  @override
  void initState() {
    super.initState();
    if (vpnActivate) {
      _obtainStats();
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Wireguard-VPN Example'),
        ),
        body: Column(
          children: [
            Text('Active VPN: ${stats.totalDownload} D -- ${stats.totalUpload} U'),
            SwitchListTile(
              value: vpnActivate,
              onChanged: _activateVpn,
              title: Text(initName),
              subtitle: Text(initEndpoint),
            ),
          ],
        ),
      ),
    );
  }

  void _obtainStats() {
    Timer.periodic(const Duration(seconds: 1), (timer) async {
      final results = await _wireguardFlutterPlugin.tunnelGetStats(initName);
      setState(() {
        stats = results ?? Stats(totalDownload: 0, totalUpload: 0);
      });
    });
  }

  void _activateVpn(bool value) async {
    final results = await _wireguardFlutterPlugin.changeStateParams(SetStateParams(
      state: !vpnActivate,
      tunnel: Tunnel(
        name: initName,
        address: initAddress,
        dnsServer: initDnsServer,
        listenPort: initPort,
        peerAllowedIp: initAllowedIp,
        peerEndpoint: initEndpoint,
        peerPublicKey: initPublicKey,
        privateKey: initPrivateKey,
        peerPresharedKey: presharedKey,
      ),
    ));
    setState(() {
      vpnActivate = results ?? false;
      if (vpnActivate) {
        _obtainStats();
      }
    });
  }
}

Generate WireGuard VPN Configurations

要获取 WireGuard VPN 配置以进行测试，可以访问 ProtonVPN 网站，注册并生成配置文件。也可以参考 WireGuard 官方网站上的指南。

Contributions

欢迎贡献。如果你发现错误或想添加新功能，请打开一个新的 issue 或发送一个 pull request。

License

本包根据 BSD 3-clause 许可证提供。更多信息请参阅 LICENSE 文件。