https://github.com/mawuva/laravel-password-history
Allows you to store users password history.
https://github.com/mawuva/laravel-password-history
Last synced: 3 months ago
JSON representation
Allows you to store users password history.
- Host: GitHub
- URL: https://github.com/mawuva/laravel-password-history
- Owner: mawuva
- License: mit
- Created: 2021-08-12T09:47:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T11:19:23.000Z (about 2 years ago)
- Last Synced: 2024-12-30T09:14:06.947Z (4 months ago)
- Language: PHP
- Homepage: https://packagist.org/packages/mawuekom/laravel-password-history
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Password History
This package allows to store users password history and check if the user can use the same for updating or not.
Then, you can tell your users when they will be going to create a new password for their accounts
if they can use an already used password or not.
## Installation
You can install the package via composer:
```bash
composer require mawuekom/laravel-password-history
```
## Usage
Once install, go to `config/app.php` to add `PasswordHistoryServiceProvider` in providers array
Laravel 5.5 and up Uses package auto discovery feature, no need to edit the `config/app.php` file.
- #### Service Provider
```php
'providers' => [
...
Mawuekom\PasswordHistory\PasswordHistoryServiceProvider::class,
],
```
- #### Publish Assets
```bash
php artisan vendor:publish --tag=password-history
```
Or you can publish config
```bash
php artisan vendor:publish --tag=password-history --config
```
#### Configuration
* You can change connection for models, models path and there is also a handy pretend feature.
* There are many configurable options which have been extended to be able to configured via `.env` file variables.
* Editing the configuration file directly may not needed because of this.
* See config file: [password-history.php](https://github.com/mawuva/laravel-password-history/blob/main/config/password-history.php).
```php
true,
'model' => Mawuekom\PasswordHistory\Models\PasswordHistory::class,
'checker' => false,
'number_to_check' => 3,
'name' => 'Password History',
'resource_name' => 'password_history',
'table' => [
'name' => env('PASSWORD_HISTORY_PASSWORD_HISTORIES_DATABASE_TABLE', 'password_histories'),
'primary_key' => env('PASSWORD_HISTORY_PASSWORD_HISTORIES_DATABASE_TABLE_PRIMARY_KEY', 'id'),
'user_foreign_key' => env('PASSWORD_HISTORY_PASSWORD_HISTORIES_DATABASE_TABLE_USER_FOREIGN_KEY', 'user_id'),
],
/**
* Users config
*/
'user' => [
'model' => App\Models\User::class,
'name' => 'User',
'resource_name' => 'user',
'table' => [
'name' => env('PASSWORD_HISTORY_USERS_DATABASE_TABLE', 'users'),
'primary_key' => env('PASSWORD_HISTORY_USERS_DATABASE_TABLE_PRIMARY_KEY', 'id'),
],
],
/*
|--------------------------------------------------------------------------
| Add uuid support
|--------------------------------------------------------------------------
*/
'uuids' => [
'enable' => true,
'column' => '_id'
],
];
```
- #### HasPasswordHistory Trait and Contract
To allow your users to use password histries, add `HasPasswordHistory` trait in your User Model.
```php
'Toto',
'email' => '[email protected]',
'password' => 'toto1234',
]);
$user ->updatePasswordHistory();
```
- #### When user wants to change his password
```php
$user = User::find(1);
PasswordHistoryChecker::validatePassword($user, $new_password);
```
### Testing
```bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Report bug
Contact me on Twitter [@ephraimseddor](https://twitter.com/ephraimseddor)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.