Skip to content

Commit f8cbb06

Browse files
authored
update readme
1 parent bb21413 commit f8cbb06

File tree

1 file changed

+21
-27
lines changed

1 file changed

+21
-27
lines changed

README.md

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<!--te-->
1616
# About
1717

18-
BruteShark is a Network Forensic Analysis Tool (NFAT) that performs deep processing and inspection of network traffic (mainly PCAP files). It includes: password extracting, building a network map, reconstruct TCP sessions, extract hashes of encrypted passwords and even convert them to a Hashcat format in order to perform an offline Brute Force attack.
18+
BruteShark is a Network Forensic Analysis Tool (NFAT) that performs deep processing and inspection of network traffic (mainly PCAP files, but it also capable of directly live capturing from a network interface). It includes: password extracting, building a network map, reconstruct TCP sessions, extract hashes of encrypted passwords and even convert them to a Hashcat format in order to perform an offline Brute Force attack.
1919

2020
The main goal of the project is to provide solution to security researchers and network administrators with the task of network traffic analysis while they try to identify weaknesses that can be used by a potential attacker to gain access to critical points on the network.
2121

@@ -109,17 +109,26 @@ Print the help menu:
109109
BruteSharkCli 1.0.0.0
110110
Copyright c 2018
111111

112-
-d, --input-dir The input directory containing the files to be processed.
112+
-d, --input-dir The input directory containing the files to be processed.
113113

114-
-i, --input The files to be processed seperated by comma
114+
-i, --input The files to be processed seperated by comma
115115

116-
-m, --modules The modules to be separterd by comma: Credentials, FileExtracting, NetworkMap
116+
-m, --modules The modules to be separterd by comma: Credentials, FileExtracting, NetworkMap
117117

118-
-o, --output Output direcorty for the results files.
118+
-o, --output Output direcorty for the results files.
119119

120-
--help Display this help screen.
120+
--help Display this help screen.
121+
122+
-p, --promiscious Configures whether to start live capture on normal or promiscious mode (sometimes needs super
123+
user privileges to to do so),use along with -l for live catpure.
124+
125+
-l, --live-capture Caputre and process packets live from a network interface.
126+
127+
-f, --filter add a capture bpf filter to the live traffic processing.
128+
129+
--help Display this help screen.
121130

122-
--version Display version information.
131+
--version Display version information.
123132

124133
Get credentials from all files in a directory (passwords and hashes will be printed to stdout):
125134

@@ -147,30 +156,15 @@ Get credentials from all files in a directory (passwords and hashes will be prin
147156

148157
Get credentials from all files in a directory and also export extracted hashes (if found) to a Hashcat input files.
149158

150-
BruteSharkCli.exe -m Credentials -d C:\Users\King\Desktop\Pcap_Examples -o C:\Users\King\Desktop\Results
159+
BruteSharkCli -m Credentials -d C:\Users\King\Desktop\Pcap_Examples -o C:\Users\King\Desktop\Results
151160

152161
Run multiple modules on all files in a directory and also export all the results.
153162

154-
BruteSharkCli.exe -m Credentials,NetworkMap,FileExtracting -d C:\Users\King\Desktop\Pcap_Examples -o C:\Users\King\Desktop\Results
155-
156-
##### Shell Mode
157-
Just type
158-
159-
BruteSharkCli.exe
163+
BruteSharkCli -m Credentials,NetworkMap,FileExtracting -d C:\Users\King\Desktop\Pcap_Examples -o C:\Users\King\Desktop\Results
164+
165+
Sniff an interface named Wi-Fi, run multiple modules and also export all the results to a directory (the results will be exported only when stoping the sniffer by hitting CTRL + C).
160166

161-
And then navigate using the following commands.
162-
| Keyword | Description |
163-
|-------------------|-----------------------------------------------------------------------------------------|
164-
| help | Print help menu |
165-
| exit | Exit CLI |
166-
| add-file | Add file to analyze. Usage: add-file FILE-PATH |
167-
| start | Start analyzing |
168-
| show-passwords | Print passwords. |
169-
| show-modules | Print modules. |
170-
| show-hashes | Print Hashes |
171-
| show-networkmap | Prints the network map as a json string. Usage: show-networkmap |
172-
| export-hashes | Export all Hashes to Hascat format input files. Usage: export-hashes OUTPUT-DIRECTORY |
173-
| export-networkmap | Export network map to a json file for neo4j. Usage: export-networkmap OUTPUT-FILE |
167+
BruteSharkCli -l Wi-Fi -m Credentials,NetworkMap,FileExtracting,DNS -o C:\Users\King\Desktop\Test Export
174168

175169
# Architecture
176170
All BruteShark projects are implemented using `.Net Core` and `.Net Standard` for modern and cross platform support.

0 commit comments

Comments
 (0)