Webauthn-rs 项目使用教程

Webauthn-rs 项目使用教程

webauthn-rsAn implementation of webauthn components for Rustlang servers项目地址:https://gitcode.com/gh_mirrors/we/webauthn-rs

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

Webauthn-rs 项目的目录结构如下：

webauthn-rs/
├── Cargo.toml
├── README.md
├── src/
│   ├── lib.rs
│   ├── webauthn.rs
│   ├── webauthn_builder.rs
│   └── ...
├── examples/
│   ├── demo.rs
│   └── ...
├── compat_tester/
│   ├── webauthn-rs-demo/
│   │   ├── Cargo.toml
│   │   └── src/
│   │       └── main.rs
│   └── ...
└── ...

目录介绍

• Cargo.toml: 项目的依赖和元数据配置文件。
• README.md: 项目的基本介绍和使用说明。
• src/: 包含项目的核心代码文件。
  • lib.rs: 库的入口文件。
  • webauthn.rs: Webauthn 实例的主要实现。
  • webauthn_builder.rs: Webauthn 实例的构造器。
• examples/: 包含示例代码，用于演示如何使用项目。
  • demo.rs: 一个简单的示例，展示如何启动和使用 Webauthn。
• compat_tester/: 包含兼容性测试的相关代码。
  • webauthn-rs-demo/: 一个演示项目，展示如何本地运行 Webauthn 示例。
    • Cargo.toml: 演示项目的依赖配置文件。
    • src/main.rs: 演示项目的入口文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 compat_tester/webauthn-rs-demo/src/main.rs。这个文件是演示项目的入口点，展示了如何配置和启动 Webauthn 服务。

启动文件内容

fn main() {
    // 配置 Webauthn 实例
    let webauthn = WebauthnBuilder::new()
        .add_authenticator(AuthenticatorType::U2F)
        .build();

    // 启动 Webauthn 服务
    webauthn.start_server();
}

启动步骤

1. 配置 Webauthn 实例: 使用 WebauthnBuilder 构造器配置 Webauthn 实例，可以添加不同的认证器类型。
2. 启动服务: 调用 start_server 方法启动 Webauthn 服务。

3. 项目的配置文件介绍

项目的配置文件主要是 Cargo.toml，位于项目根目录和 compat_tester/webauthn-rs-demo/ 目录下。

根目录下的 Cargo.toml

[package]
name = "webauthn-rs"
version = "0.5.0"
edition = "2018"

[dependencies]
base64urlsafedata = "0.5.0"
serde = "1.0.141"
tracing = "0.1.35"
url = "2"
uuid = "1.1.2"
webauthn-rs-core = "0.5.0"

演示项目目录下的 Cargo.toml

[package]
name = "webauthn-rs-demo"
version = "0.1.0"
edition = "2018"

[dependencies]
webauthn-rs = { path = "../../" }

配置文件内容

• [package]: 定义项目的名称、版本和 Rust 版本。
• [dependencies]: 列出项目依赖的库和版本。

通过这些配置文件，可以管理项目的依赖和版本，确保项目能够正确编译和运行。

webauthn-rsAn implementation of webauthn components for Rustlang servers项目地址:https://gitcode.com/gh_mirrors/we/webauthn-rs