https://github.com/kikyous/mitmfile.py

Define and load mitmproxy config easy
https://github.com/kikyous/mitmfile.py

mitmproxy mitmproxy-addons

Last synced: 3 days ago
JSON representation

Define and load mitmproxy config easy

• Host: GitHub
• URL: https://github.com/kikyous/mitmfile.py
• Owner: kikyous
• License: mit
• Created: 2022-05-11T02:26:32.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-24T09:18:15.000Z (over 2 years ago)
• Last Synced: 2025-01-01T04:03:16.226Z (24 days ago)
• Topics: mitmproxy, mitmproxy-addons
• Language: Python
• Homepage:
• Size: 19.5 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Define and load mitmproxy config easy

> As a web developer, I need different [mitmproxy](https://github.com/mitmproxy/mitmproxy) config (map_local, map_remote ...) per project,

with this plugin, I can define and load mitmproxy configs from .mitmproxy/Mitmfile in my project dir, use simple syntax which easy to write and read.

## Mitmfile sample

projectA/.mitmproxy/Mitmfile

```ini

## filter static request

view_filter !~u /static/

## report api

map_local |/api/report/17/timeline|.mitmproxy/timeline.json

map_local |/api/report/17$|.mitmproxy/report.json

map_remote |/api/report/17/performance/rank|http://qa.example.com/rank.json

## sleep request 4 seconds (load sleep.py in global config)

sleep |/api/report/17/timeline|4

## lives

map_local |/api/courses/.+/activities/lives|.mitmproxy/lives.json

```

* when you run `mitmproxy` in projectA, It will load .mitmproxy/Mitmfile and apply all definded options.

* you can use (almost) all mitmproxy config options in Mitmfile with `key value` format.

* comments start with '#'

## Edit

there is a `mitmfile.edit` command, which launch EDITOR to edit loaded Mitmfile file, you can do some modify, when editor exited, Mitmfile is automatic reloaded.

## Requirements

python 3.9+, mitmproxy 8.1.0+

## Recomend config

Automatic load this plugin

```shell

$ cat ~/.mitmproxy/config.yaml

scripts:

  - ~/.mitmproxy/scripts/mitmfile.py

```

Bind "," to edit Mitmfile

```shell

$ cat ~/.mitmproxy/keys.yaml

-

  key: ","

  cmd: mitmfile.edit

```

Set `.mitmproxy` dir to global git ignore via `core.excludesfile`

```

$ cat ~/.gitignore_global

.DS_Store

.mitmproxy

```

## Tip

if you want edit Mitmfile in a external editor, it will not able to reload automatically, in this case you can use a file listener such as nodemon to reload the program.

```bash

nodemon --signal SIGHUP --exec mitmdump --watch .mitmproxy/Mitmfile

```