Skip to main content
Version: Latest
Technical ManualLooking for step-by-step instructions? In the User Manual: Protected Information

Protected information

A ticket can carry protected items: a label and a secret value, such as a login a requester shares. ITicketProtectedInformation (DefaultTicketProtectedInformation) keeps each one as a TicketProtectedItemDocument of its own, apart from the ticket's content item, with the value encrypted by ASP.NET Core Data Protection (the tenant's keys, purpose CrestApps.OrchardCore.Tickets.ProtectedInformation); TicketProtectedItemIndex holds only the item and ticket ids. Since the ticket never holds them, they never reach TicketIndex, the ticket list, search, reports and data sets, content exports and deployment steps, the API, webhooks and workflow payloads (TicketApiModel and TicketApiEntry), e-mails, notifications or the AI tools and assistant. Every addition, removal, reveal and wrong password is an internal Event entry on the ticket's timeline with the labels only. A label is up to 100 characters, a value up to 2,000, and a ticket holds up to 20.

  • Permission: TicketOperation.ViewProtected, the per-desk permission View protected information in {desk} (ViewProtectedTicketInformation_{0}), implied by the security-critical ViewProtectedTicketInformation, which the Administrator role gets by default on a new site (existing roles get it from the role editor). Adding needs the desk's Note permission.
  • Showing: POST Admin/ticket/{id}/protected/show checks the agent's current password with SignInManager.CheckPasswordSignInAsync (ITicketPasswordConfirmation), so wrong passwords count toward the account's lockout. A confirmed password opens a 5-minute window for that user, that ticket and that tenant, kept server-side in IDistributedCache (TicketProtectedReveals); hide closes it. A user with no local password (external sign-in only) is refused with a message rather than shown the values without a check. add and remove are the other actions.
  • Requesters: the portal's new request and reply forms and the web form post an optional protectedLabel and protectedValue. On their request's page the requester reaches only the items they shared (TicketProtectedItem.FromRequester; the requesterSharedOnly arguments), never those agents keep on the ticket: they see the labels and, signed in, show the values with their own password (account/requests/{number}/protected/show) and remove them; a guest, who has no password to confirm, sees the labels and may remove them through their link. A page that shows values is sent with Cache-Control: no-store (TicketProtectedReveals.PreventCaching), so the browser never shows them again after Hide.
  • Indicators: a lock badge on the ticket page and in the list rows (both layouts, one FindTicketsWithItemsAsync query a page), and on the requester's request page and list.
  • Life cycle: a merge moves the items to the target ticket in the merge's transaction; deleting a ticket deletes them in the removal's transaction (TicketContentCleanup); a personal data erasure of the requester deletes them; TicketDesk.DeleteProtectedInformationDays (0 keeps them) has TicketProtectedInformationCleaner delete them that many days after the ticket closed, run by the auto-close background task.

The items are documents of the ServiceDesk collection (see Storage).