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 = 0.5

const	LIFETIME = 1

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

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 37 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 317 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 80 of file ilWACTokenTest.php.

References ilWACToken\setSALT().

                                    {
                 require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
                 require_once('./Services/WebAccessChecker/classes/class.ilWebAccessChecker.php');
                 require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
                 require_once('./Services/WebAccessChecker/classes/class.ilWACToken.php');
                 require_once('./Services/WebAccessChecker/test/Token/mock/class.ilWACDummyCookie.php');
                 require_once('./libs/composer/vendor/autoload.php');
                 $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');
                 ilWACToken::setSALT(self::SALT);
                 parent::setUp();
         }

Here is the call graph for this function:

◆ testCookieGeneration()

ilWACTokenTest::testCookieGeneration ( )

Definition at line 145 of file ilWACTokenTest.php.

References $_SERVER, array, ilWACDummyCookie\clear(), ilWebAccessChecker\setDEBUG(), and ilWACSignedPath\signFolderOfStartFile().

                                                {
                 ilWebAccessChecker::setDEBUG(false);
                 ilWACDummyCookie::clear();
                 $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
                 $ilWACCookieInterface = new ilWACDummyCookie();
                 ilWACSignedPath::signFolderOfStartFile($this->file_one->url(), $ilWACCookieInterface);
                 $expected_cookies = array(
                         '19ab58dae37d8d8cf931727c35514642',
                         '19ab58dae37d8d8cf931727c35514642ts',
                         '19ab58dae37d8d8cf931727c35514642ttl',
                 );
                 $this->assertEquals($expected_cookies, array_keys($ilWACCookieInterface->getAll()));
                 // in subfolder
                 ilWACDummyCookie::clear();
                 $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
                 $ilWACCookieInterface = new ilWACDummyCookie();
                 ilWACSignedPath::signFolderOfStartFile($this->file_one_subfolder->url(), $ilWACCookieInterface);
                 $this->assertEquals($expected_cookies, array_keys($ilWACCookieInterface->getAll()));
                 // in sub-subfolder
                 ilWACDummyCookie::clear();
                 $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
                 $ilWACCookieInterface = new ilWACDummyCookie();
                 ilWACSignedPath::signFolderOfStartFile($this->file_one_subfolder->url(), $ilWACCookieInterface);
                 $this->assertEquals($expected_cookies, array_keys($ilWACCookieInterface->getAll()));
         }

Here is the call graph for this function:

◆ testFileToken()

ilWACTokenTest::testFileToken ( )

Definition at line 172 of file ilWACTokenTest.php.

References ilWACSignedPath\getTokenMaxLifetimeInSeconds(), 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->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->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testFolderToken()

ilWACTokenTest::testFolderToken ( )

Definition at line 199 of file ilWACTokenTest.php.

References ilWACDummyCookie\clear(), ilWACSignedPath\getCookieMaxLifetimeInSeconds(), ilWACSignedPath\setCookieMaxLifetimeInSeconds(), and ilWACSignedPath\signFolderOfStartFile().

                                           {
                 ilWACDummyCookie::clear();
                 ilWACSignedPath::setCookieMaxLifetimeInSeconds(self::LIFETIME);
                 $lifetime = ilWACSignedPath::getCookieMaxLifetimeInSeconds();
 
                 $signed_path = $this->file_one->url();
                 ilWACSignedPath::signFolderOfStartFile($signed_path, new ilWACDummyCookie());
 
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), new ilWACDummyCookie());
                 $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, new ilWACDummyCookie());
                 sleep($lifetime + self::ADDITIONAL_TIME);
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), new ilWACDummyCookie());
                 $this->assertTrue($ilWACSignedPath->isFolderSigned());
                 $this->assertFalse($ilWACSignedPath->isFolderTokenValid());
 
                 // Revalidating cookie
                 $ilWACSignedPath->revalidatingFolderToken();
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($signed_path), new ilWACDummyCookie());
                 $this->assertTrue($ilWACSignedPath->isFolderSigned());
                 $this->assertTrue($ilWACSignedPath->isFolderTokenValid());
 
                 // Check other file
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_three->url()), new ilWACDummyCookie());
                 $this->assertTrue($ilWACSignedPath->isFolderSigned());
                 $this->assertTrue($ilWACSignedPath->isFolderTokenValid());
         }

