DataSigner.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\FileDelivery\Token;
 
use ILIAS\FileDelivery\Token\Signer\Key\Secret\SecretKeyRotation;
use ILIAS\FileDelivery\Token\Signer\Payload\Payload;
use ILIAS\FileDelivery\Token\Signer\HMACSigner;
use ILIAS\FileDelivery\Token\Serializer\JSONSerializer;
use ILIAS\FileDelivery\Token\Signer\Key\Signing\HMACSigningKeyGenerator;
use ILIAS\FileDelivery\Token\Transport\URLSafeTransport;
use ILIAS\FileDelivery\Token\Compression\DeflateCompression;
use ILIAS\FileDelivery\Token\Signer\KeyRotatingSigner;
use ILIAS\FileDelivery\Token\Signer\Salt\Factory;
use ILIAS\FileDelivery\Token\Signer\Payload\StructuredPayload;
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\FileDelivery\Token\Compression\Compression;
use ILIAS\FileDelivery\Token\Transport\Transport;
use ILIAS\FileDelivery\Token\Signer\Payload\Builder;
use ILIAS\FileDelivery\Delivery\Disposition;
use ILIAS\FileDelivery\Token\Signer\Algorithm\ShortenedSHA1;
use ILIAS\FileDelivery\Token\Signer\Algorithm\Algorithm;
 
final class DataSigner implements DataSigning
{
    private SigningSerializer $signing_serializer;
    private Factory $salt_factory;
    private Builder $payload_builder;
 
    public function __construct(
        SecretKeyRotation $key_rotation,
        ?Algorithm $algorithm = null,
        ?Compression $compression = null,
        ?Transport $transport = null
    ) {
        $this->salt_factory = new Factory();
        $compression ??= new DeflateCompression();
        $transport ??= new URLSafeTransport();
        $algorithm ??= new ShortenedSHA1();
 
        $this->signing_serializer = new SigningSerializer(
            new KeyRotatingSigner(
                $key_rotation,
                new HMACSigner(
                    $algorithm
                ),
                new HMACSigningKeyGenerator(
                    $algorithm
                )
            ),
            new JSONSerializer(),
            $compression,
            $transport
        );
 
        $this->payload_builder = new Builder();
    }
 
    public function getSignedStreamToken(
        FileStream $stream,
        string $filename,
        Disposition $disposition,
        int $user_id,
        ?\DateTimeImmutable $until = null
    ): string {
        return $this->signStreamToken($stream, $filename, $until, true);
    }
 
    public function getSignedStreamTokenWithoutIsolation(
        FileStream $stream,
        string $filename,
        Disposition $disposition,
        int $user_id,
        ?\DateTimeImmutable $until = null
    ): string {
        return $this->signStreamToken($stream, $filename, $until, false);
    }
 
    private function signStreamToken(
        FileStream $stream,
        string $filename,
        ?\DateTimeImmutable $until,
        bool $isolated
    ): string {
        $payload = $this->payload_builder->shortFile(
            $stream,
            $filename,
            $isolated
        );
 
        if ($until !== null) {
            $payload->setUntil($until->getTimestamp());
        }
 
        return $this->signing_serializer->sign(
            $payload,
            $this->salt_factory->create('stream')
        );
    }
 
    public function verifyStreamToken(string $token): ?Payload
    {
        $data = $this->verify($token, 'stream');
        if ($data === null) {
            return null;
        }
        return $this->payload_builder->shortFileFromRaw($data);
    }
 
    public function sign(
        array $data,
        string $salt,
        ?\DateTimeImmutable $until = null
    ): string {
        $payload = new StructuredPayload($data);
 
        if ($until !== null) {
            $payload->setUntil($until->getTimestamp());
        }
 
        return $this->signing_serializer->sign(
            $payload,
            $this->salt_factory->create($salt)
        );
    }
 
    public function verify(
        string $token,
        string $salt
    ): ?array {
        return $this->signing_serializer->verify(
            $token,
            $this->salt_factory->create($salt)
        )?->get();
    }
}