Collaboration diagram for ilWACToken:

Public Member Functions
	__construct ($path, $client, $timestamp=null, $ttl=null)
	ilWACToken constructor. More...

	generateToken ()

	getSessionId ()

	setSessionId ($session_id)

	getTimestamp ()

	setTimestamp ($timestamp)

	getIp ()

	setIp ($ip)

	getToken ()

	setToken ($token)

	getPath ()

	setPath ($path)

	getId ()

	getHashedId ()

	setId ($id)

	getClient ()

	setClient ($client)

	getTTL ()

	setTTL ($ttl)

	getRawToken ()

	setRawToken ($raw_token)

Static Public Member Functions
static	getSALT ()

static	setSALT ($SALT)

Data Fields
const	DEBUG = false

const	TYPE_FILE = ilWACSignedPath::TYPE_FILE

const	TYPE_FOLDER = ilWACSignedPath::TYPE_FOLDER

Protected Member Functions
	getSaltFilePath ()

	initSalt ()

	generateSaltFile ()

Static Protected Member Functions
static	isDEBUG ()

Protected Attributes
	$session_id = ''

	$timestamp = 0

	$ip = ''

	$token = ''

	$raw_token = ''

	$path = ''

	$id = ''

	$client = ''

	$ttl = 0

Static Protected Attributes
static	$SALT = ''

Detailed Description

Class ilWACToken.

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

Version: 1.0.0

Definition at line 10 of file class.ilWACToken.php.

Constructor & Destructor Documentation

◆ __construct()

ilWACToken::__construct	(	$path,
		$client,
		$timestamp = `null`,
		$ttl = `null`
	)

ilWACToken constructor.

Parameters

	$path
	$client
null	$timestamp

Definition at line 64 of file class.ilWACToken.php.

References $_SERVER, $client, $path, $session_id, $timestamp, $ttl, generateToken(), getPath(), ilWACSignedPath\getTokenMaxLifetimeInSeconds(), setClient(), setId(), setIp(), setPath(), setSessionId(), setTimestamp(), setTTL(), and time.

                                                                                     {
                 $this->setClient($client);
                 $this->setPath($path);
                 $session_id = session_id();
                 $this->setSessionId($session_id ? $session_id : '-');
                 if (isset($_SERVER['REMOTE_ADDR'])) {
                         $this->setIp($_SERVER['REMOTE_ADDR']);
                 }
                 $this->setTimestamp($timestamp ? $timestamp : time());
                 $ttl = $ttl ? $ttl : ilWACSignedPath::getTokenMaxLifetimeInSeconds();
                 $this->setTTL($ttl); //  since we do not know the type at this poit we choose the shorter duration for security reasons
                 $this->generateToken();
                 $this->setId($this->getPath());
         }

Here is the call graph for this function:

Member Function Documentation

◆ generateSaltFile()

ilWACToken::generateSaltFile ( )

protected

Definition at line 127 of file class.ilWACToken.php.

References ilWACException\DATA_DIR_NON_WRITEABLE, getSaltFilePath(), and time.

