remote-cmd-manager 1.0.0__py3-none-any.whl

remote_cmd/__init__.py

@@ -0,0 +1,125 @@
+"""
+Remote CMD - SSH 远程服务器管理工具
+
+一个功能强大的 Python 库，用于管理远程服务器。
+提供简洁的 API 用于 SSH 连接、命令执行和文件传输。
+
+主要功能：
+    - SSH 连接管理（支持密码和密钥认证）
+    - 远程命令执行（包括 sudo 命令）
+    - 文件上传和下载
+    - 主机配置管理
+    - 标签分类系统
+    - 批量连接测试
+    - 凭据加密存储
+    - 结构化日志系统
+
+快速开始：
+    >>> from remote_cmd import SSHClient, HostManager
+    >>> from remote_cmd.core.ssh_client import ConnectionConfig
+    >>>
+    >>> # 创建连接配置
+    >>> config = ConnectionConfig(
+    ...     hostname="192.168.1.100",
+    ...     username="admin",
+    ...     key_filename="~/.ssh/id_rsa"
+    ... )
+    >>>
+    >>> # 执行远程命令
+    >>> with SSHClient(config) as client:
+    ...     result = client.execute("ls -la")
+    ...     print(result.stdout)
+
+新架构（推荐）:
+    >>> from remote_cmd.repository.json_host_repository import JsonHostRepository
+    >>> from remote_cmd.service.host_service import HostService
+    >>>
+    >>> repo = JsonHostRepository("hosts.json")
+    >>> service = HostService(repo)
+    >>> service.add_host(host)
+
+命令行使用：
+    $ remote-cmd host add server1 192.168.1.100 admin -k ~/.ssh/id_rsa
+    $ remote-cmd host list
+    $ remote-cmd run server1 "uptime"
+
+更多信息：
+    - GitHub: https://github.com/Vae-Scrooge/remote-cmd-test
+    - 文档: 参见 docs/ 目录
+
+Author: Vae-Scrooge
+Version: 1.0.0
+License: MIT
+"""
+
+__version__ = "1.0.0"
+__author__ = "Vae-Scrooge"
+__email__ = "vae-scrooge@example.com"
+__license__ = "MIT"
+
+import logging
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+# 向后兼容导出（原有 API）
+from remote_cmd.core.async_client import AsyncSSHClient, ConnectionPool
+from remote_cmd.core.host import Host
+from remote_cmd.core.host_manager import HostManager
+from remote_cmd.core.ssh_client import SSHClient
+
+# 新架构导出（推荐）
+from remote_cmd.repository import HostRepository, JsonHostRepository
+
+# Phase 2 新组件
+from remote_cmd.repository.sqlite_host_repository import SqliteHostRepository
+from remote_cmd.service import (
+    ChainCredentialProvider,
+    CredentialProvider,
+    EnvCredentialProvider,
+    HostService,
+    SSHService,
+)
+from remote_cmd.service.batch_executor import BatchExecutor, BatchHostResult, BatchResult
+from remote_cmd.service.credential_provider import KeyringCredentialProvider
+from remote_cmd.service.task_runner import Task, TaskRunner, TaskStatus
+from remote_cmd.utils.crypto import CredentialEncryption
+from remote_cmd.utils.logging_utils import (
+    SensitiveDataFilter,
+    get_logger,
+    setup_logging,
+)
+
+# 定义公开 API
+__all__ = [
+    # 原有导出（向后兼容）
+    "SSHClient",
+    "AsyncSSHClient",
+    "ConnectionPool",
+    "HostManager",
+    "Host",
+    # 新架构导出
+    "HostRepository",
+    "JsonHostRepository",
+    "HostService",
+    "SSHService",
+    "CredentialProvider",
+    "EnvCredentialProvider",
+    "ChainCredentialProvider",
+    "CredentialEncryption",
+    "setup_logging",
+    "SensitiveDataFilter",
+    "get_logger",
+    # Phase 2 新组件
+    "SqliteHostRepository",
+    "BatchExecutor",
+    "BatchResult",
+    "BatchHostResult",
+    "TaskRunner",
+    "Task",
+    "TaskStatus",
+    "KeyringCredentialProvider",
+    # 元信息
+    "__version__",
+    "__author__",
+    "__license__",
+]

remote_cmd/cli/__init__.py

@@ -0,0 +1 @@
+"""CLI module for command-line interface."""

remote_cmd/cli/main.py

