ilWACToken Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilWACToken:

Public Member Functions
	__construct (string $path, string $client, int $timestamp=0, int $ttl=0)
	ilWACToken constructor. More...
	generateToken ()
	getSessionId ()
	setSessionId (string $session_id)
	getTimestamp ()
	setTimestamp (int $timestamp)
	getIp ()
	setIp (string $ip)
	getToken ()
	setToken (string $token)
	getPath ()
	setPath (string $path)
	getId ()
	getHashedId ()
	setId (string $id)
	getClient ()
	setClient (string $client)
	getTTL ()
	setTTL (int $ttl)
	getRawToken ()
	setRawToken (string $raw_token)

Static Public Member Functions
static	getSALT ()
static	setSALT (string $salt)

Protected Member Functions
	initSalt ()
	generateSaltFile ()

Protected Attributes
string	$session_id = ''
int	$timestamp = 0
string	$ip = ''
string	$token = ''
string	$raw_token = ''
string	$path = ''
string	$id = ''
string	$client = ''
int	$ttl = 0

Static Protected Attributes
static string	$SALT = ''

Private Attributes
const	SALT_FILE_PATH = __DIR__ . '/../../../../public/data/wacsalt.php'

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

ilWACToken::__construct	(	string	$path,
		string	$client,
		int	$timestamp = 0,
		int	$ttl = 0
	)

ilWACToken constructor.

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

      {
        $this->setClient($client);
        $this->setPath($path);
        $session_id = session_id();
        $this->setSessionId($session_id ?: '-');
        if (isset($_SERVER['REMOTE_ADDR'])) {
            $this->setIp($_SERVER['REMOTE_ADDR']);
        }
        $this->setTimestamp($timestamp !== 0 ? $timestamp : time());
        $ttl = $ttl !== 0 ? $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());
    }

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

Here is the call graph for this function:

Member Function Documentation

generateSaltFile()

ilWACToken::generateSaltFile ( )

protected

Exceptions

ilWACException

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

                                         : void
    {
        if (is_file(self::SALT_FILE_PATH)) {
            unlink(self::SALT_FILE_PATH);
        }
        $template = file_get_contents(__DIR__ . '/../wacsalt.php.template');
        $random = new \Random\Randomizer();
        $salt = md5(time() * $random->getInt(1000, 9999) . self::SALT_FILE_PATH);
        self::setSALT($salt);
        $template = str_replace('INSERT_SALT', $salt, $template);
        if (is_writable(dirname(self::SALT_FILE_PATH))) {
            file_put_contents(self::SALT_FILE_PATH, $template);
        } else {
            throw new ilWACException(ilWACException::DATA_DIR_NON_WRITEABLE, self::SALT_FILE_PATH);
        }
    }

References ilWACException\DATA_DIR_NON_WRITEABLE, and setSALT().

Referenced by initSalt().

Here is the call graph for this function:

Here is the caller graph for this function:

generateToken()

ilWACToken::generateToken

(

)

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

getClient()

ilWACToken::getClient

(

)

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

                               : string
    {
        return $this->client;
    }

References $client.

Referenced by generateToken().

Here is the caller graph for this function:

getHashedId()

ilWACToken::getHashedId

(

)

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

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

getId()

ilWACToken::getId

(

)

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

                           : string
    {
        return $this->id;
    }

References $id.

getIp()

ilWACToken::getIp

(

)

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

                           : string
    {
        return $this->ip;
    }

References $ip.

getPath()

ilWACToken::getPath

(

)

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

                             : string
    {
        return $this->path;
    }

References $path.

Referenced by __construct().

Here is the caller graph for this function:

getRawToken()

ilWACToken::getRawToken

(

)

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

                                 : string
    {
        return $this->raw_token;
    }

References $raw_token.

getSALT()

static ilWACToken::getSALT ( )

static

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

                                    : string
    {
        return self::$SALT;
    }

References $SALT.

Referenced by ilWACTokenTest\testTokenGeneration().

Here is the caller graph for this function:

getSessionId()

ilWACToken::getSessionId

(

)

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

                                  : string
    {
        return $this->session_id;
    }

References $session_id.

getTimestamp()

ilWACToken::getTimestamp

(

)

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

                                  : int
    {
        return $this->timestamp;
    }

