[1.16] Add Page::authenticate

Sends credentials with Fetch.continueWithAuth when Fetch.authRequired is received.
CancelAuth response is used after a failed attempt and an exception is thrown.

Author: enricodias

README.md

@@ -683,6 +683,21 @@ if ($cookieBar) {
 }
 ```
 
+### HTTP Authentication
+
+You can set credentials for HTTP Basic Authentication using `Page::authenticate` before navigating to a protected page or when using a proxy. If the credentials are invalid, an `AuthenticationFailed` exception is thrown.
+
+```php
+use HeadlessChromium\Exception\AuthenticationFailed;
+
+try {
+    $page->authenticate('username', 'password');
+    $page->navigate('http://example.com/protected')->waitForNavigation();
+} catch (AuthenticationFailed $e) {
+    // invalid credentials
+}
+```
+
 ### Set user agent
 
 You can set up a user-agent per page:

src/Exception/AuthenticationFailed.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of Chrome PHP.
+ *
+ * (c) Soufiane Ghzal <sghzal@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace HeadlessChromium\Exception;
+
+class AuthenticationFailed extends \Exception
+{
+}

src/Page.php

@@ -21,6 +21,7 @@
 use HeadlessChromium\Dom\Node;
 use HeadlessChromium\Dom\Selector\CssSelector;
 use HeadlessChromium\Dom\Selector\Selector;
+use HeadlessChromium\Exception\AuthenticationFailed;
 use HeadlessChromium\Exception\CommunicationException;
 use HeadlessChromium\Exception\EvaluationFailed;
 use HeadlessChromium\Exception\InvalidTimezoneId;
@@ -160,6 +161,64 @@ public function getSession(): Session
         return $this->target->getSession();
     }
 
+    /**
+     * Sets credentials to be used when the page encounters an HTTP authentication challenge.
+     *
+     * @throws AuthenticationFailed
+     * @throws CommunicationException
+     */
+    public function authenticate(string $username, string $password): void
+    {
+        $this->assertNotClosed();
+
+        $credentialsAttempted = false;
+
+        $this->getSession()->on('method:Fetch.authRequired', function (array $params) use ($username, $password, &$credentialsAttempted) {
+            if ($credentialsAttempted) {
+                $this->getSession()->sendMessageSync(
+                    new Message('Fetch.continueWithAuth', [
+                        'requestId' => $params['requestId'],
+                        'authChallengeResponse' => [
+                            'response' => 'CancelAuth',
+                        ],
+                    ])
+                );
+
+                throw new AuthenticationFailed('Authentication failed: invalid credentials.');
+            }
+
+            $credentialsAttempted = true;
+
+            $this->getSession()->sendMessageSync(
+                new Message('Fetch.continueWithAuth', [
+                    'requestId' => $params['requestId'],
+                    'authChallengeResponse' => [
+                        'response' => 'ProvideCredentials',
+                        'username' => $username,
+                        'password' => $password,
+                    ],
+                ])
+            );
+        });
+
+        $this->getSession()->on('method:Fetch.requestPaused', function (array $params) {
+            $this->getSession()->sendMessageSync(
+                new Message('Fetch.continueRequest', [
+                    'requestId' => $params['requestId'],
+                ])
+            );
+        });
+
+        $this->getSession()->sendMessageSync(
+            new Message('Fetch.enable', [
+                'handleAuthRequests' => true,
+                'patterns' => [
+                    ['urlPattern' => '*'],
+                ],
+            ])
+        );
+    }
+
     /**
      * Sets the HTTP header necessary for basic authentication.
      *

tests/AuthenticationTest.php

@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of Chrome PHP.
+ *
+ * (c) Soufiane Ghzal <sghzal@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace HeadlessChromium\Test;
+
+use HeadlessChromium\BrowserFactory;
+use HeadlessChromium\Exception\AuthenticationFailed;
+
+/**
+ * @covers \HeadlessChromium\Page::authenticate
+ */
+class AuthenticationTest extends HttpEnabledTestCase
+{
+    private const AUTH_URL = 'basic-auth.php';
+    private const VALID_USER = 'testuser';
+    private const VALID_PASS = 'testpass';
+
+    public function testAuthenticateAllowsAccessWithValidCredentials(): void
+    {
+        $page = (new BrowserFactory())->createBrowser()->createPage();
+
+        $page->authenticate(self::VALID_USER, self::VALID_PASS);
+        $page->navigate(self::sitePath(self::AUTH_URL))->waitForNavigation();
+
+        // let's hit it twice to ensure subsequent requests also work
+        $page->navigate(self::sitePath(self::AUTH_URL))->waitForNavigation();
+
+        self::assertStringContainsString('Authenticated', $page->getHtml());
+    }
+
+    public function testAuthenticateThrowsOnInvalidCredentials(): void
+    {
+        $this->expectException(AuthenticationFailed::class);
+
+        $page = (new BrowserFactory())->createBrowser()->createPage();
+
+        $page->authenticate('wrong', 'credentials');
+
+        $page->navigate(self::sitePath(self::AUTH_URL))->waitForNavigation();
+    }
+
+    public function testAuthenticateWithoutCredentialsDeniesAccess(): void
+    {
+        $page = (new BrowserFactory())->createBrowser()->createPage();
+
+        $page->navigate(self::sitePath(self::AUTH_URL))->waitForNavigation();
+
+        self::assertStringNotContainsString('Authenticated', $page->getHtml());
+    }
+}

tests/resources/static-web/basic-auth.php

@@ -0,0 +1,16 @@
+<?php
+
+$expectedUser = 'testuser';
+$expectedPass = 'testpass';
+
+$user = $_SERVER['PHP_AUTH_USER'] ?? null;
+$pass = $_SERVER['PHP_AUTH_PW'] ?? null;
+
+if ($user !== $expectedUser || $pass !== $expectedPass) {
+    \header('WWW-Authenticate: Basic realm="Test"');
+    \http_response_code(401);
+    echo 'Unauthorized';
+    exit;
+}
+
+echo 'Authenticated';