diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index b3ab6d31564..27869dd074d 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -954,6 +954,60 @@ a ``user_checker`` option to define the service used to perform those checks. Learn more about user checkers in :doc:`/security/user_checkers`. +Required Badges +~~~~~~~~~~~~~~~ + +Firewalls can configure a list of required badges that must be present on the authenticated passport: + +.. configuration-block:: + + .. code-block:: yaml + + # config/packages/security.yaml + security: + # ... + + firewalls: + main: + # ... + required_badges: ['CsrfTokenBadge', 'My\Badge'] + + .. code-block:: xml + + + + + + + + + CsrfTokenBadge + My\Badge + + + + + .. code-block:: php + + // config/packages/security.php + use Symfony\Config\SecurityConfig; + + return static function (SecurityConfig $security) { + $mainFirewall = $security->firewall('main'); + $mainFirewall->requiredBadges(['CsrfTokenBadge', 'My\Badge']); + // ... + }; + +.. versionadded:: 5.3 + + The ``required_badges`` option was introduced in Symfony 5.3. + providers ---------