ilWACTokenTest Class Reference

TestCase for the ilWACTokenTest. More...

Inheritance diagram for ilWACTokenTest:

Collaboration diagram for ilWACTokenTest:

Public Member Functions
	testWithoutSigning ()
	testSomeBasics ()
	testTokenGeneration ()
	testCookieGeneration ()
	testFileToken ()
	testModifiedTimestampNoMod ()
	testModifiedTimestampAddTime ()
	testModifiedTimestampSubTime ()
	testModifiedTTL ()
	testModifiedTTLAndTimestamp ()
	testModifiedToken ()

Data Fields
const	ADDITIONAL_TIME = 1
const	LIFETIME = 2
const	SALT = 'SALT'
const	CLIENT_NAME = 'client_name'

Protected Member Functions
	setUp ()
	Setup. More...
	getModifiedSignedPath (int $add_ttl=0, int $add_timestamp=0, $override_token=null)

Protected Attributes
	$backupGlobals = false
	$file_one
	$file_one_subfolder
	$file_one_subfolder_two
	$file_two
	$file_three
	$file_four
	$root

Private Attributes
	$http
	$cookieFactory

Detailed Description

TestCase for the ilWACTokenTest.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

disabled disabled disabled

Definition at line 42 of file ilWACTokenTestTBD.php.

Member Function Documentation

getModifiedSignedPath()

ilWACTokenTest::getModifiedSignedPath ( int  $add_ttl = 0, int  $add_timestamp = 0,   $override_token = null  )

protected

Parameters

null

$override_token

Definition at line 351 of file ilWACTokenTestTBD.php.

