Configuration::getAccessTokenTtl()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Platine OAuth2
5
 *
6
 * Platine OAuth2 is a library that implements the OAuth2 specification
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine OAuth2
11
 *
12
 * Permission is hereby granted, free of charge, to any person obtaining a copy
13
 * of this software and associated documentation files (the "Software"), to deal
14
 * in the Software without restriction, including without limitation the rights
15
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
 * copies of the Software, and to permit persons to whom the Software is
17
 * furnished to do so, subject to the following conditions:
18
 *
19
 * The above copyright notice and this permission notice shall be included in all
20
 * copies or substantial portions of the Software.
21
 *
22
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
 * SOFTWARE.
29
 */
30
31
/**
32
 *  @file Configuration.php
33
 *
34
 *  The OAuth2 Configuration class
35
 *
36
 *  @package    Platine\OAuth2
37
 *  @author Platine Developers Team
38
 *  @copyright  Copyright (c) 2020
39
 *  @license    http://opensource.org/licenses/MIT  MIT License
40
 *  @link   https://www.platine-php.com
41
 *  @version 1.0.0
42
 *  @filesource
43
 */
44
45
declare(strict_types=1);
46
47
namespace Platine\OAuth2;
48
49
use Platine\Stdlib\Config\AbstractConfiguration;
50
51
/**
52
 * @class Configuration
53
 * @package Platine\OAuth2
54
 */
55
class Configuration extends AbstractConfiguration
56
{
57
    /**
58
     * Return the authorization code TTL value
59
     * @return int
60
     */
61
    public function getAuthorizationCodeTtl(): int
62
    {
63
        return $this->get('ttl.authorization_code');
64
    }
65
66
    /**
67
     * Return the access token TTL value
68
     * @return int
69
     */
70
    public function getAccessTokenTtl(): int
71
    {
72
        return $this->get('ttl.access_token');
73
    }
74
75
    /**
76
     * Return the refresh token TTL value
77
     * @return int
78
     */
79
    public function getRefreshTokenTtl(): int
80
    {
81
        return $this->get('ttl.refresh_token');
82
    }
83
84
    /**
85
     * Whether need rotate refresh token
86
     * @return bool
87
     */
88
    public function isRotateRefreshToken(): bool
89
    {
90
        return $this->get('rotate_refresh_token');
91
    }
92
93
    /**
94
     * Whether need rotate refresh token after revocation
95
     * @return bool
96
     */
97
    public function isRevokeRotatedRefreshToken(): bool
98
    {
99
        return $this->get('revoke_rotated_refresh_token');
100
    }
101
102
    /**
103
     * Return the supported grants
104
     * @return array<int, string>
105
     */
106
    public function getGrants(): array
107
    {
108
        return $this->get('grants');
109
    }
110
111
    /**
112
     * {@inheritdoc}
113
     */
114
    public function getValidationRules(): array
115
    {
116
        return [
117
            'ttl' => 'array',
118
            'ttl.authorization_code' => 'integer',
119
            'ttl.access_token' => 'integer',
120
            'ttl.refresh_token' => 'integer',
121
            'rotate_refresh_token' => 'boolean',
122
            'revoke_rotated_refresh_token' => 'boolean',
123
            'grants' => 'array'
124
        ];
125
    }
126
127
    /**
128
     * {@inheritdoc}
129
     */
130
    public function getDefault(): array
131
    {
132
        return [
133
            'grants' => [],
134
            'ttl' => [
135
                'authorization_code' => 120,
136
                'access_token' => 3600,
137
                'refresh_token' => 86400,
138
            ],
139
            'rotate_refresh_token' => false,
140
            'revoke_rotated_refresh_token' => true,
141
        ];
142
    }
143
}
144