whistle.script 1.1.0 → 1.2.3

package/README.md

@@ -18,7 +18,7 @@ whistle.script为[whistle](https://github.com/avwo/whistle)的一个扩展脚本
 
 # 安装
 
-1. 安装Node(>=6): [官网下载安装最新版本(LTS和Stable都可以)](https://nodejs.org/)
+1. 安装Node: [官网下载安装最新版本(LTS和Stable都可以)](https://nodejs.org/)
 2. 安装最新版的[whistle](https://github.com/avwo/whistle)。
 
 		npm install -g whistle
@@ -28,9 +28,7 @@ whistle.script为[whistle](https://github.com/avwo/whistle)的一个扩展脚本
 
 3. 安装script插件:
 
-		npm install -g whistle.script
-		# Mac、Linux用户可能需要加sudo
-		sudo npm install -g whistle.script
+		w2 i whistle.script
 
 # 使用
 
@@ -161,12 +159,12 @@ whistle.script为[whistle](https://github.com/avwo/whistle)的一个扩展脚本
 		// 正常断开 WebSocket 连接
 		socket.on('disconnect', (code, message, opts) => {
 			console.log(code, 'client disconnect');
-			svrSocket.disconnect(code, message, opts);
+			svrSocket.disconnect(code, opts);
 		});
 		// 正常断开 WebSocket 连接
 		svrSocket.on('disconnect', (code, message, opts) => {
 			console.log(code, 'server disconnect');
-			socket.disconnect(code, message, opts);
+			socket.disconnect(code, opts);
 		});
 		// 获取客户端解析后的帧数据
 		socket.on('message', (data, opts) => {
@@ -185,18 +183,82 @@ whistle.script为[whistle](https://github.com/avwo/whistle)的一个扩展脚本
 		whistle规则配置同上，访问[https://www.websocket.org/echo.html](https://www.websocket.org/echo.html)，点击下面的connect按钮及send按钮，可以如下效果：[demo3](https://user-images.githubusercontent.com/11450939/126302243-26c8b4af-851c-4b00-87b9-3286e9e67251.gif)
 3. 操作Tunnel请求
 	``` js
-	exports.handleTunnel = async (req, connect) => {
-		const res = await connect();
-		req.pipe(res).pipe(req);
+	exports.handleTunnel = async (socket, connect) => {
+		const svrSocket = await connect();
+		socket.pipe(svrSocket).pipe(socket);
 	};
 	```
 	whistle规则配置同上
-# License
 
-[MIT](https://github.com/whistle-plugins/whistle.script/blob/master/LICENSE)
+4. 鉴权
+插件 `v1.2.0` 版本开始支持自定义鉴权方法（要求 Whistle 版本 >= `v2.7.16`）：
+``` js
+exports.auth = async (req, options) => {
+	// 给请求添加自定义头，必须与 `x-whistle-` 开头
+	// 这样可以在插件的其他 hook 里面获取到该请求头（除了 http 请求的 reqRead 钩子）
+	req.setHeader('x-whistle-test', '1111111111');
+	// return false; // 直接返回 403
+};
+```
+
+5. pipe
+插件 `v1.2.1` 版本开始支持自定义 pipe 方法：
+``` js
+
+exports.handleReqRead = (req, res, options) => {
+  req.pipe(res);
+};
+
+exports.handleReqWrite = (req, res, options) => {
+  req.pipe(res);
+};
+
+exports.handleResRead = (req, res, options) => {
+  req.pipe(res);
+};
+
+exports.handleResWrite = (req, res, options) => {
+  req.pipe(res);
+};
 
+exports.handleWsReqRead = (req, res, options) => {
+  req.pipe(res);
+};
 
+exports.handleWsReqWrite = (req, res, options) => {
+  req.pipe(res);
+};
 
+exports.handleWsResRead = (req, res, options) => {
+  req.pipe(res);
+};
 
+exports.handleWsResWrite = (req, res, options) => {
+  req.pipe(res);
+};
 
+exports.handleTunnelReqRead = (req, res, options) => {
+  req.pipe(res);
+};
+
+exports.handleTunnelReqWrite = (req, res, options) => {
+  req.pipe(res);
+};
+
+exports.handleTunnelResRead = (req, res, options) => {
+  req.pipe(res);
+};
+
+exports.handleTunnelResWrite = (req, res, options) => {
+  req.pipe(res);
+};
+
+```
+
+# 如何引入第三方模块
+使用绝对路径引入，如假设你的模块安装路径为 `/Users/test/node_modules/xxx`，则可以在脚本里面通过 `require('/Users/test/node_modules/xxx')` 引入。
+
+# License
+
+[MIT](https://github.com/whistle-plugins/whistle.script/blob/master/LICENSE)
 

package/lib/auth.js

@@ -0,0 +1,39 @@
+const scripts = require('./scripts');
+const { getRemoteUrl, getContext, getFn, noop, request, AUTH_URL, STATS_URL, DATA_URL, isRemote } = require('./util');
+
+module.exports = async (req, options) => {
+  if (!isRemote(req)) {
+    const ctx = getContext(req);
+    const { auth, verify } = scripts.getHandler(ctx);
+    const check = getFn(auth, verify);
+    return check && check(req, options);
+  }
+  const authUrl = getRemoteUrl(req, AUTH_URL);
+  if (authUrl) {
+    const { auth, headers } = await request(authUrl, req.headers);
+    if (auth === false) {
+      return false;
+    }
+    if (headers) {
+      Object.keys(headers).forEach((key) => {
+        req.set(key, headers[key]);
+      });
+    }
+  }
+  const statsUrl = getRemoteUrl(req, STATS_URL);
+  const dataUrl = getRemoteUrl(req, DATA_URL);
+  if (statsUrl) {
+    req.getReqSession((session) => {
+      if (session) {
+        request(statsUrl, req.headers, session).then(noop);
+      }
+    });
+  }
+  if (dataUrl) {
+    req.getSession((session) => {
+      if (session) {
+        request(dataUrl, req.headers, session).then(noop);
+      }
+    });
+  }
+};

package/lib/index.js

@@ -1,7 +1,23 @@
-/* eslint-enable no-console */
+const handlePipe = require('./pipe');
+
+exports.auth = require('./auth');
+exports.sniCallback = require('./sniCallback');
 exports.uiServer = require('./uiServer');
 exports.rulesServer = require('./rulesServer');
 exports.resRulesServer = require('./resRulesServer');
 exports.tunnelRulesServer = require('./tunnelRulesServer');
 exports.server = require('./server');
 exports.tunnelServer = require('./tunnelServer');
+
+exports.reqRead = handlePipe('reqRead');
+exports.reqWrite = handlePipe('reqWrite');
+exports.resRead = handlePipe('resRead');
+exports.resWrite = handlePipe('resWrite');
+exports.wsReqRead = handlePipe('wsReqRead');
+exports.wsReqWrite = handlePipe('wsReqWrite');
+exports.wsResRead = handlePipe('wsResRead');
+exports.wsResWrite = handlePipe('wsResWrite');
+exports.tunnelReqRead = handlePipe('tunnelReqRead');
+exports.tunnelReqWrite = handlePipe('tunnelReqWrite');
+exports.tunnelResRead = handlePipe('tunnelResRead');
+exports.tunnelResWrite = handlePipe('tunnelResWrite');

package/lib/pipe.js

@@ -0,0 +1,32 @@
+const iconv = require('iconv-lite');
+const scripts = require('./scripts');
+const util = require('./util');
+
+const getHandlerName = (name) => {
+  return `handle${name[0].toUpperCase()}${name.substring(1)}`;
+};
+
+module.exports = (name) => {
+  const eventName = name[0] === 'r' ? 'request' : 'connect';
+  return (server, options) => {
+    options = Object.assign({
+      getCharset: util.getCharset,
+      isText: util.isText,
+      iconv,
+    }, options);
+    server.on(eventName, async (req, res) => {
+      const oReq = req.originalReq;
+      oReq.ruleValue = oReq.pipeValue || oReq.ruleValue;
+      const handleRequest = scripts.getHandler({ req })[getHandlerName(name)];
+      if (!util.isFunction(handleRequest)) {
+        return req.pipe(res);
+      }
+      try {
+        await handleRequest(req, res, options);
+      } catch (err) {
+        req.emit('error', err);
+        console.error(err); // eslint-disable-line
+      }
+    });
+  };
+};

package/lib/resRulesServer.js

@@ -5,6 +5,16 @@ const scripts = require('./scripts');
 module.exports = (server, options) => {
   const app = new Koa();
   app.use(async (ctx) => {
+    const { req } = ctx;
+    const rulesUrl = req.sessionStorage.get(util.RES_RULES_URL);
+    if (rulesUrl != null) {
+      req.sessionStorage.remove(util.RES_RULES_URL);
+      if (rulesUrl) {
+        const result = await util.request(rulesUrl, req.headers);
+        ctx.body = util.formateRules(result);
+      }
+      return;
+    }
     util.setupContext(ctx, options);
     const { handleResponseRules } = scripts.getHandler(ctx);
     if (util.isFunction(handleResponseRules)) {

package/lib/rulesServer.js

@@ -5,6 +5,17 @@ const scripts = require('./scripts');
 module.exports = (server, options) => {
   const app = new Koa();
   app.use(async (ctx) => {
+    const { req } = ctx;
+    if (util.isRemote(req)) {
+      const rulesUrl = util.getRemoteUrl(req, util.REQ_RULES_URL);
+      const resRulesUrl = util.getRemoteUrl(req, util.RES_RULES_URL);
+      req.sessionStorage.set(util.RES_RULES_URL, resRulesUrl || '');
+      if (rulesUrl) {
+        const result = await util.request(rulesUrl, req.headers);
+        ctx.body = util.formateRules(result);
+      }
+      return;
+    }
     util.setupContext(ctx, options);
     const {
       handleWebSocketRules,

package/lib/server.js

@@ -5,20 +5,15 @@ const util = require('./util');
 
 module.exports = (server, options) => {
   server.on('request', async (req, res) => {
-    const fullUrl = req.originalReq.url;
-    const ctx = {
-      iconv,
-      req,
-      res,
-      options,
-      fullUrl,
-      url: fullUrl,
-      headers: req.headers,
-      method: req.method,
-      getStreamBuffer: util.getStreamBuffer,
-      getCharset: util.getCharset,
-      isText: util.isText,
-    };
+    if (util.isRemote(req)) {
+      return req.passThrough();
+    }
+    const ctx = util.getContext(req, res);
+    ctx.getStreamBuffer = util.getStreamBuffer;
+    ctx.getCharset = util.getCharset;
+    ctx.isText = util.isText;
+    ctx.iconv = iconv;
+    ctx.options = options;
     const { handleRequest } = scripts.getHandler(ctx);
     if (!util.isFunction(handleRequest)) {
       return req.passThrough();
@@ -29,6 +24,8 @@ module.exports = (server, options) => {
       await handleRequest(ctx, req.request);
     } catch (err) {
       clearup();
+      req.emit('error', err);
+      console.error(err); // eslint-disable-line
     }
   });
   setupWsServer(server, options);

package/lib/sniCallback.js

@@ -0,0 +1,24 @@
+const scripts = require('./scripts');
+const { getRemoteUrl, getContext, getFn, request, SNI_URL, isSni } = require('./util');
+
+module.exports = async (req, options) => {
+  if (!isSni(req)) {
+    const oReq = req.originalReq;
+    oReq.ruleValue = oReq.sniValue || oReq.ruleValue;
+    const ctx = getContext(req);
+    const { sniCallback, SNICallback } = scripts.getHandler(ctx);
+    const sniCb = getFn(sniCallback, SNICallback);
+    return sniCb && sniCb(req, options);
+  }
+  const sniUrl = getRemoteUrl(req, SNI_URL);
+  if (sniUrl) {
+    const result = await request(sniUrl, req.headers);
+    if (result === false || result.cert === false) {
+      return false;
+    }
+    if (result === true || result.cert === true) {
+      return true;
+    }
+    return result;
+  }
+};

package/lib/tunnelRulesServer.js

@@ -5,6 +5,14 @@ const scripts = require('./scripts');
 module.exports = (server, options) => {
   const app = new Koa();
   app.use(async (ctx) => {
+    const { req } = ctx;
+    if (util.isRemote(req)) {
+      const rulesUrl = util.getRemoteUrl(req, util.REQ_RULES_URL);
+      if (rulesUrl) {
+        ctx.body = await util.request(rulesUrl, req.headers);
+      }
+      return;
+    }
     util.setupContext(ctx, options);
     const { handleTunnelRules } = scripts.getHandler(ctx);
     if (util.isFunction(handleTunnelRules)) {

package/lib/tunnelServer.js

@@ -4,6 +4,9 @@ const scripts = require('./scripts');
 
 module.exports = (server, options) => {
   server.on('connect', async (req, socket) => {
+    if (util.isRemote(req)) {
+      return req.passThrough();
+    }
     const { url, headers } = req;
     socket.headers = headers;
     socket.options = options;

package/lib/util.js

@@ -1,8 +1,23 @@
 const zlib = require('zlib');
 const { EventEmitter } = require('events');
+const { parse: parseUrl } = require('url');
+const http = require('http');
+const https = require('https');
 const dataSource = require('./dataSource');
 
-exports.isFunction = fn => typeof fn === 'function';
+exports.AUTH_URL = 'x-whistle-.script-auth-url';
+exports.SNI_URL = 'x-whistle-.script-sni-url';
+exports.REQ_RULES_URL = 'x-whistle-.script-req-rules-url';
+exports.RES_RULES_URL = 'x-whistle-.script-res-rules-url';
+exports.STATS_URL = 'x-whistle-.script-stats-url';
+exports.DATA_URL = 'x-whistle-.script-data-url';
+exports.noop = () => {};
+
+const POLICY = 'x-whistle-.script-policy';
+const isFunction = fn => typeof fn === 'function';
+const URL_RE = /^https?:(?:\/\/|%3A%2F%2F)[\w.-]/;
+
+exports.isFunction = isFunction;
 exports.noop = () => {};
 const getCharset = (headers) => {
   if (/charset=([^\s]+)/.test(headers['content-type'])) {
@@ -62,15 +77,23 @@ exports.setupContext = (ctx, options) => {
   ctx.fullUrl = ctx.req.originalReq.url;
 };
 
-exports.responseRules = (ctx) => {
-  if (!ctx.body && (ctx.rules || ctx.values)) {
-    ctx.body = {
+const formateRules = (ctx) => {
+  if (ctx.rules || ctx.values) {
+    return {
       rules: Array.isArray(ctx.rules) ? ctx.rules.join('\n') : `${ctx.rules}`,
       values: ctx.values,
     };
   }
 };
 
+exports.formateRules = formateRules;
+
+exports.responseRules = (ctx) => {
+  if (!ctx.body) {
+    ctx.body = formateRules(ctx);
+  }
+};
+
 exports.getDataSource = () => {
   const ds = new EventEmitter();
   const handleData = (type, args) => {
@@ -85,3 +108,102 @@ exports.getDataSource = () => {
     },
   };
 };
+
+exports.getContext = (req, res) => {
+  const fullUrl = req.originalReq.url;
+  return {
+    req,
+    res,
+    fullUrl,
+    url: fullUrl,
+    headers: req.headers,
+    method: req.method,
+  };
+};
+
+exports.getFn = (f1, f2) => {
+  if (isFunction(f1)) {
+    return f1;
+  } if (isFunction(f2)) {
+    return f2;
+  }
+};
+
+
+const request = (url, headers, data) => {
+  if (!url) {
+    return;
+  }
+  const options = parseUrl(url);
+  options.headers = Object.assign({}, headers);
+  delete options.headers.host;
+  if (data) {
+    data = Buffer.from(JSON.stringify(data));
+    options.method = 'POST';
+  }
+  return new Promise((resolve, reject) => {
+    const httpModule = options.protocol === 'https:' ? https : http;
+    options.rejectUnauthorized = true;
+    const client = httpModule.request(options, (res) => {
+      res.on('error', handleError);  // eslint-disable-line
+      let body;
+      res.on('data', (chunk) => {
+        body = body ? Buffer.concat([body, chunk]) : chunk;
+      });
+      res.on('end', () => {
+        clearTimeout(timer); // eslint-disable-line
+        if (body) {
+          try {
+            resolve(JSON.parse(body.toString()) || '');
+          } catch (e) {}
+        }
+        resolve('');
+      });
+    });
+    const handleError = (err) => {
+      clearTimeout(timer);  // eslint-disable-line
+      client.destroy();
+      reject(err);
+    };
+    const timer = setTimeout(() => handleError(new Error('Timeout')), 12000);
+    client.on('error', handleError);
+    client.end(data);
+  });
+};
+
+exports.request = async (url, headers, data) => {
+  try {
+    return await request(url, headers, data);
+  } catch (e) {
+    if (!data) {
+      return request(url, headers, data);
+    }
+  }
+};
+
+const hasPolicy = ({ headers }, name) => {
+  const policy = headers[POLICY];
+  if (typeof policy === 'string') {
+    return policy.toLowerCase().indexOf(name) !== -1;
+  }
+};
+
+const isRemote = (req) => {
+  return hasPolicy(req, 'remote');
+};
+
+exports.isRemote = isRemote;
+
+exports.isSni = (req) => {
+  return hasPolicy(req, 'sni');
+};
+
+exports.getRemoteUrl = (req, name) => {
+  let url = req.headers[name];
+  if (typeof url === 'string') {
+    url = decodeURIComponent(url);
+    if (URL_RE.test(url)) {
+      return url;
+    }
+  }
+};

package/lib/wsServer.js

@@ -1,16 +1,8 @@
 const crypto = require('crypto');
-const util = require('./util');
+const iconv = require('iconv-lite');
+const { getDataSource, getFn } = require('./util');
 const scripts = require('./scripts');
 
-const { getDataSource } = util;
-
-const getFn = (f1, f2) => {
-  if (util.isFunction(f1)) {
-    return f1;
-  } if (util.isFunction(f2)) {
-    return f2;
-  }
-};
 
 module.exports = (server, options) => {
   const { getReceiver, getSender } = options.wsParser;
@@ -63,6 +55,7 @@ module.exports = (server, options) => {
     req.on('error', clearup);
     socket.dataSource = dataSource;
     socket.headers = headers;
+    socket.iconv = iconv;
     socket.url = socket.fullUrl = oReq.url; // eslint-disable-line
     const handleUpgrade = (res) => {
       if (replied) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "whistle.script",
   "description": "The plugin for the extension script for whistle",
-  "version": "1.1.0",
+  "version": "1.2.3",
   "author": "avenwu <avenwu@vip.qq.com>",
   "contributors": [],
   "license": "MIT",
@@ -15,14 +15,17 @@
     "ssi"
   ],
   "registry": "https://github.com/whistle-plugins/whistle.script",
+  "whistleConfig": {
+    "pluginVars": true
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/whistle-plugins/whistle.script.git"
   },
   "scripts": {
     "dev": "webpack --config ./src/webpack.config.js -w",
-    "lint": "eslint ./lib index.js",
-    "lintfix": "eslint --fix ./lib index.js"
+    "lint": "eslint ./lib test index.js",
+    "lintfix": "eslint --fix ./lib test index.js"
   },
   "devDependencies": {
     "babel-core": "^6.7.6",

package/rules.txt

@@ -0,0 +1,2 @@
+* whistle.script:// includeFilter://reqH.x-whistle-.script-policy=remote
+* sniCallback://script includeFilter://reqH.x-whistle-.script-policy=sni