Laraguard 项目使用教程
1. 项目的目录结构及介绍
Laraguard 项目的目录结构如下:
DarkGhostHunter/Laraguard/
├── config/
│ └── laraguard.php
├── database/
├── resources/
├── src/
├── tests/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── LICENSE.md
├── README.md
├── UPGRADE.md
├── composer.json
├── logo.jpg
├── phpunit.xml.dist
目录介绍
config/
: 包含项目的配置文件。database/
: 包含数据库相关的文件。resources/
: 包含资源文件,如视图和语言文件。src/
: 包含项目的源代码。tests/
: 包含测试文件。.editorconfig
: 编辑器配置文件。.gitattributes
: Git 属性配置文件。.gitignore
: Git 忽略配置文件。LICENSE.md
: 项目许可证文件。README.md
: 项目说明文件。UPGRADE.md
: 升级指南文件。composer.json
: Composer 依赖管理文件。logo.jpg
: 项目logo图片。phpunit.xml.dist
: PHPUnit 配置文件。
2. 项目的启动文件介绍
Laraguard 项目的启动文件主要是 composer.json
文件,它定义了项目的依赖和其他配置。以下是 composer.json
文件的部分内容:
{
"require": {
"darkghosthunter/laraguard": "^4.0"
},
"autoload": {
"psr-4": {
"DarkGhostHunter\\Laraguard\\": "src/"
}
}
}
启动文件介绍
require
: 定义了项目所需的依赖包。autoload
: 定义了自动加载的命名空间和对应的路径。
3. 项目的配置文件介绍
Laraguard 项目的主要配置文件是 config/laraguard.php
。以下是该配置文件的内容:
return [
'model' => \DarkGhostHunter\Laraguard\Eloquent\TwoFactorAuthentication::class,
'cache' => [
'store' => null,
'prefix' => '2fa code'
],
'recovery' => [
'enabled' => true,
'codes' => 10,
'length' => 8
],
'safe_devices' => [
'enabled' => false,
'max_devices' => 3,
'expiration_days' => 14
],
'confirm' => [
'timeout' => 10800,
'view' => 'DarkGhostHunter\Laraguard\Http\Controllers\Confirm2FACodeController@showConfirmForm',
'action' => 'DarkGhostHunter\Laraguard\Http\Controllers\Confirm2FACodeController@confirm'
],
'secret_length' => 20,
'issuer' => env('OTP_TOTP_ISSUER'),
'totp' => [
'digits' => 6,
'seconds' => 30,
'window' => 1,
'algorithm' => 'sha1'
]
];
配置文件介绍
model
: 定义了两步验证模型类。cache
: 定义了缓存配置,包括缓存存储和前缀。recovery
: 定义了恢复码的配置,包括是否启用、生成数量和长度。safe_devices
: 定义了安全设备的配置,包括是否启用、最大设备数和过期天数。confirm
: 定义了确认两步验证码的配置,包括超时时间、视图和动作。secret_length
: 定义了密钥的长度。issuer
: 定义了发行者,从环境变量中获取。totp
: 定义了 TOTP 的配置,包括位数、时间窗口和算法。
以上是 Laraguard 项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您