Updated according to comment and changed to AppBundle

Author: peterrehm

cookbook/security/api_key_authentication.rst

@@ -22,8 +22,8 @@ Your exact situation may differ, but in this example, a token is read
 from an ``apikey`` query parameter, the proper username is loaded from that
 value and then a User object is created::
 
-    // src/Acme/HelloBundle/Security/ApiKeyAuthenticator.php
-    namespace Acme\HelloBundle\Security;
+    // src/AppBundle/Security/ApiKeyAuthenticator.php
+    namespace AppBundle\Security;
 
     use Symfony\Component\Security\Core\Authentication\SimplePreAuthenticatorInterface;
     use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
@@ -147,8 +147,8 @@ used by Symfony's core user provider system).
 
 The ``$userProvider`` might look something like this::
 
-    // src/Acme/HelloBundle/Security/ApiKeyUserProvider.php
-    namespace Acme\HelloBundle\Security;
+    // src/AppBundle/Security/ApiKeyUserProvider.php
+    namespace AppBundle\Security;
 
     use Symfony\Component\Security\Core\User\UserProviderInterface;
     use Symfony\Component\Security\Core\User\User;
@@ -192,6 +192,44 @@ The ``$userProvider`` might look something like this::
         }
     }
 
+No register your user provider as service.
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/services.yml
+        services:
+            api_key_user_provider:
+                class:     AppBundle\Security\ApiKeyUserProvider
+
+    .. code-block:: xml
+
+        <!-- app/config/services.xml -->
+        <?xml version="1.0" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd">
+            <services>
+                <!-- ... -->
+
+                <service id="api_key_user_provider"
+                    class="AppBundle\Security\ApiKeyUserProvider" />
+            </services>
+        </container>
+
+    .. code-block:: php
+
+        // app/config/services.php
+        use Symfony\Component\DependencyInjection\Definition;
+
+        // ...
+
+        $container->setDefinition('api_key_user_provider', new Definition(
+            'AppBundle\Security\ApiKeyUserProvider',
+        ));
+
 .. note::
 
     Read the dedicated article to learn
@@ -231,8 +269,8 @@ you can use to create an error ``Response``.
 
 .. code-block:: php
 
-    // src/Acme/HelloBundle/Security/ApiKeyAuthenticator.php
-    namespace Acme\HelloBundle\Security;
+    // src/AppBundle/Security/ApiKeyAuthenticator.php
+    namespace AppBundle\Security;
 
     use Symfony\Component\Security\Core\Authentication\SimplePreAuthenticatorInterface;
     use Symfony\Component\Security\Core\Exception\AuthenticationException;
@@ -270,8 +308,8 @@ your custom user provider as a service called ``your_api_key_user_provider``
             # ...
 
             apikey_authenticator:
-                class:     Acme\HelloBundle\Security\ApiKeyAuthenticator
-                arguments: ["@your_api_key_user_provider"]
+                class:     AppBundle\Security\ApiKeyAuthenticator
+                arguments: ["@api_key_user_provider"]
 
     .. code-block:: xml
 
@@ -285,9 +323,9 @@ your custom user provider as a service called ``your_api_key_user_provider``
                 <!-- ... -->
 
                 <service id="apikey_authenticator"
-                    class="Acme\HelloBundle\Security\ApiKeyAuthenticator"
+                    class="AppBundle\Security\ApiKeyAuthenticator"
                 >
-                    <argument type="service" id="your_api_key_user_provider" />
+                    <argument type="service" id="api_key_user_provider" />
                 </service>
             </services>
         </container>
@@ -301,8 +339,8 @@ your custom user provider as a service called ``your_api_key_user_provider``
         // ...
 
         $container->setDefinition('apikey_authenticator', new Definition(
-            'Acme\HelloBundle\Security\ApiKeyAuthenticator',
-            array(new Reference('your_api_key_user_provider'))
+            'AppBundle\Security\ApiKeyAuthenticator',
+            array(new Reference('api_key_user_provider'))
         ));
 
 Now, activate it in the ``firewalls`` section of your security configuration
@@ -324,8 +362,8 @@ using the ``simple_preauth`` key:
                         authenticator: apikey_authenticator
 
             providers:
-                simple_preauth:
-                    id: your_api_key_user_provider
+                api_key_user_provider:
+                    id: api_key_user_provider
 
     .. code-block:: xml
 
@@ -346,7 +384,7 @@ using the ``simple_preauth`` key:
                     <simple-preauth authenticator="apikey_authenticator" />
                 </firewall>
 
