haridarshan/laravel-url-signer-cloudfront

Wrapper around the official AWS PHP SDK to generate CloudFront signed URLs

v1.0.0 2024-10-09 16:41 UTC

Requires

• php: >=7.4
• aws/aws-sdk-php-laravel: ^3.0
• illuminate/config: ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
• illuminate/support: ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
• vlucas/phpdotenv: ^3.3 || ^4.0 || ^5.0 || ^5.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• phpunit/phpunit: ^9.5 || ^10.0 || ^11.0
• vimeo/psalm: ^5.0

MIT

• Hari Darshan Gorana

• aws
• cloudfront
• aws-php-sdk
• private content
• signed-url
• aws-sdk-php-laravel
• signed-cookie
• laravel-url-signer-cloudfront

README

This a simple wrapper around the official AWS PHP Laravel SDK to generate CloudFront signed URLs

Installation

The package can be installed via Composer:

composer require haridarshan/laravel-url-signer-cloudfront

Configuration

With Laravel

By default, the package uses the following environment variables to auto-configure the plugin without modification:

AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_REGION

To customize the configuration file, publish the package configuration using Artisan.

php artisan vendor:publish --provider="Haridarshan\Laravel\UrlSigner\AwsCloudFront\CloudFrontServiceProvider"

The settings can be found in the generated config/aws.php and config/cloudfront.php configuration file. By default, the credentials and region settings will pull from your .env file.

config/aws.php (published by Aws\Laravel\AwsServiceProvider)

return [
    'credentials' => [
        'key'    => env('AWS_ACCESS_KEY_ID', ''),
        'secret' => env('AWS_SECRET_ACCESS_KEY', ''),
    ],
    'region' => env('AWS_REGION', 'us-east-1'),
    'version' => 'latest',
    
    // You can override settings for specific services
    'Ses' => [
        'region' => 'us-east-1',
    ],
];

config/cloudfront.php

return [
    'default_expiration_time_in_seconds' => 60 * 60 * 24,
    'private_key_path' => get_base_path(env('CLOUDFRONT_PRIVATE_KEY_PATH', '')),
    'key_pair_id' => env('CLOUDFRONT_KEY_PAIR_ID', ''),
];

Please Note: Add CLOUDFRONT_PRIVATE_KEY_PATH and CLOUDFRONT_KEY_PAIR_ID in .env file

Usage

Signing CloudFront URLs for private distributions

With Default configuration

$url = config('filesystems.disks.s3.url') . '/example.mp4';

// Signed CloudFront URL with 1 day expiry
echo \Haridarshan\Laravel\UrlSigner\AwsCloudFront\Facades\CloudFrontFacade::signedUrl($url);

With custom expiry

$url = config('filesystems.disks.s3.url') . '/example.mp4';
$expiry = 60 * 60; // Optional in seconds (Default: 1 day)

// Signed CloudFront URL with 1 hour expiry
echo \Haridarshan\Laravel\UrlSigner\AwsCloudFront\Facades\CloudFrontFacade::signedUrl(
    $url,
    $expiry
);

Use a custom policy to create CloudFront URLs

$url = config('filesystems.disks.s3.url') . '/example.mp4';
$policy = <<<POLICY
{
  "Statement": [
      {
          "Resource": "{$url}",
          "Condition": {
              "IpAddress": {"AWS:SourceIp": "{$_SERVER['REMOTE_ADDR']}/32"},
              "DateLessThan": {"AWS:EpochTime": 3600}
          }
      }
  ]
}
POLICY;

// Signed CloudFront URL with custom policy 
echo \Haridarshan\Laravel\UrlSigner\AwsCloudFront\Facades\CloudFrontFacade::signedUrl(
    $url,
    null,
    $policy
);

Signing CloudFront cookies for private distributions

With Default configuration

$url = config('filesystems.disks.s3.url') . '/example.mp4';

// CloudFront Signed Cookies with 1 day expiry
result = \Haridarshan\Laravel\UrlSigner\AwsCloudFront\Facades\CloudFrontFacade::signedCookie($url);

/* If successful, returns something like:
CloudFront-Expires = 1589926678
CloudFront-Signature = Lv1DyC2q...2HPXaQ__
CloudFront-Key-Pair-Id = AAPKAJIKZATYYYEXAMPLE
*/
foreach($result as $key => $value) {
    echo $key . ' = ' . $value . "\n";
}

Use a custom policy to create CloudFront cookies

$url = config('filesystems.disks.s3.url') . '/example.mp4';
$policy = <<<POLICY
{
  "Statement": [
      {
          "Resource": "{$url}",
          "Condition": {
              "IpAddress": {"AWS:SourceIp": "{$_SERVER['REMOTE_ADDR']}/32"},
              "DateLessThan": {"AWS:EpochTime": 3600}
          }
      }
  ]
}
POLICY;

// CloudFront Signed Cookies with custom policy 
$result = \Haridarshan\Laravel\UrlSigner\AwsCloudFront\Facades\CloudFrontFacade::signedUrl(
    null,
    null,
    $policy
);

Outside Laravel Application

require_once "vendor/autoload.php";

$url = "https://example.cloudfront.net/test.mp4";

Dotenv::create(
    Env::getRepository(),
    get_base_path(),
    '.env'
)->safeLoad();

$cloudfront = new \Haridarshan\Laravel\UrlSigner\AwsCloudFront\CloudFront(
    (new Sdk([
        'credentials' => [
            'key'    => env('AWS_ACCESS_KEY_ID', ''),
            'secret' => env('AWS_SECRET_ACCESS_KEY', ''),
        ],
        'region' => env('AWS_REGION', ''),
        'version' => 'latest',
    ]))->createClient('cloudfront'),
    [
        'key_pair_id' => env('CLOUDFRONT_KEY_PAIR_ID', ''),
        'private_key_path' => env('CLOUDFRONT_PRIVATE_KEY_PATH', '')
    ]
);

$signedUrl = $cloudfront->signedUrl($url);