FileEncryptionTest.php

<?php

declare(strict_types=1);

namespace tests;

use PHPUnit\Framework\TestCase;
use Rancoud\Session\FileEncryption;
use Rancoud\Session\SessionException;

/**
 * @internal
 */
class FileEncryptionTest extends TestCase
{
    protected function setUp(): void
    {
        $path = \ini_get('session.save_path');
        if (empty($path)) {
            $path = \DIRECTORY_SEPARATOR . 'tmp';
        }

        $pattern = $path . \DIRECTORY_SEPARATOR . 'sess_*';
        foreach (\glob($pattern) as $file) {
            if (\file_exists($file)) {
                \unlink($file);
            }
        }

        if (\is_dir($path . \DIRECTORY_SEPARATOR . 'tests')) {
            \rmdir($path . \DIRECTORY_SEPARATOR . 'tests');
        }
    }

    private function getPath(): string
    {
        $path = \ini_get('session.save_path');
        if (empty($path)) {
            return \DIRECTORY_SEPARATOR . 'tmp';
        }

        return $path;
    }

    /** @throws SessionException */
    private function openSessionForSavingSavePath(FileEncryption $fileEncryption): void
    {
        $success = $fileEncryption->open($this->getPath(), '');
        static::assertTrue($success);
    }

    /** @throws SessionException */
    public function testOpen(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $savePath = $this->getPath();
        $sessionName = '';
        $success = $fileEncryption->open($savePath, $sessionName);
        static::assertTrue($success);

        $savePathNotCreated = $savePath . \DIRECTORY_SEPARATOR . 'tests';
        $success = $fileEncryption->open($savePathNotCreated, $sessionName);
        static::assertTrue($success);
        $success = \file_exists($savePathNotCreated);
        static::assertTrue($success);
    }

    public function testClose(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');
        $success = $fileEncryption->close();
        static::assertTrue($success);
    }

    /** @throws SessionException */
    public function testWrite(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $this->openSessionForSavingSavePath($fileEncryption);

        $sessionId = 'sessionId';
        $data = 'azerty';
        $success = $fileEncryption->write($sessionId, $data);
        static::assertTrue($success);

        $dataInFile = \file_get_contents($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertNotSame($data, $dataInFile);

        $encryptionTrait = new class() {
            use \Rancoud\Session\Encryption;
        };
        $encryptionTrait->setKey('randomKey');
        $dataInFileDecrypted = $encryptionTrait->decrypt($dataInFile);
        static::assertSame($data, $dataInFileDecrypted);
    }

    /** @throws SessionException */
    public function testRead(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $this->openSessionForSavingSavePath($fileEncryption);

        $sessionId = 'sessionId';
        $data = 'azerty';
        $success = $fileEncryption->write($sessionId, $data);
        static::assertTrue($success);

        $dataOutput = $fileEncryption->read($sessionId);
        static::assertNotEmpty($dataOutput);
        static::assertIsString($dataOutput);
        static::assertSame($data, $dataOutput);

        $sessionId = '';
        $dataOutput = $fileEncryption->read($sessionId);
        static::assertEmpty($dataOutput);
        static::assertIsString($dataOutput);
    }

    /** @throws SessionException */
    public function testDestroy(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $this->openSessionForSavingSavePath($fileEncryption);

        $sessionId = 'todelete';
        $success = $fileEncryption->destroy($sessionId);
        static::assertTrue($success);

        $sessionId = 'sessionId';
        $data = 'azerty';
        $success = $fileEncryption->write($sessionId, $data);
        static::assertTrue($success);

        $isFileExist = \file_exists($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertTrue($isFileExist);
        $success = $fileEncryption->destroy($sessionId);
        static::assertTrue($success);
        $isFileNotExist = !\file_exists($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertTrue($isFileNotExist);
    }

    /** @throws SessionException */
    public function testGc(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $this->openSessionForSavingSavePath($fileEncryption);

        $sessionId = 'sessionId';
        $data = 'azerty';
        $success = $fileEncryption->write($sessionId, $data);
        static::assertTrue($success);

        $isFileExist = \file_exists($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertTrue($isFileExist);

        $lifetime = -1000;
        $success = $fileEncryption->gc($lifetime);
        static::assertTrue($success);

        $isFileNotExist = !\file_exists($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertTrue($isFileNotExist);
    }

    /** @throws SessionException */
    public function testValidateId(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $this->openSessionForSavingSavePath($fileEncryption);

        $baseId = 'TiqKrZDUGp5ubt3klF0oorIlFiADXC9jxig9e8leUcCYuZ9w0mXh0b1foEGIBs7SSsdOuLor58vU5liBRVPsTobnvt';
        $endId1 = 'Tj8hh65DlR3tTFI1SGX3mFciDA9rMOa4LlnMr';
        $endId2 = 'Tklezfoipvfk0lferijkoefzjklgrvefLlnMr';

        $fileEncryption->write($baseId . $endId1, 'a');

        static::assertTrue($fileEncryption->validateId($baseId . $endId1));
        static::assertFalse($fileEncryption->validateId($baseId . $endId2));
        static::assertFalse($fileEncryption->validateId('kjlfez/fez'));
    }

    /** @throws SessionException */
    public function testUpdateTimestamp(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $this->openSessionForSavingSavePath($fileEncryption);

        $sessionId = 'sessionId';
        $data = 'azerty';
        $success = $fileEncryption->write($sessionId, $data);
        static::assertTrue($success);

        $dataInFile = \file_get_contents($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        $oldFileModifiedTime = \filemtime($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertNotSame($data, $dataInFile);

        $encryptionTrait = new class() {
            use \Rancoud\Session\Encryption;
        };
        $encryptionTrait->setKey('randomKey');
        $dataInFileDecrypted = $encryptionTrait->decrypt($dataInFile);
        static::assertSame($data, $dataInFileDecrypted);

        \sleep(1);
        $success = $fileEncryption->updateTimestamp($sessionId, $data);
        static::assertTrue($success);

        \clearstatcache();

        $dataInFile2 = \file_get_contents($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);
        static::assertNotSame($data, $dataInFile2);

        $encryptionTrait = new class() {
            use \Rancoud\Session\Encryption;
        };
        $encryptionTrait->setKey('randomKey');
        $dataInFileDecrypted = $encryptionTrait->decrypt($dataInFile2);
        static::assertSame($data, $dataInFileDecrypted);
        static::assertNotSame($dataInFile, $dataInFile2);

        $newFileModifiedTime = \filemtime($this->getPath() . \DIRECTORY_SEPARATOR . 'sess_' . $sessionId);

        static::assertTrue($oldFileModifiedTime < $newFileModifiedTime);
    }

    /** @throws \Exception */
    public function testCreateId(): void
    {
        $fileEncryption = new FileEncryption();
        $fileEncryption->setKey('randomKey');

        $string = $fileEncryption->create_sid();

        static::assertMatchesRegularExpression('/^[a-zA-Z0-9-]{127}+$/', $string);
    }
}