Add PrimaryKeySessionAuthenticator

Author: dereuromark

src/Authenticator/PrimaryKeySessionAuthenticator.php

@@ -0,0 +1,109 @@
+<?php
+declare(strict_types=1);
+
+namespace Authentication\Authenticator;
+
+use ArrayAccess;
+use Authentication\Identifier\IdentifierInterface;
+use Cake\Http\Exception\UnauthorizedException;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * Session Authenticator with only ID
+ */
+class PrimaryKeySessionAuthenticator extends SessionAuthenticator
+{
+    /**
+     * @param \Authentication\Identifier\IdentifierInterface $identifier
+     * @param array<string, mixed> $config
+     */
+    public function __construct(IdentifierInterface $identifier, array $config = [])
+    {
+        $config += [
+            'identify' => false, // Not in use
+        ];
+
+        parent::__construct($identifier, $config);
+    }
+
+    /**
+     * Authenticate a user using session data.
+     *
+     * @param \Psr\Http\Message\ServerRequestInterface $request The request to authenticate with.
+     * @return \Authentication\Authenticator\ResultInterface
+     */
+    public function authenticate(ServerRequestInterface $request): ResultInterface
+    {
+        $sessionKey = $this->getConfig('sessionKey');
+        /** @var \Cake\Http\Session $session */
+        $session = $request->getAttribute('session');
+
+        $userId = $session->read($sessionKey);
+        if (!$userId) {
+            return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND);
+        }
+
+        $user = $this->_identifier->identify(['id' => $userId]);
+        if (!$user) {
+            return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND);
+        }
+
+        return new Result($user, Result::SUCCESS);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function persistIdentity(ServerRequestInterface $request, ResponseInterface $response, $identity): array
+    {
+        $sessionKey = $this->getConfig('sessionKey');
+        /** @var \Cake\Http\Session $session */
+        $session = $request->getAttribute('session');
+
+        if (!$session->check($sessionKey)) {
+            $session->renew();
+            $session->write($sessionKey, $identity['id']);
+        }
+
+        return [
+            'request' => $request,
+            'response' => $response,
+        ];
+    }
+
+    /**
+     * Impersonates a user
+     *
+     * @param \Psr\Http\Message\ServerRequestInterface $request The request
+     * @param \Psr\Http\Message\ResponseInterface $response The response
+     * @param \ArrayAccess $impersonator User who impersonates
+     * @param \ArrayAccess $impersonated User impersonated
+     * @return array
+     */
+    public function impersonate(
+        ServerRequestInterface $request,
+        ResponseInterface $response,
+        ArrayAccess $impersonator,
+        ArrayAccess $impersonated,
+    ): array {
+        $sessionKey = $this->getConfig('sessionKey');
+        $impersonateSessionKey = $this->getConfig('impersonateSessionKey');
+        /** @var \Cake\Http\Session $session */
+        $session = $request->getAttribute('session');
+        if ($session->check($impersonateSessionKey)) {
+            throw new UnauthorizedException(
+                'You are impersonating a user already. ' .
+                'Stop the current impersonation before impersonating another user.',
+            );
+        }
+        $session->write($impersonateSessionKey, $impersonator['id']);
+        $session->write($sessionKey, $impersonated['id']);
+        $this->setConfig('identify', true);
+
+        return [
+            'request' => $request,
+            'response' => $response,
+        ];
+    }
+}