Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spiral-packages/signed-urls
Create and validate signed URLs in Spiral Framework. PSR-7 compatible
https://github.com/spiral-packages/signed-urls
component php php81 psr-7 signature spiral-framework url-generator
Last synced: 2 months ago
JSON representation
Create and validate signed URLs in Spiral Framework. PSR-7 compatible
- Host: GitHub
- URL: https://github.com/spiral-packages/signed-urls
- Owner: spiral-packages
- License: mit
- Created: 2022-06-16T19:22:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T04:10:11.000Z (over 1 year ago)
- Last Synced: 2024-10-01T18:10:53.330Z (3 months ago)
- Topics: component, php, php81, psr-7, signature, spiral-framework, url-generator
- Language: PHP
- Homepage:
- Size: 33.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Signed URL generator for Spiral Framework based on Laravel
[](https://packagist.org/packages/spiral-packages/signed-urls)
[](https://packagist.org/packages/spiral-packages/signed-urls)
[](https://github.com/spiral-packages/signed-urls/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://packagist.org/packages/spiral-packages/signed-urls)
The package allows you to easily create "signed" URLs to named routes. These URLs have a "signature" hash appended to
the query string which allows Spiral Framework to verify that the URL has not been modified since it was created.
Signed URLs are especially useful for routes that are publicly accessible yet need a layer of protection against URL
manipulation.
## Requirements
Make sure that your server is configured with following PHP version and extensions:
- PHP 8.1+
- Spiral framework 3.0+
## Installation
You can install the package via composer:
```bash
composer require spiral-packages/signed-urls
```
After package install you need to register bootloader from the package.
```php
protected const LOAD = [
// ...
\Spiral\SignedUrls\Bootloader\SignedUrlsBootloader::class,
];
```
> **Note**
> if you are using [`spiral-packages/discoverer`](https://github.com/spiral-packages/discoverer),
> you don't need to register bootloader by yourself.
Specify env variables
```dotenv
# Secret key for generating the HMAC variant of the message digest.
# REQUIRED
SIGNED_URLS_KEY=secret
# Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..)
# OPTIONAL (sha256 by default)
SIGNED_URLS_ALGO=sha256
```
## Usage
For example, you might use signed URLs to implement a public "email verification" link that is emailed to your
customers:
```php
class VerifyEmailNotification
{
public function __construct(
private readonly \Spiral\SignedUrls\UrlGeneratorInterface $urls
private readonly \Spiral\Views\ViewInterface $view
) {}
public function buildView(): string
{
return $this->view->render([
'signed_url' => $this->urls->signedRoute(
route: 'verify-email',
parameters: ['user_id' => 100]
)
]);
}
}
```
If you would like to generate a temporary signed route URL that expires after a specified amount of time, you may pass
expiration date in method. When Spiral Framework validates a temporary signed route URL, it will ensure that the
expiration timestamp that is encoded into the signed URL has not expired:
```php
class VerifyEmailNotification
{
public function __construct(
private readonly \Spiral\SignedUrls\UrlGeneratorInterface $urls
private readonly \Spiral\Views\ViewInterface $view
) {}
public function buildView(): string
{
return $this->view->render([
'signed_url' => $this->urls->signedRoute(
route: 'verify-email',
parameters: ['user_id' => 100],
expiration: new \DateTime('...')
)
]);
}
}
```
You may sign not only routes but also Urls:
```php
class VerifyEmailNotification
{
public function __construct(
private readonly \Spiral\SignedUrls\UrlGeneratorInterface $urls
private readonly \Spiral\Views\ViewInterface $view
) {}
public function buildView(): string
{
return $this->view->render([
'signed_url' => $this->urls->signedUrl(
uri: new \Nyholm\Psr7\Uri('http://site.com/verify-email/?user_id=1'),
expiration: new \DateTime('...')
)
]);
}
}
```
### Validating Signed Urls
To verify that a URL has a valid signature, you should call the hasValidSignature method:
```php
class EmailVerificationController
{
public function __construct(
private readonly \Spiral\SignedUrls\UrlGeneratorInterface $urls
) {}
public function verify(\Psr\Http\Message\RequestInterface $request): string
{
if (!$this->urls->hasValidSignature($request->getUri())) {
return 'ERROR';
}
return 'OK';
}
}
```
Instead of validating signed URLs using the incoming request instance, you may assign the
`Spiral\SignedUrls\Middleware\ValidateSignature` middleware to the route:
```php
class EmailVerificationController
{
public function __construct(
private readonly \Spiral\SignedUrls\UrlGeneratorInterface $urls
) {}
#[\Spiral\Router\Annotation\Route(
name: 'verify-email',
route: '...',
middleware: \Spiral\SignedUrls\Middleware\ValidateSignature::class
)]
public function verify(\Psr\Http\Message\RequestInterface $request): string
{
return 'OK';
}
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Pavel Buchnev](https://github.com/butschster)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.