umputun/secrets

Safe Secrets - 更安全、简单的密码传输方式

https://github.com/umputun/secrets/workflows/build/badge.svg](https://github.com/umputun/secrets/actions) https://goreportcard.com/badge/github.com/umputun/secrets](https://goreportcard.com/report/github.com/umputun/secrets) ![覆盖率状态]([***]

镜像概述和主要用途

SafeSecrets 的主要用途是通过自毁链接和易于分享的PIN码来安全传输敏感数据。它解决了传统密码传输方式（如分开发送用户名和密码的邮件）的安全隐患，提供了一种简单且更安全的替代方案。信息仅可访问一次，访问后自动销毁，有效防止敏感数据泄露。

核心功能和特性

• 自毁机制：信息被读取或过期后永久删除，无法恢复
• PIN码保护：通过PIN码加密信息，确保只有知道PIN的接收者可访问
• 一次访问限制：每个链接仅允许打开一次，防止多次访问
• 安全存储：不存储原始消息或PIN，仅保存加密后的数据；默认配置下不在磁盘存储任何敏感信息
• 防暴力破解：默认限制PIN码错误尝试次数为3次
• 灵活配置：可自定义PIN码长度、最大过期时间等参数

使用场景和适用范围

• 团队内部共享密码或敏感配置信息
• 向客户或合作伙伴安全发送账户凭证
• 需要临时共享敏感数据且不希望长期留存的场景
• 替代不安全的邮件、即时通讯工具传输敏感信息

使用方法和配置说明

在线使用

可直接使用公共服务 safesecret.info，或部署私有实例。创建安全链接需提供：

• 秘密消息内容
• 消息过期时间
• 秘密PIN码

接收者打开链接后需输入PIN码查看消息，消息查看后立即销毁。

私有部署

前提条件

• Docker 和 Docker Compose

部署步骤

1. 下载 docker-compose.yml 和 secrets-nginx.conf 配置文件
2. 调整 docker-compose.yml 中的环境变量：
   • TZ：本地时区（如 Asia/Shanghai）
   • SIGN_KEY：长随机字符串（用于数据签名）
   • MAX_EXPIRE：最大过期时间（默认24小时，单位：秒）
   • PIN_SIZE：PIN码长度（默认5位）
   • PIN_ATTEMPTS：最大PIN错误尝试次数（默认3次）
3. SSL配置：
   • 自动生成证书（使用集成的 https://github.com/umputun/nginx-le%EF%BC%89%EF%BC%9A

     yaml
     environment:
       - LETSENCRYPT=true
       - LE_EMAIL=name@example.com  # 用于Let's Encrypt注册的邮箱
       - LE_FQDN=www.example.com    # 域名
     

   • 使用自有证书： 将证书文件复制到 etc/ssl 目录，并配置：

     yaml
     environment:
       - SSL_CERT=cert.pem       # 证书文件名
       - SSL_KEY=privkey.pem     # 密钥文件名
     

4. 启动服务：

   bash
   docker-compose up -d
   

5. （可选）从源码构建：

   bash
   docker-compose build && docker-compose up -d
   

详细配置可参考 https://github.com/umputun/secrets/blob/master/docker-compose.yml

技术细节

默认部署包含两个容器：

• secrets 应用容器：提供后端API和前端UI
• nginx-le 容器：提供Nginx反向代理和Let's Encrypt SSL支持

应用容器可独立运行（无需Nginx代理），适用于已有代理（如haproxy、AWS ELB/ALB）的场景。

API参考

保存消息

请求：POST /api/v1/message
请求体：{"message":"敏感信息内容", "exp": 过期时间(秒), "pin": "PIN码"}

示例：

bash
http POST https://safesecret.info/api/v1/message pin=12345 message=testtest-12345678 exp:=1000

响应：

json
{
  "exp": "2016-06-25T13:33:45.11847278-05:00",
  "key": "f1acfe04-277f-4016-518d-16c312ab84b5"
}

加载消息

请求：GET /api/v1/message/:key/:pin

示例：

bash
http GET https://safesecret.info/api/v1/message/6ceab760-3059-4a52-5670-649509b128fc/12345

响应：

json
{
  "key": "6ceab760-3059-4a52-5670-649509b128fc",
  "message": "testtest-12345678"
}

服务状态检查

请求：GET /api/v1/ping

响应：

pong

获取系统参数

请求：GET /api/v1/params

响应：

json
{
  "max_exp_sec": 86400,
  "max_pin_attempts": 3,
  "pin_size": 5
}