Safari-FIDO-U2F 项目使用教程

Safari-FIDO-U2F 项目使用教程

1. 项目目录结构及介绍

Safari-FIDO-U2F/
├── README.md
├── LICENSE
├── src/
│   ├── Swift/
│   │   ├── Main.swift
│   │   └── ...
│   ├── JavaScript/
│   │   ├── u2f.js
│   │   └── ...
│   ├── Shell/
│   │   ├── build.sh
│   │   └── ...
│   └── C/
│       ├── libu2f-host/
│       └── ...
├── config/
│   ├── settings.json
│   └── ...
└── ...

目录结构说明

• README.md: 项目的基本介绍和使用说明。
• LICENSE: 项目的开源许可证文件，本项目使用 MIT 许可证。
• src/: 项目的源代码目录。
  • Swift/: 包含项目的 Swift 代码，主要用于与硬件通信。
  • JavaScript/: 包含项目的 JavaScript 代码，用于实现 FIDO U2F 的高级 API。
  • Shell/: 包含项目的 Shell 脚本，用于构建和配置项目。
  • C/: 包含项目的 C 代码，主要用于底层硬件通信。
• config/: 包含项目的配置文件，如 settings.json。

2. 项目的启动文件介绍

启动文件

• src/Swift/Main.swift: 这是项目的入口文件，负责初始化并启动整个应用程序。它包含了主要的逻辑流程，包括与硬件的通信、JavaScript 脚本的注入等。

启动流程

1. 初始化: Main.swift 文件首先初始化项目的各个模块，包括 Swift 和 JavaScript 部分。
2. 注入脚本: 通过 beforeload 事件监听器，将 u2f.js 脚本注入到顶层页面。
3. 消息传递: 监听 u2f_ 消息，并将这些消息传递给原生代码进行处理。
4. 返回结果: 将原生代码处理后的结果返回给 u2f.js 进行进一步处理。

3. 项目的配置文件介绍

配置文件

• config/settings.json: 这是项目的主要配置文件，包含了项目的各种设置和参数。

配置文件内容

{
  "apiVersion": "1.1",
  "enableLogging": true,
  "hardwareTimeout": 5000,
  "supportedBrowsers": ["Safari"]
}

配置项说明

• apiVersion: 指定项目使用的 FIDO U2F API 版本。
• enableLogging: 是否启用日志记录功能。
• hardwareTimeout: 硬件通信的超时时间，单位为毫秒。
• supportedBrowsers: 支持的浏览器列表，目前仅支持 Safari。

通过以上配置文件，用户可以根据自己的需求调整项目的运行参数，以适应不同的使用场景。