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

Create gh-pages branch via GitHub

Browse Source
This commit is contained in:
alexyan
2014-11-26 11:57:05 +08:00
parent 3ca8359a21
commit 2fa6a88253
8 changed files with 621 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

250
index.html
View File

@@ -1,53 +1,58 @@
<!doctype html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>Anyproxy by alipay-ct-wd</title>
<meta name="description" content="Anyproxy : A fully configurable proxy in NodeJS, which can handle HTTPS requests perfectly.">
<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>Anyproxy</title>
</head>
<body>
<div class="wrapper">
<header>
<h1>Anyproxy</h1>
<p>A fully configurable proxy in NodeJS, which can handle HTTPS requests perfectly.</p>
<p class="view"><a href="https://github.com/alipay-ct-wd/anyproxy">View the Project on GitHub <small>alipay-ct-wd/anyproxy</small></a></p>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/alibaba/anyproxy">View on GitHub</a>
<h1 id="project_title">Anyproxy</h1>
<h2 id="project_tagline">A fully configurable proxy in NodeJS, which can handle HTTPS requests perfectly.</h2>
<ul>
<li><a href="https://github.com/alipay-ct-wd/anyproxy/zipball/master">Download <strong>ZIP File</strong></a></li>
<li><a href="https://github.com/alipay-ct-wd/anyproxy/tarball/master">Download <strong>TAR Ball</strong></a></li>
<li><a href="https://github.com/alipay-ct-wd/anyproxy">View On <strong>GitHub</strong></a></li>
</ul>
</header>
<section>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/alibaba/anyproxy/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/alibaba/anyproxy/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>
<a name="anyproxy" class="anchor" href="#anyproxy"><span class="octicon octicon-link"></span></a>anyproxy</h1>
<a id="anyproxy" class="anchor" href="#anyproxy" aria-hidden="true"><span class="octicon octicon-link"></span></a>anyproxy</h1>
<p>A fully configurable proxy in NodeJS, which can handle HTTPS requests perfectly.</p>
<h2>
<a name="feature" class="anchor" href="#feature"><span class="octicon octicon-link"></span></a>Feature</h2>
<a id="feature" class="anchor" href="#feature" aria-hidden="true"><span class="octicon octicon-link"></span></a>Feature</h2>
<ul>
<li>work as http or https proxy</li>
<li>fully configurable, you can modify a request at any stage by your own javascript code</li>
<li>when working as https proxy, it can generate and intercept https requests for any domain without complaint by browser (after you trust its root CA)</li>
<li>provide a web interface</li>
</ul><p><img src="http://gtms03.alicdn.com/tps/i3/TB1ddyqGXXXXXbXXpXXihxC1pXX-1000-549.jpg_640x640q90.jpg" alt="screenshot"></p>
</ul>
<p><img src="http://gtms03.alicdn.com/tps/i3/TB1ddyqGXXXXXbXXpXXihxC1pXX-1000-549.jpg_640x640q90.jpg" alt="screenshot"></p>
<h2>
<a name="usage" class="anchor" href="#usage"><span class="octicon octicon-link"></span></a>Usage</h2>
<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span class="octicon octicon-link"></span></a>Usage</h2>
<h3>
<a name="step-1---install" class="anchor" href="#step-1---install"><span class="octicon octicon-link"></span></a>step 1 - install</h3>
<a id="step-1---install" class="anchor" href="#step-1---install" aria-hidden="true"><span class="octicon octicon-link"></span></a>step 1 - install</h3>
<ul>
<li>install <a href="http://nodejs.org/">NodeJS</a>
@@ -55,21 +60,27 @@
<li>
<code>npm install -g anyproxy</code> , may require <code>sudo</code>
</li>
</ul><h3>
<a name="step-2---start-server" class="anchor" href="#step-2---start-server"><span class="octicon octicon-link"></span></a>step 2 - start server</h3>
</ul>
<h3>
<a id="step-2---start-server" class="anchor" href="#step-2---start-server" aria-hidden="true"><span class="octicon octicon-link"></span></a>step 2 - start server</h3>
<ul>
<li>start with default settings : <code>anyproxy</code>
</li>
<li>start with a specific port: <code>anyproxy --port 8001</code>
</li>
</ul><h3>
<a name="step-3---launch-web-interface" class="anchor" href="#step-3---launch-web-interface"><span class="octicon octicon-link"></span></a>step 3 - launch web interface</h3>
</ul>
<h3>
<a id="step-3---launch-web-interface" class="anchor" href="#step-3---launch-web-interface" aria-hidden="true"><span class="octicon octicon-link"></span></a>step 3 - launch web interface</h3>
<ul>
<li>visit <a href="http://127.0.0.1:8002">http://127.0.0.1:8002</a> with modern browsers</li>
</ul><h2>
<a name="how-to-write-your-own-rule-file" class="anchor" href="#how-to-write-your-own-rule-file"><span class="octicon octicon-link"></span></a>How to write your own rule file</h2>
</ul>
<h2>
<a id="how-to-write-your-own-rule-file" class="anchor" href="#how-to-write-your-own-rule-file" aria-hidden="true"><span class="octicon octicon-link"></span></a>How to write your own rule file</h2>
<ul>
<li>with rule file, you can modify a request at any stage, no matter it's just before sending or after servers' responding.</li>
@@ -100,137 +111,148 @@
</ul>
</li>
<li><p>rule file scheme is as follows, you may also get it from <a href="https://github.com/alipay-ct-wd/anyproxy/blob/master/rule_sample/rule__blank.js">rule__blank.js</a></p></li>
</ul><div class="highlight highlight-javascript"><pre>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="p">{</span>
<span class="cm">/*</span>
<span class="cm"> these functions will overwrite the default ones, write your own when necessary.</span>
<span class="cm"> */</span>
</ul>
<span class="c1">//whether to intercept this request by local logic</span>
<span class="c1">//if the return value is true, anyproxy will call dealLocalResponse to get response data and will not send request to remote server anymore</span>
<span class="nx">shouldUseLocalResponse</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">reqBody</span><span class="p">){</span>
<span class="k">return</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">},</span>
<div class="highlight highlight-javascript"><pre>
<span class="pl-sv">module</span>.exports <span class="pl-k">=</span> {
<span class="pl-c">/*</span>
<span class="pl-c"> these functions will overwrite the default ones, write your own when necessary.</span>
<span class="pl-c"> */</span>
<span class="c1">//you may deal the response locally instead of sending it to server</span>
<span class="c1">//this function be called when shouldUseLocalResponse returns true</span>
<span class="c1">//callback(statusCode,resHeader,responseData)</span>
<span class="c1">//e.g. callback(200,{"content-type":"text/html"},"hello world")</span>
<span class="nx">dealLocalResponse</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">reqBody</span><span class="p">,</span><span class="nx">callback</span><span class="p">){</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">statusCode</span><span class="p">,</span><span class="nx">resHeader</span><span class="p">,</span><span class="nx">responseData</span><span class="p">)</span>
<span class="p">},</span>
<span class="pl-c">//whether to intercept this request by local logic</span>
<span class="pl-c">//if the return value is true, anyproxy will call dealLocalResponse to get response data and will not send request to remote server anymore</span>
<span class="pl-en">shouldUseLocalResponse</span> : <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">reqBody</span>){
<span class="pl-k">return</span> <span class="pl-c1">false</span>;
},
<span class="c1">//replace the request protocol when sending to the real server</span>
<span class="c1">//protocol : "http" or "https"</span>
<span class="nx">replaceRequestProtocol</span><span class="o">:</span><span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">protocol</span><span class="p">){</span>
<span class="kd">var</span> <span class="nx">newProtocol</span> <span class="o">=</span> <span class="nx">protocol</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">newProtocol</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//you may deal the response locally instead of sending it to server</span>
<span class="pl-c">//this function be called when shouldUseLocalResponse returns true</span>
<span class="pl-c">//callback(statusCode,resHeader,responseData)</span>
<span class="pl-c">//e.g. callback(200,{"content-type":"text/html"},"hello world")</span>
<span class="pl-en">dealLocalResponse</span> : <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">reqBody</span>,<span class="pl-vpf">callback</span>){
callback(statusCode,resHeader,responseData)
},
<span class="c1">//req is user's request sent to the proxy server</span>
<span class="c1">//option is how the proxy server will send request to the real server. i.e. require("http").request(option,function(){...})</span>
<span class="c1">//you may return a customized option to replace the original option</span>
<span class="c1">//you should not write content-length header in options, since anyproxy will handle it for you</span>
<span class="nx">replaceRequestOption</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">option</span><span class="p">){</span>
<span class="kd">var</span> <span class="nx">newOption</span> <span class="o">=</span> <span class="nx">option</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">newOption</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//replace the request protocol when sending to the real server</span>
<span class="pl-c">//protocol : "http" or "https"</span>
<span class="pl-en">replaceRequestProtocol</span>:<span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">protocol</span>){
<span class="pl-s">var</span> newProtocol <span class="pl-k">=</span> protocol;
<span class="pl-k">return</span> newProtocol;
},
<span class="c1">//replace the request body</span>
<span class="nx">replaceRequestData</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">data</span><span class="p">){</span>
<span class="k">return</span> <span class="nx">data</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//req is user's request sent to the proxy server</span>
<span class="pl-c">//option is how the proxy server will send request to the real server. i.e. require("http").request(option,function(){...})</span>
<span class="pl-c">//you may return a customized option to replace the original option</span>
<span class="pl-c">//you should not write content-length header in options, since anyproxy will handle it for you</span>
<span class="pl-en">replaceRequestOption</span> : <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">option</span>){
<span class="pl-s">var</span> newOption <span class="pl-k">=</span> option;
<span class="pl-k">return</span> newOption;
},
<span class="c1">//replace the statusCode before it's sent to the user</span>
<span class="nx">replaceResponseStatusCode</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">res</span><span class="p">,</span><span class="nx">statusCode</span><span class="p">){</span>
<span class="kd">var</span> <span class="nx">newStatusCode</span> <span class="o">=</span> <span class="nx">statusCode</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">newStatusCode</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//replace the request body</span>
<span class="pl-en">replaceRequestData</span>: <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">data</span>){
<span class="pl-k">return</span> data;
},
<span class="c1">//replace the httpHeader before it's sent to the user</span>
<span class="c1">//Here header == res.headers</span>
<span class="nx">replaceResponseHeader</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">res</span><span class="p">,</span><span class="nx">header</span><span class="p">){</span>
<span class="kd">var</span> <span class="nx">newHeader</span> <span class="o">=</span> <span class="nx">header</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">newHeader</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//replace the statusCode before it's sent to the user</span>
<span class="pl-en">replaceResponseStatusCode</span>: <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">res</span>,<span class="pl-vpf">statusCode</span>){
<span class="pl-s">var</span> newStatusCode <span class="pl-k">=</span> statusCode;
<span class="pl-k">return</span> newStatusCode;
},
<span class="c1">//replace the response from the server before it's sent to the user</span>
<span class="c1">//you may return either a Buffer or a string</span>
<span class="c1">//serverResData is a Buffer, you may get its content by calling serverResData.toString()</span>
<span class="nx">replaceServerResData</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">res</span><span class="p">,</span><span class="nx">serverResData</span><span class="p">){</span>
<span class="k">return</span> <span class="nx">serverResData</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//replace the httpHeader before it's sent to the user</span>
<span class="pl-c">//Here header == res.headers</span>
<span class="pl-en">replaceResponseHeader</span>: <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">res</span>,<span class="pl-vpf">header</span>){
<span class="pl-s">var</span> newHeader <span class="pl-k">=</span> header;
<span class="pl-k">return</span> newHeader;
},
<span class="c1">//add a pause before sending response to user</span>
<span class="nx">pauseBeforeSendingResponse</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">,</span><span class="nx">res</span><span class="p">){</span>
<span class="kd">var</span> <span class="nx">timeInMS</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> <span class="c1">//delay all requests for 1ms</span>
<span class="k">return</span> <span class="nx">timeInMS</span><span class="p">;</span>
<span class="p">},</span>
<span class="pl-c">//replace the response from the server before it's sent to the user</span>
<span class="pl-c">//you may return either a Buffer or a string</span>
<span class="pl-c">//serverResData is a Buffer, you may get its content by calling serverResData.toString()</span>
<span class="pl-en">replaceServerResData</span>: <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">res</span>,<span class="pl-vpf">serverResData</span>){
<span class="pl-k">return</span> serverResData;
},
<span class="c1">//should intercept https request, or it will be forwarded to real server</span>
<span class="nx">shouldInterceptHttpsReq</span> <span class="o">:</span><span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">){</span>
<span class="k">return</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">}</span>
<span class="pl-c">//add a pause before sending response to user</span>
<span class="pl-en">pauseBeforeSendingResponse</span> : <span class="pl-st">function</span>(<span class="pl-vpf">req</span>,<span class="pl-vpf">res</span>){
<span class="pl-s">var</span> timeInMS <span class="pl-k">=</span> <span class="pl-c1">1</span>; <span class="pl-c">//delay all requests for 1ms</span>
<span class="pl-k">return</span> timeInMS;
},
<span class="p">};</span>
<span class="pl-c">//should intercept https request, or it will be forwarded to real server</span>
<span class="pl-en">shouldInterceptHttpsReq</span> :<span class="pl-st">function</span>(<span class="pl-vpf">req</span>){
<span class="pl-k">return</span> <span class="pl-c1">false</span>;
}
};
</pre></div>
<h2>
<a name="using-https-features" class="anchor" href="#using-https-features"><span class="octicon octicon-link"></span></a>Using https features</h2>
<a id="using-https-features" class="anchor" href="#using-https-features" aria-hidden="true"><span class="octicon octicon-link"></span></a>Using https features</h2>
<h4>
<a name="step-1---install-openssl" class="anchor" href="#step-1---install-openssl"><span class="octicon octicon-link"></span></a>step 1 - install openssl</h4>
<a id="step-1---install-openssl" class="anchor" href="#step-1---install-openssl" aria-hidden="true"><span class="octicon octicon-link"></span></a>step 1 - install openssl</h4>
<ul>
<li>install <a href="http://wiki.openssl.org/index.php/Compilation_and_Installation">openssl</a> ,if you want to use HTTPS-related features. After that, the command <code>openssl</code> should be exposed to your shell</li>
</ul><h4>
<a name="step-2---generate-a-rootca-and-trust-it" class="anchor" href="#step-2---generate-a-rootca-and-trust-it"><span class="octicon octicon-link"></span></a>step 2 - generate a rootCA and trust it</h4>
</ul>
<h4>
<a id="step-2---generate-a-rootca-and-trust-it" class="anchor" href="#step-2---generate-a-rootca-and-trust-it" aria-hidden="true"><span class="octicon octicon-link"></span></a>step 2 - generate a rootCA and trust it</h4>
<ul>
<li>you should do this when it is the first time to start anyproxy</li>
<li>execute <code>anyproxy --root</code> ,follow the instructions on screen</li>
<li>you will see some tip like <em>rootCA generated at : /usr/lib...</em> . <code>cd</code> to that directory, add/trust the rootCA.crt file to your system keychain. In OSX, you may do that by open the *crt file directly</li>
</ul><h4>
<a name="step-3---start-a-https-proxy" class="anchor" href="#step-3---start-a-https-proxy"><span class="octicon octicon-link"></span></a>step 3 - start a https proxy</h4>
</ul>
<h4>
<a id="step-3---start-a-https-proxy" class="anchor" href="#step-3---start-a-https-proxy" aria-hidden="true"><span class="octicon octicon-link"></span></a>step 3 - start a https proxy</h4>
<ul>
<li><code>anyproxy --type https --host my.domain.com</code></li>
<li>the param <code>host</code> is required with https proxy and it should be kept exactly what it it when you config your browser. Otherwise, you may get some warning about security.</li>
</ul><h2>
<a name="others" class="anchor" href="#others"><span class="octicon octicon-link"></span></a>Others</h2>
</ul>
<h2>
<a id="others" class="anchor" href="#others" aria-hidden="true"><span class="octicon octicon-link"></span></a>Others</h2>
<h4>
<a name="work-as-a-module" class="anchor" href="#work-as-a-module"><span class="octicon octicon-link"></span></a>work as a module</h4>
<a id="work-as-a-module" class="anchor" href="#work-as-a-module" aria-hidden="true"><span class="octicon octicon-link"></span></a>work as a module</h4>
<pre><code>npm install anyproxy --save
</code></pre>
<div class="highlight highlight-javascript"><pre><span class="kd">var</span> <span class="nx">proxy</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s2">"anyproxy"</span><span class="p">);</span>
<span class="o">!</span><span class="nx">proxy</span><span class="p">.</span><span class="nx">isRootCAFileExists</span><span class="p">()</span> <span class="o">&amp;&amp;</span> <span class="nx">proxy</span><span class="p">.</span><span class="nx">generateRootCA</span><span class="p">();</span> <span class="c1">//please manually trust this rootCA</span>
<span class="k">new</span> <span class="nx">proxy</span><span class="p">.</span><span class="nx">proxyServer</span><span class="p">(</span><span class="s2">"http"</span><span class="p">,</span><span class="s2">"8001"</span><span class="p">,</span> <span class="s2">"localhost"</span> <span class="p">,</span><span class="s2">"path/to/rule/file.js"</span><span class="p">);</span>
<div class="highlight highlight-javascript"><pre><span class="pl-s">var</span> proxy <span class="pl-k">=</span> <span class="pl-s3">require</span>(<span class="pl-s1"><span class="pl-pds">"</span>anyproxy<span class="pl-pds">"</span></span>);
<span class="pl-k">!</span>proxy.isRootCAFileExists() <span class="pl-k">&amp;&amp;</span> proxy.generateRootCA(); <span class="pl-c">//please manually trust this rootCA</span>
<span class="pl-k">new</span> <span class="pl-en">proxy.proxyServer</span>(<span class="pl-s1"><span class="pl-pds">"</span>http<span class="pl-pds">"</span></span>,<span class="pl-s1"><span class="pl-pds">"</span>8001<span class="pl-pds">"</span></span>, <span class="pl-s1"><span class="pl-pds">"</span>localhost<span class="pl-pds">"</span></span> ,<span class="pl-s1"><span class="pl-pds">"</span>path/to/rule/file.js<span class="pl-pds">"</span></span>);
</pre></div>
<h4>
<a name="clear-all-the-temperary-certificates" class="anchor" href="#clear-all-the-temperary-certificates"><span class="octicon octicon-link"></span></a>clear all the temperary certificates</h4>
<a id="clear-all-the-temperary-certificates" class="anchor" href="#clear-all-the-temperary-certificates" aria-hidden="true"><span class="octicon octicon-link"></span></a>clear all the temperary certificates</h4>
<p><code>anyproxy --clear</code></p>
<h2>
<a name="contact" class="anchor" href="#contact"><span class="octicon octicon-link"></span></a>Contact</h2>
<a id="contact" class="anchor" href="#contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contact</h2>
<ul>
<li>Please feel free to raise any issue about this project, or give us some advice on this doc. :)</li>
</ul>
</section>
<footer>
<p>This project is maintained by <a href="https://github.com/alipay-ct-wd">alipay-ct-wd</a></p>
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Anyproxy maintained by <a href="https://github.com/alibaba">alibaba</a></p>
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
<script src="javascripts/scale.fix.js"></script>
</body>
</html>
</html>