microProxy

microProxy is a http/https traffic interceptor which can help you debug with http/https based network traffic. This project is highly inspired by mitmproxy, but with some different architecture design.

For more in depth information about our architecture design, please refer to the wiki page.

Note: We are still in a very earyly stage and as a result, the interface will be changed.

Features:

• Proxy Mode:

  • SOCKS5 Proxy
  • Transparent Proxy(Linux Only)

• Protocol Support:

  • HTTP
  • HTTPS
  • HTTP2 (vis alpn, HTTP Upgrade is not supported)

• Flexible Viewer Design:

  • Viewer can connect to proxy with different machine.
  • Support multiple viewer connect to the same proxy instance.
  • Implement your own viewer by following the Viewer communication mechanism.

• Plugin System (still in very earyly stage):

  • Support external script to modify the Request/Response content.

Viewer Implementation List:

• Console Viwer: Simple console dump viewer.
• TUI Viwer: Terminal UI viewer which used gviewer.
• GUI Viewer: Graphic UI written in node.js and electron.

System Requirement:

microProxy can run in both Linux and MacOS.

Note: The transparent proxy mode can only work in Linux.

In order to let http2 protocol works properly, the openssl version 1.0.2.h (alpn support)is required.

Installation:

This project is not update to pypi yet. Therefore, to intall this project, please follow the following steps.

# Install basic dependencies.
pip install --process-dependency-links https://github.com/mike820324/microProxy/archive/v0.4.0.tar.gz#egg=microProxy

# Install viewer related dependencies.
pip install https://github.com/mike820324/microProxy/archive/v0.4.0.tar.gz#egg=microProxy[viewer]

QuickStart:

To run the proxy, simply type the following command.

# create server root ca
openssl req -new -x509 -days 365 -nodes -out ./cert.crt -keyout ./cert.key

# start proxy server
mpserver --viewer-channel tcp://127.0.0.1:5581 --cert-file ./cert.crt --key-file ./cert.key

# start tui-viewer
mptui --viewer-channel tcp://127.0.0.1:5581

# start console-viewer
mpdump --viewer-channel tcp://127.0.0.1:5581

For more information about command line options and configurations, please refer to the wiki page.

Troubleshooting:

• Installation failed in macosx:

Please followg this link https://cryptography.io/en/latest/installation/#building-cryptography-on-os-x to build on macosx.