References $parts, $path, $token, ILIAS\Repository\int(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

Referenced by testModifiedTimestampAddTime(), testModifiedTimestampNoMod(), testModifiedTimestampSubTime(), testModifiedToken(), testModifiedTTL(), and testModifiedTTLAndTimestamp().

                                                                                                              : string
    {
        ilWACSignedPath::setTokenMaxLifetimeInSeconds(self::LIFETIME);
        $signed_path = ilWACSignedPath::signFile($this->file_one->url());

        $parts = parse_url($signed_path);
        $path = $parts['path'];
        $query = $parts['query'];
        parse_str($query, $query_array);
        $token = $override_token ? $override_token : $query_array['il_wac_token'];
        $ttl = (int) $query_array['il_wac_ttl'];
        $ts = (int) $query_array['il_wac_ts'];
        $path_with_token = $path . '?il_wac_token=' . $token;

        $modified_ttl = $ttl + $add_ttl;
        $modified_ts = $ts + $add_timestamp;

        return $path_with_token . '&il_wac_ttl=' . $modified_ttl . '&il_wac_ts=' . $modified_ts;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUp()

ilWACTokenTest::setUp ( )

protected

Setup.

Definition at line 93 of file ilWACTokenTestTBD.php.

References $c, $container, $GLOBALS, ILIAS\FileDelivery\http(), and ilWACToken\setSALT().

                              : void
    {
        parent::setUp();

        $this->root = vfs\vfsStream::setup('ilias.de');
        $this->file_one = vfs\vfsStream::newFile('data/client_name/mobs/mm_123/dummy.jpg')
                                       ->at($this->root)->setContent('dummy');
        $this->file_one_subfolder = vfs\vfsStream::newFile('data/client_name/mobs/mm_123/mobile/dummy.jpg')
                                                 ->at($this->root)->setContent('dummy');
        $this->file_one_subfolder_two = vfs\vfsStream::newFile('data/client_name/mobs/mm_123/mobile/device/dummy.jpg')
                                                     ->at($this->root)->setContent('dummy');
        $this->file_two = vfs\vfsStream::newFile('data/client_name/mobs/mm_123/dummy2.jpg')
                                       ->at($this->root)->setContent('dummy2');
        $this->file_three = vfs\vfsStream::newFile('data/client_name/mobs/mm_124/dummy.jpg')
                                         ->at($this->root)->setContent('dummy');
        $this->file_four = vfs\vfsStream::newFile('data/client_name/sec/ilBlog/mm_124/dummy.jpg')
                                        ->at($this->root)->setContent('dummy');

        //setup container for HttpServiceAware classes
        $container = new \ILIAS\DI\Container();
        $container['http'] = fn($c) => Mockery::mock(GlobalHttpState::class);

        $this->http = $container['http'];


        $GLOBALS["DIC"] = $container;

        $this->cookieFactory = Mockery::mock(CookieFactoryImpl::class);

        //because the cookie have no logic except cloning it self therefore it should be no problem to defer the function calls
        $this->cookieFactory->shouldDeferMissing();

        ilWACToken::setSALT(self::SALT);
    }

Here is the call graph for this function:

testCookieGeneration()

ilWACTokenTest::testCookieGeneration

(

)

Definition at line 197 of file ilWACTokenTestTBD.php.

References $response, ILIAS\FileDelivery\http(), and ilWACSignedPath\signFolderOfStartFile().

                                          : void
    {
        $this->markTestSkipped('unable to use http cookies at this point');

        $cookieJar = Mockery::mock(CookieJar::class);

        $response = Mockery::mock(ResponseInterface::class);

        $this->http
            ->shouldReceive('response')
            ->times(3)
            ->withNoArgs()
            ->andReturn($response)
            ->getMock();

        $cookieJar
            ->shouldReceive('with')
            ->times(3)
            ->with(new CookieWrapper(SetCookie::create('')))
            ->andReturnSelf()
            ->getMock()

            ->shouldReceive('with')
            ->times(3)
            ->with(new CookieWrapper(SetCookie::create('')))
            ->andReturnSelf()
            ->getMock()

            ->shouldReceive('with')
            ->times(3)
            ->with(new CookieWrapper(SetCookie::create('')))
            ->andReturnSelf()
            ->getMock();

        $this->http->shouldReceive('cookieJar')
            ->withNoArgs()
            ->andReturn($cookieJar);

        ilWACSignedPath::signFolderOfStartFile($this->file_one->url());

        // in subfolder
        ilWACSignedPath::signFolderOfStartFile($this->file_one_subfolder->url());

        // in sub-subfolder
        ilWACSignedPath::signFolderOfStartFile($this->file_one_subfolder->url());
    }

Here is the call graph for this function:

testFileToken()

ilWACTokenTest::testFileToken

(

)

Definition at line 245 of file ilWACTokenTestTBD.php.

References CLIENT_NAME, ilWACSignedPath\getTokenMaxLifetimeInSeconds(), ILIAS\FileDelivery\http(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

                                   : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        ilWACSignedPath::setTokenMaxLifetimeInSeconds(self::LIFETIME);
        $lifetime = ilWACSignedPath::getTokenMaxLifetimeInSeconds();

        // Request within lifetime
        $signed_path = ilWACSignedPath::signFile($this->file_one->url());
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), $this->http, $this->cookieFactory);

        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertTrue($ilWACSignedPath->isSignedPathValid());
        $this->assertEquals($ilWACSignedPath->getPathObject()->getClient(), self::CLIENT_NAME);
        $this->assertFalse($ilWACSignedPath->getPathObject()->isInSecFolder());
        $this->assertTrue($ilWACSignedPath->getPathObject()->isImage());
        $this->assertFalse($ilWACSignedPath->getPathObject()->isAudio());
        $this->assertFalse($ilWACSignedPath->getPathObject()->isVideo());
        $this->assertTrue($ilWACSignedPath->getPathObject()->hasTimestamp());
        $this->assertTrue($ilWACSignedPath->getPathObject()->hasToken());

        // Request after lifetime
        $signed_path = ilWACSignedPath::signFile($this->file_four->url());
        sleep($lifetime + self::ADDITIONAL_TIME);
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testModifiedTimestampAddTime()

ilWACTokenTest::testModifiedTimestampAddTime

(

)

Definition at line 292 of file ilWACTokenTestTBD.php.

References getModifiedSignedPath(), and ILIAS\FileDelivery\http().

                                                  : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        // self::markTestSkipped("WIP");
        // return;
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(self::ADDITIONAL_TIME, 0)), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testModifiedTimestampNoMod()

