README

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

此包基于 spatie/url-signer。

安装

确保已全局安装Composer，如Composer文档中的安装章节中所述。

打开命令行，进入项目目录并执行

composer require tilleuls/url-signer-bundle

如果您使用Symfony Flex，所有配置已经完成。您可以在config/packages/url_signer.yaml文件中自定义它。

否则，通过将其添加到项目的config/bundles.php文件中注册的包列表中来启用此包

// config/bundles.php

return [
    // ...
    CoopTilleuls\UrlSignerBundle\CoopTilleulsUrlSignerBundle::class => ['all' => true],
];

配置

添加签名密钥（作为环境变量）

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

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

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

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

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

默认过期时间也可以更改。

以秒为单位

# config/packages/url_signer.yaml
coop_tilleuls_url_signer:
    default_expiration: 3600 # 86400 by default

使用日期/时间字符串

# config/packages/url_signer.yaml
coop_tilleuls_url_signer:
    default_expiration: '1 day'

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

# config/packages/url_signer.yaml
coop_tilleuls_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
    {
        // Or $url = $this->generateUrl('secured_document', ['id' => 42], UrlGeneratorInterface::ABSOLUTE_URL);
        $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 seconds. For 1 hour:
        // $expiration = 3600;

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

        // Will return a path like this: /documents/42?expires=1611316656&signature=82f6958bd5c96fda58b7a55ade7f651fadb51e12171d58ed271e744bcc7c85c3
        // Or a URL depending on what has been signed before.
        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;

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

    protected function createSignature(string $url, string $expiration, string $signatureKey): string
    {
        return hash_hmac('algo', "{$url}::{$expiration}", $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创建。