wlgen 1.2__py3-none-any.whl

wlgen/__init__.py

@@ -0,0 +1,54 @@
+def gen_wordlist(charset):
+    """Recursively build a wordlist in memory
+
+    Recursively builds a wordlist in memory, then returns complete list
+    which can be written to a file using either stdout or by specifying
+    an output file. The wordlist is being built bottom-up by combining
+    the current string position's character set with its previous one(s).
+
+    The input charset is assumed to be unique and sorted.
+    Example: {0: '123', 1: 'ABC', 2: '!"§ '}
+    """
+    subset = {}
+    if len(charset) == 1:
+        return charset[0]
+    else:
+        current_pos = charset[0]
+        for str_pos in range(1, len(charset)):
+            subset[str_pos - 1] = charset[str_pos]
+        previous_pos = gen_wordlist(subset)
+        wlist = [(i + j) for i in current_pos for j in previous_pos]
+        return wlist
+
+
+def gen_wordlist_iter(charset):
+    """Generates a wordlist using itertools.product"""
+    from itertools import product
+
+    charlst = [sorted(set(i)) for i in charset.values()]
+    return map("".join, product(*charlst))
+
+
+def gen_words(charset, positions=None, prev_iter=None):
+    """Recursively generate wordlist word for word
+
+    Recursively generates a wordlist word for word, based on a given
+    sets of characters. charset is a dictionary containing character
+    sets for each string position of the generated words.
+
+    The input charset is assumed to be unique and sorted.
+    Example: {0: '123', 1: 'ABC', 2: '!"§ '}
+    """
+    if prev_iter is None:
+        positions = [0 for i in charset]
+        cur_iter = 0
+    else:
+        cur_iter = prev_iter + 1
+    for idx, _ in enumerate(charset[cur_iter]):
+        positions[cur_iter] = idx
+        if cur_iter == len(charset) - 1:
+            yield "".join(
+                [charset[idx][val] for idx, val in enumerate(positions)]
+            )
+        else:
+            yield from gen_words(charset, positions, cur_iter)

wlgen/tests/__init__.py

@@ -0,0 +1,38 @@
+import filecmp
+import unittest
+import os
+import wlgen
+
+
+class wlgen_test(unittest.TestCase):
+    def setUp(self):
+        self.cset = {0: "123", 1: "ABC", 2: ' !"$'}
+        if os.name == "nt":
+            self.sample = "src/wlgen/tests/files/sample_mixed_dos"
+        else:
+            self.sample = "src/wlgen/tests/files/sample_mixed_unix"
+
+    def test_mixed_words(self):
+        tfilepath = "src/wlgen/tests/files/tmp"
+        with open(tfilepath, "w", encoding="utf-8") as tfile:
+            for word in wlgen.gen_words(self.cset):
+                tfile.write("%s\n" % word)
+        self.assertTrue(filecmp.cmp(tfilepath, self.sample))
+
+    def test_mixed_list(self):
+        tfilepath = "src/wlgen/tests/files/tmp"
+        with open(tfilepath, "w", encoding="utf-8") as tfile:
+            for word in wlgen.gen_wordlist(self.cset):
+                tfile.write("%s\n" % word)
+        self.assertTrue(filecmp.cmp(tfilepath, self.sample))
+
+    def test_mixed_iter(self):
+        tfilepath = "src/wlgen/tests/files/tmp"
+        with open(tfilepath, "w", encoding="utf-8") as tfile:
+            for word in wlgen.gen_wordlist_iter(self.cset):
+                tfile.write("%s\n" % word)
+        self.assertTrue(filecmp.cmp(tfilepath, self.sample))
+
+
+if __name__ == "__main__":
+    unittest.main()

wlgen/tests/files/sample_mixed_dos

@@ -0,0 +1,36 @@
+1A 
+1A!
+1A"
+1A$
+1B 
+1B!
+1B"
+1B$
+1C 
+1C!
+1C"
+1C$
+2A 
+2A!
+2A"
+2A$
+2B 
+2B!
+2B"
+2B$
+2C 
+2C!
+2C"
+2C$
+3A 
+3A!
+3A"
+3A$
+3B 
+3B!
+3B"
+3B$
+3C 
+3C!
+3C"
+3C$

wlgen/tests/files/sample_mixed_unix

