README

Laravel的Google两步认证包

Google2FA是Google两步认证模块的PHP实现，支持RFC 4226中指定的基于HMAC的一次性密码（HOTP）算法和RFC 6238中指定的基于时间的一次性密码（TOTP）算法。

此包是Laravel到Google2FA PHP包的桥梁。

此包的目的是创建Google2FA的二维码并检查用户输入的代码。如果您需要创建备份/恢复代码，请查看以下内容。

恢复/备份代码

如果您需要创建恢复或备份代码，以便为用户提供恢复丢失账户的方法，您可以使用Recovery Package。

演示、示例 & 游乐场

请查看Google2FA Package Playground。

这是一个演示应用程序，展示了如何使用Google2FA：google2fa-example。

您可以使用Google身份验证器应用程序扫描此（旧）演示页面上的二维码，并实时查看代码变化（几乎）。

兼容性

在Google2FA 2.0（Laravel 5.1）之前，您必须安装pragmarx/google2fa:~1.0，因为此包既是Laravel包也是PHP（无偏见）。

演示

点击此处查看中间件演示

安装

使用Composer进行安装

composer require pragmarx/google2fa-laravel

如果您更喜欢内联二维码而不是Google生成的URL，则需要安装BaconQrCode

composer require bacon/bacon-qr-code

Laravel上的安装

Laravel 5.5

您不需要做其他任何事情，此包会自动加载服务提供者和创建别名，使用新的自动发现功能。

Laravel 5.4及以下版本

将服务提供者和外观别名添加到您的app/config/app.php（Laravel 4.x）或config/app.php（Laravel 5.x）

PragmaRX\Google2FALaravel\ServiceProvider::class,

'Google2FA' => PragmaRX\Google2FALaravel\Facade::class,

发布配置文件

php artisan vendor:publish --provider="PragmaRX\Google2FALaravel\ServiceProvider"

使用它

使用外观

use Google2FA;

return Google2FA::generateSecretKey();

在Laravel中，您可以使用IoC容器

$google2fa = app('pragmarx.google2fa');

return $google2fa->generateSecretKey();

中间件

此包有一个中间件可以帮助您在应用程序中编码2FA。要使用它，您只需

将中间件添加到您的Kernel.php

protected $routeMiddleware = [
    ...
    '2fa' => \PragmaRX\Google2FALaravel\Middleware::class,
];

在路由中使用它

Route::get('/admin', function () {
    return view('admin.index');
})->middleware(['auth', '2fa']);

配置视图

您可以在配置文件（config/google2fa.php）中设置您的“请求一次性密码”视图

/**
 * One Time Password View
 */
'view' => 'google2fa.index',

在视图中，您只需提供一个包含输入的表单，该输入也是可配置的

/**
 * One Time Password request input name
 */
'otp_input' => 'one_time_password',

以下是一个表单示例

    <form action="/google2fa/authenticate" method="POST">
        <input name="one_time_password" type="text">

        <button type="submit">Authenticate</button>
    </form>

一次性密码有效期

通常OTP永久有效，直到用户注销您的应用程序，但为了提高应用程序的安全性，您可能希望定期重新请求，特别是对于Google OTP。因此，您可以在此处设置分钟数

/**
* Lifetime in minutes.
* In case you need your users to be asked for a new one time passwords from time to time.
*/

'lifetime' => 0, // 0 = eternal

并且您可以选择是否在用户浏览网站时保持OTP有效

/**
 * Renew lifetime at every new request.
 */

'keep_alive' => true,

手动从2Fa注销

此命令将注销用户，并在下一次请求时将其重定向到2Fa表单

Google2FA::logout();

如果您不想使用外观，您也可以

use PragmaRX\Google2FALaravel\Support\Authenticator;

(new Authenticator(request()))->logout();

在X次尝试后限制/锁定

除非你需要非常复杂的功能，否则你很可能可以使用Laravel的路由限流中间件来完成这个任务。

Route::get('/admin', function () {
    return view('admin.index');
})->middleware(['auth', '2fa', 'throttle']);

无状态使用

$authenticator = app(Authenticator::class)->bootStateless($request);

if ($authenticator->isAuthenticated()) {
    // otp auth success!
}

你还可以使用无状态中间件

protected $routeMiddleware = [
    ...
    '2fa' => \PragmaRX\Google2FALaravel\MiddlewareStateless::class,
];

事件

以下事件会被触发

• EmptyOneTimePasswordReceived
• LoggedOut
• LoginFailed
• LoginSucceeded
• OneTimePasswordExpired
• OneTimePasswordRequested

文档

请查看Google2FA主仓库中的ReadMe文件。

测试

该包的测试是用phpspec编写的。

作者

Antonio Carlos Ribeiro

许可证

Google2FA遵循MIT许可证 - 请查阅LICENSE文件以获取详细信息

贡献

欢迎提交拉取请求和问题。