plugins/AntiBrute/AntiBrutePlugin.php

   1 <?php
   2
   3 if (!defined('GNUSOCIAL')) { exit(1); }
   4
   5 class AntiBrutePlugin extends Plugin {
   6     protected $failed_attempts = 0;
   7     protected $unauthed_user = null;
   8     protected $client_ip = null;
   9
  10     const FAILED_LOGIN_IP_SECTION = 'failed_login_ip';
  11
  12     public function onStartCheckPassword($nickname, $password, &$authenticatedUser)
  13     {
  14         if (common_is_email($nickname)) {
  15             $this->unauthed_user = User::getKV('email', common_canonical_email($nickname));
  16         } else {
  17             $this->unauthed_user = User::getKV('nickname', Nickname::normalize($nickname));
  18         }
  19
  20         if (!$this->unauthed_user instanceof User) {
  21             // Unknown username continue processing StartCheckPassword (maybe uninitialized LDAP user etc?)
  22             return true;
  23         }
  24
  25         // This probably needs some work. For example with IPv6 you can easily generate new IPs...
  26         $this->client_ip = common_client_ip()[0] ?: common_client_ip()[1];   // [0] is proxy, [1] should be the real IP
  27         $this->failed_attempts = (int)$this->unauthed_user->getPref(self::FAILED_LOGIN_IP_SECTION, $this->client_ip);
  28         switch (true) {
  29         case $this->failed_attempts >= 5:
  30             common_log(LOG_WARNING, sprintf('Multiple failed login attempts for user %s from IP %s - brute force attack?',
  31                                  $this->unauthed_user->getNickname(), $this->client_ip));
  32             // 5 seconds is a good max waiting time anyway...
  33             sleep($this->failed_attempts % 5 + 1);
  34             break;
  35         case $this->failed_attempts > 0:
  36             common_debug(sprintf('Previously failed login on user %s from IP %s - sleeping %u seconds.',
  37                                  $this->unauthed_user->getNickname(), $this->client_ip, $this->failed_attempts));
  38             sleep($this->failed_attempts);
  39             break;
  40         default:
  41             // No sleeping if it's our first failed attempt.
  42         }
  43
  44         return true;
  45     }
  46
  47     public function onEndCheckPassword($nickname, $password, $authenticatedUser)
  48     {
  49         if ($authenticatedUser instanceof User) {
  50             // We'll trust this IP for this user and remove failed logins for the database..
  51             $authenticatedUser->delPref(self::FAILED_LOGIN_IP_SECTION, $this->client_ip);
  52             return true;
  53         }
  54
  55         // See if we have an unauthed user from before. If not, it might be because the User did
  56         // not exist yet (such as autoregistering with LDAP, OpenID etc.).
  57         if ($this->unauthed_user instanceof User) {
  58             // And if the login failed, we'll increment the attempt count.
  59             common_debug(sprintf('Failed login tests for user %s from IP %s',
  60                                  $this->unauthed_user->getNickname(), $this->client_ip));
  61             $this->unauthed_user->setPref(self::FAILED_LOGIN_IP_SECTION, $this->client_ip, ++$this->failed_attempts);
  62         }
  63         return true;
  64     }
  65
  66     public function onPluginVersion(&$versions)
  67     {
  68         $versions[] = array('name' => 'AntiBrute',
  69                             'version' => GNUSOCIAL_VERSION,
  70                             'author' => 'Mikael Nordfeldth',
  71                             'homepage' => 'http://gnu.io/',
  72                             'description' =>
  73                             // TRANS: Plugin description.
  74                             _m('Anti bruteforce method(s).'));
  75         return true;
  76     }
  77 }