soiposervices / laravel-otp
Laravel OTP generator and validation
Requires
- php: ^5.5.9|^7.0|^8.0|^8.1|^8.2
- illuminate/support: ^5.2|^6.0|^7.0|^8.0|^9.0|^10.0
This package is auto-updated.
Last update: 2024-11-30 02:34:34 UTC
README
Introduction
A package for Laravel One Time Password (OTP) generator and validation without Eloquent Model, since it done by Cache. The cache connection same as your laravel cache config and it supported: "apc", "array", "database", "file", "memcached", "redis"
This is a fork of SoipoServices/laravel-otp , thanks to SoipoServices for his hard work.
Installation
Install via composer
composer require soiposervices/laravel-otp
Add Service Provider & Facade
For Laravel 5.5+
Once the package is added, the service provider and facade will be auto discovered.
For Laravel 5.2 / 5.3 / 5.4
Add the ServiceProvider to the providers array in config/app.php
:
SoipoServices\Otp\OtpServiceProvider::class
Add the Facade to the aliases array in config/app.php
:
'Otp' => SoipoServices\Otp\OtpFacade::class
Configuration
Publish config and language file
php artisan vendor:publish --provider="SoipoServices\Otp\OtpServiceProvider"
This package publishes an otp.php
file inside your applications's config folder which contains the settings for this package. Most of the variables are bound to environment variables, you may add Key-Value pair to the .env
file in the Laravel application.
OTP_FORMAT=numeric
OTP_LENGTH=6
OTP_SENSITIVE=false
OTP_EXPIRES_TIME=15
OTP_ATTEMPT_TIMES=5
OTP_REPEATED=true
OTP_DEMO=false
Usage
Generate OTP
Otp::generate(string $identifier)
$identifier
: The identity that will be tied to the OTP.
Sample
use OTP; // in controller $password = Otp::generate('reg:name@domain.com');
This will generate a OTP that will be valid for 15 minutes.
Validate OTP
Otp::validate(string $identifier, string $password)
$identifier
: The identity that is tied to the OTP.$password
: The password tied to the identity.
Sample
use OTP; // in controller $result = Otp::validate('reg:name@domain.com', '123456');
Responses
On Success
{
"status": true
}
Invalid OTP
{
"status": false,
"error": "invalid"
}
Expired
{
"status": false,
"error": "expired"
}
Max attempt
{
"status": false,
"error": "max_attempt"
}
- Reached the maximum allowed attempts, default 10 times with each identifier
Validate OTP by Laravel Validation
// in a `FormRequest` use SoipoServices\Otp\Rules\OtpValidate; public function rules() { return [ 'code' => ['required', new OtpValidate('change-email:name@domain.com')] ]; } // in a controller $request->validate([ 'code' => ['required', new OtpValidate('change-email:name@domain.com')] ]);
Validate OTP by session id
// Otp class $result = Otp::validate('123456'); // in a `FormRequest` use SoipoServices\Otp\Rules\OtpValidate; public function rules() { return [ 'code' => ['required', new OtpValidate()] ]; } // in a controller $request->validate([ 'code' => ['required', new OtpValidate()] ]);
- The setting without identifier will automatically use the session ID as the default, and the OTP generation and verification will be completed in same session (browser's cookies).
Advanced Usage
Generate OTP with options
$password = Otp::setLength(8)->setFormat('string')->setExpires(60)->setRepeated(false)->generate('identifier-key-here'); // or array option $password = Otp::generate('identifier-key-here', [ 'length' => 8, 'format' => 'string', 'expires' => 60, 'repeated' => false ]);
setLength($length)
: The length of the password. Default: 6setFormat($format)
: The format option allows you to decide which generator implementation to be used when generating new passwords. Options: 'string','numeric','numeric-no-zero','customize'. Default: "numeric"setExpires($minutes)
: The expiry time of the password in minutes. Default: 15setRepeated($boolean)
: The repeated of the password. The previous password is valid when new password generated until either one password used or itself expired. Default: true
Generate OTP with customize password
$password = Otp::setCustomize('12345678ABC@#$')->generate('identifier-key-here');
setCustomize($string)
: Random letter from the customize string
Validate OTP with specific attempt times
$password = Otp::setAttempts(3)->validate('identifier-key-here', 'password-here');
setAttempts($times)
: The number of incorrect password attempts. Default: 5
Validate OTP with case sensitive
$password = Otp::setSensitive(true)->generate('identifier-key-here'); // validate $result = Otp::setSensitive(true)->validate('identifier-key-here', 'password-here'); // in controller use SoipoServices\Otp\Rules\OtpValidate; $request->validate([ 'code' => ['required', new OtpValidate('identifier-key-here', ['sensitive' => true])] ]);
setSensitive($boolean)
: Requiring correct input of uppercase and lowercase letters. Default: true
Generate OTP with seperate password
$password = Otp::setLength([4,3,4])->setSeparator(':')->generate('identifier-key-here');
Sample password
3526:126:3697
setLength($array)
: The length of the password, use array to separate each length.setSeparator($string)
: The separator of the password. Default: "-"
Validate OTP with extra data
$password = Otp::setData(['user_id' => auth()->id()])->generate('login-confirmation');
setData($var)
: Allows you to get the extra data of OTP.
// validate $result = Otp::setDisposable(false)->validate('login-confirmation', 'password-here'); // in controller use SoipoServices\Otp\Rules\OtpValidate; $request->validate([ 'code' => ['required', new OtpValidate('login-confirmation', ['disposable' => false])] ]);
setDisposable($boolean)
: The disposable of the Otp identifier, the different password is not valid when same identifier password used. Default: true
On Success Response
{
"status": true,
"data": [
"user_id": 10
]
}
- When you set disposable to
false
, you are able support different password with different extra data for different user in the same identifier key of the OTP.
Validate OTP with skip using
// validate $result = Otp::setSkip(true)->validate('identifier-key-here', 'password-here'); // in controller use SoipoServices\Otp\Rules\OtpValidate; $request->validate([ 'code' => ['required', new OtpValidate('identifier-key-here', ['skip' => true])] ]);
setSkip($boolean)
: Skip using the password when validate, which means you can reuse the password again. Default: false- When there is an error response to the form request, it will skip using the password, but remember to
OTP::validate(...)
in controller.
Delete OTP
Otp::forget('identifier-key-here');
- Delete all password with this specific identifier
Delete specific password
Otp::forget('identifier-key-here', 'password-here');
Reset attempt times
Otp::resetAttempt('identifier-key-here');
Demo password
Add the following Key-Value pair to the .env
file in the Laravel application.
OTP_DEMO=true
- Demo mode for development purposes, no need to use real password to validate.
- Default demo password: "1234", "123456", "12345678"
Contribution
All contributions are welcome! 😄
License
The MIT License (MIT).
If you enjoy this, please consider supporting SoipoServices: