CipherGate

企业级统一鉴权与安全接入平台，面向 SaaS、客户端软件和第三方生态，提供标准化的接入与安全中台能力。

项目简介

CipherGate 将分散在业务侧的鉴权、会话、风控、配置分发能力统一收敛，帮助团队实现：

更低的接入成本：HTTP / WebSocket 协议统一
更强的安全一致性：签名、防重放、限流、加密链路
更清晰的运营治理：用户、卡密、在线时长、行为日志

核心功能

🔐 安全管理

端到端数据加密，时间窗校验、nonce 防重放
细粒度访问控制与签名验证
会话加密通信
OAuth2 登录集成（GitHub 等）

👥 用户体系

应用用户管理、密码重置、封禁与解封
会员等级体系与设备绑定
多设备绑定与账号状态治理
用户注册验证码（OTP）支持

🎫 卡密运营

卡密批量生成、分发、加时续期
设备/IP 绑定与解绑控制
卡密激活统计与状态流转
卡密心跳检测与在线管理

💰 支付与财务

集成 Epay 支付网关
订单管理与支付状态追踪
余额系统与交易记录
定价计划管理

📊 数据监控

实时数据统计与仪表盘
调用日志分析与用户行为追踪
在线状态实时展示与掉线感知
活动日志审计

🎟️ 运营工具

工单系统：技术支持请求与问题反馈
公告系统：系统公告与应用公告管理
签到系统：每日签到与连续签到奖励
邀请系统：邀请好友注册获得奖励

🤝 代理协作

代理账户管理与权限分配
代理配额控制
代理绑定用户管理

🔌 第三方接入

HTTP + WebSocket 双通道接入
统一开放接口标准
变量配置中心与动态下发
系统消息推送

🧩 插件扩展

插件上传、启停、配置管理
支持按需扩展加解密或协议处理逻辑
平台能力可持续演进而不侵入主干业务

🛡️ RBAC 权限

后台用户、角色、菜单、权限点统一管理
细粒度接口授权与权限隔离
多角色协作和审计支持

适用场景

企业应用授权：管理内部应用的用户授权
SaaS 服务：为 SaaS 应用提供用户管理能力
软件分发：通过卡密进行软件授权分发
API 网关：统一管理 API 访问权限
代理商管理：多级代理体系与分润

技术栈

层级	技术
后端	Java 17, Spring Boot 4, Spring Security, WebSocket, MyBatis-Plus
前端	React 18, TypeScript, Vite, Ant Design 5, ECharts
基础设施	MySQL 8, Redis 7, RabbitMQ 3, MinIO
构建交付	Gradle, Docker Compose, GitHub Actions
扩展机制	PF4J (插件框架)
工具库	Hutool, Fastjson2, ip2region, JJWT

项目结构

CipherGate/
├── src/                          # 后端源码
│   └── main/java/com/ayssu/ciphergate/
│       ├── controller/           # API 控制器
│       ├── entity/               # 数据库实体
│       ├── service/              # 业务逻辑层
│       ├── mapper/               # MyBatis Mapper
│       ├── config/               # 配置类
│       ├── agent/                # 代理模块
│       ├── portal/               # 用户门户
│       └── thirdparty/           # 第三方接入
├── frontend/                     # 前端源码
│   ├── src/
│   │   ├── components/           # 组件
│   │   ├── pages/                # 页面
│   │   └── services/             # API 服务
│   └── dist/                     # 构建产物
├── plugins/                      # 插件模块
│   └── rsa-crypto-plugin/        # RSA 加密插件
├── docs/                         # 文档源码
├── deploy-bundle/                # 部署包
└── ciphergate-plugin-api/        # 插件 API

快速开始

环境要求

Docker & Docker Compose
Java 17+ (仅本地开发)
Node.js 20+ (仅本地开发)

方式一：本地开发

1) 启动依赖服务

docker compose -f compose.yaml up -d

启动 MySQL、Redis、RabbitMQ、MinIO 四个基础服务。

2) 启动后端服务

./gradlew bootRun

3) 启动前端（可选）

cd frontend
npm install
npm run dev

前端开发服务器默认运行在 http://localhost:5173。

方式二：生产部署

1) 下载部署包

从 GitHub Releases 下载 deploy-bundle.zip。

2) 解压并配置

unzip deploy-bundle.zip -d deploy-bundle
cd deploy-bundle

编辑 .env 文件，修改默认密码和端口配置。

3) 启动服务

docker compose -f docker-compose.server.yml up -d

服务启动后，访问 http://localhost:<FRONTEND_PORT> 进入管理后台。

部署架构

生产环境包含以下服务：

服务	说明	默认端口
frontend	Nginx 前端服务	5173
backend	Java 后端服务	8080
mysql	MySQL 数据库	3306
redis	Redis 缓存与会话存储	6379
rabbitmq	RabbitMQ 消息队列	5672
minio	MinIO 对象存储	9000

所有端口均可通过 .env 文件自定义。