@@ -0,0 +1,36 @@
+1A 
+1A!
+1A"
+1A$
+1B 
+1B!
+1B"
+1B$
+1C 
+1C!
+1C"
+1C$
+2A 
+2A!
+2A"
+2A$
+2B 
+2B!
+2B"
+2B$
+2C 
+2C!
+2C"
+2C$
+3A 
+3A!
+3A"
+3A$
+3B 
+3B!
+3B"
+3B$
+3C 
+3C!
+3C"
+3C$

wlgen/tests/files/tmp

@@ -0,0 +1,36 @@
+1A 
+1A!
+1A"
+1A$
+1B 
+1B!
+1B"
+1B$
+1C 
+1C!
+1C"
+1C$
+2A 
+2A!
+2A"
+2A$
+2B 
+2B!
+2B"
+2B$
+2C 
+2C!
+2C"
+2C$
+3A 
+3A!
+3A"
+3A$
+3B 
+3B!
+3B"
+3B$
+3C 
+3C!
+3C"
+3C$

wlgen-1.2.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: wlgen
+Version: 1.2
+Summary: A recursive wordlist generator written in python
+Author-email: tehw0lf <tehwolf@protonmail.com>
+License-File: LICENSE.txt
+Requires-Python: >=3.12
+Requires-Dist: ruff>=0.8.4
+Requires-Dist: setuptools>=75.6.0
+Description-Content-Type: text/markdown
+
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0a096cae2cdf489690eb6e0b4aa80c86)](https://app.codacy.com/app/tehw0lf/wlgen?utm_source=github.com&utm_medium=referral&utm_content=tehw0lf/wlgen&utm_campaign=Badge_Grade_Dashboard)
+[![Build Status](https://travis-ci.com/tehw0lf/wlgen.svg?branch=master)](https://travis-ci.com/tehw0lf/wlgen) [![codecov](https://codecov.io/gh/tehw0lf/wlgen/branch/master/graph/badge.svg)](https://codecov.io/gh/tehw0lf/wlgen)
+
+# Description
+
+A recursive wordlist generator written in Python.
+For each string position, custom character sets can be defined.
+
+# Prerequisites
+
+Python 3.x (developed on Python 3.6.4)
+
+# Instructions
+
+## Installation
+
+To install from GitHub:
+
+```
+git clone https://github.com/tehw0lf/wlgen.git
+cd wlgen
+python setup.py test (optional unit tests to ensure functionality)
+pip install .
+```
+
+To install from PyPI:
+
+```
+pip install wlgen
+```
+
+## Which function should I use?
+
+Currently there are three implementations to generate a wordlist.
+`gen_wordlist` builds the whole list in memory before writing it, `gen_words` is a generator that is memory efficient but slower.
+`gen_wordlist_iter` uses `itertools.product` to generate the wordlist, which is recommended for lists that are too large to be built by `gen_wordlist`.
+Both algorithms calculate the n-ary cartesian product of the input character sets.

wlgen-1.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+wlgen/__init__.py,sha256=hK9iJmcG2CZkTyJiD329mbVgHPVUdqa6qerHncs1Vg4,1961
+wlgen/tests/__init__.py,sha256=9DaJ97qqDMsRUuHYwULumACTCtro_xYWUWssEYx752Y,1336
+wlgen/tests/files/sample_mixed_dos,sha256=uLOptT7zup07sisc0TPOjjMpzRnQF7FCIFUdZmISfAc,144
+wlgen/tests/files/sample_mixed_unix,sha256=uLOptT7zup07sisc0TPOjjMpzRnQF7FCIFUdZmISfAc,144
+wlgen/tests/files/tmp,sha256=uLOptT7zup07sisc0TPOjjMpzRnQF7FCIFUdZmISfAc,144
+wlgen-1.2.dist-info/METADATA,sha256=V1gENboXjThvjMT0c0AfK3RHs1fzUISuOgKAll67qQM,1677
+wlgen-1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+wlgen-1.2.dist-info/entry_points.txt,sha256=fmA2JfIuvgdwP8woh4ieNpmfWE-J2iY41O4FXgZYXz8,37
+wlgen-1.2.dist-info/licenses/LICENSE.txt,sha256=PRTS5qlGXIqTHJXHvYvsUaxARnoQmdax_vS37P03snU,1070
+wlgen-1.2.dist-info/RECORD,,

wlgen-1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

wlgen-1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+wlgen = wlgen:main

wlgen-1.2.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Robert Weyres
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.