timoa/nodejs-encryption-api-example

Node.js加密API端点

概述

本镜像提供了一个使用Node.js通过API进行数据加密/解密的示例。其核心思想是测试如何在数据存储（如MongoDB）中存储加密数据，并通过为每次调用提供加密密钥来控制数据。

注意：本项目不涵盖传输加密（SSL），且不建议用于生产环境。

核心功能与特性

• API存储端点：使用提供的密钥加密数据并存储到MongoDB集合（采用AES-256-CBC加密）
• API检索端点：使用提供的密钥解密数据并返回结果
• AES-256-CBC加密：使用随机初始化向量（IV）
• IV与加密数据一起存储（通过:字符分隔）
• 带关联ID的日志记录
• MongoDB数据存储（使用Mongoose）
• Swagger API规范/文档支持（开发中）
• 健康检查端点：用于检查应用是否正常运行
• Dockerfile：用于生成Docker镜像
• Docker Compose文件：用于启动API和MongoDB官方Docker镜像
• Travis CI集成：构建、测试并部署到Docker Hub
• SonarCloud代码质量检查
• 单元测试和功能测试
• Postman集合和环境配置

使用场景与适用范围

适用于开发和测试环境中，演示如何通过API接口实现数据的加密存储与解密检索，帮助开发者理解客户端加密密钥控制下的数据安全管理流程。不适合生产环境使用。

使用方法与配置说明

本地运行

安装依赖

bash
npm install

启动应用

bash
npm start

运行测试

bash
# 单元测试
npm test

# 测试覆盖率
npm run test:coverage

# 功能测试
npm run test:functional

# 运行所有测试
npm run test:all

Docker部署

Docker Compose

确保本地未运行MongoDB且3000端口未被其他应用占用

bash
docker-compose up

Postman测试

导入Postman环境

下载https://raw.githubusercontent.com/timoa/nodejs-encryption-api-example/master/src/config/postman.environment.json%E5%B9%B6%E5%AF%BC%E5%85%A5%E3%80%82%E7%8E%AF%E5%A2%83%E5%8C%85%E5%90%AB%E9%BB%98%E8%AE%A4%E5%8A%A0%E5%AF%86%E5%AF%86%E9%92%A5%E5%92%8CID%EF%BC%8C%E4%BE%BF%E4%BA%8E%E5%BF%AB%E9%80%9F%E6%B5%8B%E8%AF%95API%E3%80%82

运行Postman集合

![Run in Postman]([***]

文档访问

应用启动后，可通过以下地址访问Swagger文档：
http://localhost:3000/swagger

工作原理

生成加密密钥（256位/32字符长度）

需生成用于加密MongoDB中存储数据的密钥。可通过以下在线工具生成256位密钥：
[***]

添加加密数据

使用以下curl命令，替换encryption_key和value为实际密钥和需加密的JSON数据：

bash
curl -X POST \
  http://127.0.0.1:3000/api/secrets/add \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "test-01",
    "encryption_key": "p2s5v8y/B?E(H+MbQeShVmYq3t6w9z$C",
    "value": {
        "first_name": "firstname",
        "last_name": "lastname",
        "email": "email@email.com",
        "password": "app123",
        "password_confirmation": "app123"
    }
}'

返回的加密数据示例（IV为前半部分，通过:分隔）：

json
{
    "_id": "5c61979c82126860464dd0e8",
    "id": "test-01",
    "value": "42d0f6eb0810caaaaf5bad7477ebfc44:3572036ad7b4d77959cbc85feb364bf2c3442f7290ab210e88b00aae5a8122509df282db39ffcd092a927c4f302b93ba87f70563af8a51b29577196cc010d5514d29351ee74b64538d9004f581c911ea059be8769520075659e497a6b716ab95af692b56326a682b443d05150e90d8b75c43eabe15a27c01f240eae9edecf345436bb294b28c41087629754b01ada42c",
    "__v": 0
}

获取加密数据

获取特定ID数据

通过ID查询（如下例中的test-01）：

bash
curl -X POST \
  http://127.0.0.1:3000/api/secrets \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "test-01",
    "encryption_key": "p2s5v8y/B?E(H+MbQeShVmYq3t6w9z$C"
}'

返回结果（包含解密后的数据）：

json
[
    {
        "id": "test-01",
        "value": {
            "first_name": "firstname",
            "last_name": "lastname",
            "email": "email@email.com",
            "password": "app123",
            "password_confirmation": "app123"
        }
    }
]

使用通配符*查询ID

在ID末尾使用通配符*查询多个结果（如下例中的test-01-*）：

bash
curl -X POST \
  http://127.0.0.1:3000/api/secrets \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "test-01-*",
    "encryption_key": "p2s5v8y/B?E(H+MbQeShVmYq3t6w9z$C"
}'

返回结果（包含所有匹配ID的解密数据）：

json
[
    {
        "id": "test-01-01",
        "value": {
            "first_name": "firstname",
            "last_name": "lastname",
            "email": "email@email.com",
            "password": "app123",
            "password_confirmation": "app123"
        }
    },
    {
        "id": "test-01-02",
        "value": {
            "first_name": "firstname",
            "last_name": "lastname",
            "email": "email@email.com",
            "password": "app123",
            "password_confirmation": "app123"
        }
    },
    {
        "id": "test-01-03",
        "value": {
            "first_name": "firstname",
            "last_name": "lastname",
            "email": "email@email.com",
            "password": "app123",
            "password_confirmation": "app123"
        }
    }
]

待办事项

• 错误加密密钥时返回空数组而非错误
• 完善Swagger详细 schema
• Docker容器中添加PM2支持（应用崩溃时自动重启）
• 从Travis-CI迁移到CircleCI（支持#TravisAlumns）