-
Notifications
You must be signed in to change notification settings - Fork 1k
/
Copy pathDbAuthMiddleware.php
257 lines (252 loc) · 13.9 KB
/
DbAuthMiddleware.php
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<?php
namespace Tqdev\PhpCrudApi\Middleware;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Tqdev\PhpCrudApi\Column\ReflectionService;
use Tqdev\PhpCrudApi\Config\Config;
use Tqdev\PhpCrudApi\Controller\Responder;
use Tqdev\PhpCrudApi\Database\GenericDB;
use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
use Tqdev\PhpCrudApi\Middleware\Router\Router;
use Tqdev\PhpCrudApi\Record\Condition\ColumnCondition;
use Tqdev\PhpCrudApi\Record\ErrorCode;
use Tqdev\PhpCrudApi\Record\OrderingInfo;
use Tqdev\PhpCrudApi\RequestUtils;
class DbAuthMiddleware extends Middleware
{
private $reflection;
private $db;
private $ordering;
public function __construct(Router $router, Responder $responder, Config $config, string $middleware, ReflectionService $reflection, GenericDB $db)
{
parent::__construct($router, $responder, $config, $middleware);
$this->reflection = $reflection;
$this->db = $db;
$this->ordering = new OrderingInfo();
}
public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
{
if (session_status() == PHP_SESSION_NONE) {
if (!headers_sent()) {
$sessionName = $this->getProperty('sessionName', '');
if ($sessionName) {
session_name($sessionName);
}
if (!ini_get('session.cookie_samesite')) {
ini_set('session.cookie_samesite', 'Lax');
}
if (!ini_get('session.cookie_httponly')) {
ini_set('session.cookie_httponly', 1);
}
if (!ini_get('session.cookie_secure') && isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] != 'off') {
ini_set('session.cookie_secure', 1);
}
session_start();
}
}
$path = RequestUtils::getPathSegment($request, 1);
$method = $request->getMethod();
if ($method == 'POST' && in_array($path, ['login', 'register', 'password'])) {
$body = $request->getParsedBody();
$usernameFormFieldName = $this->getProperty('usernameFormField', 'username');
$passwordFormFieldName = $this->getProperty('passwordFormField', 'password');
$newPasswordFormFieldName = $this->getProperty('newPasswordFormField', 'newPassword');
$username = isset($body->$usernameFormFieldName) ? $body->$usernameFormFieldName : '';
$password = isset($body->$passwordFormFieldName) ? $body->$passwordFormFieldName : '';
$newPassword = isset($body->$newPasswordFormFieldName) ? $body->$newPasswordFormFieldName : '';
//add separate property for login as this could be a view joining users table to other table
//such as roles, details etc. At a minimum, the view output should include the $usernameColumn and $passwordColumn
if ($path === 'login') {
$tableName = $this->getProperty('loginTable', $this->getProperty('usersTable', 'users'));
} else {
$tableName = $this->getProperty('usersTable', 'users');
}
$table = $this->reflection->getTable($tableName);
$usernameColumnName = $this->getProperty('usernameColumn', 'username');
$usernameColumn = $table->getColumn($usernameColumnName);
$passwordColumnName = $this->getProperty('passwordColumn', 'password');
$usernamePattern = $this->getProperty('usernamePattern','/^[A-Za-z0-9]+$/'); // specify regex pattern for username, defaults to alphanumeric characters
$usernameMinLength = (int)$this->getProperty('usernameMinLength',5);
$usernameMaxLength = (int)$this->getProperty('usernameMaxLength',30);
if($usernameMinLength > $usernameMaxLength){
//obviously, $usernameMinLength should be less than $usernameMaxLength, but we'll still check in case of mis-config then we'll swap the 2 values
$lesser = $usernameMaxLength;
$usernameMaxLength = $usernameMinLength;
$usernameMinLength = $lesser;
}
$passwordLength = $this->getProperty('passwordLength', '12');
$pkName = $table->getPk()->getName();
$registerUser = $this->getProperty('registerUser', '');
$loginAfterRegistration = $this->getProperty('loginAfterRegistration', '');
$condition = new ColumnCondition($usernameColumn, 'eq', $username);
$returnedColumns = $this->getProperty('returnedColumns', '');
if (!$returnedColumns) {
$columnNames = $table->getColumnNames();
} else {
$columnNames = array_map('trim', explode(',', $returnedColumns));
$columnNames[] = $passwordColumnName;
$columnNames = array_values(array_unique($columnNames));
}
$columnOrdering = $this->ordering->getDefaultColumnOrdering($table);
if ($path == 'register') {
if (!$registerUser) {
return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
}
if (strlen(trim($username)) == 0) {
return $this->responder->error(ErrorCode::USERNAME_EMPTY, $username);
}
if (strlen($password) < $passwordLength) {
return $this->responder->error(ErrorCode::PASSWORD_TOO_SHORT, $passwordLength);
}
if(strlen($username) < $usernameMinLength){
return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED, $username . " [ Username length must be at least ". $usernameMinLength ." characters.]");
}
if(strlen($username) > $usernameMaxLength){
return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED, $username . " [ Username length must not exceed ". $usernameMaxLength ." characters.]");
}
if(!preg_match($usernamePattern, $username)){
return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED, $username . " [ Username contains disallowed characters.]");
}
$users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
if (!empty($users)) {
return $this->responder->error(ErrorCode::USER_ALREADY_EXIST, $username);
}
$data = json_decode($registerUser, true);
$data = is_array($data) ? $data : (array)$body;
// get the original posted data
$userTableColumns = $table->getColumnNames();
foreach($data as $key=>$value){
if(in_array($key,$userTableColumns)){
// process only posted data if the key exists as users table column
if($key === $usernameColumnName){
$data[$usernameColumnName] = $username; //process the username and password as usual
}else if($key === $passwordColumnName){
$data[$passwordColumnName] = password_hash($password, PASSWORD_DEFAULT);
}else{
$data[$key] = filter_var($value, FILTER_VALIDATE_EMAIL) ? $value : filter_var($value,FILTER_SANITIZE_ENCODED);
//sanitize all other inputs, except for valid or properly formatted email address
}
}
}
try{
$this->db->createSingle($table, $data);
/* Since we're processing additional data during registration, we need to check if these data were defined in db to be unique.
* For example, emailAddress are usually used just once in an application. We can query the database to check if the new emailAddress is not yet registered,
* but, in some cases, we may more than 2 or 3 or more unique fields (not common, but possible), hence we would also need to
* query 2,3 or more times.
* As a TEMPORARY WORKAROUND, we'll just attempt to register the new user and wait for the db to throw a DUPLICATE KEY EXCEPTION.
*/
}catch(\PDOException error){
if($error->getCode() ==="23000"){
return $this->responder->error(ErrorCode::DUPLICATE_KEY_EXCEPTION,'',$error->getMessage());
}else{
return $this->responder->error(ErrorCode::INPUT_VALIDATION_FAILED,$$error->getMessage());
}
}
$users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
foreach ($users as $user) {
if ($loginAfterRegistration) {
if (!headers_sent()) {
session_regenerate_id(true);
}
unset($user[$passwordColumnName]);
$_SESSION['updatedAt'] = time();
$_SESSION['user'] = $user;
return $this->responder->success($user);
} else {
unset($user[$passwordColumnName]);
return $this->responder->success($user);
}
}
return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
}
if ($path == 'login') {
$users = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, 0, 1);
foreach ($users as $user) {
if (password_verify($password, $user[$passwordColumnName]) == 1) {
if (!headers_sent()) {
session_regenerate_id(true);
}
unset($user[$passwordColumnName]);
$_SESSION['updatedAt'] = time();
$_SESSION['user'] = $user;
return $this->responder->success($user);
}
}
return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
}
if ($path == 'password') {
if ($username != ($_SESSION['user'][$usernameColumnName] ?? '')) {
return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
}
if (strlen($newPassword) < $passwordLength) {
return $this->responder->error(ErrorCode::PASSWORD_TOO_SHORT, $passwordLength);
}
$userColumns = $columnNames;
if (!in_array($pkName, $columnNames)) {
array_push($userColumns, $pkName);
}
$users = $this->db->selectAll($table, $userColumns, $condition, $columnOrdering, 0, 1);
foreach ($users as $user) {
if (password_verify($password, $user[$passwordColumnName]) == 1) {
if (!headers_sent()) {
session_regenerate_id(true);
}
$data = [$passwordColumnName => password_hash($newPassword, PASSWORD_DEFAULT)];
$this->db->updateSingle($table, $data, $user[$pkName]);
unset($user[$passwordColumnName]);
if (!in_array($pkName, $columnNames)) {
unset($user[$pkName]);
}
return $this->responder->success($user);
}
}
return $this->responder->error(ErrorCode::AUTHENTICATION_FAILED, $username);
}
}
if ($method == 'POST' && $path == 'logout') {
if (isset($_SESSION['user'])) {
$user = $_SESSION['user'];
unset($_SESSION['user']);
if (session_status() != PHP_SESSION_NONE) {
session_destroy();
}
return $this->responder->success($user);
}
return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
}
if ($method == 'GET' && $path == 'me') {
if (isset($_SESSION['user'])) {
$updateAfter = $this->getProperty('refreshSession',0) * 60;//update session after x minutes
if($updateAfter > 0 &&( time() >($_SESSION['user']['updatedAt'] + $updateAfter))){
$tableName = $this->getProperty('loginTable','users');
$table = $this->reflection->getTable($tableName);
$pkName = $table->getPk()->getName();
$passwordColumnName = $this->getProperty('passwordColumn','');
$returnedColumns = $this->getProperty('returnedColumns','');
if(!$returnedColumns){
$columnNames = $table->getColumnNames();
}else{
$columnNames = array_map('trim',explode(',',$returnedColumns));
$columnNames[] = $passwordColumnName;
$columnNames = array_values(array_unique($columnNames));
}
$user = $this->db->selectSingle($table,$columnNames,$_SESSION['user'][$pkName]);
unset($user[$passwordColumnName]);
$user['updatedAt'] = time();
$_SESSION['user'] = $user;
}
return $this->responder->success($_SESSION['user']);
}
return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
}
if (!isset($_SESSION['user']) || !$_SESSION['user']) {
$authenticationMode = $this->getProperty('mode', 'required');
if ($authenticationMode == 'required') {
return $this->responder->error(ErrorCode::AUTHENTICATION_REQUIRED, '');
}
}
return $next->handle($request);
}
}