Jul 29, 2020 · Dec 7, 2020 · Dec 8, 2020 · Dec 8, 2020 · Dec 9, 2020 · Dec 10, 2020
diff --git a/messenger.rst b/messenger.rst

 .. code-block:: terminal

    # see all messages in the failure transport
    # see all messages in the failure transport with a default limit of 50
    $ php bin/console messenger:failed:show

    # see the 10 first messages
    $ php bin/console messenger:failed:show --max=10

    # see only MyClass messages
    $ php bin/console messenger:failed:show --class-filter='MyClass'

    # see the number of messages by message class
    $ php bin/console messenger:failed:show --stats

    # see details about a specific failure
    $ php bin/console messenger:failed:show 20 -vv
diff --git a/routing.rst b/routing.rst
            // ['HTTP_HOST' => 'm.' . $client->getContainer()->getParameter('domain')]
        );

 .. tip::

    You can also use the inline defaults and requirements format in the
    ``host`` option: ``{subdomain<m|mobile>?m}.example.com``

 .. versionadded:: 5.2

    Inline parameter default values support in hosts were introduced in
    Symfony 5.2. Prior to Symfony 5.2, they were supported in the path only.

 .. _i18n-routing:

 Localized Routes (i18n)
diff --git a/security/experimental_authenticators.rst b/security/experimental_authenticators.rst
    use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
    use Symfony\Component\Security\Core\Exception\AuthenticationException;
    use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
    use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
    use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
    use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
    use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
    use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;

                throw new CustomUserMessageAuthenticationException('No API token provided');
            }

            $user = $this->entityManager->getRepository(User::class)
                ->findOneBy(['apiToken' => $apiToken])
            ;
            if (null === $user) {
                throw new UsernameNotFoundException();
            }

            return new SelfValidatingPassport($user);
            return new SelfValidatingPassport(new UserBadge($apiToken));
        }

        public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
 Security Passports
 ~~~~~~~~~~~~~~~~~~

 .. versionadded:: 5.2

    The ``UserBadge`` was introduced in Symfony 5.2. Prior to 5.2, the user
    instance was provided directly to the passport.

 A passport is an object that contains the user that will be authenticated as
 well as other pieces of information, like whether a password should be checked
 or if "remember me" functionality should be enabled.

 The default
 :class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Passport`
 requires a user object and credentials. The following credential classes
 are supported by default:
 requires a user and credentials.

 Use the
 :class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Badge\\UserBadge`
 to attach the user to the passport. The ``UserBadge`` requires a user
 identifier (e.g. the username or email), which is used to load the user
 using :ref:`the user provider <security-user-providers>`::

    use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;

    // ...
    $passport = new Passport(new UserBadge($email), $credentials);

 .. note::

    You can optionally pass a user loader as second argument to the
    ``UserBadge``. This callable receives the ``$userIdentifier``
    and must return a ``UserInterface`` object (otherwise a
    ``UsernameNotFoundException`` is thrown)::

        // ...
        $passport = new Passport(
            new UserBadge($email, function ($userIdentifier) {
                return $this->userRepository->findOneBy(['email' => $userIdentifier]);
            }),
            $credentials
        );

 The following credential classes are supported by default:

 :class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Credentials\\PasswordCredentials`
    This requires a plaintext ``$password``, which is validated using the
    :ref:`password encoder configured for the user <security-encoding-user-password>`.
    :ref:`password encoder configured for the user <security-encoding-user-password>`::

        use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\PasswordCredentials;

        // ...
        return new Passport($user, new PasswordCredentials($plaintextPassword));

 :class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Credentials\\CustomCredentials`
    Allows a custom closure to check credentials::

        use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\CustomCredentials;

        // ...
        return new Passport($user, new CustomCredentials(
            // If this function returns anything else than `true`, the credentials
            $apiToken
        ));

 .. note::

    If you don't need any credentials to be checked (e.g. a JWT token), you
    can use the
    :class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\SelfValidatingPassport`.
    This class only requires a user and optionally `Passport Badges`_.
 Self Validating Passport
 ........................

 If you don't need any credentials to be checked (e.g. when using API
 tokens), you can use the
 :class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\SelfValidatingPassport`.
 This class only requires a ``UserBadge`` object and optionally `Passport
 Badges`_.

 Passport Badges
 ~~~~~~~~~~~~~~~
    initiated). This skips the
    :doc:`pre-authentication user checker </security/user_checkers>`.

 For instance, if you want to add CSRF and password migration to your custom
 authenticator, you would initialize the passport like this::
 .. versionadded:: 5.2

    Since 5.2, the ``PasswordUpgradeBadge`` is automatically added to
    the passport if the passport has ``PasswordCredentials``.

 For instance, if you want to add CSRF to your custom authenticator, you
 would initialize the passport like this::

    // src/Service/LoginAuthenticator.php
    namespace App\Service;

    // ...
    use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
    use Symfony\Component\Security\Http\Authenticator\Passport\Badge\CsrfTokenBadge;
    use Symfony\Component\Security\Http\Authenticator\Passport\Badge\PasswordUpgradeBadge;
    use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
    use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
    use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;

            $username = $request->request->get('username');
            $csrfToken = $request->request->get('csrf_token');

            // ... get the $user from the $username and validate no
            // parameter is empty
            // ... validate no parameter is empty

            return new Passport($user, new PasswordCredentials($password), [
 // $this->userRepository must implement PasswordUpgraderInterface
                newPasswordUpgradeBadge($password, $this->userRepository),
                new CsrfTokenBadge('login', $csrfToken),
 ]);
            return new Passport(
 new UserBadge($user),
                newPasswordCredentials($password),
 [new CsrfTokenBadge('login', $csrfToken)]
            );
        }
    }

    ``createAuthenticatedToken()``)::

        // ...
        use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
        use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;

        class LoginAuthenticator extends AbstractAuthenticator
        {
            {
                // ... process the request

                $passport = new SelfValidatingPassport($username, []);
                $passport = new SelfValidatingPassport(new UserBadge($username), []);

                // set a custom attribute (e.g. scope)
                $passport->setAttribute('scope', $oauthScope);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -807,8 +807,17 @@ to retry them:

		.. code-block:: terminal

		# see all messages in the failure transport
		# see all messages in the failure transport with a default limit of 50
		$ php bin/console messenger:failed:show

		# see the 10 first messages
		$ php bin/console messenger:failed:show --max=10

		# see only MyClass messages
		$ php bin/console messenger:failed:show --class-filter='MyClass'

		# see the number of messages by message class
		$ php bin/console messenger:failed:show --stats

		# see details about a specific failure
		$ php bin/console messenger:failed:show 20 -vv
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2036,6 +2036,16 @@ these routes.
		// ['HTTP_HOST' => 'm.' . $client->getContainer()->getParameter('domain')]
		);

		.. tip::

		You can also use the inline defaults and requirements format in the
		``host`` option: ``{subdomain<m\|mobile>?m}.example.com``

		.. versionadded:: 5.2

		Inline parameter default values support in hosts were introduced in
		Symfony 5.2. Prior to Symfony 5.2, they were supported in the path only.

		.. _i18n-routing:

		Localized Routes (i18n)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -295,8 +295,8 @@ method that fits most use-cases::
		use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
		use Symfony\Component\Security\Core\Exception\AuthenticationException;
		use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
		use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
		use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
		use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
		use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
		use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;

Expand DownExpand Up		@@ -328,14 +328,7 @@ method that fits most use-cases::
		throw new CustomUserMessageAuthenticationException('No API token provided');
		}

		$user = $this->entityManager->getRepository(User::class)
		->findOneBy(['apiToken' => $apiToken])
		;
		if (null === $user) {
		throw new UsernameNotFoundException();
		}

		return new SelfValidatingPassport($user);
		return new SelfValidatingPassport(new UserBadge($apiToken));
		}

		public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
