dreamonkey/laravel-cloudfront-url-signer

Laravel 5.6+ 版的 CloudFront 缓存签名 URL 包装器

v3.4.0 2023-04-03 16:31 UTC

README

!!!! 本包不再维护 !!!! 可以自由地分支并开始维护自己的副本,我们可以在此链接流行的分支

在 Laravel 6+ 中创建 CloudFront 签名 URL

易于使用的 Laravel 6+ 包装器,围绕官方 AWS PHP SDK,允许通过 CloudFront CDN 访问私有内容

laravel-url-signer启发

Latest Version on Packagist Total Downloads

此包可以创建 CloudFront 的缓存策略签名 URL,该 URL 在指定时间后过期。这是通过包装 AWS SDK 方法,并添加 Laravel 风格的配置和可访问性来实现的。

以下是创建有效期为 30 天的签名 URL 的方法

// With Facade
CloudFrontUrlSigner::sign('https://myapp.com/resource', 30);

// With helper
sign('https://myapp.com/resource', 30);

输出符合CloudFront 规范

安装

该包可以通过 Composer 安装

composer require dreamonkey/laravel-cloudfront-url-signer

配置

配置文件可以通过以下方式可选发布

php artisan vendor:publish --provider="Dreamonkey\CloudFrontUrlSigner\CloudFrontUrlSignerServiceProvider"

这是文件的内容

return [
    /*
     * The default expiration time of a URL in days.
     */
    'default_expiration_time_in_days' => 1,

    /*
     * The private key used to sign all URLs.
     */
    'private_key_path' => storage_path(env('CLOUDFRONT_PRIVATE_KEY_PATH', 'trusted-signer.pem')),

    /*
     * Identifies the CloudFront key pair associated
     * to the trusted signer which validates signed URLs.
     */
    'key_pair_id' => env('CLOUDFRONT_KEY_PAIR_ID', ''),

    /*
     * CloudFront API version, by default it uses the latest available.
     */
    'version' => env('CLOUDFRONT_API_VERSION', 'latest'),

];

用法

签名 URL

URL 可以通过 sign 方法进行签名

CloudFrontUrlSigner::sign('https://myapp.com/resource');

默认情况下,URL 的生命周期为一天。此值可以在配置文件中更改。如果您想要自定义生命周期,可以指定 URL 应该有效的天数

// The generated URL will be valid for 5 days.
CloudFrontUrlSigner::sign('https://myapp.com/resource', 5);

为了更细粒度的控制,您也可以传递一个 DateTime 实例作为第二个参数。URL 将有效到该时刻。此示例使用 Carbon 以便于操作

// This URL will be valid up until 2 hours from the moment it was generated.
CloudFrontUrlSigner::sign('https://myapp.com/resource', Carbon\Carbon::now()->addHours(2) );

变更日志

请参阅CHANGELOG 了解最近更改的更多信息。

测试

$ vendor/bin/phpunit

贡献

请参阅CONTRIBUTING 了解详细信息。

安全性

如果您发现任何安全相关的问题,请通过电子邮件 p.caleffi@dreamonkey.com 反馈,而不是使用问题跟踪器。

致谢

许可

MIT 许可证 (MIT)。请参阅许可文件 了解更多信息。