✨ Add proxy support ✨

Author: mildsunrise

README.md

@@ -61,6 +61,20 @@ If you want to allow another user to use the bot, use `/token` and give
 that user the resulting link. If you want to use this bot on a group,
 `/token` will give you a message to forward into the group.
 
+## Proxy server
+
+shell-bot obeys the `https_proxy` or `all_proxy` environment variable
+to use a proxy, and supports HTTP/HTTPS/SOCKS4/SOCKS4A/SOCKS5 proxies.
+Examples:
+
+~~~ bash
+export https_proxy="http://168.63.76.32:3128"
+node server
+
+export https_proxy="socks://127.0.0.1:9050"
+node server
+~~~
+
 
 
 [Telegram bot]: https://core.telegram.org/bots

lib/utils.js

@@ -6,6 +6,7 @@ var fs = require("fs");
 var util = require("util");
 var mime = require("mime");
 var crypto = require("crypto");
+var url = require("url");
 
 
 /** TIMER **/
@@ -201,6 +202,41 @@ function constructFilename(msg) {
   return "upload." + mime.extension(msg.file.mime);
 }
 
+/** AGENT **/
+
+function createAgent() {
+  var proxy = process.env["https_proxy"] || process.env["all_proxy"];
+  if (!proxy) return;
+
+  try {
+    proxy = url.parse(proxy);
+  } catch (e) {
+    console.error("Error parsing proxy URL:", e, "Ignoring proxy.");
+    return;
+  }
+
+  if ([ "socks:", "socks4:", "socks4a:", "socks5:" ].indexOf(proxy.protocol) !== -1) {
+    try {
+      var SocksProxyAgent = require('socks-proxy-agent');
+    } catch (e) {
+      console.error("Error loading SOCKS proxy support, verify socks-proxy-agent is correctly installed. Ignoring proxy.");
+      return;
+    }
+    return new SocksProxyAgent(proxy);
+  }
+  if ([ "http:", "https:" ].indexOf(proxy.protocol) !== -1) {
+    try {
+      var HttpsProxyAgent = require('https-proxy-agent');
+    } catch (e) {
+      console.error("Error loading HTTPS proxy support, verify https-proxy-agent is correctly installed. Ignoring proxy.");
+      return;
+    }
+    return new HttpsProxyAgent(proxy);
+  }
+
+  console.error("Unknown proxy protocol:", util.inspect(proxy.protocol), "Ignoring proxy.");
+}
+
 
 
 exports.Timer = Timer;
@@ -212,3 +248,4 @@ exports.resolveShell = resolveShell;
 exports.generateToken = generateToken;
 exports.resolveBoolean = resolveBoolean;
 exports.constructFilename = constructFilename;
+exports.createAgent = createAgent;

lib/wizard.js

@@ -2,6 +2,7 @@ var readline = require("readline");
 var botgram = require("botgram");
 var fs = require("fs");
 var util = require("util");
+var utils = require("./utils");
 
 // Wizard functions
 
@@ -91,7 +92,7 @@ function writeFile(file, contents) {
 
 function createBot(token) {
     return new Promise(function (resolve, reject) {
-        var bot = botgram(token);
+        var bot = botgram(token, { agent: utils.createAgent() });
         bot.on("error", function (err) {
             bot.stop();
             reject(err);

package-lock.json

@@ -18,6 +18,10 @@
     "node-pty": "^0.8.1",
     "terminal.js": "1.0.9"
   },
+  "optionalDependencies": {
+    "https-proxy-agent": "^2.2.1",
+    "socks-proxy-agent": "^4.0.1",
+  },
   "bugs": {
     "url": "https://github.com/botgram/shell-bot/issues"
   },

package.json

@@ -21,7 +21,7 @@ try {
     return;
 }
 
-var bot = botgram(config.authToken);
+var bot = botgram(config.authToken, { agent: utils.createAgent() });
 var owner = config.owner;
 var tokens = {};
 var granted = {};