Docs and examples to top level

1 files changed, 44 insertions, 0 deletions

diff --git a/examples/flowbasic b/examples/flowbasic
new file mode 100644
index 00000000..4a87b86a
--- /dev/null
+++ b/examples/flowbasic
@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+"""
+    This example shows how to build a proxy based on mitmproxy's Flow
+    primitives.
+
+    Heads Up: In the majority of cases, you want to use inline scripts.
+
+    Note that request and response messages are not automatically replied to,
+    so we need to implement handlers to do this.
+"""
+from mitmproxy import flow
+from mitmproxy.proxy import ProxyServer, ProxyConfig
+
+
+class MyMaster(flow.FlowMaster):
+    def run(self):
+        try:
+            flow.FlowMaster.run(self)
+        except KeyboardInterrupt:
+            self.shutdown()
+
+    def handle_request(self, f):
+        f = flow.FlowMaster.handle_request(self, f)
+        if f:
+            f.reply()
+        return f
+
+    def handle_response(self, f):
+        f = flow.FlowMaster.handle_response(self, f)
+        if f:
+            f.reply()
+        print(f)
+        return f
+
+
+config = ProxyConfig(
+    port=8080,
+    # use ~/.mitmproxy/mitmproxy-ca.pem as default CA file.
+    cadir="~/.mitmproxy/"
+)
+state = flow.State()
+server = ProxyServer(config)
+m = MyMaster(server, state)
+m.run()