Skip to content

Commit 3c8ae2d

Browse files
committed
chore: add more info on readme
1 parent 6f4c8c1 commit 3c8ae2d

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,40 @@
22

33
Here's the mitmproxy setup I use when working on various researches, pentests, and bug bounties.
44

5+
Personally I have not been using Burp for many years unless I really had a reason to. Reasons include:
6+
7+
1. Free of cost.
8+
2. Convenient to debug when performing security researches or playing CTFs.
9+
3. Convenient to add plugins or features if you can write a code in python.
10+
4. Viewing and editing via web interface. Simply install at your home, VPS, or work. extremely lightweight.
11+
5. [Chaining proxies](https://docs.mitmproxy.org/stable/concepts-modes/#upstream-proxy) is very convenient.
12+
513
Contributions are welcome! Feel free to share any interesting addons or views you have.
614

15+
You may also want to look the official [Addons Examples](https://github.com/mitmproxy/mitmproxy/tree/main/examples/addons) for boilerplate codes.
16+
717
## Background
818

919
### Previous Work
1020

1121
Long ago, I wrote a blog post of my [mitmproxy + OpenVPN setup](https://blog.flatt.tech/entry/mitmproxy) at my former workplace.
12-
Then I later published another [mitmproxy + OpenVPN setup](https://gist.github.com/stypr/abe9ef83556759847c063ae9389fa0ae) to show the current setup both in English and Korean.
22+
Later, I published another [mitmproxy + OpenVPN setup](https://gist.github.com/stypr/abe9ef83556759847c063ae9389fa0ae) to share my existing setup both in English and Korean.
1323

1424
### What's New?
1525

1626
This time introduces a few more changes:
1727

1828
#### Directory Structure Updates
1929

20-
- **`views/*`**: Automates decryption of specific request/response data to enhance data visualization.
21-
- **`addons/*`**: Acts as plugins to perform actions on send/receive HTTP data
30+
Directories are divided for convenient coding, hot-reloading on subdirectories are included
31+
32+
- **`views`**: Automates manipulation of specific request/response data to enhance data visualization.
33+
- **`addons*`**: Acts as plugins to perform actions on send/receive HTTP data
2234

2335
#### Transition to WireGuard Setup
2436

2537
- Completely Replaced OpenVPN with WireGuard for improved functionality. (Ref. [WireGuard Mode](https://mitmproxy.org/posts/wireguard-mode/))
26-
- WireGuard mode supports DNS and UDP packet manipulation, unlike the transparent proxy, which cannot pass UDP packets when the upstream SOCKS5 proxy only supports TCP.
38+
- WireGuard mode supports DNS and UDP packet inspection / manipulation unlike the transparent proxy.
2739
- WireGuard setups are significantly simpler compared to traditional OpenVPN configurations.
2840
- Some limitations remain, such as partial handling of HTTP2/HTTP3 traffics, but there seems not much problem of just using old HTTPS.
2941

0 commit comments

Comments
 (0)