README

复制自 UrlSignerBundle 包。根据个人需求进行了修改。

安装

composer.json

    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/proklung/url.signer.bundle"
        }
    ]

composer require proklung/url-signer-bundle

配置示例

url_signer:
  signature_key: 'testkey'
  signer: 'md5' # 'sha256' by default
  default_expiration: 24 # 1 day by default
  expires_parameter: 'expires' # 'expires' by default
  signature_parameter: 'signature' # 'signature' by default

原始文档

在 Symfony 中创建和验证有限生命周期的签名 URL。

此包基于 spatie/url-signer。

## Configuration

Add a signature key (as environment variable):

```yml
# config/packages/url_signer.yaml
url_signer:
    signature_key: '%env(string:SIGNATURE_KEY)%'

在开发模式下，您可以使用 .env 文件

# .env (or .env.local)
SIGNATURE_KEY=your_signature_key

您还可以更改用于创建签名的签名者

# config/packages/url_signer.yaml
url_signer:
    signer: 'md5' # 'sha256' by default

默认过期时间（以天为单位）也可以更改

# config/packages/url_signer.yaml
url_signer:
    default_expiration: 3 # 1 by default

您还可以自定义 URL 参数名称

# config/packages/url_signer.yaml
url_signer:
    expires_parameter: 'exp' # 'expires' by default
    signature_parameter: 'sign' # 'signature' by default

使用方法

生成签名 URL

要为路由创建临时签名 URL，您首先需要将 URL 签名者注入到您的服务或控制器中

// src/Controller/DocumentController.php
namespace App\Controller;

use CoopTilleuls\UrlSignerBundle\UrlSigner\UrlSignerInterface;

class DocumentController
{
    public function __construct(
        private UrlSignerInterface $urlSigner,
    ) {}
}

如果您的应用程序启用了自动绑定（默认 Symfony 配置），您就无需做更多操作。

否则，在配置中注入 url_signer.signer 服务

# config/services.yaml
services:
    App\Controller\DocumentController:
        arguments:
            $urlSigner: '@url_signer.signer'

现在您可以使用 URL 签名者生成签名 URL

// src/Controller/DocumentController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class DocumentController extends AbstractController
{
    private function generateSignedUrl(): string
    {
        $url = $this->generateUrl('secured_document', ['id' => 42]);
        // Will expire after one hour.
        $expiration = (new \DateTime('now'))->add(new \DateInterval('PT1H'));
        // An integer can also be used for the expiration: it will correspond to a number of days. For 3 days:
        // $expiration = 3;

        // Not passing the second argument will use the default expiration time (1 day by default).
        // return $this->urlSigner->sign($url);

        // Will return a URL (more precisely a path) like this: /documents/42?expires=1611316656&signature=82f6958bd5c96fda58b7a55ade7f651fadb51e12171d58ed271e744bcc7c85c3
        return $this->urlSigner->sign($url, $expiration);
    }
}

验证签名路由请求

要拒绝访问签名无效的路由，请将 _signed 额外参数 添加到路由配置中

# config/routes.yaml
secured_document:
    path: /documents/{id}
    controller: App\Controller\DocumentController::index
    defaults:
        _signed: true

如果签名无效（签名错误或 URL 已过期），请求将收到 403 响应（拒绝访问）。

自定义签名者

如果您需要使用特定的哈希算法生成签名，您可以创建自己的签名者。

创建一个扩展 AbstractUrlSigner 类的类

// src/UrlSigner/CustomUrlSigner.php
namespace App\UrlSigner;

use CoopTilleuls\UrlSignerBundle\UrlSigner\AbstractUrlSigner;
use Psr\Http\Message\UriInterface;

class CustomUrlSigner extends AbstractUrlSigner
{
    public static function getName(): string
    {
        return 'custom';
    }

    protected function createSignature(UriInterface|string $url, string $expiration): string
    {
        $url = (string) $url;

        return hash_hmac('algo', "{$url}::{$expiration}", $this->signatureKey);
    }
}

如果您的应用程序启用了自动配置（默认 Symfony 配置），您就完成了。

否则，注册并标记您的服务

# config/services.yaml
services:
    App\UrlSigner\CustomUrlSigner:
        # You don't need to specify the arguments
        tags: ['url_signer.signer']

现在您可以使用您自定义的签名者

# config/packages/url_signer.yaml
coop_tilleuls_url_signer:
    signer: 'custom'

致谢

由 Alan Poulain 为 Les-Tilleuls.coop 创建。