AWS CF Signer 使用与技术文档

1. 安装指南

通过Gemfile安装

在您的Gemfile文件中添加以下代码：

gem 'aws_cf_signer'

然后运行bundle install命令以安装aws_cf_signer。

直接安装

您也可以直接在系统上安装aws_cf_signer：

gem install aws_cf_signer

2. 项目使用说明

aws_cf_signer是一个小型的Ruby宝石，用于签署AWS CloudFront URL，需要提供一个AWS密钥对ID和PEM文件。以下是使用方法：

# 从文件系统中提供私钥路径
signer = AwsCfSigner.new('/path/to/my/pk-1234567890.pem')

# 如果私钥文件名不包含key_pair_id，需要作为第二个参数传递
signer = AwsCfSigner.new('/path/to/my/private-key.pem', '1234567890')

# 如果您的私钥不在文件系统中，可以显式传递，此时也需要提供key_pair_id
signer = AwsCfSigner.new(ENV["CLOUDFRONT_PRIVATE_KEY"], '1234567890')

# 必须提供过期日期
url = signer.sign('http://d604721fxaaqy9.cloudfront.net/horizon.jpg?large=yes&license=yes', :ending => 'Sat, 14 Nov 2009 22:20:00 GMT')

# 也可以使用Time对象
url = signer.sign('http://d604721fxaaqy9.cloudfront.net/horizon.jpg?large=yes&license=yes', :ending => Time.now + 3600)

3. 项目API使用文档

以下是aws_cf_signer提供的API使用方法：

签署URL

使用私钥签署一个URL，必须指定过期时间：

signer.sign(url, options)

options参数可以包括：

• :ending：URL过期的日期，可以是字符串或Time对象。
• :starting：URL生效的起始日期（可选）。
• :resource：要签署的资源路径。
• :ip_range：允许访问的IP范围。
• :policy_file：提供策略文件的路径。

4. 项目安装方式

请参考上述“安装指南”部分，安装aws_cf_signer可以通过Gemfile或直接使用gem命令。

使用本技术文档，用户可以快速了解如何在项目中集成和使用aws_cf_signer，以及如何通过API进行URL的签名。遵循以上指南，用户可以有效地利用AWS CloudFront服务进行资源的安全分发。