gotoni 0.1.0__tar.gz

gotoni-0.1.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: gotoni
+Version: 0.1.0
+Summary: A helper package to easily add SSH support to Modal apps.
+Author: Alessio Toniolo
+Project-URL: Homepage, https://github.com/alessiotoniolo/gotoni
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: modal
+
+# gotoni (Python Package)
+
+A Python package providing utilities to easily inject an SSH daemon into [Modal](https://modal.com/) images and securely connect to running containers.
+
+## Installation
+
+```bash
+cd python
+pip install -e .
+```
+
+## Usage
+
+```python
+import modal
+import gotoni
+
+# 1. Add SSH into your Modal Image
+image = modal.Image.debian_slim().pip_install("fastapi")
+image = gotoni.add_ssh(image, key_path="~/.ssh/id_rsa.pub")
+
+app = modal.App("my-ssh-app", image=image)
+
+# 2. Start the SSH daemon in a modal function
+@app.function(timeout=3600)
+def debug_session():
+    # This will print the SSH command to your terminal and block for the duration of the timeout
+    gotoni.start_ssh(port=2222, timeout=3600)
+```

gotoni-0.1.0/README.md

@@ -0,0 +1,29 @@
+# gotoni (Python Package)
+
+A Python package providing utilities to easily inject an SSH daemon into [Modal](https://modal.com/) images and securely connect to running containers.
+
+## Installation
+
+```bash
+cd python
+pip install -e .
+```
+
+## Usage
+
+```python
+import modal
+import gotoni
+
+# 1. Add SSH into your Modal Image
+image = modal.Image.debian_slim().pip_install("fastapi")
+image = gotoni.add_ssh(image, key_path="~/.ssh/id_rsa.pub")
+
+app = modal.App("my-ssh-app", image=image)
+
+# 2. Start the SSH daemon in a modal function
+@app.function(timeout=3600)
+def debug_session():
+    # This will print the SSH command to your terminal and block for the duration of the timeout
+    gotoni.start_ssh(port=2222, timeout=3600)
+```

gotoni-0.1.0/gotoni/__init__.py

@@ -0,0 +1,71 @@
+import subprocess
+import time
+import modal
+
+def add_ssh(image: modal.Image, key_path: str = "~/.ssh/id_rsa.pub") -> modal.Image:
+    """
+    Modifies a Modal image to configure an SSH daemon, allowing secure remote access.
+    
+    This function performs the following setup steps on the provided modal.Image:
+    1. Installs the 'openssh-server' package via apt.
+    2. Generates host keys using 'ssh-keygen -A'.
+    3. Modifies '/etc/ssh/sshd_config' to:
+       - Allow root login ('PermitRootLogin yes').
+       - Enable public key authentication ('PubkeyAuthentication yes').
+       - Disable password authentication ('PasswordAuthentication no').
+    4. Copies the specified local SSH public key to the container's '/root/.ssh/authorized_keys'.
+    5. Sets strict permissions (chmod 600) on the 'authorized_keys' file to ensure SSH accepts it.
+    
+    Args:
+        image (modal.Image): The base Modal image to modify.
+        key_path (str): The path to your local public SSH key. 
+                        Defaults to "~/.ssh/id_rsa.pub".
+                        
+    Returns:
+        modal.Image: The updated Modal image with the SSH daemon and keys configured.
+    """
+    return (
+        image
+        .apt_install("openssh-server")
+        .run_commands(
+            "ssh-keygen -A",
+            r"sed -i 's/^#\?PermitRootLogin.*/PermitRootLogin yes/' /etc/ssh/sshd_config",
+            r"sed -i 's/^#\?PubkeyAuthentication.*/PubkeyAuthentication yes/' /etc/ssh/sshd_config",
+            r"sed -i 's/^#\?PasswordAuthentication.*/PasswordAuthentication no/' /etc/ssh/sshd_config",
+        )
+        .add_local_file(key_path, "/root/.ssh/authorized_keys", copy=True)
+        .run_commands("chmod 600 /root/.ssh/authorized_keys")
+    )
+
+
+def start_ssh(port: int = 2222, timeout: int = 3600):
+    """
+    Starts the SSH daemon in the Modal container and sets up a port forward to the user's local machine.
+    
+    This function should be called inside your Modal function when you want to block and keep 
+    the container alive for an SSH session. It performs these actions:
+    1. Spawns the SSH daemon subprocess: `/usr/sbin/sshd -D -e -p <port>`.
+    2. Uses `modal.forward` to expose the chosen port over an unencrypted Modal tunnel.
+    3. Prints out the exact `ssh` command the user can copy and paste into their local 
+       terminal or IDE to connect to the container.
+    4. Blocks execution (sleeps) for the specified `timeout` duration to keep the container running.
+    
+    Args:
+        port (int): The port on which the SSH daemon will listen inside the container. 
+                    Defaults to 2222.
+        timeout (int): The number of seconds to keep the container running and the tunnel open. 
+                       Defaults to 3600 (1 hour).
+    """
+    # Start the SSH daemon in the background
+    subprocess.Popen(["/usr/sbin/sshd", "-D", "-e", "-p", str(port)])
+    
+    # Expose via Modal tunnel
+    with modal.forward(port=port, unencrypted=True) as tunnel:
+        host, tunnel_port = tunnel.tcp_socket
+        print(f"\n=======================================================")
+        print(f" SSH into container using command:")
+        print(f"     ssh -p {tunnel_port} root@{host}")
+        print(f"=======================================================\n")
+        
+        # Block to keep the container alive and tunnel active
+        time.sleep(timeout)

gotoni-0.1.0/gotoni.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: gotoni
+Version: 0.1.0
+Summary: A helper package to easily add SSH support to Modal apps.
+Author: Alessio Toniolo
+Project-URL: Homepage, https://github.com/alessiotoniolo/gotoni
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: modal
+
+# gotoni (Python Package)
+
+A Python package providing utilities to easily inject an SSH daemon into [Modal](https://modal.com/) images and securely connect to running containers.
+
+## Installation
+
+```bash
+cd python
+pip install -e .
+```
+
+## Usage
+
+```python
+import modal
+import gotoni
+
+# 1. Add SSH into your Modal Image
+image = modal.Image.debian_slim().pip_install("fastapi")
+image = gotoni.add_ssh(image, key_path="~/.ssh/id_rsa.pub")
+
+app = modal.App("my-ssh-app", image=image)
+
+# 2. Start the SSH daemon in a modal function
+@app.function(timeout=3600)
+def debug_session():
+    # This will print the SSH command to your terminal and block for the duration of the timeout
+    gotoni.start_ssh(port=2222, timeout=3600)
+```

gotoni-0.1.0/gotoni.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+gotoni/__init__.py
+gotoni.egg-info/PKG-INFO
+gotoni.egg-info/SOURCES.txt
+gotoni.egg-info/dependency_links.txt
+gotoni.egg-info/requires.txt
+gotoni.egg-info/top_level.txt

gotoni-0.1.0/gotoni.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gotoni-0.1.0/gotoni.egg-info/requires.txt

@@ -0,0 +1 @@
+modal

gotoni-0.1.0/gotoni.egg-info/top_level.txt

@@ -0,0 +1 @@
+gotoni

gotoni-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gotoni"
+version = "0.1.0"
+description = "A helper package to easily add SSH support to Modal apps."
+readme = "README.md"
+authors = [
+  { name="Alessio Toniolo" }
+]
+requires-python = ">=3.8"
+dependencies = [
+    "modal"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/alessiotoniolo/gotoni"

gotoni-0.1.0/setup.cfg

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