Create secured URLs with a limited lifetime
This package can create URLs with a limited lifetime. This is done by adding an expiration date and a signature to the URL.
$urlSigner = new MD5UrlSigner('randomkey');
$urlSigner->sign('https://myapp.com', 30);
// => The generated url will be valid for 30 days
This will output an URL that looks like https://myapp.com/?expires=xxxx&signature=xxxx.
Imagine mailing this URL out to the users of your application. When a user clicks on a signed URL your application can validate it with:
$urlSigner->validate('https://myapp.com/?expires=xxxx&signature=xxxx');
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
All postcards are published on our website.
Installation
The package can installed via Composer:
composer require spatie/url-signer
Usage
A signer-object can sign URLs and validate signed URLs. A secret key is used to generate signatures.
use Spatie\UrlSigner\MD5UrlSigner;
$urlSigner = new MD5UrlSigner('mysecretkey');
Generating URLs
Signed URLs can be generated by providing a regular URL and an expiration date to the sign method.
$expirationDate = (new DateTime)->modify('10 days');
$urlSigner->sign('https://myapp.com', $expirationDate);
// => The generated url will be valid for 10 days
If an integer is provided as expiration date, the url will be valid for that amount of days.
$urlSigner->sign('https://myapp.com', 30);
// => The generated url will be valid for 30 days
Validating URLs
To validate a signed URL, simply call the validate() method. This will return a boolean.
$urlSigner->validate('https://myapp.com/?expires=1439223344&signature=2d42f65bd023362c6b61f7432705d811');
// => true
$urlSigner->validate('https://myapp.com/?expires=1439223344&signature=2d42f65bd0-INVALID-23362c6b61f7432705d811');
// => false
Writing custom signers
This packages provides a signer that uses md5 to generate signature. You can create your own signer by implementing the Spatie\UrlSigner\UrlSigner-interface. If you let your signer extend Spatie\UrlSigner\BaseUrlSigner you'll only need to provide the createSignature-method.
Tests
The tests can be run with:
$ vendor/bin/phpspec run
Integrations
To get started quickly in Laravel you can use the spatie/laravel-url-signer package.
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Credits
About Spatie
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.
82 Jan 16, 2022
3 Apr 12, 2022
501 Jan 4, 2023
401 Dec 22, 2022
1.2k Jan 4, 2023
773 Dec 30, 2022
61 Dec 6, 2022
3 Jan 6, 2022
530 Jan 6, 2023
2 Jan 8, 2022
289 Dec 5, 2022
19.1k Jan 2, 2023
54 Dec 16, 2022
4 Oct 29, 2022
349 Dec 31, 2022
45 Dec 31, 2022
307 Dec 23, 2022
8 Aug 17, 2022
5 Jul 26, 2022
16 Aug 29, 2020