forked from BlackArch/wordlistctl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wordlistctl.py
executable file
·349 lines (276 loc) · 12 KB
/
wordlistctl.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
#!/usr/bin/env python3
# -*- coding: latin-1 -*- ######################################################
# #
# wordlistctl - Fetch, install and search wordlist archives from websites. #
# #
# DESCRIPTION #
# Script to fetch, install, update and search wordlist archives from websites #
# offering wordlists with more than 6400 wordlists available. #
# #
# AUTHORS #
################################################################################
import argparse
import gzip
import tarfile
import time
import json
import os
import sys
from shutil import copyfileobj
from concurrent.futures import ThreadPoolExecutor
try:
import requests
from termcolor import colored
except Exception as ex:
print(f"[-] {ex}", file=sys.stderr)
sys.exit(-1)
# Internal Variables
__organization__: str = "blackarch.org"
__license__: str = "GPLv3"
__version__: str = "v0.9.3"
__project__: str = "wordlistctl"
__description__: str = "Fetch, install and search wordlist archives from websites."
WORDLIST_PATH: str = "/usr/share/wordlists"
REPOSITORY: dict = {}
RETRY_COUNT: int = 5
SEARCH_RESULTS: list = []
def error(string: str) -> None:
print(colored("[-]", "red", attrs=["bold"]) +
f" {string}", file=sys.stderr)
def warning(string: str) -> None:
print(colored("[!]", "yellow", attrs=["bold"]) + f" {string}")
def info(string: str) -> None:
print(colored("[*]", "blue", attrs=["bold"]) + f" {string}")
def success(string: str) -> None:
print(colored("[+]", "green", attrs=["bold"]) + f" {string}")
def banner() -> None:
print(colored(f"--==[ {__project__} by {__organization__} ]==--\n",
"red", attrs=["bold"]))
def load_repo() -> None:
global REPOSITORY
repofile: str = f"{os.path.dirname(os.path.realpath(__file__))}/repo.json"
try:
if not os.path.isfile(repofile):
raise FileNotFoundError("repository file not found")
REPOSITORY = json.load(open(repofile, 'r'))
except Exception as ex:
error(f"Error while loading repository: {str(ex)}")
exit(-1)
def to_readable_size(size: int) -> str:
units: dict = {0: 'B',
1: 'Kb',
2: 'Mb',
3: 'Gb',
4: 'Tb'}
i: int = 0
while size > 1000:
size = size / 1000
i += 1
return f"{size:.2f} {units[i]}"
def decompress_file(infilename: str) -> None:
filename: str = os.path.basename(infilename).lower()
try:
info(f"decompressing {infilename}")
if filename.endswith(".tar.gz"):
tar: tarfile.TarFile = tarfile.open(infilename)
tar.extractall(os.path.dirname(infilename))
elif filename.endswith(".gz"):
gf: gzip.GzipFile = gzip.GzipFile(infilename)
outfile = open(infilename.split(".gz")[0], "wb")
copyfileobj(gf, outfile)
outfile.close()
else:
warning(f"decompressing {infilename.split('.')[-1]} file type not supported")
return
success(f"decompressing {filename} completed")
os.remove(infilename)
except Exception as ex:
error(f"Unable to decompress {infilename}: {ex}")
def fetch_file(url: str, path: str, useragent: str, decompress: bool) -> None:
filename: str = os.path.basename(path)
partpath: str = f'{path}.part'
headers = {"User-Agent": useragent}
try:
if os.path.isfile(path):
warning(f"{filename} already exists -- skipping")
else:
if os.path.isfile(partpath):
info(f"resume downloading {filename} to {partpath}")
size: int = os.stat(partpath).st_size
headers["Range"] = f'bytes={size}-'
else:
info(f"downloading {filename} to {partpath}")
for _ in range(RETRY_COUNT):
rq: requests.Response = requests.get(url, stream=True, headers=headers)
if rq.status_code == 404:
raise FileNotFoundError("host returned 404")
elif rq.status_code not in [200, 206]:
time.sleep(5)
continue
mode: str = "ab" if rq.status_code == 206 else "wb"
with open(partpath, mode) as fp:
for data in rq.iter_content(chunk_size=1024):
fp.write(data)
os.rename(partpath, path)
success(f"downloading {filename} completed")
break
if decompress:
decompress_file(path)
except KeyboardInterrupt:
return
except Exception as ex:
error(f"Error while downloading {filename}: {ex}")
def check_dir(dir_name: str) -> None:
try:
if os.path.isdir(dir_name) is False:
info(f"creating directory {dir_name}")
os.mkdir(dir_name)
except Exception as ex:
error(f"unable to create directory: {str(ex)}")
exit(-1)
def fetch_func(parser: argparse.ArgumentParser) -> None:
global REPOSITORY
if parser.wordlist is None and parser.group is None and parser.fetch_term is None:
error("no wordlist specified")
return
if parser.workers > 25:
warning("Number of workers is too big, you might get banned.")
executer: ThreadPoolExecutor = ThreadPoolExecutor(parser.workers)
check_dir(parser.basedir)
for group in ["usernames", "passwords",
"discovery", "fuzzing", "misc"]:
check_dir(f"{parser.basedir}/{group}")
wordlists: list = []
if parser.wordlist is not None:
wordlists = [wordlist for wordlist in parser.wordlist]
if parser.fetch_term is not None:
for wordlist in REPOSITORY:
if parser.fetch_term in wordlist:
wordlists.append(wordlist)
if parser.group is not None:
for wordlist in REPOSITORY:
if REPOSITORY[wordlist]["group"] in parser.group:
wordlists.append(wordlist)
for wordlist in wordlists:
if wordlist not in REPOSITORY:
error(f"wordlist not found: {wordlist}")
continue
group: str = REPOSITORY[wordlist]["group"]
filename: str = REPOSITORY[wordlist]["url"].split('/')[-1]
path: str = f"{parser.basedir}/{group}/{filename}"
executer.submit(fetch_file, REPOSITORY[wordlist]["url"], path,
parser.useragent, parser.decompress)
executer.shutdown(wait=True)
def search_func(parser: argparse.ArgumentParser) -> None:
global REPOSITORY
global SEARCH_RESULTS
SEARCH_RESULTS = []
count: int = 0
search_term: str = parser.search_term
search_results: list = []
try:
if parser.local:
for root, _, files in os.walk(parser.basedir):
for f in files:
if f.lower().__contains__(search_term.lower()):
wordlist = os.path.join(root, f)
size = to_readable_size(os.path.getsize(wordlist))
print(f" > {wordlist} ({size})")
count += 1
else:
for wordlist in REPOSITORY:
if wordlist.lower().__contains__(search_term.lower()):
size = REPOSITORY[wordlist]["size"]
print(f" {count} > {wordlist} ({size})")
count += 1
SEARCH_RESULTS.append(wordlist)
if count == 0:
error("no wordlists found")
except Exception as ex:
error(ex)
def lst_func(parser: argparse.ArgumentParser) -> None:
global REPOSITORY
global SEARCH_RESULTS
SEARCH_RESULTS = []
success("available wordlists:")
print()
count: int = 0
for wordlist in REPOSITORY:
if parser.group is not None:
if REPOSITORY[wordlist]["group"] not in parser.group:
continue
size: str = REPOSITORY[wordlist]["size"]
print(f" {count} > {wordlist} ({size})")
SEARCH_RESULTS.append(wordlist)
count += 1
print()
def add_fetch_options(parser: argparse.ArgumentParser) -> None:
parser.add_argument("-d", "--decompress", action="store_true",
help="decompress and remove archive")
parser.add_argument("-w", "--workers", type=int, default=10,
help="download workers [default: %(default)s]")
parser.add_argument("-u", "--useragent", default=f"{__project__}/{__version__}",
help="parser user agent [default: %(default)s]")
parser.add_argument("-b", "--base-dir", default=f"{WORDLIST_PATH}", dest="basedir",
help="wordlists base directory [default: %(default)s]")
def main() -> int:
banner()
load_repo()
parser = argparse.ArgumentParser(prog=f"{__project__}",
description=f"{__description__}")
parser.add_argument("-v", "--version", action="version",
version=f"{__project__} {__version__}")
subparsers = parser.add_subparsers(dest="command")
fetch = subparsers.add_parser("fetch", help="fetch wordlists")
fetch.add_argument("-l", "--wordlist", nargs='+', dest="wordlist",
help="wordlist to fetch")
fetch.add_argument("-g", "--group", nargs='+', dest="group",
choices=["usernames", "passwords",
"discovery", "fuzzing", "misc"],
help="wordlist group to fetch")
fetch.add_argument("fetch_term", help="fetch string filter")
add_fetch_options(fetch)
fetch.set_defaults(func=fetch_func)
search = subparsers.add_parser("search", help="search wordlists")
search.add_argument("search_term", help="what to search")
search.add_argument("-l", "--local", action="store_true", default=False,
help="search local archives")
search.add_argument("-f", "--fetch", type=int, nargs='+', dest="indexes", metavar="INDEX",
help=("fetch the wordlists at the given indexes in the search "
"results, see fetch options for additional options"))
search_fetch = search.add_argument_group("fetch options")
add_fetch_options(search_fetch)
search.set_defaults(func=search_func)
lst = subparsers.add_parser("list", help="list wordlists")
lst.add_argument("-g", "--group",
choices=["usernames", "passwords",
"discovery", "fuzzing", "misc"],
help="group")
lst.add_argument("-f", "--fetch", type=int, nargs='+', dest="indexes", metavar="INDEX",
help=("fetch the wordlists at the given indexes in the list, "
"see fetch options for additiional options"))
lst_fetch = lst.add_argument_group("fetch options")
add_fetch_options(lst_fetch)
lst.set_defaults(func=lst_func)
results = parser.parse_args()
if sys.argv.__len__() == 1:
parser.print_help()
return
try:
results.func(results)
if results.command != "fetch" and results.indexes is not None:
setattr(results, "wordlist", [])
# arguments added so `fetch_func` does not complain
setattr(results, "group", None)
setattr(results, "fetch_term", None)
for i in results.indexes:
try:
results.wordlist.append(SEARCH_RESULTS[i])
except IndexError:
error(f"no wordlist with index: {i}")
fetch_func(results)
except Exception as ex:
error(f"Error while parsing arguments: {ex}")
if __name__ == "__main__":
sys.exit(main())