kpass-gen 0.2.1__tar.gz → 0.2.5__tar.gz

kpass_gen-0.2.5/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: kpass-gen
+Version: 0.2.5
+Summary: kpass is a Python toolkit for generating, ciphering and evaluating passwords with JSON, CSV and YAML export.
+Author-email: "Lucas Paulino Da Silva (~K')" <lucas.workps@gmail.com>
+License: MIT License
+        
+        Copyright (c) [year] [fullname]
+        
+        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.
+Project-URL: homepage, https://github.com/lucaspy-stack/kpass
+Project-URL: repository, https://github.com/lucaspy-stack/kpass
+Keywords: password,generator,leet,name-based,cybersecurity,pentest,automation,security,rich,csv,yaml,json,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: rich
+Dynamic: license-file
+
+# 🔐 kpass — Smart Password Generator & Evaluator
+
+<p align="center">
+  <img src="assets/kpass_icon.png" alt="kpass logo" width="100%"/>
+</p>
+
+**kpass** is a Python toolkit for **generating**, **ciphering** and **evaluating** passwords—designed for **educational**, **testing** and **automation** scenarios.
+
+---
+
+## ✨ Features
+
+* **Generate** hundreds or thousands of password combinations from:
+
+  * Full name
+  * Age
+  * Birth date
+* **Leet‑speak** substitutions like `A → 4`, `E → 3`, `S → $`
+* **Strength evaluation** based on:
+
+  * Length
+  * Digits
+  * Special characters
+  * Mixed case
+  * Numeric sequence patterns
+* **Export** automatically to `.json`, `.csv` or `.yaml` with a progress bar powered by **rich**
+
+---
+
+## ⚠️ Security Disclaimer
+
+This project **does not** produce secure passwords for production systems.
+It uses **predictable** inputs (names, dates) and should **not** be used for real authentication.
+
+---
+
+## 🎯 Use Cases
+
+* 🧠 **Cybersecurity Awareness**
+  Learn why personal info makes weak passwords.
+
+* 🧰 **Pentesting & Wordlist Creation**
+  Build custom dictionaries for ethical hacking.
+
+* 🧪 **Automation & Testing**
+  Generate dummy passwords for scripts, bots or sandbox environments.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install kpass-gen
+```
+
+> Requires Python 3.6+
+
+---
+
+## 🚀 Quick Start
+
+### 1. Generate Passwords
+
+```python
+from kpass import generator
+
+# Example: Johnny Silverhand (born 08/07/2000, age 50 in 2077)
+generator(
+    name="Johnny Silverhand",
+    age="50",
+    birth_date="08/07/2000",
+    file_type="json",         # optional: json, csv, yaml or yml
+    file_name="jsilverhand"   # optional: filename without extension
+)
+```
+
+### 2. Apply Leet Cipher
+
+```python
+from kpass import apply_ciphers
+
+# Example: Panam Palmer
+leet = apply_ciphers("Panam Palmer")
+print(leet)  # → "|D4|\\|4/\\/\\ |D41/\\/\\312"
+```
+
+### 3. Save Custom Password Lists
+
+```python
+from kpass import save_to_file
+
+# Example passwords inspired by Cyberpunk characters
+passwords = ["Chipp4020!", "AltAccount2077$", "RoughTrade37#"]
+scores    = [3, 5, 4]
+verdicts  = ["#mean", "#strong", "#good"]
+
+save_to_file(
+    passwords,
+    scores,
+    verdicts,
+    file_name="cyberpunk_list",
+    file_type="csv"    # outputs cyberpunk_list.csv
+)
+```
+
+### 4. Check Password Strength
+
+```python
+from kpass import verify
+
+# returns "#very_strong"
+print(verify("R0gueDr1ft!99"))
+
+# returns 6
+print(verify("R0gueDr1ft!99", want_verdict=False))
+```
+
+---
+
+## 🔧 API Reference
+
+| Function                                                          | Description                                                                 |
+| ----------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `generator(name, age, birth_date, file_type, file_name)`          | Generates permutations, evaluates strength, and saves to a file             |
+| `apply_ciphers(text)`                                             | Applies leet‑speak substitutions                                            |
+| `save_to_file(passwords, scores, verdicts, file_name, file_type)` | Exports password list + scores + verdicts with a progress bar               |
+| `verify(password, want_verdict=True)`                             | Evaluates strength; returns an `int` score or `str` verdict (`#good`, etc.) |
+| `check_sequences(password)`                                       | Detects ascending/descending numeric sequences                              |
+| `veredict(score)`                                                 | Maps numeric score to verdict string (`#weak`, `#strong`, etc.)             |
+
+---
+
+## ✅ Requirements
+
+* Python 3.6 or higher
+* [rich](https://pypi.org/project/rich/) for progress bars
+
+---
+
+## 📄 License
+
+MIT License — free to use, modify and share.

kpass_gen-0.2.5/README.md

@@ -0,0 +1,142 @@
+# 🔐 kpass — Smart Password Generator & Evaluator
+
+<p align="center">
+  <img src="assets/kpass_icon.png" alt="kpass logo" width="100%"/>
+</p>
+
+**kpass** is a Python toolkit for **generating**, **ciphering** and **evaluating** passwords—designed for **educational**, **testing** and **automation** scenarios.
+
+---
+
+## ✨ Features
+
+* **Generate** hundreds or thousands of password combinations from:
+
+  * Full name
+  * Age
+  * Birth date
+* **Leet‑speak** substitutions like `A → 4`, `E → 3`, `S → $`
+* **Strength evaluation** based on:
+
+  * Length
+  * Digits
+  * Special characters
+  * Mixed case
+  * Numeric sequence patterns
+* **Export** automatically to `.json`, `.csv` or `.yaml` with a progress bar powered by **rich**
+
+---
+
+## ⚠️ Security Disclaimer
+
+This project **does not** produce secure passwords for production systems.
+It uses **predictable** inputs (names, dates) and should **not** be used for real authentication.
+
+---
+
+## 🎯 Use Cases
+
+* 🧠 **Cybersecurity Awareness**
+  Learn why personal info makes weak passwords.
+
+* 🧰 **Pentesting & Wordlist Creation**
+  Build custom dictionaries for ethical hacking.
+
+* 🧪 **Automation & Testing**
+  Generate dummy passwords for scripts, bots or sandbox environments.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install kpass-gen
+```
+
+> Requires Python 3.6+
+
+---
+
+## 🚀 Quick Start
+
+### 1. Generate Passwords
+
+```python
+from kpass import generator
+
+# Example: Johnny Silverhand (born 08/07/2000, age 50 in 2077)
+generator(
+    name="Johnny Silverhand",
+    age="50",
+    birth_date="08/07/2000",
+    file_type="json",         # optional: json, csv, yaml or yml
+    file_name="jsilverhand"   # optional: filename without extension
+)
+```
+
+### 2. Apply Leet Cipher
+
+```python
+from kpass import apply_ciphers
+
+# Example: Panam Palmer
+leet = apply_ciphers("Panam Palmer")
+print(leet)  # → "|D4|\\|4/\\/\\ |D41/\\/\\312"
+```
+
+### 3. Save Custom Password Lists
+
+```python
+from kpass import save_to_file
+
+# Example passwords inspired by Cyberpunk characters
+passwords = ["Chipp4020!", "AltAccount2077$", "RoughTrade37#"]
+scores    = [3, 5, 4]
+verdicts  = ["#mean", "#strong", "#good"]
+
+save_to_file(
+    passwords,
+    scores,
+    verdicts,
+    file_name="cyberpunk_list",
+    file_type="csv"    # outputs cyberpunk_list.csv
+)
+```
+
+### 4. Check Password Strength
+
+```python
+from kpass import verify
+
+# returns "#very_strong"
+print(verify("R0gueDr1ft!99"))
+
+# returns 6
+print(verify("R0gueDr1ft!99", want_verdict=False))
+```
+
+---
+
+## 🔧 API Reference
+
+| Function                                                          | Description                                                                 |
+| ----------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `generator(name, age, birth_date, file_type, file_name)`          | Generates permutations, evaluates strength, and saves to a file             |
+| `apply_ciphers(text)`                                             | Applies leet‑speak substitutions                                            |
+| `save_to_file(passwords, scores, verdicts, file_name, file_type)` | Exports password list + scores + verdicts with a progress bar               |
+| `verify(password, want_verdict=True)`                             | Evaluates strength; returns an `int` score or `str` verdict (`#good`, etc.) |
+| `check_sequences(password)`                                       | Detects ascending/descending numeric sequences                              |
+| `veredict(score)`                                                 | Maps numeric score to verdict string (`#weak`, `#strong`, etc.)             |
+
+---
+
+## ✅ Requirements
+
+* Python 3.6 or higher
+* [rich](https://pypi.org/project/rich/) for progress bars
+
+---
+
+## 📄 License
+
+MIT License — free to use, modify and share.

{kpass_gen-0.2.1 → kpass_gen-0.2.5}/kpass/__init__.py

@@ -1,19 +1,19 @@
 from .main import (
     generator,
-    save_to_txt,
-    aplly_ciphers,
+    save_to_file,
+    apply_ciphers,
     check_sequences,
     veredict,
     verify,
 )
 
-__version__ = "0.2.1"
+__version__ = "0.2.5"
 
 __all__ = [
     "generator",
-    "save_to_txt",
-    "aplly_ciphers",
+    "save_to_file",
+    "apply_ciphers",
     "check_sequences",
     "veredict",
     "verify",
-]
+]

kpass_gen-0.2.5/kpass/main.py

@@ -0,0 +1,239 @@
+import itertools
+from rich.progress import Progress, BarColumn, TextColumn, TimeElapsedColumn
+import re
+import string
+import json
+from math import perm
+from datetime import datetime
+from pathlib import Path
+
+# -----------------------------------------------------------------------------
+# Ciphers dictionary to replace letters with leetspeak equivalents
+# Each key is a character and the corresponding value is its cipher substitution
+# -----------------------------------------------------------------------------
+
+ciphers = {
+    "A": "4", "a": "4", "Á": "4", "á": "4", "@": "4",
+    "B": "8", "b": "8",
+    "C": "(", "c": "(",
+    "D": "[)", "d": "[)",
+    "E": "3", "e": "3", "É": "3", "é": "3", "&": "3",
+    "F": "#", "f": "#",
+    "G": "6", "g": "6",
+    "H": "#", "h": "#",
+    "I": "1", "i": "1", "Í": "1", "í": "1", "!": "1",
+    "J": "_|", "j": "_|",
+    "K": "|<", "k": "|<",
+    "L": "1", "l": "1",
+    "M": "/\\/\\", "m": "/\\/\\",
+    "N": "|\\|", "n": "|\\|",
+    "O": "0", "o": "0", "Ó": "0", "ó": "0",
+    "P": "|D", "p": "|D",
+    "Q": "0_", "q": "0_",
+    "R": "12", "r": "12",
+    "S": "$", "s": "$", "Š": "$", "š": "$",
+    "T": "7", "t": "7",
+    "U": "(_)", "u": "(_)",
+    "V": "\\/", "v": "\\/",
+    "W": "\\/\\/", "w": "\\/\\/",
+    "X": "%", "x": "%",
+    "Y": "`/", "y": "`/",
+    "Z": "2", "z": "2"
+}
+
+# -----------------------------------------------------------------------------
+# Function: apply_ciphers
+# Description:
+#   Transforms input text by replacing each character according to the ciphers dict
+# Parameters:
+#   text (str): The original text to be ciphered
+# Returns:
+#   str: The transformed text with cipher substitutions
+# -----------------------------------------------------------------------------
+
+def apply_ciphers(text: str) -> str:
+    return ''.join(ciphers.get(char, char) for char in text)
+
+# -----------------------------------------------------------------------------
+# Utility: write with progress bar
+# -----------------------------------------------------------------------------
+
+def _write_with_progress(write_fn, items):
+    with Progress(
+        TextColumn("[progress.description]{task.description}"),
+        BarColumn(),
+        TimeElapsedColumn(),
+    ) as progress:
+        task = progress.add_task("[cyan]Saving passwords...", total=len(items))
+        for item in items:
+            write_fn(item)
+            progress.update(task, advance=1)
+
+# -----------------------------------------------------------------------------
+# Function: save_to_file
+# Description:
+#   Writes a list of passwords, scores, and verdicts to a file with progress
+# Parameters:
+#   passwords (list[str]): List of password strings
+#   scores (list[int]): Corresponding strength scores
+#   verdicts (list[str]): Corresponding verdict strings
+#   file_name (str): Output filename without extension
+#   file_type (str): Extension (json, csv, yaml, yml)
+# Returns:
+#   None
+# -----------------------------------------------------------------------------
+
+def save_to_file(
+    passwords: list[str],
+    scores: list[int],
+    verdicts: list[str],
+    file_name: str = "pass_generated",
+    file_type: str = "json"
+) -> None:
+    extension = file_type.lstrip('.')
+    path = Path(f"{file_name}.{extension}")
+    path.write_text("", encoding="utf-8-sig")  # limpa conteúdo existente
+
+    def writer_json(item):
+        pwd, score, verdict = item
+        return json.dumps({"password": pwd, "score": score, "veredict": verdict}, indent=4, ensure_ascii=False) + "\n"
+
+    def writer_csv(item):
+        pwd, score, verdict = item
+        return (
+            f'"password","{pwd}",\n'
+            f'"score","{score}",\n'
+            f'"veredict","{verdict}"\n\\n'
+        )
+
+    def writer_yaml(item):
+        pwd, score, verdict = item
+        return (
+            f'"password": "{pwd}"\n'
+            f'"score": "{score}"\n'
+            f'"veredict": "{verdict}"\n\\n'
+        )
+
+    if extension == "json":
+        writer = writer_json
+    elif extension == "csv":
+        writer = writer_csv
+    elif extension in ("yaml", "yml"):
+        writer = writer_yaml
+    else:
+        raise ValueError(f"Unsupported file type: {file_type}")
+
+    items = list(zip(passwords, scores, verdicts))
+    with Progress(
+        TextColumn("[progress.description]{task.description}"),
+        BarColumn(),
+        TimeElapsedColumn(),
+    ) as progress:
+        task = progress.add_task("[cyan]Saving passwords...", total=len(items))
+        with path.open("a", encoding="utf-8-sig") as file:
+            for item in items:
+                file.write(writer(item))
+                progress.update(task, advance=1)
+
+# -----------------------------------------------------------------------------
+# Function: base_files_architecture (no changes needed)
+# -----------------------------------------------------------------------------
+def base_files_architecture(password, score, verdict, file_type):
+    if file_type.lower() in ("json", ".json"):
+        return json.dumps({"password": password, "score": str(score), "veredict": verdict}, indent=4, ensure_ascii=False) + "\n\n"
+    if file_type.lower() in ("csv", ".csv"):
+        return (
+            f'"password","{password}",\n'
+            f'"score","{score}\n"'
+            f'"veredict","{verdict}"\n'
+        ) + "\n"
+    if file_type.lower() in ("yaml", ".yaml", "yml", ".yml"):
+        return (
+            f'"password": "{password}"\n'
+            f'"score": "{score}"\n'
+            f'"veredict": "{verdict}"\n'
+        ) + "\n"
+
+# -----------------------------------------------------------------------------
+# Function: generator
+# Description:
+#   Builds possible password permutations based on user info and ciphers,
+#   filters by length, evaluates strength, and saves them
+# -----------------------------------------------------------------------------
+
+def generator(
+    name: str,
+    age: str,
+    birth_date: str,
+    file_type: str = "json",
+    file_name: str = "pass_generated"
+) -> None:
+    dt = datetime.strptime(birth_date, "%d/%m/%Y")
+    day, month, year = dt.strftime("%d"), dt.strftime("m"), dt.strftime("Y")
+    name_tiny = name.lower().replace(" ", "")
+    parts = name.split()
+    first = parts[0]
+    middle = "".join(parts[1:-1]) if len(parts) > 2 else ""
+    last = parts[-1] if len(parts) > 1 else ""
+    age_reversed = age[::-1]
+    bases = [
+        name_tiny, name.upper().replace(" ", ""), first, middle, last,
+        day, month, year, age, age_reversed,
+        apply_ciphers(name_tiny), apply_ciphers(first), apply_ciphers(last)
+    ]
+    bases = list({b for b in bases if b.strip()})
+    possible_passwords = set()
+    total = sum(perm(len(bases), r) for r in range(2, 5))
+    with Progress(
+        TextColumn("[cyan]Generating passwords..."),
+        BarColumn(),
+        TimeElapsedColumn(),
+    ) as progress:
+        task = progress.add_task("passwords", total=total)
+        for length in range(2, 5):
+            for combo in itertools.permutations(bases, length):
+                pwd = "".join(combo)
+                if 6 <= len(pwd) <= 18:
+                    possible_passwords.add(pwd)
+                progress.update(task, advance=1)
+    scored = [(pwd, verify(pwd, False), veredict(verify(pwd, False))) for pwd in possible_passwords]
+    passwords, scores, verdicts = zip(*scored)
+    save_to_file(list(passwords), list(scores), list(verdicts), file_name, file_type)
+
+# -----------------------------------------------------------------------------
+# Sequence, verdict, and verify unchanged (except typo fix)
+# -----------------------------------------------------------------------------
+
+def check_sequences(password: str) -> bool:
+    digits = [int(c) for c in password if c.isdigit()]
+    for i in range(len(digits) - 2):
+        if digits[i] + 1 == digits[i+1] == digits[i+2] - 1:
+            return True
+        if digits[i] - 1 == digits[i+1] == digits[i+2] + 1:
+            return True
+    return False
+
+def veredict(score: int) -> str:
+    levels = [
+        "#very_weak", "#weak", "#weak", "#mean", "#good", "#strong", "#very_strong"
+    ]
+    return levels[score] if 0 <= score < len(levels) else "#unknown"
+
+def verify(
+    password: str,
+    want_verdict: bool = True,
+) -> int | str:
+    strength = 0
+    if len(password) >= 8:
+        strength += 1
+        if re.search(r'\d', password):
+            strength += 1
+            if any(c in string.punctuation for c in password):
+                strength += 1
+                if any(c.isupper() for c in password):
+                    strength += 1
+                if any(c.islower() for c in password):
+                    strength += 1
+                if not check_sequences(password):
+                    strength += 1
+    return veredict(strength) if want_verdict else strength