Yubikey 项目技术文档

1. 安装指南

使用 Ruby Gem 安装

Yubikey 项目可以通过 Ruby Gem 进行安装。运行以下命令来安装 Yubikey Gem：

gem install yubikey

如果您正在使用 Bundler，您可以将 Yubikey Gem 添加到您的 Gemfile 文件中：

gem 'yubikey'

然后运行以下命令来安装所有依赖项：

bundle install

2. 项目使用说明

本项目是一个 Ruby 库，用于验证、解码、解密和解析 Yubikey 一次性密码。

OTP 解码

以下是一个如何使用 Yubikey OTP 解码的示例：

key = 'ecde18dbe76fbd0c33330f1c354871db'
otp = 'dteffujehknhfjbrjnlnldnhcujvddbikngjrtgh'
token = Yubikey::OTP.new(otp, key)

puts "设备公共ID: #{token.public_id}" # => 'dteffuje'
puts "设备密钥ID: #{token.secret_id}" # => '8792ebfe26cc'
puts "设备插入计数: #{token.insert_counter}" # => 19
puts "会话激活计数: #{token.session_counter}" # => 17
puts "会话时间戳: #{token.timestamp}" # => 49712
puts "OTP 随机数据: #{token.random_number}" # => 40904

OTP 验证

使用您的 api_key 和 api_id 来进行 OTP 验证，这些可以在 yubico.com 获取。

以下是一个如何使用 Yubikey OTP 验证的示例：

begin
  otp = Yubikey::OTP::Verify.new(api_id: 1234,
                                 api_key: 'NiSwGZBQ0gTbwXbRGWAf4kM5xXg=',
                                 otp: 'dteffujehknhfjbrjnlnldnhcujvddbikngjrtgh')

  if otp.valid?
    puts '有效的 OTP'
  elsif otp.replayed?
    puts '重放的 OTP'
  end
rescue Yubikey::OTP::InvalidOTPError
  puts '无效的 OTP'
end

3. 项目API使用文档

本项目提供的 API 主要包括 OTP 解码和 OTP 验证两部分。

OTP 解码

Yubikey::OTP.new(otp, key) 方法用于解码 OTP。参数 otp 是一次性密码，而 key 是用于解码的密钥。

OTP 验证

Yubikey::OTP::Verify.new(api_id, api_key, otp) 方法用于验证 OTP。参数 api_id 和 api_key 是 Yubico 提供的 API 识别信息，而 otp 是要验证的一次性密码。

验证方法包括：

• valid?：检查 OTP 是否有效。
• replayed?：检查 OTP 是否被重放。

4. 项目安装方式

请参考本文档的“安装指南”部分，了解如何通过 Ruby Gem 安装本项目。