yubihsm.rs

纯Rust客户端，用于YubiHSM 2设备，由Yubico提供。

文档

关于

这是一个纯Rust客户端库，用于YubiHSM 2设备，实现了Yubico的YubiHSM SDK中的libyubihsm C库的大部分功能。它提供了两个后端与YubiHSM通信：

• HTTP：通过Yubico SDK中的yubihsm-connector进程与YubiHSM通信。
• USB：使用rusb crate直接通过USB与YubiHSM通信。

yubihsm::Client类型提供了对HSM命令的访问。

这不是Yubico的官方项目，也不受Yubico的支持或认可（尽管管理他们Twitter账号的人认为这很棒）。

注意：如果你在寻找YubiKey库而不是YubiHSM，请查看yubikey-piv.rs。

最低支持的Rust版本

此crate需要Rust 1.57 或更高版本。

支持的命令

注意：如果您想使用此列表中未提供的命令，请打开一个请求支持的issue。

注意：标记为⚠️的命令尚未经过适当测试，可能包含错误或根本无法工作。它们默认禁用：要使用它们，您必须启用untested cargo功能。如果您成功使它们工作，请打开一个报告成功的issue（或PR）问题，以便我们可以将它们提升到✅。

测试

此crate允许您以三种不同的方式运行集成测试套件

• 针对真实YubiHSM2设备的实时测试
  • 通过HTTP
  • 通过USB
• 使用MockHSM进行模拟测试，该工具实现了部分YubiHSM2功能

cargo test：通过yubihsm-connector测试YubiHSM2通过HTTP的实时连接

此模式假设您拥有YubiHSM2硬件设备，已经为您的平台下载了YubiHSM2 SDK，并且正在运行一个监听在localhost默认端口12345的yubihsm-connector进程。

YubiHSM2设备应处于默认出厂状态。要将其重置到该状态，请使用yubihsm-shell reset命令或插入后立即按住YubiHSM2 10秒。

您可以通过LED快速闪烁1秒来确认测试正在实时针对YubiHSM2进行。

注意：这些测试是破坏性的，不要在包含您关心密钥的YubiHSM2上运行。

cargo test --features=usb：通过USB测试YubiHSM2的实时连接

添加usb cargo功能会在HTTP连接器支持的基础上构建USB连接器支持，并且通过USB而不是使用yubihsm-connector进程来运行测试套件。

注意：这些测试是破坏性的，不要在包含您关心密钥的YubiHSM2上运行。

cargo test --features=mockhsm：对模拟HSM进行的模拟测试

当您无法访问物理YubiHSM2硬件时，例如在CI环境中，此模式很有用。

许可

yubihsm.rs同时根据MIT许可和Apache许可（版本2.0）的条款分发。

有关详细信息，请参阅LICENSE-APACHE和LICENSE-MIT。