shawsank/otp

Laravel5 OTP manager

Maintainers

Details

github.com/shawsank/laravel-otp

Source

Installs: 23

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 9

1.0.0 2020-01-16 13:27 UTC

Requires

  • php: >=5.4

MIT 431bf16f05b010d549d5c8c3459817c22dd519b7

  • P R <indparez.woop@gmail.com>

laravelotpotp generate

This package is auto-updated.

Last update: 2024-12-16 23:59:21 UTC

README

Laravel 5 OTP Generation.

The module generates OTPs and validates them. You can plug your own notifier (such as AWS SNS) to send the OTPs to various channels.

Several configuration options are provided:

  • Expiration duration
  • Maximum OTPs allowed for a client
  • Length of OTP
  • Blacklisting clients

Installation

Via composer

  1. Run composer require shawsank/otp
  2. Add Shawsank\OTP\OTPServiceProvider to your providers array in config/app.php
  3. Run composer dump-autoload
  4. Run php artisan vendor:publish
  5. Run php artisan migrate

Done!

Configuration options

The package publishes config/otp.php. It is well documented.

Usage

The package provides with the following helpers:

  1. Manager
  2. Generator
  3. Validator

You can use Manager to interact with the whole module. It acts as a wrapper for the complete functionality. However, you are free to use other helpers to generate and validate the OTPs.

Generate an OTP

To generate an OTP, call generate method of Manager. This takes two arguments: module and ID. Both are strings. You can pass anything here, but keep in mind that this combination will be used to validate the OTP. For e.g. $manager->generate('users', '1') will return an OTP for the combination of 'users' module and ID '1'.

Validate an OTP

To validate, call isValid() of the manager. It will return boolean based on the validity of the OTP. Validation makes sure the module + ID is not blocked, and the token is not expired.

Blocking and Unblocking

Whenever the module + ID exceeds the maximum allowed (non-expired) OTPs, they will be blocked. You won't be able to generate anymore OTPs for that module + ID combination. Currently, there is no interface to unblock the clients. You need to manually remove the entry from the table otp_blacklist. Please check ToDo to check progress and thoughts on this feature.

Notifications

The manager gives notify() method which accepts any implementation of Notifier interface. You can implement this interface as per your business logic.

You might want to call useOtp() of the manager after the varification process completes. If you do not call this method, OTP will remain valid till it reaches its expiry limit.

Contributions

All contributions are welcome! Create a fork, create PRs, discuss!

TODO

  1. Add option for numeric/alphanumeric code generation
  2. Provide a way to unblock clients
  3. Provide example implementation(s) for Notifier
  4. Find a better way to remove expired OTPs from DB