Package 'cookie'

Cookie Parser Middleware

Description

Creates a middleware function that parses the Cookie HTTP header and populates req$cookies. When a secret is provided, signed cookies are verified and exposed on req$signedCookies.

Usage

cookieParser(secret = NULL, options = NULL)

Arguments

secret	A character vector or list of strings used to sign and verify cookies. Optional.
options	A function used to decode cookie values. Defaults to utils::URLdecode().

Value

A middleware function that sets req$cookies, req$signedCookies, and req$secret, then calls forward().

---

Serialise a Set-Cookie Header

Description

Serialises a cookie name-value pair into a Set-Cookie header string.

Usage

serialise(name, val = NULL, ...)

Arguments

name	A string with the cookie name, or a list with ⁠$name⁠ and ⁠$value⁠ elements (in which case val is ignored).
val	A string. The cookie value.
...	Additional cookie attributes: encode A function to encode the cookie value. Defaults to utils::URLencode(). maxAge An integer. Number of seconds until the cookie expires. domain A string. The cookie domain. path A string. The cookie path. expires A Date, POSIXct, or POSIXt. The expiry date. httpOnly Logical. Adds the HttpOnly attribute. secure Logical. Adds the Secure attribute. partitioned Logical. Adds the Partitioned attribute. priority A string: "low", "medium", or "high". sameSite A string ("strict", "lax", "none") or logical (TRUE maps to "Strict").

Value

A Set-Cookie header string.

Examples

serialise("session", "abc123")
serialise("id", "42", httpOnly = TRUE, secure = TRUE, sameSite = "lax")

---

Sign a Cookie Value

Description

Sign the given val with secret.

Usage

sign(val, secret)

Arguments

val	A string. The cookie value to sign.
secret	The secret key used to generate the signature.

Value

A string of the form "<val>.<signature>".

Examples

sign("hello", "tobiiscool")

---

Unsign a Cookie Value

Description

Verifies the signature of a signed cookie value and returns the original value if valid, or FALSE if the signature does not match.

Usage

unsign(input, secret)

Arguments

input	A string. A signed cookie value produced by sign().
secret	The secret key to verify against.

Value

The original unsigned value if verification succeeds, FALSE otherwise.

Examples

input <- sign("hello", "tobiiscool")
unsign(input, "tobiiscool")
unsign(input, "luna")

---