Generate a url with an expiration date and signature to prevent unauthorized access

Fund package maintenance!

Installs: 1 247 927

Dependents: 18

Suggesters: 0

Security: 0

Stars: 414

Watchers: 15

Forks: 46

Open Issues: 1

2.1.1 2023-12-06 11:03 UTC


Latest Version on Packagist Software License Quality Score Total Downloads

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 Sha256UrlSigner('randomkey');

$urlSigner->sign('', 30);

// => The generated url will be valid for 30 seconds

This will output a URL that looks like

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:

// returns `true` if valid, `false` if not

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.


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.


The package can installed via Composer:

composer require spatie/url-signer


A signer-object can sign URLs and validate signed URLs. A secret key is used to generate signatures.

use Spatie\UrlSigner\Sha256UrlSigner;

$urlSigner = new Sha256UrlSigner('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('', $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 seconds.

$urlSigner->sign('', 30);

// => The generated URL will be valid for 30 seconds

Validating URLs

To validate a signed URL, simply call the validate() method. This will return a boolean.


// => true


// => false

Writing custom signers

This packages provides a signer that uses SHA256 to generate signature. You can create your own signer by implementing the Spatie\UrlSigner\Contracts\UrlSigner-interface. If you let your signer extend Spatie\UrlSigner\AbstractUrlSigner you'll only need to provide the createSignature-method.


The tests can be run with:

composer test


To get started quickly in Laravel you can use the spatie/laravel-url-signer package.


Please see CHANGELOG for more information what has changed recently.


Please see CONTRIBUTING for details.


If you've found a bug regarding security please mail instead of using the issue tracker.


About Spatie

Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.


The MIT License (MIT). Please see License File for more information.