ilWACToken Class Reference

Class ilWACToken. More...

Collaboration diagram for ilWACToken:

Public Member Functions
	__construct ($path, $client, $timestamp=0, $ttl=0)
	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	SALT_FILE_PATH = './data/wacsalt.php'

Protected Member Functions
	initSalt ()
	generateSaltFile ()

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 12 of file class.ilWACToken.php.

Constructor & Destructor Documentation

__construct()

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

ilWACToken constructor.

Parameters

string	$path
string	$client
int	$timestamp
int	$ttl

Definition at line 65 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.

    {
        assert(is_string($path));
        assert(is_string($client));
        assert(is_int($timestamp));
        assert(is_int($ttl));
        $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

Returns

void

Exceptions

ilWACException

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

References $template, ilWACException\DATA_DIR_NON_WRITEABLE, and time.

Referenced by initSalt().

    {
        if (is_file(self::SALT_FILE_PATH)) {
            unlink(self::SALT_FILE_PATH);
        }
        $template = file_get_contents('./Services/WebAccessChecker/wacsalt.php.template');
        $random = new \ilRandom();
        $salt = md5(time() * $random->int(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);
        }
    }

Here is the caller graph for this function:

generateToken()

ilWACToken::generateToken

(

)

Returns

void

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

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

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

    {
        $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 298 of file class.ilWACToken.php.

References $client.

Referenced by generateToken().

    {
        return (string) $this->client;
    }

Here is the caller graph for this function:

getHashedId()

ilWACToken::getHashedId

(

)

Returns

string

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

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

getId()

ilWACToken::getId

(

)

Returns

string

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

References $id.

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

getIp()

ilWACToken::getIp

(

)

Returns

string

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

References $ip.

    {
        return (string) $this->ip;
    }

getPath()

ilWACToken::getPath

(

)

Returns

string

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

References $path.

Referenced by __construct().

    {
        return (string) $this->path;
    }

Here is the caller graph for this function:

getRawToken()

ilWACToken::getRawToken

(

)

Returns

string

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

References $raw_token.

    {
        return (string) $this->raw_token;
    }

getSALT()

static ilWACToken::getSALT ( )

static

Returns

string

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

Referenced by ilWACTokenTest\testTokenGeneration().

    {
        return (string) self::$SALT;
    }

Here is the caller graph for this function:

getSessionId()

ilWACToken::getSessionId

(

)

Returns

string

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

References $session_id.

    {
        return (string) $this->session_id;
    }

getTimestamp()

ilWACToken::getTimestamp

(

)

Returns

int

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

References $timestamp.

Referenced by generateToken().

    {
        return (int) $this->timestamp;
    }

Here is the caller graph for this function:

getToken()

ilWACToken::getToken

(

)

Returns

string

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

References $token.

    {
        return (string) $this->token;
    }

getTTL()

ilWACToken::getTTL

(

)

Returns

int

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

References $ttl.

Referenced by generateToken().

    {
        return (int) $this->ttl;
    }

Here is the caller graph for this function:

initSalt()

ilWACToken::initSalt ( )

protected

Returns

void

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

References generateSaltFile().

Referenced by generateToken().

    {
        if (self::getSALT()) {
            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();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setClient()

ilWACToken::setClient

(

$client

)

Parameters

string

$client

Returns

void

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

References $client.

Referenced by __construct().

    {
        assert(is_string($client));
        $this->client = $client;
    }

Here is the caller graph for this function:

setId()

ilWACToken::setId

(

$id

)

Parameters

string

$id

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

References $id.

Referenced by __construct().

    {
        assert(is_string($id));
        $this->id = $id;
    }

Here is the caller graph for this function:

setIp()

ilWACToken::setIp

(

$ip

)

Parameters

string

$ip

Returns

void

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

References $ip.

Referenced by __construct().

    {
        assert(is_string($ip));
        $this->ip = $ip;
    }

Here is the caller graph for this function:

setPath()

ilWACToken::setPath

(

$path

)

Parameters

string

$path

Returns

void

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

References $path.

Referenced by __construct().

    {
        assert(is_string($path));
        $this->path = $path;
    }

Here is the caller graph for this function:

setRawToken()

ilWACToken::setRawToken

(

$raw_token

)

Parameters

string

$raw_token

Returns

void

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

References $raw_token.

Referenced by generateToken().

    {
        assert(is_string($raw_token));
        $this->raw_token = $raw_token;
    }

Here is the caller graph for this function:

setSALT()

static ilWACToken::setSALT (   $salt )

static

Parameters

string

$salt

Returns

void

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

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

    {
        assert(is_string($salt));
        self::$SALT = $salt;
    }

Here is the caller graph for this function:

setSessionId()

ilWACToken::setSessionId

(

$session_id

)

Parameters

string

$session_id

Returns

void

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

References $session_id.

Referenced by __construct().

    {
        assert(is_string($session_id));
        $this->session_id = $session_id;
    }

Here is the caller graph for this function:

setTimestamp()

ilWACToken::setTimestamp

(

$timestamp

)

Parameters

int

$timestamp

Returns

void

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

References $timestamp.

Referenced by __construct().

    {
        assert(is_int($timestamp));
        $this->timestamp = $timestamp;
    }

Here is the caller graph for this function:

setToken()

ilWACToken::setToken

(

$token

)

Parameters

string

$token

Returns

void

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

References $token.

Referenced by generateToken().

    {
        assert(is_string($token));
        $this->token = $token;
    }

Here is the caller graph for this function:

setTTL()

ilWACToken::setTTL

(

$ttl

)

Parameters

int

$ttl

Returns

void

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

References $ttl.

Referenced by __construct().

    {
        assert(is_int($ttl));
        $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.

$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().

SALT_FILE_PATH

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

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