module Gem::Security

对 gem 进行签名

Gem::Security 实现了 gem 的加密签名。下面的部分是使用签名 gem 和生成您自己的 gem 的分步指南。

演练

构建您的证书

为了开始对 gem 进行签名，您需要构建一个私钥和一个自签名证书。方法如下：

# build a private key and certificate for yourself:
$ gem cert --build you@example.com

这可能需要几秒钟到一两分钟，具体取决于您的计算机速度（公钥算法并非最快的加密算法）。完成后，您将在当前目录中看到文件 “gem-private_key.pem” 和 “gem-public_cert.pem”。

首先：将这两个文件移至 ~/.gem，如果您在该目录中还没有密钥和证书。确保文件权限使其他人无法读取密钥（默认情况下，文件会安全保存）。

请妥善保管您的私钥；如果泄露，有人可以冒充您签名软件包（注意：PKI 有办法减轻丢失密钥的风险；稍后将详细介绍）。

签名 gem

在 RubyGems 2 及更高版本中，签名 gem 不需要额外的工作。RubyGems 会自动在您的主目录中查找您的密钥和证书，并使用它们来签名新打包的 gem。

如果您的证书不是自签名的（由第三方签名），RubyGems 将尝试从受信任的证书加载证书链。使用 gem cert --add signing_cert.pem 将您的签名者添加为受信任的证书。有关证书链的详细信息，请参阅下文。

如果您构建 gem，它将被自动签名。如果您查看 gem 文件，您会发现添加了几个新文件：

$ tar tf your-gem-1.0.gem
metadata.gz
metadata.gz.sig # metadata signature
data.tar.gz
data.tar.gz.sig # data signature
checksums.yaml.gz
checksums.yaml.gz.sig # checksums signature

手动签名 gem

如果您希望将密钥存储在单独的安全位置，则需要手动设置 gem 以进行签名。为此，请在打包 gem 之前在 gemspec 中设置 signing_key 和 cert_chain。

s.signing_key = '/secure/path/to/gem-private_key.pem'
s.cert_chain = %w[/secure/path/to/gem-public_cert.pem]

当您使用这些选项打包 gem 时，RubyGems 将自动从安全路径加载您的密钥和证书。

已签名的 gem 和安全策略

现在让我们验证签名。继续安装 gem，但添加以下选项：-P HighSecurity，如下所示：

# install the gem with using the security policy "HighSecurity"
$ sudo gem install your.gem -P HighSecurity

-P 选项设置您的安全策略 — 我们稍后将对此进行讨论。嗯，这是什么？

$ gem install -P HighSecurity your-gem-1.0.gem
ERROR:  While executing gem ... (Gem::Security::Exception)
    root cert /CN=you/DC=example is not trusted

罪魁祸首是安全策略。RubyGems 有几种不同的安全策略。让我们短暂休息一下，回顾一下安全策略。以下是可用的安全策略列表以及每个策略的简要说明：

RubyGems 拒绝安装您闪亮的新签名 gem 的原因是它来自不受信任的来源。好吧，您的代码是无懈可击的（当然），所以您需要将自己添加为受信任的来源：

# add trusted certificate
gem cert --add ~/.gem/gem-public_cert.pem

您现在已将您的公钥证书添加为受信任的来源。现在您可以轻松安装由您的私钥签名的包了。让我们再次尝试上面的安装命令：

# install the gem with using the HighSecurity policy (and this time
# without any shenanigans)
$ gem install -P HighSecurity your-gem-1.0.gem
Successfully installed your-gem-1.0
1 gem installed

这次 RubyGems 将接受您的签名包并开始安装。

在等待 RubyGems 发挥其魔力时，可以通过运行 gem help cert 来查看其他一些安全命令。

Options:
  -a, --add CERT                   Add a trusted certificate.
  -l, --list [FILTER]              List trusted certificates where the
                                   subject contains FILTER
  -r, --remove FILTER              Remove trusted certificates where the
                                   subject contains FILTER
  -b, --build EMAIL_ADDR           Build private key and self-signed
                                   certificate for EMAIL_ADDR
  -C, --certificate CERT           Signing certificate for --sign
  -K, --private-key KEY            Key for --sign or --build
  -A, --key-algorithm ALGORITHM    Select key algorithm for --build from RSA, DSA, or EC. Defaults to RSA.
  -s, --sign CERT                  Signs CERT with the key from -K
                                   and the certificate from -C
  -d, --days NUMBER_OF_DAYS        Days before the certificate expires
  -R, --re-sign                    Re-signs the certificate from -C with the key from -K

我们已经涵盖了 --build 选项，而 --add、--list 和 --remove 命令似乎相当直接；它们允许您添加、列出和删除受信任证书列表中的证书。但是这个 --sign 选项是怎么回事？

证书链

