Skip to content

[Security] Document the login_throttling.interval option #15211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javiereguiluz merged 1 commit into from
Apr 12, 2021
Merged

[Security] Document the login_throttling.interval option #15211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,11 @@ You must enable this using the ``login_throttling`` setting:
login_throttling:
max_attempts: 3

# configure the maximum login attempts in a custom period of time
login_throttling:
max_attempts: 3
interval: '15 minutes'

# use a custom rate limiter via its service ID
login_throttling:
limiter: app.my_login_rate_limiter
Expand All @@ -526,6 +531,9 @@ You must enable this using the ``login_throttling`` setting:
<!-- configure the maximum login attempts (per minute) -->
<login-throttling max-attempts="3"/>

<!-- configure the maximum login attempts in a custom period of time -->
<login-throttling max-attempts="3" interval="15 minutes"/>

<!-- use a custom rate limiter via its service ID -->
<login-throttling limiter="app.my_login_rate_limiter"/>
</firewall>
Expand All @@ -550,6 +558,12 @@ You must enable this using the ``login_throttling`` setting:
'max_attempts' => 3,
],

// configure the maximum login attempts in a custom period of time
'login_throttling' => [
'max_attempts' => 3,
'interval' => '15 minutes',
],

// use a custom rate limiter via its service ID
'login_throttling' => [
'limiter' => 'app.my_login_rate_limiter',
Expand All @@ -558,6 +572,10 @@ You must enable this using the ``login_throttling`` setting:
],
]);

.. versionadded:: 5.3

The ``login_throttling.interval`` option was introduced in Symfony 5.3.

By default, login attempts are limited on ``max_attempts`` (default: 5)
failed requests for ``IP address + username`` and ``5 * max_attempts``
failed requests for ``IP address``. The second limit protects against an
Expand Down