Skip to content

TYEclipse/p2p_time_sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

p2p_time_sync

轻量级的 Peer-to-Peer 时间同步库与示例工具(Python + asyncio + UDP)。

一个演示如何在对等网络中通过交换时间戳估计时钟偏移并收敛的项目;可选支持消息签名(PyNaCl)。


简介

  • 目标:在不依赖集中式时间服务器的情况下,通过点对点时间戳交换实现时钟偏移估计与收敛。
  • 实现要点:asyncio + UDP、采样与延迟过滤、稳健聚合(修剪中位数)、EMA 平滑、可选消息签名。

特性

  • 轻量 P2P 时间同步协议
  • 多次采样、延迟过滤与修剪聚合
  • EMA(指数移动平均)平滑逻辑时钟偏移
  • 可选的消息签名/校验(使用 PyNaCl)
  • 可配置采样参数与超时行为

快速开始

  1. 克隆仓库并进入目录:
git clone https://github.com/TYEclipse/p2p_time_sync.git
cd p2p_time_sync
  1. 推荐使用虚拟环境:
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
# 可选:启用消息签名功能
pip install pynacl
  1. 运行示例 peer(在不同终端启动两个或多个实例):
  • 启动 peer A

    python3 p2p_time_sync.py --port 8000 --peer 127.0.0.1:8001
  • 启动 peer B

    python3 p2p_time_sync.py --port 8001 --peer 127.0.0.1:8000
  • 如果只想监听本地接口:

    python3 p2p_time_sync.py --host 127.0.0.1 --port 8000 --peer 127.0.0.1:8001

协议概览(JSON 报文)

REQ(请求):

{
  "type": "REQ",
  "nonce": "<随机字符串>",
  "from": "<peer_id>",
  "ts": 1620000000.123  // 发送时的本地 wall clock 时间
}

RESP(响应):

{
  "type": "RESP",
  "nonce": "<相同的随机字符串>",
  "from": "<peer_id>",
  "t1": 1620000000.200,  // 服务器接收请求时的 wall 时间
  "t2": 1620000000.205,  // 服务器发送响应时的 wall 时间
  "sig": "<hex signature>", // 可选(启用 PyNaCl 时)
  "vk": "<hex verify key>"  // 可选(发送方的公钥)
}

时间估计算法(与 NTP 类似)

  • 本地发送时间 t0(wall)
  • 远端接收时间 t1(远端 wall)
  • 远端发送时间 t2(远端 wall)
  • 本地接收时间 t3(wall)

使用四个时间戳估计:

  • theta(时钟偏移) = ((t1 - t0) + (t2 - t3)) / 2
  • delta(往返延迟) = (t3 - t0) - (t2 - t1)

实现细节(简要)

  • 对每个 peer 做多次采样,选择延迟较小的样本作为代表。
  • 对 offset 集合做修剪(trim)并取中位数或修剪后的中位数作为聚合值。
  • 使用 EMA 平滑更新本地逻辑偏移:offset = (1-α)offset + αtheta_star。
  • 使用 monotonic 时间检测本地 wall clock 跳变以排除异常样本。

消息签名(可选)

  • 若安装 PyNaCl,节点会生成 SigningKey/VerifyKey,在 RESP 中附带 vk 与 sig,接收方校验签名防止伪造。
  • 当前实现为运行时生成临时签名密钥;可扩展为持久化密钥以便长期识别。

配置选项(可在 p2p_time_sync.py 中调整)

  • host: 本地监听地址(默认 0.0.0.0)
  • port: 本地监听端口(必需)
  • --peer: 指定对等节点(host:port,可重复)
  • samples_per_peer: 每个 peer 的探测次数(默认 3)
  • per_round_peer_count: 每轮探测的 peer 上限(默认 20)
  • request_timeout: 单次请求超时时间(秒,默认 5.0)
  • round_interval: 每轮探测间隔(秒,默认 60.0)
  • ema_alpha: EMA 平滑系数(默认 0.3)
  • trim_ratio: 修剪比例用于计算稳健中位数(默认 0.15)
  • min_samples_for_update: 更新偏移所需的最小样本数(默认 5)