Expand DownExpand Up		@@ -442,23 +435,61 @@ into a security
		Security Passports
		~~~~~~~~~~~~~~~~~~

		.. versionadded:: 5.2

		The ``UserBadge`` was introduced in Symfony 5.2. Prior to 5.2, the user
		instance was provided directly to the passport.

		A passport is an object that contains the user that will be authenticated as
		well as other pieces of information, like whether a password should be checked
		or if "remember me" functionality should be enabled.

		The default
		:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Passport`
		requires a user object and credentials. The following credential classes
		are supported by default:
		requires a user and credentials.

		Use the
		:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Badge\\UserBadge`
		to attach the user to the passport. The ``UserBadge`` requires a user
		identifier (e.g. the username or email), which is used to load the user
		using :ref:`the user provider <security-user-providers>`::

		use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;

		// ...
		$passport = new Passport(new UserBadge($email), $credentials);

		.. note::

		You can optionally pass a user loader as second argument to the
		``UserBadge``. This callable receives the ``$userIdentifier``
		and must return a ``UserInterface`` object (otherwise a
		``UsernameNotFoundException`` is thrown)::

		// ...
		$passport = new Passport(
		new UserBadge($email, function ($userIdentifier) {
		return $this->userRepository->findOneBy(['email' => $userIdentifier]);
		}),
		$credentials
		);

		The following credential classes are supported by default:

		:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Credentials\\PasswordCredentials`
		This requires a plaintext ``$password``, which is validated using the
		:ref:`password encoder configured for the user <security-encoding-user-password>`.
		:ref:`password encoder configured for the user <security-encoding-user-password>`::

		use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\PasswordCredentials;

		// ...
		return new Passport($user, new PasswordCredentials($plaintextPassword));

		:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\Credentials\\CustomCredentials`
		Allows a custom closure to check credentials::

		use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\CustomCredentials;

		// ...
		return new Passport($user, new CustomCredentials(
		// If this function returns anything else than `true`, the credentials
Expand All		@@ -472,12 +503,15 @@ are supported by default:
		$apiToken
		));

		.. note::

		If you don't need any credentials to be checked (e.g. a JWT token), you
		can use the
		:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\SelfValidatingPassport`.
		This class only requires a user and optionally `Passport Badges`_.
		Self Validating Passport
		........................

		If you don't need any credentials to be checked (e.g. when using API
		tokens), you can use the
		:class:`Symfony\\Component\\Security\\Http\\Authenticator\\Passport\\SelfValidatingPassport`.
		This class only requires a ``UserBadge`` object and optionally `Passport
		Badges`_.

		Passport Badges
		~~~~~~~~~~~~~~~
Expand DownExpand Up		@@ -507,16 +541,21 @@ the following badges are supported:
		initiated). This skips the
		:doc:`pre-authentication user checker </security/user_checkers>`.

		For instance, if you want to add CSRF and password migration to your custom
		authenticator, you would initialize the passport like this::
		.. versionadded:: 5.2

		Since 5.2, the ``PasswordUpgradeBadge`` is automatically added to
		the passport if the passport has ``PasswordCredentials``.

		For instance, if you want to add CSRF to your custom authenticator, you
		would initialize the passport like this::

		// src/Service/LoginAuthenticator.php
		namespace App\Service;

		// ...
		use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
		use Symfony\Component\Security\Http\Authenticator\Passport\Badge\CsrfTokenBadge;
		use Symfony\Component\Security\Http\Authenticator\Passport\Badge\PasswordUpgradeBadge;
		use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
		use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
		use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;

Expand All		@@ -528,14 +567,13 @@ authenticator, you would initialize the passport like this::
		$username = $request->request->get('username');
		$csrfToken = $request->request->get('csrf_token');

		// ... get the $user from the $username and validate no
		// parameter is empty
		// ... validate no parameter is empty

		return new Passport($user, new PasswordCredentials($password), [
		// $this->userRepository must implement PasswordUpgraderInterface
		newPasswordUpgradeBadge($password, $this->userRepository),
		new CsrfTokenBadge('login', $csrfToken),
		]);
		return new Passport(
		new UserBadge($user),
		newPasswordCredentials($password),
		[new CsrfTokenBadge('login', $csrfToken)]
		);
		}
		}

Expand All		@@ -547,7 +585,7 @@ authenticator, you would initialize the passport like this::
		``createAuthenticatedToken()``)::

		// ...
		use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
		use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;

		class LoginAuthenticator extends AbstractAuthenticator
		{
Expand All		@@ -557,7 +595,7 @@ authenticator, you would initialize the passport like this::
		{
		// ... process the request

		$passport = new SelfValidatingPassport($username, []);
		$passport = new SelfValidatingPassport(new UserBadge($username), []);

		// set a custom attribute (e.g. scope)
		$passport->setAttribute('scope', $oauthScope);
Expand Down