为了回答这个问题，让我们看看“证书链”，这是我之前提到的一个概念。自签名证书存在一些问题：首先，自签名证书的安全性并不高。当然，证书上写着 Yukihiro Matsumoto，但我怎么知道它确实是 matz 本人生成并签名的，除非他亲自把证书给了我？

第二个问题是可扩展性。好吧，如果有 50 个 gem 作者，那么我就有 50 个受信任的证书，没问题。如果有 500 个 gem 作者呢？1000 个呢？不断添加新的受信任证书很麻烦，而且实际上使信任系统安全性降低，因为它鼓励 RubyGems 用户盲目信任新证书。

这就是证书链的用武之地。证书链在颁发证书和子证书之间建立了任意长度的信任链。因此，我们不是按开发者基础信任证书，而是使用 PKI 的证书链概念来构建逻辑信任层次结构。这是一个基于（大致）地理位置的假设的信任层次结构示例：

                    --------------------------
                    | rubygems@rubygems.org |
                    --------------------------
                                |
              -----------------------------------
              |                                 |
  ----------------------------    -----------------------------
  |  seattlerb@seattlerb.org |    | dcrubyists@richkilmer.com |
  ----------------------------    -----------------------------
       |                |                 |             |
---------------   ----------------   -----------   --------------
|   drbrain   |   |   zenspider  |   | pabs@dc |   | tomcope@dc |
---------------   ----------------   -----------   --------------

现在，用户无需拥有 4 个受信任的证书（drbrain、zenspider、pabs@dc 和 tomecope@dc 各一个），而是只需要一个证书，“rubygems@rubygems.org” 证书。

工作原理如下：

我安装了由“drbrain”签名的包“rdoc-3.12.gem”。我从未听说过“drbrain”，但他的证书有一个由“seattle.rb@seattlerb.org”证书签发的有效签名，该证书又有一个由“rubygems@rubygems.org”证书签发的有效签名。瞧！此时，我更愿意信任“drbrain”签名的包，因为我可以建立一个到“rubygems@rubygems.org”的链，而我确实信任它。

签名证书

--sign 选项允许这一切发生。开发人员使用 --build 选项创建他们的构建证书，然后通过在下次区域 Ruby 会议（在我们的假设示例中）上携带证书进行签名，由持有区域 RubyGems 签名证书的人进行签名，该证书在下次 RubyConf 上由顶级 RubyGems 证书的持有者签名。在每个点，颁发者运行相同的命令：

# sign a certificate with the specified key and certificate
# (note that this modifies client_cert.pem!)
$ gem cert -K /mnt/floppy/issuer-priv_key.pem -C issuer-pub_cert.pem
   --sign client_cert.pem

然后，已颁发证书的持有者（在这种情况下是您的朋友“drbrain”）可以使用此签名证书来签名 RubyGems。顺便说一句，“drbrain”会将其新签名的证书保存为 ~/.gem/gem-public_cert.pem，以便让其他人知道他的新花哨签名证书。

显然，这个 RubyGems 信任基础设施尚未建立。此外，“现实世界”中，颁发者实际上是从证书请求生成子证书，而不是签名现有证书。而且我们的假设基础设施缺少一个证书吊销系统。这些是将来可以修复的问题……

至此，您应该知道如何执行所有这些新颖有趣的操作：

手动验证签名

如果您不信任 RubyGems，可以手动验证 gem 签名：

  1. 获取并解压 gem

    gem fetch some_signed_gem
tar -xf some_signed_gem-1.0.gem

  2. 从 gemspec 中获取公钥

    gem spec some_signed_gem-1.0.gem cert_chain | \
  ruby -rpsych -e 'puts Psych.load($stdin)' > public_key.crt

  3. 生成 data.tar.gz 的 SHA1 哈希

    openssl dgst -sha1 < data.tar.gz > my.hash

  4. 验证签名

    openssl rsautl -verify -inkey public_key.crt -certin \
  -in data.tar.gz.sig > verified.hash

  5. 将您的哈希与验证后的哈希进行比较

    diff -s verified.hash my.hash

  6. 对 metadata.gz 重复步骤 5 和 6

OpenSSL 参考

由 --build 和 --sign 生成的 .pem 文件是 PEM 文件。以下是一些有用的 OpenSSL 命令来操作它们：

# convert a PEM format X509 certificate into DER format:
# (note: Windows .cer files are X509 certificates in DER format)
$ openssl x509 -in input.pem -outform der -out output.der

# print out the certificate in a human-readable format:
$ openssl x509 -in input.pem -noout -text

您也可以对私钥文件执行相同的操作：

# convert a PEM format RSA key into DER format:
$ openssl rsa -in input_key.pem -outform der -out output_key.der

# print out the key in a human readable format:
$ openssl rsa -in input_key.pem -noout -text

错误/待办事项

原始作者

Paul Duncan <pabs@pablotron.org> pablotron.org/