README

Laravel Otp is designed to generate and verify otp being sent to users

Installation

You can install the package via composer:

composer require ibrahem-kamal/laravel-otp

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-otp-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-otp-config"

This is the contents of the published config file:

return [
    'services' => [
        'default' => [
            'expires_in' => 5, // in minutes
            'otp_generator_options' => [
                'length' => 4, // no of digits
                'numbers' => true,
                'letters' => false,
                'symbols' => false,
            ],
            'validate_uniqueness_after_generation' => true,
            'delete_after_verification' => false,
        ],
    ],
    'fallback_options' => [
        'otp_generator_options' => [
            'length' => 4, // no of digits
            'numbers' => true,
            'letters' => false,
            'symbols' => false,
        ],
        'validate_uniqueness_after_generation' => true, // whether to validate the uniqueness of the otp after generation by checking the database
        'delete_after_verification' => false, // whether to delete the otp after verification
    ]

];

You can add as many services as you want, and you can use the fallback options to set the default options for the otp generation and verification

Usage

First you need to prepare your model by implementing the HasOtp Interface and using the InteractsWithOtp trait

class User extends Authenticatable implements HasOtp
{
    use InteractsWithOtp;
}

If you dont have phone column in your model, you can override the getPhoneNumber method to return the user phone number like this

    public function getPhoneNumber(): string
    {
        return $this->mobile_number;
    }

Then you can use the Otp to generate otp

$user->otp()->generate() // returns OtpCode Model instance

// you can also pass the service name to generate otp for a specific service or modify the options

$user->otp()
        ->setPhone('11111')
        ->setValidateUniquenessAfterGeneration(false)
        ->setService('other service')
        ->setGeneratorOptions(
            length: 6,
            letters: false,
            numbers: true, 
            symbols: false
        )->generate()  // returns OtpCode Model instance

You can verify the otp using the verify method

$otp = $user->otp()->verifyOtp('1234') // returns ServiceResponse instance
    $otp->isSuccess(); //bool
    $otp->getErrorsString(); // errors as string
    $otp->getErrors(); // errors as array
    $otp->getData(); // OtpCode Model instance when success
    $otp->toArray(); // array of all the above

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

ibrahem-kamal / laravel-otp

Maintainers

Details