UgosProApi 1.0.0

UgosProApi

绿联 UGOS Pro NAS 系统的非官方 .NET SDK 客户端。

通过对绿联 UGOS Pro Web 前端的私有 API 进行逆向工程实现，提供安全登录、会话管理、文件列表、上传、下载和删除功能。

安装

dotnet add package UgosProApi

快速开始

基础用法

using UgosProApi;
using UgosProApi.Authentication;

// 配置 NAS 连接
var config = new UgosConfig
{
    Protocol = "https://",
    Server = "192.168.1.1",
    Port = 9999,
    Username = "admin",
    Password = "your_password"
};

// 创建客户端
using var client = new UgosClient(config);

// 1. 获取 RSA 公钥
var rsaPublicKey = await client.GetPasswordRsaAsync();

// 2. 登录
var session = await client.LoginAsync(rsaPublicKey);

// 3. 刷新会话
await client.IsLoginAsync(session);

// 4. 上传文件
var fileBytes = File.ReadAllBytes(@"C:\test.jpg");
await client.UploadFileAsync(session, fileBytes, "test.jpg",
    DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(), "/home/admin/");

// 5. 下载文件
await using var stream = await client.DownloadAsync(session,
    new List<string> { "/home/admin/test.jpg" });
using var fileStream = File.Create(@"C:\downloaded.jpg");
await stream.CopyToAsync(fileStream);

// 6. 删除文件（移入回收站）
await client.DeletePathsAsync(session,
    new List<string> { "/home/admin/test.jpg" }, forever: false);

ASP.NET Core DI 集成

// Program.cs
builder.Services.AddUgosProApi(config =>
{
    config.Server = "192.168.1.1";
    config.Port = 9999;
    config.Username = "admin";
    config.Password = "your_password";
});

// 在 Controller / Service 中使用
public class FileController : ControllerBase
{
    private readonly IUgosClient _ugosClient;

    public FileController(IUgosClient ugosClient)
    {
        _ugosClient = ugosClient;
    }

    [HttpPost("upload")]
    public async Task<IActionResult> Upload(IFormFile file)
    {
        var rsaKey = await _ugosClient.GetPasswordRsaAsync();
        var session = await _ugosClient.LoginAsync(rsaKey);

        using var ms = new MemoryStream();
        await file.CopyToAsync(ms);
        var bytes = ms.ToArray();

        await _ugosClient.UploadFileAsync(session, bytes, file.FileName,
            DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(), "/home/admin/");

        return Ok();
    }
}

API 参考

认证流程

1. 获取 RSA 公钥：POST /ugreen/v1/verify/check
2. 密码登录：RSA 加密密码后 POST /ugreen/v1/verify/login
3. 请求签名：后续请求携带 cookie、x-ugreen-security-key、x-ugreen-token 请求头
4. 会话刷新：定期调用 IsLoginAsync 更新 Cookie

目标框架

• .NET 8.0+

依赖

• 仅依赖 Microsoft.Extensions.DependencyInjection.Abstractions（可选，仅 DI 集成需要）

许可证

MIT

致谢

本项目基于 Java 原版 ugos_pro_api 移植，感谢原作者 pewee。