OpenSK项目安装与部署完全指南

OpenSK项目安装与部署完全指南

OpenSK OpenSK is an open-source implementation for security keys written in Rust that supports both FIDO U2F and FIDO2 standards. 项目地址: https://gitcode.com/gh_mirrors/op/OpenSK

项目概述

OpenSK是一个开源的FIDO2安全密钥实现方案，基于Rust语言开发，运行在Tock操作系统上。本文将详细介绍如何搭建OpenSK开发环境、编译固件以及部署到不同硬件平台的全过程。

开发环境准备

硬件编程工具选择

OpenSK支持多种编程器选项：

• Segger J-Link（默认推荐）：高性能专业调试器
• OpenOCD：开源调试工具链
• pyOCD：基于Python的调试工具
• nrfutil：适用于支持DFU的USB Dongle设备

软件依赖安装

在开始前，请确保系统已安装以下组件：

1. Rust工具链：

   • 通过rustup安装Rust编译环境

2. Python环境：

   • Python3及pip包管理器
   • 推荐Debian系系统安装python3-pip包

3. 加密工具：

   • OpenSSL命令行工具
   • Debian系系统需安装libssl-dev和pkg-config

4. 可选工具：

   • nrfutil（用于DFU模式刷机）
   • uuid-runtime（提供uuidgen命令）
   • llvm和gcc-arm-none-eabi（升级功能需要）

注意：如果使用Python 3.10以上版本，当前nrfutil可能不兼容，建议使用Python 3.10或尝试Nordic提供的新工具。

初始环境搭建

首次安装步骤

1. 克隆项目仓库：

   git clone -b develop <仓库地址>
   cd OpenSK
   

2. 运行初始化脚本：

   ./setup.sh
   

该脚本会自动完成以下工作：

• 检查并更新git子模块
• 应用必要的补丁文件
• 生成加密材料
• 安装ARM架构的Rust工具链
• 安装tockloader工具

Linux系统额外配置

在Linux系统上，需要添加udev规则以允许普通用户访问OpenSK设备：

sudo cp rules.d/55-opensk.rules /etc/udev/rules.d/
sudo udevadm control --reload

执行后需重新插拔设备使规则生效。

证书配置

为支持U2F或认证功能，必须配置证书：

./tools/configure.py \
    --certificate=crypto_data/opensk_cert.pem \
    --private-key=crypto_data/opensk.key

固件编译与部署

更新已有环境

如果已有OpenSK环境需要更新：

1. 重置并重新设置环境（会删除所有未提交的更改）：

   ./reset.sh
   ./setup.sh
   

2. 刷写固件（注意2.0认证版本后存储格式不兼容）：

   # 首次运行清除存储
   ./deploy.py --erase_storage
   # 正常刷写固件
   ./deploy.py --opensk
   

高级部署选项

除默认JTAG方式外，还支持：

• OpenOCD编程器：添加--programmer=openocd参数
• pyOCD编程器：添加--programmer=pyocd参数
• 自定义编程：使用--programmer=none生成IntelHex文件

如果已安装Tock OS，可跳过该步骤：

./deploy.py --no-tockos

固件升级功能

OpenSK实验性地支持通过CTAP命令进行固件升级，无需调试端口。闪存分为四个部分：

1. 引导加载程序
2. 固件分区A
3. 固件分区B
4. 凭证持久存储

升级功能目前仅开发板支持，部署时会自动安装引导加载程序。请注意安全保存升级签名私钥。

硬件平台支持

OpenSK支持多种硬件平台，包括：

• Nordic nRF52840-DK开发板
• Nordic nRF52840 Dongle
• Makerdiary nRF52840-MDK USB Dongle
• Feitian OpenSK dongle

各平台具体操作步骤请参考对应的硬件文档。

注意事项

1. 证书配置涉及隐私考量，请仔细阅读相关文档
2. 从2.0之前版本升级会清除所有已存储的网站登录凭证
3. 开发环境主要在Linux和macOS测试，Windows可能存在问题

通过本文指南，您应该能够顺利完成OpenSK的开发环境搭建和固件部署工作。如需更详细的硬件特定说明，请查阅对应的硬件文档。

OpenSK OpenSK is an open-source implementation for security keys written in Rust that supports both FIDO U2F and FIDO2 standards. 项目地址: https://gitcode.com/gh_mirrors/op/OpenSK