Darkwire.io 项目介绍
项目概述
Darkwire.io 是一个简单易用的加密 web 聊天服务。这个项目通过 socket.io 和 Web Cryptography API 的结合,实现了客户端加密,是了解客户端加密如何工作的理想示例,并展示了如何将其集成到聊天服务中。
服务端与客户端
- Darkwire 服务器:Darkwire 的服务器部分是一个基于 Node.js 的应用程序。
- Darkwire Web 客户端:Darkwire 的 web 客户端使用 JavaScript 编写,并集成了 React JS 和 Redux 库。
开发指南
前置条件
要开始使用 Darkwire,用户需要将 server/
和 client/
目录下的 .env.dist
文件复制并移除 .dist
扩展名来配置环境变量。此外,由于加密需要,Darkwire 仅在 localhost 或 HTTPS 连接下工作。
手动安装步骤
要安装 Darkwire 并开始开发,用户需要合理配置 Node.js 和 Yarn。以下是必要的步骤:
-
使用 nvm 安装正确的 Node.js 版本:
nvm install nvm use npm install yarn -g
-
安装代码依赖:
yarn
-
启动服务器和客户端:
yarn setup yarn dev
使用 Docker-Compose
用户可以通过运行以下命令快速启动开发环境:
docker-compose up
此命令将自动为用户创建默认的 .env
文件。
生产环境
要构建生产版本,用户需要运行以下命令创建服务器和客户端的生产构建:
yarn build
然后启动服务器:
yarn start
使用 Docker
用户可以通过 Docker 进行构建和运行:
构建镜像:
docker build --tag darkwire.io:latest .
运行服务:
docker run --init --name darkwire.io --rm -p 3001:3001 darkwire.io
用户可以在 server/.env.dist
和 client/.env.dist
使用任何环境变量配置。
安全性
任何安全问题请报告至 hello@darkwire.io
。
工作原理
Darkwire 结合了非对称加密(RSA-OAEP)、对称会话密钥(AES-CBC)和签名密钥(HMAC)来保证安全性。聊天加密的工作流程如下:
- 用户(如 Bob)创建聊天室,并生成公钥/私钥对。
- 其他用户(如 Alice)加入房间并生成他们的公钥/私钥对。各自交换公钥。
- 发送消息时,将创建会话密钥、签名密钥和初始化向量。
- 信息加密后连同签名及加密的密钥发送给接收者。
- 接收者使用私钥解密密钥,并验证信息完整性。
群聊与此类似,每个参与者接收到的加密密钥包将解密自己的部分。
文件传输
Darkwire 支持文件传输,通过对文件进行 base64 编码并以与聊天消息相同的方式加密来实现。文件的默认传输大小限制为 4MB,用户可以通过 .env
文件的 REACT_APP_MAX_FILE_SIZE
变量进行调整。
Sockets 和服务器
Darkwire 通过 socket.io 利用安全的 WebSockets (WSS) 来传输加密信息。聊天室的生命周期仅存在于所有参与者退出之前,只有公钥会暂存在服务器内存中。每位用户的聊天记录保存在其浏览器中,当窗口关闭时记录将被清空。