Sessioner & Säkerhet

Dokumentsessioner och åtkomstkontroll

Ett Doconut‑token är kraftfullt: den som presenterar det kan begära varje sida i dokumentet om det inte var bundet till den öppnande sessionen. Den här sidan förklarar vad en session innehåller, hur länge den varar och vilka kontroller UseDoconut() aktiverar 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‑status — rotation, vändningar och annoteringsdata som användaren applicerar i widgeten,
  • det valfria sökindexet, byggt vid den första sökningen (eller laddat från en förbyggd .srh‑fil när sidor serveras från delat lagringsutrymme),
  • 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 token. När en session blir utkastad — genom utgång eller av CloseDocument(token) — tar dess utkastnings‑callback bort dokumentmotorn och frigör det associerade minnet omedelbart.

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

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

Inbyggd tokenbindning

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

  • Olika webbläsare/session som presenterar ett stulet 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 sessions‑cookie med sidbegäranden. Cross‑origin‑inställningar som tar bort cookies (eller en API‑klient utan cookie‑burk) 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 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 avstängning; 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 ett token, söker den upp åtkomsttillståndet som registrerades när dokumentet öppnades och godkänner endast om alla följande gäller:

  1. ett tillstånd finns för tokenet,
  2. det har inte löpt ut (tillståndets livstid = dokumentets TimeOut),
  3. den begärande ASP.NET‑session‑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åge‑nyckeln 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:n med stängt fel med 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.";
});

Kärn‑sid‑middleware verifierar sedan secure-{token}‑sessions‑markören innan den levererar dokumentet. Med UnsafeMode = true hoppar UseDoconut() över åtkomst‑middleware och kärn‑markör‑kontrollen ä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 levererar samma dokument från delat lagringsutrymme: 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 en behörighetsuppgift som varje nod kan verifiera oberoende. Den fullständiga arrangemanget finns på Distribuerade distributioner.

Återkallelse

CloseDocument(token) frigör inte bara minnet — den tar också bort secure-{token}‑markören och återkallar åtkomsttillståndet, så ett stängt token är omedelbart dött 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 redan den) och AddSession(), och anropa app.UseSession() före Doconut‑middleware‑grenen.
  • Säkerställ att din sessions‑cookie‑policy låter widgetens begäranden bära cookie:n (SameSite, HTTPS).
  • Använd CloseDocument när användaren lämnar dokumentet — både minne och säkerhet drar nytta av det.
  • Logga eller dela aldrig token; behandla dem som kortlivade referenser.
  • Levererar du från delat lagringsutrymme? Gå över till signerade åtkomstbiljetter istället för att acceptera oskyddade dokument.

Var den här sidan hjälpsam?