ArxPagingCookie

Definition

Namespace

ARX.SDK.Query

Package

ARX.SDK

public static class ArxPagingCookie

Properties

• const int MaxLength

  The longest cookie ARX reads, in characters: anything longer is refused before decoding.

• static byte[] ProcessKey { get; }

  This process's own random key: the key of every service that is given none, so services made per request still read each other's cookies. It changes with every process: another instance, or a restart, needs a shared key.

Methods

• static string Encode(string providerName, ReadOnlySpan<byte> state, string? query = null, byte[]? signingKey = null)

  A cookie for the next page.

  Parameter	Type	Description
  providerName	string	The provider writing it (checked when it is read back).
  state	ReadOnlySpan<byte>	The provider's position, in its own encoding.
  query	string?= null	A description of the query the cookie belongs to (its source, filter and order, never the page): a cookie used with another query is refused. Null for none.
  signingKey	byte[]?= null	Optional: a key of at least 32 bytes to sign the cookie with. The same key reads it back.

• static byte[] Decode(string cookie, string providerName, string? query = null, byte[]? signingKey = null)

  The provider's state from a cookie it wrote; ARX1001 when the cookie isn't one.

  Parameter	Type	Description
  cookie	string	The cookie from PagingCookie.
  providerName	string	The provider reading it: a cookie written by another is refused.
  query	string?= null	The same description of the query that Encode was given.
  signingKey	byte[]?= null	The key it was signed with; null when it wasn't signed. A signed cookie read without the key, or the reverse, is refused.

• static string Encode(string providerName, ReadOnlySpan<byte> state, string query, byte[] key, ArxPagingCookieProtection protection)

  A cookie for the next page, protected as protection says: Sealed (version 2: encrypted and authenticated, AES-256-GCM, so a client can neither read nor change it), Signed (version 1, HMAC-SHA256: readable, not changeable) or Plain (version 1, unsigned).

  Parameter	Type	Description
  providerName	string	The provider writing it (checked when it is read back).
  state	ReadOnlySpan<byte>	The provider's position, in its own encoding.
  query	string	A description of the query the cookie belongs to; a cookie used with another query is refused. Null for none.
  key	byte[]	The key (32 bytes or more) for Sealed and Signed; ignored for Plain.
  protection	ArxPagingCookieProtection	How the cookie is protected.

• static byte[] Decode(string cookie, string providerName, string query, byte[] key, ArxPagingCookieProtection protection)

  The provider's state from a cookie protected as protection says; ARX1001 when it isn't one: a cookie protected otherwise, changed, written by another provider or for another query, or sealed with another key (another instance of the application, or before a restart, without a shared key).

  Parameter	Type	Description
  cookie	string	The cookie from PagingCookie.
  providerName	string	The provider reading it.
  query	string	The same description of the query that Encode was given.
  key	byte[]	The key it was sealed or signed with; ignored for Plain.
  protection	ArxPagingCookieProtection	The protection the service requires.

• static byte[] NewKey()

  A new random key for paging cookies: 32 bytes.

Usage

var sharedKey = ArxPagingCookie.NewKey();

Protect paging cookies, scenario 2

Used in:

• Protect paging cookiesRetrieveMultiple