1
0
mirror of https://github.com/delight-im/PHP-Auth.git synced 2025-08-08 09:06:29 +02:00

34 Commits

Author SHA1 Message Date
Marco
729c76668f Move all exceptions and errors to separate files for autoloading 2020-09-30 20:40:54 +02:00
Marco
cc6430a83e Explain where usernames may be used to address unconfirmed recipients 2020-05-11 13:14:14 +02:00
Marco
6f933ac560 Explain how to impose restrictions on characters/length for usernames 2020-05-11 13:10:33 +02:00
Marco
157a7095b0 Use 'throttling' flag in 'Auth#forgotPassword' when limiting requests 2020-05-06 22:36:45 +02:00
Marco
0f976a260b Fix doc comment for parameter 'ipAddress' on 'Auth' constructor 2020-05-06 22:35:20 +02:00
Marco
dcd893a12c Document 'Auth#resetPasswordAndSignIn' in README 2020-04-20 21:36:08 +02:00
Marco
0086419175 Add tests for 'Auth#resetPasswordAndSignIn' 2020-04-20 21:35:04 +02:00
Marco
d49b35690c Implement 'Auth#resetPasswordAndSignIn' 2020-04-20 21:34:00 +02:00
Marco
171519fdf3 Use 'see' tag to link 'Auth#id' to 'Auth#getUserId' 2020-04-20 21:32:43 +02:00
Marco
14ce7b1e8f Add references between four methods for password reset via 'see' tags 2020-04-20 21:31:28 +02:00
Marco
49c70eff41 Document return value of 'Auth#resetPassword' in README 2020-04-20 21:02:57 +02:00
Marco
2f772b00c8 Adjust tests for 'Auth#resetPassword' now having a return value 2020-04-20 20:48:19 +02:00
Marco
5214da1f59 Make 'Auth#resetPassword' return both the user's ID and their email 2020-04-20 20:47:27 +02:00
Marco
d8847fb197 Document in README how to retrieve a list of all registered users 2020-03-19 18:52:24 +01:00
Emin Mühəmmədi
1757ad3fd1 Fix variable name in README 2019-07-28 17:44:37 +02:00
Marco
54f6c5320a Refer to section 'Additional user information' from 'Registration' 2019-05-23 19:29:45 +02:00
Marco
4b3f2ab91c Document option of custom expiry of requests for 'Auth#forgotPassword' 2019-02-25 19:52:32 +01:00
Marco
df990b5b75 Fix notes regarding session resync after adding or removing roles 2019-02-21 18:34:09 +01:00
Marco
7b2ac9b107 Fix missing entries in table of contents for 'Usage' 2019-01-29 13:33:07 +01:00
Marco
ad90c7d04a Change responses with success messages from comments to 'echo' 2018-10-05 00:27:01 +02:00
Marco
c0baa517fa Change responses with error messages from comments to 'die' statements 2018-10-04 23:55:55 +02:00
Marco
3120e3a6a5 Document return values of 'confirmEmail' and 'confirmEmailAndSignIn' 2018-10-04 23:12:41 +02:00
Marco
4cd6360fc7 Document optional database name, schema or other qualifier in README 2018-08-28 23:51:30 +02:00
Marco
382832457d Make use of database name, schema or other qualifier in all statements 2018-08-28 23:44:50 +02:00
Marco
f70923679f Implement methods 'makeTableName' and 'makeTableNameComponents' 2018-08-28 23:25:28 +02:00
Marco
521e73662d Allow for specification of database name, schema or other qualifier 2018-08-28 22:03:40 +02:00
Marco
2b3bf611e2 Update dependencies 2018-08-28 21:47:16 +02:00
Marco
352260c759 Remove obsolete error class 'DatabaseDriverError' 2018-07-25 20:31:36 +02:00
Marco
cbf2b52f29 Fix wrong example of variable name for library's instance in README 2018-07-23 01:08:04 +02:00
Marco
c685f22937 Add note about scope of variables with regard to closures to README 2018-05-28 21:28:00 +02:00
Marco
9d08c939a0 Fail safely in role checks when invalid input has been supplied 2018-05-25 23:19:07 +02:00
Marco
7a8508d56e Document effect of 'sessionResyncInterval' for affected operations 2018-04-26 18:12:30 +02:00
Marco
f6607f664d Enhance 'DatabaseError' instances to be more verbose 2018-04-20 18:01:00 +02:00
Marco
49a4ef8280 Document required database privileges in README 2018-04-03 14:48:10 +02:00
29 changed files with 644 additions and 270 deletions

298
README.md
View File

