Custom Signed Urls in Laravel

4.0.1 2022-01-11 00:21 UTC

This package is auto-updated.

Last update: 2022-05-12 00:28:12 UTC


This package is forked and repackaged version of the lab66/laravel-url-signer. This is to enable support for Laravel framework versions 6.x and onwards, and to be used as FileInvite internal package.

Create secured URLs with a (un)limited lifetime in Laravel

Latest Version on Packagist Build Status Quality Score SensioLabsInsight StyleCI 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.

Requires Laravel 5.3+.

This is how you can create signed URL that's valid for 30 minutes:

UrlSigner::sign('', 30);

The output will look like this:

The URL can be validated with the validate-function.


The package also provides a middleware to protect routes.


As you would have guessed the package can be installed via Composer:

composer require fileinvite-org/laravel-url-signer

To enable the package, register the serviceprovider, and optionally register the facade:

// config/app.php

'providers' => [

'aliases' => [
    'UrlSigner' => Lab66\UrlSigner\UrlSignerFacade::class,


The configuration file can optionally be published via:

php artisan vendor:publish --tag=url-signer

This is the contents of the file:

return [

     * The private key used to create the signature & sign the url.
    'private_key' => '-----BEGIN RSA PRIVATE KEY-----

     * The public key used to verify the signed url signature.
    'public_key' => '-----BEGIN PUBLIC KEY-----
-----END PUBLIC KEY-----',

     * The default expiration time of a URL in minutes.
    'default_expiration' => 60,

     * These strings are used a parameter names in a signed url.
    'parameters' => [
        'expires'   => 'expires',
        'signature' => 'signature',



Signing URLs

URL's can be signed with the sign-method:


By default the lifetime of an URL is one hour. This value can be change in the config-file. If you want a custom life time, you can specify the number of minutes the URL should be valid:

//the generated URL will be valid for 5 minutes.
UrlSigner::sign('', 5);

For fine grained control, you may also pass a DateTime instance as the second parameter. The url will be valid up to that moment. This example uses Carbon for convenience:

//This URL will be valid up until 2 days from the moment it was generated.
UrlSigner::sign('', Carbon::now()->addDays(2) );

Validating URLs

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


Protecting routes with middleware

The package also provides a middleware to protect routes:

Route::get('protected-route', ['middleware' => 'signed-url', function () {
    return 'Hello secret world!';

Your app will abort with a 403 status code if the route is called without a valid signature.

Regenerating keys

This package also exposes functions to regenerate the keys in your configuration, it might be good to do this after each deployment, this will invalidate all old signed urls.

php artisan url-signer:generate

You will need to have published the configuration file before running this command.

There is also an optional parameter for complexity of the key, depending on complexity this may affect speed of signing/validation.

php artisan url-signer:generate 4096


Please see CHANGELOG for more information what has changed recently.


$ vendor/bin/phpunit

Usage outside Laravel

If you're working on a non-Laravel project, you can use the framework agnostic version by Spatie.


Please see CONTRIBUTING for details.


If you discover any security related issues, please email or by using the issue tracker.



This project originated from but was rewritten to be an all inclusive package, with support for OpenSSL public/private keys.


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