diff options
Diffstat (limited to 'doc/en_US/bruteforce-protection.markdown')
-rw-r--r-- | doc/en_US/bruteforce-protection.markdown | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/en_US/bruteforce-protection.markdown b/doc/en_US/bruteforce-protection.markdown new file mode 100644 index 00000000..2f75b919 --- /dev/null +++ b/doc/en_US/bruteforce-protection.markdown @@ -0,0 +1,35 @@ +Brute Force Protection +====================== + +The brute force protection of Kanboard works at the user account level: + +- After 3 authentication failure for the same username, the login form shows a captcha image to prevent automated bot tentatives. +- After 6 authentication failure, the user account is locked down for a period of 15 minutes. + +This feature works only for authentication methods that use the login form. + +However, **after three authentication failure through the user API**, the account has to be unlocked by using the login form. + +Kanboard doesn't block any IP addresses since bots can use several anonymous proxies. However, you can use external tools like [fail2ban](http://www.fail2ban.org) to avoid massive scans. + +Configuration +------------- + +Default settings can be changed with these configuration variables: + +```php +// Enable captcha after 3 authentication failure +define('BRUTEFORCE_CAPTCHA', 3); + +// Lock the account after 6 authentication failure +define('BRUTEFORCE_LOCKDOWN', 6); + +// Lock account duration in minutes +define('BRUTEFORCE_LOCKDOWN_DURATION', 15); +``` + +Unlocking users +--------------- + +If you don't want to wait 15 minutes, you can unlock a user from the user interface. +As administrator, go to the user profile and click on "Unlock this user". |