From ba4811e65fb1e13012f91fdbb7dd3ae0f8b79778 Mon Sep 17 00:00:00 2001 From: acite <1498045907@qq.com> Date: Mon, 29 Sep 2025 20:49:44 +0800 Subject: [PATCH] [doc] Doc Update --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 9ddef6f..9d9ae48 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,31 @@ _🚀This is the client of the multimedia server Abyss, which can also be extend Logo +## 🎯 Target + +The ultimate goal of this software project is to enable anyone to easily build a smooth media library that they can fully manage and control, +contribute to with trusted individuals, and securely access from any location without worrying about unauthorized use of their data by third parties. +Undoubtedly, this is a distant goal, but in any case, +I hope this project can make a modest contribution to the advancement of cybersecurity and the protection of user privacy. + +## Key Features + +- **Media Management**: Organize and serve images, videos, and live streams with structured directory support. +- **User Authentication**: Challenge-response authentication using **Ed25519** signatures. No private keys are ever transmitted. +- **Role-Based Access Control (RBAC)**: Hierarchical user privileges with configurable permissions for resources. +- **Secure Proxy**: Built-in HTTP/S proxy with end-to-end encrypted tunneling using **X25519** key exchange and **ChaCha20-Poly1305** encryption. +- **Resource-Level Permissions**: Fine-grained control over files and directories using a SQLite-based attribute system. +- **Task System**: Support for background tasks such as media uploads and processing with chunk-based integrity validation. +- **RESTful API**: Fully documented API endpoints for media access, user management, and task control. + +## Technology Stack + +- **Backend**: ASP.NET Core 9, MVC, Dependency Injection +- **Database**: SQLite with async ORM support +- **Cryptography**: NSec.Cryptography (Ed25519, X25519), ChaCha20Poly1305 +- **Media Handling**: Range requests, MIME type detection, chunked uploads +- **Security**: Rate limiting, IP binding, token expiration, secure headers + ## Development background - Operating System: Voidraw OS v1.1 (based on Ubuntu) or any compatible Linux distribution.