Here is the call graph for this function:

◆ testFolderTokenWithSecondFile()

ilWACTokenTest::testFolderTokenWithSecondFile ( )

Definition at line 238 of file ilWACTokenTest.php.

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

                                                         {
                 ilWACSignedPath::setCookieMaxLifetimeInSeconds(self::LIFETIME);
                 $lifetime = ilWACSignedPath::getCookieMaxLifetimeInSeconds();
                 // Sign File One
                 $ilWACCookieInterface = new ilWACDummyCookie();
                 ilWACSignedPath::signFolderOfStartFile($this->file_one->url(), $ilWACCookieInterface);
                 // Check File Two
                 $file_two = $this->file_two->url();
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($file_two), $ilWACCookieInterface);
                 $this->assertTrue($ilWACSignedPath->isFolderSigned());
                 $this->assertTrue($ilWACSignedPath->isFolderTokenValid());
 
                 // Request after lifetime
                 ilWACSignedPath::signFolderOfStartFile($file_two, $ilWACCookieInterface);
                 sleep($lifetime + self::ADDITIONAL_TIME);
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($file_two), $ilWACCookieInterface);
                 $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()), $ilWACCookieInterface);
                 $this->assertTrue($ilWACSignedPath->isFolderSigned());
                 $this->assertTrue($ilWACSignedPath->isFolderTokenValid());
         }

Here is the call graph for this function:

◆ testModifiedTimestampAddTime()

ilWACTokenTest::testModifiedTimestampAddTime ( )

Definition at line 276 of file ilWACTokenTest.php.

References getModifiedSignedPath().

                                                        {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(self::ADDITIONAL_TIME, 0)));
                 $this->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testModifiedTimestampNoMod()

ilWACTokenTest::testModifiedTimestampNoMod ( )

Definition at line 269 of file ilWACTokenTest.php.

References getModifiedSignedPath().

                                                      {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(0, 0)));
                 $this->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertTrue($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testModifiedTimestampSubTime()

ilWACTokenTest::testModifiedTimestampSubTime ( )

Definition at line 283 of file ilWACTokenTest.php.

References getModifiedSignedPath().

                                                        {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(self::ADDITIONAL_TIME * - 1, 0)));
                 $this->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testModifiedToken()

ilWACTokenTest::testModifiedToken ( )

Definition at line 304 of file ilWACTokenTest.php.

References getModifiedSignedPath().

                                             {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(0, 0, md5('LOREM'))));
                 $this->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testModifiedTTL()

ilWACTokenTest::testModifiedTTL ( )

Definition at line 290 of file ilWACTokenTest.php.

References getModifiedSignedPath().

                                           {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(0, 1)));
                 $this->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testModifiedTTLAndTimestamp()

ilWACTokenTest::testModifiedTTLAndTimestamp ( )

Definition at line 297 of file ilWACTokenTest.php.

References getModifiedSignedPath().

                                                       {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->getModifiedSignedPath(1, 1)));
                 $this->assertTrue($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
         }

Here is the call graph for this function:

◆ testSomeBasics()

ilWACTokenTest::testSomeBasics ( )

Definition at line 110 of file ilWACTokenTest.php.

References $query, ilWACToken\DEBUG, ilWACLog\getInstance(), and ilWebAccessChecker\isDEBUG().

                                          {
                 $query = 'myparam=1234';
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_four->url() . '?' . $query), new ilWACDummyCookie());
 
                 $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());
 
                 $this->assertEquals('ilWACLogDummy', get_class(ilWACLog::getInstance()));
 
                 $this->assertFalse(ilWebAccessChecker::isDEBUG());
                 $this->assertFalse(ilWACToken::DEBUG);
         }

Here is the call graph for this function:

◆ testTokenGeneration()

ilWACTokenTest::testTokenGeneration ( )

Definition at line 127 of file ilWACTokenTest.php.

