Guardian/CoverDrop 项目 REST API 规范详解
2025-06-10 06:52:22作者:丁柯新Fawn
项目概述
Guardian/CoverDrop 是一个安全通信系统,提供了一套完整的 REST API 接口,用于用户端和记者端的安全数据传输。该系统采用了严格的签名验证机制,确保所有数据交换的安全性。
API 设计原则
- 严格的身份验证:所有修改资源的请求都必须使用签名表单
- 清晰的权限划分:API 路径明确区分用户端(
/user/
)和记者端(/journalist/
) - 版本控制:所有 API 都带有版本前缀(
/v1/
) - 错误处理标准化:统一的错误响应格式
签名表单机制
CoverDrop 系统要求所有修改数据库资源的请求都必须使用签名表单。这种机制确保了请求的完整性和真实性。
签名表单结构
{
"body": "<base64编码的JSON对象>",
"signature": "<hex编码的签名>",
"timestamp": "<UTC时间戳>",
"signing_pk": "<hex编码的签名公钥>"
}
验证流程
- 服务器接收请求后,首先验证签名是否有效
- 检查时间戳是否在有效期内
- 验证签名公钥是否存在于密钥库中
常见错误响应
401 未授权
{
"error": "signature verification failed"
}
404 未找到
{
"error": "Signing key not found in key repository, it is either expired or never existed"
}
核心 API 端点详解
1. 系统状态检查
GET /v1/healthcheck
- 用途:基础健康检查
- 响应示例:
{
"name": "api",
"status": "ok",
"commit": "45b61edc158ac02908c88c2ce944556cc9d8f4df",
"branch": "main"
}
GET /v1/status
- 用途:获取系统运行状态
- 状态值:
AVAILABLE
:系统正常运行UNAVAILABLE
:系统不可用DEGRADED_PERFORMANCE
:性能下降SCHEDULED_MAINTENANCE
:计划维护中NO_INFORMATION
:无系统状态信息
POST /v1/status
- 用途:更新系统状态
- 权限:需要管理员密钥对
- 请求示例:
{
"body": "eyJzdGF0dXM...",
"signature": "c41127d0f54...",
"timestamp": "2024-01-04T17:19:01.820879Z",
"signing_pk": "cb516f4dcf3f..."
}
2. 日志管理
POST /v1/logging
- 用途:动态调整日志级别
- 使用场景:调试时无需重启服务即可获取详细日志
- 权限:需要管理员密钥对
3. 公钥管理
GET /v1/public-keys
- 用途:获取所有公钥信息
- 返回内容:
- 组织公钥
- CoverNode 身份公钥
- CoverNode 消息公钥
- 所有记者公钥
- 已注册记者信息
- 默认记者ID(可选)
公钥操作端点
CoverDrop 系统提供了完整的公钥生命周期管理:
-
记者公钥管理:
POST /v1/public-keys/journalists
- 添加记者信息DELETE /v1/public-keys/journalists/delete
- 删除记者PATCH /v1/public-keys/journalists/update-profile
- 更新记者信息
-
CoverNode 公钥管理:
- 配置公钥:
POST /v1/public-keys/covernode/provisioning-public-key
- 身份公钥:
POST /v1/public-keys/covernode/identity-public-key
- 消息公钥:
POST /v1/public-keys/covernode/messaging-public-key
- 配置公钥:
-
记者端公钥管理:
- 配置公钥:
POST /v1/public-keys/journalist/provisioning-public-key
- 身份公钥:
POST /v1/public-keys/journalist/identity-public-key
- 消息公钥:
POST /v1/public-keys/journalist/messaging-public-key
- 配置公钥:
4. 用户端接口
死信投递(Dead Drops)管理
GET /v1/user/dead-drops
- 获取死信投递记录POST /v1/user/dead-drops
- 创建新的死信投递
5. 记者端接口
死信投递管理
GET /v1/journalist/dead-drops
- 记者获取死信投递记录POST /v1/journalist/dead-drops
- 记者创建死信投递
安全最佳实践
- 密钥轮换:系统会检测密钥轮换频率,防止过于频繁的更换
- 请求时效性:所有请求都必须包含有效时间戳
- 最小权限原则:不同操作需要不同级别的密钥对授权
- 错误信息最小化:错误响应不泄露系统内部细节
常见问题解答
Q: 为什么我的签名请求被拒绝? A: 可能原因:1) 签名验证失败 2) 时间戳过期 3) 签名公钥不存在或已过期
Q: 如何获取系统当前状态?
A: 使用 GET /v1/status
端点,无需认证即可获取系统状态信息
Q: 记者信息更新失败可能是什么原因? A: 常见原因:1) 描述过长 2) 签名无效 3) 权限不足
通过本文的详细解读,开发者可以全面了解 Guardian/CoverDrop 项目的 REST API 设计理念和使用方法,为系统集成和二次开发提供参考。
登录后查看全文
热门项目推荐
PaddleOCR-VL
PaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
openPangu-Ultra-MoE-718B-V1.1
昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0134AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile011
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
23
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
231
2.31 K

仓颉编译器源码及 cjdb 调试工具。
C++
112
76

React Native鸿蒙化仓库
JavaScript
216
290

暂无简介
Dart
532
117

仓颉编程语言运行时与标准库。
Cangjie
122
93

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
991
587

Ascend Extension for PyTorch
Python
74
103

仓颉编程语言测试用例。
Cangjie
34
60

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
401