日志与调试

  • 使用 Python 标准 logging,模块使用 module-level logger(p2p_time_sync)。
  • 新增的日志点包含:
    • Datagram 接收时的源地址与原始字节长度(debug)
    • 收发请求/响应时的 nonce、时间戳 t0/t1/t2/t3、theta、delta、rtt(debug)
    • 响应签名校验成功/失败信息(warning/debug)
    • 每轮采样统计(样本数、延迟过滤阈值、theta_star)和偏移更新的旧/新值(info)
  • 建议命令行(启用 DEBUG 输出):
python -c "import logging; logging.basicConfig(level=logging.DEBUG)" && python3 p2p_time_sync.py --port 8000
  • 常见调试场景:
    • 若看到大量 "Timeout waiting for nonce":检查网络连通性、防火墙与对端是否在线。
    • 若看到 "Signature verification failed":确认对端与本端签名库一致(PyNaCl),或查看 vk/sig 是否被篡改。
    • 若看到偏移不收敛:查看每轮日志中的 theta_star、样本数与延迟分位,判断是否网络延迟波动过大或样本不足。

使用脚本启动与停止节点(run_nodes.sh / stop_nodes.sh)

仓库中提供了两个便捷脚本用于在同一台机器上快速启动/停止多节点用于本地测试:

  • run_nodes.sh:在当前目录下启动多个 p2p_time_sync.py 实例,写入日志和 pid 文件到 logs/
  • stop_nodes.sh:根据 logs/ 下的 .pid 文件尝试结束对应进程并清理 pid 文件。

主要要点:

  • 脚本位置:仓库根目录(与 p2p_time_sync.py 同级)。
  • 日志目录:logs/(脚本会自动创建)。每个节点会在 logs/node_<port>.log 中写日志,pid 文件为 logs/node_<port>.pid
  • 启动方式:run_nodes.sh 使用 nohup + python3 -c "... runpy.run_path(...)" 启动每个节点的独立进程,并通过 logging.basicConfig(level=logging.DEBUG) 将日志级别设为 DEBUG(仅用于本地调试)。
  • 停止方式:stop_nodes.sh 读取 logs/*.pid,对存在的 pid 发送 kill,并删除 pid 文件。如果进程已不存在,会直接删除对应 pid 文件并输出提示。

环境变量与可定制参数(运行前可在命令前设置或导出):

  • NODE_COUNT:要启动的节点数量,默认 40
  • START_PORT:起始端口号,默认 8000(节点将依次使用 START_PORT, START_PORT+1, ...)。
  • HOST:绑定/连接的主机地址,默认 127.0.0.1

快速示例:

  • 使用默认参数启动(在仓库根目录执行):
./run_nodes.sh
  • 指定 5 个节点、起始端口为 9000:
NODE_COUNT=5 START_PORT=9000 ./run_nodes.sh
  • 停止所有由脚本启动的节点:
./stop_nodes.sh

调试与故障排查:

  • 若某些端口被占用,run_nodes.sh 启动对应节点时可能失败,检查 logs/node_<port>.log 以获取启动时的错误信息。
  • 若发现节点未写入日志或 .pid 文件未创建,确认脚本具有可执行权限:
chmod +x run_nodes.sh stop_nodes.sh
  • stop_nodes.sh 未能结束进程,可手动通过 ps/kill 定位并结束:
ps aux | grep p2p_time_sync.py
kill <pid>
  • 注意:这些脚本仅用于本地测试与演示。脚本会把所有节点配置为相互为 peers(使用 localhost + 一系列端口),不适合直接在生产环境或跨主机集群中使用。

如果需要更复杂的集群部署或在多台机器上运行,请参考 README 中的“快速开始”章节,用系统服务管理器(systemd/docker/kubernetes 等)或编写更健壮的启动器来管理进程与日志。

示例用例(本地模拟)

  • 在同一台机器上用不同端口运行多个 peer,可观察 offset 收敛。
  • 若有网络延迟波动,算法通过延迟过滤与修剪保持稳健性。

贡献

  • 欢迎 PR:修复 bug、持久化签名密钥、改进发现/引导机制、增加测试与 CI。
  • 请先打开 issue 讨论较大设计变更,或在 PR 描述中说明修改内容。

联系方式

免责声明

  • 本项目为教育/演示用途;在对安全或准确性要求极高的生产环境中请慎用,并结合更成熟的时钟同步方案(如 NTP/PTP/专用硬件)。

About

基于点对点(P2P)网络的分布式时间同步工具,用于在无中心节点的网络中实现节点间的高精度时钟校准。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors