Skip to content

Commit

Permalink
Fixed minor spelling mistakes and added bold for file names
Browse files Browse the repository at this point in the history
  • Loading branch information
fwalloe committed Dec 8, 2018
1 parent cfe0e3a commit 7253e03
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,37 @@ KrackPlus seeks to handle dependencies and parse the output from two scripts mad
Users can run a scan or an attack with a single command – all dependencies are handled in the background.

## Contributors ##
Fredrik Walløe

Lars Magnus Trinborgholen

Lars Kristian Mæhlum
Fredrik Walløe

## Usage ###

Run KrackPlus.py to see a usage guide.

## Files ##
KrackPlus.py: graphical user interface for KrackPlus.
*KrackPlus.py:* graphical user interface for KrackPlus.

prepareKrackPlus.sh: installs dependencies needed to run KrackPlus.
*prepareKrackPlus.sh:* installs dependencies needed to run KrackPlus.

prepareClientScan.sh: installs prerequisites necessary to run set up a network that check whether devices that connect to it are vulnerable.
*prepareClientScan.sh:* installs prerequisites necessary to run set up a network that check whether devices that connect to it are vulnerable.

prepareClientAttack.sh. handles prerequsites necessary to run the attack script.
*prepareClientAttack.sh:* handles prerequsites necessary to run the attack script.

reportTemplate.tex: a LaTeX template used to generate reports after vulnerability scans. Scan results are pushed to this file, which is compiled into a .pdf.
*reportTemplate.tex:* a LaTeX template used to generate reports after vulnerability scans. Scan results are pushed to this file, which is compiled into a .pdf.

restoreClientWifi.sh: attempts to restore client WIFI after an attack or scan.
*restoreClientWifi.sh:* attempts to restore client WIFI after an attack or scan.

parser.py: parses output from either scan or attack and displays appropriate output to user.
*parser.py:* parses output from either scan or attack and displays appropriate output to user.

networkCredentials.txt: file that hold credentials for the vulnerability scan network.
*networkCredentials.txt:* file that hold credentials for the vulnerability scan network.

dependenciesClientScan: contains a list of dependencies. Used by the prepareClient* scripts.
*dependenciesClientScan:* contains a list of dependencies. Used by the prepareClient* scripts.

killProcesses: kills processes that run in the background (dnsmasq and, optionally, sslstrip).
*killProcesses.sh:* kills processes that run in the background (dnsmasq and, optionally, sslstrip).

generatePDF.py: creates a PDF report that contains scan results.
*generatePDF.py:* creates a PDF report that contains scan results.

displayInterfaces.sh: finds and displays the names of the user's NICs as part of the usage guide.
*displayInterfaces.sh:* finds and displays the names of the user's NICs as part of the usage guide.

0 comments on commit 7253e03

Please sign in to comment.