Download the PHP package morcen/laravel-otp-generator without Composer

On this page you can find all versions of the php package morcen/laravel-otp-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of morcen/laravel-otp-generator

Informations about the package laravel-otp-generator

Generate OTP for your Laravel application

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package requires Laravel >= 8.x.

Installation

  1. Install the package via composer:

  2. Publish the config file with:

    Open config/otp.php and update the following:

    • identifier - this is what this package will use to query for the OTP record in the database
    • set - this defines the characters that will be used for the code. Possible values are:
      • numbers - from zero to nine (0 to 9)
      • lowercase - English alphabet from a to z
      • uppercase - English alphabet from A to Z
      • others- defaults to empty string. You can put any other characters you wish to see as part of the OTP code.
      • all - uses all letters and numbers, including the characters in others option. This is the defualt option.
    • lifetime - defines how long the OTP will be valid for. Default is 15 minutes.
    • length - defines the default length of the OTP. Though this can be simply overriden whenever the generate or generateFor methods are called. Default length is 4.
    • encrypt - if set to true, it will have additional property hash in the returned object. If used with generateFor() method, the value that will be saved in the database will be the encrypted value. Available since v1.1.0.
    • alg - This will be the hashing algorithm used for the OTP code. This will only take effect if encrypt is set to true. Valid options are sha1 and md5. Available since v1.1.0.

  3. Publish the migrations with:

    and update it to include the identifier field mentioned in the previous step. For example, if you have

    in your config/otp.php, you have to add this line in the migration file created:

  4. Run the migrations with:

Usage

To generate an OTP that can be validated afterwards, use the method generatedFor(). It accepts two parameters:

For example, we want to create an OTP for the email [email protected]:

$otp receives back the OTP object*, e.g.

And then to validate, use the method validateFor, accepting the $identifierValue and the OTP as parameters and returns bool:

*NOTE: hash property only appears in the OTP object if encrypt is set to true.

To generate and receive an OTP code only:

$otp receives back just the OTP object like this:

*NOTE: hash property only appears in the OTP object if encrypt is set to true.

To override the default length of the OTP, pass the length as a parameter. For example, to generate an OTP that is 10 characters long:

or

Testing

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.

All versions of laravel-otp-generator with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
spatie/laravel-package-tools Version ^1.9.2
laravel/framework Version ^8.0 | ^9.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package morcen/laravel-otp-generator contains the following files

Loading the files please wait ...