jhaals/yopass

Yopass - 安全分享秘密信息

!Yopass-horizontal

https://goreportcard.com/badge/github.com/jhaals/yopass](https://goreportcard.com/report/github.com/jhaals/yopass) 

!demo

镜像概述和主要用途

Yopass是一个用于快速、安全分享秘密信息的项目。其核心目的是减少密码等敏感信息在工单系统、Slack消息和电子邮件中的传播。消息在浏览器本地加密/解密，加密后的消息会发送到Yopass，但不包含解密密钥（解密密钥仅在加密时显示一次）。Yopass随后返回一个带有指定过期时间的一次性URL。

在线分享秘密信息没有绝对完美的方式，每种实现都存在权衡。Yopass设计为尽可能简单和“无状态”，同时不牺牲安全性。生成的UUID与提交加密消息的用户之间没有映射关系。最佳实践是通过其他渠道发送除密码外的所有上下文信息。

演示地址。若关注安全性，建议自行部署Yopass。

核心功能和特性

• 使用OpenPGP进行端到端加密
• 秘密信息仅可查看一次
• 无需账户或用户管理
• 秘密信息在指定时间后自动销毁
• 支持自定义密码选项
• 有限的文件上传功能

历史

Yopass于2014年首次发布，由开发者维护并得到https://github.com/jhaals/yopass/graphs/contributors%E7%A4%BE%E5%8C%BA%E7%9A%84%E6%94%AF%E6%8C%81%E3%80%82%E7%9B%AE%E5%89%8D%E5%B7%B2%E8%A2%AB%E5%A4%9A%E5%AE%B6%E5%A4%A7%E5%9E%8B%E4%BC%81%E4%B8%9A%E9%87%87%E7%94%A8%EF%BC%8C%E9%83%A8%E5%88%86%E4%BC%81%E4%B8%9A%E5%A6%82%E4%B8%8B%E3%80%82

如果您正在使用Yopass，并希望通过代码贡献之外的方式支持项目，可通过邮件致谢、考虑***，或同意在本说明中列出您的公司名称作为Yopass用户。

受信任的用户

• Doddle LTD
• Spotify
• Gumtree Australia

命令行界面

Yopass的主要设计目标是通过简单的Web界面让所有人轻松快速地分享秘密信息。同时提供命令行界面，以支持需要分享程序输出等场景。

console
$ yopass --help
Yopass - 安全分享秘密信息、密码和文件

标志:
      --api string          Yopass API服务器地址 (默认 "https://api.yopass.se")
      --decrypt string      解密秘密信息URL
      --expiration string   秘密信息过期删除时间 [1h, 1d, 1w] (默认 "1h")
      --file string         从文件读取秘密信息（而非标准输入）
      --key string          手动加密/解密密钥
      --one-time            一次性下载 (默认 true)
      --url string          Yopass公共URL (默认 "https://yopass.se")

设置从标志、环境变量或配置文件（位于~/.config/yopass/defaults.<json,toml,yml,hcl,ini,...>）中读取，优先级依次为标志、环境变量、配置文件。环境变量需以YOPASS_为前缀，连字符转换为下划线。

示例:
      # 从标准输入加密并分享秘密信息
      printf 'secret message' | yopass

      # 加密并分享秘密文件
      yopass --file /path/to/secret.conf

      # 分享秘密信息，支持全天多次下载
      cat secret-notes.md | yopass --expiration=1d --one-time=false

      # 解密秘密信息到标准输出
      yopass --decrypt https://yopass.se/#/...

网站: https://yopass.se

以下是安装CLI的方法：

• 从源码编译（需要Go >= v1.21）

  console
  go install github.com/jhaals/yopass/cmd/yopass@latest
  

安装与配置

服务器配置选项

命令行标志：

console
$ yopass-server -h
      --address string             监听地址 (默认 0.0.0.0)
      --database string            数据库后端 ('memcached' 或 'redis') (默认 "memcached")
      --max-length int             加密秘密信息的最大长度 (默认 10000)
      --memcached string           Memcached地址 (默认 "localhost:11211")
      --metrics-port int           监控指标服务器监听端口 (默认 -1)
      --port int                   监听端口 (默认 1337)
      --redis string               Redis URL (默认 "redis://localhost:6379/0")
      --tls-cert string            TLS证书路径
      --tls-key string             TLS密钥路径
      --cors-allow-origin          Access-Control-Allow-Origin CORS设置 (默认 *)
      --force-onetime-secrets      拒绝创建非一次性秘密信息
      --disable-upload             禁用/file上传端点
      --prefetch-secret            显示秘密信息可能为一次性下载的提示 (默认 true)
      --disable-features           禁用前端功能部分
      --no-language-switcher       禁用UI中的语言切换器
      --trusted-proxies strings    用于验证X-Forwarded-For头的可信代理IP地址或CIDR块
      --privacy-notice-url string  隐私声明页面URL
      --imprint-url string         法律声明页面URL

