adevesa/laravel-simple-otp

为您的应用程序生成和验证OTP

1.0.2 2024-01-31 20:16 UTC

This package is auto-updated.

Last update: 2024-09-08 13:41:35 UTC


README

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

此包是一个简单的Laravel OTP生成器。您可以使用它来生成OTP并进行验证。

安装

您可以通过composer安装此包

composer require adevesa/laravel-simple-otp

您可以使用以下命令发布迁移并运行它们,以及发布配置文件:

php artisan vendor:publish --provider="adevesa\SimpleOTP\SimpleOTPServiceProvider"
php artisan migrate

这是发布配置文件的内容

return [
    'otp_length' => env('SIMPLE_OTP_LENGTH', 6),
    'otp_format' => env('SIMPLE_OTP_FORMAT', 'alpha_numeric'),
    'otp_expiration_minutes' => env('SIMPLE_OTP_EXPIRATION_MINUTES', 5),
    'otp_max_attempts' => env('SIMPLE_OTP_MAX_ATTEMPTS', 3),
    'otp_throw_exceptions' => env('SIMPLE_OTP_THROW_EXCEPTIONS', true),
];

使用 otp_throw_exceptions 选项,您可以控制包是否应抛出异常或在OTP无效时返回 false

使用方法

$simpleOTP = new adevesa\SimpleOTP();
$code = $simpleOTP->create('a_email@example.com');
$simpleOTP->verify('a_email@example.com', "ASD123");

或者也可以

$code = \adevesa\SimpleOTP\Facades\SimpleOTP::create('+5491123456789')->code;
$isValid = \adevesa\SimpleOTP\Facades\SimpleOTP::verify('+5491123456789', $code);

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近的变化详情。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

如果您发现任何安全相关的问题,请通过电子邮件 adevesa95@outlook.com 而不是使用问题跟踪器。

鸣谢

许可证

MIT许可证(MIT)。请参阅 许可证文件 了解更多信息。