ilWACTokenTest Class Reference

TestCase for the ilWACTokenTest. More...

Inheritance diagram for ilWACTokenTest:

Collaboration diagram for ilWACTokenTest:

Public Member Functions
	testWithoutSigning ()
	testSomeBasics ()
	testTokenGeneration ()
	testCookieGeneration ()
	testFileToken ()
	testFolderToken ()
	testFolderTokenWithSecondFile ()
	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 ($add_ttl=0, $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 52 of file ilWACTokenTest.php.

Member Function Documentation

getModifiedSignedPath()

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

protected

Parameters

int	$add_ttl
int	$add_timestamp
null	$override_token

Returns

string

Definition at line 500 of file ilWACTokenTest.php.

References $path, $query, ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

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

    {
        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 103 of file ilWACTokenTest.php.

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

    {
        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'] = function ($c) {
            return 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 196 of file ilWACTokenTest.php.

References $response, ILIAS\HTTP\Cookies\Cookie\getName(), ILIAS\FileDelivery\http(), and ilWACSignedPath\signFolderOfStartFile().

    {
        $expected_cookies = [
            '19ab58dae37d8d8cf931727c35514642',
            '19ab58dae37d8d8cf931727c35514642ts',
            '19ab58dae37d8d8cf931727c35514642ttl',
        ];

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

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

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

            ->shouldReceive('saveResponse')
            ->times(3)
            ->with($response);

        $cookieJar
            ->shouldReceive('with')
            ->times(3)
            ->with(Mockery::on(function (Cookie $cookie) use ($expected_cookies) {
                return strcmp($cookie->getName(), $expected_cookies[0]) === 0;
            }))
            ->andReturnSelf()
            ->getMock()

            ->shouldReceive('with')
            ->times(3)
            ->with(Mockery::on(function (Cookie $cookie) use ($expected_cookies) {
                return strcmp($cookie->getName(), $expected_cookies[1]) === 0;
            }))
            ->andReturnSelf()
            ->getMock()

            ->shouldReceive('with')
            ->times(3)
            ->with(Mockery::on(function (Cookie $cookie) use ($expected_cookies) {
                return strcmp($cookie->getName(), $expected_cookies[2]) === 0;
            }))
            ->andReturnSelf()
            ->getMock()

            ->shouldReceive('renderIntoResponseHeader')
            ->times(3)
            ->withAnyArgs()
            ->andReturn($response);

        $this->http->shouldReceive('cookieJar')
            ->times(3)
            ->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 264 of file ilWACTokenTest.php.

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

    {
        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:

testFolderToken()

ilWACTokenTest::testFolderToken

(

)

Definition at line 295 of file ilWACTokenTest.php.

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

    {
        $response = Mockery::mock(ResponseInterface::class);
        $cookieJar = Mockery::mock(CookieJar::class);

        $this->http
            ->shouldReceive('response')
            ->once()
            ->withNoArgs()
            ->andReturn($response)
            ->getMock()

            ->shouldReceive('cookieJar')
            ->once()
            ->withNoArgs()
            ->andReturn($cookieJar)
            ->getMock()

            ->shouldReceive('saveResponse')
            ->once()
            ->with($response);

        $timestamp = 2 ** 31 - 31;
        $ttl = 30;
        $tokenId = '19ab58dae37d8d8cf931727c35514642';

        $tokenCookie = $this->cookieFactory->create($tokenId, '344d7676240285cc714366038beb44d81bda1d4b');
        $timestampCookie = $this->cookieFactory->create("{$tokenId}ts", "$timestamp");
        $ttlCookie = $this->cookieFactory->create("{$tokenId}ttl", "$ttl");

        $cookieJar
            ->shouldReceive('with')
            ->times(3)
            ->with(Mockery::type(Cookie::class))
            ->andReturnSelf()
            ->getMock()

            ->shouldReceive('renderIntoResponseHeader')
            ->once()
            ->withAnyArgs()
            ->andReturn($response)
            ->getMock()

            ->shouldReceive('get')
            ->times(3)
            ->withAnyArgs()
            ->andReturnValues([$tokenCookie, $timestampCookie, $ttlCookie])
            ->getMock()

            ->shouldReceive('get')
            ->times(3)
            ->withAnyArgs()
            ->andReturnValues([$tokenCookie, $timestampCookie, $ttlCookie]);

        ilWACSignedPath::setCookieMaxLifetimeInSeconds(self::LIFETIME);
        $lifetime = ilWACSignedPath::getCookieMaxLifetimeInSeconds();

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

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

        self::markTestSkipped("WIP");
        return;

        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertTrue($ilWACSignedPath->isFolderTokenValid());
        $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
        ilWACSignedPath::signFolderOfStartFile($signed_path);
        sleep($lifetime + self::ADDITIONAL_TIME);
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertFalse($ilWACSignedPath->isFolderTokenValid());

        // Revalidating cookie
        $ilWACSignedPath->revalidatingFolderToken();
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertTrue($ilWACSignedPath->isFolderTokenValid());

        // Check other file
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_three->url()), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertTrue($ilWACSignedPath->isFolderTokenValid());
    }

Here is the call graph for this function:

testFolderTokenWithSecondFile()

ilWACTokenTest::testFolderTokenWithSecondFile

(

)

Definition at line 393 of file ilWACTokenTest.php.

References $file_two, ilWACSignedPath\getCookieMaxLifetimeInSeconds(), ILIAS\FileDelivery\http(), ilWACSignedPath\setCookieMaxLifetimeInSeconds(), and ilWACSignedPath\signFolderOfStartFile().

    {
        self::markTestSkipped("WIP");
        return;
        ilWACSignedPath::setCookieMaxLifetimeInSeconds(self::LIFETIME);
        $lifetime = ilWACSignedPath::getCookieMaxLifetimeInSeconds();
        // Sign File One

        ilWACSignedPath::signFolderOfStartFile($this->file_one->url());
        // Check File Two
        $file_two = $this->file_two->url();
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($file_two), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertTrue($ilWACSignedPath->isFolderTokenValid());

        // Request after lifetime
        ilWACSignedPath::signFolderOfStartFile($file_two);
        sleep($lifetime + self::ADDITIONAL_TIME);
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($file_two), $this->http, $this->cookieFactory);
        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertFalse($ilWACSignedPath->isFolderTokenValid());

        // Revalidating cookie
        $ilWACSignedPath->revalidatingFolderToken();
        $this->assertTrue($ilWACSignedPath->isFolderSigned());
        $this->assertTrue($ilWACSignedPath->isFolderTokenValid());

        // Check other file
        $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_three->url()), $this->http, $this->cookieFactory);
        $this->assertFalse($ilWACSignedPath->isFolderSigned());
        $this->assertFalse($ilWACSignedPath->isFolderTokenValid());
    }

Here is the call graph for this function:

testModifiedTimestampAddTime()

ilWACTokenTest::testModifiedTimestampAddTime

(

)

Definition at line 443 of file ilWACTokenTest.php.

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

    {
        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 430 of file ilWACTokenTest.php.

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

    {
        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 453 of file ilWACTokenTest.php.

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

    {
        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 484 of file ilWACTokenTest.php.

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

    {
        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 464 of file ilWACTokenTest.php.

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

    {
        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 474 of file ilWACTokenTest.php.

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

    {
        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 165 of file ilWACTokenTest.php.

References $query, and ILIAS\FileDelivery\http().

    {
        $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('./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 181 of file ilWACTokenTest.php.

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

    {
        $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 141 of file ilWACTokenTest.php.

References ILIAS\FileDelivery\http().

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

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

        $cookieJar
            ->shouldReceive('get')
            ->times(6)
            ->withAnyArgs()
            ->andReturnNull();

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

        $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 61 of file ilWACTokenTest.php.

$cookieFactory

CookieFactory MockInterface ilWACTokenTest::$cookieFactory

private

Definition at line 97 of file ilWACTokenTest.php.

$file_four

ilWACTokenTest::$file_four

protected

Definition at line 85 of file ilWACTokenTest.php.

$file_one

ilWACTokenTest::$file_one

protected

Definition at line 65 of file ilWACTokenTest.php.

$file_one_subfolder

ilWACTokenTest::$file_one_subfolder

protected

Definition at line 69 of file ilWACTokenTest.php.

$file_one_subfolder_two

ilWACTokenTest::$file_one_subfolder_two

protected

Definition at line 73 of file ilWACTokenTest.php.

$file_three

ilWACTokenTest::$file_three

protected

Definition at line 81 of file ilWACTokenTest.php.

$file_two

ilWACTokenTest::$file_two

protected

Definition at line 77 of file ilWACTokenTest.php.

Referenced by testFolderTokenWithSecondFile().

$http

GlobalHttpState MockInterface ilWACTokenTest::$http

private

Definition at line 93 of file ilWACTokenTest.php.

$root

ilWACTokenTest::$root

protected

Definition at line 89 of file ilWACTokenTest.php.

ADDITIONAL_TIME

const ilWACTokenTest::ADDITIONAL_TIME = 1

Definition at line 54 of file ilWACTokenTest.php.

CLIENT_NAME

const ilWACTokenTest::CLIENT_NAME = 'client_name'

Definition at line 57 of file ilWACTokenTest.php.

LIFETIME

const ilWACTokenTest::LIFETIME = 2

Definition at line 55 of file ilWACTokenTest.php.

SALT

const ilWACTokenTest::SALT = 'SALT'

Definition at line 56 of file ilWACTokenTest.php.

---

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

• Services/WebAccessChecker/test/Token/ilWACTokenTest.php