加密的秘密信息可通过更改--database标志存储在Memcached或Redis中。

代理配置

当Yopass部署在反向代理或负载均衡器（如Nginx、Caddy、Cloudflare或AWS ALB）之后时，可能需要记录真实客户端IP而非代理IP。Yopass支持可信代理配置，以安全处理X-Forwarded-For头。

安全说明：仅当请求来自显式配置的可信代理时，才会信任X-Forwarded-For头。这可防止来自不受信任来源的IP欺骗。

示例：

bash
# 信任单个代理IP
yopass-server --trusted-proxies 192.168.1.100

# 信任多个代理IP
yopass-server --trusted-proxies 192.168.1.100,10.0.0.50

# 信任代理子网（CIDR表示法）
yopass-server --trusted-proxies 192.168.1.0/24,10.0.0.0/8

# 环境变量（适用于Docker）
export TRUSTED_PROXIES="192.168.1.0/24,10.0.0.0/8"
yopass-server

常见代理场景：

• Nginx/Apache：使用反向代理服务器的IP地址
• Cloudflare：使用Cloudflare的IP范围（可从其文档获取）
• AWS ALB/ELB：使用VPC的CIDR块或负载均衡器的子网
• Docker网络：使用Docker网络的网关IP或子网

未配置可信代理时，Yopass将始终使用直接连接的IP，这是推荐的默认行为。

Docker Compose

使用Docker Compose文件deploy/with-nginx-proxy-and-letsencrypt/docker-compose.yml可搭建带TLS传输加密和Let's Encrypt自动证书续期的Yopass实例。首先将域名指向运行Yopass的主机，然后替换docker-compose.yml中的VIRTUAL_HOST、LETSENCRYPT_HOST和LETSENCRYPT_EMAIL占位符为实际值。切换到部署目录并启动容器：

console
docker-compose up -d

Yopass将通过VIRTUAL_HOST/LETSENCRYPT_HOST指定的域名可用。

已有反向代理处理TLS的高级用户可使用“insecure”设置：

console
cd deploy/docker-compose/insecure
docker-compose up -d

然后将反向代理指向127.0.0.1:80。

Docker

带TLS加密：

console
docker run --name memcached_yopass -d memcached
docker run -p 443:1337 -v /local/certs/:/certs \
    --link memcached_yopass:memcached -d jhaals/yopass --memcached=memcached:11211 --tls-key=/certs/tls.key --tls-cert=/certs/tls.crt

Yopass将通过主机的所有IP（包括公网IP）的443端口可用。若要限制为特定IP，使用-p 127.0.0.1:443:1337。

不带TLS加密（需反向代理处理传输加密）：

console
docker run --name memcached_yopass -d memcached
docker run -p 127.0.0.1:80:1337 --link memcached_yopass:memcached -d jhaals/yopass --memcached=memcached:11211

然后将处理TLS的反向代理指向127.0.0.1:80。

Kubernetes

console
kubectl apply -f deploy/yopass-k8.yaml
kubectl port-forward service/yopass 1337:1337

此配置仅用于快速启动，实际运行时请配置TLS。

监控

Yopass可选择提供OpenMetrics / Prometheus文本格式的指标。使用标志--metrics-port <port>可让Yopass在指定端口启动第二个HTTP服务器，通过/metrics路径提供指标。

支持的指标：

• 前缀为process_的基本进程指标（如CPU、内存和文件描述符使用情况）
• 前缀为go_的Go运行时指标（如Go内存使用、垃圾回收统计等）
• 前缀为yopass_http_的HTTP请求指标（HTTP请求计数器和HTTP请求延迟直方图）

翻译

Yopass支持添加其他语言的翻译。现代前端使用react-i18next内置国际化支持，目前支持英语和瑞典语。欢迎通过拉取请求贡献翻译。