|
1
|
|
|
<?php |
|
2
|
|
|
declare(strict_types=1); |
|
3
|
|
|
/** |
|
4
|
|
|
* Caridea |
|
5
|
|
|
* |
|
6
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not |
|
7
|
|
|
* use this file except in compliance with the License. You may obtain a copy of |
|
8
|
|
|
* the License at |
|
9
|
|
|
* |
|
10
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
11
|
|
|
* |
|
12
|
|
|
* Unless required by applicable law or agreed to in writing, software |
|
13
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
|
14
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
|
15
|
|
|
* License for the specific language governing permissions and limitations under |
|
16
|
|
|
* the License. |
|
17
|
|
|
* |
|
18
|
|
|
* @copyright 2015-2018 LibreWorks contributors |
|
19
|
|
|
* @license Apache-2.0 |
|
20
|
|
|
*/ |
|
21
|
|
|
namespace Caridea\Session; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* Stores a token to help prevent Cross-site Request Forgery. |
|
25
|
|
|
* |
|
26
|
|
|
* @copyright 2015-2018 LibreWorks contributors |
|
27
|
|
|
* @license Apache-2.0 |
|
28
|
|
|
*/ |
|
29
|
|
|
class CsrfPlugin extends Plugin |
|
30
|
|
|
{ |
|
31
|
|
|
/** |
|
32
|
|
|
* @var \Caridea\Session\Map A session value namespace |
|
33
|
|
|
*/ |
|
34
|
|
|
protected $values; |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* Creates a new CSRF plugin. |
|
38
|
|
|
*/ |
|
39
|
1 |
|
public function __construct() |
|
40
|
|
|
{ |
|
41
|
1 |
|
$this->values = new NullMap(); |
|
42
|
1 |
|
} |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* Matches the client's CSRF token to the one stored in the session. |
|
46
|
|
|
* |
|
47
|
|
|
* @param string $value The client-supplied CSRF value |
|
48
|
|
|
* @return bool |
|
49
|
|
|
*/ |
|
50
|
1 |
|
public function isValid(string $value): bool |
|
51
|
|
|
{ |
|
52
|
1 |
|
return $value === $this->getValue(); |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
/** |
|
56
|
|
|
* Gets the session CSRF token |
|
57
|
|
|
* |
|
58
|
|
|
* @return string|null The CSRF token (or null) |
|
59
|
|
|
*/ |
|
60
|
1 |
|
public function getValue(): ?string |
|
61
|
|
|
{ |
|
62
|
1 |
|
return $this->values->get('value'); |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* Recalculates the hash |
|
67
|
|
|
*/ |
|
68
|
1 |
|
protected function regenerate(): void |
|
69
|
|
|
{ |
|
70
|
1 |
|
$this->values->offsetSet('value', hash('sha512', random_bytes(32))); |
|
71
|
1 |
|
} |
|
72
|
|
|
|
|
73
|
|
|
/** |
|
74
|
|
|
* {@inheritDoc} |
|
75
|
|
|
*/ |
|
76
|
1 |
|
public function onRegenerate(Session $session): void |
|
77
|
|
|
{ |
|
78
|
1 |
|
$this->regenerate(); |
|
79
|
1 |
|
} |
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* {@inheritDoc} |
|
83
|
|
|
*/ |
|
84
|
4 |
|
public function onStart(Session $session): void |
|
85
|
|
|
{ |
|
86
|
4 |
|
$this->values = $session->getValues(__CLASS__); |
|
87
|
4 |
|
if (!$this->values->get('value')) { |
|
88
|
1 |
|
$this->regenerate(); |
|
89
|
|
|
} |
|
90
|
4 |
|
} |
|
91
|
|
|
} |
|
92
|
|
|
|
libreworks /
caridea-session