@@ -55,6 +55,9 @@ Migrating from an earlier version of this project? See our [upgrade guide](Migra
* [Email verification](#email-verification) * [Email verification](#email-verification)
* [Keeping the user logged in](#keeping-the-user-logged-in) * [Keeping the user logged in](#keeping-the-user-logged-in)
* [Password reset (“forgot password”)](#password-reset-forgot-password) * [Password reset (“forgot password”)](#password-reset-forgot-password)
* [Initiating the request](#step-1-of-3-initiating-the-request)
* [Verifying an attempt](#step-2-of-3-verifying-an-attempt)
* [Updating the password](#step-3-of-3-updating-the-password)
* [Changing the current users password](#changing-the-current-users-password) * [Changing the current users password](#changing-the-current-users-password)
* [Changing the current users email address](#changing-the-current-users-email-address) * [Changing the current users email address](#changing-the-current-users-email-address)
* [Re-sending confirmation requests](#re-sending-confirmation-requests) * [Re-sending confirmation requests](#re-sending-confirmation-requests)
@@ -64,6 +67,7 @@ Migrating from an earlier version of this project? See our [upgrade guide](Migra
* [User ID](#user-id) * [User ID](#user-id)
* [Email address](#email-address) * [Email address](#email-address)
* [Display name](#display-name) * [Display name](#display-name)
* [Status information](#status-information)
* [Checking whether the user was “remembered”](#checking-whether-the-user-was-remembered) * [Checking whether the user was “remembered”](#checking-whether-the-user-was-remembered)
* [IP address](#ip-address) * [IP address](#ip-address)
* [Additional user information](#additional-user-information) * [Additional user information](#additional-user-information)
@@ -114,7 +118,7 @@ Migrating from an earlier version of this project? See our [upgrade guide](Migra
$auth = new \Delight\Auth\Auth($db); $auth = new \Delight\Auth\Auth($db);
``` ```
If you have an open `PDO` connection already, just re-use it. If you have an open `PDO` connection already, just re-use it. The database user (e.g. `my-username`) needs at least the privileges `SELECT`, `INSERT`, `UPDATE` and `DELETE` for the tables used by this library (or their parent database).
If your web server is behind a proxy server and `$_SERVER['REMOTE_ADDR']` only contains the proxys IP address, you must pass the users real IP address to the constructor in the second argument, which is named `$ipAddress`. The default is the usual remote IP address received by PHP. If your web server is behind a proxy server and `$_SERVER['REMOTE_ADDR']` only contains the proxys IP address, you must pass the users real IP address to the constructor in the second argument, which is named `$ipAddress`. The default is the usual remote IP address received by PHP.
@@ -124,34 +128,46 @@ During development, you may want to disable the request limiting or throttling p
During the lifetime of a session, some user data may be changed remotely, either by a client in another session or by an administrator. That means this information must be regularly resynchronized with its authoritative source in the database, which this library does automatically. By default, this happens every five minutes. If you want to change this interval, pass a custom interval in seconds to the constructor as the fifth argument, which is named `$sessionResyncInterval`. During the lifetime of a session, some user data may be changed remotely, either by a client in another session or by an administrator. That means this information must be regularly resynchronized with its authoritative source in the database, which this library does automatically. By default, this happens every five minutes. If you want to change this interval, pass a custom interval in seconds to the constructor as the fifth argument, which is named `$sessionResyncInterval`.
If all your database tables need a common database name, schema name, or other qualifier that must be specified explicitly, you can optionally pass that qualifier to the constructor as the sixth parameter, which is named `$dbSchema`.
### Registration (sign up) ### Registration (sign up)
```php ```php
try { try {
$userId = $auth->register($_POST['email'], $_POST['password'], $_POST['username'], function ($selector, $token) { $userId = $auth->register($_POST['email'], $_POST['password'], $_POST['username'], function ($selector, $token) {
// send `$selector` and `$token` to the user (e.g. via email) echo 'Send ' . $selector . ' and ' . $token . ' to the user (e.g. via email)';
}); });
// we have signed up a new user with the ID `$userId` echo 'We have signed up a new user with the ID ' . $userId;
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// invalid email address die('Invalid email address');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// invalid password die('Invalid password');
} }
catch (\Delight\Auth\UserAlreadyExistsException $e) { catch (\Delight\Auth\UserAlreadyExistsException $e) {
// user already exists die('User already exists');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
**Note:** The anonymous callback function is a [closure](http://php.net/manual/en/functions.anonymous.php). Thus, besides its own parameters, only [superglobals](http://php.net/manual/en/language.variables.superglobals.php) like `$_GET`, `$_POST`, `$_COOKIE` and `$_SERVER` are available inside. For any other variable from the parent scope, you need to explicitly make a copy available inside by adding a `use` clause after the parameter list.
The username in the third parameter is optional. You can pass `null` there if you dont want to manage usernames. The username in the third parameter is optional. You can pass `null` there if you dont want to manage usernames.
If you want to enforce unique usernames, on the other hand, simply call `registerWithUniqueUsername` instead of `register`, and be prepared to catch the `DuplicateUsernameException`. If you want to enforce unique usernames, on the other hand, simply call `registerWithUniqueUsername` instead of `register`, and be prepared to catch the `DuplicateUsernameException`.
**Note:** When accepting and managing usernames, you may want to exclude non-printing control characters and certain printable special characters, as in the character class `[\x00-\x1f\x7f\/:\\]`. In order to do so, you could wrap the call to `Auth#register` or `Auth#registerWithUniqueUsername` inside a conditional branch, for example by only accepting usernames when the following condition is satisfied:
```php
if (\preg_match('/[\x00-\x1f\x7f\/:\\\\]/', $username) === 0) {
// ...
}
```
For email verification, you should build an URL with the selector and token and send it to the user, e.g.: For email verification, you should build an URL with the selector and token and send it to the user, e.g.:
```php ```php
@@ -160,25 +176,29 @@ $url = 'https://www.example.com/verify_email?selector=' . \urlencode($selector)
If you dont want to perform email verification, just omit the last parameter to `Auth#register`. The new user will be active immediately, then. If you dont want to perform email verification, just omit the last parameter to `Auth#register`. The new user will be active immediately, then.
Need to store additional user information? Read on [here](#additional-user-information).
**Note:** When sending an email to the user, please note that the (optional) username, at this point, has not yet been confirmed as acceptable to the owner of the (new) email address. It could contain offensive or misleading language chosen by someone who is not actually the owner of the address.
### Login (sign in) ### Login (sign in)
```php ```php
try { try {
$auth->login($_POST['email'], $_POST['password']); $auth->login($_POST['email'], $_POST['password']);
// user is logged in echo 'User is logged in';
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// wrong email address die('Wrong email address');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// wrong password die('Wrong password');
} }
catch (\Delight\Auth\EmailNotVerifiedException $e) { catch (\Delight\Auth\EmailNotVerifiedException $e) {
// email not verified die('Email not verified');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
@@ -192,24 +212,26 @@ Extract the selector and token from the URL that the user clicked on in the veri
try { try {
$auth->confirmEmail($_GET['selector'], $_GET['token']); $auth->confirmEmail($_GET['selector'], $_GET['token']);
// email address has been verified echo 'Email address has been verified';
} }
catch (\Delight\Auth\InvalidSelectorTokenPairException $e) { catch (\Delight\Auth\InvalidSelectorTokenPairException $e) {
// invalid token die('Invalid token');
} }
catch (\Delight\Auth\TokenExpiredException $e) { catch (\Delight\Auth\TokenExpiredException $e) {
// token expired die('Token expired');
} }
catch (\Delight\Auth\UserAlreadyExistsException $e) { catch (\Delight\Auth\UserAlreadyExistsException $e) {
// email address already exists die('Email address already exists');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
If you want the user to be automatically signed in after successful confirmation, just call `confirmEmailAndSignIn` instead of `confirmEmail`. That alternative method also supports [persistent logins](#keeping-the-user-logged-in) via its optional third parameter. If you want the user to be automatically signed in after successful confirmation, just call `confirmEmailAndSignIn` instead of `confirmEmail`. That alternative method also supports [persistent logins](#keeping-the-user-logged-in) via its optional third parameter.
On success, the two methods `confirmEmail` and `confirmEmailAndSignIn` both return an array with the users new email address, which has just been verified, at index one. If the confirmation was for an address change instead of a simple address verification, the users old email address will be included in the array at index zero.
### Keeping the user logged in ### Keeping the user logged in
The third parameter to the `Auth#login` and `Auth#confirmEmailAndSignIn` methods controls whether the login is persistent with a long-lived cookie. With such a persistent login, users may stay authenticated for a long time, even when the browser session has already been closed and the session cookies have expired. Typically, youll want to keep the user logged in for weeks or months with this feature, which is known as “remember me” or “keep me logged in”. Many users will find this more convenient, but it may be less secure if they leave their devices unattended. The third parameter to the `Auth#login` and `Auth#confirmEmailAndSignIn` methods controls whether the login is persistent with a long-lived cookie. With such a persistent login, users may stay authenticated for a long time, even when the browser session has already been closed and the session cookies have expired. Typically, youll want to keep the user logged in for weeks or months with this feature, which is known as “remember me” or “keep me logged in”. Many users will find this more convenient, but it may be less secure if they leave their devices unattended.
@@ -242,31 +264,35 @@ Omit the third parameter or set it to `null` to disable the feature. Otherwise,
```php ```php
try { try {
$auth->forgotPassword($_POST['email'], function ($selector, $token) { $auth->forgotPassword($_POST['email'], function ($selector, $token) {
// send `$selector` and `$token` to the user (e.g. via email) echo 'Send ' . $selector . ' and ' . $token . ' to the user (e.g. via email)';
}); });
// request has been generated echo 'Request has been generated';
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// invalid email address die('Invalid email address');
} }
catch (\Delight\Auth\EmailNotVerifiedException $e) { catch (\Delight\Auth\EmailNotVerifiedException $e) {
// email not verified die('Email not verified');
} }
catch (\Delight\Auth\ResetDisabledException $e) { catch (\Delight\Auth\ResetDisabledException $e) {
// password reset is disabled die('Password reset is disabled');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
**Note:** The anonymous callback function is a [closure](http://php.net/manual/en/functions.anonymous.php). Thus, besides its own parameters, only [superglobals](http://php.net/manual/en/language.variables.superglobals.php) like `$_GET`, `$_POST`, `$_COOKIE` and `$_SERVER` are available inside. For any other variable from the parent scope, you need to explicitly make a copy available inside by adding a `use` clause after the parameter list.
You should build an URL with the selector and token and send it to the user, e.g.: You should build an URL with the selector and token and send it to the user, e.g.:
```php ```php
$url = 'https://www.example.com/reset_password?selector=' . \urlencode($selector) . '&token=' . \urlencode($token); $url = 'https://www.example.com/reset_password?selector=' . \urlencode($selector) . '&token=' . \urlencode($token);
``` ```
If the default lifetime of the password reset requests does not work for you, you can use the third parameter of `Auth#forgotPassword` to specify a custom interval in seconds after which the requests should expire.
#### Step 2 of 3: Verifying an attempt #### Step 2 of 3: Verifying an attempt
As the next step, users will click on the link that they received. Extract the selector and token from the URL. As the next step, users will click on the link that they received. Extract the selector and token from the URL.
@@ -277,22 +303,22 @@ If the selector/token pair is valid, let the user choose a new password:
try { try {
$auth->canResetPasswordOrThrow($_GET['selector'], $_GET['token']); $auth->canResetPasswordOrThrow($_GET['selector'], $_GET['token']);
// put the selector into a `hidden` field (or keep it in the URL) echo 'Put the selector into a "hidden" field (or keep it in the URL)';
// put the token into a `hidden` field (or keep it in the URL) echo 'Put the token into a "hidden" field (or keep it in the URL)';
// ask the user for their new password echo 'Ask the user for their new password';
} }
catch (\Delight\Auth\InvalidSelectorTokenPairException $e) { catch (\Delight\Auth\InvalidSelectorTokenPairException $e) {
// invalid token die('Invalid token');
} }
catch (\Delight\Auth\TokenExpiredException $e) { catch (\Delight\Auth\TokenExpiredException $e) {
// token expired die('Token expired');
} }
catch (\Delight\Auth\ResetDisabledException $e) { catch (\Delight\Auth\ResetDisabledException $e) {
// password reset is disabled die('Password reset is disabled');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
@@ -300,10 +326,10 @@ Alternatively, if you dont need any error messages but only want to check the
```php ```php
if ($auth->canResetPassword($_GET['selector'], $_GET['token'])) { if ($auth->canResetPassword($_GET['selector'], $_GET['token'])) {
// put the selector into a `hidden` field (or keep it in the URL) echo 'Put the selector into a "hidden" field (or keep it in the URL)';
// put the token into a `hidden` field (or keep it in the URL) echo 'Put the token into a "hidden" field (or keep it in the URL)';
// ask the user for their new password echo 'Ask the user for their new password';
} }
``` ```
@@ -315,25 +341,29 @@ Now when you have the new password for the user (and still have the other two pi
try { try {
$auth->resetPassword($_POST['selector'], $_POST['token'], $_POST['password']); $auth->resetPassword($_POST['selector'], $_POST['token'], $_POST['password']);
// password has been reset echo 'Password has been reset';
} }
catch (\Delight\Auth\InvalidSelectorTokenPairException $e) { catch (\Delight\Auth\InvalidSelectorTokenPairException $e) {
// invalid token die('Invalid token');
} }
catch (\Delight\Auth\TokenExpiredException $e) { catch (\Delight\Auth\TokenExpiredException $e) {
// token expired die('Token expired');
} }
catch (\Delight\Auth\ResetDisabledException $e) { catch (\Delight\Auth\ResetDisabledException $e) {
// password reset is disabled die('Password reset is disabled');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// invalid password die('Invalid password');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
Do you want to have the respective user signed in automatically when their password reset succeeds? Simply use `Auth#resetPasswordAndSignIn` instead of `Auth#resetPassword` to log in the user immediately.
If you need the users ID or email address, e.g. for sending them a notification that their password has successfully been reset, just use the return value of `Auth#resetPassword`, which is an array containing two entries named `id` and `email`.
### Changing the current users password ### Changing the current users password
If a user is currently logged in, they may change their password. If a user is currently logged in, they may change their password.
@@ -342,16 +372,16 @@ If a user is currently logged in, they may change their password.
try { try {
$auth->changePassword($_POST['oldPassword'], $_POST['newPassword']); $auth->changePassword($_POST['oldPassword'], $_POST['newPassword']);
// password has been changed echo 'Password has been changed';
} }
catch (\Delight\Auth\NotLoggedInException $e) { catch (\Delight\Auth\NotLoggedInException $e) {
// not logged in die('Not logged in');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// invalid password(s) die('Invalid password(s)');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
@@ -369,40 +399,46 @@ If a user is currently logged in, they may change their email address.
try { try {
if ($auth->reconfirmPassword($_POST['password'])) { if ($auth->reconfirmPassword($_POST['password'])) {
$auth->changeEmail($_POST['newEmail'], function ($selector, $token) { $auth->changeEmail($_POST['newEmail'], function ($selector, $token) {
// send `$selector` and `$token` to the user (e.g. via email to the *new* address) echo 'Send ' . $selector . ' and ' . $token . ' to the user (e.g. via email to the *new* address)';
}); });
// the change will take effect as soon as the new email address has been confirmed echo 'The change will take effect as soon as the new email address has been confirmed';
} }
else { else {
// we can't say if the user is who they claim to be echo 'We can\'t say if the user is who they claim to be';
} }
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// invalid email address die('Invalid email address');
} }
catch (\Delight\Auth\UserAlreadyExistsException $e) { catch (\Delight\Auth\UserAlreadyExistsException $e) {
// email address already exists die('Email address already exists');
} }
catch (\Delight\Auth\EmailNotVerifiedException $e) { catch (\Delight\Auth\EmailNotVerifiedException $e) {
// account not verified die('Account not verified');
} }
catch (\Delight\Auth\NotLoggedInException $e) { catch (\Delight\Auth\NotLoggedInException $e) {
// not logged in die('Not logged in');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
**Note:** The anonymous callback function is a [closure](http://php.net/manual/en/functions.anonymous.php). Thus, besides its own parameters, only [superglobals](http://php.net/manual/en/language.variables.superglobals.php) like `$_GET`, `$_POST`, `$_COOKIE` and `$_SERVER` are available inside. For any other variable from the parent scope, you need to explicitly make a copy available inside by adding a `use` clause after the parameter list.
For email verification, you should build an URL with the selector and token and send it to the user, e.g.: For email verification, you should build an URL with the selector and token and send it to the user, e.g.:
```php ```php
$url = 'https://www.example.com/verify_email?selector=' . \urlencode($selector) . '&token=' . \urlencode($token); $url = 'https://www.example.com/verify_email?selector=' . \urlencode($selector) . '&token=' . \urlencode($token);
``` ```
**Note:** When sending an email to the user, please note that the (optional) username, at this point, has not yet been confirmed as acceptable to the owner of the (new) email address. It could contain offensive or misleading language chosen by someone who is not actually the owner of the address.
After the request to change the email address has been made, or even better, after the change has been confirmed by the user, you should send an email to their accounts *previous* email address as an out-of-band notification informing the account owner about this critical change. After the request to change the email address has been made, or even better, after the change has been confirmed by the user, you should send an email to their accounts *previous* email address as an out-of-band notification informing the account owner about this critical change.
**Note:** Changes to a users email address take effect in the local session immediately, as expected. In other sessions (e.g. on other devices), the changes may need up to five minutes to take effect, though. This increases performance and usually poses no problem. If you want to change this behavior, nevertheless, simply decrease (or perhaps increase) the value that you pass to the [`Auth` constructor](#creating-a-new-instance) as the argument named `$sessionResyncInterval`.
### Re-sending confirmation requests ### Re-sending confirmation requests
If an earlier confirmation request could not be delivered to the user, or if the user missed that request, or if they just dont want to wait any longer, you may re-send an earlier request like this: If an earlier confirmation request could not be delivered to the user, or if the user missed that request, or if they just dont want to wait any longer, you may re-send an earlier request like this:
@@ -410,16 +446,16 @@ If an earlier confirmation request could not be delivered to the user, or if the
```php ```php
try { try {
$auth->resendConfirmationForEmail($_POST['email'], function ($selector, $token) { $auth->resendConfirmationForEmail($_POST['email'], function ($selector, $token) {
// send `$selector` and `$token` to the user (e.g. via email) echo 'Send ' . $selector . ' and ' . $token . ' to the user (e.g. via email)';
}); });
// the user may now respond to the confirmation request (usually by clicking a link) echo 'The user may now respond to the confirmation request (usually by clicking a link)';
} }
catch (\Delight\Auth\ConfirmationRequestNotFound $e) { catch (\Delight\Auth\ConfirmationRequestNotFound $e) {
// no earlier request found that could be re-sent die('No earlier request found that could be re-sent');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// there have been too many requests -- try again later die('There have been too many requests -- try again later');
} }
``` ```
@@ -428,25 +464,29 @@ If you want to specify the user by their ID instead of by their email address, t
```php ```php
try { try {
$auth->resendConfirmationForUserId($_POST['userId'], function ($selector, $token) { $auth->resendConfirmationForUserId($_POST['userId'], function ($selector, $token) {
// send `$selector` and `$token` to the user (e.g. via email) echo 'Send ' . $selector . ' and ' . $token . ' to the user (e.g. via email)';
}); });
// the user may now respond to the confirmation request (usually by clicking a link) echo 'The user may now respond to the confirmation request (usually by clicking a link)';
} }
catch (\Delight\Auth\ConfirmationRequestNotFound $e) { catch (\Delight\Auth\ConfirmationRequestNotFound $e) {
// no earlier request found that could be re-sent die('No earlier request found that could be re-sent');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// there have been too many requests -- try again later die('There have been too many requests -- try again later');
} }
``` ```
**Note:** The anonymous callback function is a [closure](http://php.net/manual/en/functions.anonymous.php). Thus, besides its own parameters, only [superglobals](http://php.net/manual/en/language.variables.superglobals.php) like `$_GET`, `$_POST`, `$_COOKIE` and `$_SERVER` are available inside. For any other variable from the parent scope, you need to explicitly make a copy available inside by adding a `use` clause after the parameter list.
Usually, you should build an URL with the selector and token and send it to the user, e.g. as follows: Usually, you should build an URL with the selector and token and send it to the user, e.g. as follows:
```php ```php
$url = 'https://www.example.com/verify_email?selector=' . \urlencode($selector) . '&token=' . \urlencode($token); $url = 'https://www.example.com/verify_email?selector=' . \urlencode($selector) . '&token=' . \urlencode($token);
``` ```
**Note:** When sending an email to the user, please note that the (optional) username, at this point, has not yet been confirmed as acceptable to the owner of the (new) email address. It could contain offensive or misleading language chosen by someone who is not actually the owner of the address.
### Logout ### Logout
```php ```php
@@ -458,7 +498,7 @@ try {
$auth->logOutEverywhereElse(); $auth->logOutEverywhereElse();
} }
catch (\Delight\Auth\NotLoggedInException $e) { catch (\Delight\Auth\NotLoggedInException $e) {
// not logged in die('Not logged in');
} }
// or // or
@@ -467,7 +507,7 @@ try {
$auth->logOutEverywhere(); $auth->logOutEverywhere();
} }
catch (\Delight\Auth\NotLoggedInException $e) { catch (\Delight\Auth\NotLoggedInException $e) {
// not logged in die('Not logged in');
} }
``` ```
@@ -477,16 +517,18 @@ Additionally, if you store custom information in the session as well, and if you
$auth->destroySession(); $auth->destroySession();
``` ```
**Note:** Global logouts take effect in the local session immediately, as expected. In other sessions (e.g. on other devices), the changes may need up to five minutes to take effect, though. This increases performance and usually poses no problem. If you want to change this behavior, nevertheless, simply decrease (or perhaps increase) the value that you pass to the [`Auth` constructor](#creating-a-new-instance) as the argument named `$sessionResyncInterval`.
### Accessing user information ### Accessing user information
#### Login state #### Login state
```php ```php
if ($auth->isLoggedIn()) { if ($auth->isLoggedIn()) {
// user is signed in echo 'User is signed in';
} }
else { else {
// user is *not* signed in yet echo 'User is not signed in yet';
} }
``` ```
@@ -513,7 +555,7 @@ If the user is not currently signed in, this returns `null`.
#### Display name #### Display name
```php ```php
$email = $auth->getUsername(); $username = $auth->getUsername();
``` ```
Remember that usernames are optional and there is only a username if you supplied it during registration. Remember that usernames are optional and there is only a username if you supplied it during registration.
@@ -524,27 +566,27 @@ If the user is not currently signed in, this returns `null`.
```php ```php
if ($auth->isNormal()) { if ($auth->isNormal()) {
// user is in default state echo 'User is in default state';
} }
if ($auth->isArchived()) { if ($auth->isArchived()) {
// user has been archived echo 'User has been archived';
} }
if ($auth->isBanned()) { if ($auth->isBanned()) {
// user has been banned echo 'User has been banned';
} }
if ($auth->isLocked()) { if ($auth->isLocked()) {
// user has been locked echo 'User has been locked';
} }
if ($auth->isPendingReview()) { if ($auth->isPendingReview()) {
// user is pending review echo 'User is pending review';
} }
if ($auth->isSuspended()) { if ($auth->isSuspended()) {
// user has been suspended echo 'User has been suspended';
} }
``` ```
@@ -552,10 +594,10 @@ if ($auth->isSuspended()) {
```php ```php
if ($auth->isRemembered()) { if ($auth->isRemembered()) {
// user did not sign in but was logged in through their long-lived cookie echo 'User did not sign in but was logged in through their long-lived cookie';
} }
else { else {
// user signed in manually echo 'User signed in manually';
} }
``` ```
@@ -601,17 +643,17 @@ For example, when a user has been remembered by a long-lived cookie and thus `Au
```php ```php
try { try {
if ($auth->reconfirmPassword($_POST['password'])) { if ($auth->reconfirmPassword($_POST['password'])) {
// the user really seems to be who they claim to be echo 'The user really seems to be who they claim to be';
} }
else { else {
// we can't say if the user is who they claim to be echo 'We can\'t say if the user is who they claim to be';
} }
} }
catch (\Delight\Auth\NotLoggedInException $e) { catch (\Delight\Auth\NotLoggedInException $e) {
// the user is not signed in die('The user is not signed in');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
@@ -625,19 +667,19 @@ Users may have no role at all (which they do by default), exactly one role, or a
```php ```php
if ($auth->hasRole(\Delight\Auth\Role::SUPER_MODERATOR)) { if ($auth->hasRole(\Delight\Auth\Role::SUPER_MODERATOR)) {
// the user is a super moderator echo 'The user is a super moderator';
} }
// or // or
if ($auth->hasAnyRole(\Delight\Auth\Role::DEVELOPER, \Delight\Auth\Role::MANAGER)) { if ($auth->hasAnyRole(\Delight\Auth\Role::DEVELOPER, \Delight\Auth\Role::MANAGER)) {
// the user is either a developer, or a manager, or both echo 'The user is either a developer, or a manager, or both';
} }
// or // or
if ($auth->hasAllRoles(\Delight\Auth\Role::DEVELOPER, \Delight\Auth\Role::MANAGER)) { if ($auth->hasAllRoles(\Delight\Auth\Role::DEVELOPER, \Delight\Auth\Role::MANAGER)) {
// the user is both a developer and a manager echo 'The user is both a developer and a manager';
} }
``` ```
@@ -704,20 +746,20 @@ function canEditArticle(\Delight\Auth\Auth $auth) {
// ... // ...
if (canEditArticle($app->auth())) { if (canEditArticle($auth)) {
// the user can edit articles here echo 'The user can edit articles here';
} }
// ... // ...
if (canEditArticle($app->auth())) { if (canEditArticle($auth)) {
// ... and here echo '... and here';
} }
// ... // ...
if (canEditArticle($app->auth())) { if (canEditArticle($auth)) {
// ... and here echo '... and here';
} }
``` ```
@@ -773,17 +815,17 @@ try {
if ($auth->reconfirmPassword($_POST['password'])) { if ($auth->reconfirmPassword($_POST['password'])) {
$auth->setPasswordResetEnabled($_POST['enabled'] == 1); $auth->setPasswordResetEnabled($_POST['enabled'] == 1);
// the setting has been changed echo 'The setting has been changed';
} }
else { else {
// we can't say if the user is who they claim to be echo 'We can\'t say if the user is who they claim to be';
} }
} }
catch (\Delight\Auth\NotLoggedInException $e) { catch (\Delight\Auth\NotLoggedInException $e) {
// the user is not signed in die('The user is not signed in');
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// too many requests die('Too many requests');
} }
``` ```
@@ -806,7 +848,7 @@ try {
// throttle the specified resource or feature to *3* requests per *60* seconds // throttle the specified resource or feature to *3* requests per *60* seconds
$auth->throttle([ 'my-resource-name' ], 3, 60); $auth->throttle([ 'my-resource-name' ], 3, 60);
// do something with the resource or feature echo 'Do something with the resource or feature';
} }
catch (\Delight\Auth\TooManyRequestsException $e) { catch (\Delight\Auth\TooManyRequestsException $e) {
// operation cancelled // operation cancelled
@@ -840,16 +882,16 @@ Do not forget to implement secure access control before exposing access to this
try { try {
$userId = $auth->admin()->createUser($_POST['email'], $_POST['password'], $_POST['username']); $userId = $auth->admin()->createUser($_POST['email'], $_POST['password'], $_POST['username']);
// we have signed up a new user with the ID `$userId` echo 'We have signed up a new user with the ID ' . $userId;
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// invalid email address die('Invalid email address');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// invalid password die('Invalid password');
} }
catch (\Delight\Auth\UserAlreadyExistsException $e) { catch (\Delight\Auth\UserAlreadyExistsException $e) {
// user already exists die('User already exists');
} }
``` ```
@@ -866,7 +908,7 @@ try {
$auth->admin()->deleteUserById($_POST['id']); $auth->admin()->deleteUserById($_POST['id']);
} }
catch (\Delight\Auth\UnknownIdException $e) { catch (\Delight\Auth\UnknownIdException $e) {
// unknown ID die('Unknown ID');
} }
``` ```
@@ -877,7 +919,7 @@ try {
$auth->admin()->deleteUserByEmail($_POST['email']); $auth->admin()->deleteUserByEmail($_POST['email']);
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// unknown email address die('Unknown email address');
} }
``` ```
@@ -888,13 +930,23 @@ try {
$auth->admin()->deleteUserByUsername($_POST['username']); $auth->admin()->deleteUserByUsername($_POST['username']);
} }
catch (\Delight\Auth\UnknownUsernameException $e) { catch (\Delight\Auth\UnknownUsernameException $e) {
// unknown username die('Unknown username');
} }
catch (\Delight\Auth\AmbiguousUsernameException $e) { catch (\Delight\Auth\AmbiguousUsernameException $e) {
// ambiguous username die('Ambiguous username');
} }
``` ```
#### Retrieving a list of registered users
When fetching a list of all users, the requirements vary greatly between projects and use cases, and customization is common. For example, you might want to fetch different columns, join related tables, filter by certain criteria, change how results are sorted (in varying direction), and limit the number of results (while providing an offset).
Thats why its easier to use a single custom SQL query. Start with the following:
```sql
SELECT id, email, username, status, verified, roles_mask, registered, last_login FROM users;
```
#### Assigning roles to users #### Assigning roles to users
```php ```php
@@ -902,7 +954,7 @@ try {
$auth->admin()->addRoleForUserById($userId, \Delight\Auth\Role::ADMIN); $auth->admin()->addRoleForUserById($userId, \Delight\Auth\Role::ADMIN);
} }
catch (\Delight\Auth\UnknownIdException $e) { catch (\Delight\Auth\UnknownIdException $e) {
// unknown user ID die('Unknown user ID');
} }
// or // or
@@ -911,7 +963,7 @@ try {
$auth->admin()->addRoleForUserByEmail($userEmail, \Delight\Auth\Role::ADMIN); $auth->admin()->addRoleForUserByEmail($userEmail, \Delight\Auth\Role::ADMIN);
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// unknown email address die('Unknown email address');
} }
// or // or
@@ -920,13 +972,15 @@ try {
$auth->admin()->addRoleForUserByUsername($username, \Delight\Auth\Role::ADMIN); $auth->admin()->addRoleForUserByUsername($username, \Delight\Auth\Role::ADMIN);
} }
catch (\Delight\Auth\UnknownUsernameException $e) { catch (\Delight\Auth\UnknownUsernameException $e) {
// unknown username die('Unknown username');
} }
catch (\Delight\Auth\AmbiguousUsernameException $e) { catch (\Delight\Auth\AmbiguousUsernameException $e) {
// ambiguous username die('Ambiguous username');
} }
``` ```
**Note:** Changes to a users set of roles may need up to five minutes to take effect. This increases performance and usually poses no problem. If you want to change this behavior, nevertheless, simply decrease (or perhaps increase) the value that you pass to the [`Auth` constructor](#creating-a-new-instance) as the argument named `$sessionResyncInterval`.
#### Taking roles away from users #### Taking roles away from users
```php ```php
@@ -934,7 +988,7 @@ try {
$auth->admin()->removeRoleForUserById($userId, \Delight\Auth\Role::ADMIN); $auth->admin()->removeRoleForUserById($userId, \Delight\Auth\Role::ADMIN);
} }
catch (\Delight\Auth\UnknownIdException $e) { catch (\Delight\Auth\UnknownIdException $e) {
// unknown user ID die('Unknown user ID');
} }
// or // or
@@ -943,7 +997,7 @@ try {
$auth->admin()->removeRoleForUserByEmail($userEmail, \Delight\Auth\Role::ADMIN); $auth->admin()->removeRoleForUserByEmail($userEmail, \Delight\Auth\Role::ADMIN);
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// unknown email address die('Unknown email address');
} }
// or // or
@@ -952,26 +1006,28 @@ try {
$auth->admin()->removeRoleForUserByUsername($username, \Delight\Auth\Role::ADMIN); $auth->admin()->removeRoleForUserByUsername($username, \Delight\Auth\Role::ADMIN);
} }
catch (\Delight\Auth\UnknownUsernameException $e) { catch (\Delight\Auth\UnknownUsernameException $e) {
// unknown username die('Unknown username');
} }
catch (\Delight\Auth\AmbiguousUsernameException $e) { catch (\Delight\Auth\AmbiguousUsernameException $e) {
// ambiguous username die('Ambiguous username');
} }
``` ```
**Note:** Changes to a users set of roles may need up to five minutes to take effect. This increases performance and usually poses no problem. If you want to change this behavior, nevertheless, simply decrease (or perhaps increase) the value that you pass to the [`Auth` constructor](#creating-a-new-instance) as the argument named `$sessionResyncInterval`.
#### Checking roles #### Checking roles
```php ```php
try { try {
if ($auth->admin()->doesUserHaveRole($userId, \Delight\Auth\Role::ADMIN)) { if ($auth->admin()->doesUserHaveRole($userId, \Delight\Auth\Role::ADMIN)) {
// the specified user is an administrator echo 'The specified user is an administrator';
} }
else { else {
// the specified user is *not* an administrator echo 'The specified user is not an administrator';
} }
} }
catch (\Delight\Auth\UnknownIdException $e) { catch (\Delight\Auth\UnknownIdException $e) {
// unknown user ID die('Unknown user ID');
} }
``` ```
@@ -988,10 +1044,10 @@ try {
$auth->admin()->logInAsUserById($_POST['id']); $auth->admin()->logInAsUserById($_POST['id']);
} }
catch (\Delight\Auth\UnknownIdException $e) { catch (\Delight\Auth\UnknownIdException $e) {
// unknown ID die('Unknown ID');
} }
catch (\Delight\Auth\EmailNotVerifiedException $e) { catch (\Delight\Auth\EmailNotVerifiedException $e) {
// email address not verified die('Email address not verified');
} }
// or // or
@@ -1000,10 +1056,10 @@ try {
$auth->admin()->logInAsUserByEmail($_POST['email']); $auth->admin()->logInAsUserByEmail($_POST['email']);
} }
catch (\Delight\Auth\InvalidEmailException $e) { catch (\Delight\Auth\InvalidEmailException $e) {
// unknown email address die('Unknown email address');
} }
catch (\Delight\Auth\EmailNotVerifiedException $e) { catch (\Delight\Auth\EmailNotVerifiedException $e) {
// email address not verified die('Email address not verified');
} }
// or // or
@@ -1012,13 +1068,13 @@ try {
$auth->admin()->logInAsUserByUsername($_POST['username']); $auth->admin()->logInAsUserByUsername($_POST['username']);
} }
catch (\Delight\Auth\UnknownUsernameException $e) { catch (\Delight\Auth\UnknownUsernameException $e) {
// unknown username die('Unknown username');
} }
catch (\Delight\Auth\AmbiguousUsernameException $e) { catch (\Delight\Auth\AmbiguousUsernameException $e) {
// ambiguous username die('Ambiguous username');
} }
catch (\Delight\Auth\EmailNotVerifiedException $e) { catch (\Delight\Auth\EmailNotVerifiedException $e) {
// email address not verified die('Email address not verified');
} }
``` ```
@@ -1029,10 +1085,10 @@ try {
$auth->admin()->changePasswordForUserById($_POST['id'], $_POST['newPassword']); $auth->admin()->changePasswordForUserById($_POST['id'], $_POST['newPassword']);
} }
catch (\Delight\Auth\UnknownIdException $e) { catch (\Delight\Auth\UnknownIdException $e) {
// unknown ID die('Unknown ID');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// invalid password die('Invalid password');
} }
// or // or
@@ -1041,13 +1097,13 @@ try {
$auth->admin()->changePasswordForUserByUsername($_POST['username'], $_POST['newPassword']); $auth->admin()->changePasswordForUserByUsername($_POST['username'], $_POST['newPassword']);
} }
catch (\Delight\Auth\UnknownUsernameException $e) { catch (\Delight\Auth\UnknownUsernameException $e) {
// unknown username die('Unknown username');
} }
catch (\Delight\Auth\AmbiguousUsernameException $e) { catch (\Delight\Auth\AmbiguousUsernameException $e) {
// ambiguous username die('Ambiguous username');
} }
catch (\Delight\Auth\InvalidPasswordException $e) { catch (\Delight\Auth\InvalidPasswordException $e) {
// invalid password die('Invalid password');
} }
``` ```

View File

@@ -6,7 +6,7 @@
"ext-openssl": "*", "ext-openssl": "*",
"delight-im/base64": "^1.0", "delight-im/base64": "^1.0",
"delight-im/cookie": "^3.1", "delight-im/cookie": "^3.1",
"delight-im/db": "^1.2" "delight-im/db": "^1.3"
}, },
"type": "library", "type": "library",
"keywords": [ "auth", "authentication", "login", "security" ], "keywords": [ "auth", "authentication", "login", "security" ],

12
composer.lock generated
View File

@@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"content-hash": "54d541ae3c5ba25b0cc06688d2b65467", "content-hash": "e4acd9e4ba13c4d0692f07a03a454859",
"packages": [ "packages": [
{ {
"name": "delight-im/base64", "name": "delight-im/base64",
@@ -90,16 +90,16 @@
}, },
{ {
"name": "delight-im/db", "name": "delight-im/db",
"version": "v1.2.0", "version": "v1.3.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/delight-im/PHP-DB.git", "url": "https://github.com/delight-im/PHP-DB.git",
"reference": "df99ef7c2e86c7ce206647ffe8ba74447c075b57" "reference": "7a03da20b5592fa445c10cd6c7245d51037292c4"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/delight-im/PHP-DB/zipball/df99ef7c2e86c7ce206647ffe8ba74447c075b57", "url": "https://api.github.com/repos/delight-im/PHP-DB/zipball/7a03da20b5592fa445c10cd6c7245d51037292c4",
"reference": "df99ef7c2e86c7ce206647ffe8ba74447c075b57", "reference": "7a03da20b5592fa445c10cd6c7245d51037292c4",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@@ -127,7 +127,7 @@
"sql", "sql",
"sqlite" "sqlite"
], ],
"time": "2017-03-18T20:51:59+00:00" "time": "2018-08-28T18:23:01+00:00"
}, },
{ {
"name": "delight-im/http", "name": "delight-im/http",

View File

@@ -12,17 +12,16 @@ use Delight\Db\PdoDatabase;
use Delight\Db\PdoDsn; use Delight\Db\PdoDsn;
use Delight\Db\Throwable\Error; use Delight\Db\Throwable\Error;
require_once __DIR__ . '/Exceptions.php';
/** Component that can be used for administrative tasks by privileged and authorized users */ /** Component that can be used for administrative tasks by privileged and authorized users */
final class Administration extends UserManager { final class Administration extends UserManager {
/** /**
* @param PdoDatabase|PdoDsn|\PDO $databaseConnection the database connection to operate on * @param PdoDatabase|PdoDsn|\PDO $databaseConnection the database connection to operate on
* @param string|null $dbTablePrefix (optional) the prefix for the names of all database tables used by this component * @param string|null $dbTablePrefix (optional) the prefix for the names of all database tables used by this component
* @param string|null $dbSchema (optional) the schema name for all database tables used by this component
*/ */
public function __construct($databaseConnection, $dbTablePrefix = null) { public function __construct($databaseConnection, $dbTablePrefix = null, $dbSchema = null) {
parent::__construct($databaseConnection, $dbTablePrefix); parent::__construct($databaseConnection, $dbTablePrefix, $dbSchema);
} }
/** /**
@@ -270,11 +269,14 @@ final class Administration extends UserManager {
* @see Role * @see Role
*/ */
public function doesUserHaveRole($userId, $role) { public function doesUserHaveRole($userId, $role) {
if (empty($role) || !\is_numeric($role)) {
return false;
}
$userId = (int) $userId; $userId = (int) $userId;
$role = (int) $role;
$rolesBitmask = $this->db->selectValue( $rolesBitmask = $this->db->selectValue(
'SELECT roles_mask FROM ' . $this->dbTablePrefix . 'users WHERE id = ?', 'SELECT roles_mask FROM ' . $this->makeTableName('users') . ' WHERE id = ?',
[ $userId ] [ $userId ]
); );
@@ -282,6 +284,8 @@ final class Administration extends UserManager {
throw new UnknownIdException(); throw new UnknownIdException();
} }
$role = (int) $role;
return ($rolesBitmask & $role) === $role; return ($rolesBitmask & $role) === $role;
} }
@@ -298,7 +302,7 @@ final class Administration extends UserManager {
$userId = (int) $userId; $userId = (int) $userId;
$rolesBitmask = $this->db->selectValue( $rolesBitmask = $this->db->selectValue(
'SELECT roles_mask FROM ' . $this->dbTablePrefix . 'users WHERE id = ?', 'SELECT roles_mask FROM ' . $this->makeTableName('users') . ' WHERE id = ?',
[ $userId ] [ $userId ]
); );
@@ -425,14 +429,14 @@ final class Administration extends UserManager {
private function deleteUsersByColumnValue($columnName, $columnValue) { private function deleteUsersByColumnValue($columnName, $columnValue) {
try { try {
return $this->db->delete( return $this->db->delete(
$this->dbTablePrefix . 'users', $this->makeTableNameComponents('users'),
[ [
$columnName => $columnValue $columnName => $columnValue
] ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
@@ -452,12 +456,12 @@ final class Administration extends UserManager {
private function modifyRolesForUserByColumnValue($columnName, $columnValue, callable $modification) { private function modifyRolesForUserByColumnValue($columnName, $columnValue, callable $modification) {
try { try {
$userData = $this->db->selectRow( $userData = $this->db->selectRow(
'SELECT id, roles_mask FROM ' . $this->dbTablePrefix . 'users WHERE ' . $columnName . ' = ?', 'SELECT id, roles_mask FROM ' . $this->makeTableName('users') . ' WHERE ' . $columnName . ' = ?',
[ $columnValue ] [ $columnValue ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if ($userData === null) { if ($userData === null) {
@@ -468,7 +472,7 @@ final class Administration extends UserManager {
try { try {
$this->db->exec( $this->db->exec(
'UPDATE ' . $this->dbTablePrefix . 'users SET roles_mask = ? WHERE id = ?', 'UPDATE ' . $this->makeTableName('users') . ' SET roles_mask = ? WHERE id = ?',
[ [
$newRolesBitmask, $newRolesBitmask,
(int) $userData['id'] (int) $userData['id']
@@ -478,7 +482,7 @@ final class Administration extends UserManager {
return true; return true;
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
@@ -544,12 +548,12 @@ final class Administration extends UserManager {
private function logInAsUserByColumnValue($columnName, $columnValue) { private function logInAsUserByColumnValue($columnName, $columnValue) {
try { try {
$users = $this->db->select( $users = $this->db->select(
'SELECT verified, id, email, username, status, roles_mask FROM ' . $this->dbTablePrefix . 'users WHERE ' . $columnName . ' = ? LIMIT 2 OFFSET 0', 'SELECT verified, id, email, username, status, roles_mask FROM ' . $this->makeTableName('users') . ' WHERE ' . $columnName . ' = ? LIMIT 2 OFFSET 0',
[ $columnValue ] [ $columnValue ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
$numberOfMatchingUsers = ($users !== null) ? \count($users) : 0; $numberOfMatchingUsers = ($users !== null) ? \count($users) : 0;

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class AmbiguousUsernameException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class AttemptCancelledException extends AuthException {}

View File

@@ -16,8 +16,6 @@ use Delight\Db\PdoDsn;
use Delight\Db\Throwable\Error; use Delight\Db\Throwable\Error;
use Delight\Db\Throwable\IntegrityConstraintViolationException; use Delight\Db\Throwable\IntegrityConstraintViolationException;
require_once __DIR__ . '/Exceptions.php';
/** Component that provides all features and utilities for secure authentication of individual users */ /** Component that provides all features and utilities for secure authentication of individual users */
final class Auth extends UserManager { final class Auth extends UserManager {
@@ -35,13 +33,14 @@ final class Auth extends UserManager {
/** /**
* @param PdoDatabase|PdoDsn|\PDO $databaseConnection the database connection to operate on * @param PdoDatabase|PdoDsn|\PDO $databaseConnection the database connection to operate on
* @param string $ipAddress the IP address that should be used instead of the default setting (if any), e.g. when behind a proxy * @param string|null $ipAddress (optional) the IP address that should be used instead of the default setting (if any), e.g. when behind a proxy
* @param string|null $dbTablePrefix (optional) the prefix for the names of all database tables used by this component * @param string|null $dbTablePrefix (optional) the prefix for the names of all database tables used by this component
* @param bool|null $throttling (optional) whether throttling should be enabled (e.g. in production) or disabled (e.g. during development) * @param bool|null $throttling (optional) whether throttling should be enabled (e.g. in production) or disabled (e.g. during development)
* @param int|null $sessionResyncInterval (optional) the interval in seconds after which to resynchronize the session data with its authoritative source in the database * @param int|null $sessionResyncInterval (optional) the interval in seconds after which to resynchronize the session data with its authoritative source in the database
* @param string|null $dbSchema (optional) the schema name for all database tables used by this component
*/ */
public function __construct($databaseConnection, $ipAddress = null, $dbTablePrefix = null, $throttling = null, $sessionResyncInterval = null) { public function __construct($databaseConnection, $ipAddress = null, $dbTablePrefix = null, $throttling = null, $sessionResyncInterval = null, $dbSchema = null) {
parent::__construct($databaseConnection, $dbTablePrefix); parent::__construct($databaseConnection, $dbTablePrefix, $dbSchema);
$this->ipAddress = !empty($ipAddress) ? $ipAddress : (isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null); $this->ipAddress = !empty($ipAddress) ? $ipAddress : (isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null);
$this->throttling = isset($throttling) ? (bool) $throttling : true; $this->throttling = isset($throttling) ? (bool) $throttling : true;
@@ -114,12 +113,12 @@ final class Auth extends UserManager {
if (!empty($parts[0]) && !empty($parts[1])) { if (!empty($parts[0]) && !empty($parts[1])) {
try { try {
$rememberData = $this->db->selectRow( $rememberData = $this->db->selectRow(
'SELECT a.user, a.token, a.expires, b.email, b.username, b.status, b.roles_mask, b.force_logout FROM ' . $this->dbTablePrefix . 'users_remembered AS a JOIN ' . $this->dbTablePrefix . 'users AS b ON a.user = b.id WHERE a.selector = ?', 'SELECT a.user, a.token, a.expires, b.email, b.username, b.status, b.roles_mask, b.force_logout FROM ' . $this->makeTableName('users_remembered') . ' AS a JOIN ' . $this->makeTableName('users') . ' AS b ON a.user = b.id WHERE a.selector = ?',
[ $parts[0] ] [ $parts[0] ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (!empty($rememberData)) { if (!empty($rememberData)) {
@@ -156,12 +155,12 @@ final class Auth extends UserManager {
// fetch the authoritative data from the database again // fetch the authoritative data from the database again
try { try {
$authoritativeData = $this->db->selectRow( $authoritativeData = $this->db->selectRow(
'SELECT email, username, status, roles_mask, force_logout FROM ' . $this->dbTablePrefix . 'users WHERE id = ?', 'SELECT email, username, status, roles_mask, force_logout FROM ' . $this->makeTableName('users') . ' WHERE id = ?',
[ $this->getUserId() ] [ $this->getUserId() ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
// if the user's data has been found // if the user's data has been found
@@ -353,12 +352,12 @@ final class Auth extends UserManager {
try { try {
$expectedHash = $this->db->selectValue( $expectedHash = $this->db->selectValue(
'SELECT password FROM ' . $this->dbTablePrefix . 'users WHERE id = ?', 'SELECT password FROM ' . $this->makeTableName('users') . ' WHERE id = ?',
[ $this->getUserId() ] [ $this->getUserId() ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (!empty($expectedHash)) { if (!empty($expectedHash)) {
@@ -496,7 +495,7 @@ final class Auth extends UserManager {
try { try {
$this->db->insert( $this->db->insert(
$this->dbTablePrefix . 'users_remembered', $this->makeTableNameComponents('users_remembered'),
[ [
'user' => $userId, 'user' => $userId,
'selector' => $selector, 'selector' => $selector,
@@ -506,7 +505,7 @@ final class Auth extends UserManager {
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
$this->setRememberCookie($selector, $token, $expires); $this->setRememberCookie($selector, $token, $expires);
@@ -566,13 +565,13 @@ final class Auth extends UserManager {
// update the timestamp of the user's last login // update the timestamp of the user's last login
try { try {
$this->db->update( $this->db->update(
$this->dbTablePrefix . 'users', $this->makeTableNameComponents('users'),
[ 'last_login' => \time() ], [ 'last_login' => \time() ],
[ 'id' => $userId ] [ 'id' => $userId ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
parent::onLoginSuccessful($userId, $email, $username, $status, $roles, $forceLogout, $remembered); parent::onLoginSuccessful($userId, $email, $username, $status, $roles, $forceLogout, $remembered);
@@ -620,12 +619,12 @@ final class Auth extends UserManager {
try { try {
$confirmationData = $this->db->selectRow( $confirmationData = $this->db->selectRow(
'SELECT a.id, a.user_id, a.email AS new_email, a.token, a.expires, b.email AS old_email FROM ' . $this->dbTablePrefix . 'users_confirmations AS a JOIN ' . $this->dbTablePrefix . 'users AS b ON b.id = a.user_id WHERE a.selector = ?', 'SELECT a.id, a.user_id, a.email AS new_email, a.token, a.expires, b.email AS old_email FROM ' . $this->makeTableName('users_confirmations') . ' AS a JOIN ' . $this->makeTableName('users') . ' AS b ON b.id = a.user_id WHERE a.selector = ?',
[ $selector ] [ $selector ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (!empty($confirmationData)) { if (!empty($confirmationData)) {
@@ -634,18 +633,18 @@ final class Auth extends UserManager {
// invalidate any potential outstanding password reset requests // invalidate any potential outstanding password reset requests
try { try {
$this->db->delete( $this->db->delete(
$this->dbTablePrefix . 'users_resets', $this->makeTableNameComponents('users_resets'),
[ 'user' => $confirmationData['user_id'] ] [ 'user' => $confirmationData['user_id'] ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
// mark the email address as verified (and possibly update it to the new address given) // mark the email address as verified (and possibly update it to the new address given)
try { try {
$this->db->update( $this->db->update(
$this->dbTablePrefix . 'users', $this->makeTableNameComponents('users'),
[ [
'email' => $confirmationData['new_email'], 'email' => $confirmationData['new_email'],
'verified' => 1 'verified' => 1
@@ -657,7 +656,7 @@ final class Auth extends UserManager {
throw new UserAlreadyExistsException(); throw new UserAlreadyExistsException();
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
// if the user is currently signed in // if the user is currently signed in
@@ -672,12 +671,12 @@ final class Auth extends UserManager {
// consume the token just being used for confirmation // consume the token just being used for confirmation
try { try {
$this->db->delete( $this->db->delete(
$this->dbTablePrefix . 'users_confirmations', $this->makeTableNameComponents('users_confirmations'),
[ 'id' => $confirmationData['id'] ] [ 'id' => $confirmationData['id'] ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
// if the email address has not been changed but simply been verified // if the email address has not been changed but simply been verified
@@ -817,12 +816,12 @@ final class Auth extends UserManager {
try { try {
$existingUsersWithNewEmail = $this->db->selectValue( $existingUsersWithNewEmail = $this->db->selectValue(
'SELECT COUNT(*) FROM ' . $this->dbTablePrefix . 'users WHERE email = ?', 'SELECT COUNT(*) FROM ' . $this->makeTableName('users') . ' WHERE email = ?',
[ $newEmail ] [ $newEmail ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if ((int) $existingUsersWithNewEmail !== 0) { if ((int) $existingUsersWithNewEmail !== 0) {
@@ -831,12 +830,12 @@ final class Auth extends UserManager {
try { try {
$verified = $this->db->selectValue( $verified = $this->db->selectValue(
'SELECT verified FROM ' . $this->dbTablePrefix . 'users WHERE id = ?', 'SELECT verified FROM ' . $this->makeTableName('users') . ' WHERE id = ?',
[ $this->getUserId() ] [ $this->getUserId() ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
// ensure that at least the current (old) email address has been verified before proceeding // ensure that at least the current (old) email address has been verified before proceeding
@@ -919,12 +918,12 @@ final class Auth extends UserManager {
private function resendConfirmationForColumnValue($columnName, $columnValue, callable $callback) { private function resendConfirmationForColumnValue($columnName, $columnValue, callable $callback) {
try { try {
$latestAttempt = $this->db->selectRow( $latestAttempt = $this->db->selectRow(
'SELECT user_id, email FROM ' . $this->dbTablePrefix . 'users_confirmations WHERE ' . $columnName . ' = ? ORDER BY id DESC LIMIT 1 OFFSET 0', 'SELECT user_id, email FROM ' . $this->makeTableName('users_confirmations') . ' WHERE ' . $columnName . ' = ? ORDER BY id DESC LIMIT 1 OFFSET 0',
[ $columnValue ] [ $columnValue ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if ($latestAttempt === null) { if ($latestAttempt === null) {
@@ -961,6 +960,11 @@ final class Auth extends UserManager {
* @throws ResetDisabledException if the user has explicitly disabled password resets for their account * @throws ResetDisabledException if the user has explicitly disabled password resets for their account
* @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded
* @throws AuthError if an internal problem occurred (do *not* catch) * @throws AuthError if an internal problem occurred (do *not* catch)
*
* @see canResetPasswordOrThrow
* @see canResetPassword
* @see resetPassword
* @see resetPasswordAndSignIn
*/ */
public function forgotPassword($email, callable $callback, $requestExpiresAfter = null, $maxOpenRequests = null) { public function forgotPassword($email, callable $callback, $requestExpiresAfter = null, $maxOpenRequests = null) {
$email = self::validateEmailAddress($email); $email = self::validateEmailAddress($email);
@@ -998,7 +1002,7 @@ final class Auth extends UserManager {
throw new ResetDisabledException(); throw new ResetDisabledException();
} }
$openRequests = (int) $this->getOpenPasswordResetRequests($userData['id']); $openRequests = $this->throttling ? (int) $this->getOpenPasswordResetRequests($userData['id']) : 0;
if ($openRequests < $maxOpenRequests) { if ($openRequests < $maxOpenRequests) {
$this->throttle([ 'requestPasswordReset', $this->getIpAddress() ], 4, (60 * 60 * 24 * 7), 2); $this->throttle([ 'requestPasswordReset', $this->getIpAddress() ], 4, (60 * 60 * 24 * 7), 2);
@@ -1132,12 +1136,12 @@ final class Auth extends UserManager {
try { try {
$projection = \implode(', ', $requestedColumns); $projection = \implode(', ', $requestedColumns);
$userData = $this->db->selectRow( $userData = $this->db->selectRow(
'SELECT ' . $projection . ' FROM ' . $this->dbTablePrefix . 'users WHERE email = ?', 'SELECT ' . $projection . ' FROM ' . $this->makeTableName('users') . ' WHERE email = ?',
[ $email ] [ $email ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (!empty($userData)) { if (!empty($userData)) {
@@ -1158,7 +1162,7 @@ final class Auth extends UserManager {
private function getOpenPasswordResetRequests($userId) { private function getOpenPasswordResetRequests($userId) {
try { try {
$requests = $this->db->selectValue( $requests = $this->db->selectValue(
'SELECT COUNT(*) FROM ' . $this->dbTablePrefix . 'users_resets WHERE user = ? AND expires > ?', 'SELECT COUNT(*) FROM ' . $this->makeTableName('users_resets') . ' WHERE user = ? AND expires > ?',
[ [
$userId, $userId,
\time() \time()
@@ -1173,7 +1177,7 @@ final class Auth extends UserManager {
} }
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
@@ -1201,7 +1205,7 @@ final class Auth extends UserManager {
try { try {
$this->db->insert( $this->db->insert(
$this->dbTablePrefix . 'users_resets', $this->makeTableNameComponents('users_resets'),
[ [
'user' => $userId, 'user' => $userId,
'selector' => $selector, 'selector' => $selector,
@@ -1211,7 +1215,7 @@ final class Auth extends UserManager {
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (\is_callable($callback)) { if (\is_callable($callback)) {
@@ -1225,17 +1229,23 @@ final class Auth extends UserManager {
/** /**
* Resets the password for a particular account by supplying the correct selector/token pair * Resets the password for a particular account by supplying the correct selector/token pair
* *
* The selector/token pair must have been generated previously by calling `Auth#forgotPassword(...)` * The selector/token pair must have been generated previously by calling {@see forgotPassword}
* *
* @param string $selector the selector from the selector/token pair * @param string $selector the selector from the selector/token pair
* @param string $token the token from the selector/token pair * @param string $token the token from the selector/token pair
* @param string $newPassword the new password to set for the account * @param string $newPassword the new password to set for the account
* @return string[] an array with the user's ID at index `id` and the user's email address at index `email`
* @throws InvalidSelectorTokenPairException if either the selector or the token was not correct * @throws InvalidSelectorTokenPairException if either the selector or the token was not correct
* @throws TokenExpiredException if the token has already expired * @throws TokenExpiredException if the token has already expired
* @throws ResetDisabledException if the user has explicitly disabled password resets for their account * @throws ResetDisabledException if the user has explicitly disabled password resets for their account
* @throws InvalidPasswordException if the new password was invalid * @throws InvalidPasswordException if the new password was invalid
* @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded
* @throws AuthError if an internal problem occurred (do *not* catch) * @throws AuthError if an internal problem occurred (do *not* catch)
*
* @see forgotPassword
* @see canResetPasswordOrThrow
* @see canResetPassword
* @see resetPasswordAndSignIn
*/ */
public function resetPassword($selector, $token, $newPassword) { public function resetPassword($selector, $token, $newPassword) {
$this->throttle([ 'resetPassword', $this->getIpAddress() ], 5, (60 * 60), 10); $this->throttle([ 'resetPassword', $this->getIpAddress() ], 5, (60 * 60), 10);
@@ -1244,12 +1254,12 @@ final class Auth extends UserManager {
try { try {
$resetData = $this->db->selectRow( $resetData = $this->db->selectRow(
'SELECT a.id, a.user, a.token, a.expires, b.resettable FROM ' . $this->dbTablePrefix . 'users_resets AS a JOIN ' . $this->dbTablePrefix . 'users AS b ON b.id = a.user WHERE a.selector = ?', 'SELECT a.id, a.user, a.token, a.expires, b.email, b.resettable FROM ' . $this->makeTableName('users_resets') . ' AS a JOIN ' . $this->makeTableName('users') . ' AS b ON b.id = a.user WHERE a.selector = ?',
[ $selector ] [ $selector ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (!empty($resetData)) { if (!empty($resetData)) {
@@ -1262,13 +1272,18 @@ final class Auth extends UserManager {
try { try {
$this->db->delete( $this->db->delete(
$this->dbTablePrefix . 'users_resets', $this->makeTableNameComponents('users_resets'),
[ 'id' => $resetData['id'] ] [ 'id' => $resetData['id'] ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
return [
'id' => $resetData['user'],
'email' => $resetData['email']
];
} }
else { else {
throw new TokenExpiredException(); throw new TokenExpiredException();
@@ -1287,12 +1302,57 @@ final class Auth extends UserManager {
} }
} }
/**
* Resets the password for a particular account by supplying the correct selector/token pair
*
* The selector/token pair must have been generated previously by calling {@see forgotPassword}
*
* The user will be automatically signed in if this operation is successful
*
* @param string $selector the selector from the selector/token pair
* @param string $token the token from the selector/token pair
* @param string $newPassword the new password to set for the account
* @param int|null $rememberDuration (optional) the duration in seconds to keep the user logged in ("remember me"), e.g. `60 * 60 * 24 * 365.25` for one year
* @return string[] an array with the user's ID at index `id` and the user's email address at index `email`
* @throws InvalidSelectorTokenPairException if either the selector or the token was not correct
* @throws TokenExpiredException if the token has already expired
* @throws ResetDisabledException if the user has explicitly disabled password resets for their account
* @throws InvalidPasswordException if the new password was invalid
* @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded
* @throws AuthError if an internal problem occurred (do *not* catch)
*
* @see forgotPassword
* @see canResetPasswordOrThrow
* @see canResetPassword
* @see resetPassword
*/
public function resetPasswordAndSignIn($selector, $token, $newPassword, $rememberDuration = null) {
$idAndEmail = $this->resetPassword($selector, $token, $newPassword);
if (!$this->isLoggedIn()) {
$idAndEmail['email'] = self::validateEmailAddress($idAndEmail['email']);
$userData = $this->getUserDataByEmailAddress(
$idAndEmail['email'],
[ 'username', 'status', 'roles_mask', 'force_logout' ]
);
$this->onLoginSuccessful($idAndEmail['id'], $idAndEmail['email'], $userData['username'], $userData['status'], $userData['roles_mask'], $userData['force_logout'], true);
if ($rememberDuration !== null) {
$this->createRememberDirective($idAndEmail['id'], $rememberDuration);
}
}
return $idAndEmail;
}
/** /**
* Check if the supplied selector/token pair can be used to reset a password * Check if the supplied selector/token pair can be used to reset a password
* *
* The password can be reset using the supplied information if this method does *not* throw any exception * The password can be reset using the supplied information if this method does *not* throw any exception
* *
* The selector/token pair must have been generated previously by calling `Auth#forgotPassword(...)` * The selector/token pair must have been generated previously by calling {@see forgotPassword}
* *
* @param string $selector the selector from the selector/token pair * @param string $selector the selector from the selector/token pair
* @param string $token the token from the selector/token pair * @param string $token the token from the selector/token pair
@@ -1301,6 +1361,11 @@ final class Auth extends UserManager {
* @throws ResetDisabledException if the user has explicitly disabled password resets for their account * @throws ResetDisabledException if the user has explicitly disabled password resets for their account
* @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded
* @throws AuthError if an internal problem occurred (do *not* catch) * @throws AuthError if an internal problem occurred (do *not* catch)
*
* @see forgotPassword
* @see canResetPassword
* @see resetPassword
* @see resetPasswordAndSignIn
*/ */
public function canResetPasswordOrThrow($selector, $token) { public function canResetPasswordOrThrow($selector, $token) {
try { try {
@@ -1324,12 +1389,17 @@ final class Auth extends UserManager {
/** /**
* Check if the supplied selector/token pair can be used to reset a password * Check if the supplied selector/token pair can be used to reset a password
* *
* The selector/token pair must have been generated previously by calling `Auth#forgotPassword(...)` * The selector/token pair must have been generated previously by calling {@see forgotPassword}
* *
* @param string $selector the selector from the selector/token pair * @param string $selector the selector from the selector/token pair
* @param string $token the token from the selector/token pair * @param string $token the token from the selector/token pair
* @return bool whether the password can be reset using the supplied information * @return bool whether the password can be reset using the supplied information
* @throws AuthError if an internal problem occurred (do *not* catch) * @throws AuthError if an internal problem occurred (do *not* catch)
*
* @see forgotPassword
* @see canResetPasswordOrThrow
* @see resetPassword
* @see resetPasswordAndSignIn
*/ */
public function canResetPassword($selector, $token) { public function canResetPassword($selector, $token) {
try { try {
@@ -1355,7 +1425,7 @@ final class Auth extends UserManager {
if ($this->isLoggedIn()) { if ($this->isLoggedIn()) {
try { try {
$this->db->update( $this->db->update(
$this->dbTablePrefix . 'users', $this->makeTableNameComponents('users'),
[ [
'resettable' => $enabled ? 1 : 0 'resettable' => $enabled ? 1 : 0
], ],
@@ -1365,7 +1435,7 @@ final class Auth extends UserManager {
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
else { else {
@@ -1384,14 +1454,14 @@ final class Auth extends UserManager {
if ($this->isLoggedIn()) { if ($this->isLoggedIn()) {
try { try {
$enabled = $this->db->selectValue( $enabled = $this->db->selectValue(
'SELECT resettable FROM ' . $this->dbTablePrefix . 'users WHERE id = ?', 'SELECT resettable FROM ' . $this->makeTableName('users') . ' WHERE id = ?',
[ $this->getUserId() ] [ $this->getUserId() ]
); );
return (int) $enabled === 1; return (int) $enabled === 1;
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
else { else {
@@ -1432,7 +1502,7 @@ final class Auth extends UserManager {
} }
/** /**
* Shorthand/alias for `getUserId()` * Shorthand/alias for {@see getUserId}
* *
* @return int * @return int
*/ */
@@ -1563,9 +1633,13 @@ final class Auth extends UserManager {
* @see Role * @see Role
*/ */
public function hasRole($role) { public function hasRole($role) {
$role = (int) $role; if (empty($role) || !\is_numeric($role)) {
return false;
}
if (isset($_SESSION) && isset($_SESSION[self::SESSION_FIELD_ROLES])) { if (isset($_SESSION) && isset($_SESSION[self::SESSION_FIELD_ROLES])) {
$role = (int) $role;
return (((int) $_SESSION[self::SESSION_FIELD_ROLES]) & $role) === $role; return (((int) $_SESSION[self::SESSION_FIELD_ROLES]) & $role) === $role;
} }
else { else {
@@ -1687,12 +1761,12 @@ final class Auth extends UserManager {
try { try {
$bucket = $this->db->selectRow( $bucket = $this->db->selectRow(
'SELECT tokens, replenished_at FROM ' . $this->dbTablePrefix . 'users_throttling WHERE bucket = ?', 'SELECT tokens, replenished_at FROM ' . $this->makeTableName('users_throttling') . ' WHERE bucket = ?',
[ $key ] [ $key ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if ($bucket === null) { if ($bucket === null) {
@@ -1724,13 +1798,13 @@ final class Auth extends UserManager {
// merge the updated bucket into the database // merge the updated bucket into the database
try { try {
$affected = $this->db->update( $affected = $this->db->update(
$this->dbTablePrefix . 'users_throttling', $this->makeTableNameComponents('users_throttling'),
$bucket, $bucket,
[ 'bucket' => $key ] [ 'bucket' => $key ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if ($affected === 0) { if ($affected === 0) {
@@ -1738,13 +1812,13 @@ final class Auth extends UserManager {
try { try {
$this->db->insert( $this->db->insert(
$this->dbTablePrefix . 'users_throttling', $this->makeTableNameComponents('users_throttling'),
$bucket $bucket
); );
} }
catch (IntegrityConstraintViolationException $ignored) {} catch (IntegrityConstraintViolationException $ignored) {}
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
} }
@@ -1768,7 +1842,7 @@ final class Auth extends UserManager {
* @return Administration * @return Administration
*/ */
public function admin() { public function admin() {
return new Administration($this->db, $this->dbTablePrefix); return new Administration($this->db, $this->dbTablePrefix, $this->dbSchema);
} }
/** /**
@@ -1864,7 +1938,7 @@ final class Auth extends UserManager {
if (isset($existingSelector)) { if (isset($existingSelector)) {
// fetch the expiry date for the given selector // fetch the expiry date for the given selector
$existingExpiry = $this->db->selectValue( $existingExpiry = $this->db->selectValue(
'SELECT expires FROM ' . $this->dbTablePrefix . 'users_remembered WHERE selector = ? AND user = ?', 'SELECT expires FROM ' . $this->makeTableName('users_remembered') . ' WHERE selector = ? AND user = ?',
[ [
$existingSelector, $existingSelector,
$this->getUserId() $this->getUserId()

12
src/AuthError.php Normal file
View File

@@ -0,0 +1,12 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
/** Base class for all (unchecked) errors */
class AuthError extends \Exception {}

12
src/AuthException.php Normal file
View File

@@ -0,0 +1,12 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
/** Base class for all (checked) exceptions */
class AuthException extends \Exception {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class ConfirmationRequestNotFound extends AuthException {}

11
src/DatabaseError.php Normal file
View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class DatabaseError extends AuthError {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class DuplicateUsernameException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class EmailNotVerifiedException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class EmailOrUsernameRequiredError extends AuthError {}

View File

@@ -1,53 +0,0 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class AuthException extends \Exception {}
class UnknownIdException extends AuthException {}
class InvalidEmailException extends AuthException {}
class UnknownUsernameException extends AuthException {}
class InvalidPasswordException extends AuthException {}
class EmailNotVerifiedException extends AuthException {}
class UserAlreadyExistsException extends AuthException {}
class NotLoggedInException extends AuthException {}
class InvalidSelectorTokenPairException extends AuthException {}
class TokenExpiredException extends AuthException {}
class TooManyRequestsException extends AuthException {}
class DuplicateUsernameException extends AuthException {}
class AmbiguousUsernameException extends AuthException {}
class AttemptCancelledException extends AuthException {}
class ResetDisabledException extends AuthException {}
class ConfirmationRequestNotFound extends AuthException {}
class AuthError extends \Exception {}
class DatabaseError extends AuthError {}
class DatabaseDriverError extends DatabaseError {}
class MissingCallbackError extends AuthError {}
class HeadersAlreadySentError extends AuthError {}
class EmailOrUsernameRequiredError extends AuthError {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class HeadersAlreadySentError extends AuthError {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class InvalidEmailException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class InvalidPasswordException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class InvalidSelectorTokenPairException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class MissingCallbackError extends AuthError {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class NotLoggedInException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class ResetDisabledException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class TokenExpiredException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class TooManyRequestsException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class UnknownIdException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class UnknownUsernameException extends AuthException {}

View File

@@ -0,0 +1,11 @@
<?php
/*
* PHP-Auth (https://github.com/delight-im/PHP-Auth)
* Copyright (c) delight.im (https://www.delight.im/)
* Licensed under the MIT License (https://opensource.org/licenses/MIT)
*/
namespace Delight\Auth;
class UserAlreadyExistsException extends AuthException {}

View File

@@ -15,8 +15,6 @@ use Delight\Db\PdoDsn;
use Delight\Db\Throwable\Error; use Delight\Db\Throwable\Error;
use Delight\Db\Throwable\IntegrityConstraintViolationException; use Delight\Db\Throwable\IntegrityConstraintViolationException;
require_once __DIR__ . '/Exceptions.php';
/** /**
* Abstract base class for components implementing user management * Abstract base class for components implementing user management
* *
@@ -45,6 +43,8 @@ abstract class UserManager {
/** @var PdoDatabase the database connection to operate on */ /** @var PdoDatabase the database connection to operate on */
protected $db; protected $db;
/** @var string|null the schema name for all database tables used by this component */
protected $dbSchema;
/** @var string the prefix for the names of all database tables used by this component */ /** @var string the prefix for the names of all database tables used by this component */
protected $dbTablePrefix; protected $dbTablePrefix;
@@ -70,8 +70,9 @@ abstract class UserManager {
/** /**
* @param PdoDatabase|PdoDsn|\PDO $databaseConnection the database connection to operate on * @param PdoDatabase|PdoDsn|\PDO $databaseConnection the database connection to operate on
* @param string|null $dbTablePrefix (optional) the prefix for the names of all database tables used by this component * @param string|null $dbTablePrefix (optional) the prefix for the names of all database tables used by this component
* @param string|null $dbSchema (optional) the schema name for all database tables used by this component
*/ */
protected function __construct($databaseConnection, $dbTablePrefix = null) { protected function __construct($databaseConnection, $dbTablePrefix = null, $dbSchema = null) {
if ($databaseConnection instanceof PdoDatabase) { if ($databaseConnection instanceof PdoDatabase) {
$this->db = $databaseConnection; $this->db = $databaseConnection;
} }
@@ -87,6 +88,7 @@ abstract class UserManager {
throw new \InvalidArgumentException('The database connection must be an instance of either `PdoDatabase`, `PdoDsn` or `PDO`'); throw new \InvalidArgumentException('The database connection must be an instance of either `PdoDatabase`, `PdoDsn` or `PDO`');
} }
$this->dbSchema = $dbSchema !== null ? (string) $dbSchema : null;
$this->dbTablePrefix = (string) $dbTablePrefix; $this->dbTablePrefix = (string) $dbTablePrefix;
} }
@@ -140,7 +142,7 @@ abstract class UserManager {
if ($username !== null) { if ($username !== null) {
// count the number of users who do already have that specified username // count the number of users who do already have that specified username
$occurrencesOfUsername = $this->db->selectValue( $occurrencesOfUsername = $this->db->selectValue(
'SELECT COUNT(*) FROM ' . $this->dbTablePrefix . 'users WHERE username = ?', 'SELECT COUNT(*) FROM ' . $this->makeTableName('users') . ' WHERE username = ?',
[ $username ] [ $username ]
); );
@@ -157,7 +159,7 @@ abstract class UserManager {
try { try {
$this->db->insert( $this->db->insert(
$this->dbTablePrefix . 'users', $this->makeTableNameComponents('users'),
[ [
'email' => $email, 'email' => $email,
'password' => $password, 'password' => $password,
@@ -172,7 +174,7 @@ abstract class UserManager {
throw new UserAlreadyExistsException(); throw new UserAlreadyExistsException();
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
$newUserId = (int) $this->db->getLastInsertId(); $newUserId = (int) $this->db->getLastInsertId();
@@ -197,7 +199,7 @@ abstract class UserManager {
try { try {
$affected = $this->db->update( $affected = $this->db->update(
$this->dbTablePrefix . 'users', $this->makeTableNameComponents('users'),
[ 'password' => $newPassword ], [ 'password' => $newPassword ],
[ 'id' => $userId ] [ 'id' => $userId ]
); );
@@ -207,7 +209,7 @@ abstract class UserManager {
} }
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
@@ -258,12 +260,12 @@ abstract class UserManager {
$projection = \implode(', ', $requestedColumns); $projection = \implode(', ', $requestedColumns);
$users = $this->db->select( $users = $this->db->select(
'SELECT ' . $projection . ' FROM ' . $this->dbTablePrefix . 'users WHERE username = ? LIMIT 2 OFFSET 0', 'SELECT ' . $projection . ' FROM ' . $this->makeTableName('users') . ' WHERE username = ? LIMIT 2 OFFSET 0',
[ $username ] [ $username ]
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (empty($users)) { if (empty($users)) {
@@ -345,7 +347,7 @@ abstract class UserManager {
try { try {
$this->db->insert( $this->db->insert(
$this->dbTablePrefix . 'users_confirmations', $this->makeTableNameComponents('users_confirmations'),
[ [
'user_id' => (int) $userId, 'user_id' => (int) $userId,
'email' => $email, 'email' => $email,
@@ -356,7 +358,7 @@ abstract class UserManager {
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
if (\is_callable($callback)) { if (\is_callable($callback)) {
@@ -385,12 +387,12 @@ abstract class UserManager {
try { try {
$this->db->delete( $this->db->delete(
$this->dbTablePrefix . 'users_remembered', $this->makeTableNameComponents('users_remembered'),
$whereMappings $whereMappings
); );
} }
catch (Error $e) { catch (Error $e) {
throw new DatabaseError(); throw new DatabaseError($e->getMessage());
} }
} }
@@ -403,9 +405,50 @@ abstract class UserManager {
protected function forceLogoutForUserById($userId) { protected function forceLogoutForUserById($userId) {
$this->deleteRememberDirectiveForUserById($userId); $this->deleteRememberDirectiveForUserById($userId);
$this->db->exec( $this->db->exec(
'UPDATE ' . $this->dbTablePrefix . 'users SET force_logout = force_logout + 1 WHERE id = ?', 'UPDATE ' . $this->makeTableName('users') . ' SET force_logout = force_logout + 1 WHERE id = ?',
[ $userId ] [ $userId ]
); );
} }
/**
* Builds a (qualified) full table name from an optional qualifier, an optional prefix, and the table name itself
*
* The optional qualifier may be a database name or a schema name, for example
*
* @param string $name the name of the table
* @return string[] the components of the (qualified) full name of the table
*/
protected function makeTableNameComponents($name) {
$components = [];
if (!empty($this->dbSchema)) {
$components[] = $this->dbSchema;
}
if (!empty($name)) {
if (!empty($this->dbTablePrefix)) {
$components[] = $this->dbTablePrefix . $name;
}
else {
$components[] = $name;
}
}
return $components;
}
/**
* Builds a (qualified) full table name from an optional qualifier, an optional prefix, and the table name itself
*
* The optional qualifier may be a database name or a schema name, for example
*
* @param string $name the name of the table
* @return string the (qualified) full name of the table
*/
protected function makeTableName($name) {
$components = $this->makeTableNameComponents($name);
return \implode('.', $components);
}
} }

View File

@@ -254,9 +254,21 @@ function processRequestData(\Delight\Auth\Auth $auth) {
} }
else if ($_POST['action'] === 'resetPassword') { else if ($_POST['action'] === 'resetPassword') {
try { try {
$auth->resetPassword($_POST['selector'], $_POST['token'], $_POST['password']); if (isset($_POST['login']) && $_POST['login'] > 0) {
if ($_POST['login'] == 2) {
// keep logged in for one year
$rememberDuration = (int) (60 * 60 * 24 * 365.25);
}
else {
// do not keep logged in after session ends
$rememberDuration = null;
}
return 'ok'; return $auth->resetPasswordAndSignIn($_POST['selector'], $_POST['token'], $_POST['password'], $rememberDuration);
}
else {
return $auth->resetPassword($_POST['selector'], $_POST['token'], $_POST['password']);
}
} }
catch (\Delight\Auth\InvalidSelectorTokenPairException $e) { catch (\Delight\Auth\InvalidSelectorTokenPairException $e) {
return 'invalid token'; return 'invalid token';
@@ -893,6 +905,11 @@ function showGuestUserForm() {
echo '<input type="text" name="selector" placeholder="Selector" /> '; echo '<input type="text" name="selector" placeholder="Selector" /> ';
echo '<input type="text" name="token" placeholder="Token" /> '; echo '<input type="text" name="token" placeholder="Token" /> ';
echo '<input type="text" name="password" placeholder="New password" /> '; echo '<input type="text" name="password" placeholder="New password" /> ';
echo '<select name="login" size="1">';
echo '<option value="0">Sign in automatically? — No</option>';
echo '<option value="1">Sign in automatically? — Yes</option>';
echo '<option value="2">Sign in automatically? — Yes (and remember)</option>';
echo '</select> ';
echo '<button type="submit">Reset password</button>'; echo '<button type="submit">Reset password</button>';
echo '</form>'; echo '</form>';