WebSocat 安装与使用指南

WebSocat 是一个基于 Rust 开发的开源命令行工具，它相当于网络套接字工具 netcat 和 curl 在 WebSocket 协议上的增强版本。该工具提供了强大的 WebSocket 连接管理功能，支持多种高级特性，非常适合协议调试、服务交互和自动化脚本场景。

项目概述

WebSocat 使用 Rust 语言开发，充分利用了 Rust 的内存安全性和高性能特性。它支持 WebSocket 协议的核心功能，包括：

• TCP 到 WebSocket 的双向代理
• 二进制和文本消息模式的自动转换
• 自动重连机制
• 多平台兼容（Linux、Windows、macOS）
• SSL/TLS 加密支持

安装方法

通过 Cargo 安装（推荐）

确保系统已安装 Rust 工具链，然后执行：

cargo install websocat --features=ssl

如果遇到 SSL 依赖问题，可以去掉 --features=ssl 参数：

cargo install websocat

从源代码编译安装

1. 克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/we/websocat
cd websocat

2. 编译项目：

cargo build --release

3. 安装可执行文件：

cp target/release/websocat /usr/local/bin/

各系统包管理器安装

Debian/Ubuntu：

# 下载预编译包或从源代码编译

macOS：

# 使用 Homebrew
brew install websocat

# 或使用 MacPorts
sudo port install websocat

FreeBSD：

pkg install websocat

基本使用示例

连接到 WebSocket 服务器

连接到公共的回显服务器测试功能：

websocat ws://ws.vi-server.org/mirror

输入任意文本后，服务器会将相同内容回显。

创建 WebSocket 服务器

在本地端口 1234 启动 WebSocket 服务器：

websocat -s 1234

其他客户端可以通过 ws://127.0.0.1:1234/ 连接到该服务器。

TCP 到 WebSocket 代理

将本地 TCP 端口 22 (SSH) 代理到 WebSocket：

websocat --oneshot -b ws-l:127.0.0.1:1234 tcp:127.0.0.1:22

然后通过另一个 WebSocat 实例连接到该代理：

websocat --oneshot -b tcp-l:127.0.0.1:1236 ws://127.0.0.1:1234/

消息广播模式

创建广播服务器，所有连接客户端都能收到彼此的消息：

# 服务器端
websocat -t ws-l:127.0.0.1:1234 broadcast:mirror:

# 客户端A
websocat ws://127.0.0.1:1234

# 客户端B  
websocat ws://127.0.0.1:1234

高级功能特性

WebSocat 提供了丰富的命令行选项：

• --binary：以二进制模式发送 WebSocket 消息
• --text：以文本模式发送 WebSocket 消息
• --header：添加自定义 HTTP 头
• --origin：设置 Origin 头
• --protocol：指定 WebSocket 子协议
• --insecure：接受无效的 SSL 证书

查看完整帮助信息：

websocat --help
websocat --help=long  # 显示详细帮助

项目结构

WebSocat 的源代码结构清晰，主要包含：

• src/main.rs：主程序入口点
• src/specifier.rs：地址类型解析器
• src/options.rs：命令行选项处理
• 各种 peer 实现文件（如 ws_peer.rs、tcp_peer.rs 等）

常见问题解决

SSL 证书问题

在 Android 系统上，可能需要手动指定证书文件：

SSL_CERT_FILE=cacert.pem websocat wss://echo.websocket.org

或使用不安全的连接：

websocat --insecure wss://echo.websocket.org

Rust 版本兼容性

不同版本的 WebSocat 需要特定版本的 Rust 编译器。如果编译失败，可以尝试使用 Cargo.lock.legacy 文件：

cp Cargo.lock.legacy Cargo.lock
cargo build --release

总结

WebSocat 是一个功能强大的 WebSocket 命令行工具，它结合了 netcat 的灵活性和 WebSocket 协议的实时通信能力。无论是简单的连接测试还是复杂的代理场景，WebSocat 都能提供可靠的解决方案。通过丰富的命令行选项和灵活的地址类型系统，开发者可以轻松构建各种 WebSocket 相关的自动化任务和调试工具。