HttpPathBuilderTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use PHPUnit\Framework\TestCase;
 
final class HttpPathBuilderTest extends TestCase
{
    public static function environmentProvider(): Generator
    {
        yield 'Host matches configured HTTP path (no `allowed_hosts` configuration)' => [
            'server_data' => [
                'HTTP_HOST' => 'localhost',
                'REQUEST_URI' => '/login.php',
            ],
            'http_path' => 'http://localhost',
            'wsdl_path' => 'https://localhost/soap/server.php?wsdl=1',
            'allowed_hosts' => '',
        ];
 
        yield 'Host matches configured WSDL path (no `allowed_hosts` configuration)' => [
            'server_data' => [
                'HTTP_HOST' => 'soap.ilias.de',
                'REQUEST_URI' => '/login.php',
            ],
            'http_path' => 'https://test.ilias.de',
            'wsdl_path' => 'https://soap.ilias.de/soap/server.php?wsdl=1',
            'allowed_hosts' => '',
        ];
 
        yield 'Localhost is always allowed (no `allowed_hosts` configuration)' => [
            'server_data' => [
                'HTTP_HOST' => 'localhost',
                'REQUEST_URI' => '/login.php',
            ],
            'http_path' => 'https://test.ilias.de',
            'wsdl_path' => 'https://test.ilias.de/soap/server.php?wsdl=1',
            'allowed_hosts' => '',
        ];
 
        yield 'Host is in `allowed_hosts` list' => [
            'server_data' => [
                'HTTP_HOST' => 'test2.ilias.de',
                'REQUEST_URI' => '/login.php',
            ],
            'http_path' => 'https://test.ilias.de',
            'wsdl_path' => 'https://test.ilias.de/soap/server.php?wsdl=1',
            'allowed_hosts' => 'test2.ilias.de',
        ];
    }
 
    #[\PHPUnit\Framework\Attributes\DataProvider('environmentProvider')]
    public function testValidHostsTriggerNoExceptions(
        array|ArrayAccess $server_data,
        string $http_path,
        string $wsdl_path,
        string $allowed_hosts
    ): void {
        $path_builder = new \ILIAS\Init\Environment\HttpPathBuilder(
            new \ILIAS\Data\Factory(),
            $this->getSettingsMock($wsdl_path, $allowed_hosts),
            $this->getHttpsMock(),
            $this->getIniMock($http_path),
            $server_data
        );
 
        $this->assertNotEmpty((string) $path_builder->build());
    }
 
    public function testUnknownHostWillRaiseException(): void
    {
        $this->expectException(RuntimeException::class);
 
        $path_builder = new \ILIAS\Init\Environment\HttpPathBuilder(
            new \ILIAS\Data\Factory(),
            $this->getSettingsMock('https://test.ilias.de/soap/server.php?wsdl=1', 'test.ilias.de'),
            $this->getHttpsMock(),
            $this->getIniMock('https://test.ilias.de'),
            [
                'HTTP_HOST' => 'phishing.ilias.de',
                'REQUEST_URI' => '/login.php',
            ]
        );
 
        $path_builder->build();
    }
 
    public function testContentDomainIsRejectedAsApplicationHostWhenIsolationActive(): void
    {
        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('reserved for asset delivery');
 
        $path_builder = new \ILIAS\Init\Environment\HttpPathBuilder(
            new \ILIAS\Data\Factory(),
            // content host added to allowed_hosts so we reach the isolation check
            $this->getSettingsMock('https://app.ilias.de/soap/server.php?wsdl=1', 'content.ilias.de'),
            $this->getHttpsMock(),
            $this->getIniMock('https://app.ilias.de'),
            [
                'HTTP_HOST' => 'content.ilias.de',
                'REQUEST_URI' => '/login.php',
            ],
            \ILIAS\FileDelivery\Isolation\IsolationConfig::fromArray([
                \ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_ACTIVATED => true,
                \ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_CONTENT_DOMAIN => 'https://content.ilias.de',
                \ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_ILIAS_DOMAIN => 'https://app.ilias.de',
            ])
        );
 
        $path_builder->build();
    }
 
    public function testApplicationHostStillAllowedWhenIsolationActive(): void
    {
        $path_builder = new \ILIAS\Init\Environment\HttpPathBuilder(
            new \ILIAS\Data\Factory(),
            $this->getSettingsMock('https://app.ilias.de/soap/server.php?wsdl=1', ''),
            $this->getHttpsMock(),
            $this->getIniMock('https://app.ilias.de'),
            [
                'HTTP_HOST' => 'app.ilias.de',
                'REQUEST_URI' => '/login.php',
            ],
            \ILIAS\FileDelivery\Isolation\IsolationConfig::fromArray([
                \ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_ACTIVATED => true,
                \ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_CONTENT_DOMAIN => 'https://content.ilias.de',
                \ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_ILIAS_DOMAIN => 'https://app.ilias.de',
            ])
        );
 
        $this->assertSame('app.ilias.de', $path_builder->build()->getHost());
    }
 
    public function testContentDomainNotRejectedWhenIsolationInactive(): void
    {
        // isolation disabled -> the content host is treated like any other host;
        // since it is in allowed_hosts here, build() must succeed
        $path_builder = new \ILIAS\Init\Environment\HttpPathBuilder(
            new \ILIAS\Data\Factory(),
            $this->getSettingsMock('https://app.ilias.de/soap/server.php?wsdl=1', 'content.ilias.de'),
            $this->getHttpsMock(),
            $this->getIniMock('https://app.ilias.de'),
            [
                'HTTP_HOST' => 'content.ilias.de',
                'REQUEST_URI' => '/login.php',
            ],
            \ILIAS\FileDelivery\Isolation\IsolationConfig::disabled()
        );
 
        $this->assertSame('content.ilias.de', $path_builder->build()->getHost());
    }
 
    private function getSettingsMock(
        string $wsdl_path,
        string $allowed_hosts
    ): ilSetting&\PHPUnit\Framework\MockObject\MockObject {
        $settings = $this
            ->getMockBuilder(ilSetting::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['get'])
            ->getMock();
        $settings->method('get')->willReturnCallback(
            static fn(string $key, ?string $default = null): ?string => match ($key) {
                'soap_wsdl_path' => $wsdl_path,
                'allowed_hosts' => $allowed_hosts,
                default => $default
            }
        );
 
        return $settings;
    }
 
    private function getHttpsMock(): ilHttps&\PHPUnit\Framework\MockObject\MockObject
    {
        $https = $this
            ->getMockBuilder(ilHTTPS::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['isDetected'])
            ->getMock();
        $https->method('isDetected')->willReturn(true);
 
        return $https;
    }
 
    private function getIniMock(string $http_path): ilIniFile&\PHPUnit\Framework\MockObject\MockObject
    {
        $ini = $this
            ->getMockBuilder(ilIniFile::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['readVariable'])
            ->getMock();
        $ini->method('readVariable')->willReturnCallback(
            static fn(string $group, string $variable): string => match ($variable) {
                'http_path' => $http_path,
                default => ''
            }
        );
 
        return $ini;
    }
}