From 09402ecccff903d79121234fd2dcf88083194bf1 Mon Sep 17 00:00:00 2001 From: byt3bl33d3r Date: Sat, 22 Aug 2015 22:08:10 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cba1641..ff3f70b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Contact me at: - IRC on Freenode: #MITMf - Email: byt3bl33d3r@gmail.com -**Before submitting issues, please read the [CONTRIBUTING.md](CONTRIBUTING.md).** +**Before submitting issues, please read the relevant [section](https://github.com/byt3bl33d3r/MITMf/wiki/Reporting-a-bug) in the wiki .** Description ============ @@ -132,17 +132,7 @@ For a complete list of available options, just run ```python mitmf.py --help``` - **SMBAuth** : Evoke SMB challenge-response authentication attempts - **Upsidedownternet** : Flips images 180 degrees -How to install on Kali -====================== - -```apt-get install mitmf``` - -**Currently Kali has a very old version of MITMf in its repos, read the [Installation](#installation) section to get the latest version** - Installation ============ -- Clone this repository -- Run the ```setup.sh``` script -- On Kali, Debian (and possibly Ubuntu): ```apt-get install python-dev python-setuptools libpcap0.8-dev libnetfilter-queue-dev``` -- Run the command ```pip install --upgrade -r requirements.txt``` to install all Python dependencies +Please refer to the wiki for [installation instructions](https://github.com/byt3bl33d3r/MITMf/wiki/Installation) From 69f3e65ea9b0c1fe5e1141d3eef3ac80ce02ebf7 Mon Sep 17 00:00:00 2001 From: byt3bl33d3r Date: Sat, 22 Aug 2015 22:19:10 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++------------------ 1 file changed, 39 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6db95b6..7154da3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,34 +2,51 @@ Contributing ============ Hi! Thanks for taking the time and contributing to MITMf! Pull requests are always welcome! -Submitting Issues -================= -If you have *questions* regarding the framework please email me at byt3bl33d3r@gmail.com +Submitting Issues/Bug Reporting +============= -**Only submit issues if you find a bug in the latest version of the framework.** +Bug reporting is an essential part of any project since it let's people know whats broken! -When inevitably you do come across said *bug*, please open an issue and include at least the following in the description: +Before reading on, here's a list of cases where you **shouldn't** be reporting the bug: +- If you haven't installed MITMf using method described in the [installation](https://github.com/byt3bl33d3r/MITMf/wiki/Installation) intructions. (your fault!) +- If you're using and old version of the framework (and by old I mean anything else that **isn't** the current version on Github) +- If you found a bug in a packaged version of MITMf (e.g. Kali Repos), please file a bug report with the distros maintaner -- Full command string you used -- OS you're using -- Full error traceback, if any -- A packet capture if relevant +Lately, there has been a sharp **increase** in the volume of bug reports so in order for me to make any sense out of them and to quickly identify, reproduce and push a fix I do pretend a minimal amount of cooperation from the reporter! -Also, remember that Github markdown is your friend! +Writing the report +================== +**Before submitting a bug familiarize yourself with [Github markdown](https://help.github.com/articles/github-flavored-markdown/) and use it in your report!** -FAQ -=== -- **Is Windows supported?** -- Nope, don't think it will ever be +After that, open an issue ticket and please describe the bug in **detail!** MITMf has a lot of moving parts so the more detail the better! -- **Is OSX supported?** -- Initial compatibility has been introduced in 0.9.8, still needs some testing, find anything broken submit a PR or open an issue ticket! +Include in the report: +- The full command string you used +- The full output of: ```pip freeze``` +- The full output of MITMf in debug mode (append ```--log debug``` to the command you used) +- The OS you're using (distribution and architecture) +- The full error traceback (If any) +- If the bug resides in the way MITMf sends/receives packets, include a link to a pcap containing a full packet capture -- **I can't install package X because of an error!** -- Try installing the package via ```pip``` or your distro's package manager. This *isn't* a problem with MITMf. +Some good & bad examples +========================= -- **How do I install package X?** or **I get an ImportError when launching MITMf!** -- Please read the installation guide in the [readme](README.md). +- How to write a bug report -- **Dude, no documentation?** -- The docs are a work in progress at the moment, once the framework hits 1.0 I will push them to the wiki \ No newline at end of file +https://github.com/byt3bl33d3r/MITMf/issues/71 + +https://github.com/byt3bl33d3r/MITMf/issues/70 + +https://github.com/byt3bl33d3r/MITMf/issues/64 + +- How not to write a bug report + +https://github.com/byt3bl33d3r/MITMf/issues/35 <-- My personal favorite + +https://github.com/byt3bl33d3r/MITMf/issues/139 + +https://github.com/byt3bl33d3r/MITMf/issues/138 + +https://github.com/byt3bl33d3r/MITMf/issues/128 + +https://github.com/byt3bl33d3r/MITMf/issues/52