initial commit

LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2024 Andrey DarkCat09
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,46 @@
+# Intro
+
+Mitm-Archive consists of two parts:
+- [Addon for mitmproxy](https://git.dc09.ru/mitm-archive/addon) intercepting and saving (archiving) all HTTP responses, written in Python
+- [Server](https://git.dc09.ru/mitm-archive/server) giving exactly the same responses as in an archive for corresponding method+domain+port+path+query, written in Go
+
+"Archive" is an SQLite3 database and a directory storing headers and body for each archived response. See Format section for details.
+
+# User guide: addon
+
+## Installing mitmproxy
+First, check if there is a package provided by your Linux distro and its version is 10.x (NOT 9.x or less).  
+If there isn't, or you are using Windows, you can download official pre-built binaries: <https://mitmproxy.org/>.
+
+In case you are on a Linux distro without glibc or you don't trust official binaries (that's wise), use `pipx install mitmproxy`.
+Mitmproxy also contains native code, so the following packages are required: `base-devel` (includes `gcc`), `openssl-devel`, `libbsd-devel`, `python3-devel`.
+Note: these are package names in Void Linux repository; they may not match with yours.
+
+Native library inside `pylsqpack` depends on BSD's `sys/queue.h` which is provided by `libbsd-devel`, but located in `bsd/sys/queue.h`.
+The simpliest solution is:
+```bash
+$ sudo ln -s /usr/include/bsd/sys/queue.h /usr/include/sys/queue.h
+```
+
+Now you can run `pipx install mitmproxy`
+
+## Configuring HTTPS proxy
+Start `mitmproxy` or `mitmweb`. 1st is a CLI, 2nd provides web UI.
+
+I'll assume that you are using Firefox (or forks).
+FF supports importing certificates browser-wide and it's simplier to configure HTTP proxy than in Chromium.
+
+I recommend to create a separate browser profile, because next we'll import a TLS cert, and you must remember to remove it after creating an archive for security reasons.
+On Firefox, it's `about:profiles` in address bar > Create a New Profile.
+**It's just an advice;** if manually switching proxy off and removing mitmproxy cert is OK (you're sure you won't forget), then use your main profile,
+but close any active tabs that may produce extra requests that you don't want to be archived (e.g. messenger web clients like Element or Telegram Web).
+
+Now, point your browser to the proxy on `127.0.0.1:8080`.
+On Firefox, it's Settings > Network Settings (at the bottom) > Settings... > Manual proxy configuration > HTTP: `127.0.0.1`, Port: `8080` > Checkbox "Also use this proxy for HTTPS".
+
+Go to `http://mitm.it`, ignore warnings about an unencrypted connection (mitm.it is served by your local mitmproxy),
+click "Get mitmproxy-ca-cert.pem" below "Firefox".
+Import it: Settings > Privacy & Security > Certificates > View Certificates... > "Authorities" tab > Import... >
+Choose the downloaded cert > Checkbox "Trust this CA to identify web sites" > OK.
+
+## TODO