ilWACTokenTest::testModifiedTimestampNoMod

(

)

Definition at line 278 of file ilWACTokenTestTBD.php.

References getModifiedSignedPath(), and ILIAS\FileDelivery\http().

                                                : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        // self::markTestSkipped("WIP");
        // return;
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(0, 0)), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertTrue($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testModifiedTimestampSubTime()

ilWACTokenTest::testModifiedTimestampSubTime

(

)

Definition at line 303 of file ilWACTokenTestTBD.php.

References getModifiedSignedPath(), and ILIAS\FileDelivery\http().

                                                  : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        // self::markTestSkipped("WIP");
        // return;
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(self::ADDITIONAL_TIME
                                                                                          * -1, 0)), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testModifiedToken()

ilWACTokenTest::testModifiedToken

(

)

Definition at line 337 of file ilWACTokenTestTBD.php.

References getModifiedSignedPath(), and ILIAS\FileDelivery\http().

                                       : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        // self::markTestSkipped("WIP");
        // return;
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(0, 0, md5('LOREM'))), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testModifiedTTL()

ilWACTokenTest::testModifiedTTL

(

)

Definition at line 315 of file ilWACTokenTestTBD.php.

References getModifiedSignedPath(), and ILIAS\FileDelivery\http().

                                     : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        // self::markTestSkipped("WIP");
        // return;
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(0, 1)), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testModifiedTTLAndTimestamp()

ilWACTokenTest::testModifiedTTLAndTimestamp

(

)

Definition at line 326 of file ilWACTokenTestTBD.php.

References getModifiedSignedPath(), and ILIAS\FileDelivery\http().

                                                 : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        // self::markTestSkipped("WIP");
        // return;
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(1, 1)), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
    }

Here is the call graph for this function:

testSomeBasics()

ilWACTokenTest::testSomeBasics

(

)

Definition at line 163 of file ilWACTokenTestTBD.php.

References CLIENT_NAME, and ILIAS\FileDelivery\http().

                                    : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");
        $query = 'myparam=1234';
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_four->url() . '?'
                                                             . $query), $this->http, $this->cookieFactory);

        $this->assertEquals('dummy.jpg', $ilWACSignedPath->getPathObject()->getFileName());
        $this->assertEquals($query, $ilWACSignedPath->getPathObject()->getQuery());
        $this->assertEquals('./public/data/' . self::CLIENT_NAME
                            . '/sec/ilBlog/mm_124/', $ilWACSignedPath->getPathObject()
                                                                     ->getSecurePath());
        $this->assertEquals('ilBlog', $ilWACSignedPath->getPathObject()->getSecurePathId());
        $this->assertFalse($ilWACSignedPath->getPathObject()->isStreamable());
    }

Here is the call graph for this function:

testTokenGeneration()

ilWACTokenTest::testTokenGeneration

(

)

Definition at line 180 of file ilWACTokenTestTBD.php.

