SSHKey 技术文档

1. 安装指南

SSHKey 是一个用于生成 SSH 密钥对的 Ruby 库，支持 RSA、DSA 和 ECDSA 密钥类型。以下是安装步骤：

安装步骤

1. 确保你已经安装了 Ruby 环境（CRuby 2.5+ 或 JRuby）。

2. 使用以下命令安装 sshkey gem：

   gem install sshkey
   

2. 项目的使用说明

生成新的密钥对

默认情况下，SSHKey.generate 会生成一个 2048 位的 RSA 密钥对。你也可以通过指定 type 和 bits 参数来生成不同类型的密钥对。

k = SSHKey.generate

k = SSHKey.generate(
  type:       "DSA",
  bits:       1024,
  comment:    "[e-mail]",
  passphrase: "foobar"
)

使用现有密钥

你可以从现有的 PEM 格式的私钥字符串中创建一个 SSHKey 对象。

f = File.read(File.expand_path("~/.ssh/id_rsa"))
k = SSHKey.new(f, comment: "[e-mail]")

如果你的密钥是 OpenSSH 格式（以 -----BEGIN OPENSSH PRIVATE KEY----- 开头），你需要将其转换为 PEM 格式或生成一个新的密钥。

生成新的 RSA 密钥（PEM 格式）

ssh-keygen -t rsa -b 4096 -m PEM

转换现有 OpenSSH 格式密钥

ssh-keygen -p -N "" -m pem -f /path/to/existing/private/key

3. 项目 API 使用文档

SSHKey 对象

获取私钥和公钥

你可以通过以下方法获取私钥和公钥的字符串形式。注意，public_key 是 RSA 或 DSA 或 ECDSA 公钥，而不是 SSH 公钥。

k.private_key
k.public_key

获取 SSH 公钥：

k.ssh_public_key

加密私钥

如果生成密钥时设置了 passphrase，或者通过 passphrase 访问器设置了密码，你可以获取加密后的私钥。

k.passphrase = "foo"
k.encrypted_private_key

注释

密钥可以有一个可选的注释，该注释会显示在 SSH 公钥中。你可以通过 comment 访问器获取或设置注释。

k.comment = "[e-mail]"
k.ssh_public_key

密钥长度

你可以获取密钥的位长度。

k.bits

指纹

你可以获取 SSH 公钥的 MD5、SHA1 或 SHA256 指纹。

k.md5_fingerprint
k.sha1_fingerprint
k.sha256_fingerprint

公钥指令

你可以添加可选的指令，这些指令会在密钥认证时强制执行。

k.directives = "no-pty"
k.directives = [
  "no-port-forwarding",
  "no-X11-forwarding",
  "no-agent-forwarding",
  "no-pty",
  "command='/home/user/bin/authprogs'"
]
k.ssh_public_key

Randomart

你可以生成 OpenSSH 兼容的 ASCII 艺术指纹。

puts k.randomart

原始 OpenSSL 密钥对象

你可以获取原始的 OpenSSL::PKey::RSA、OpenSSL::PKey::DSA 或 OpenSSL::PKey::EC 对象。

k.key_object

现有 SSH 公钥

验证

你可以验证给定的 SSH 公钥是否有效。

SSHKey.valid_ssh_public_key? "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC9HuXvYJPtQE..."

4. 项目安装方式

通过 Gem 安装

gem install sshkey

通过 Bundler 安装

如果你使用 Bundler 管理依赖，可以在 Gemfile 中添加以下内容：

gem 'sshkey'

然后运行：

bundle install

---

通过本文档，你应该能够顺利安装并使用 SSHKey 库来生成和管理 SSH 密钥对。如果你有任何问题，请参考文档中的详细说明。