服务依赖关系

frontend → backend → mysql
                  → redis
                  → rabbitmq
                  → minio

增量更新

当只需要更新部分组件时，无需下载全量包：

仅更新后端

下载 app.jar
替换服务器 app/app.jar
执行：docker compose -f docker-compose.server.yml up -d backend

仅更新前端

下载 frontend-dist.zip
覆盖服务器 frontend/dist 目录
执行：docker compose -f docker-compose.server.yml up -d frontend

配置说明

环境变量

部署包中的 .env 文件包含所有可配置项：

# 数据库配置
MYSQL_ROOT_PASSWORD=your_password
MYSQL_DATABASE=ciphergate
MYSQL_USER=your_user
MYSQL_PASSWORD=your_password
MYSQL_PORT=3306

# Redis 配置
REDIS_PORT_HOST=6379

# RabbitMQ 配置
RABBITMQ_USERNAME=rabbitmq
RABBITMQ_PASSWORD=rabbitmq
RABBITMQ_PORT=5672
RABBITMQ_MGMT_PORT=15672

# MinIO 配置
MINIO_ACCESS_KEY=your_access_key
MINIO_SECRET_KEY=your_secret_key
MINIO_BUCKET=ciphergate-plugins
MINIO_API_PORT=9000
MINIO_CONSOLE_PORT=9001

# 服务端口
BACKEND_PORT=8080
FRONTEND_PORT=5173

安全建议

生产环境部署前，务必：

修改所有默认密码
使用强密码策略
限制数据库、Redis 等服务的外网访问
配置 HTTPS 反向代理
定期备份数据库

功能模块详解

开发者中心

面向应用开发者，提供应用全生命周期管理：

功能	说明
应用管理	创建、编辑、删除应用，配置应用参数
卡密管理	批量生成卡密、查看激活统计、管理卡密状态
用户管理	管理应用用户、封禁/解封、密码重置
变量配置	配置应用变量，支持动态下发
调用日志	查看 API 调用记录与统计数据
凭证管理	管理应用的 appKey/appSecret

用户门户

面向终端用户，提供自助服务：

功能	说明
会员服务	查看会员等级、续费、升级
订单管理	查看历史订单、支付状态
余额充值	账户余额充值与消费记录
工单系统	提交技术支持、查看处理进度
签到系统	每日签到获取奖励
邀请好友	分享邀请码获取奖励

第三方接入

支持 HTTP 和 WebSocket 两种接入方式：

方式	适用场景	特点
HTTP	请求式调用	签名验证、防重放、限流
WebSocket	实时通信	认证握手、加密通信、心跳维持

代理系统

支持多级代理体系：

代理账户创建与管理
代理权限分配
代理配额控制
代理绑定用户管理

文档

部署后可通过以下路径访问在线文档：

管理后台文档：http://your-domain/docs/
快速入门：注册账号、首次登录
开发者中心：应用管理、卡密管理、变量配置
用户中心：会员服务、订单管理、工单系统
代理中心：代理管理、配额分配

开发指南

本地开发环境搭建

# 1. 克隆项目
git clone https://github.com/AYssu/CipherGate.git
cd CipherGate

# 2. 启动基础服务
docker compose -f compose.yaml up -d

# 3. 启动后端
./gradlew bootRun

# 4. 启动前端（可选）
cd frontend && npm install && npm run dev

构建部署包

# Linux/macOS
./deploy-server.sh

# Windows
deploy-server.bat

构建完成后，会在项目根目录生成 ciphergate-deploy.zip。

插件开发

插件使用 PF4J 框架，参考 plugins/rsa-crypto-plugin 示例：

在 plugins/ 目录下创建新模块
实现 ciphergate-plugin-api 中定义的接口
使用 Gradle 构建插件 JAR
通过管理后台上传插件

贡献

欢迎提交 Issue / PR。

建议在变更说明中包含：

功能范围
风险点
回滚方案
自测结果

许可证

开源项目，具体许可证请查看仓库根目录的 LICENSE 文件。

Name		Name	Last commit message	Last commit date
Latest commit History 114 Commits
.github		.github
ciphergate-plugin-api		ciphergate-plugin-api
docs		docs
frontend		frontend
gradle/wrapper		gradle/wrapper
plugins/rsa-crypto-plugin		plugins/rsa-crypto-plugin
src		src
.dockerignore		.dockerignore
.env.server		.env.server
.gitattributes		.gitattributes
.gitignore		.gitignore
AGENTS.md		AGENTS.md
README.md		README.md
build.gradle		build.gradle
compose.yaml		compose.yaml
deploy-server.bat		deploy-server.bat
deploy-server.sh		deploy-server.sh
docker-compose.server.yml		docker-compose.server.yml
gradlew		gradlew
gradlew.bat		gradlew.bat
package-lock.json		package-lock.json
package.bat		package.bat
package.json		package.json
package.sh		package.sh
settings.gradle		settings.gradle

Folders and files

Latest commit

History

Repository files navigation