STRLCPY/wifi_db

Update README and help
r4ulcl committed 1 year ago

f4be89e2

1 parent 56006924

Revision indexing in progress... (symbol navigation in revisions will be accurate after indexed)

■ ■ ■ ■ ■ ■

README.md

		skipped 20 lines
21	21
22	22		### Manual installation
23	23
24		-	#### Debian bases
	24	+	#### Debian based systems (Ubuntu, Kali, Parrot, etc.)
25	25
26	26		Dependencies:
27	27
	28	+	- python3
	29	+	- python3-pip
28	30		- tshark
29	31		- hcxtools
30		-
31	32
32	33		``` bash
33	34		sudo apt install tshark
	35	+	sudo apt install python3 python3-pip
34	36
35	37		git clone https://github.com/ZerBea/hcxtools.git
36	38		cd hcxtools
		skipped 6 lines
43	45		Installation
44	46
45	47		``` bash
46		-	sudo apt install python3-pip
47	48		git clone https://github.com/r4ulcl/wifi_db
48	49		cd wifi_db
49	50		pip3 install -r requirements.txt
		skipped 3 lines
53	54
54	55		Dependencies:
55	56
	57	+	- python3
	58	+	- python3-pip
56	59		- tshark
57	60		- hcxtools
58	61
59	62
60	63		``` bash
61	64		sudo pacman -S wireshark-qt
	65	+	sudo pacman -S python-pip python
62	66
63	67		git clone https://github.com/ZerBea/hcxtools.git
64	68		cd hcxtools
		skipped 5 lines
70	74		Installation
71	75
72	76		``` bash
73		-	sudo pacman -S python-pip
74	77		git clone https://github.com/r4ulcl/wifi_db
75	78		cd wifi_db
76	79		pip3 install -r requirements.txt
		skipped 23 lines
100	103		docker run -t -v $PWD/db.SQLITE:/db.SQLITE -v $CAPTURESFOLDER:/captures/ r4ulcl/wifi_db
101	104		```
102	105
103		-	- '-v $PWD/db.SQLITE:/db.SQLITE': To save de output in current folder db.SQLITE file
104		-	- '-v $CAPTURESFOLDER:/captures/': To share the folder with the captures with the docker
	106	+	- `-v $PWD/db.SQLITE:/db.SQLITE`: To save de output in current folder db.SQLITE file
	107	+	- `-v $CAPTURESFOLDER:/captures/`: To share the folder with the captures with the docker
	108	+
	109	+	![usage docker](./resources/usagedocker.png)
	110	+
105	111
106	112
107	113		### Create the SQLite database using manual installation
		skipped 9 lines
117	123		``` bash
118	124		python3 wifi_db.py -d database.sqlite scan-folder
119	125		```
	126	+
	127	+	![usage](./resources/usage.png)
	128	+
120	129
121	130		### Open database
122	131
123	132		The database can be open with:
124	133		- [sqlitebrowser](https://sqlitebrowser.org/)
	134	+
	135	+
	136	+	![sqlitebrowser](./resources/sqlitebrowser.png)
	137	+
	138	+	Below is an example of a ProbeClientsConnected table.
	139	+
	140	+	![sqlitebrowser-probes](./resources/sqlitebrowser-probes.png)
125	141
126	142
127	143		### Optional arguments
		skipped 105 lines

resources/sqlitebrowser-probes.png
resources/sqlitebrowser.png
resources/usage.png

■ ■ ■ ■ ■ ■

wifi_db.py

		skipped 57 lines
58	58		" database (default name: %(default)s)")
59	59
60	60		parser.add_argument("capture", type=str, nargs='+',
61		-	help="capture file (.csv, .kismet.csv, "
62		-	".kismet.netxml, .log.csv), \
63		-	if no extension add all")
	61	+	help="capture folder or file with extensions .csv, "
	62	+	".kismet.csv, .kismet.netxml, or .log.csv. If no "
	63	+	"extension is provided, all types will be added. "
	64	+	"Additionally, this option supports the use of "
	65	+	"wildcards (*) to select multiple files or folders.")
64	66		args = parser.parse_args()
65	67
66	68		# vars
		skipped 149 lines

Update README and help