scribblerockerz/cryptletter

Cryptletter 镜像文档

概述

通过互联网发送明文密码不仅风险高，更是极不安全的行为。本项目旨在提高这一过程的安全性，让用户能够控制发送的数据，避免安全问题长期存在于收件箱中。Cryptletter 是一个自托管的微服务，专注于安全传输敏感信息，通过加密和自毁机制保护数据安全。

应用截图

应用程序界面截图展示了消息创建和加密传输的流程。

核心功能与特性

• 自托管
  可直接获取并部署使用，完全掌控服务和数据。

• 客户端 AES-256 加密
  消息通过 -js 库在客户端进行加密。密钥作为哈希值附加，不会发送至服务器（即使服务遭遇黑客，也只会获取到加密后的无效数据）。

• 带 TTL 的消息
  可自定义消息在客户端打开后的存活时间，超时后自动销毁。

• 受限消息访问
  消息仅限首次打开时的客户端 IP 地址访问。通过 *** 等链接检查工具发布的消息将被阻止打开。

使用场景与适用范围

• 需安全发送敏感信息（如密码、API 密钥、个人身份信息）的场景
• 自托管环境下的内部团队通信，确保敏感数据不被长期存储
• 要求控制消息生命周期和访问权限的场景，避免信息泄露后被长期滥用

快速使用

创建 docker-compose.yml 文件并运行 docker-compose up 即可快速启动服务。

Docker Compose 配置

yaml
# docker-compose.yml
version: '3'

services:
    redis:
        image: 'redis:alpine'
        ports:
            - '6379:6379'
    app:
        image: 'scribblerockerz/cryptletter:latest'
        command: './cryptletter'
        ports:
            - '8080:8080'
        links:
            - redis
        environment:
            - 'REDIS__ADDRESS=redis:6379'
            - 'APP__LOG_LEVEL=4'

环境要求

该微服务依赖 Redis 运行，可通过 Docker 或独立可执行文件部署。

配置说明

配置方式

配置可通过 YAML 文件或环境变量提供。

• 运行 cryptletter config:init 在工作目录生成新的 cryptletter.yml 配置文件
• 通过命令行参数指定配置文件路径：

  bash
  $ cryptletter --config ../your/own/path/you-name-it.yml
  

配置文件详解

yaml
# cryptletter.yml
app:
  # 消息未被打开时的存活时间（分钟）
  default_message_ttl: 43830
  # 日志级别，值越大日志越详细
  log_level: 4
  # 环境类型，"dev" 模式用于本地开发（禁用 CORS）
  env: prod
  
  # 服务配置
  server:
    port: 8080

  # 创建新消息的密码保护（用于限制公开访问）
  creation_protection_password: ""
    
  # 自定义 CSS 和 JS 配置
  additional:
    css: './web/example/additional.css'  # 附加 CSS 文件路径
    js: './web/example/custom.js'        # 附加 JS 文件路径
    
  attachments:
    # 消息达到 TTL 后清理文件的定时任务（cron 表达式）
    cleanup_schedule: * * * * *
    # 附件存储驱动：s3、local 或空字符串（禁用附件支持）
    driver: local
    # 上传附件的存储目录
    storage_path: cryptletter-uploads

# Redis 配置
redis:
  address: 127.0.0.1:6379  # Redis 地址
  database: 0              # Redis 数据库编号
  password: ""             # Redis 密码

# S3 附件存储配置（当 attachment.driver 为 s3 时生效）
s3:
  access_id: minioadmin     # S3 访问 ID
  access_secret: minioadmin # S3 访问密钥
  bucket_name: cryptletter-attachments  # 存储桶名称
  bucket_region: eu-central-1           # 存储桶区域
  endpoint: http://127.0.0.1:9000       # S3 服务端点
  secure: true               # 是否使用 HTTPS

环境变量

使用 __ 代替配置文件中的点符号，例如：
APP__LOG_LEVEL=0（设置日志级别为最低）
REDIS__ADDRESS=redis:6379（设置 Redis 地址）

自定义

可通过配置文件中的 additional.css 和 additional.js 注入自定义样式和脚本。如需完全自定义，需重新构建应用（资源嵌入在可执行文件中）。

构建

运行 ./build.sh 生成可执行文件，可根据需求调整 Docker 构建推送目标。