-                <provider name="simple_preauth" id="your_api_key_user_provider" />
+                <provider name="api_key_user_provider" id="api_key_user_provider" />
             </config>
         </srv:container>
 
@@ -368,7 +406,7 @@ using the ``simple_preauth`` key:
             ),
             'providers' => array(
                 'simple_preauth'       => array(
-                    'id'        => 'your_api_key_user_provider',
+                    'id'        => 'api_key_user_provider',
                 ),
             ),
         ));
@@ -411,8 +449,8 @@ configuration or set it to ``false``:
                         authenticator: apikey_authenticator
 
             providers:
-                simple_preauth:
-                    id: your_api_key_user_provider
+                api_key_user_provider:
+                    id: api_key_user_provider
 
     .. code-block:: xml
 
@@ -433,7 +471,7 @@ configuration or set it to ``false``:
                     <simple-preauth authenticator="apikey_authenticator" />
                 </firewall>
 
-                <provider name="simple_preauth" id="your_api_key_user_provider" />
+                <provider name="api_key_user_provider" id="api_key_user_provider" />
             </config>
         </srv:container>
 
@@ -453,8 +491,8 @@ configuration or set it to ``false``:
                 ),
             ),
             'providers' => array(
-                'simple_preauth'       => array(
-                    'id'        => 'your_api_key_user_provider',
+                'api_key_user_provider'       => array(
+                    'id'        => 'api_key_user_provider',
                 ),
             ),
         ));
@@ -464,7 +502,7 @@ case the API key (i.e. ``$token->getCredentials()``) - are not stored in the ses
 for security reasons. To take advantage of the session, update ``ApiKeyAuthenticator``
 to see if the stored token has a valid User object that can be used::
 
-    // src/Acme/HelloBundle/Security/ApiKeyAuthenticator.php
+    // src/AppBundle/Security/ApiKeyAuthenticator.php
     // ...
 
     class ApiKeyAuthenticator implements SimplePreAuthenticatorInterface
@@ -518,7 +556,7 @@ stored in the database, then you may want to re-query for a fresh version
 of the user to make sure it's not out-of-date. But regardless of your requirements,
 ``refreshUser()`` should now return the User object::
 
-    // src/Acme/HelloBundle/Security/ApiKeyUserProvider.php
+    // src/AppBundle/Security/ApiKeyUserProvider.php
 
     // ...
     class ApiKeyUserProvider implements UserProviderInterface
@@ -558,7 +596,7 @@ a certain URL (e.g. the redirect URL in OAuth).
 Fortunately, handling this situation is easy: just check to see what the
 current URL is before creating the token in ``createToken()``::
 
-    // src/Acme/HelloBundle/Security/ApiKeyAuthenticator.php
+    // src/AppBundle/Security/ApiKeyAuthenticator.php
 
     // ...
     use Symfony\Component\Security\Http\HttpUtils;
@@ -570,7 +608,7 @@ current URL is before creating the token in ``createToken()``::
 
         protected $httpUtils;
 
-        public function __construct(ApiKeyUserProviderInterface $userProvider, HttpUtils $httpUtils)
+        public function __construct(UserProviderInterface $userProvider, HttpUtils $httpUtils)
         {
             $this->userProvider = $userProvider;
             $this->httpUtils = $httpUtils;
@@ -606,8 +644,8 @@ service:
             # ...
 
             apikey_authenticator:
-                class:     Acme\HelloBundle\Security\ApiKeyAuthenticator
-                arguments: ["@your_api_key_user_provider", "@security.http_utils"]
+                class:     AppBundle\Security\ApiKeyAuthenticator
+                arguments: ["@api_key_user_provider", "@security.http_utils"]
 
     .. code-block:: xml
 
@@ -621,9 +659,9 @@ service:
                 <!-- ... -->
 
                 <service id="apikey_authenticator"
-                    class="Acme\HelloBundle\Security\ApiKeyAuthenticator"
+                    class="AppBundle\Security\ApiKeyAuthenticator"
                 >
-                    <argument type="service" id="your_api_key_user_provider" />
+                    <argument type="service" id="api_key_user_provider" />
                     <argument type="service" id="security.http_utils" />
                 </service>
             </services>
@@ -640,7 +678,7 @@ service:
         $container->setDefinition('apikey_authenticator', new Definition(
             'Acme\HelloBundle\Security\ApiKeyAuthenticator',
             array(
-                new Reference('your_api_key_user_provider'),
+                new Reference('api_key_user_provider'),
                 new Reference('security.http_utils')
             )
         ));