class.ilWACToken.php

Go to the documentation of this file.

<?php
require_once('class.ilWACSignedPath.php');

class ilWACToken {

        const DEBUG = false;
        const TYPE_FILE = ilWACSignedPath::TYPE_FILE;
        const TYPE_FOLDER = ilWACSignedPath::TYPE_FOLDER;
        protected static $SALT = '';
        protected $session_id = '';
        protected $timestamp = 0;
        protected $ip = '';
        protected $token = '';
        protected $raw_token = '';
        protected $path = '';
        protected $id = '';
        protected $client = '';
        protected $ttl = 0;


        public function __construct($path, $client, $timestamp = null, $ttl = null) {
                $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());
        }


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


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


        protected function getSaltFilePath() {
                $salt_file = './data/wacsalt.php';

                return $salt_file;
        }


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


        protected function generateSaltFile() {
                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());
                }
        }


        public function getSessionId() {
                return $this->session_id;
        }


        public function setSessionId($session_id) {
                $this->session_id = $session_id;
        }


        public function getTimestamp() {
                return $this->timestamp;
        }


        public function setTimestamp($timestamp) {
                $this->timestamp = $timestamp;
        }


        public function getIp() {
                return $this->ip;
        }


        public function setIp($ip) {
                $this->ip = $ip;
        }


        public function getToken() {
                return $this->token;
        }


        public function setToken($token) {
                $this->token = $token;
        }


        public function getPath() {
                return $this->path;
        }


        public function setPath($path) {
                $this->path = $path;
        }


        public function getId() {
                return $this->id;
        }


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


        public function setId($id) {
                $this->id = $id;
        }


        public static function getSALT() {
                return self::$SALT;
        }


        public static function setSALT($SALT) {
                self::$SALT = $SALT;
        }


        public function getClient() {
                return $this->client;
        }


        public function setClient($client) {
                $this->client = $client;
        }


        public function getTTL() {
                return $this->ttl;
        }


        public function setTTL($ttl) {
                $this->ttl = $ttl;
        }


        public function getRawToken() {
                return $this->raw_token;
        }


        public function setRawToken($raw_token) {
                $this->raw_token = $raw_token;
        }
}