@@ -0,0 +1,434 @@
+"""
+命令行接口模块
+
+提供完整的命令行工具，用于管理远程主机和执行 SSH 操作。
+基于 Click 框架构建，使用 HostService + Repository 架构。
+
+主要命令：
+- host: 主机管理命令组
+  - add: 添加新主机
+  - list: 列出所有主机
+  - remove: 移除主机
+  - test: 测试主机连接
+- run: 在远程主机上执行命令
+- upload: 上传文件到远程主机
+- download: 从远程主机下载文件
+"""
+
+import os
+from typing import Any, Optional
+
+import click
+
+from remote_cmd.core.host import Host
+from remote_cmd.repository.json_host_repository import JsonHostRepository
+from remote_cmd.service.batch_executor import BatchExecutor
+from remote_cmd.service.credential_provider import (
+    ChainCredentialProvider,
+    EnvCredentialProvider,
+)
+from remote_cmd.service.host_service import HostService
+from remote_cmd.utils.config import get_default_config_path, load_config
+
+
+def _build_service(config_file: str) -> HostService:
+    """从配置文件构建 HostService"""
+    repo = JsonHostRepository(filepath=config_file, auto_load=True)
+    cred_provider = ChainCredentialProvider(
+        [
+            EnvCredentialProvider(),
+        ]
+    )
+    return HostService(repository=repo, credential_provider=cred_provider)
+
+
+@click.group()
+@click.version_option(version="1.0.0", prog_name="remote-cmd")
+@click.option("--config", "-c", type=click.Path(), help="配置文件路径")
+@click.option("--verbose", "-v", is_flag=True, help="启用详细输出模式")
+@click.pass_context
+def cli(ctx, config: Optional[str], verbose: bool):
+    """
+    Remote CMD - SSH 远程服务器管理工具
+
+    一个功能强大的命令行工具，用于管理远程主机配置、
+    执行命令和传输文件。
+
+    快速开始：
+        # 添加主机
+        remote-cmd host add my-server 192.168.1.100 admin -k ~/.ssh/id_rsa
+
+        # 列出所有主机
+        remote-cmd host list
+
+        # 执行远程命令
+        remote-cmd run my-server "ls -la"
+
+        # 上传文件
+        remote-cmd upload my-server ./local.txt /remote/path.txt
+    """
+    ctx.ensure_object(dict)
+
+    config_path = config or get_default_config_path()
+    ctx.obj["config"] = load_config(config_path)
+    ctx.obj["verbose"] = verbose
+
+    hosts_file = ctx.obj["config"].get("hosts_file", "hosts.json")
+    ctx.obj["service"] = _build_service(hosts_file)
+
+    if verbose:
+        click.echo(f"使用配置文件: {config_path}")
+
+
+@cli.group()
+def host():
+    """
+    主机管理命令组
+
+    用于添加、删除、列出、查看和测试远程主机连接。
+
+    可用命令：
+        add     添加新主机
+        list    列出所有主机
+        show    查看主机详情
+        remove  移除主机
+        test    测试主机连接
+    """
+    pass
+
+
+@host.command("add")
+@click.argument("name", required=True)
+@click.argument("hostname", required=True)
+@click.argument("username", required=True)
+@click.option("--port", "-p", default=22, help="SSH 端口号（默认：22）")
+@click.option(
+    "--password",
+    "-P",
+    default=None,
+    help="登录密码（不推荐直接在命令行输入，建议使用 REMOTE_CMD_PASSWORD 环境变量或交互式输入）",
+)
+@click.option("--key", "-k", help="SSH 私钥文件路径")
+@click.option("--tag", "-t", multiple=True, help="主机标签（可多次指定）")
+@click.option("--description", "-d", default="", help="主机描述")
+@click.pass_context
+def host_add(
+    ctx,
+    name: str,
+    hostname: str,
+    username: str,
+    port: int,
+    password: Optional[str],
+    key: Optional[str],
+    tag: tuple,
+    description: str,
+):
+    """
+    添加新主机
+
+    NAME: 主机名称（唯一标识符）
+    HOSTNAME: 主机地址（IP 或域名）
+    USERNAME: SSH 登录用户名
+    """
+    service: HostService = ctx.obj["service"]
+
+    # 获取密码：优先级 REMOTE_CMD_PASSWORD > --password > 交互式输入
+    resolved_password = os.environ.get("REMOTE_CMD_PASSWORD") or password
+    if not resolved_password and not key:
+        resolved_password = click.prompt(
+            "SSH 密码", hide_input=True, default="", show_default=False
+        )
+    elif password and not os.environ.get("REMOTE_CMD_PASSWORD"):
+        click.echo(
+            click.style(
+                "⚠ 警告: 在命令行参数中传递密码不安全，建议使用 REMOTE_CMD_PASSWORD 环境变量",
+                fg="yellow",
+            ),
+            err=True,
+        )
+
+    host = Host(
+        name=name,
+        hostname=hostname,
+        username=username,
+        port=port,
+        password=resolved_password or password,
+        key_filename=key,
+        tags=list(tag),
+        description=description,
+    )
+
+    try:
+        service.add_host(host)
+        click.echo(f"✓ 主机 '{name}' 添加成功")
+    except ValueError as e:
+        click.echo(f"✗ 错误: {e}", err=True)
+        ctx.exit(1)
+
+
+@host.command("list")
+@click.option("--tag", "-t", help="按标签筛选主机")
+@click.pass_context
+def host_list(ctx, tag: Optional[str]):
+    """列出所有主机"""
+    service: HostService = ctx.obj["service"]
+    hosts = service.list_hosts(tag=tag)
+
+    if not hosts:
+        if tag:
+            click.echo(f"没有找到标签为 '{tag}' 的主机")
+        else:
+            click.echo("没有配置任何主机")
+        return
+
+    click.echo(f"\n{'名称':<20} {'主机地址':<25} {'用户名':<15} {'标签':<20}")
+    click.echo("-" * 80)
+
+    for host in hosts:
+        tags_str = ", ".join(host.tags) if host.tags else "-"
+        click.echo(f"{host.name:<20} {host.hostname:<25} {host.username:<15} {tags_str:<20}")
+
+    click.echo()
+
+
+@host.command("remove")
+@click.argument("name", required=True)
+@click.confirmation_option(prompt="确定要移除这个主机吗？")
+@click.pass_context
+def host_remove(ctx, name: str):
+    """移除主机"""
+    service: HostService = ctx.obj["service"]
+
+    try:
+        service.remove_host(name)
+        click.echo(f"✓ 主机 '{name}' 已移除")
+    except KeyError as e:
+        click.echo(f"✗ 错误: {e}", err=True)
+        ctx.exit(1)
+
+
+@host.command("show")
+@click.argument("name", required=True)
+@click.pass_context
+def host_show(ctx, name: str):
+    """显示主机详细信息"""
+    service: HostService = ctx.obj["service"]
+
+    try:
+        host = service.get_host(name)
+        click.echo(f"\n{'=' * 50}")
+        click.echo(f"  主机详情: {host.name}")
+        click.echo(f"{'=' * 50}")
+        click.echo(f"  名称:      {host.name}")
+        click.echo(f"  主机地址:  {host.hostname}")
+        click.echo(f"  用户名:    {host.username}")
+        click.echo(f"  端口:      {host.port}")
+        click.echo(
+            f"  认证方式:  {'密码' if host.password else 'SSH 密钥' if host.key_filename else 'SSH Agent'}"
+        )
+        if host.key_filename:
+            click.echo(f"  密钥路径:  {host.key_filename}")
+        tags_str = ", ".join(host.tags) if host.tags else "-"
+        click.echo(f"  标签:      {tags_str}")
+        click.echo(f"  描述:      {host.description or '-'}")
+        click.echo(f"{'=' * 50}\n")
+    except KeyError as e:
+        click.echo(f"✗ 错误: {e}", err=True)
+        ctx.exit(1)
+
+
+@host.command("test")
+@click.argument("name", required=True)
+@click.pass_context
+def host_test(ctx, name: str):
+    """测试主机连接"""
+    service: HostService = ctx.obj["service"]
+
+    click.echo(f"正在测试 '{name}' 的连接...")
+
+    if service.test_connection(name):
+        click.echo(f"✓ 主机 '{name}' 连接成功")
+    else:
+        click.echo(f"✗ 主机 '{name}' 连接失败", err=True)
+        ctx.exit(1)
+
+
+@cli.command()
+@click.argument("host_name", required=True)
+@click.argument("command", required=True)
+@click.pass_context
+def run(ctx, host_name: str, command: str):
+    """
+    在远程主机上执行命令
+
+    HOST_NAME: 主机名称
+    COMMAND: 要执行的命令
+    """
+    service: HostService = ctx.obj["service"]
+
+    try:
+        with service.connect_to_host(host_name) as client:
+            result = client.execute(command)
+
+            if result.stdout:
+                click.echo(result.stdout)
+
+            if result.stderr:
+                click.echo(result.stderr, err=True)
+
+            ctx.exit(result.exit_code)
+
+    except Exception as e:  # noqa: BLE001
+        click.echo(f"✗ 错误: {e}", err=True)
+        ctx.exit(1)
+
+
+@cli.command()
+@click.argument("host_name", required=True)
+@click.argument("local_path", required=True)
+@click.argument("remote_path", required=True)
+@click.pass_context
+def upload(ctx, host_name: str, local_path: str, remote_path: str):
+    """
+    上传文件到远程主机
+
+    HOST_NAME: 主机名称
+    LOCAL_PATH: 本地文件路径
+    REMOTE_PATH: 远程目标路径
+    """
+    service: HostService = ctx.obj["service"]
+
+    try:
+        with service.connect_to_host(host_name) as client:
+            client.upload_file(local_path, remote_path)
+            click.echo(f"✓ 上传成功: {local_path} -> {host_name}:{remote_path}")
+    except Exception as e:  # noqa: BLE001
+        click.echo(f"✗ 错误: {e}", err=True)
+        ctx.exit(1)
+
+
+@cli.command()
+@click.argument("host_name", required=True)
+@click.argument("local_path", required=True)
+@click.argument("remote_path", required=True)
+@click.pass_context
+def download(ctx, host_name: str, local_path: str, remote_path: str):
+    """
+    从远程主机下载文件
+
+    HOST_NAME: 主机名称
+    LOCAL_PATH: 本地文件路径
+    REMOTE_PATH: 远程目标路径
+    """
+    service: HostService = ctx.obj["service"]
+
+    try:
+        with service.connect_to_host(host_name) as client:
+            client.download_file(remote_path, local_path)
+            click.echo(f"✓ 下载成功: {host_name}:{remote_path} -> {local_path}")
+    except Exception as e:  # noqa: BLE001
+        click.echo(f"✗ 错误: {e}", err=True)
+        ctx.exit(1)
+
+
+@cli.command()
+@click.argument("host_names", nargs=-1, required=True)
+@click.argument("command", required=True)
+@click.option("--concurrency", "-C", default=10, help="最大并发数（默认：10）")
+@click.option("--timeout", "-T", default=30, help="单个命令超时秒数（默认：30）")
+@click.option("--retry", "-r", default=0, help="失败重试次数（默认：0）")
+@click.option("--retry-delay", default=1.0, help="重试间隔秒数（默认：1.0）")
+@click.option("--show-failures", is_flag=True, help="仅显示失败主机")
+@click.pass_context
+def batch_run(
+    ctx,
+    host_names: tuple,
+    command: str,
+    concurrency: int,
+    timeout: int,
+    retry: int,
+    retry_delay: float,
+    show_failures: bool,
+):
+    """
+    在多个主机上批量执行命令
+
+    HOST_NAMES: 主机名称列表（可指定多个）
+    COMMAND: 要执行的命令
+
+    示例:
+
+        remote-cmd batch-run web-1 web-2 db-1 "uptime"
+
+        remote-cmd batch-run web-1 web-2 "df -h" -C 5 -r 2
+    """
+    service: HostService = ctx.obj["service"]
+    executor = BatchExecutor(
+        host_service=service,
+        max_concurrency=concurrency,
+        command_timeout=timeout,
+    )
+
+    click.echo(f"批量执行: {len(host_names)} 台主机, 命令='{command}', 并发={concurrency}")
+    click.echo()
+
+    bar: Any
+    with click.progressbar(
+        length=len(host_names),
+        label="执行进度",
+        show_eta=True,
+        show_percent=True,
+    ) as bar:
+
+        def progress(_completed, _total, _host_name):
+            bar.update(1)
+
+        result = executor.execute(
+            host_names=list(host_names),
+            command=command,
+            retry_count=retry,
+            retry_delay=retry_delay,
+            progress_callback=progress,
+        )
+
+    click.echo()
+    click.echo("=" * 50)
+    click.echo("  执行结果汇总")
+    click.echo("=" * 50)
+    click.echo(f"  总执行:   {result.total}")
+    click.echo(f"  成功:     {result.success}")
+    click.echo(f"  失败:     {result.failed}")
+    click.echo(f"  耗时:     {result.duration:.1f}s")
+    click.echo(f"  成功率:   {result.success_rate:.1%}")
+    click.echo("=" * 50)
+
+    if result.failed_hosts:
+        click.echo()
+        click.echo(click.style("失败主机:", fg="red"))
+        for host in result.failed_hosts:
+            host_result = result.results[host]
+            error_msg = host_result.error or f"exit_code={host_result.exit_code}"
+            click.echo(
+                click.style(
+                    f"  ✗ {host}: {error_msg}",
+                    fg="red",
+                )
+            )
+
+    if not show_failures and result.success_hosts:
+        click.echo()
+        click.echo(click.style("成功主机:", fg="green"))
+        for host in result.success_hosts:
+            click.echo(click.style(f"  ✓ {host}", fg="green"))
+
+    if result.failed > 0:
+        ctx.exit(1)
+
+
+def main():
+    """CLI 程序入口点"""
+    cli()
+
+
+if __name__ == "__main__":
+    main()

remote_cmd/core/__init__.py

@@ -0,0 +1 @@
+"""Core module for SSH operations."""