WebAuthn 框架使用教程

WebAuthn 框架使用教程

webauthn-frameworkFIDO-U2F / FIDO2 / Webauthn Framework项目地址:https://gitcode.com/gh_mirrors/we/webauthn-framework

1. 项目的目录结构及介绍

WebAuthn 框架的目录结构如下：

webauthn-framework/
├── config/
│   ├── packages/
│   │   └── webauthn.yaml
│   └── routes/
│       └── webauthn.yaml
├── src/
│   ├── Bundle/
│   │   └── WebauthnBundle/
│   ├── Component/
│   │   └── Webauthn/
│   ├── Framework/
│   │   └── Webauthn/
│   └── Server/
│       └── Webauthn/
├── tests/
│   └── Webauthn/
├── .gitignore
├── .php_cs.dist
├── composer.json
├── LICENSE
├── README.md
└── webpack.config.js

目录结构介绍

• config/: 包含项目的配置文件。
  • packages/: 包含 Symfony 包的配置文件，如 webauthn.yaml。
  • routes/: 包含路由配置文件，如 webauthn.yaml。
• src/: 包含项目的源代码。
  • Bundle/: 包含 Symfony 包的代码。
  • Component/: 包含 WebAuthn 组件的代码。
  • Framework/: 包含 WebAuthn 框架的代码。
  • Server/: 包含 WebAuthn 服务器的代码。
• tests/: 包含项目的测试代码。
• .gitignore: Git 忽略文件。
• .php_cs.dist: PHP CS Fixer 配置文件。
• composer.json: Composer 依赖管理文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

WebAuthn 框架的启动文件主要是 public/index.php，这是 Symfony 项目的标准入口文件。

// public/index.php

use App\Kernel;
use Symfony\Component\Dotenv\Dotenv;
use Symfony\Component\ErrorHandler\Debug;
use Symfony\Component\HttpFoundation\Request;

require dirname(__DIR__).'/vendor/autoload.php';

(new Dotenv())->bootEnv(dirname(__DIR__).'/.env');

if ($_SERVER['APP_DEBUG']) {
    umask(0000);

    Debug::enable();
}

$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
$request = Request::createFromGlobals();
$response = $kernel->handle($request);
$response->send();
$kernel->terminate($request, $response);

启动文件介绍

• 引入 Composer 自动加载文件。
• 加载环境变量文件 .env。
• 根据 APP_DEBUG 环境变量启用或禁用调试模式。
• 创建 Symfony 内核实例并处理请求。
• 发送响应并终止内核。

3. 项目的配置文件介绍

WebAuthn 框架的配置文件主要位于 config/packages/ 目录下，其中 webauthn.yaml 是主要的配置文件。

# config/packages/webauthn.yaml

webauthn:
    relying_party:
        name: 'My Relying Party'
        id: 'example.com'
        origins: ['https://example.com']
    credential_repository: 'App\Repository\CredentialRepository'
    user_repository: 'App\Repository\UserRepository'

配置文件介绍

• relying_party: 配置依赖方信息。
  • name: 依赖方的名称。
  • id: 依赖方的 ID。
  • origins: 允许的源列表。
• credential_repository: 凭证存储库的类名。
• user_repository: 用户存储库的类名。

以上是 WebAuthn 框架的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 WebAuthn 框架。

webauthn-frameworkFIDO-U2F / FIDO2 / Webauthn Framework项目地址:https://gitcode.com/gh_mirrors/we/webauthn-framework