Referenced by initSalt().

                                               {
                 if (is_file($this->getSaltFilePath())) {
                         unlink($this->getSaltFilePath());
                 }
                 $template = file_get_contents('./Services/WebAccessChecker/wacsalt.php.template');
                 $salt = md5(time() * rand(1000, 9999) . $this->getSaltFilePath());
                 self::setSALT($salt);
                 $template = str_replace('INSERT_SALT', $salt, $template);
                 if (is_writable(dirname($this->getSaltFilePath()))) {
                         file_put_contents($this->getSaltFilePath(), $template);
                 } else {
                         throw new ilWACException(ilWACException::DATA_DIR_NON_WRITEABLE, $this->getSaltFilePath());
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateToken()

ilWACToken::generateToken ( )

Definition at line 88 of file class.ilWACToken.php.

References $token, array, getClient(), getTimestamp(), getTTL(), initSalt(), setRawToken(), and setToken().

Referenced by __construct().

                                         {
                 $this->initSalt();
                 $token = implode('-', array(
                         self::getSALT(),
                         $this->getClient(),
                         $this->getTimestamp(),
                         $this->getTTL(),
                 ));
                 $this->setRawToken($token);
                 $token = sha1($token);
                 $this->setToken($token);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClient()

ilWACToken::getClient ( )

Returns: string

Definition at line 266 of file class.ilWACToken.php.

References $client.

Referenced by generateToken().

                                     {
                 return $this->client;
         }

Here is the caller graph for this function:

◆ getHashedId()

ilWACToken::getHashedId ( )

Returns: string

Definition at line 234 of file class.ilWACToken.php.

                                       {
                 return md5($this->id);
         }

◆ getId()

ilWACToken::getId ( )

Returns: string

Definition at line 226 of file class.ilWACToken.php.

References $id.

                                 {
                 return $this->id;
         }

◆ getIp()

ilWACToken::getIp ( )

Returns: string

Definition at line 178 of file class.ilWACToken.php.

References $ip.

                                 {
                 return $this->ip;
         }

◆ getPath()

ilWACToken::getPath ( )

Returns: string

Definition at line 210 of file class.ilWACToken.php.

References $path.

Referenced by __construct().

                                   {
                 return $this->path;
         }

Here is the caller graph for this function:

◆ getRawToken()

ilWACToken::getRawToken ( )

Returns: string

Definition at line 298 of file class.ilWACToken.php.

References $raw_token.

                                       {
                 return $this->raw_token;
         }

◆ getSALT()

static ilWACToken::getSALT ( )

static

Returns: string

Definition at line 250 of file class.ilWACToken.php.

Referenced by ilWACTokenTest\testTokenGeneration().

                                          {
                 return self::$SALT;
         }

Here is the caller graph for this function:

◆ getSaltFilePath()

ilWACToken::getSaltFilePath ( )

protected

Returns: string

Definition at line 105 of file class.ilWACToken.php.

Referenced by generateSaltFile(), and initSalt().

                                              {
                 $salt_file = './data/wacsalt.php';
 
                 return $salt_file;
         }

Here is the caller graph for this function:

◆ getSessionId()

ilWACToken::getSessionId ( )

Returns: string

Definition at line 146 of file class.ilWACToken.php.

References $session_id.

                                        {
                 return $this->session_id;
         }

◆ getTimestamp()

ilWACToken::getTimestamp ( )

Returns: int

Definition at line 162 of file class.ilWACToken.php.

References $timestamp.

Referenced by generateToken().

                                        {
                 return $this->timestamp;
         }

Here is the caller graph for this function:

◆ getToken()

ilWACToken::getToken ( )

Returns: string

Definition at line 194 of file class.ilWACToken.php.

References $token.

                                    {
                 return $this->token;
         }

◆ getTTL()

ilWACToken::getTTL ( )

Returns: int

Definition at line 282 of file class.ilWACToken.php.

References $ttl.

Referenced by generateToken().

                                  {
                 return $this->ttl;
         }

Here is the caller graph for this function:

◆ initSalt()

ilWACToken::initSalt ( )

protected

Definition at line 112 of file class.ilWACToken.php.

References generateSaltFile(), and getSaltFilePath().

Referenced by generateToken().

                                       {
                 if (self::getSALT()) {
                         return true;
                 }
                 $salt = null;
                 if (is_file($this->getSaltFilePath())) {
                         include($this->getSaltFilePath());
                 }
                 self::setSALT($salt);
                 if (!$salt) {
                         $this->generateSaltFile();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDEBUG()

static ilWACToken::isDEBUG ( )

staticprotected

Returns: bool

Definition at line 83 of file class.ilWACToken.php.

References DEBUG, and ilWebAccessChecker\isDEBUG().

                                             {
                 return (ilWebAccessChecker::isDEBUG() || self::DEBUG);
         }

Here is the call graph for this function:

◆ setClient()

ilWACToken::setClient ( $client )

Parameters

string $client

Definition at line 274 of file class.ilWACToken.php.

References $client.

Referenced by __construct().

                                            {
                 $this->client = $client;
         }

Here is the caller graph for this function:

◆ setId()

ilWACToken::setId ( $id )

Parameters

string $id

Definition at line 242 of file class.ilWACToken.php.

References $id.

Referenced by __construct().

                                    {
                 $this->id = $id;
         }

Here is the caller graph for this function:

◆ setIp()

ilWACToken::setIp ( $ip )

Parameters

string $ip

Definition at line 186 of file class.ilWACToken.php.

References $ip.

Referenced by __construct(), and ilWACTokenTest\testTokenGeneration().

                                    {
                 $this->ip = $ip;
         }

Here is the caller graph for this function:

◆ setPath()

ilWACToken::setPath ( $path )

Parameters

string $path

Definition at line 218 of file class.ilWACToken.php.

References $path.

Referenced by __construct().

                                        {
                 $this->path = $path;
         }

Here is the caller graph for this function:

◆ setRawToken()

ilWACToken::setRawToken ( $raw_token )

Parameters

string $raw_token

Definition at line 306 of file class.ilWACToken.php.

References $raw_token.

Referenced by generateToken().

                                                 {
                 $this->raw_token = $raw_token;
         }

Here is the caller graph for this function:

◆ setSALT()

static ilWACToken::setSALT ( $SALT )

static

Parameters

string $SALT

Definition at line 258 of file class.ilWACToken.php.

References $SALT.

Referenced by ilWACCheckingInstanceTest\setUp(), and ilWACTokenTest\setUp().

                                               {
                 self::$SALT = $SALT;
         }

Here is the caller graph for this function:

◆ setSessionId()

ilWACToken::setSessionId ( $session_id )

Parameters

string $session_id

Definition at line 154 of file class.ilWACToken.php.

References $session_id.

Referenced by __construct().

                                                   {
                 $this->session_id = $session_id;
         }

Here is the caller graph for this function:

◆ setTimestamp()

ilWACToken::setTimestamp ( $timestamp )

Parameters

int $timestamp

Definition at line 170 of file class.ilWACToken.php.

References $timestamp.

Referenced by __construct().

                                                  {
                 $this->timestamp = $timestamp;
         }

Here is the caller graph for this function:

◆ setToken()

ilWACToken::setToken ( $token )

Parameters

string $token

Definition at line 202 of file class.ilWACToken.php.

References $token.

Referenced by generateToken().

                                          {
                 $this->token = $token;
         }

Here is the caller graph for this function:

◆ setTTL()

ilWACToken::setTTL ( $ttl )

Parameters

int $ttl

Definition at line 290 of file class.ilWACToken.php.

References $ttl.

Referenced by __construct().

                                      {
                 $this->ttl = $ttl;
         }

Here is the caller graph for this function:

Field Documentation

◆ $client

ilWACToken::$client = ''

protected

Definition at line 50 of file class.ilWACToken.php.

Referenced by __construct(), getClient(), and setClient().

◆ $id

ilWACToken::$id = ''

protected

Definition at line 46 of file class.ilWACToken.php.

Referenced by getId(), and setId().

◆ $ip

ilWACToken::$ip = ''

protected

Definition at line 30 of file class.ilWACToken.php.

Referenced by getIp(), and setIp().

◆ $path

ilWACToken::$path = ''

protected

Definition at line 42 of file class.ilWACToken.php.

Referenced by __construct(), getPath(), and setPath().

◆ $raw_token

ilWACToken::$raw_token = ''

protected

Definition at line 38 of file class.ilWACToken.php.

Referenced by getRawToken(), and setRawToken().

◆ $SALT

ilWACToken::$SALT = ''

staticprotected

Definition at line 18 of file class.ilWACToken.php.

Referenced by setSALT().

◆ $session_id

ilWACToken::$session_id = ''

protected

Definition at line 22 of file class.ilWACToken.php.

Referenced by __construct(), getSessionId(), and setSessionId().

◆ $timestamp

ilWACToken::$timestamp = 0

protected

Definition at line 26 of file class.ilWACToken.php.

Referenced by __construct(), getTimestamp(), and setTimestamp().

◆ $token

ilWACToken::$token = ''

protected

Definition at line 34 of file class.ilWACToken.php.

Referenced by generateToken(), getToken(), and setToken().

◆ $ttl

ilWACToken::$ttl = 0

protected

Definition at line 54 of file class.ilWACToken.php.

Referenced by __construct(), getTTL(), and setTTL().

◆ DEBUG

const ilWACToken::DEBUG = false

Definition at line 12 of file class.ilWACToken.php.

Referenced by ilWACTokenTest\testSomeBasics().

◆ TYPE_FILE

const ilWACToken::TYPE_FILE = ilWACSignedPath::TYPE_FILE

Definition at line 13 of file class.ilWACToken.php.

◆ TYPE_FOLDER

const ilWACToken::TYPE_FOLDER = ilWACSignedPath::TYPE_FOLDER

Definition at line 14 of file class.ilWACToken.php.

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

Services/WebAccessChecker/classes/class.ilWACToken.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ generateSaltFile()

◆ generateToken()

◆ getClient()

◆ getHashedId()

◆ getId()

◆ getIp()

◆ getPath()

◆ getRawToken()

◆ getSALT()

◆ getSaltFilePath()

◆ getSessionId()

◆ getTimestamp()

◆ getToken()

◆ getTTL()

◆ initSalt()

◆ isDEBUG()

◆ setClient()

◆ setId()

◆ setIp()

◆ setPath()

◆ setRawToken()

◆ setSALT()

◆ setSessionId()

◆ setTimestamp()

◆ setToken()

◆ setTTL()

Field Documentation

◆ $client

◆ $id

◆ $ip

◆ $path

◆ $raw_token

◆ $SALT

◆ $session_id

◆ $timestamp

◆ $token

◆ $ttl

◆ DEBUG

◆ TYPE_FILE

◆ TYPE_FOLDER