References $_SERVER, ilWACToken\getSALT(), ilWebAccessChecker\setDEBUG(), and ilWACToken\setIp().

                                               {
                 ilWebAccessChecker::setDEBUG(false);
                 $ilWacPath = new ilWacPath($this->file_four->url());
                 $ilWACToken = new ilWACToken($ilWacPath->getPath(), self::CLIENT_NAME, 123456, 20);
                 $ilWACToken->setIp('127.0.0.1');
                 $ilWACToken->generateToken();
                 $this->assertEquals('SALT-127.0.0.1-client_name-123456-20', $ilWACToken->getRawToken());
                 $this->assertEquals('./data/client_name/sec/ilBlog/mm_124/dummy.jpg', $ilWACToken->getId());
 
                 ilWebAccessChecker::setDEBUG(false);
                 $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
                 $this->assertEquals(self::SALT, ilWACToken::getSALT());
                 $ilWACToken = new ilWACToken($ilWacPath->getPath(), self::CLIENT_NAME, 123456, 20);
                 $this->assertEquals('cd5a43304b232c785ef4f9796053b8bf5d6d829a', $ilWACToken->getToken());
                 $this->assertEquals('e45b98f267dc891c8206c844f7df29ea', $ilWACToken->getHashedId());
         }

Here is the call graph for this function:

◆ testWithoutSigning()

ilWACTokenTest::testWithoutSigning ( )

Definition at line 100 of file ilWACTokenTest.php.

                                              {
                 $ilWACSignedPath = new ilWACSignedPath(new ilWACPath($this->file_one->url()), new ilWACDummyCookie());
 
                 $this->assertFalse($ilWACSignedPath->isSignedPath());
                 $this->assertFalse($ilWACSignedPath->isSignedPathValid());
                 $this->assertFalse($ilWACSignedPath->isFolderSigned());
                 $this->assertFalse($ilWACSignedPath->isFolderTokenValid());
         }

Field Documentation

◆ $backupGlobals

ilWACTokenTest::$backupGlobals = false

protected

Definition at line 46 of file ilWACTokenTest.php.

◆ $file_four

ilWACTokenTest::$file_four

protected

Definition at line 70 of file ilWACTokenTest.php.

◆ $file_one

ilWACTokenTest::$file_one

protected

Definition at line 50 of file ilWACTokenTest.php.

◆ $file_one_subfolder

ilWACTokenTest::$file_one_subfolder

protected

Definition at line 54 of file ilWACTokenTest.php.

◆ $file_one_subfolder_two

ilWACTokenTest::$file_one_subfolder_two

protected

Definition at line 58 of file ilWACTokenTest.php.

◆ $file_three

ilWACTokenTest::$file_three

protected

Definition at line 66 of file ilWACTokenTest.php.

◆ $file_two

ilWACTokenTest::$file_two

protected

Definition at line 62 of file ilWACTokenTest.php.

Referenced by testFolderTokenWithSecondFile().

◆ $root

ilWACTokenTest::$root

protected

Definition at line 74 of file ilWACTokenTest.php.

◆ ADDITIONAL_TIME

const ilWACTokenTest::ADDITIONAL_TIME = 0.5

Definition at line 39 of file ilWACTokenTest.php.

◆ CLIENT_NAME

const ilWACTokenTest::CLIENT_NAME = 'client_name'

Definition at line 42 of file ilWACTokenTest.php.

◆ LIFETIME

const ilWACTokenTest::LIFETIME = 1

Definition at line 40 of file ilWACTokenTest.php.

◆ SALT

const ilWACTokenTest::SALT = 'SALT'

Definition at line 41 of file ilWACTokenTest.php.

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

Services/WebAccessChecker/test/Token/ilWACTokenTest.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getModifiedSignedPath()

◆ setUp()

◆ testCookieGeneration()

◆ testFileToken()

◆ testFolderToken()

◆ testFolderTokenWithSecondFile()

◆ testModifiedTimestampAddTime()

◆ testModifiedTimestampNoMod()

◆ testModifiedTimestampSubTime()

◆ testModifiedToken()

◆ testModifiedTTL()

◆ testModifiedTTLAndTimestamp()

◆ testSomeBasics()

◆ testTokenGeneration()

◆ testWithoutSigning()

Field Documentation

◆ $backupGlobals

◆ $file_four

◆ $file_one

◆ $file_one_subfolder

◆ $file_one_subfolder_two

◆ $file_three

◆ $file_two

◆ $root

◆ ADDITIONAL_TIME

◆ CLIENT_NAME

◆ LIFETIME

◆ SALT