GPGME 项目技术文档

本文档将详细介绍如何安装、使用以及 API 调用 GPGME 项目。

1. 安装指南

GPGME 项目依赖于以下环境：

• Ruby 1.8 或更高版本
• GPGME 1.1.2 或更高版本
• gpg-agent（可选，但推荐使用）

安装步骤如下：

gem install gpgme

2. 项目使用说明

GPGME 提供了三种级别的 API。最高级别的 API 非常简单，中等级别的 API 提供更多功能，但可能不太用户友好，而最低级别的 API 接近 GPGME 的 C 接口。

2.1 高级别 API 使用示例

例如，要创建一个纯文本的清晰签名并将其输出到 stdout，可以按如下方式编写：

crypto = GPGME::Crypto.new
crypto.clearsign $stdin, :output => $stdout

2.2 中级别 API 使用示例

同样的示例可以用中级别 API 重写如下：

plain = GPGME::Data.new($stdin)
sig = GPGME::Data.new($stdout)
GPGME::Ctx.new do |ctx|
  ctx.sign(plain, sig, GPGME::SIG_MODE_CLEAR)
end

2.3 最低级别 API 使用示例

同样的示例可以用最低级别 API 重写如下：

ret = []
GPGME::gpgme_new(ret)
ctx = ret.shift
GPGME::gpgme_data_new_from_fd(ret, 0)
plain = ret.shift
GPGME::gpgme_data_new_from_fd(ret, 1)
sig = ret.shift
GPGME::gpgme_op_sign(ctx, plain, sig, GPGME::SIG_MODE_CLEAR)

3. 项目 API 使用文档

以下是 GPGME 项目的 API 文档。

3.1 Crypto 类

GPGME::Crypto 类提供了加密、解密、签名和验证签名的便捷方法。以下是一些示例：

• 文档加密：

  crypto = GPGME::Crypto.new
  crypto.encrypt "Hello world!", :recipients => "[e-mail]"
  

• 对称加密：

  crypto = GPGME::Crypto.new :password => "gpgme"
  crypto.encrypt "Hello world!", :symmetric => true
  

• 文档解密（包括签名验证）：

  crypto.decrypt File.open("text.gpg")
  

• 文档签名：

  crypto.sign "I hereby proclaim Github the beneficiary of all my money when I die"
  

• 签名验证：

  sign = crypto.sign "Some text"
  data = crypto.verify(sign) { |signature| signature.valid? }
  

3.2 Key 类

GPGME::Key 对象表示一个密钥，并提供了与密钥相关的高级方法，用于查找、导出、导入、删除和创建密钥。

• 密钥列表：

  GPGME::Key.find(:secret, "[e-mail]")
  

• 密钥导出：

  GPGME::Key.export("[e-mail]")
  

• 密钥导入：

  GPGME::Key.import(File.open("my.key"))
  

• 密钥验证：

  GPGME::Key.valid?(public_key)
  

3.3 Engine 类

GPGME::Engine 类提供了三种便捷方法，用于获取当前使用的 gpg 引擎信息。

• 获取当前信息：

  GPGME::Engine.info.first
  

• 更改家目录以使用不同设置：

  GPGME::Engine.home_dir = '/tmp'
  

4. 项目安装方式

请参考上述“安装指南”部分。

以上是 GPGME 项目的详细技术文档，希望对您有所帮助。