ssh-handler 1.0.4__tar.gz → 1.0.6__tar.gz

{ssh_handler-1.0.4/ssh_handler.egg-info → ssh_handler-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssh-handler
-Version: 1.0.4
+Version: 1.0.6
 Summary: Extensive SSH/SFTP/SCP/FTP handler built on Paramiko, for test automation, CLIs and PyQt5 tools.
 Author: ssh-handler contributors
 License-Expression: MIT
@@ -224,6 +224,21 @@ Requirements: `pip install "ssh-handler[winrm]"` (pulls in `pywinrm`; uses NTLM
 domain creds work without Kerberos), and the account must be a **local
 administrator** on the target. If SSH already works, this code path never runs.
 
+### Set up OpenSSH Server on a machine (bundled installer)
+
+Installing the package also gives you a one-command setup for the *local* Windows
+machine — it ships inside the wheel, self-elevates to Administrator, installs &
+starts OpenSSH Server, and opens the firewall:
+
+```powershell
+pip install ssh-handler
+ssh-handler-setup                 # install + start sshd + firewall (self-elevates)
+ssh-handler-setup --install-pip   # also (re)install the package as admin
+# equivalent: python -m ssh_handler setup-server
+```
+
+Run it on whichever machine you want to reach over SSH (e.g. the RDP jump box).
+
 When a connection just fails, the error now self-diagnoses — it probes the SSH and
 RDP ports and tells you *why* (e.g. "Port 22 is closed but RDP (3389) is open … no
 SSH server listening"). Call `ssh.diagnose()` for a pre-flight reachability check.

{ssh_handler-1.0.4 → ssh_handler-1.0.6}/README.md

@@ -193,6 +193,21 @@ Requirements: `pip install "ssh-handler[winrm]"` (pulls in `pywinrm`; uses NTLM
 domain creds work without Kerberos), and the account must be a **local
 administrator** on the target. If SSH already works, this code path never runs.
 
+### Set up OpenSSH Server on a machine (bundled installer)
+
+Installing the package also gives you a one-command setup for the *local* Windows
+machine — it ships inside the wheel, self-elevates to Administrator, installs &
+starts OpenSSH Server, and opens the firewall:
+
+```powershell
+pip install ssh-handler
+ssh-handler-setup                 # install + start sshd + firewall (self-elevates)
+ssh-handler-setup --install-pip   # also (re)install the package as admin
+# equivalent: python -m ssh_handler setup-server
+```
+
+Run it on whichever machine you want to reach over SSH (e.g. the RDP jump box).
+
 When a connection just fails, the error now self-diagnoses — it probes the SSH and
 RDP ports and tells you *why* (e.g. "Port 22 is closed but RDP (3389) is open … no
 SSH server listening"). Call `ssh.diagnose()` for a pre-flight reachability check.

{ssh_handler-1.0.4 → ssh_handler-1.0.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ssh-handler"
-version = "1.0.4"
+version = "1.0.6"
 description = "Extensive SSH/SFTP/SCP/FTP handler built on Paramiko, for test automation, CLIs and PyQt5 tools."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -32,6 +32,10 @@ all = ["keyring>=23.0", "scp>=0.14", "PyQt5>=5.15", "pywinrm>=0.4.3"]
 
 [project.scripts]
 ssh-handler = "ssh_handler.cli:main"
+ssh-handler-setup = "ssh_handler.cli:setup_server_main"
 
 [tool.setuptools]
 packages = ["ssh_handler"]
+
+[tool.setuptools.package-data]
+ssh_handler = ["*.ps1"]

{ssh_handler-1.0.4 → ssh_handler-1.0.6}/ssh_handler/__init__.py

@@ -22,7 +22,7 @@ dependencies (PyQt5 / scp) don't break the core package.
 
 from __future__ import annotations
 
-__version__ = "1.0.4"
+__version__ = "1.0.6"
 
 from .config import SSHConfig, FTPConfig
 from .core import SSHHandler, ShellSession

{ssh_handler-1.0.4 → ssh_handler-1.0.6}/ssh_handler/cli.py

@@ -15,9 +15,11 @@ Credentials (password never echoed, never stored in plaintext):
 
 from __future__ import annotations
 
+import os
 import sys
 import json
 import argparse
+import subprocess
 
 from .config import SSHConfig
 from .core import SSHHandler
@@ -26,6 +28,35 @@ from .exceptions import SSHError
 from .results import CommandResult, TransferResult
 
 
+def _setup_script_path() -> str:
+    """Absolute path to the bundled OpenSSH setup PowerShell script."""
+    return os.path.join(os.path.dirname(__file__), "setup_openssh_server.ps1")
+
+
+def setup_server_main(argv=None) -> int:
+    """
+    Console entry point (`ssh-handler-setup`): run the bundled PowerShell script
+    that installs & starts OpenSSH Server, opens the firewall, and optionally
+    pip-installs the package. Self-elevates to Administrator. Windows only.
+
+    Any extra args are forwarded to the script, e.g.:
+        ssh-handler-setup --InstallPip --Port 22
+    """
+    if os.name != "nt":
+        print("ssh-handler-setup only runs on Windows (it sets up OpenSSH Server).",
+              file=sys.stderr)
+        return 2
+    script = _setup_script_path()
+    if not os.path.exists(script):
+        print(f"Bundled setup script not found: {script}", file=sys.stderr)
+        return 1
+    extra = list(argv) if argv is not None else sys.argv[1:]
+    cmd = ["powershell", "-NoProfile", "-ExecutionPolicy", "Bypass",
+           "-File", script] + extra
+    print(f"Launching OpenSSH Server setup (will prompt for Administrator)...")
+    return subprocess.call(cmd)
+
+
 def _add_conn_args(p: argparse.ArgumentParser) -> None:
     p.add_argument("--host", required=True)
     p.add_argument("--port", type=int, default=22)
@@ -107,6 +138,29 @@ def main(argv=None) -> int:
     p_info = sub.add_parser("info", help="connect and report remote OS")
     _add_conn_args(p_info)
 
+    p_setup = sub.add_parser("setup-server",
+                             help="install & start OpenSSH Server on THIS Windows "
+                                  "machine (self-elevates to Administrator)")
+    p_setup.add_argument("--install-pip", action="store_true",
+                         help="also pip-install ssh-handler[winrm]")
+    p_setup.add_argument("--port", type=int, default=22)
+
+    # setup-server takes no connection args and runs the bundled PowerShell script
+    if argv is None:
+        _argv = sys.argv[1:]
+    else:
+        _argv = list(argv)
+    if _argv and _argv[0] == "setup-server":
+        forward = []
+        rest = _argv[1:]
+        if "--install-pip" in rest:
+            forward.append("-InstallPip")
+        if "--port" in rest:
+            i = rest.index("--port")
+            if i + 1 < len(rest):
+                forward += ["-Port", rest[i + 1]]
+        return setup_server_main(forward)
+
     args = parser.parse_args(argv)
 
     # store-credential is handled without a connection

{ssh_handler-1.0.4 → ssh_handler-1.0.6}/ssh_handler/results.py

@@ -31,6 +31,11 @@ class CommandResult:
     def ok(self) -> bool:
         return self.exit_code == 0
 
+    @property
+    def text(self) -> str:
+        """stdout with surrounding whitespace/newlines stripped - print-ready."""
+        return self.stdout.strip()
+
     def __bool__(self) -> bool:
         return self.ok
 

ssh_handler-1.0.6/ssh_handler/setup_openssh_server.ps1

@@ -0,0 +1,150 @@
+<#
+.SYNOPSIS
+    One-shot setup for an SSH target / RDP jump machine:
+    installs & starts OpenSSH Server, opens the firewall, and (optionally)
+    pip-installs the ssh-handler package. Self-elevates to Administrator.
+
+.DESCRIPTION
+    Run this once on a Windows machine that you want to reach over SSH (e.g. the
+    RDP box you tunnel through). It:
+      1. Re-launches itself elevated if not already running as Administrator.
+      2. Installs OpenSSH Server (Windows capability -> winget fallback).
+      3. Starts sshd, sets it to start automatically, opens TCP 22.
+      4. Optionally runs `pip install -U "ssh-handler[winrm]"`.
+      5. Verifies sshd is running and listening.
+
+.PARAMETER InstallPip
+    Also install/upgrade the ssh-handler Python package (needs Python+pip on PATH).
+
+.PARAMETER Port
+    SSH port to open in the firewall (default 22).
+
+.EXAMPLE
+    powershell -ExecutionPolicy Bypass -File .\setup_openssh_server.ps1
+
+.EXAMPLE
+    powershell -ExecutionPolicy Bypass -File .\setup_openssh_server.ps1 -InstallPip
+#>
+
+param(
+    [switch]$InstallPip,
+    [int]$Port = 22
+)
+
+$ErrorActionPreference = 'Stop'
+$ProgressPreference = 'SilentlyContinue'
+
+# --- 1. Self-elevate to Administrator -------------------------------------- #
+$isAdmin = ([Security.Principal.WindowsPrincipal]`
+    [Security.Principal.WindowsIdentity]::GetCurrent()`
+    ).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)
+
+if (-not $isAdmin) {
+    Write-Host "Elevating to Administrator..." -ForegroundColor Yellow
+    $argList = "-NoProfile -ExecutionPolicy Bypass -File `"$PSCommandPath`""
+    if ($InstallPip) { $argList += " -InstallPip" }
+    $argList += " -Port $Port"
+    Start-Process powershell -Verb RunAs -ArgumentList $argList
+    exit
+}
+
+Write-Host "=== OpenSSH Server setup (running as Administrator) ===" -ForegroundColor Cyan
+
+# --- 2. Install OpenSSH Server --------------------------------------------- #
+function Test-SshdPresent {
+    return [bool](Get-Service -Name sshd -ErrorAction SilentlyContinue)
+}
+
+if (Test-SshdPresent) {
+    Write-Host "OpenSSH Server already present." -ForegroundColor Green
+}
+else {
+    Write-Host "Installing OpenSSH Server..."
+    $installed = $false
+
+    # 2a. Windows capability (Features-on-Demand). May be slow on corporate nets.
+    try {
+        $cap = Get-WindowsCapability -Online -Name 'OpenSSH.Server*' |
+               Select-Object -First 1
+        if ($cap -and $cap.State -ne 'Installed') {
+            Write-Host "  Trying Add-WindowsCapability (can take a few minutes)..."
+            Add-WindowsCapability -Online -Name $cap.Name | Out-Null
+        }
+        if (Test-SshdPresent) { $installed = $true }
+    }
+    catch {
+        Write-Host "  Windows capability install failed: $($_.Exception.Message)" `
+            -ForegroundColor DarkYellow
+    }
+
+    # 2b. winget fallback
+    if (-not $installed) {
+        try {
+            Write-Host "  Trying winget (Microsoft.OpenSSH.Beta)..."
+            winget install --id Microsoft.OpenSSH.Beta -e --silent `
+                --accept-source-agreements --accept-package-agreements | Out-Null
+            if (Test-SshdPresent) { $installed = $true }
+        }
+        catch {
+            Write-Host "  winget not available or failed." -ForegroundColor DarkYellow
+        }
+    }
+
+    if (-not $installed -and -not (Test-SshdPresent)) {
+        Write-Warning @"
+Could not auto-install OpenSSH Server (Windows Update / winget likely blocked).
+Manual fallback:
+  1. On a machine with internet, download OpenSSH-Win64.zip from
+     https://github.com/PowerShell/Win32-OpenSSH/releases/latest
+  2. Copy it here, extract to 'C:\Program Files\OpenSSH'
+  3. Run:  powershell -ExecutionPolicy Bypass -File 'C:\Program Files\OpenSSH\install-sshd.ps1'
+Then re-run this script to finish service + firewall setup.
+"@
+        exit 1
+    }
+    Write-Host "OpenSSH Server installed." -ForegroundColor Green
+}
+
+# --- 3. Service + firewall -------------------------------------------------- #
+Write-Host "Configuring sshd service and firewall..."
+Set-Service -Name sshd -StartupType Automatic
+Start-Service sshd
+
+$ruleName = "OpenSSH-Server-In-TCP"
+if (-not (Get-NetFirewallRule -Name $ruleName -ErrorAction SilentlyContinue)) {
+    New-NetFirewallRule -Name $ruleName -DisplayName 'OpenSSH Server (sshd)' `
+        -Enabled True -Direction Inbound -Protocol TCP -Action Allow `
+        -LocalPort $Port | Out-Null
+    Write-Host "  Firewall rule added for TCP $Port." -ForegroundColor Green
+}
+else {
+    Write-Host "  Firewall rule already present." -ForegroundColor Green
+}
+
+# --- 4. Optional: pip install the package ---------------------------------- #
+if ($InstallPip) {
+    Write-Host "Installing ssh-handler (pip)..."
+    try {
+        python -m pip install --upgrade pip | Out-Null
+        python -m pip install -U "ssh-handler[winrm]"
+        Write-Host "  ssh-handler installed." -ForegroundColor Green
+    }
+    catch {
+        Write-Warning "pip install failed: $($_.Exception.Message)"
+        Write-Host "  Ensure Python and pip are on PATH, then run: pip install -U ssh-handler"
+    }
+}
+
+# --- 5. Verify -------------------------------------------------------------- #
+Write-Host "`n=== Verification ===" -ForegroundColor Cyan
+$svc = Get-Service sshd
+Write-Host ("sshd status : {0}" -f $svc.Status)
+$test = Test-NetConnection localhost -Port $Port -WarningAction SilentlyContinue
+Write-Host ("port {0} open : {1}" -f $Port, $test.TcpTestSucceeded)
+
+if ($svc.Status -eq 'Running' -and $test.TcpTestSucceeded) {
+    Write-Host "`nDone. This machine now accepts SSH on port $Port." -ForegroundColor Green
+}
+else {
+    Write-Warning "Setup finished but sshd is not listening yet - check the messages above."
+}

{ssh_handler-1.0.4 → ssh_handler-1.0.6/ssh_handler.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssh-handler
-Version: 1.0.4
+Version: 1.0.6
 Summary: Extensive SSH/SFTP/SCP/FTP handler built on Paramiko, for test automation, CLIs and PyQt5 tools.
 Author: ssh-handler contributors
 License-Expression: MIT
@@ -224,6 +224,21 @@ Requirements: `pip install "ssh-handler[winrm]"` (pulls in `pywinrm`; uses NTLM
 domain creds work without Kerberos), and the account must be a **local
 administrator** on the target. If SSH already works, this code path never runs.
 
+### Set up OpenSSH Server on a machine (bundled installer)
+
+Installing the package also gives you a one-command setup for the *local* Windows
+machine — it ships inside the wheel, self-elevates to Administrator, installs &
+starts OpenSSH Server, and opens the firewall:
+
+```powershell
+pip install ssh-handler
+ssh-handler-setup                 # install + start sshd + firewall (self-elevates)
+ssh-handler-setup --install-pip   # also (re)install the package as admin
+# equivalent: python -m ssh_handler setup-server
+```
+
+Run it on whichever machine you want to reach over SSH (e.g. the RDP jump box).
+
 When a connection just fails, the error now self-diagnoses — it probes the SSH and
 RDP ports and tells you *why* (e.g. "Port 22 is closed but RDP (3389) is open … no
 SSH server listening"). Call `ssh.diagnose()` for a pre-flight reachability check.

{ssh_handler-1.0.4 → ssh_handler-1.0.6}/ssh_handler.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ ssh_handler/ftp.py
 ssh_handler/pool.py
 ssh_handler/pyqt_worker.py
 ssh_handler/results.py
+ssh_handler/setup_openssh_server.ps1
 ssh_handler/winrm_bootstrap.py
 ssh_handler.egg-info/PKG-INFO
 ssh_handler.egg-info/SOURCES.txt

ssh_handler-1.0.6/ssh_handler.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ssh-handler = ssh_handler.cli:main
+ssh-handler-setup = ssh_handler.cli:setup_server_main

ssh_handler-1.0.4/ssh_handler.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-ssh-handler = ssh_handler.cli:main