WebAuthn 开源项目使用教程

WebAuthn 开源项目使用教程

webauthnWin32 APIs for WebAuthn standard项目地址:https://gitcode.com/gh_mirrors/webauthn1/webauthn

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

webauthn/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── auth.js
│   │   ├── index.js
│   ├── models/
│   │   ├── user.js
│   ├── controllers/
│   │   ├── authController.js
│   ├── utils/
│   │   ├── webauthn.js
├── public/
│   ├── index.html
│   ├── styles.css
├── tests/
│   ├── auth.test.js

目录结构说明

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • auth.js: 认证路由文件。
    • index.js: 主路由文件。
  • models/: 数据模型文件目录。
    • user.js: 用户模型文件。
  • controllers/: 控制器文件目录。
    • authController.js: 认证控制器文件。
  • utils/: 工具文件目录。
    • webauthn.js: WebAuthn 工具文件。
• public/: 静态文件目录。
  • index.html: 主页HTML文件。
  • styles.css: 样式文件。
• tests/: 测试文件目录。
  • auth.test.js: 认证测试文件。

2. 项目的启动文件介绍

src/index.js

const express = require('express');
const bodyParser = require('body-parser');
const config = require('config');
const routes = require('./routes');
 
const app = express();
 
app.use(bodyParser.json());
app.use('/', routes);
 
const port = config.get('port') || 3000;
 
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件说明

• 引入 express 框架和 body-parser 中间件。
• 加载配置文件 config。
• 引入并使用路由文件 routes。
• 监听配置文件中定义的端口，默认为 3000。

3. 项目的配置文件介绍

src/config/default.json

{
  "port": 3000,
  "webauthn": {
    "rpName": "Example Corp",
    "rpID": "example.com",
    "origin": "https://example.com"
  }
}

src/config/production.json

{
  "port": 8080,
  "webauthn": {
    "rpName": "Production Corp",
    "rpID": "prod.example.com",
    "origin": "https://prod.example.com"
  }
}

配置文件说明

• port: 服务器监听的端口。
• webauthn: WebAuthn 相关配置。
  • rpName: 依赖方名称。
  • rpID: 依赖方ID。
  • origin: 认证请求的来源。

以上是基于 https://github.com/microsoft/webauthn.git 项目的使用教程，包含了项目的目录结构、启动文件和配置文件的详细介绍。希望对您有所帮助！

webauthnWin32 APIs for WebAuthn standard项目地址:https://gitcode.com/gh_mirrors/webauthn1/webauthn