dcodegroup / laravel-cloudfront-url-signer
Laravel 5.6+ 版 CloudFront 缓存签名的包装器
3.6
2024-07-10 23:23 UTC
Requires
- php: ^7.3.0|^8.0
- aws/aws-sdk-php: ^3.52
- illuminate/support: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^6.0|^8.0|^9.0
- phpunit/phpunit: ^8.0|^9.0|^10.5
This package is auto-updated.
Last update: 2024-09-10 23:44:49 UTC
README
易于使用的 Laravel 6+ 版 AWS PHP SDK 包装器,允许通过 CloudFront CDN 访问私有内容
受 laravel-url-signer 启发
此包可以创建 CloudFront 的签名字段签名的 URL,该 URL 在指定时间后过期。这是通过包装 AWS SDK 方法并添加 Laravel 风格的配置和访问性来完成的。
以下是如何创建有效期为 30 天的签名字符串的方法
// 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
可以使用 sign
方法签名 URL
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)。有关更多信息,请参阅 许可证文件