aliasr 1.0.0__tar.gz

aliasr-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mojo
+
+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.

aliasr-1.0.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: aliasr
+Version: 1.0.0
+Summary: Modern TUI launcher for pentest commands
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual>=6.2.0
+Requires-Dist: textual-autocomplete>=4.0.5
+Requires-Dist: pykeepass>=4.0.0
+Requires-Dist: pyperclip>=1.9.0
+Dynamic: license-file
+
+# Aliasr
+
+[![PyPI version](https://img.shields.io/pypi/v/aliasr?v1.0.0)](https://pypi.org/project/aliasr/)
+![Python](https://img.shields.io/badge/python-3.11+-blue.svg)
+![License](https://img.shields.io/github/license/Mojo8898/aliasr)
+
+**Aliasr** is a modern, feature-rich TUI launcher for penetration testing commands inspired by [Arsenal](https://github.com/Orange-Cyberdefense/arsenal), but with significantly improved functionality.
+
+## Features
+
+Some of the largest improvements Aliasr implements include:
+
+- [x] Significantly expanded tmux integration.
+- [x] Cheat variations that allow for different authentication methods to be built into a single parameter.
+- [x] Automatic parameter population based on history and other sources.
+- [x] Secure KeePass integration for managing credentials.
+
+## Install
+
+```bash
+uv tool install git+https://github.com/Mojo8898/aliasr
+pipx install git+https://github.com/Mojo8898/aliasr
+```
+
+I also highly recommend adding the following line to your `~/.zshrc`:
+
+```bash
+alias a=aliasr
+```
+
+If you intend on leveraging the extended tmux integration aliasr offers (which you should), also add the following to your `~/.tmux.conf`:
+
+```bash
+# Add to ~/.tmux.conf
+bind U split-window "aliasr send -pp"
+bind K split-window "aliasr -e send -pp"
+
+# Recommended tmux settings
+set -s escape-time 0
+set -s focus-events on
+set -s default-terminal "tmux-256color"
+set -as terminal-overrides ",*:Tc"
+```
+
+You can now use the `prefix+K` hotkey to open aliasr below the current pane and send commands automatically to the pane that was focused previously. `prefix+U` does the same but without also sending the enter key to execute the command.
+
+## Usage
+
+```bash
+$ aliasr -h
+usage: aliasr [-h] [-e] {audit,send,scan,list,clear} ...
+
+aliasr - Modern TUI launcher for pentest commands
+
+positional arguments:
+  {audit,send,scan,list,clear}
+    audit               Audit cheatsheets and configs
+    send                Modify how commands are sent
+    scan                Auto-populate globals from a target IP
+    list                List globals or credentials
+    clear               Clear session data
+
+options:
+  -h, --help            show this help message and exit
+  -e, --exec            Execute the command immediately
+```
+
+**Note:** *Almost* all hotkeys can be found in the footer of the application when running.
+
+## Configuration
+
+Aliasr allows you to configure pretty much everything. Refer to the built-in `config.toml` found [here](./aliasr/data/config.toml) to see what configurations options are available.
+
+Create your own config in `~/.config/aliasr/config.toml` to edit existing configurations and changes will automatically be merged at runtime.
+
+**Note:** Paths set in the environment variables `XDG_CONFIG_HOME` and `ALIASR_CONFIG` will be used instead if set.
+
+## Cheats
+
+A detailed reference guide on writing cheats can be found [here](./aliasr/data/wiki/Cheats.md).
+
+## Contributing
+
+Contributions are welcome but make sure you if you are contributing to cheats, you follow guidelines in [Cheats Reference](./aliasr/data/wiki/Cheats.md). Also feel free to open an issue if you want to add other features.
+
+Detailed development setup instructions can be found in the [official Textual documentation](https://textual.textualize.io/guide/devtools/).
+
+## Acknowledgments
+
+- Inspired by [Arsenal](https://github.com/Orange-Cyberdefense/arsenal) by Orange Cyberdefense
+- Built with [Textual](https://github.com/Textualize/textual)
+- Special thanks to all members of my HackTheBox team [S4U2SelfEnjoyers](https://app.hackthebox.com/teams/7014?tab=members) for beta testing and providing essential feedback.

aliasr-1.0.0/README.md

@@ -0,0 +1,92 @@
+# Aliasr
+
+[![PyPI version](https://img.shields.io/pypi/v/aliasr?v1.0.0)](https://pypi.org/project/aliasr/)
+![Python](https://img.shields.io/badge/python-3.11+-blue.svg)
+![License](https://img.shields.io/github/license/Mojo8898/aliasr)
+
+**Aliasr** is a modern, feature-rich TUI launcher for penetration testing commands inspired by [Arsenal](https://github.com/Orange-Cyberdefense/arsenal), but with significantly improved functionality.
+
+## Features
+
+Some of the largest improvements Aliasr implements include:
+
+- [x] Significantly expanded tmux integration.
+- [x] Cheat variations that allow for different authentication methods to be built into a single parameter.
+- [x] Automatic parameter population based on history and other sources.
+- [x] Secure KeePass integration for managing credentials.
+
+## Install
+
+```bash
+uv tool install git+https://github.com/Mojo8898/aliasr
+pipx install git+https://github.com/Mojo8898/aliasr
+```
+
+I also highly recommend adding the following line to your `~/.zshrc`:
+
+```bash
+alias a=aliasr
+```
+
+If you intend on leveraging the extended tmux integration aliasr offers (which you should), also add the following to your `~/.tmux.conf`:
+
+```bash
+# Add to ~/.tmux.conf
+bind U split-window "aliasr send -pp"
+bind K split-window "aliasr -e send -pp"
+
+# Recommended tmux settings
+set -s escape-time 0
+set -s focus-events on
+set -s default-terminal "tmux-256color"
+set -as terminal-overrides ",*:Tc"
+```
+
+You can now use the `prefix+K` hotkey to open aliasr below the current pane and send commands automatically to the pane that was focused previously. `prefix+U` does the same but without also sending the enter key to execute the command.
+
+## Usage
+
+```bash
+$ aliasr -h
+usage: aliasr [-h] [-e] {audit,send,scan,list,clear} ...
+
+aliasr - Modern TUI launcher for pentest commands
+
+positional arguments:
+  {audit,send,scan,list,clear}
+    audit               Audit cheatsheets and configs
+    send                Modify how commands are sent
+    scan                Auto-populate globals from a target IP
+    list                List globals or credentials
+    clear               Clear session data
+
+options:
+  -h, --help            show this help message and exit
+  -e, --exec            Execute the command immediately
+```
+
+**Note:** *Almost* all hotkeys can be found in the footer of the application when running.
+
+## Configuration
+
+Aliasr allows you to configure pretty much everything. Refer to the built-in `config.toml` found [here](./aliasr/data/config.toml) to see what configurations options are available.
+
+Create your own config in `~/.config/aliasr/config.toml` to edit existing configurations and changes will automatically be merged at runtime.
+
+**Note:** Paths set in the environment variables `XDG_CONFIG_HOME` and `ALIASR_CONFIG` will be used instead if set.
+
+## Cheats
+
+A detailed reference guide on writing cheats can be found [here](./aliasr/data/wiki/Cheats.md).
+
+## Contributing
+
+Contributions are welcome but make sure you if you are contributing to cheats, you follow guidelines in [Cheats Reference](./aliasr/data/wiki/Cheats.md). Also feel free to open an issue if you want to add other features.
+
+Detailed development setup instructions can be found in the [official Textual documentation](https://textual.textualize.io/guide/devtools/).
+
+## Acknowledgments
+
+- Inspired by [Arsenal](https://github.com/Orange-Cyberdefense/arsenal) by Orange Cyberdefense
+- Built with [Textual](https://github.com/Textualize/textual)
+- Special thanks to all members of my HackTheBox team [S4U2SelfEnjoyers](https://app.hackthebox.com/teams/7014?tab=members) for beta testing and providing essential feedback.

aliasr-1.0.0/aliasr/__main__.py

@@ -0,0 +1,163 @@
+import os
+import argparse
+
+
+def _parser() -> argparse.ArgumentParser:
+    p = argparse.ArgumentParser(
+        prog="aliasr",
+        description="aliasr - Modern TUI launcher for pentest commands",
+    )
+    p.add_argument(
+        "-e",
+        "--exec",
+        dest="execute",
+        action="store_true",
+        help="Execute the command immediately",
+    )
+
+    sub = p.add_subparsers(dest="cmd")
+
+    # ---------- Audit ----------
+
+    audit = sub.add_parser("audit", help="Audit cheatsheets and configs")
+    audit.add_argument(
+        "-l", "--list-all", action="store_true", help="List individual cheats"
+    )
+    audit_sub = audit.add_subparsers(dest="audit_cmd", help="Audit specific components")
+    audit_sub.add_parser("refs", help="Audit parameter references in cheatsheets")
+    audit_sub.add_parser("vars", help="Audit variations (variations.toml)")
+    audit_sub.add_parser("conf", help="Audit configuration (config.toml)")
+
+    # ---------- Send ----------
+
+    send = sub.add_parser("send", help="Modify how commands are sent")
+    send_mx = send.add_mutually_exclusive_group()
+    send_mx.add_argument("-c", "--copy", action="store_true", help="Copy to clipboard")
+    send_mx.add_argument("-o", "--outfile", metavar="FILE", help="Write to file")
+    send_mx.add_argument(
+        "-p", "--pane", metavar="PANE", nargs="?", const="0", help="Send to tmux pane"
+    )
+    send_mx.add_argument(
+        "-pp", "--previous-pane", action="store_true", help="Send to previous tmux pane"
+    )
+
+    # ---------- Scan ----------
+    
+    scan = sub.add_parser("scan", help="Auto-populate globals from a target IP")
+    scan.add_argument(
+        "ip",
+        metavar="IP",
+        help="Target IP address to scan"
+    )
+    scan.add_argument(
+        "-u", "--user",
+        metavar="USER",
+        help="Username for authenticated scan"
+    )
+    
+    # Authentication options (mutually exclusive)
+    auth_group = scan.add_mutually_exclusive_group()
+    auth_group.add_argument(
+        "-p", "--password",
+        metavar="PASSWORD",
+        help="Password for authenticated scan"
+    )
+    auth_group.add_argument(
+        "-H", "--hash",
+        metavar="HASH",
+        help="NT hash for authenticated scan"
+    )
+    auth_group.add_argument(
+        "-k", "--kerberos",
+        action="store_true",
+        help="Use Kerberos authentication (ccache)"
+    )
+
+    # ---------- List ----------
+
+    list_cmd = sub.add_parser("list", help="List globals or credentials")
+    list_sub = list_cmd.add_subparsers(dest="list_cmd", required=True, help="What to list")
+    list_sub.add_parser("globals", help="List all globals and their current values")
+    list_sub.add_parser("creds", help="List all saved credentials")
+    list_sub.add_parser("all", help="List both globals and credentials")
+
+    # ---------- Clear ----------
+
+    clear = sub.add_parser(
+        "clear", help="Clear session data"
+    )
+    clear_sub = clear.add_subparsers(dest="clear_cmd", required=True)
+    clear_sub.add_parser(
+        "cache", help="Clear cheats cache (mandatory if cheats have been updated)"
+    )
+    clear_sub.add_parser("globals", help="Clear globals")
+    clear_sub.add_parser("creds", help="Clear credentials")
+    clear_sub.add_parser("all", help="Clear everything")
+
+    p.set_defaults(copy=False, outfile=None, pane=None, previous_pane=False)
+    return p
+
+
+def main() -> int:
+    args = _parser().parse_args()
+
+    if args.cmd == "clear":
+        from aliasr.core.bootstrap import clear_flags
+
+        clear_cache = args.clear_cmd in ("cache", "all")
+        clear_globals = args.clear_cmd in ("globals", "all")
+        clear_creds = args.clear_cmd in ("creds", "all")
+        clear_flags(clear_cache, clear_globals, clear_creds)
+        return 0
+
+    if args.cmd == "audit":
+        from aliasr.audit import run_audit_cli
+
+        return run_audit_cli(args.list_all, args.audit_cmd)
+    
+    if args.cmd == "list":
+        from aliasr.core.list import run_list
+        return run_list(args.list_cmd)
+    
+    if args.cmd == "scan":
+        from aliasr.core.scan import run_scan_cli
+        return run_scan_cli(
+            args.ip, 
+            args.user, 
+            args.password,
+            getattr(args, 'hash', None),
+            getattr(args, 'kerberos', False)
+        )
+
+    os.environ.setdefault("COLORTERM", "truecolor")
+
+    from aliasr.core.bootstrap import launch_app
+
+    app = launch_app(
+        execute=args.execute,
+        pane=args.pane,
+        previous=args.previous_pane,
+    )
+
+    app.run()
+
+    # ---------- Delivery ----------
+
+    cmd = getattr(app, "pending_inject", None)
+    if not cmd:
+        return 0
+
+    from aliasr.core.inject import inject
+
+    return inject(
+        cmd=cmd,
+        copy=args.copy,
+        outfile=args.outfile,
+        using_tmux=app.in_tmux,
+        execute=app.execute_cmd,
+        pane_index=app.tmux_target_pane,
+    )
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

aliasr-1.0.0/aliasr/app.py

@@ -0,0 +1,101 @@
+from importlib.resources import files
+from pathlib import Path
+from threading import Thread
+
+from textual.app import App
+from textual.binding import Binding
+from textual.widgets import Input
+
+from aliasr.core.config import kb_root, THEME
+from aliasr.tui.main_screen.globals_grid import GlobalsGrid
+from aliasr.tui.main_screen.main_screen import MainScreen
+from aliasr.tui.theme import BUNDLED_THEMES
+
+
+class Aliasr(App[None]):
+    CSS_PATH = Path(files("aliasr") / "tui" / "main.tcss")
+
+    BINDINGS = [
+        Binding(
+            "escape",
+            "safe_exit",
+        ),
+        Binding(
+            "ctrl+q",
+            "safe_exit",
+            priority=True,
+        ),
+        Binding(
+            kb_root("quit"),
+            "safe_exit",
+            "Quit",
+            priority=True,
+        ),
+        Binding(
+            kb_root("copy_input"),
+            "copy_input",
+            "Copy",
+            priority=True,
+            tooltip="Copy the value of the currently focused input.",
+        ),
+    ]
+
+    def __init__(
+        self,
+        *,
+        in_tmux: bool = False,
+        execute_cmd: bool = False,
+        tmux_current_pane: str | None = None,
+        tmux_target_pane: str | None = None,
+    ) -> None:
+        super().__init__()
+        self.animation_level = "none"
+        self.pending_inject: str | None = None
+        self.in_tmux = in_tmux
+        self.execute_cmd = execute_cmd
+        self.tmux_current_pane = tmux_current_pane
+        self.tmux_target_pane = tmux_target_pane
+        self.globals: dict[str, str] = {}
+        self.cheats: list = []
+
+    # ---------- UI ----------
+
+    def on_mount(self) -> None:
+        theme = BUNDLED_THEMES.get(THEME.name)
+        if theme:
+            self.register_theme(theme)
+        try:
+            self.theme = THEME.name
+        except Exception:
+            self.register_theme(BUNDLED_THEMES["aliasr"])
+            self.theme = "aliasr"
+
+        def _background_load():
+            from aliasr.core.creds import load_creds
+            from aliasr.core.variations import load_variations
+
+            load_creds()
+            load_variations()
+
+        Thread(target=_background_load, daemon=True).start()
+
+    # ---------- Actions ----------
+
+    def action_copy_input(self) -> None:
+        w = self.focused
+        if isinstance(w, Input):
+            from aliasr.core.inject import copy_to_clipboard
+
+            if w.value:
+                copy_to_clipboard(w.value or "")
+                self.notify("Copied Input Value!", severity="success", timeout=2.5)
+
+    def action_safe_exit(self) -> None:
+        for grid in self.query(GlobalsGrid):
+            grid.commit_all_modified()
+        self.exit()
+
+    # ---------- Public API ----------
+
+    def get_default_screen(self) -> MainScreen:
+        return MainScreen()