[Security] Renamed simple_token to simple_http, added support for failure and success handler to both simple firewalls

2 files changed, 133 insertions, 12 deletions

diff --git a/Http/Authentication/SimpleAuthenticationHandler.php b/Http/Authentication/SimpleAuthenticationHandler.php
new file mode 100644
index 0000000..ce56ee3
--- /dev/null
+++ b/Http/Authentication/SimpleAuthenticationHandler.php
@@ -0,0 +1,105 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Authentication;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Authentication\SimpleAuthenticatorInterface;
+
+/**
+ * Class to proxy authentication success/failure handlers
+ *
+ * Events are sent to the SimpleAuthenticatorInterface if it implements
+ * the right interface, otherwise (or if it fails to return a Response)
+ * the default handlers are triggered.
+ *
+ * @author Jordi Boggiano <j.boggiano@seld.be>
+ */
+class SimpleAuthenticationHandler implements AuthenticationFailureHandlerInterface, AuthenticationSuccessHandlerInterface
+{
+    protected $successHandler;
+    protected $failureHandler;
+    protected $simpleAuthenticator;
+
+    /**
+     * Constructor.
+     *
+     * @param SimpleAuthenticatorInterface          $authenticator  SimpleAuthenticatorInterface instance
+     * @param AuthenticationSuccessHandlerInterface $successHandler Default success handler
+     * @param AuthenticationFailureHandlerInterface $failureHandler Default failure handler
+     * @param LoggerInterface                       $logger         Optional logger
+     */
+    public function __construct(SimpleAuthenticatorInterface $authenticator, AuthenticationSuccessHandlerInterface $successHandler, AuthenticationFailureHandlerInterface $failureHandler, LoggerInterface $logger = null)
+    {
+        $this->simpleAuthenticator = $authenticator;
+        $this->successHandler = $successHandler;
+        $this->failureHandler = $failureHandler;
+        $this->logger = $logger;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token)
+    {
+        if ($this->simpleAuthenticator instanceof AuthenticationSuccessHandlerInterface) {
+            if ($this->logger) {
+                $this->logger->debug(sprintf('Using the %s object as authentication success handler', get_class($this->simpleAuthenticator)));
+            }
+
+            $response = $this->simpleAuthenticator->onAuthenticationSuccess($request, $token);
+            if ($response instanceof Response) {
+                return $response;
+            }
+
+            if (null !== $response) {
+                throw new \UnexpectedValueException(sprintf('The %s::onAuthenticationSuccess method must return null to use the default success handler, or a Response object', get_class($this->simpleAuthenticator)));
+            }
+        }
+
+        if ($this->logger) {
+            $this->logger->debug('Fallback to the default authentication success handler');
+        }
+
+        return $this->successHandler->onAuthenticationSuccess($request, $token);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
+    {
+        if ($this->simpleAuthenticator instanceof AuthenticationFailureHandlerInterface) {
+            if ($this->logger) {
+                $this->logger->debug(sprintf('Using the %s object as authentication failure handler', get_class($this->simpleAuthenticator)));
+            }
+
+            $response = $this->simpleAuthenticator->onAuthenticationFailure($request, $exception);
+            if ($response instanceof Response) {
+                return $response;
+            }
+
+            if (null !== $response) {
+                throw new \UnexpectedValueException(sprintf('The %s::onAuthenticationFailure method must return null to use the default failure handler, or a Response object', get_class($this->simpleAuthenticator)));
+            }
+        }
+
+        if ($this->logger) {
+            $this->logger->debug('Fallback to the default authentication failure handler');
+        }
+
+        return $this->failureHandler->onAuthenticationFailure($request, $exception);
+    }
+}
diff --git a/Http/Firewall/SimpleTokenAuthenticationListener.php b/Http/Firewall/SimpleHttpAuthenticationListener.php
index cda535b..ab49b14 100644
--- a/Http/Firewall/SimpleTokenAuthenticationListener.php
+++ b/Http/Firewall/SimpleHttpAuthenticationListener.php
@@ -16,16 +16,19 @@ use Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterfac
 use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
-use Symfony\Component\Security\Core\Authentication\SimpleTokenAuthenticatorInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Security\Core\Authentication\SimpleHttpAuthenticatorInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface;
+use Symfony\Component\Security\Http\Authentication\AuthenticationSuccessHandlerInterface;
 
 /**
- * SimpleTokenListener implements simple proxying to an authenticator.
+ * SimpleHttpListener implements simple proxying to an authenticator.
  *
  * @author Jordi Boggiano <j.boggiano@seld.be>
  */
-class SimpleTokenAuthenticationListener implements ListenerInterface
+class SimpleHttpAuthenticationListener implements ListenerInterface
 {
     private $securityContext;
     private $authenticationManager;
@@ -39,10 +42,10 @@ class SimpleTokenAuthenticationListener implements ListenerInterface
      * @param SecurityContextInterface         $securityContext       A SecurityContext instance
      * @param AuthenticationManagerInterface   $authenticationManager An AuthenticationManagerInterface instance
      * @param string                           $providerKey
-     * @param SimpleTokenAuthenticatorInterface $simpleAuthenticator   A SimpleTokenAuthenticatorInterface instance
+     * @param SimpleHttpAuthenticatorInterface $simpleAuthenticator   A SimpleHttpAuthenticatorInterface instance
      * @param LoggerInterface                  $logger                A LoggerInterface instance
      */
-    public function __construct(SecurityContextInterface $securityContext, AuthenticationManagerInterface $authenticationManager, $providerKey, SimpleTokenAuthenticatorInterface $simpleAuthenticator, LoggerInterface $logger = null)
+    public function __construct(SecurityContextInterface $securityContext, AuthenticationManagerInterface $authenticationManager, $providerKey, SimpleHttpAuthenticatorInterface $simpleAuthenticator, LoggerInterface $logger = null)
     {
         if (empty($providerKey)) {
             throw new \InvalidArgumentException('$providerKey must not be empty.');
@@ -65,26 +68,39 @@ class SimpleTokenAuthenticationListener implements ListenerInterface
         $request = $event->getRequest();
 
         if (null !== $this->logger) {
-            $this->logger->info(sprintf('Attempting simple token authorization %s', $this->providerKey));
+            $this->logger->info(sprintf('Attempting simple http authorization %s', $this->providerKey));
         }
 
-
         try {
             $token = $this->simpleAuthenticator->createToken($request, $this->providerKey);
             $token = $this->authenticationManager->authenticate($token);
             $this->securityContext->setToken($token);
-
-        } catch (AuthenticationException $failed) {
+        } catch (AuthenticationException $e) {
             $this->securityContext->setToken(null);
 
             if (null !== $this->logger) {
-                $this->logger->info(sprintf('Authentication request failed: %s', $failed->getMessage()));
+                $this->logger->info(sprintf('Authentication request failed: %s', $e->getMessage()));
+            }
+
+            if ($this->simpleAuthenticator instanceof AuthenticationFailureHandlerInterface) {
+                $response = $this->simpleAuthenticator->onAuthenticationFailure($request, $e);
+                if ($response instanceof Response) {
+                    $event->setResponse($response);
+                } elseif (null !== $response) {
+                    throw new \UnexpectedValueException(sprintf('The %s::onAuthenticationFailure method must return null or a Response object', get_class($this->simpleAuthenticator)));
+                }
             }
 
-            // TODO call failure handler
             return;
         }
 
-        // TODO call success handler
+        if ($this->simpleAuthenticator instanceof AuthenticationSuccessHandlerInterface) {
+            $response = $this->simpleAuthenticator->onAuthenticationSuccess($request, $token);
+            if ($response instanceof Response) {
+                $event->setResponse($response);
+            } elseif (null !== $response) {
+                throw new \UnexpectedValueException(sprintf('The %s::onAuthenticationSuccess method must return null or a Response object', get_class($this->simpleAuthenticator)));
+            }
+        }
     }
 }