References CLIENT_NAME, ilWACToken\generateToken(), and ilWACToken\getSALT().

                                         : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");

        $ilWacPath = new ilWacPath($this->file_four->url());
        $ilWACToken = new ilWACToken($ilWacPath->getPath(), self::CLIENT_NAME, 123456, 20);
        $ilWACToken->generateToken();
        $this->assertEquals('SALT-client_name-123456-20', $ilWACToken->getRawToken());
        $this->assertEquals('./data/client_name/sec/ilBlog/mm_124/dummy.jpg', $ilWACToken->getId());

        $this->assertEquals(self::SALT, ilWACToken::getSALT());
        $ilWACToken = new ilWACToken($ilWacPath->getPath(), self::CLIENT_NAME, 123456, 20);
        $this->assertEquals('b541e2bae42ee222f9be959b7ad2ab8844cbb05b', $ilWACToken->getToken());
        $this->assertEquals('e45b98f267dc891c8206c844f7df29ea', $ilWACToken->getHashedId());
    }

Here is the call graph for this function:

testWithoutSigning()

ilWACTokenTest::testWithoutSigning

(

)

Definition at line 129 of file ilWACTokenTestTBD.php.

References ILIAS\FileDelivery\http().

                                        : void
    {
        $this->markTestSkipped("Failed for some unknown reason.");

        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_one->url()), $this->http, $this->cookieFactory);

        $cookieJar = Mockery::mock(CookieJar::class);

        $cookieJar
            ->shouldReceive('getAll')
            ->times(2)
            ->withAnyArgs()
            ->andReturn([]);

        $this->http->shouldReceive('cookieJar')
            ->twice()
            ->withNoArgs()
            ->andReturn($cookieJar);

        $request = Mockery::mock(Psr\Http\Message\RequestInterface::class);
        $request->shouldReceive('getCookieParams')
                ->andReturn([]);

        $this->http->shouldReceive('request')
            ->withNoArgs()
            ->andReturn($request);

        $this->assertFalse($ilWACSignedPath->isSignedPath());
        $this->assertFalse($ilWACSignedPath->isSignedPathValid());
        $this->assertFalse($ilWACSignedPath->isFolderSigned());
        $this->assertFalse($ilWACSignedPath->isFolderTokenValid());
    }

Here is the call graph for this function:

Field Documentation

$backupGlobals

ilWACTokenTest::$backupGlobals = false

protected

Definition at line 51 of file ilWACTokenTestTBD.php.

$cookieFactory

CookieFactory MockInterface ilWACTokenTest::$cookieFactory

private

Definition at line 87 of file ilWACTokenTestTBD.php.

$file_four

ilWACTokenTest::$file_four

protected

Definition at line 75 of file ilWACTokenTestTBD.php.

$file_one

ilWACTokenTest::$file_one

protected

Definition at line 55 of file ilWACTokenTestTBD.php.

$file_one_subfolder

ilWACTokenTest::$file_one_subfolder

protected

Definition at line 59 of file ilWACTokenTestTBD.php.

$file_one_subfolder_two

ilWACTokenTest::$file_one_subfolder_two

protected

Definition at line 63 of file ilWACTokenTestTBD.php.

$file_three

ilWACTokenTest::$file_three

protected

Definition at line 71 of file ilWACTokenTestTBD.php.

$file_two

ilWACTokenTest::$file_two

protected

Definition at line 67 of file ilWACTokenTestTBD.php.

$http

GlobalHttpState MockInterface ilWACTokenTest::$http

private

Definition at line 83 of file ilWACTokenTestTBD.php.

$root

ilWACTokenTest::$root

protected

Definition at line 79 of file ilWACTokenTestTBD.php.

ADDITIONAL_TIME

const ilWACTokenTest::ADDITIONAL_TIME = 1

Definition at line 44 of file ilWACTokenTestTBD.php.

CLIENT_NAME

const ilWACTokenTest::CLIENT_NAME = 'client_name'

Definition at line 47 of file ilWACTokenTestTBD.php.

LIFETIME

const ilWACTokenTest::LIFETIME = 2

Definition at line 45 of file ilWACTokenTestTBD.php.

SALT

const ilWACTokenTest::SALT = 'SALT'

Definition at line 46 of file ilWACTokenTestTBD.php.

---

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

• components/ILIAS/WebAccessChecker/tests/Token/ilWACTokenTestTBD.php