coppolafab/php-url-signer

This package is abandoned and no longer maintained. No replacement package was suggested.

Create signed URLs with an expiring date

v3.0.0 2020-12-28 14:07 UTC

Requires

• php: ~7.4 || ~8.0.0

Requires (Dev)

• ext-phar: *
• infection/infection: ^0.20.2
• phpstan/phpstan: ^0.12.64
• phpunit/phpunit: ^9.5.0
• squizlabs/php_codesniffer: ^3.5
• vimeo/psalm: ^4.3

Conflicts

• thecodingmachine/safe: <1.1.3

ISC

• Fabio Coppola

• url
• link
• signed
• expire

README

A PHP library for signing URLs and verify their validity.

It works by appending a computed signature and an expiring timestamp to an URL. The generated URL is valid if its data is not altered in any way and until the specified expiring time.

A signed URL possession, provides limited time to perform a request, and can transport publicly visible query parameters, for example tokens and other not sensitive data, without the need to store them in a backend storage like session or cache.

Some use cases:

• Login links
• Password reset links
• Email confirmation links
• etc.

Installation

Install via Composer:

composer require coppolafab/php-url-signer

Usage

use coppolafab\UrlSigner\HashHmacUrlSigner;
use DateTimeImmutable;

$urlSigner = new HashHmacUrlSigner('valid'  /** signature key */);

// valid until 2020-09-13T12:26:40+00:00
$expirationDate = (new DateTimeImmutable())->setTimestamp(1600000000);

$signedUrl = $urlSigner->sign('https://example.com/', $expirationDate);
// 'https://example.com/?url_expires_at=1600000000&signature=d6ebe19e590813d94d1b58fe9f9e204a3c5f074ac791dbf0fc2bc3631091f2f1'


$isValid = $urlSigner->verify($signedUrl);
// true, if verified before $expirationDate

Testing

• Coding Style: $ vendor/bin/phpcs
• Unit tests: $ vendor/bin/phpunit
• Static analysis - PHPStan: $ vendor/bin/phpstan analyse
• Static analysis - Psalm: $ vendor/bin/psalm
• Mutation Testing - Infection: vendor/bin/infection

Docker

A docker-compose.yml file is included, with a pre-configured image that builds PHP8 and pcov.

# build image
docker-compose build
# install dependencies
docker-compose run --rm php-url-signer composer install
# run tests
docker-compose run --rm php-url-signer vendor/bin/phpunit
docker-compose run --rm php-url-signer ...