导语 | 本文主要介绍Whistle的实现原理,通过这篇文章读者可以了解Whistle的具体实现过程,并且自己也可以实现一个简单的抓包调试工具。
项目Github地址:https://github.com/avwo/whistle
Whistle是基于Node实现的跨平台Web抓包调试(HTTP)代理,主要功能:
本文将从最基本的概念开始逐步实现Whistle功能,包含以下内容:
一、什么是HTTP代理
代理是客户端到服务端的中转服务,其中:
接下来看下客户端如何将目标服务器地址传给HTTP代理,以及HTTP代理如何跟目标服务器建立连接。
二、实现简单HTTP代理
先看一个用Node实现的最简单HTTP代理:
const http = require('http');const { connect } = require('net');
/****************** 工具方法 ******************/const getHostPort = (host, defaultPort) => { let port = defaultPort || 80; const index = host.indexOf(':'); if (index !== -1) { port = host.substring(index + 1); host = host.substring(0, index); } return {host, port};};
const getOptions = (req, defaultPort) => { // 这里假定 host 一定存在,完整实现参见 Whistle const { host, port } = getHostPort(req.headers.host, defaultPort); return { hostname: host, // 指定请求域名,用于通过 DNS 获取服务器 IP 及设置请求头 host 字段 port, // 指定服务器端口 path: req.url || '/', method: req.method, headers: req.headers, rejectUnauthorized: false, // 给 HTTPS 请求用的,HTTP 请求会自动忽略 };};
// 简单处理,出错直接断开,完整实现逻辑参考 Whistleconst handleClose = (req, res) => { const destroy = (err) => { // 及时关闭无用的连接,防止内存泄露 req.destroy(); res && res.destroy(); }; res && res.on('error', destroy); req.on('error', destroy); req.once('close', destroy);};
/****************** 服务代码 ******************/const server = http.createServer();// 处理 HTTP 请求server.on('request', (req, res) => { // 与服务端建立连接,透传客户端请求及服务端响应内容 const client = http.request(getOptions(req), (svrRes) => { res.writeHead(svrRes.statusCode, svrRes.headers); svrRes.pipe(res); }); req.pipe(client); handleClose(res, client);});
// 隧道代理:处理 HTTPS、HTTP2、WebSocket、TCP 等请求server.on('connect', (req, socket) => { // 与服务端建立连接,透传客户端请求及服务端响应内容 const client = connect(getHostPort(req.url), () => { socket.write('HTTP/1.1 200 Connection Established\r\n\r\n'); socket.pipe(client).pipe(socket); }); handleClose(socket, client);});
server.listen(8080);
上述代码实现了一个具有转发请求功能的HTTP代理,从代码可知HTTP代理就是一个普通的HTTP Server,并监听request和connect这两个事件,客户端会通过这两个事件将目标服务器地址传过来,其中:
可以在事件里面的req.url或req.headers.host获取目标服务器的地址(host:port),再跟该服务器地址建立连接并将结果通过HTTP响应的方式返回给客户端,这里只是实现代理的最基本功能,完整的HTTP除了请求转发,至少应该还有:
下面以Whistle为例看下如何用Node.js实现一个完整的HTTP代理。
三、完整HTTP代理架构(Whistle)
主要分五个模块:
四、具体实现原理
下面分别看下这五个模块具体是怎么实现的。
所有请求先会经过请求接入模块,Whistle支持四种请求接入方式:
实现原理:将所有请求都转成HTTP代理的隧道代理请求或HTTP请求,再解析隧道代理请求转成HTTP请求。
如何将普通tcp请求转成隧道代理请求参见:lack-proxy
下面看下如何从隧道代理请求解析出HTTP请求。
关键点(HTTP请求也可以走隧道代理):
HTTP 请求处理可以分两个阶段:
(四)规则管理
与传统抓包调试代理采用断点修改请求响应数据不同,Whistle采用配置规则的方式修改请求响应,采用配置方式的好处是操作简单,且可以将操作持久化存储及共享给他人,先看几个例子:
Whistle的规则管理主要两个功能:解析规则、匹配规则。
Whistle有两类规则:
文档:https://github.com/whistle-plugins/whistle.autosave/blob/master/rules.txt
文档:https://wproxy.org/whistle/plugins.html
Whistle规则的完整结构为:
文档:https://wproxy.org/whistle/mode.html
Whistle插件的功能很多,不仅具备Node的所有能力,且可以操作Whistle的所有规则(理论上可以基于插件实现一个Whistle),主要用来做以下事情:
比如:
其它插件例子参见:https://github.com/whistle-plugins
Whistle是如何实现插件功能?主要遵循以下三个设计原则:
确保所有功能点都可扩展,如:请求鉴权、生成证书、获取抓包、设置规则、请求处理等。
插件内部异常不影响其它功能,Whistle的每个插件独立进程,插件与Whistle之间通过HTTP协议交互。
Whistle是使用npm包pfork来启动插件进程,进程间的交换是直接通过Node的http模块实现的),方便开发者利用http的生态开发插件。
方便用户开发及使用。
开发:结构简单 (npm包) + 脚手架lack;
使用:安装npm包即可,用法跟内置协议一样,且可内置交互界面。
有关插件的更多细节参见:https://wproxy.org/whistle/plugins.html
事实上,Whistle除了支持插件扩展,还可以同时作为独立模块引入项目使用;除了本地开发使用,也可以基于Whistle开发出支持多人使用的开发联调协作工具,比如后面会给大家介绍其实现原理的:
Nohost:https://github.com/Tencent/nohost
TDE目前只在腾讯内部使用,后续后逐步对外开源。
参考资料:
1.Github仓库:https://github.com/avwo/whistle
2.官方插件仓库:https://github.com/whistle-plugins
3.详细文档:https://wproxy.org/whistle/
作者简介
吴文斌(avenwu)
腾讯前端高级工程师
腾讯前端高级工程师,Whistle、Nohost作者,目前主要负责团队的Node服务框架及效率工具的开发维护工作。
推荐阅读