XiaoMo/anyproxy
1
0
Fork 0
mirror of https://github.com/alibaba/anyproxy.git synced 2025-04-24 08:41:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

invoke log util, console.log can be switched off

Browse Source
This commit is contained in:
OttoMao 2015-03-23 10:20:04 +08:00
parent bdf5e4fabb
commit 68478cd162
10 changed files with 122 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -109,7 +109,8 @@ var options = {
socketPort : 8003, // optional, internal port for web socket, replace this when it is conflict with your own service socketPort : 8003, // optional, internal port for web socket, replace this when it is conflict with your own service
webConfigPort : 8088, // optional, internal port for web config(beta), replace this when it is conflict with your own service webConfigPort : 8088, // optional, internal port for web config(beta), replace this when it is conflict with your own service
throttle : 10, // optional, speed limit in kb/s throttle : 10, // optional, speed limit in kb/s
disableWebInterface : false //optional, set it when you don't want to use the web interface disableWebInterface : false, //optional, set it when you don't want to use the web interface
silent : false, //optional, do not print anything into terminal. do not set it when you are still debugging.
}; };
new proxy.proxyServer(options); new proxy.proxyServer(options);

24
bin.js
View File

@ -5,7 +5,8 @@ var program = require('commander'),
fs = require("fs"), fs = require("fs"),
path = require("path"), path = require("path"),
npm = require("npm"), npm = require("npm"),
packageInfo = require("./package.json"); packageInfo = require("./package.json"),
logUtil = require("./lib/log");
program program
.version(packageInfo.version) .version(packageInfo.version)
@ -17,6 +18,7 @@ program
.option('-g, --root [value]', 'generate root CA') .option('-g, --root [value]', 'generate root CA')
.option('-l, --throttle [value]', 'throttle speed in kb/s (kbyte / sec)') .option('-l, --throttle [value]', 'throttle speed in kb/s (kbyte / sec)')
.option('-i, --intercept', 'intercept(decrypt) https requests when root CA exists') .option('-i, --intercept', 'intercept(decrypt) https requests when root CA exists')
.option('-s, --silent', 'do not print anything into terminal')
.option('-c, --clear', 'clear all the tmp certificates') .option('-c, --clear', 'clear all the tmp certificates')
.option('install', 'install node modules') .option('install', 'install node modules')
.parse(process.argv); .parse(process.argv);
@ -37,26 +39,29 @@ if(program.clear){
}, function (er) { }, function (er) {
npm.commands.install(program.args || [], function (er, data) { npm.commands.install(program.args || [], function (er, data) {
if(er)throw er; if(er)throw er;
}) });
npm.registry.log.on("log", function (message) { npm.registry.log.on("log", function (message) {});
})
}); });
}else{ }else{
var proxy = require("./proxy.js"); var proxy = require("./proxy.js");
var ruleModule; var ruleModule;
if(program.silent){
logUtil.setPrintStatus(false);
}
if(program.rule){ if(program.rule){
var ruleFilePath = path.resolve(process.cwd(),program.rule); var ruleFilePath = path.resolve(process.cwd(),program.rule);
try{ try{
if(fs.existsSync(ruleFilePath)){ if(fs.existsSync(ruleFilePath)){
ruleModule = require(ruleFilePath); ruleModule = require(ruleFilePath);
console.log("rule file loaded :" + ruleFilePath); logUtil.printLog("rule file loaded :" + ruleFilePath);
}else{ }else{
console.log(ruleFilePath); var logText = color.red("can not find rule file at " + ruleFilePath);
console.log(color.red("can not find rule file")); logUtil.printLog(logText, logUtil.T_ERR);
} }
}catch(e){ }catch(e){
console.log("failed to load rule file :" + e.toString()); logUtil.printLog("failed to load rule file :" + e.toString(), logUtil.T_ERR);
} }
} }
@ -68,6 +73,7 @@ if(program.clear){
throttle : program.throttle, throttle : program.throttle,
rule : ruleModule, rule : ruleModule,
disableWebInterface : false, disableWebInterface : false,
interceptHttps : program.intercept interceptHttps : program.intercept,
silent : program.silent
}); });
} }

