Phiên làm việc & Bảo mật

Phiên làm việc tài liệu và kiểm soát truy cập

Token Doconut rất mạnh: bất kỳ ai trình bày nó đều có thể yêu cầu mọi trang của tài liệu nếu nó không được ràng buộc với phiên mở. Trang này giải thích một phiên chứa gì, thời gian tồn tại của nó, và các kiểm tra mà UseDoconut() bật theo mặc định.

Những gì một phiên tài liệu chứa

Mỗi OpenDocumentAsync thành công tạo ra một phiên trong IMemoryCache:

  • bộ loaded format viewer (đối tượng động cơ tài liệu giữ tài liệu đã phân tích),
  • per-page state — xoay, lật và dữ liệu chú thích mà người dùng áp dụng trong widget,
  • bộ search index tùy chọn, được xây dựng lười biếng khi tìm kiếm đầu tiên (hoặc tải từ tệp .srh đã được xây dựng trước khi các trang được phục vụ từ lưu trữ chung),
  • đánh dấu watermark của phiên từ DocOptions.Watermark.

Thời gian tồn tại

Các phiên hết hạn theo sliding window: DocOptions.TimeOut phút (mặc định 60), được đặt lại bởi mỗi yêu cầu trình bày token. Khi một phiên bị loại bỏ — do hết hạn hoặc bởi CloseDocument(token) — callback loại bỏ sẽ giải phóng động cơ tài liệu và giải phóng bộ nhớ liên quan ngay lập tức.

csharp
// Một phiên ngắn hạn cho bản xem trước một lần
var token = await viewer.OpenDocumentAsync(path, new DocOptions { TimeOut = 10 });

Yêu cầu với token đã hết hạn sẽ nhận được hình ảnh lỗi hiển thị Document session not found. Please re-open document. — client phải mở lại để lấy token mới.

Ràng buộc token tích hợp

Với UnsafeMode = false (mặc định), OpenDocumentAsync ràng buộc token mới với phiên ASP.NET của yêu cầu HTTP đã mở nó, bằng cách ghi một dấu secure-{token} vào phiên đó. Middleware Doconut sau đó từ chối phục vụ các trang cho bất kỳ phiên trình duyệt nào khác:

  • Trình duyệt/phiên khác trình bày token bị đánh cắp → hình ảnh lỗi You Are Not Authorized To View This Page.
  • Middleware phiên không được đăng ký → HTTP 500 Session middleware not configured. Call UseSession() before UseDoconut().

Đây là lý do tại sao Quick Start yêu cầu AddSession() + app.UseSession() trước nhánh Doconut. Hai hậu quả thực tiễn:

  • Client phải gửi session cookie ASP.NET cùng với các yêu cầu trang. Các cấu hình cross-origin mà loại bỏ cookie (hoặc client API không có cookie jar) sẽ không vượt qua kiểm tra — đó là tính năng hoạt động, không phải lỗi.
  • options.UnsafeMode = true vô hiệu hoá hoàn toàn việc ràng buộc. Nó tồn tại cho các kịch bản kiểm soát (ví dụ render server-to-server); để nó false trong môi trường production.

Ràng buộc token được kiểm soát duy nhất bởi công tắc toàn cục UnsafeMode này — nó bật theo mặc định (UnsafeMode = false) và áp dụng cho mọi phiên. Không có tùy chọn tắt cho từng tài liệu; việc đặt UnsafeMode = true sẽ vô hiệu hoá ràng buộc trên toàn bộ.

Quyền truy cập và người dùng đã xác thực

Khi UnsafeMode là false, UseDoconut() chèn DocumentAccessMiddleware tự động trước middleware trang. Không đăng ký lại lần thứ hai. Khi một yêu cầu mang token, nó tra cứu access grant đã ghi khi tài liệu được mở và chỉ cho phép nếu tất cả các điều kiện sau đều đúng:

  1. một grant tồn tại cho token,
  2. grant chưa hết hạn (thời gian sống của grant = TimeOut của tài liệu),
  3. ID phiên ASP.NET yêu cầu khớp với ID đã mở tài liệu,
  4. nếu người mở đã xác thực, claim NameIdentifier của người dùng yêu cầu cũng phải khớp.

Các lỗi trả về 403 — dưới dạng hình ảnh PNG lỗi cho các yêu cầu trang/thumbnail, và dưới dạng văn bản thuần cho các trường hợp khác. Thông điệp và khóa truy vấn token đến từ DocumentSecurityOptions (TokenQueryKey, mặc định "token"; UnauthorizedMessage, mặc định "You Are Not Authorized To View This Page."). Cấu hình các tùy chọn này qua ASP.NET Core DI trước khi xây dựng ứng dụng. Nếu trạng thái phiên không khả dụng, middleware sẽ đóng lại với HTTP 500: ASP.NET Session is required for Doconut document security.

csharp
builder.Services.Configure<Doconut.Security.DocumentSecurityOptions>(options =>
{
    options.TokenQueryKey = "token";
    options.UnauthorizedMessage = "You Are Not Authorized To View This Page.";
});

Middleware trang cốt lõi sau đó xác minh dấu secure-{token} của phiên trước khi phục vụ tài liệu. Với UnsafeMode = true, UseDoconut() bỏ qua middleware truy cập và kiểm tra dấu cốt lõi cũng bị tắt.

Bảo mật trên nhiều nút

Token ràng buộc phiên giả định rằng nút phục vụ một trang cũng đã thấy yêu cầu mở tài liệu. Giả định này không đúng khi nhiều nút phục vụ cùng một tài liệu từ lưu trữ chung: một yêu cầu trang có thể đến một nút chưa từng thấy yêu cầu mở, và kiểm tra per-session sẽ từ chối.

Câu trả lời không phải là để tài liệu không được bảo vệ. Sử dụng ticket truy cập có chữ ký qua AddDoconutDistributedDocumentSecurity(...), thay thế kiểm tra phiên bằng một chứng chỉ mà mỗi nút có thể xác minh độc lập. Sắp xếp đầy đủ được mô tả trong Triển khai phân tán.

Thu hồi

CloseDocument(token) không chỉ giải phóng bộ nhớ — nó còn loại bỏ dấu secure-{token} và thu hồi access grant, vì vậy một token đã đóng sẽ chết ngay trên cả hai lớp bảo mật.

Danh sách kiểm tra cho môi trường production

  • Giữ UnsafeMode = false (mặc định) trên một nút duy nhất — công tắc toàn cục này là thứ ràng buộc token với các phiên.
  • Đăng ký AddDistributedMemoryCache() (các ứng dụng MVC và Razor Pages đã có sẵn) và AddSession(), và gọi app.UseSession() trước nhánh middleware Doconut.
  • Đảm bảo chính sách cookie phiên của bạn cho phép các yêu cầu widget mang cookie (SameSite, HTTPS).
  • Sử dụng CloseDocument khi người dùng rời tài liệu — cả bộ nhớ và bảo mật đều được cải thiện.
  • Không bao giờ ghi log hoặc chia sẻ token; coi chúng như chứng chỉ ngắn hạn.
  • Phục vụ từ lưu trữ chung? Chuyển sang ticket truy cập có chữ ký thay vì chấp nhận tài liệu không được bảo vệ.

Trang này có hữu ích không?