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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees;
use Illuminate\Support\Str;
use Psr\Http\Message\ServerRequestInterface;
use function array_map;
use function explode;
use function implode;
use function is_string;
use function parse_url;
use function rawurlencode;
use function session_name;
use function session_regenerate_id;
use function session_register_shutdown;
use function session_set_cookie_params;
use function session_set_save_handler;
use function session_start;
use function session_status;
use function session_write_close;
use const PHP_SESSION_ACTIVE;
use const PHP_URL_HOST;
use const PHP_URL_PATH;
use const PHP_URL_SCHEME;
/**
* Session handling
*/
class Session
{
// Use the secure prefix with HTTPS.
private const string SESSION_NAME = 'WT2_SESSION';
private const string SECURE_SESSION_NAME = '__Secure-WT-ID';
/**
* Start a session
*
* @param ServerRequestInterface $request
*
* @return void
*/
public static function start(ServerRequestInterface $request): void
{
// Store sessions in the database
session_set_save_handler(new SessionDatabaseHandler($request));
$url = Validator::attributes($request)->string('base_url');
$secure = parse_url($url, PHP_URL_SCHEME) === 'https';
$domain = (string) parse_url($url, PHP_URL_HOST);
$path = (string) parse_url($url, PHP_URL_PATH);
// Paths containing UTF-8 characters need special handling.
$path = implode('/', array_map(static fn (string $x): string => rawurlencode($x), explode('/', $path)));
session_name($secure ? self::SECURE_SESSION_NAME : self::SESSION_NAME);
session_register_shutdown();
session_set_cookie_params([
'lifetime' => 0,
'path' => $path . '/',
'domain' => $domain,
'secure' => $secure,
'httponly' => true,
'samesite' => 'Lax',
]);
session_start();
// A new session? Prevent session fixation attacks by choosing a new session ID.
if (self::get('initiated') !== true) {
self::regenerate(true);
self::put('initiated', true);
}
}
/**
* Save/close the session. This releases the session lock.
* Closing early can help concurrent connections.
*/
public static function save(): void
{
if (session_status() === PHP_SESSION_ACTIVE) {
session_write_close();
}
}
/**
* Read a value from the session
*
* @param string $name
* @param mixed $default
*
* @return mixed
*/
public static function get(string $name, $default = null)
{
return $_SESSION[$name] ?? $default;
}
/**
* Read a value from the session and remove it.
*
* @param string $name
*
* @return mixed
*/
public static function pull(string $name)
{
$value = self::get($name);
self::forget($name);
return $value;
}
/**
* After any change in authentication level, we should use a new session ID.
*
* @param bool $destroy
*
* @return void
*/
public static function regenerate(bool $destroy = false): void
{
if ($destroy) {
self::clear();
}
if (session_status() === PHP_SESSION_ACTIVE) {
session_regenerate_id($destroy);
}
}
/**
* Remove all stored data from the session.
*
* @return void
*/
public static function clear(): void
{
$_SESSION = [];
}
/**
* Write a value to the session
*
* @param string $name
* @param mixed $value
*
* @return void
*/
public static function put(string $name, $value): void
{
$_SESSION[$name] = $value;
}
/**
* Remove a value from the session
*
* @param string $name
*
* @return void
*/
public static function forget(string $name): void
{
unset($_SESSION[$name]);
}
/**
* Cross-Site Request Forgery tokens - ensure that the user is submitting
* a form that was generated by the current session.
*
* @return string
*/
public static function getCsrfToken(): string
{
$csrf_token = self::get('CSRF_TOKEN');
if (is_string($csrf_token)) {
return $csrf_token;
}
$csrf_token = Str::random(32);
self::put('CSRF_TOKEN', $csrf_token);
return $csrf_token;
}
/**
* Does a session variable exist?
*
* @param string $name
*
* @return bool
*/
public static function has(string $name): bool
{
return isset($_SESSION[$name]);
}
}
|
