From 6829b381b73db04bd548d32506b9873ad954187b Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sat, 5 Jul 2025 13:33:22 +0000 Subject: [PATCH] Update README.md --- README.en.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..a0e7277 --- /dev/null +++ b/README.en.md @@ -0,0 +1,57 @@ + + +# Encryption Platform + +This is a fully functional encryption management platform that provides core features such as algorithm management, key management, file encryption and decryption, and access control. + +## Features + +- **Encryption Algorithm Management**: Supports creating, updating, deleting, and querying encryption algorithms +- **Key Management**: Secure storage and management of encryption keys +- **File Encryption/Decryption**: Supports file encryption and decryption operations +- **Access Control System**: Role-Based Access Control (RBAC) and fine-grained permission management +- **Operation Audit**: Full recording of all operation logs +- **SQL Injection Protection**: Built-in SQL injection detection and defense mechanisms + +## Installation Guide + +1. Clone the repository +2. Run SQL scripts to initialize the database +3. Configure database connection in application.yml +4. Build the project using Maven +5. Start the Spring Boot application + +## API Documentation + +Complete RESTful API documentation is available via Swagger UI. Main APIs include: + +- `/api/auth`: Authentication-related interfaces +- `/api/user`: User management +- `/api/role`: Role management +- `/api/permission`: Permission management +- `/api/menu`: Menu management +- `/api/algorithm`: Encryption algorithm management +- `/api/key`: Key management +- `/api/file-encryption`: File encryption and decryption +- `/api/security/sql-injection`: SQL injection protection configuration + +## Security Features + +- JWT token authentication +- Enhanced password policies +- SQL injection detection filter +- Request log recording +- Detailed permission controls + +## Contribution Guidelines + +Contributions are welcome! Please follow these steps: + +1. Fork the repository +2. Create a new branch +3. Submit code changes +4. Create a Pull Request + +## License + +This project uses the Apache 2.0 license. Please see the LICENSE file for more details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b190e2 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# 加密平台 + +这是一个功能齐全的加密管理平台,提供算法管理、密钥管理、文件加密解密、权限控制等核心功能。 + +## 功能特性 + +- **加密算法管理**:支持创建、更新、删除和查询加密算法 +- **密钥管理**:安全存储和管理加密密钥 +- **文件加密/解密**:支持文件加密和解密操作 +- **权限控制系统**:基于角色的访问控制(RBAC)和细粒度权限管理 +- **操作审计**:完整记录所有操作日志 +- **SQL注入防护**:内置SQL注入检测和防御机制 + +## 安装指南 + +1. 克隆仓库 +2. 执行SQL脚本初始化数据库 +3. 配置application.yml中的数据库连接 +4. 使用Maven构建项目 +5. 启动Spring Boot应用 + +## API文档 + +完整的RESTful API文档可通过Swagger UI访问。主要API包括: + +- `/api/auth`:认证相关接口 +- `/api/user`:用户管理 +- `/api/role`:角色管理 +- `/api/permission`:权限管理 +- `/api/menu`:菜单管理 +- `/api/algorithm`:加密算法管理 +- `/api/key`:密钥管理 +- `/api/file-encryption`:文件加密解密 +- `/api/security/sql-injection`:SQL注入防护配置 + +## 安全特性 + +- JWT令牌认证 +- 密码策略强化 +- SQL注入检测过滤器 +- 请求日志记录 +- 详细的权限控制 + +## 贡献指南 + +欢迎贡献代码!请遵循以下步骤: + +1. Fork仓库 +2. 创建新分支 +3. 提交代码更改 +4. 创建Pull Request + +## 许可证 + +本项目采用Apache 2.0许可证。详情请参阅LICENSE文件。 \ No newline at end of file -- Gitee