File: ExpiringTokens.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 (96 lines) | stat: -rw-r--r-- 6,187 bytes parent folder | download
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
<?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\UsersManager\tests\Fixtures;

use Piwik\Common;
use Piwik\Db;
use Piwik\Plugins\UsersManager\API;
use Piwik\Plugins\UsersManager\Model as UsersManagerModel;
use Piwik\Tests\Framework\Fixture;

/**
 * Generates auth tokens for token notification tests
 */
class ExpiringTokens extends Fixture
{
    public $expiringTokens = [
        'user1' => [
            ['user1, not expired user token, secure only', '2025-01-01 00:00:00', null, '0', '1'],
            ['user1, not expired user token, not secure only', '2025-01-01 00:00:00', null, '0', '0'],
            ['user1, not expired system token, secure only', '2025-01-01 00:00:00', null, '1', '1'],
            ['user1, not expired system token, not secure only', '2025-01-01 00:00:00', null, '1', '0'],
            ['user1, expiring user token <30 days, secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '0', '1'],
            ['user1, expiring user token <30 days, not secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '0', '0'],
            ['user1, expiring system token <30 days, secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '1', '1'],
            ['user1, expiring system token <30 days, not secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '1', '0'],
            ['user1, expiring user token =30 days, secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '0', '1'],
            ['user1, expiring user token =30 days, not secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '0', '0'],
            ['user1, expiring system token =30 days, secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '1', '1'],
            ['user1, expiring system token =30 days, not secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '1', '0'],
            ['user1, expiring user token >30 days, secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '0', '1'],
            ['user1, expiring user token >30 days, not secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '0', '0'],
            ['user1, expiring system token >30 days, secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '1', '1'],
            ['user1, expiring system token >30 days, not secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '1', '0'],
            ['user1, expired user token, secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '0', '1'],
            ['user1, expired user token, not secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '0', '0'],
            ['user1, expired system token, secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '1', '1'],
            ['user1, expired system token, not secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '1', '0'],
        ],
        'user2' => [
            ['user2, not expired user token, secure only', '2025-01-01 00:00:00', null, '0', '1'],
            ['user2, not expired user token, not secure only', '2025-01-01 00:00:00', null, '0', '0'],
            ['user2, not expired system token, secure only', '2025-01-01 00:00:00', null, '1', '1'],
            ['user2, not expired system token, not secure only', '2025-01-01 00:00:00', null, '1', '0'],
            ['user2, expiring user token <30 days, secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '0', '1'],
            ['user2, expiring user token <30 days, not secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '0', '0'],
            ['user2, expiring system token <30 days, secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '1', '1'],
            ['user2, expiring system token <30 days, not secure only', '2025-01-01 00:00:00', '2025-04-03 00:00:00', '1', '0'],
            ['user2, expiring user token =30 days, secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '0', '1'],
            ['user2, expiring user token =30 days, not secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '0', '0'],
            ['user2, expiring system token =30 days, secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '1', '1'],
            ['user2, expiring system token =30 days, not secure only', '2025-01-01 00:00:00', '2025-04-30 00:00:00', '1', '0'],
            ['user2, expiring user token >30 days, secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '0', '1'],
            ['user2, expiring user token >30 days, not secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '0', '0'],
            ['user2, expiring system token >30 days, secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '1', '1'],
            ['user2, expiring system token >30 days, not secure only', '2025-01-01 00:00:00', '2025-05-29 00:00:00', '1', '0'],
            ['user2, expired user token, secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '0', '1'],
            ['user2, expired user token, not secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '0', '0'],
            ['user2, expired system token, secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '1', '1'],
            ['user2, expired system token, not secure only', '2025-01-01 00:00:00', '2025-02-01 00:00:00', '1', '0'],
        ],
    ];

    public function setUp(): void
    {
        Fixture::createWebsite('2020-01-11 00:00:00');

        $this->setUpUsersAndTokens();
    }

    private function setUpUsersAndTokens()
    {
        $api = API::getInstance();
        $api->addUser('user1', 'password1', 'user1@example.com');
        $api->addUser('user2', 'password2', 'user2@example.com');
        $api->setUserAccess('user2', 'view', [1]);

        $model = new UsersManagerModel();
        foreach ($this->expiringTokens as $user => $tokens) {
            foreach ($tokens as $token) {
                $model->addTokenAuth($user, $model->generateRandomTokenAuth(), ...$token);
            }
        }
    }

    public function resetTsExpirationNotification()
    {
        Db::get()->query("UPDATE " . Common::prefixTable('user_token_auth') . " SET ts_expiration_warning_notified = NULL");
    }
}