ILIAS\FileDelivery\Token\DataSigner Class Reference

Collaboration diagram for ILIAS\FileDelivery\Token\DataSigner:

Public Member Functions
	__construct (SecretKeyRotation $key_rotation)
	getSignedStreamToken (FileStream $stream, string $filename, Disposition $disposition, int $user_id, ?\DateTimeImmutable $until=null)
	verifyStreamToken (string $token)
	sign (array $data, string $salt, ?\DateTimeImmutable $until=null)
	verify (string $token, string $salt)

Private Attributes
Signer	$signer
Serializer	$serializer
SigningSerializer	$signing_serializer
Factory	$salt_factory
Compression	$compression
Transport	$transport
Builder	$payload_builder

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 46 of file DataSigner.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Token\DataSigner::__construct

(

SecretKeyRotation

$key_rotation

)

Definition at line 56 of file DataSigner.php.

      {
        $this->salt_factory = new Factory();
        $compression = new DeflateCompression();
        $transport = new URLSafeTransport();
        $algorithm = new SHA1();

        $this->signing_serializer = new SigningSerializer(
            new KeyRotatingSigner(
                $key_rotation,
                new HMACSigner(
                    $algorithm
                ),
                new HMACSigningKeyGenerator(
                    $algorithm
                )
            ),
            new JSONSerializer(),
            $compression,
            $transport
        );

        $this->payload_builder = new Builder();
    }

Member Function Documentation

getSignedStreamToken()

ILIAS\FileDelivery\Token\DataSigner::getSignedStreamToken	(	FileStream	$stream,
		string	$filename,
		Disposition	$disposition,
		int	$user_id,
		?\DateTimeImmutable	$until = null
	)

Definition at line 82 of file DataSigner.php.

References $payload, and null.

     : string {
        $payload = $this->payload_builder->shortFile(
            $stream,
            $filename
        );

        if ($until !== null) {
            $payload->setUntil($until->getTimestamp());
        }

        return $this->signing_serializer->sign(
            $payload,
            $this->salt_factory->create('stream')
        );
    }

sign()

ILIAS\FileDelivery\Token\DataSigner::sign	(	array	$data,
		string	$salt,
		?\DateTimeImmutable	$until = null
	)

Definition at line 113 of file DataSigner.php.

References $payload, and null.

     : string {
        $payload = new StructuredPayload($data);

        if ($until !== null) {
            $payload->setUntil($until->getTimestamp());
        }

        return $this->signing_serializer->sign(
            $payload,
            $this->salt_factory->create($salt)
        );
    }

verify()

ILIAS\FileDelivery\Token\DataSigner::verify	(	string	$token,
		string	$salt
	)

Definition at line 130 of file DataSigner.php.

Referenced by ILIAS\FileDelivery\Token\DataSigner\verifyStreamToken().

     : ?array {
        return $this->signing_serializer->verify(
            $token,
            $this->salt_factory->create($salt)
        )?->get();
    }

Here is the caller graph for this function:

verifyStreamToken()

ILIAS\FileDelivery\Token\DataSigner::verifyStreamToken

(

string

$token

)

Definition at line 104 of file DataSigner.php.

References $data, null, and ILIAS\FileDelivery\Token\DataSigner\verify().

                                                    : ?Payload
    {
        $data = $this->verify($token, 'stream');
        if ($data === null) {
            return null;
        }
        return $this->payload_builder->shortFileFromRaw($data);
    }

Here is the call graph for this function:

Field Documentation

$compression

Compression ILIAS\FileDelivery\Token\DataSigner::$compression

private

Definition at line 52 of file DataSigner.php.

$payload_builder

Builder ILIAS\FileDelivery\Token\DataSigner::$payload_builder

private

Definition at line 54 of file DataSigner.php.

$salt_factory

Factory ILIAS\FileDelivery\Token\DataSigner::$salt_factory

private

Definition at line 51 of file DataSigner.php.

$serializer

Serializer ILIAS\FileDelivery\Token\DataSigner::$serializer

private

Definition at line 49 of file DataSigner.php.

$signer

Signer ILIAS\FileDelivery\Token\DataSigner::$signer

private

Definition at line 48 of file DataSigner.php.

$signing_serializer

SigningSerializer ILIAS\FileDelivery\Token\DataSigner::$signing_serializer

private

Definition at line 50 of file DataSigner.php.

$transport

Transport ILIAS\FileDelivery\Token\DataSigner::$transport

private

Definition at line 53 of file DataSigner.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/FileDelivery/src/Token/DataSigner.php