whistle.script 1.2.0 → 1.2.4

package/README.md

@@ -201,6 +201,60 @@ exports.auth = async (req, options) => {
 };
 ```
 
+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')` 引入。
 

package/lib/index.js

@@ -1,7 +1,23 @@
+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/server.js

@@ -24,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/util.js

@@ -2,9 +2,11 @@ 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.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';
@@ -13,7 +15,7 @@ exports.noop = () => {};
 
 const POLICY = 'x-whistle-.script-policy';
 const isFunction = fn => typeof fn === 'function';
-const URL_RE = /^http:(?:\/\/|%3A%2F%2F)[\w.-]/;
+const URL_RE = /^https?:(?:\/\/|%3A%2F%2F)[\w.-]/;
 
 exports.isFunction = isFunction;
 exports.noop = () => {};
@@ -140,7 +142,9 @@ const request = (url, headers, data) => {
     options.method = 'POST';
   }
   return new Promise((resolve, reject) => {
-    const client = http.request(options, (res) => {
+    const httpModule = options.protocol === 'https:' ? https : http;
+    options.rejectUnauthorized = false;
+    const client = httpModule.request(options, (res) => {
       res.on('error', handleError);  // eslint-disable-line
       let body;
       res.on('data', (chunk) => {
@@ -177,10 +181,23 @@ exports.request = async (url, headers, data) => {
   }
 };
 
-const isRemote = ({ headers }) => (headers[POLICY] === 'remote');
+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') {

package/lib/wsServer.js

@@ -1,4 +1,5 @@
 const crypto = require('crypto');
+const iconv = require('iconv-lite');
 const { getDataSource, getFn } = require('./util');
 const scripts = require('./scripts');
 
@@ -54,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.2.0",
+  "version": "1.2.4",
   "author": "avenwu <avenwu@vip.qq.com>",
   "contributors": [],
   "license": "MIT",
@@ -15,6 +15,9 @@
     "ssi"
   ],
   "registry": "https://github.com/whistle-plugins/whistle.script",
+  "whistleConfig": {
+    "pluginVars": true
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/whistle-plugins/whistle.script.git"

package/rules.txt

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