38
lib/certMgr.js
View File

@ -6,6 +6,7 @@ var exec = require('child_process').exec,
color = require('colorful'), color = require('colorful'),
readline = require('readline'), readline = require('readline'),
util = require('./util'), util = require('./util'),
logUtil = require("./log"),
asyncTask = require("async-task-mgr"); asyncTask = require("async-task-mgr");
//TODO : unstable in windows //TODO : unstable in windows
@ -19,10 +20,10 @@ if(!fs.existsSync(certDir)){
try{ try{
fs.mkdirSync(certDir,0777); //may fail in windows fs.mkdirSync(certDir,0777); //may fail in windows
}catch(e){ }catch(e){
console.log("==========="); logUtil.printLog("===========", logUtil.T_ERR);
console.log("failed to create cert dir ,please create one by yourself - " + certDir); logUtil.printLog("failed to create cert dir ,please create one by yourself - " + certDir, logUtil.T_ERR);
console.log("this error will not block main thread unless you use https-related features in anyproxy"); logUtil.printLog("this error will not block main thread unless you use https-related features in anyproxy", logUtil.T_ERR);
console.log("==========="); logUtil.printLog("===========", logUtil.T_ERR);
} }
} }
@ -62,7 +63,7 @@ function createCert(hostname,callback){
callback && callback(new Error("error when generating certificate"),null); callback && callback(new Error("error when generating certificate"),null);
}else{ }else{
var tipText = "certificate created for __HOST".replace(/__HOST/,hostname); var tipText = "certificate created for __HOST".replace(/__HOST/,hostname);
console.log(color.yellow(color.bold("[internal https]")) + color.yellow(tipText)); logUtil.printLog(color.yellow(color.bold("[internal https]")) + color.yellow(tipText)) ;
callback(null); callback(null);
} }
}); });
@ -80,18 +81,19 @@ function isRootCAFileExists(){
} }
function checkRootCA(){ function checkRootCA(){
if(!isRootCAFileExists()){ if(!isRootCAFileExists() || true){
console.log(color.red("can not find rootCA.crt or rootCA.key")); logUtil.printLog(color.red("can not find rootCA.crt or rootCA.key"), logUtil.T_ERR);
console.log(color.red("you may generate one by the following methods")); logUtil.printLog(color.red("you may generate one by the following methods"), logUtil.T_ERR);
console.log(color.red("\twhen using globally : anyproxy --root")); logUtil.printLog(color.red("\twhen using globally : anyproxy --root"), logUtil.T_ERR);
console.log(color.red("\twhen using as a module : require(\"anyproxy\").generateRootCA();")); logUtil.printLog(color.red("\twhen using as a module : require(\"anyproxy\").generateRootCA();"), logUtil.T_ERR);
logUtil.printLog(color.red("\tmore info : https://github.com/alibaba/anyproxy/wiki/How-to-config-https-proxy"), logUtil.T_ERR);
process.exit(0); process.exit(0);
} }
} }
function generateRootCA(){ function generateRootCA(){
if(isRootCAFileExists()){ if(isRootCAFileExists()){
console.log(color.yellow("rootCA exists at " + certDir)); logUtil.printLog(color.yellow("rootCA exists at " + certDir));
var rl = readline.createInterface({ var rl = readline.createInterface({
input : process.stdin, input : process.stdin,
output: process.stdout output: process.stdout
@ -101,7 +103,7 @@ function generateRootCA(){
if(/yes/i.test(answer)){ if(/yes/i.test(answer)){
startGenerating(); startGenerating();
}else{ }else{
console.log("will not generate a new one"); logUtil.printLog("will not generate a new one");
process.exit(0); process.exit(0);
} }
@ -114,18 +116,18 @@ function generateRootCA(){
function startGenerating(){ function startGenerating(){
//clear old certs //clear old certs
clearCerts(function(){ clearCerts(function(){
console.log(color.green("temp certs cleared")); logUtil.printLog(color.green("temp certs cleared"));
var spawnSteam = spawn(cmd_genRoot,['.'],{cwd:certDir,stdio: 'inherit'}); var spawnSteam = spawn(cmd_genRoot,['.'],{cwd:certDir,stdio: 'inherit'});
spawnSteam.on('close', function (code) { spawnSteam.on('close', function (code) {
if(code == 0){ if(code == 0){
console.log(color.green("rootCA generated")); logUtil.printLog(color.green("rootCA generated"));
console.log(color.green(color.bold("please trust the rootCA.crt in " + certDir))); logUtil.printLog(color.green(color.bold("please trust the rootCA.crt in " + certDir)));
console.log(color.green(color.bold("or you may get it via anyproxy webinterface"))); logUtil.printLog(color.green(color.bold("or you may get it via anyproxy webinterface")));
process.exit(0);
}else{ }else{
console.log(color.red("fail to generate root CA")); logUtil.printLog(color.red("fail to generate root CA"),logUtil.T_ERR);
} }
process.exit(0);
}); });
}); });

7
lib/httpsServerMgr.js
View File

@ -9,6 +9,7 @@ var getPort = require('./getPort'),
crypto = require('crypto'), crypto = require('crypto'),
color = require('colorful'), color = require('colorful'),
certMgr = require("./certMgr"), certMgr = require("./certMgr"),
logUtil = require("./log"),
asyncTask = require("async-task-mgr"); asyncTask = require("async-task-mgr");
var createSecureContext = tls.createSecureContext || crypto.createSecureContext; var createSecureContext = tls.createSecureContext || crypto.createSecureContext;
@ -43,11 +44,11 @@ function SNIPrepareCert(serverName,SNICallback){
],function(err,result){ ],function(err,result){
if(!err){ if(!err){
var tipText = "proxy server for __NAME established".replace("__NAME",serverName); var tipText = "proxy server for __NAME established".replace("__NAME",serverName);
console.log(color.yellow(color.bold("[internal https]")) + color.yellow(tipText)); logUtil.printLog(color.yellow(color.bold("[internal https]")) + color.yellow(tipText));
SNICallback(null,ctx); SNICallback(null,ctx);
}else{ }else{
console.log("err occurred when prepare certs for SNI - " + err); logUtil.printLog("err occurred when prepare certs for SNI - " + err, logUtil.T_ERR);
console.log("you may upgrade your Node.js to the lastest version"); logUtil.printLog("you may upgrade your Node.js to the lastest version", logUtil.T_ERR);
} }
}); });
} }

17
lib/log.js Normal file
View File

@ -0,0 +1,17 @@
var ifPrint = true;
function setPrintStatus(status){
ifPrint = !!status;
}
function printLog(content,type){
if(!ifPrint) return;
var tip = content;
console.log(tip);
}
module.exports.printLog = printLog;
module.exports.setPrintStatus = setPrintStatus;
module.exports.T_TIP = 0;
module.exports.T_ERR = 1;

9
lib/recorder.js
View File

@ -3,7 +3,8 @@ var zlib = require('zlib'),
Datastore = require('nedb'), Datastore = require('nedb'),
util = require("util"), util = require("util"),
fs = require("fs"), fs = require("fs"),
events = require('events'); events = require('events'),
logUtil = require("./log");
//option.filename //option.filename
function Recorder(option){ function Recorder(option){
@ -24,11 +25,11 @@ function Recorder(option){
autoload :true autoload :true
}); });
db.persistence.setAutocompactionInterval(5001); db.persistence.setAutocompactionInterval(5001);
console.log("db file : " + option.filename); logUtil.printLog("db file : " + option.filename);
}catch(e){ }catch(e){
console.log(e); logUtil.printLog(e, logUtil.T_ERR);
console.log("Failed to load on-disk db file. Will use in-meomory db instead."); logUtil.printLog("Failed to load on-disk db file. Will use in-meomory db instead.", logUtil.T_ERR);
db = new Datastore(); db = new Datastore();
} }

29
lib/requestHandler.js
View File

@ -11,6 +11,7 @@ var http = require("http"),
util = require("./util"), util = require("./util"),
getPort = require("./getPort"), getPort = require("./getPort"),
Stream = require("stream"), Stream = require("stream"),
logUtil = require("./log"),
httpsServerMgr = require("./httpsServerMgr"); httpsServerMgr = require("./httpsServerMgr");
var defaultRule = require("./rule_default.js"), var defaultRule = require("./rule_default.js"),
@ -40,7 +41,7 @@ function userRequestHandler(req,userRes){
resourceInfoId = GLOBAL.recorder.appendRecord(resourceInfo); resourceInfoId = GLOBAL.recorder.appendRecord(resourceInfo);
} }
console.log(color.green("\nreceived request to : " + host + path)); logUtil.printLog(color.green("\nreceived request to : " + host + path));
//get request body and route to local or remote //get request body and route to local or remote
async.series([fetchReqData,routeReq],function(){}); async.series([fetchReqData,routeReq],function(){});
@ -63,10 +64,10 @@ function userRequestHandler(req,userRes){
//route to dealing function //route to dealing function
function routeReq(callback){ function routeReq(callback){
if(userRule.shouldUseLocalResponse(req,reqData)){ if(userRule.shouldUseLocalResponse(req,reqData)){
console.log("==>use local rules"); logUtil.printLog("==>use local rules");
dealWithLocalResponse(callback); dealWithLocalResponse(callback);
}else{ }else{
console.log("==>will forward to real server by proxy"); logUtil.printLog("==>will forward to real server by proxy");
dealWithRemoteResonse(callback); dealWithRemoteResonse(callback);
} }
} }
@ -163,7 +164,7 @@ function userRequestHandler(req,userRes){
//get custom response //get custom response
},function(callback){ },function(callback){
if(userRule.replaceServerResData){ if(userRule.replaceServerResData){
console.log(color.red("replaceServerResData is deprecated, and will be unavilable soon. Use replaceServerResDataAsync instead.")); logUtil.printLog(color.red("replaceServerResData is deprecated, and will be unavilable soon. Use replaceServerResDataAsync instead."), logUtil.T_ERR);
serverResData = userRule.replaceServerResData(req,res,serverResData) || serverResData; serverResData = userRule.replaceServerResData(req,res,serverResData) || serverResData;
callback(); callback();
}else if(userRule.replaceServerResDataAsync){ }else if(userRule.replaceServerResDataAsync){
@ -225,13 +226,13 @@ function userRequestHandler(req,userRes){
}); });
res.on('error',function(error){ res.on('error',function(error){
console.log('error',error); logUtil.printLog('error' + error, logUtil.T_ERR);
}); });
}); });
proxyReq.on("error",function(e){ proxyReq.on("error",function(e){
console.log("err with request :" + e + " " + req.url); logUtil.printLog("err with request :" + e + " " + req.url, logUtil.T_ERR);
userRes.end(); userRes.end();
}); });
@ -252,11 +253,11 @@ function connectReqHandler(req, socket, head){
shouldIntercept = false; // TODO : a more general solution? shouldIntercept = false; // TODO : a more general solution?
} }
console.log(color.green("\nreceived https CONNECT request " + host)); logUtil.printLog(color.green("\nreceived https CONNECT request " + host));
if(shouldIntercept){ if(shouldIntercept){
console.log("==>will forward to local https server"); logUtil.printLog("==>will forward to local https server");
}else{ }else{
console.log("==>will bypass the man-in-the-middle proxy"); logUtil.printLog("==>will bypass the man-in-the-middle proxy");
} }
//record //record
@ -334,10 +335,10 @@ function connectReqHandler(req, socket, head){
}); });
conn.on("error",function(e){ conn.on("error",function(e){
console.log("err when connect to %j, %j" , host , e); logUtil.printLog("err when connect to + " + host + " , " + e, logUtil.T_ERR);
}); });
}catch(e){ }catch(e){
console.log("err when connect to remote https server (__host)".replace(/__host/,host)); logUtil.printLog("err when connect to remote https server (__host)".replace(/__host/,host), logUtil.T_ERR);
} }
//update record //update record
@ -354,7 +355,7 @@ function connectReqHandler(req, socket, head){
} }
],function(err,result){ ],function(err,result){
if(err){ if(err){
console.log("err " + err); logUtil.printLog("err " + err, logUtil.T_ERR);
throw err; throw err;
} }
}); });
@ -381,13 +382,13 @@ function setRules(newRule){
} }
if('function' == typeof(userRule.summary)){ if('function' == typeof(userRule.summary)){
functions.push(function(cb){ functions.push(function(cb){
console.log(userRule.summary()); logUtil.printLog(userRule.summary());
cb(null); cb(null);
}); });
} }
async.series(functions,function(errors,result){ async.series(functions,function(errors,result){
if(!errors){ if(!errors){
console.log(color.green('Anyproxy rules initialize finished, have fun!')); logUtil.printLog(color.green('Anyproxy rules initialize finished, have fun!'));
} }
}); });

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "anyproxy", "name": "anyproxy",
"version": "3.2.5", "version": "3.3.0",
"description": "A fully configurable proxy in NodeJS, which can handle HTTPS requests perfectly.", "description": "A fully configurable proxy in NodeJS, which can handle HTTPS requests perfectly.",
"main": "proxy.js", "main": "proxy.js",
"bin": { "bin": {

33
proxy.js
View File

@ -13,6 +13,7 @@ var http = require('http'),
getPort = require("./lib/getPort"), getPort = require("./lib/getPort"),
requestHandler = require("./lib/requestHandler"), requestHandler = require("./lib/requestHandler"),
Recorder = require("./lib/recorder"), Recorder = require("./lib/recorder"),
logUtil = require("./lib/log"),
inherits = require("util").inherits, inherits = require("util").inherits,
util = require("./lib/util"), util = require("./lib/util"),
path = require("path"), path = require("path"),
@ -50,7 +51,7 @@ try{
} }
}catch(e){ }catch(e){
if(e){ if(e){
console.log("error" + e); logUtil.printLog("error" + e, logUtil.T_ERR);
throw e; throw e;
} }
} }
@ -66,6 +67,7 @@ try{
//option.dbFile : null(default) //option.dbFile : null(default)
//option.throttle : null(default) //option.throttle : null(default)
//option.disableWebInterface //option.disableWebInterface
//option.silent : false(default)
//option.interceptHttps ,internal param for https //option.interceptHttps ,internal param for https
function proxyServer(option){ function proxyServer(option){
option = option || {}; option = option || {};
@ -78,7 +80,12 @@ function proxyServer(option){
proxyWebPort = option.webPort || DEFAULT_WEB_PORT, //port for web interface proxyWebPort = option.webPort || DEFAULT_WEB_PORT, //port for web interface
socketPort = option.socketPort || DEFAULT_WEBSOCKET_PORT, //port for websocket socketPort = option.socketPort || DEFAULT_WEBSOCKET_PORT, //port for websocket
proxyConfigPort = option.webConfigPort || DEFAULT_CONFIG_PORT, //port to ui config server proxyConfigPort = option.webConfigPort || DEFAULT_CONFIG_PORT, //port to ui config server
disableWebInterface = !!option.disableWebInterface ; disableWebInterface = !!option.disableWebInterface,
ifSilent = !!option.silent;
if(ifSilent){
logUtil.setPrintStatus(false);
}
if(option.dbFile){ if(option.dbFile){
GLOBAL.recorder = new Recorder({filename: option.dbFile}); GLOBAL.recorder = new Recorder({filename: option.dbFile});
@ -91,7 +98,7 @@ function proxyServer(option){
} }
if(option.throttle){ if(option.throttle){
console.log("throttle :" + option.throttle + "kb/s"); logUtil.printLog("throttle :" + option.throttle + "kb/s");
GLOBAL._throttle = new ThrottleGroup({rate: 1024 * parseInt(option.throttle) }); // rate - byte/sec GLOBAL._throttle = new ThrottleGroup({rate: 1024 * parseInt(option.throttle) }); // rate - byte/sec
} }
@ -132,7 +139,7 @@ function proxyServer(option){
//start web interface //start web interface
function(callback){ function(callback){
if(disableWebInterface){ if(disableWebInterface){
console.log('web interface is disabled'); logUtil.printLog('web interface is disabled');
callback(null); callback(null);
}else{ }else{
@ -199,13 +206,13 @@ function proxyServer(option){
//kill web server when father process exits //kill web server when father process exits
process.on("exit",function(code){ process.on("exit",function(code){
child_webServer.kill(); child_webServer.kill();
console.log('AnyProxy is about to exit with code:', code); logUtil.printLog('AnyProxy is about to exit with code: ' + code, logUtil.T_ERR);
process.exit(); process.exit();
}); });
process.on("uncaughtException",function(err){ process.on("uncaughtException",function(err){
child_webServer.kill(); child_webServer.kill();
console.log('Caught exception: ' + err); logUtil.printLog('Caught exception: ' + err, logUtil.T_ERR);
process.exit(); process.exit();
}); });
@ -222,10 +229,10 @@ function proxyServer(option){
var tipText,webUrl; var tipText,webUrl;
webUrl = "http://" + ip.address() + ":" + proxyWebPort +"/"; webUrl = "http://" + ip.address() + ":" + proxyWebPort +"/";
tipText = "GUI interface started at : " + webUrl; tipText = "GUI interface started at : " + webUrl;
console.log(color.green(tipText)); logUtil.printLog(color.green(tipText));
// tipText = "[alpha]qr code to for iOS client: " + webUrl + "qr"; // tipText = "[alpha]qr code to for iOS client: " + webUrl + "qr";
// console.log(color.green(tipText)); // logUtil.printLog(color.green(tipText));
callback(null); callback(null);
} }
} }
@ -235,18 +242,18 @@ function proxyServer(option){
function(err,result){ function(err,result){
if(!err){ if(!err){
var tipText = (proxyType == T_TYPE_HTTP ? "Http" : "Https") + " proxy started at " + color.bold(ip.address() + ":" + proxyPort); var tipText = (proxyType == T_TYPE_HTTP ? "Http" : "Https") + " proxy started at " + color.bold(ip.address() + ":" + proxyPort);
console.log(color.green(tipText)); logUtil.printLog(color.green(tipText));
}else{ }else{
var tipText = "err when start proxy server :("; var tipText = "err when start proxy server :(";
console.log(color.red(tipText)); logUtil.printLog(color.red(tipText), logUtil.T_ERR);
console.log(err); logUtil.printLog(err, logUtil.T_ERR);
} }
} }
); );
self.close = function(){ self.close = function(){
self.httpProxyServer && self.httpProxyServer.close(); self.httpProxyServer && self.httpProxyServer.close();
console.log(color.green("server closed :" + proxyHost + ":" + proxyPort)); logUtil.printLog(color.green("server closed :" + proxyHost + ":" + proxyPort));
} }
} }
@ -257,7 +264,7 @@ function UIConfigServer(port){
var app = express(), var app = express(),
customerRule = { customerRule = {
summary: function(){ summary: function(){
console.log("replace some response with local response"); logUtil.printLog("replace some response with local response");
return "replace some response with local response"; return "replace some response with local response";
} }
}, },

3
webServer.js
View File

@ -8,6 +8,7 @@ var express = require("express"),
inherits = require("util").inherits, inherits = require("util").inherits,
ent = require("ent"), ent = require("ent"),
qrCode = require('qrcode-npm'), qrCode = require('qrcode-npm'),
logUtil = require("./lib/log"),
WebSocketServer = require('ws').Server; WebSocketServer = require('ws').Server;
function proxyWebServer(port,webSocketPort,proxyConfigPort,ruleSummary,ipAddress,menuListStr){ function proxyWebServer(port,webSocketPort,proxyConfigPort,ruleSummary,ipAddress,menuListStr){
@ -118,7 +119,7 @@ function proxyWebServer(port,webSocketPort,proxyConfigPort,ruleSummary,ipAddress
try{ try{
this.clients[i].send(data); this.clients[i].send(data);
}catch(e){ }catch(e){
console.log("websocket failed to send data, " + e); logUtil.printLog("websocket failed to send data, " + e, logUtil.T_ERR);
} }
} }
}; };