Skip to content

feat(bruteforce): Document the new BruteForceProtection attribute #9742

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
nickvergessen merged 2 commits into from
Apr 24, 2023
Merged

feat(bruteforce): Document the new BruteForceProtection attribute #9742

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36b571c
feat(bruteforce): Document the new BruteForceProtection attribute
nickvergessen Mar 8, 2023
e80210b
fix(bruteforce): Fix 429 explanation
nickvergessen Apr 24, 2023
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
Prev Previous commit
fix(bruteforce): Fix 429 explanation 
Signed-off-by: Joas Schilling <[email protected]>
  • Loading branch information
@nickvergessen
nickvergessen committed Apr 24, 2023
commit e80210b9a4cc69ebcb529f89ca067427362122e5
4 changes: 2 additions & 2 deletions developer_manual/basics/controllers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -889,9 +889,9 @@ To enable brute force protection the following *Attribute* can be added to the c

The attribute is only available in Nextcloud 27 or later. In older versions the ``@BruteForceProtection(action=string)`` annotation can be used, but that does not allow multiple assignments to a single controller method.

Then the **throttle()** method has to be called on the response in case of a violation. Doing so will increase the throttle counter and make following requests slower, until a slowness of roughly 30 seconds is reached and the controller returns a ``429 Too Many Requests`` status is returned instead of avoid further requests.
Then the **throttle()** method has to be called on the response in case of a violation. Doing so will increase the throttle counter and make following requests slower, until a slowness of roughly 30 seconds is reached and the controller returns a ``429 Too Many Requests`` status without further validating or executing the request.

A controller method that would employ brute-force protection with an action of "foobar" would look as following:
A controller method that would implement brute-force protection with an action of "foobar" would look as following:

.. code-block:: php
:emphasize-lines: 11,18
Expand Down