ILIAS\FileDelivery\Token\DataSigner Class Reference

Inheritance diagram for ILIAS\FileDelivery\Token\DataSigner:

Collaboration diagram for ILIAS\FileDelivery\Token\DataSigner:

Public Member Functions
	__construct (SecretKeyRotation $key_rotation, ?Algorithm $algorithm=null, ?Compression $compression=null, ?Transport $transport=null)
	getSignedStreamToken (FileStream $stream, string $filename, Disposition $disposition, int $user_id, ?\DateTimeImmutable $until=null)
	getSignedStreamTokenWithoutIsolation (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)
	getSignedStreamToken (FileStream $stream, string $filename, Disposition $disposition, int $user_id, ?\DateTimeImmutable $until=null)
	getSignedStreamTokenWithoutIsolation (FileStream $stream, string $filename, Disposition $disposition, int $user_id, ?\DateTimeImmutable $until=null)
	Signs the token for delivery on the ILIAS domain instead of the content domain of User Content Isolation. More...
	verifyStreamToken (string $token)
	sign (array $data, string $salt, ?\DateTimeImmutable $until=null)
	verify (string $token, string $salt)

Private Member Functions
	signStreamToken (FileStream $stream, string $filename, ?\DateTimeImmutable $until, bool $isolated)

Private Attributes
SigningSerializer	$signing_serializer
Factory	$salt_factory
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 44 of file DataSigner.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Token\DataSigner::__construct	(	SecretKeyRotation	$key_rotation,
		?Algorithm	$algorithm = null,
		?Compression	$compression = null,
		?Transport	$transport = null
	)

Definition at line 50 of file DataSigner.php.

      {
        $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();
    }

Member Function Documentation

getSignedStreamToken()

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

Implements ILIAS\FileDelivery\Token\DataSigning.

Definition at line 79 of file DataSigner.php.

     : string {
        return $this->signStreamToken($stream, $filename, $until, true);
    }

getSignedStreamTokenWithoutIsolation()

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

Deprecated:

see {

See also

DataSigning::getSignedStreamTokenWithoutIsolation()}

Implements ILIAS\FileDelivery\Token\DataSigning.

Definition at line 92 of file DataSigner.php.

     : string {
        return $this->signStreamToken($stream, $filename, $until, false);
    }

sign()

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

Implements ILIAS\FileDelivery\Token\DataSigning.

Definition at line 133 of file DataSigner.php.

     : string {
        $payload = new StructuredPayload($data);
 
        if ($until !== null) {
            $payload->setUntil($until->getTimestamp());
        }
 
        return $this->signing_serializer->sign(
            $payload,
            $this->salt_factory->create($salt)
        );
    }

References ILIAS\FileDelivery\Token\Signer\Payload\StructuredPayload\setUntil().

Here is the call graph for this function:

signStreamToken()

ILIAS\FileDelivery\Token\DataSigner::signStreamToken ( FileStream  $stream, string  $filename, ?\DateTimeImmutable  $until, bool  $isolated  )

private

Definition at line 102 of file DataSigner.php.

     : 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')
        );
    }

verify()

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

Implements ILIAS\FileDelivery\Token\DataSigning.

Definition at line 150 of file DataSigner.php.

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

verifyStreamToken()

ILIAS\FileDelivery\Token\DataSigner::verifyStreamToken

(

string

$token

)

Implements ILIAS\FileDelivery\Token\DataSigning.

Definition at line 124 of file DataSigner.php.

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

References $data, and $token.

Field Documentation

$payload_builder

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

private

Definition at line 48 of file DataSigner.php.

$salt_factory

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

private

Definition at line 47 of file DataSigner.php.

$signing_serializer

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

private

Definition at line 46 of file DataSigner.php.

---

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

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