References $timestamp.

Referenced by generateToken().

Here is the caller graph for this function:

getToken()

ilWACToken::getToken

(

)

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

                              : string
    {
        return $this->token;
    }

References $token.

getTTL()

ilWACToken::getTTL

(

)

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

                            : int
    {
        return $this->ttl;
    }

References $ttl.

Referenced by generateToken().

Here is the caller graph for this function:

initSalt()

ilWACToken::initSalt ( )

protected

@noRector

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

                                 : void
    {
        if (self::getSALT() !== '' && self::getSALT() !== '0') {
            return;
        }
        $salt = '';
        if (is_file(self::SALT_FILE_PATH)) {
            require self::SALT_FILE_PATH;
            self::setSALT($salt);
        }
 
        if (strcmp($salt, '') === 0) {
            $this->generateSaltFile();
            $this->initSalt();
        }
    }

References generateSaltFile(), initSalt(), SALT_FILE_PATH, and setSALT().

Referenced by generateToken(), and initSalt().

Here is the call graph for this function:

Here is the caller graph for this function:

setClient()

ilWACToken::setClient

(

string

$client

)

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

                                             : void
    {
        $this->client = $client;
    }

References $client, and ILIAS\UI\examples\Progress\Bar\client().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

setId()

ilWACToken::setId

(

string

$id

)

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

                                     : void
    {
        $this->id = $id;
    }

References $id.

Referenced by __construct().

Here is the caller graph for this function:

setIp()

ilWACToken::setIp

(

string

$ip

)

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

                                     : void
    {
        $this->ip = $ip;
    }

References $ip.

Referenced by __construct().

Here is the caller graph for this function:

setPath()

ilWACToken::setPath

(

string

$path

)

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

                                         : void
    {
        $this->path = $path;
    }

References $path.

Referenced by __construct().

Here is the caller graph for this function:

setRawToken()

ilWACToken::setRawToken

(

string

$raw_token

)

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

                                                  : void
    {
        $this->raw_token = $raw_token;
    }

References $raw_token.

Referenced by generateToken().

Here is the caller graph for this function:

setSALT()

static ilWACToken::setSALT ( string  $salt )

static

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

                                                : void
    {
        self::$SALT = $salt;
    }

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

Here is the caller graph for this function:

setSessionId()

ilWACToken::setSessionId

(

string

$session_id

)

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

                                                    : void
    {
        $this->session_id = $session_id;
    }

References $session_id.

Referenced by __construct().

Here is the caller graph for this function:

setTimestamp()

ilWACToken::setTimestamp

(

int

$timestamp

)

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

                                                : void
    {
        $this->timestamp = $timestamp;
    }

References $timestamp.

Referenced by __construct().

Here is the caller graph for this function:

setToken()

ilWACToken::setToken

(

string

$token

)

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

                                           : void
    {
        $this->token = $token;
    }

References $token.

Referenced by generateToken().

Here is the caller graph for this function:

setTTL()

ilWACToken::setTTL

(

int

$ttl

)

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

                                    : void
    {
        $this->ttl = $ttl;
    }

References $ttl.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$client

string ilWACToken::$client = ''

protected

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

Referenced by getClient(), and setClient().

$id

string ilWACToken::$id = ''

protected

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

Referenced by getId(), and setId().

$ip

string ilWACToken::$ip = ''

protected

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

Referenced by getIp(), and setIp().

$path

string ilWACToken::$path = ''

protected

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

Referenced by getPath(), and setPath().

$raw_token

string ilWACToken::$raw_token = ''

protected

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

Referenced by getRawToken(), and setRawToken().

$SALT

string ilWACToken::$SALT = ''

staticprotected

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

Referenced by getSALT().

$session_id

string ilWACToken::$session_id = ''

protected

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

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

$timestamp

int ilWACToken::$timestamp = 0

protected

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

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

$token

string ilWACToken::$token = ''

protected

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

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

$ttl

int ilWACToken::$ttl = 0

protected

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

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

SALT_FILE_PATH

const ilWACToken::SALT_FILE_PATH = __DIR__ . '/../../../../public/data/wacsalt.php'

private

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

Referenced by initSalt().

---

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

• components/ILIAS/WebAccessChecker/classes/class.ilWACToken.php