A FTP server based on I2TCP


Keywords
clean-code, ftp-server, pypi-package, python3
License
MIT
Install
pip install i2ftps==0.3.4

Documentation

介绍

本项目为一款基于I2TCP通讯协议 的文件传输服务器, 有效密钥长度达到512bit,同时嵌有类Google双重认证机制, 确保服务能在公网环境下安全存活。

特性

  • 支持文件断点续传
  • 支持文件哈希校验
  • 仅允许访问设定目录下的文件
  • 可设置只读模式
  • 512 bits有效密钥长度
  • 动态token身份认证
  • 可选TLS加 密

安装方法

pip install i2ftp-server

环境需求

  • Python3.6+
  • i2cylib >= 1.8.14

集成命令

  • i2ftps-setup 服务器配置向导
  • i2ftps 服务器启动/停止

默认配置文件路径

/usr/share/i2ftp/server_conf.json

附:通讯协议说明

通讯流程:

  1. 客户端与服务器建立TCP连接
  2. 客户端与服务器建立I2TCP连接
  3. 服务器发送版本号 b"I2FTP x.x"
  4. 客户端发送User指令
  5. 服务器响应User指令

协议结构:

底层 TCP/IPI2TCPUser 顶层

User层数据包:

  • 客户端命令 - “查询”:LIST,<PATH>

    • 返回:<bool 路径是否存在>,{'文件1':{is_dir:<bool 是否是文件夹> size:<int 大小>, time:<float 文件修改时间戳>}}
  • 客户端命令 - “请求下载”:GETF,<PATH>

    • 返回:<bool 请求是否接受>,[16 bytes 下载会话ID]
  • 客户端命令 - “通过会话ID下载”:DOWN,<16 bytes 下载会话ID>,<uint64 文件指针偏移量>,<uint64 截止文件指针偏移量>

    • 若单个返回包无法一次传输请求的长度,服务器会依次发送多个数据包,直到满足请求的长度为止。

    • 截止文件指针偏移量文件指针偏移量,则服务器会认为是请求了从文件指针偏移量开始到文件末尾的数据。

    • 返回:<bool 操作是否有效>,[uint64 文件指针偏移量],[bytes 数据内容 最大长度524128 Bytes] (单个或序列)

  • 客户端命令 - “请求上传”:PULF,<PATH>,<str_hex 文件哈希校验值>

    • 返回:<bool 操作是否有效>,[16 bytes 上传会话ID]
  • 客户端命令 - “通过会话ID上传”:UPLD,<16 bytes 上传会话ID>,<uint64 文件指针偏移量>,<bytes 数据内容 最大长度524128 Bytes>

    • 返回:<bool 上传是否成功>,[int 当前文件指针偏移量]
  • 客户端命令 - “关闭会话”:CLOZ,<16 bytes 会话ID>

    • 返回:<bool 操作是否成功>,[hex_str 若会话为下载会话,则会同时返回文件的MD5校验值]
  • 客户端命令 - “文件/文件夹操作”:FIOP,<int 命令:0-重命名,1-移动,2-复制,3-删除,4-创建目录>,<str 路径1>,[str 路径2]

    • 返回:<bool 操作是否成功>
  • 管理员命令 - “进程控制”:PCTL,[raw 保留字段]

    • 返回:<bool 操作是否成功>,<int 进程PID>