Issue 35 partitioned cookie

src/Cookie.php

@@ -31,6 +31,7 @@ final class Cookie {
 	const SAME_SITE_RESTRICTION_NONE = 'None';
 	const SAME_SITE_RESTRICTION_LAX = 'Lax';
 	const SAME_SITE_RESTRICTION_STRICT = 'Strict';
+	const PARTITIONED = 'Partitioned';
 
 	/** @var string the name of the cookie which is also the key for future accesses via `$_COOKIE[...]` */
 	private $name;
@@ -48,6 +49,8 @@ final class Cookie {
 	private $secureOnly;
 	/** @var string|null indicates that the cookie should not be sent along with cross-site requests (either `null`, `None`, `Lax` or `Strict`) */
 	private $sameSiteRestriction;
+	/** @var string|null indicates that the cookie should be partitioned to comply with CHIPS see https://developer.mozilla.org/en-US/docs/Web/Privacy/Privacy_sandbox/Partitioned_cookies */
+	private $partitioned;
 
 	/**
 	 * Prepares a new cookie
@@ -63,6 +66,7 @@ public function __construct($name) {
 		$this->httpOnly = true;
 		$this->secureOnly = false;
 		$this->sameSiteRestriction = self::SAME_SITE_RESTRICTION_LAX;
+		$this->partitioned = false;
 	}
 
 	/**
@@ -242,6 +246,22 @@ public function setSameSiteRestriction($sameSiteRestriction) {
 		return $this;
 	}
 
+	/**
+	 * Anything truthy passed in will set 'Partitioned' on the cookie
+	 * @param false|string|null $partitioned
+	 */
+	public function setPartitioned($partitioned)
+	{
+		if ($partitioned) {
+			$partitioned = self::PARTITIONED;
+		}
+		else {
+			$partitioned = null;
+		}
+		$this->partitioned = $partitioned;
+	}
+
+
 	/**
 	 * Saves the cookie
 	 *
@@ -326,9 +346,10 @@ public static function setcookie($name, $value = null, $expiryTime = 0, $path =
 	 * @param bool $secureOnly indicates that the cookie should be sent back by the client over secure HTTPS connections only
 	 * @param bool $httpOnly indicates that the cookie should be accessible through the HTTP protocol only and not through scripting languages
 	 * @param string|null $sameSiteRestriction indicates that the cookie should not be sent along with cross-site requests (either `null`, `None`, `Lax` or `Strict`)
+	 * @param string|null $partitioned indicates that the cookie should be partitioned for CHIPS compatibility. See https://developer.mozilla.org/en-US/docs/Web/Privacy/Privacy_sandbox/Partitioned_cookies`)
 	 * @return string the HTTP header
 	 */
-	public static function buildCookieHeader($name, $value = null, $expiryTime = 0, $path = null, $domain = null, $secureOnly = false, $httpOnly = false, $sameSiteRestriction = null) {
+	public static function buildCookieHeader($name, $value = null, $expiryTime = 0, $path = null, $domain = null, $secureOnly = false, $httpOnly = false, $sameSiteRestriction = null, $partitioned = null) {
 		if (self::isNameValid($name)) {
 			$name = (string) $name;
 		}
@@ -398,6 +419,10 @@ public static function buildCookieHeader($name, $value = null, $expiryTime = 0,
 			$headerStr .= '; SameSite=Strict';
 		}
 
+		if ($partitioned) {
+			$headerStr .= '; ' . self::PARTITIONED;
+		}
+
 		return $headerStr;
 	}
 
@@ -443,6 +468,9 @@ public static function parse($cookieHeader) {
 					elseif (\stripos($attribute, 'SameSite=') === 0) {
 						$cookie->setSameSiteRestriction(\substr($attribute, 9));
 					}
+					elseif (\stripos($attribute, 'Partitioned') === 0) {
+						$cookie->setPartitioned(true);
+					}
 				}
 			}
 

tests/index.php

@@ -19,14 +19,18 @@
 // start output buffering
 \ob_start();
 
-\testCookie(null);
-\testCookie(false);
-\testCookie('');
-\testCookie(0);
+try {
+	\testCookie(null);
+	\testCookie(false);
+	\testCookie('');
+	\testCookie(0);
+	\testCookie('hello', null);
+} catch (\Throwable $e) {
+	echo $e->getMessage();
+}
 \testCookie('hello');
 \testCookie('hello', false);
 \testCookie('hello', true);
-\testCookie('hello', null);
 \testCookie('hello', '');
 \testCookie('hello', 0);
 \testCookie('hello', 1);
@@ -118,6 +122,7 @@
 \testEqual((new \Delight\Cookie\Cookie('key'))->setValue('value')->setDomain('.www.example.com'), 'Set-Cookie: key=value; path=/; domain=.www.example.com; httponly; SameSite=Lax');
 \testEqual((new \Delight\Cookie\Cookie('key'))->setValue('value')->setDomain('blog.example.com'), 'Set-Cookie: key=value; path=/; domain=.blog.example.com; httponly; SameSite=Lax');
 \testEqual((new \Delight\Cookie\Cookie('key'))->setValue('value')->setDomain('.blog.example.com'), 'Set-Cookie: key=value; path=/; domain=.blog.example.com; httponly; SameSite=Lax');
+\testEqual((new \Delight\Cookie\Cookie('SID'))->setValue('31d4d96e407aad42')->setSameSiteRestriction('Lax')->setSecureOnly(true)->setPartitioned(true), 'Set-Cookie: SID=31d4d96e407aad42; path=/; secure; httponly; SameSite=Lax; Partitioned');
 
 \testEqual(\Delight\Cookie\Cookie::parse('Set-Cookie: SID'), '');
 \testEqual(\Delight\Cookie\Cookie::parse('Set-Cookie: SID=31d4d96e407aad42'), 'Set-Cookie: SID=31d4d96e407aad42');