wlgen 1.2__tar.gz

wlgen-1.2/.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    name: python
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Run ruff
+        run: uv run ruff check
+      - name: Run tests
+        run: uv run src/wlgen/tests/__init__.py
+      - name: Build
+        run: uv build
+      - name: Publish package distributions to PyPI
+        if: ${{ github.event_name == 'push' }}
+        uses: pypa/gh-action-pypi-publish@release/v1

wlgen-1.2/.gitignore

@@ -0,0 +1,103 @@
+# VSCode settings
+.vscode/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

wlgen-1.2/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.

wlgen-1.2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,37 @@
+[![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/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name="wlgen"
+version="1.2"
+description="A recursive wordlist generator written in python"
+readme = "README.md"
+authors = [
+    { name = "tehw0lf", email = "tehwolf@protonmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "ruff>=0.8.4",
+    "setuptools>=75.6.0",
+]
+
+[project.scripts]
+wlgen = "wlgen:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

wlgen-1.2/setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

wlgen-1.2/setup.py

@@ -0,0 +1,18 @@
+from setuptools import setup
+
+setup(
+    name="wlgen",
+    version="1.2",
+    description="A recursive wordlist generator written in python",
+    long_description="""A recursive wordlist generator written in Python.
+For each string position, custom character sets can be defined.
+Currently there are two 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.
+""",
+    url="https://github.com/tehw0lf/wlgen",
+    author="tehw0lf",
+    author_email="tehwolf@protonmail.com",
+    packages=["src/wlgen"],
+    zip_safe=False,
+)

wlgen-1.2/src/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-1.2/src/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-1.2/src/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-1.2/src/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-1.2/src/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/uv.lock

@@ -0,0 +1,51 @@
+version = 1
+requires-python = ">=3.12"
+
+[[package]]
+name = "ruff"
+version = "0.8.4"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/34/37/9c02181ef38d55b77d97c68b78e705fd14c0de0e5d085202bb2b52ce5be9/ruff-0.8.4.tar.gz", hash = "sha256:0d5f89f254836799af1615798caa5f80b7f935d7a670fad66c5007928e57ace8", size = 3402103 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/05/67/f480bf2f2723b2e49af38ed2be75ccdb2798fca7d56279b585c8f553aaab/ruff-0.8.4-py3-none-linux_armv6l.whl", hash = "sha256:58072f0c06080276804c6a4e21a9045a706584a958e644353603d36ca1eb8a60", size = 10546415 },
+    { url = "https://files.pythonhosted.org/packages/eb/7a/5aba20312c73f1ce61814e520d1920edf68ca3b9c507bd84d8546a8ecaa8/ruff-0.8.4-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:ffb60904651c00a1e0b8df594591770018a0f04587f7deeb3838344fe3adabac", size = 10346113 },
+    { url = "https://files.pythonhosted.org/packages/76/f4/c41de22b3728486f0aa95383a44c42657b2db4062f3234ca36fc8cf52d8b/ruff-0.8.4-py3-none-macosx_11_0_arm64.whl", hash = "sha256:6ddf5d654ac0d44389f6bf05cee4caeefc3132a64b58ea46738111d687352296", size = 9943564 },
+    { url = "https://files.pythonhosted.org/packages/0e/f0/afa0d2191af495ac82d4cbbfd7a94e3df6f62a04ca412033e073b871fc6d/ruff-0.8.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e248b1f0fa2749edd3350a2a342b67b43a2627434c059a063418e3d375cfe643", size = 10805522 },
+    { url = "https://files.pythonhosted.org/packages/12/57/5d1e9a0fd0c228e663894e8e3a8e7063e5ee90f8e8e60cf2085f362bfa1a/ruff-0.8.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:bf197b98ed86e417412ee3b6c893f44c8864f816451441483253d5ff22c0e81e", size = 10306763 },
+    { url = "https://files.pythonhosted.org/packages/04/df/f069fdb02e408be8aac6853583572a2873f87f866fe8515de65873caf6b8/ruff-0.8.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c41319b85faa3aadd4d30cb1cffdd9ac6b89704ff79f7664b853785b48eccdf3", size = 11359574 },
+    { url = "https://files.pythonhosted.org/packages/d3/04/37c27494cd02e4a8315680debfc6dfabcb97e597c07cce0044db1f9dfbe2/ruff-0.8.4-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:9f8402b7c4f96463f135e936d9ab77b65711fcd5d72e5d67597b543bbb43cf3f", size = 12094851 },
+    { url = "https://files.pythonhosted.org/packages/81/b1/c5d7fb68506cab9832d208d03ea4668da9a9887a4a392f4f328b1bf734ad/ruff-0.8.4-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e4e56b3baa9c23d324ead112a4fdf20db9a3f8f29eeabff1355114dd96014604", size = 11655539 },
+    { url = "https://files.pythonhosted.org/packages/ef/38/8f8f2c8898dc8a7a49bc340cf6f00226917f0f5cb489e37075bcb2ce3671/ruff-0.8.4-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:736272574e97157f7edbbb43b1d046125fce9e7d8d583d5d65d0c9bf2c15addf", size = 12912805 },
+    { url = "https://files.pythonhosted.org/packages/06/dd/fa6660c279f4eb320788876d0cff4ea18d9af7d9ed7216d7bd66877468d0/ruff-0.8.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e5fe710ab6061592521f902fca7ebcb9fabd27bc7c57c764298b1c1f15fff720", size = 11205976 },
+    { url = "https://files.pythonhosted.org/packages/a8/d7/de94cc89833b5de455750686c17c9e10f4e1ab7ccdc5521b8fe911d1477e/ruff-0.8.4-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:13e9ec6d6b55f6da412d59953d65d66e760d583dd3c1c72bf1f26435b5bfdbae", size = 10792039 },
+    { url = "https://files.pythonhosted.org/packages/6d/15/3e4906559248bdbb74854af684314608297a05b996062c9d72e0ef7c7097/ruff-0.8.4-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:97d9aefef725348ad77d6db98b726cfdb075a40b936c7984088804dfd38268a7", size = 10400088 },
+    { url = "https://files.pythonhosted.org/packages/a2/21/9ed4c0e8133cb4a87a18d470f534ad1a8a66d7bec493bcb8bda2d1a5d5be/ruff-0.8.4-py3-none-musllinux_1_2_i686.whl", hash = "sha256:ab78e33325a6f5374e04c2ab924a3367d69a0da36f8c9cb6b894a62017506111", size = 10900814 },
+    { url = "https://files.pythonhosted.org/packages/0d/5d/122a65a18955bd9da2616b69bc839351f8baf23b2805b543aa2f0aed72b5/ruff-0.8.4-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:8ef06f66f4a05c3ddbc9121a8b0cecccd92c5bf3dd43b5472ffe40b8ca10f0f8", size = 11268828 },
+    { url = "https://files.pythonhosted.org/packages/43/a9/1676ee9106995381e3d34bccac5bb28df70194167337ed4854c20f27c7ba/ruff-0.8.4-py3-none-win32.whl", hash = "sha256:552fb6d861320958ca5e15f28b20a3d071aa83b93caee33a87b471f99a6c0835", size = 8805621 },
+    { url = "https://files.pythonhosted.org/packages/10/98/ed6b56a30ee76771c193ff7ceeaf1d2acc98d33a1a27b8479cbdb5c17a23/ruff-0.8.4-py3-none-win_amd64.whl", hash = "sha256:f21a1143776f8656d7f364bd264a9d60f01b7f52243fbe90e7670c0dfe0cf65d", size = 9660086 },
+    { url = "https://files.pythonhosted.org/packages/13/9f/026e18ca7d7766783d779dae5e9c656746c6ede36ef73c6d934aaf4a6dec/ruff-0.8.4-py3-none-win_arm64.whl", hash = "sha256:9183dd615d8df50defa8b1d9a074053891ba39025cf5ae88e8bcb52edcc4bf08", size = 9074500 },
+]
+
+[[package]]
+name = "setuptools"
+version = "75.6.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/43/54/292f26c208734e9a7f067aea4a7e282c080750c4546559b58e2e45413ca0/setuptools-75.6.0.tar.gz", hash = "sha256:8199222558df7c86216af4f84c30e9b34a61d8ba19366cc914424cdbd28252f6", size = 1337429 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/55/21/47d163f615df1d30c094f6c8bbb353619274edccf0327b185cc2493c2c33/setuptools-75.6.0-py3-none-any.whl", hash = "sha256:ce74b49e8f7110f9bf04883b730f4765b774ef3ef28f722cce7c273d253aaf7d", size = 1224032 },
+]
+
+[[package]]
+name = "wlgen"
+version = "1.2"
+source = { editable = "." }
+dependencies = [
+    { name = "ruff" },
+    { name = "setuptools" },
+]
+
+[package.metadata]
+requires-dist = [
+    { name = "ruff", specifier = ">=0.8.4" },
+    { name = "setuptools", specifier = ">=75.6.0" },
+]