diff --git a/README.md b/README.md index 0b9e22b..c59afa6 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,75 @@ IntraGate 是一个高性能的内网穿透系统，旨在为企业和开发者提供安全、可靠的内网资源访问解决方案。通过先进的连接管理和流量转发技术，IntraGate 使得内部网络资源可以被安全地暴露于公网，而无需改变现有的网络结构。系统支持多种认证机制，确保只有授权用户能够访问内网服务。此外，IntraGate 还提供流量控制、负载均衡和日志记录等高级功能，帮助企业优化资源使用效率，增强系统稳定性。 -## 1. 基础架构搭建 -- 🛠️ **需求分析**：确定系统需支持的内网协议、最大连接数、安全要求等。[更多](./doc/requirements_analysis.md) -- [ ] **技术选型**：选择合适的编程语言（zig）、网络库和工具。 -- [ ] **架构设计**：设计模块化的架构，包括客户端管理、认证、数据传输等模块。 -- [ ] **环境搭建**：设置开发环境、版本控制（如Git）和持续集成工具。 -## 2. 核心功能实现 -- [ ] **连接管理**：实现客户端与服务端之间的稳定连接，包括重连机制和心跳检测。 -- [ ] **认证机制**：设计安全的认证流程，如基于Token或证书的认证。 -- [ ] **流量转发**：实现内网流量的捕获、封装和转发至指定客户端。 -- [ ] **配置管理**：开发配置接口，允许动态调整系统参数。 +## IntraGate实现Roadmap -## 3. 高级功能和性能优化 -- [ ] **流量控制**：实现流量控制，如速率限制和优先级处理，以保证服务质量。 -- [ ] **负载均衡**：部署多个服务节点，根据负载情况动态分配连接。 -- [ ] **日志记录**：详细记录操作日志，用于故障排查和性能分析。 +### 第一阶段：基础知识储备 (预估时间：2 周) -## 4. 安全性强化和测试 -- [ ] **安全审计**：检查代码安全漏洞，使用工具如OWASP ZAP进行安全审计。 -- [ ] **全面测试**：进行功能测试、压力测试和安全性测试，确保系统稳定性和安全性。 -- [ ] **代码审查**：团队成员间进行代码审查，提升代码质量和发现潜在问题。 +- **网络协议：** + - 深入理解 TCP/UDP 协议，掌握三次握手、四次挥手等核心概念。 + - 熟悉 HTTP/HTTPS 协议，了解请求方法、状态码、头部字段等。 +- **编程语言：** + - 选择并熟练掌握一门编程语言（Zig, C）。 + - 学习网络编程基础，掌握 Socket 编程、多线程/协程等知识。 +- **数据结构与算法：** + - 复习常用数据结构（数组、链表、哈希表等）和算法（排序、查找等）。 -## 5. 部署和维护 -- [ ] **准备部署文档**：编写详细的安装和配置手册。 -- [ ] **用户反馈和问题修复**：建立反馈机制，快速响应用户问题，定期更新修复补丁。 -- [ ] **持续迭代和优化**：根据市场反馈和技术发展，持续优化产品功能和性能。 +### 第二阶段：需求分析与设计 (预估时间：1 周) + +- **核心功能：** + - 细化端口映射、反向代理、协议支持、配置管理等功能需求。 +- **性能要求：** + - 确定并发连接数、延迟、可扩展性等性能指标。 +- **安全性：** + - 明确数据加密、认证授权等安全需求。 +- **概要设计：** + - 划分模块（配置、代理、协议、加密、认证、日志）。 + - 设计数据结构（端口映射表、连接池）。 + - 确定算法流程（客户端连接、协议解析、端口映射、反向代理、加密传输、认证授权）。 + +### 第三阶段：详细设计 (预估时间：2 周) + +- **配置模块：** + - 设计配置文件格式，支持命令行参数覆盖。 + - 实现配置文件读取和解析功能。 +- **代理模块：** + - 实现端口监听、连接建立、请求转发、响应返回功能。 + - 设计并实现连接池。 +- **协议模块：** + - 实现 TCP 和 UDP 协议的解析和封装。 +- **加密模块：** + - 选择并集成加密库（OpenSSL 等）。 + - 实现 TLS/SSL 握手和数据加密解密。 +- **认证模块：** + - 设计用户认证方案（用户名密码、Token 等）。 + - 实现用户认证和访问控制。 +- **日志模块：** + - 实现日志记录功能，支持不同级别的日志输出。 + +### 第四阶段：编码实现 (预估时间：4 周) + +- **搭建开发环境：** + - 安装编程语言环境和相关工具。 +- **编写代码：** + - 按照详细设计文档，逐步实现各个模块功能。 +- **单元测试：** + - 编写单元测试用例，确保每个模块功能正确。 +- **集成测试：** + - 将各个模块组合起来，进行端到端测试。 + +### 第五阶段：优化与改进 (预估时间：2 周) + +- **性能优化：** + - 使用多线程/协程、缓存、更高效的算法等手段提升性能。 +- **功能扩展：** + - 支持更多协议、负载均衡、故障转移、自定义插件等。 + +### 第六阶段：部署与运维 (预估时间：1 周) + +- **选择服务器环境：** + - 考虑云服务器或自建服务器。 +- **编写部署脚本：** + - 实现自动化部署。 +- **监控与维护：** + - 建立监控机制，及时发现并处理异常情况。 diff --git a/doc/requirements_analysis.md b/doc/requirements_analysis.md index de71990..3caf5f0 100644 --- a/doc/requirements_analysis.md +++ b/doc/requirements_analysis.md @@ -1,89 +1,109 @@ # IntraGate 内网穿透系统需求分析 -## 服务端需求 +## 服务端需求(IntraGate Server Side) -###功能性需求 +### 基础知识储备 -* **高性能的数据处理能力**： - * 服务器应采用高性能的网络编程框架（如Netty、libuv），支持异步I/O操作和事件驱动模型，以充分利用服务器资源，提高并发处理能力。 - * 服务器应支持连接池和线程池等技术，以便有效管理连接和线程资源，避免资源浪费和性能瓶颈。 - * 服务器应支持数据缓存机制，对频繁访问的数据进行缓存，减少数据库或文件系统的访问次数，提高响应速度。 -* **多种认证方式**： - * 服务器应支持密码认证、Token 认证和证书认证等多种认证方式，以满足不同安全级别和应用场景的需求。 - * 对于密码认证，服务器应采用安全的密码存储方式（如 bcrypt、scrypt），并对密码进行加盐处理，防止密码泄露。 - * 对于 Token 认证，服务器应生成具有时效性的 Token，并定期更新 Token，以防止 Token 被盗用。 - * 对于证书认证，服务器应验证证书的有效性和合法性，并支持证书吊销列表（CRL）和在线证书状态协议（OCSP）等机制。 -* **灵活的访问控制**： - * 服务器应支持基于角色的访问控制（RBAC）模型，可以根据用户的角色分配不同的权限。 - * 服务器应支持细粒度的访问控制，可以针对不同的内网资源设置不同的访问权限。 - * 服务器应支持 IP 白名单和黑名单机制，限制特定 IP 地址的访问。 -* **高效的数据转发**： - * 服务器应支持端口映射、反向代理和隧道等多种数据转发方式，以适应不同的网络环境和应用需求。 - * 服务器应具备智能路由功能，可以根据网络状况和负载情况选择最佳的转发路径。 - * 服务器应支持数据包过滤和流量控制，防止恶意流量和攻击。 -* **多协议支持**： - * 除了 TCP 和 UDP 协议外，服务器还应支持 HTTP、HTTPS、FTP、SSH 等常用协议，以满足不同应用场景的需求。 - * 服务器应支持自定义协议扩展，方便用户根据自己的需求添加新的协议支持。 +在开始之前，需要掌握以下基础知识 -### 性能需求 +1. **网络协议：** + - TCP/UDP：了解两种传输协议的特点，熟悉三次握手、四次挥手等概念。 + - HTTP/HTTPS：了解 Web 服务的基本原理，熟悉请求和响应的格式。 -* **高并发处理能力**：服务器应能同时处理大量并发连接，例如，支持至少 5000 个并发连接，确保在高负载情况下系统的稳定性和响应速度。 -* **低延迟**：服务器应尽可能减少数据传输过程中的延迟，例如，通过优化网络传输路径、减少数据包处理时间等方式，保证数据的实时性和用户体验。 -* **高吞吐量**：服务器应具备高吞吐量的数据处理能力，例如，支持每秒至少 1Gbps 的数据传输速率，满足大文件传输和高带宽应用的需求。 +2. **编程语言：** + - 选择一门您熟悉的编程语言（如 Go、Python、Java、Zig等）。 + - 掌握基本的网络编程知识（如 Socket 编程、多线程/协程）。 -### 可用性需求 -* **高可用性架构**：服务器应采用高可用性架构，例如，主从复制、负载均衡、集群等，确保在单点故障或服务器宕机的情况下，系统仍能正常运行。 -* **故障恢复机制**：服务器应具备故障恢复机制，例如，自动检测故障、自动切换备用服务器、自动恢复数据等，最大限度地减少故障对业务的影响。 -* **可扩展性**：服务器应具备良好的可扩展性，例如，支持水平扩展和垂直扩展，以便根据业务需求灵活调整服务器的处理能力。 +3. **数据结构与算法：** + - 了解常用的数据结构（如数组、链表、哈希表）和算法（如排序、查找）。a -### 扩展性与维护性需求 -* **插件化架构**：服务器应采用插件化架构，可以方便地添加、删除和更新功能模块，提高系统的灵活性和可扩展性。 -* **RESTful API**：提供全面的 RESTful API，覆盖服务器的各项功能，方便管理员通过 API 对服务器进行配置、管理和监控。 -* **详细的 API 文档**：提供清晰、详细的 API 文档，包括 API 的功能描述、请求参数、响应结果、错误码等，方便开发者理解和使用 API。 +### 需求分析 -### 安全性需求 -* **防火墙**：服务器应配置防火墙，限制对服务器的访问，只允许特定的端口和协议通过。 -* **入侵检测系统（IDS）**：部署 IDS，实时监控服务器的网络流量，检测并报警潜在的入侵行为。 -* **安全审计**：定期对服务器进行安全审计，检查系统漏洞和安全风险。 +1. **核心功能：** + - 端口映射：将内网端口映射到公网端口。 + - 反向代理：将公网请求转发到内网服务。 + - 协议支持：支持 TCP 和 UDP 协议。 + - 配置管理：支持配置文件或命令行参数配置。 -### 监控与报警 -* **实时监控**：服务器应提供实时监控界面，显示系统的运行状态、性能指标、连接情况、日志信息等，方便管理员及时了解系统状况。 -* **自定义报警规则**：服务器应支持自定义报警规则，例如，当 CPU 占用率超过 80%、内存使用率超过 90%、连接数超过 10000 时发送报警通知。 -* **多种报警方式**：服务器应支持多种报警方式，例如，邮件、短信、微信等，确保管理员能够及时收到报警信息。 +2. **性能要求：** + - 高并发：能同时处理大量连接请求。 + - 低延迟：尽量减少请求转发过程中的延迟。 + - 可扩展：能方便地增加服务器节点。 -### 客户端需求 +3. **安全性：** + - 数据加密：支持 TLS/SSL 加密传输。 + - 认证授权：支持用户认证和访问控制。 -### 功能性需求 +### 概要设计 -* **连接稳定性**： - * **断线重连**：客户端应具备断线重连功能，在网络连接中断时自动尝试重新连接服务器，并支持自定义重连间隔和次数。 - * **心跳机制**：客户端应支持心跳机制，定期向服务器发送心跳包，保持连接活跃，并及时发现连接中断的情况。 -* **多协议支持**： - * 客户端应支持 TCP 和 UDP 协议，并能根据用户的选择或自动检测，选择合适的协议进行数据传输。 - * 客户端还应支持 HTTP、HTTPS、FTP 等常用协议的代理功能，方便用户访问内网资源。 -* **数据压缩与加密**： - * 客户端应支持可配置的数据压缩功能，在网络带宽有限的情况下，通过压缩数据来提高传输效率。 - * 客户端应支持多种加密算法，如 AES、DES 等，对传输的数据进行加密，保障数据安全。 +1. **模块划分：** + - 配置模块：读取并解析配置文件。 + - 代理模块：负责端口映射和反向代理。 + - 协议模块：处理 TCP 和 UDP 协议。 + - 加密模块：实现 TLS/SSL 加密传输。 + - 认证模块：实现用户认证和访问控制。 + - 日志模块：记录程序运行日志。 -### 易用性需求 +2. **数据结构：** + - 端口映射表：存储内网端口和公网端口的映射关系。 + - 连接池：管理客户端和服务器之间的连接。 -* **友好的用户界面**：客户端应提供简洁、直观的图形化用户界面，方便用户进行配置和操作。 -* **清晰的状态显示**：客户端应实时显示当前的连接状态、传输速度、流量统计等信息，让用户了解连接情况。 -* **操作便捷性**：客户端应支持快捷键、拖拽等操作方式，提高用户操作效率。 -* **多平台支持**：客户端应支持 Windows、macOS、Linux 等主流操作系统，满足不同用户的需求。 +3. **算法流程：** + - 客户端连接：接收客户端连接请求，建立 TCP 连接。 + - 协议解析：解析客户端请求协议，获取目标地址和端口。 + - 端口映射：根据映射表找到对应的内网地址和端口。 + - 反向代理：建立与内网服务器的连接，转发请求和响应。 + - 加密传输：对数据进行加密解密。 + - 认证授权：验证用户身份和权限。 -### 性能需求 +### 详细设计 -* **低资源占用**：客户端应尽可能减少对系统资源（CPU、内存、网络带宽）的占用，避免影响用户计算机的正常运行。 -* **快速响应**：客户端应具有快速的响应速度，及时响应用户的操作和网络事件。 +1. **配置模块：** + - 设计配置文件格式（如 INI、YAML、JSON）。 + - 实现配置文件读取和解析功能。 + - 支持命令行参数覆盖配置文件。 -### 安全性需求 +2. **代理模块：** + - 实现端口监听和连接建立功能。 + - 实现请求转发和响应返回功能。 + - 实现连接池管理功能，包括连接创建、复用、超时关闭等。 -* **本地数据保护**：客户端应保护用户的本地数据，例如配置文件、日志文件等，防止未经授权的访问和篡改。 -* **安全更新**：客户端应支持自动更新或手动更新，及时修复安全漏洞，保障用户数据安全。 +3. **协议模块：** + - 实现 TCP 和 UDP 协议的解析和封装功能。 + - 处理协议中的特殊字段（如 HTTP 头部）。 -### 扩展性与维护性需求 +4. **加密模块：** + - 集成 OpenSSL 或其他加密库。 + - 实现 TLS/SSL 握手和数据加密解密功能。 -* **插件化架构**：客户端应采用插件化架构，支持用户自定义插件，扩展客户端功能。 -* **日志记录**：客户端应详细记录日志信息，包括连接状态、操作记录、错误信息等，方便用户排查问题。 -* **崩溃报告**：当客户端崩溃时，应自动生成崩溃报告，并提供上传功能，方便开发者分析和解决问题。 +5. **认证模块：** + - 设计用户认证方案（如用户名密码、Token）。 + - 实现用户认证和访问控制功能。 + +6. **日志模块：** + - 实现日志记录功能，记录程序运行信息、错误信息等。 + - 支持不同级别的日志输出（如 DEBUG、INFO、ERROR）。 + +### 编码实现 + +1. **选择编程语言和开发环境。** +2. **按照详细设计文档编写代码。** +3. **进行单元测试和集成测试。** + +### 优化与改进 + +1. **性能优化：** + - 使用多线程/协程提高并发处理能力。 + - 使用缓存减少重复计算。 + - 使用更高效的数据结构和算法。 + +2. **功能扩展：** + - 支持更多的协议（如 FTP、SMTP）。 + - 支持负载均衡和故障转移。 + - 支持自定义插件扩展功能。 + +### 部署与运维 + +1. **选择合适的服务器环境。** +2. **编写部署脚本或使用自动化工具。** +3. **监控服务器运行状态，及时处理异常情况。**