# express-data-encryption

**Repository Path**: RuixeWolf/express-data-encryption

## Basic Information

- **Project Name**: express-data-encryption
- **Description**: 基于 Nodejs Express 框架，使用 TypeScript 开发的 MVC 架构后端服务，实现常用的用户操作场景所涉及的重点数据加密功能
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-15
- **Last Updated**: 2022-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nodejs Express 数据加密

## 项目描述

基于 Nodejs Express 框架，使用 TypeScript 开发的 MVC 架构后端服务，实现常用的用户操作场景所涉及的重点数据加密与签验功能

## 主要功能

- 非对称加解密传输时的重点数据（如：客户端对称加密的密钥）
- 对称加解密传输时的一般重点数据（如：用户密码），相较于非对称加密处理速度更快
- 传输时加密的字段包含时间戳信息，服务端校验时间戳用于防止中间人攻击时保存密文伪造请求
- 重点的 API（如：用户登录、修改用户信息）使用数字签名对请求数据进行校验
- 单向加密储存时的重点数据
- 使用 Token 验证客户端的会话状态
- Token 有时限，客户端访问时自动续约
- 限制同一用户同时登录的客户端数量

## 前端项目

- [GitHub](https://github.com/RuixeWolf/vue-data-encryption)
- [Gitee](https://gitee.com/RuixeWolf/vue-data-encryption)

## 项目运行

### 生成 RSA 私钥与公钥

```shell
mkdir keys && cd keys
openssl genrsa -out rsa_2048_priv.pem 2048
openssl rsa -pubout -in rsa_2048_priv.pem -out rsa_2048_pub.pem
```

### 添加前端应用

```shell
mkdir frontendApp
cp /path/to/frontendProject/dist/* ./frontendApp
```

### 添加静态文件目录

```shell
mkdir static
```

### 配置数据库

- 设置 MongoDB URL 环境变量，环境变量名称默认为：`EXPRESS_MONGODB_URL`
- MongoDB URL 环境变量内容为：`mongodb://[user]:[password]@[host]:[port]/[dbName]?authSource=[dbName]`

### 安装依赖

```shell
npm install
```

### 启动服务

```shell
npm run start
```

### 启动开发模式

```shell
npm run dev
```

### 项目打包构建

```shell
npm run build
```

生产环境可以选择部署打包后的项目，以提高启动速度与保护源码

## 使用 Docker 运行项目

### 构建 Docker 镜像

```shell
npm run build:docker-image
```

注：需要已有前端应用 `frontendApp` 目录与 RSA 密钥 `keys` 目录

### 启动 Docker Compose

```shell
npm run start:docker-compose
```

项目运行于 `http://localhost:8002/`

### 关闭 Docker Compose

```shell
npm run stop:docker-compose
```

## 目录结构

```
├─builder - 项目构建器
├─dist - 打包输出目录
├─docker - Docker 数据目录
│  └─volumes - Docker 数据卷
│     └─mongodb - MongoDB 数据卷
│        ├─config - MongoDB 配置
│        └─data - MongoDB 数据
├─frontendApp - 前端单页面应用
├─keys - RSA 密钥
├─src - 项目源码
│  ├─apps - 应用模块
│  ├─configs - 服务配置
│  ├─interfaces - 公共接口
│  ├─models - 公共数据模型
│  ├─privateMiddlewares - 私有中间件
│  ├─publicMiddlewares - 公共中间件
│  ├─serverError - 异常处理
│  └─utils - 工具库
└─static - 静态文件
```