Sessioner & Säkerhet

Dokumentsessioner och åtkomstkontroll

En Doconut-token är kraftfull: den som presenterar den kan begära varje sida i dokumentet om den inte var bunden till den öppnande sessionen. Den här sidan förklarar vad en session innehåller, hur länge den varar och vilka kontroller UseDoconut() möjliggör som standard.

Vad en dokumentsession innehåller

Varje lyckad OpenDocumentAsync skapar en session i IMemoryCache:

  • den laddade formatvisaren (dokumentmotorinstansen som håller det parsade dokumentet),
  • per-sida-tillstånd — rotation, vändningar och annoteringsdata som användaren applicerar i widgeten,
  • det valfria sökindexet, byggt lat på den första sökningen (eller laddat från en förbyggd .srh-fil när sidor serveras från delat lagring),
  • sessionens vattenstämpel från DocOptions.Watermark.

Livstid

Sessioner löper ut på ett glidande fönster: DocOptions.TimeOut minuter (standard 60), återställs av varje begäran som presenterar tokenen. När en session blir utkastad — genom utgång eller av CloseDocument(token) — rensar dess utkastningscallback dokumentmotorn och frigör det tillhörande minnet omedelbart.

csharp
// En kortlivad session för en engångsförhandsgranskning
var token = await viewer.OpenDocumentAsync(path, new DocOptions { TimeOut = 10 });

En begäran med en utgången token får en felbild som visar Document session not found. Please re-open document. — klienten måste öppna om för att få en ny token.

Inbyggd tokenbindning

Med UnsafeMode = false (standard) binder OpenDocumentAsync den nya tokenen till ASP.NET-sessionen för HTTP‑begäran som öppnade den, genom att skriva en secure-{token}-markör i den sessionen. Doconut‑middleware vägrar sedan att leverera sidor till någon annan webbläsarsession:

  • En annan webbläsare/session som presenterar en stulen token → felbild You Are Not Authorized To View This Page.
  • Session‑middleware inte registrerad → HTTP 500 Session middleware not configured. Call UseSession() before UseDoconut().

Detta är varför Quick Start insisterar på AddSession() + app.UseSession() före Doconut‑grenen. Två praktiska konsekvenser:

  • Klienten måste skicka ASP.NET sessionskakan med sidbegäranden. Cross‑origin‑uppsättningar som tar bort kakor (eller en API‑klient utan cookie‑behållare) kommer att misslyckas med kontrollen — det är funktionen som fungerar, inte en bugg.
  • options.UnsafeMode = true inaktiverar bindningen helt. Den finns för kontrollerade scenarier (t.ex. server‑till‑server‑rendering); låt den vara false i produktion.

Tokenbindning styrs enbart av denna globala UnsafeMode‑växel — den är på som standard (UnsafeMode = false) och gäller för varje session. Det finns ingen per‑dokument‑avaktivering; att sätta UnsafeMode = true inaktiverar bindningen globalt.

Åtkomsttillstånd och autentiserade användare

När UnsafeMode är false, sätter UseDoconut() in DocumentAccessMiddleware automatiskt före sid‑middleware. Registrera den inte en andra gång. När en begäran bär en token, slår den upp åtkomsttillståndet som registrerades när dokumentet öppnades och godkänner bara om alla följande gäller:

  1. ett tillstånd finns för tokenen,
  2. det har inte löpt ut (tillståndets livstid = dokumentets TimeOut),
  3. den begärande ASP.NET‑sessions‑ID:n matchar den som öppnade dokumentet,
  4. om öppnaren var autentiserad, matchar den begärande användarens NameIdentifier‑anspråk också.

Fel returnerar 403 — som en PNG‑felbild för sid‑/miniatyr‑begäranden, som vanlig text annars. Meddelandet och token‑frågeparametern kommer från DocumentSecurityOptions (TokenQueryKey, standard "token"; UnauthorizedMessage, standard "You Are Not Authorized To View This Page."). Konfigurera dessa alternativ via ASP.NET Core DI innan appen byggs. Om sessions‑tillstånd är otillgängligt misslyckas middleware med stängd status och 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.";
});

Den centrala sid‑middleware verifierar sedan secure-{token}‑sessions‑markören innan den levererar dokumentet. Med UnsafeMode = true hoppar UseDoconut() över åtkomst‑middleware och den centrala markörkontrollen är också inaktiverad.

Säkerhet över flera noder

Session‑bundna token antar att noden som levererar en sida också såg begäran som öppnade dokumentet. Detta antagande gäller inte när flera noder serverar samma dokument från delat lagring: en sid‑begäran kan hamna på en nod som aldrig såg öppningen, och per‑session‑kontrollen avvisar den.

Svaret är inte att lämna dokument oskyddade. Använd signerade åtkomstbiljetter via AddDoconutDistributedDocumentSecurity(...), vilket ersätter sessionskontrollen med ett credential som varje nod kan verifiera oberoende. Den fullständiga lösningen finns på Distribuerade distributioner.

Återkallelse

CloseDocument(token) frigör inte bara minne — den tar också bort secure-{token}‑markören och återkallar åtkomsttillståndet, så en stängd token är omedelbart död på båda säkerhetslagren.

Checklista för produktion

  • Behåll UnsafeMode = false (standard) på en enda nod — denna globala växel är det som binder token till sessioner.
  • Registrera AddDistributedMemoryCache() (MVC‑ och Razor‑Pages‑appar har den redan) och AddSession(), och anropa app.UseSession() före Doconut‑middleware‑grenen.
  • Se till att din sessionskaka‑policy låter widgetens begäranden bära kakorna (SameSite, HTTPS).
  • Använd CloseDocument när användaren lämnar dokumentet — både minne och säkerhet gynnas.
  • Logga eller dela aldrig token; behandla dem som kortlivade credentials.
  • Serverar du från delat lagring? Gå över till signerade åtkomstbiljetter istället för att acceptera oskyddade dokument.

Var den här sidan hjälpsam?