This is a simple package to generate and validate OTPs (One Time Passwords). This can be implemented mostly in Authentication.
Install via composer
composer require ichtrojan/laravel-otpRun Migrations
php artisan migrateNOTE
Response are returned as objects. You can access its attributes with the arrow operator (->)
<?php
use Ichtrojan\Otp\Otp;
(new Otp)->generate(string $identifier, string $type, int $length = 4, int $validity = 10);$identifier: The identity that will be tied to the OTP.$type: The type of token to be generated, supported types arenumericandalpha_numeric$length (optional | default = 4): The length of token to be generated.$validity (optional | default = 10): The validity period of the OTP in minutes.
<?php
use Ichtrojan\Otp\Otp;
(new Otp)->generate('[email protected]', 'numeric', 6, 15);This will generate a six digit OTP that will be valid for 15 minutes and the success response will be:
{
"status": true,
"token": "282581",
"message": "OTP generated"
}
<?php
use Ichtrojan\Otp\Otp;
(new Otp)->validate(string $identifier, string $token)$identifier: The identity that is tied to the OTP.$token: The token tied to the identity.
<?php
use Ichtrojan\Otp\Otp;
(new Otp)->validate('[email protected]', '282581');On Success
{
"status": true,
"message": "OTP is valid"
}
Does not exist
{
"status": false,
"message": "OTP does not exist"
}
Not Valid*
{
"status": false,
"message": "OTP is not valid"
}
Expired
{
"status": false,
"message": "OTP Expired"
}
You can delete expired tokens by running the following artisan command:
php artisan otp:cleanYou can also add this artisan command to app/Console/Kernel.php to automatically clean on scheduled
<?php
protected function schedule(Schedule $schedule)
{
$schedule->command('otp:clean')->daily();
}If you find an issue with this package or you have any suggestion please help out. I am not perfect.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent