bdsh 0.2.1__tar.gz

bdsh-0.2.1/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: bdsh
+Version: 0.2.1
+Summary: BadOS Dynamic Shell
+Author-email: Logan Dhillon <dev@logandhillon.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# BadOS Dynamic Shell (bdsh)
+
+Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.github.io/bdsh).
+
+## Quick Install
+
+Run the following command:
+
+```sh
+curl -O https://raw.githubusercontent.com/badtechnologies/bdsh/main/install.py
+python3 install.py
+```
+
+After completing setup, bdsh should be good to go!
+
+
+## Installation (Manual)
+
+1. **Download the latest release**
+
+    Or, you can directly download `install.py` from the [repo](https://github.com/badtechnologies/bdsh).
+
+> [!TIP]
+> The only file needed to create a bdsh installation is `install.py`.<br>
+> Running `install.py` generates, downloads, or installs everything else.
+
+2. **Setup bdsh:**
+
+    ```sh
+    python3 install.py
+    ```
+
+    Follow the on-screen instructions.
+
+    Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh` to launch the interactive shell.
+
+3. **Launch bdsh:**
+
+    ```sh
+    bdsh
+    ```
+
+> [!NOTE]
+> This may change depending on how you created your launcher scripts.

bdsh-0.2.1/README.md

@@ -0,0 +1,44 @@
+# BadOS Dynamic Shell (bdsh)
+
+Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.github.io/bdsh).
+
+## Quick Install
+
+Run the following command:
+
+```sh
+curl -O https://raw.githubusercontent.com/badtechnologies/bdsh/main/install.py
+python3 install.py
+```
+
+After completing setup, bdsh should be good to go!
+
+
+## Installation (Manual)
+
+1. **Download the latest release**
+
+    Or, you can directly download `install.py` from the [repo](https://github.com/badtechnologies/bdsh).
+
+> [!TIP]
+> The only file needed to create a bdsh installation is `install.py`.<br>
+> Running `install.py` generates, downloads, or installs everything else.
+
+2. **Setup bdsh:**
+
+    ```sh
+    python3 install.py
+    ```
+
+    Follow the on-screen instructions.
+
+    Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh` to launch the interactive shell.
+
+3. **Launch bdsh:**
+
+    ```sh
+    bdsh
+    ```
+
+> [!NOTE]
+> This may change depending on how you created your launcher scripts.

bdsh-0.2.1/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bdsh"
+authors = [
+    { name = "Logan Dhillon", email = "dev@logandhillon.com" }
+]
+dynamic = ["version"]
+description = "BadOS Dynamic Shell"
+requires-python = ">=3.10"
+readme = "README.md"
+
+[project.scripts]
+bdsh = "bdsh.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "bdsh.__version__.__version__"}

bdsh-0.2.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bdsh-0.2.1/src/bdsh/__init__.py

@@ -0,0 +1,3 @@
+from .__version__ import __version__
+
+NL = '\r\n'

bdsh-0.2.1/src/bdsh/__main__.py

@@ -0,0 +1,15 @@
+# BadOS Dynamic Shell (bdsh)
+
+import os
+import sys
+
+from bdsh.shell import Shell
+
+def main():
+    _cwd = os.getcwd()
+    bdsh = Shell(sys.stdout, sys.stdin)
+    bdsh.start()
+    os.chdir(_cwd)
+
+if __name__ == "__main__":
+    main()

bdsh-0.2.1/src/bdsh/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

bdsh-0.2.1/src/bdsh/command/__init__.py

@@ -0,0 +1,32 @@
+from abc import ABC, abstractmethod
+from collections.abc import Callable
+from typing import List, Any, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from bdsh.shell import Shell
+
+
+class Command(ABC):
+    def __init__(self, shell: Shell):
+        self.shell = shell
+
+    @abstractmethod
+    def execute(self, args: List[str]):
+        pass
+
+    @abstractmethod
+    def help(self) -> str:
+        pass
+
+
+class AnonymousCommand(Command):
+    def __init__(self, shell: Shell, execute: Callable[[List[str]], Any], help_msg: str):
+        super().__init__(shell)
+        self.help_msg = help_msg
+        self.execute = execute
+
+    def execute(self, args: List[str]):
+        self.execute(args)
+
+    def help(self) -> str:
+        return self.help_msg

bdsh-0.2.1/src/bdsh/command/commands.py

@@ -0,0 +1,110 @@
+import os
+from typing import List, TYPE_CHECKING, Dict
+
+from bdsh import NL
+from bdsh.command import Command, AnonymousCommand
+
+if TYPE_CHECKING:
+    from bdsh.shell import Shell
+
+
+class HelpCommand(Command):
+    def execute(self, args: List[str]):
+        if len(args) > 1:
+            subcommand = self.shell.commands.get(args[1])
+            if isinstance(subcommand, Command):
+                msg = subcommand.help()
+
+                if not msg:
+                    self.shell.print(f"help: {args[1]} does not have a manual or help message")
+                else:
+                    self.shell.print(f"{args[1]}: {msg}")
+            else:
+                raise TypeError(f"{args[1]} is not a valid command")
+        else:
+            self.shell.print(f"bdsh commands:{NL}" + '\t'.join(self.shell.commands.keys()))
+
+    def help(self) -> str:
+        return "lists all commands, or displays the help message for individual commands"
+
+
+class ListDirectoryCommand(Command):
+    def execute(self, args: List[str]):
+        try:
+            path = self.shell.get_path(args[1]) if len(args) > 1 else self.shell.path
+            items = os.listdir(path)
+            self.shell.print('\t'.join([item + '/' if os.path.isdir(os.path.join(path, item)) else item for item in items]))
+        except FileNotFoundError:
+            raise FileNotFoundError(f"{args[1]}: does not exist")
+
+    def help(self) -> str:
+        return "lists the contents of a directory"
+
+
+class DefineCommand(Command):
+    def execute(self, args: List[str]):
+        if '-h' in args or '--help' in args:
+            self.shell.print(
+                f"usage: def <keyword> <definition>{NL}binds <keyword> to <definition>{NL}executing <keyword> will execute <definition>")
+            return
+
+        if len(args) < 3:
+            raise ValueError("missing params (at least 3)")
+
+        definition = " ".join(args[2:])
+
+        if args[1] == definition:
+            raise SyntaxError("keyword cannot be the same as the definition")
+
+        self.shell.definitions[args[1]] = definition
+        self.shell.print(f"defined '{args[1]}' to run '{definition}'")
+
+    def help(self) -> str:
+        return "defines a 'definition', which maps a string to a command"
+
+
+class ThrowCommand(Command):
+    def execute(self, args: List[str]):
+        raise Exception(' '.join(args[1:]))
+
+    def help(self) -> str:
+        return "throws an exception"
+
+
+class GoCommand(Command):
+    def execute(self, args: List[str]):
+        if os.path.exists(path := self.shell.get_path(args[1])):
+            self.shell.path = path
+            os.chdir(path)
+        else:
+            raise FileNotFoundError(f"{args[1]}: no such file or folder")
+
+    def help(self) -> str:
+        return "goes to a directory"
+
+
+class PeekCommand(Command):
+    def execute(self, args: List[str]):
+        if os.path.isfile(path := os.path.join(self.shell.path, args[1])):
+            with open(path, 'r') as f:
+                self.shell.print(f.read())
+        else:
+            raise FileNotFoundError(f"{args[1]}: no such file")
+
+    def help(self) -> str:
+        return "peeks the contents of a file"
+
+
+def register_commands(shell: Shell) -> Dict[str, Command]:
+    return {
+        "exit": AnonymousCommand(shell, lambda _: exit(0), ""),
+        "help": HelpCommand(shell),
+        "echo": AnonymousCommand(shell, lambda args: shell.print(' '.join(args[1:])), ""),
+        "ld": ListDirectoryCommand(shell),
+        "ver": AnonymousCommand(shell, lambda _: shell.print(shell.header), ""),
+        "def": DefineCommand(shell),
+        "throw": ThrowCommand(shell),
+        "cwd": AnonymousCommand(shell, lambda _: shell.print(shell.cwd()), ""),
+        "go": GoCommand(shell),
+        "peek": PeekCommand(shell),
+    }

bdsh-0.2.1/src/bdsh/shell.py

@@ -0,0 +1,112 @@
+import os
+import subprocess
+import sys
+from typing import TextIO
+
+from bdsh import NL, __version__
+from bdsh.command.commands import register_commands
+
+ROOT_DIR = os.path.abspath('bdsh')
+
+
+class Shell:
+    def __init__(self, stdout: TextIO | None, stdin: TextIO | None, **is_ssh: bool):
+        self.stdout = stdout
+        self.stdin = stdin
+        self.print = lambda s: self.stdout.write(s)
+        self.readchar = lambda: self.stdin.read(1)
+        self.is_ssh = is_ssh
+        self.path = self.get_path()
+        self.cwd = lambda: os.path.relpath(self.path, ROOT_DIR).replace('.', '/', 1)
+
+        self.header = f"BadOS Dynamic Shell (v{__version__}) {'(BadBandSSH)' if is_ssh else ''}{NL}(c) Bad Technologies. All rights reserved.{NL}"
+
+        self.commands = register_commands(self)
+
+        self.definitions = {
+            "ls": "ld",
+            "dir": "ld",
+            "cd": "go"
+        }
+
+        self.env = os.environ.copy()
+        self.env['PYTHONPATH'] = os.path.dirname(os.path.realpath(__file__))
+
+    def run_line(self, line: str):
+        line = line.strip() # dont want to process invisible characters
+
+        if line == "":
+            return
+
+        args = line.split(' ')
+
+        if args[0] in self.definitions:
+            self.run_line(self.definitions[args[0]] + " " + ' '.join(args[1:]))
+        elif args[0] in self.commands:
+            try:
+                self.commands[args[0]].execute(args)
+            except Exception as e:
+                self.print(f"{args[0]}: {e}")
+        elif os.path.exists(binary := self.get_path("exec", args[0])):
+            if self.is_ssh:
+                self.print(f"{args[0]} is unsupported over SSH")
+                return
+
+            subprocess.run([sys.executable, binary] + args[1:], stdout=self.stdout, stderr=subprocess.STDOUT,
+                           stdin=self.stdin, text=True, env=self.env)
+        else:
+            self.print(f"Invalid command: {args[0]}")
+
+    def get_prompt(self):
+        return f"{NL}{self.cwd()}$ "
+
+    @staticmethod
+    def get_path(*paths: str):
+        path = os.path.abspath(os.path.join(ROOT_DIR, *paths))
+        return path if path.startswith(ROOT_DIR) else ROOT_DIR
+
+    def start(self):
+        os.chdir(self.get_path())
+        self.run_line("ver")
+
+        if not os.path.exists(self.get_path()):
+            self.print(f"bdsh: bdsh directory does not exist{NL}")
+            exit(1)
+
+        self.print(self.get_prompt())
+
+        buffer = []
+
+        while True:
+            try:
+                char = self.readchar()
+
+                if self.is_ssh:
+                    self.print(char)
+
+                if char in {'\n', '\r'}:
+                    if char == '\r':
+                        self.print('\n')
+                    self.run_line(''.join(buffer))
+                    buffer.clear()
+                    self.print(self.get_prompt())
+                elif char == '\x03':  # ^C
+                    buffer.clear()
+                    self.print(self.get_prompt())
+                elif char == '\x7f':  # backspace
+                    if len(buffer) <= 0:
+                        continue
+                    self.print('\x08 \x08')
+                    buffer.pop()
+                else:
+                    buffer.append(char)
+
+            except KeyboardInterrupt:
+                buffer.clear()
+                self.print(self.get_prompt())
+                continue
+
+            except Exception as e:
+                buffer.clear()
+                self.print(f"bdsh: unhandled exception: {e}{NL}{self.get_prompt()}")
+                continue

bdsh-0.2.1/src/bdsh.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: bdsh
+Version: 0.2.1
+Summary: BadOS Dynamic Shell
+Author-email: Logan Dhillon <dev@logandhillon.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# BadOS Dynamic Shell (bdsh)
+
+Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.github.io/bdsh).
+
+## Quick Install
+
+Run the following command:
+
+```sh
+curl -O https://raw.githubusercontent.com/badtechnologies/bdsh/main/install.py
+python3 install.py
+```
+
+After completing setup, bdsh should be good to go!
+
+
+## Installation (Manual)
+
+1. **Download the latest release**
+
+    Or, you can directly download `install.py` from the [repo](https://github.com/badtechnologies/bdsh).
+
+> [!TIP]
+> The only file needed to create a bdsh installation is `install.py`.<br>
+> Running `install.py` generates, downloads, or installs everything else.
+
+2. **Setup bdsh:**
+
+    ```sh
+    python3 install.py
+    ```
+
+    Follow the on-screen instructions.
+
+    Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh` to launch the interactive shell.
+
+3. **Launch bdsh:**
+
+    ```sh
+    bdsh
+    ```
+
+> [!NOTE]
+> This may change depending on how you created your launcher scripts.

bdsh-0.2.1/src/bdsh.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+src/bdsh/__init__.py
+src/bdsh/__main__.py
+src/bdsh/__version__.py
+src/bdsh/shell.py
+src/bdsh.egg-info/PKG-INFO
+src/bdsh.egg-info/SOURCES.txt
+src/bdsh.egg-info/dependency_links.txt
+src/bdsh.egg-info/entry_points.txt
+src/bdsh.egg-info/top_level.txt
+src/bdsh/command/__init__.py
+src/bdsh/command/commands.py

bdsh-0.2.1/src/bdsh.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bdsh-0.2.1/src/bdsh.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bdsh = bdsh.__main__:main

bdsh-0.2.1/src/bdsh.egg-info/top_level.txt

@@ -0,0 +1 @@
+bdsh