ohos_ssh

第一部分：项目背景与战略目标
ohos_ssh 是一个基于 libssh 封装的 OpenHarmony 三方库，提供 SFTP 服务端与 SSH 客户端能力，属于典型的后端安全通信基础设施。在仓颉生态中，亟需一个内存安全、高并发、强类型的原生 SSH 协议实现，以替代现有 C/C++ 底层依赖，规避 CVE 漏洞风险（如 OpenSSL 相关漏洞）。本项目将利用仓颉语言 1.0.0+ 的核心优势——编译期内存安全、轻量级线程模型、强类型系统及 CJNative 高性能 FFI 能力，构建一个可嵌入微服务、边缘设备或云原生环境的纯仓颉 SSH/SFTP 后端库，为 OpenHarmony 及通用后端场景提供可信、高效、自主可控的安全通信基座。

第二部分：核心功能需求与技术规格

2.1 功能模块分解

2.2 非功能性需求规范

• 性能指标：P99 连接建立延迟 < 15ms，SFTP 文件传输吞吐量 ≥ 80% 原生 libssh 水平（对比基准环境）。

• 安全要求：完全杜绝空指针解引用、缓冲区溢出、Use-After-Free 等内存安全问题；所有密钥操作在安全内存区域进行。

• 可靠性：网络中断、服务端异常等场景下自动清理资源，无僵尸连接；错误路径全覆盖。

• 可维护性：模块解耦清晰，支持算法插件化；接口设计符合仓颉惯用法（idiomatic Cangjie）。

2.3 核心接口设计示例 (伪代码)

interface SshService {
    // 启动 SFTP 服务端
    fn startSftpServer(
        privateKeyPath: String,
        port: Int32,
        config: SshConfig
    ): Result<Void, SshError>

    // 执行远程命令（SSH 客户端）
    async fn executeCommand(ip: String, port: Int32, cmd: String): Result<String, SshError>

    // 生成密钥对
    fn generateKeyPair(
        algo: KeyAlgorithm,
        privPath: String,
        pubPath: String
    ): Result<Void, SshError>
}

enum SshError {
    ConnectionFailed(String),
    AuthRejected,
    InvalidKeyFormat,
    ProtocolViolation,
    IoError(IoError)
}

enum KeyAlgorithm {
    Ecdsa,
    Rsa4096
}

第三部分：项目交付物与实施路线图

3.1 阶段性交付物清单

• 第一阶段：核心协议解析、密钥管理、基础 SFTP/SSH 客户端功能 + 单元测试（覆盖率≥95%）+ 接口文档

• 第二阶段：高并发连接池、异步 I/O 优化、算法协商引擎 + 集成测试（与 OpenSSH 互操作）+ 压测报告

• 第三阶段：性能调优报告、生产级部署指南（含 Docker 示例）、cjpm 发布包（支持 OpenHarmony 与标准 Linux）

3.2 项目实施路线图

第四部分：技术实现规范与质量认证体系

4.1 仓颉语言专项质量规范

• 100% 通过 cjfmt 格式校验，禁止手动格式调整。

• 所有外部交互使用强类型接口，禁止 any 或隐式转换。

• 错误必须通过 Result<T, E> 或显式 throws 声明，禁止 panic 用于业务逻辑。

4.2 测试与验证标准

• 单元测试覆盖所有 public 接口及边界条件，行覆盖率 ≥95%。

• 建立 SSH 协议模糊测试（fuzzing）套件，持续监控协议解析鲁棒性。

• 使用仓颉内置 sanitizer 工具链进行内存安全验证。

4.3 文档与可维护性

• 所有 public 函数/类型需包含 Doc Comments，说明参数、错误码、线程安全级别。

• 记录关键决策（如为何选择特定加密库绑定方式）至 ADR 文档。

• 提供 CONTRIBUTING.md 明确构建、调试、PR 提交流程。

4.4 持续集成质量门禁

cjpm fmt --check
cjpm build --release
cjpm lint --deny-warnings
cjpm test --all-features --coverage
cjpm bench --baseline=libssh-v0.11.1

第五部分：技术栈与开发环境

• 核心语言：仓颉编程语言（Cangjie Language）1.0.0+（强制）

• 构建与包管理：CJPM (Cangjie Package Manager)

• 测试框架：仓颉原生测试框架（支持 async/await 测试）

• 质量工具：cjfmt, cjpm lint, cjpm bench, cj-sanitizer

• 环境要求：Linux/macOS 开发环境，CI 使用 cangjie-lang/cjci:1.0 官方 Docker 镜像

交付件

验收标准

1.功能

1. 三方库必须有明确的功能；

2. 如果参考对标库移值开发，功能与参考三方库保持一致。

2.资料

1. Readme：包含简介，软件架构，目录结构，下载安装（编译构建），接口说明，使用示例，约束限制，开源协议，参与贡献等内容；

2. Changelog，三方库版本需包含基本的修改说明。

3.标准遵从性（可选），三方库实现需满足对应协议或行业标准，举例

1. appquth：支持对OAuth 的PKCE扩展；

2. icu4j：支持unicode标准库，通用字符集ISO/IEC 10646。

4.性能目标

1. 性能敏感三方库接口运行性能持平对标三方库

5.开源协议遵从，必须包含License文件

1. 放置合适的开源License协议，建议Apache License Version 2.0；

2. 引用或参考开源三方库，需遵从开源协议。

6.网络安全要求

1. 满足基础的网络安全红线及隐私要求，符合安全编码规范。

过程质量要求