Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev0.1.3

wireguard_flutter

SDK Flutter Wireguard

AndroidiOSmacOSWindowsLinux
Downloads em 30 dias
872
Curtidas
36
Pontos Pub
120

Instalar pacote

flutter pub add wireguard_flutter

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

O SDK Wireguard Flutter habilita conectividade de VPN segura e de alto desempenho em aplicativos Flutter. Ele fornece uma implementação multiplataforma do protocolo WireGuard, permitindo que desenvolvedores integrem túneis de rede criptografados em apps para Android, iOS, macOS, Windows e Linux. O SDK simplifica a gestão de configuração e o controle do ciclo de vida do túnel, tornando-o ideal para funcionalidades de rede voltadas para privacidade ou de nível corporativo. Desenvolvido com foco em desempenho e segurança, ele utiliza implementações nativas do WireGuard por baixo dos panos.

Casos de uso

  • Comunicação segura entre aplicativo e servidor
  • Acesso a rede privada em aplicativos móveis
  • Acesso remoto de nível corporativo
  • Transferência de dados criptografados entre dispositivos
  • Contornando restrições regionais

Principais recursos

  • Suporte multiplataforma
  • integração nativa do WireGuard
  • Configuração fácil de túnel
  • Conexões com baixa latência
  • Padrões de criptografia fortes

Indicado para

  • Desenvolvedores de aplicativos de mensagens seguras
  • Equipes que precisam de acesso à rede privada
  • Aplicativos que exigem canais de dados criptografados
  • Aplicativos focados na privacidade
  • Ferramentas de infraestrutura de rede

Considerações

  • Requer configuração específica da plataforma para configurações avançadas
  • Pode ser necessário permissões adicionais em algumas plataformas
  • Não adequado para casos de uso não-VPN
  • Depende de bibliotecas nativas estáveis do WireGuard
  • Documentação limitada para casos de borda

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

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.

Categorias

Dependências

Lista de dependências 3 itens

Repositório-fonte

Projetos que usam este pacote

Ainda não há dados.