add documentation about access denied handler

symfony · nykopol · Oct 31, 2016 · Nov 1, 2016 · Nov 1, 2016 · Nov 3, 2016
commit 10eff8514491c7e98a401d161caa801b6e73921a
diff --git a/security.rst b/security.rst
@@ -1295,6 +1295,7 @@ Authorization (Denying Access)
     security/force_https
     security/securing_services
     security/access_control
+    security/access_denied_handler
 
 Other Security Related Topics
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/security/access_denied_handler.rst b/security/access_denied_handler.rst
@@ -0,0 +1,68 @@
+.. index::
+    single: Security; Creating a Custom Access Denied Handler
+
+How to Create a Custom Access Denied Handler
+============================================
+
+When your application throw an ``AccessDeniedException`` you can catch this exception
+with a service to return a custom Response.
+
+On each firewall context you can define a custom access denied handler.
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/security.yml
+        firewalls:
+            foo:
+                # ...
+                access_denied_handler: custom_handler.service.id
+
+    .. code-block:: php
+
+        // app/config/security.php
+        $container->loadFromExtension('security', array(
+            'firewalls' => array(
+                'foo' => array(
+                    // ...
+                    'access_denied_handler' => 'custom_handler.service.id',
+                ),
+            ),
+        ));
+
+
+Your handler must implement the interface
+:class:`Symfony\\Component\\Security\\Http\\Authorization\\AccessDeniedHandlerInterface`.
+This interface define one method called ``handle()`` that can do whatever you want.
+You can use it to send a mail, log a message, or generally return a custom Response.
+
+
+.. code-block:: php
+
+    namespace AppBundle\Security;
+
+    use Symfony\Component\Security\Http\Authorization\AccessDeniedHandlerInterface;
+    use Symfony\Component\HttpFoundation\Request;
+    use Symfony\Component\HttpFoundation\Response;
+    use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+
+    class AccessDeniedHandler implements AccessDeniedHandlerInterface
+    {
+        public function handle(Request $request, AccessDeniedException $accessDeniedException)
+        {
+            // to some stuff...
+            return new Response($content, 403);
+        }
+    }
+
+Then you must register your service :
+
+.. code-block:: yml
+
+    # app/config/services.yml
+    services:
+        custom_handler.service.id:
+            class: AppBundle\Security\AccessDeniedHandler
+
+That's it, now on the ``foo`` firewall, all ``AccessDeniedException`` will be notified to you service.