ichtrojan / laravel-otp
A simple package to generate and validate OTPs
Installs: 181 664
Dependents: 4
Suggesters: 1
Security: 0
Stars: 236
Watchers: 8
Forks: 53
Open Issues: 7
README
Introduction ๐
This is a simple package to generate and validate OTPs (One Time Passwords). This can be implemented mostly in Authentication.
Installation ๐ฝ
Install via composer
composer require ichtrojan/laravel-otp
Run Migrations
php artisan migrate
Usage ๐งจ
NOTE
Response are returned as objects. You can access its attributes with the arrow operator (->
)
Generate OTP
<?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 arenumeric
andalpha_numeric
$length (optional | default = 4)
: The length of token to be generated.$validity (optional | default = 10)
: The validity period of the OTP in minutes.
Sample
<?php use Ichtrojan\Otp\Otp; (new Otp)->generate('michael@okoh.co.uk', '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"
}
Validate OTP
<?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.
Sample
<?php use Ichtrojan\Otp\Otp; (new Otp)->validate('michael@okoh.co.uk', '282581');
Responses
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"
}
Delete expired tokens
You can delete expired tokens by running the following artisan command:
php artisan otp:clean
You 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(); }
Contribution
If you find an issue with this package or you have any suggestion please help out. I am not perfect.