README

Laravel的PHP包，用于Google双因素认证

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

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

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

恢复/备份代码

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

演示、示例与沙盒

请查看Google2FA Package Playground。

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

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

兼容性

在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();

文档

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

测试

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

作者

Antonio Carlos Ribeiro

许可协议

Google2FA遵循BSD 3-Clause License许可协议 - 有关详细信息，请参阅LICENSE文件。

贡献

欢迎提交pull请求和issue。