File: Model.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (107 lines) | stat: -rw-r--r-- 3,372 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\Login;

use Piwik\Common;
use Piwik\Date;
use Piwik\Db;
use Piwik\Option;
use Piwik\Plugins\Login\Security\BruteForceDetection;

class Model
{
    public const NOTIFIED_USER_ABOUT_LOGIN_ATTEMPTS_OPTION_PREFIX = 'BruteForceDetection.suspiciousLoginCountNotified.';

    public const LAST_LOGIN_COUNTRY_OPTION_PREFIX = 'LoginFromDifferentCountry.lastCountry.';

    /**
     * @var
     */
    private $tablePrefixed;

    public function __construct()
    {
        $this->tablePrefixed = Common::prefixTable(BruteForceDetection::TABLE_NAME);
    }

    public function getTotalLoginAttemptsInLastHourForLogin(string $login): int
    {
        $sql = "SELECT COUNT(*) FROM `{$this->tablePrefixed}` WHERE login = ? AND attempted_at > ?";
        $count = Db::fetchOne($sql, [$login, $this->getDateTimeSubMinutes(60)]);
        return (int) $count;
    }

    public function hasNotifiedUserAboutSuspiciousLogins(string $login): bool
    {
        $optionName = $this->getSuspiciousLoginsNotifiedOptionName($login);
        $timeSent = Option::get($optionName);
        $timeSent = (int) @json_decode($timeSent, true);
        if ($timeSent <= 0) { // sanity check
            return false;
        }

        $timeSinceSent = Date::getNowTimestamp() - $timeSent;
        if (
            $timeSinceSent <= 0 // sanity check
            || $timeSinceSent > $this->getAmountOfTimeBetweenSuspiciousLoginNotifications()
        ) {
            return false;
        }

        return true;
    }

    public function getDistinctIpsAttemptingLoginsInLastHour(string $login): int
    {
        $sql = "SELECT COUNT(DISTINCT ip_address) FROM `{$this->tablePrefixed}` WHERE login = ? AND attempted_at > ?";
        $count = Db::fetchOne($sql, [$login, $this->getDateTimeSubMinutes(60)]);
        return (int) $count;
    }

    private function getDateTimeSubMinutes($minutes): string
    {
        return Date::now()->subPeriod($minutes, 'minute')->getDatetime();
    }

    private function getAmountOfTimeBetweenSuspiciousLoginNotifications(): int
    {
        return 2 * 7 * 24 * 60 * 60; // 2 weeks
    }

    private function getSuspiciousLoginsNotifiedOptionName(string $login): string
    {
        return self::NOTIFIED_USER_ABOUT_LOGIN_ATTEMPTS_OPTION_PREFIX . $login;
    }

    private function getLastLoginCountryOptionName(string $login): string
    {
        return self::LAST_LOGIN_COUNTRY_OPTION_PREFIX . $login;
    }

    public function markSuspiciousLoginsNotifiedEmailSent(string $login): void
    {
        $optionName = $this->getSuspiciousLoginsNotifiedOptionName($login);
        Option::set($optionName, Date::getNowTimestamp());
    }

    public function setLastLoginCountry(string $login, string $countryCode): void
    {
        $optionName = $this->getLastLoginCountryOptionName($login);
        Option::set($optionName, $countryCode);
    }

    public function getLastLoginCountry($login): ?string
    {
        $optionName = $this->getLastLoginCountryOptionName($login);
        $optionValue = Option::get($optionName);
        // convert false to null so that we don't return mixed types
        return (false !== $optionValue) ? $optionValue : null;
    }
}