Flutter TCP通信插件tcp_tunnel的使用

Flutter TCP通信插件tcp_tunnel的使用

标题

tcp_tunnel

内容

• pub包版本: pub/v/tcp_tunnel.svg
• Null Safety: dart.dev/null-safety
• Codecov: app.codecov.io/gh/gmpassos/tcp_tunnel
• Dart CI: github.com/gmpassos/tcp_tunnel/actions/workflows/dart.yml/badge.svg?branch=master
• GitHub Tag: github.com/gmpassos/tcp_tunnel/releases
• New Commits: github.com/gmpassos/tcp_tunnel/network
• Last Commits: github.com/gmpassos/tcp_tunnel/commits/master
• Pull Requests: github.com/gmpassos/tcp_tunnel/pulls
• Code Size: github.com/gmpassos/tcp_tunnel/blob/master/LICENSE
• License: github.com/dart-lang/stagehand/blob/master/LICENSE

动机

该库的主要动机是帮助开发人员在复杂的网络拓扑中开发服务器、客户端和服务。

使用方法

有三种类型的隧道可以结合使用：

1. 本地端口重定向: 将 listenPort（例如 3366）链接到 localTargetPort（例如 3306），实现双向数据流。

   Future<void> redirectLocalPort(int listenPort, int targetPort, {String targetHost = 'localhost'}) async {
     await TunnelLocalServer(listenPort, targetPort, targetHost: targetHost).start();
   }
   

2. 桥接隧道: 连接 listenPort1 和 listenPort2，实现数据流量交换。

   Future<void> bridgePorts(int listenPort1, int listenPort2) async {
     await TunnelBridge(listenPort1, listenPort2).start();
   }
   

3. 客户端隧道: 将 remoteHost:remotePort 链接到 localTargetPort，实现双向数据传输。

   Future<void> clientTunnel(String remoteHost, int remotePort, int localTargetPort) async {
     var tunnel = Tunnel.connect(remoteHost, remotePort, localTargetPort);
   
     tunnel.onClose = ( t) {
       // 关闭连接，尝试重新连接...
     };
   }
   

CLI工具

你可以轻松地在任何支持Dart的平台上使用CLI工具 tcp_tunnel。

激活CLI工具只需运行：

dart pub global activate tcp_tunnel

然后你可以为每个必要的场景创建隧道：

1. 本地端口重定向:

   tcp_tunnel local %listenPort %targetPort %targetHost
   

   • %targetHost 是可选的，默认值为 localhost。

2. 桥接隧道:

   tcp_tunnel bridge %listenPort1 %listenPort2
   

3. 客户端隧道:

   tcp_tunnel client %remoteHost %remotePort %localTargetPort
   

结合使用

要访问远程服务器X（没有公共地址）中的端口3306（MySQL）：

1. 在公共服务器Y（server-y.domain）上建立一个服务器桥接：

   tcp_tunnel bridge 8035 8036
   

2. 在私有服务器X（具有私有MySQL数据库的服务器）上运行客户端隧道：

   tcp_tunnel client server-y.domain 8036 3306
   

3. 运行mysql客户端指向隧道端口：

   mysql -u myuser -p -h server-y.domain -P 8035
   

4. 如果希望扩展配置，可以在上述重定向中建立一个本地端口：

   tcp_tunnel local 3306 8035 server-y.domain
   

   现在，只需访问本地端口3306即可，就像访问标准MySQL数据库一样。 实际上，这个本地端口连接到一个远程私有服务器。

   mysql -u myuser -p -h localhost -P 3306
   

   或者默认设置（与上述相同）：

   mysql -u myuser -p
   

安全性

请注意，隧道通信 未加密，且任何通过公共网络进行的连接都可能暴露其数据给潜在的安全风险。

特征和bug

请将功能请求和bug提交到 issue tracker。

作者

Graciliano M. Passos: gmpassos@GitHub

赞助

不要害羞，展示一些爱，成为我们的 GitHub赞助商。你的支持对我们来说意义重大，并且保持代码充满活力！☕✨

许可证

Dart免费开源许可证 https://github.com/dart-lang/stagehand/blob/master/LICENSE

示例代码

import 'dart:io';

import 'package:tcp_tunnel/tcp_tunnel.dart';

void main() async {
  // 桥接：8035 <-> 8036
  await bridgePorts(8035, 8036);

  // 客户端：8036 <-> 3306
  await clientTunnel('localhost', 8036, 3306);

  // 客户端：3307 <-> 8035
  await redirectLocalPort(3307, 8035);

  ///// 最终隧道：
  // 3307 <-> 8035 <-> 8036 <-> 3306
}

Future<void> redirectLocalPort(int listenPort, int targetPort,
    {String targetHost = 'localhost'}) async {
  await TunnelLocalServer(listenPort, targetPort, targetHost: targetHost)
      .start();
}

Future<void> bridgePorts(int listenPort1, int listenPort2) async {
  await TunnelBridge(listenPort1, listenPort2).start();
}

Future<void> clientTunnel(
    String remoteHost, int remotePort, int localTargetPort) async {
  var tunnel = Tunnel.connect(remoteHost, remotePort, localTargetPort);

  tunnel.onClose = (t) {
    print('** Tunnel Closed');
    exit(1);
  };
}