Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kennethormandy/craft-s3securedownloads
https://github.com/kennethormandy/craft-s3securedownloads
craft-plugin craftcms-plugin
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kennethormandy/craft-s3securedownloads
- Owner: kennethormandy
- License: mit
- Created: 2019-12-03T23:25:34.000Z (about 5 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-07-16T22:21:12.000Z (5 months ago)
- Last Synced: 2024-10-14T11:49:08.177Z (2 months ago)
- Topics: craft-plugin, craftcms-plugin
- Language: PHP
- Size: 229 KB
- Stars: 4
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# S3 Secure Downloads plugin for Craft CMS
This plugin will return a [pre-signed URL](http://docs.aws.amazon.com/AmazonS3/latest/dev/ShareObjectPreSignedURL.html) used to allow temporary access to private objects with an expiring URL. You can optionally allow file downloads only for logged in users and force file downloads (useful for PDF files).
From the original developer, [Jonathan Melville](https://github.com/jonathanmelville/s3securedownloads):
> This plugin was originally developed for a client in the financial services industry who wanted to make sure only logged in users had access to downloads of financial reports, and download links couldn’t be shared. … Now you can keep your S3 objects private but grant temporary access to them with an expiring link.
## Installation
```sh
# Require the plugin with composer
composer require kennethormandy/craft-s3securedownloads
```
Then, install the plugin:
```sh
# Install the plugin via the Control Panel, or by running:
./craft plugin/install s3securedownloads
```
## Usage
Pass in an asset's entry id and it will return a pre-signed URL for that asset:
```twig
{% set asset = entry.myAssetField.one() %}
{{ asset }}
```
By default, only users logged in will be able to generate the pre-signed URL. This can be changed within the plugin settings.
The generated a pre-signed AWS S3 URL will expire after 24 hours, or however long you have configured in the plugin settings.
## Options
### `filename`
By default, the download will use the same filename as the Craft CMS asset. Alternatively, a custom filename can be passed to AWS instead. For example:
```twig
{% set asset = entry.myAssetField.one() %}
{{ asset }}
```
## Events
- `kennethormandy\s3securedownloads\services\SignUrl`
- `SignUrl::EVENT_BEFORE_SIGN_URL`
- `SignUrl::EVENT_AFTER_SIGN_URL`
```php
use Craft;
use yii\base\Event;
use kennethormandy\s3securedownloads\events\SignUrlEvent;
use kennethormandy\s3securedownloads\services\SignUrl;
// …
Event::on(
SignUrl::class,
SignUrl::EVENT_BEFORE_SIGN_URL,
function (SignUrlEvent $event) {
$asset = $event->asset;
Craft::info("Handle EVENT_BEFORE_SIGN_URL event here", __METHOD__);
}
);
Event::on(
SignUrl::class,
SignUrl::EVENT_AFTER_SIGN_URL,
function (SignUrlEvent $event) {
$asset = $event->asset;
Craft::info("Handle EVENT_AFTER_SIGN_URL event here", __METHOD__);
}
);
```
## Earlier versions
S3 Secure Downloads is available for Craft 3, 4, and 5. For a version that runs on Craft v2.5.x, see [the original plugin](https://github.com/jonathanmelville/s3securedownloads). [Note that as of June 24, 2020](https://aws.amazon.com/blogs/aws/amazon-s3-update-sigv2-deprecation-period-extended-modified/) all new AWS S3 buckets require URLs to be signed using Signature Version 4, and the original plugin (understandably) only signs URLs using Signature Version 2.
## License
[The MIT License (MIT)](./LICENSE.md)
Copyright © 2016–2019 [Jonathan Melville](https://github.com/jonathanmelville/s3securedownloads)
Copyright © 2019–2024 [Kenneth Ormandy Inc.](https://kennethormandy.com)
%20}}){kind=link}