ILIAS\FileDelivery\Token\SigningSerializer Class Reference

Collaboration diagram for ILIAS\FileDelivery\Token\SigningSerializer:

Public Member Functions
	__construct (private KeyRotatingSigner $signer, private Serializer $serializer, private Compression $compression, private Transport $transport)
	sign (Payload $payload, Salt $salt)
	verify (string $data, Salt $salt)

Private Attributes
const	SEPARATOR = '<<>>'

Detailed Description

Author

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

Definition at line 36 of file SigningSerializer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Token\SigningSerializer::__construct	(	private KeyRotatingSigner	$signer,
		private Serializer	$serializer,
		private Compression	$compression,
		private Transport	$transport
	)

Definition at line 43 of file SigningSerializer.php.

      {
    }

Member Function Documentation

sign()

ILIAS\FileDelivery\Token\SigningSerializer::sign	(	Payload	$payload,
		Salt	$salt
	)

Definition at line 51 of file SigningSerializer.php.

                                                      : string
    {
        // serialize payload
        $serialized_payload = $this->serializer->serializePayload($payload->get());
        $serialized_validity = $this->serializer->serializeValidity($payload->until());
        $signable_payload = $serialized_payload . self::SEPARATOR . $serialized_validity;
 
        // sign payload
        $signature = $this->signer->sign($signable_payload, $salt);
 
        $signed_payload = $signable_payload . self::SEPARATOR . $signature;
 
        $compressed_payload = $this->compression->compress($signed_payload);
 
        $prepare_for_transport = $this->transport->prepareForTransport($compressed_payload);
 
        return $prepare_for_transport;
    }

References $payload.

verify()

ILIAS\FileDelivery\Token\SigningSerializer::verify	(	string	$data,
		Salt	$salt
	)

Definition at line 70 of file SigningSerializer.php.

                                                    : ?Payload
    {
        // decompress payload
        try {
            $decompressed_payload = $this->compression->decompress(
                $this->transport->readFromTransport($data)
            );
        } catch (\Throwable) {
            return null;
        }
 
        $split_data = explode(self::SEPARATOR, $decompressed_payload);
        $serialized_payload = $split_data[0] ?? '';
        $validity = $split_data[1] ?? '';
        $signature = $split_data[2] ?? '';
 
        $payload_with_validity = $serialized_payload . self::SEPARATOR . $validity;
 
        if ($this->signer->verify($payload_with_validity, $signature, (int) $validity, $salt) === false) {
            return null;
        }
 
        return new StructuredPayload($this->serializer->unserializePayload($serialized_payload));
    }

References $data.

Field Documentation

SEPARATOR

const ILIAS\FileDelivery\Token\SigningSerializer::SEPARATOR = '<<>>'

private

Definition at line 41 of file SigningSerializer.php.

---

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

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