split the stuff into different files
[GitHub/Stricted/speedport-hybrid-php-api.git] / SpeedportHybrid.class.php
index c8ee3cbbf0d860f1232b513404229915f2124749..892355a252ccac363dfcd17d6afe21d3a9338258 100644 (file)
@@ -1,10 +1,27 @@
 <?php
+require_once('RebootException.class.php');
+require_once('RouterException.class.php');
+require_once('CryptLib/CryptLib.php');
+require_once('Connection.class.php');
+require_once('Phone.class.php');
+require_once('System.class.php');
+
 /**
  * @author      Jan Altensen (Stricted)
  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @copyright   2015 Jan Altensen (Stricted)
  */
 class SpeedportHybrid {
+       use Connection;
+       use Phone;
+       use System;
+       
+       /**
+        * class version
+        * @const       string
+        */
+       const VERSION = '1.0.3';
+       
        /**
         * password-challenge
         * @var string
@@ -27,7 +44,7 @@ class SpeedportHybrid {
         * session cookie
         * @var string
         */
-       private $session = '';
+       private $cookie = '';
        
        /**
         * router url
@@ -41,33 +58,24 @@ class SpeedportHybrid {
         */
        private $derivedk = '';
        
-       public function __construct ($password, $url = 'http://speedport.ip/') {
+       public function __construct ($url = 'http://speedport.ip/') {
                $this->url = $url;
-               $this->getChallenge();
-               
-               if (empty($this->challenge)) {
-                       throw new Exception('unable to get the challenge from the router');
-               }
-               
-               $login = $this->login($password);
-               
-               if ($login === false) {
-                       throw new Exception('unable to login');
-               }
        }
        
        /**
         * Requests the password-challenge from the router.
         */
-       public function getChallenge () {
+       private function getChallenge () {
                $path = 'data/Login.json';
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'challengev' => 'null');
                $data = $this->sentRequest($path, $fields);
-               $data = json_decode($data['body'], true);
-               $data = $this->getValues($data);
+               $data = $this->getValues($data['body']);
                
                if (isset($data['challengev']) && !empty($data['challengev'])) {
-                       $this->challenge = $data['challengev'];
+                       return $data['challengev'];
+               }
+               else {
+                       throw new RouterException('unable to get the challenge from the router');
                }
        }
        
@@ -78,39 +86,24 @@ class SpeedportHybrid {
         * @return      boolean
         */
        public function login ($password) {
+               $this->challenge = $this->getChallenge();
+               
                $path = 'data/Login.json';
                $this->hash = hash('sha256', $this->challenge.':'.$password);
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash);
                $data = $this->sentRequest($path, $fields);
-               $json = json_decode($data['body'], true);
-               $json = $this->getValues($json);
+               $json = $this->getValues($data['body']);
+               
                if (isset($json['login']) && $json['login'] == 'success') {
-                       if (isset($data['header']['Set-Cookie']) && !empty($data['header']['Set-Cookie'])) {
-                               preg_match('/^.*(SessionID_R3=[a-z0-9]*).*/i', $data['header']['Set-Cookie'], $match);
-                               if (isset($match[1]) && !empty($match[1])) {
-                                       $this->session = $match[1];
-                               }
-                               else {
-                                       throw new Exception('unable to get the session cookie from the router');
-                               }
-                               
-                               // calculate derivedk
-                               if (!function_exists("hash_pbkdf2")) {
-                                       require_once 'CryptLib/CryptLib.php';
-                                       $pbkdf2 = new CryptLib\Key\Derivation\PBKDF\PBKDF2(array('hash' => 'sha1'));
-                                       $this->derivedk = bin2hex($pbkdf2->derive(hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32));
-                                       $this->derivedk = substr($this->derivedk, 0, 32);
-                               }
-                               else {
-                                       $this->derivedk = hash_pbkdf2('sha1', hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
-                               }
-                               
-                               // get the csrf_token
-                               $this->token = $this->getToken();
-                               
-                               if ($this->checkLogin() === true) {
-                                       return true;
-                               }
+                       $this->cookie = $this->getCookie($data);
+                       
+                       $this->derivedk = $this->getDerviedk($password);
+                       
+                       // get the csrf_token
+                       $this->token = $this->getToken();
+                       
+                       if ($this->checkLogin(false) === true) {
+                               return true;
                        }
                }
                
@@ -120,22 +113,29 @@ class SpeedportHybrid {
        /**
         * check if we are logged in
         *
-        * @return boolean
+        * @param       boolean $exception
+        * @return      boolean
         */
-       public function checkLogin () {
-               $path = 'data/SecureStatus.json';
-               $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get '.$file.' data');
+       public function checkLogin ($exception = true) {
+               // check if challenge or session is empty
+               if (empty($this->challenge) || empty($this->cookie)) {
+                       if ($exception === true) {
+                               throw new RouterException('you musst be logged in to use this method');
+                       }
+                       
+                       return false;
                }
                
-               $json = json_decode($data['body'], true);
-               $json = $this->getValues($json);
+               $path = 'data/SecureStatus.json';
+               $fields = array();
+               $data = $this->sentRequest($path, $fields, true);
+               $data = $this->getValues($data['body']);
                
-               if ($json['loginstate'] != 1) {
+               if ($data['loginstate'] != 1) {
+                       if ($exception === true) {
+                               throw new RouterException('you musst be logged in to use this method');
+                       }
+                       
                        return false;
                }
                
@@ -145,210 +145,54 @@ class SpeedportHybrid {
        /**
         * logout
         * 
-        * @return      array
+        * @return      boolean
         */
        public function logout () {
+               $this->checkLogin();
+               
                $path = 'data/Login.json';
-               $fields = array('csrf_token' =>  $this->token, 'logout' => 'byby');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               if ($this->checkLogin() === false) {
+               $fields = array('csrf_token' => $this->token, 'logout' => 'byby');
+               $data = $this->sentRequest($path, $fields, true);
+               $data = $this->getValues($data['body']);
+               if ((isset($data['status']) && $data['status'] == 'ok') && $this->checkLogin(false) === false) {
                        // reset challenge and session
                        $this->challenge = '';
-                       $this->session = '';
-                       $this->token = "";
-                       
-                       $json = json_decode($data['body'], true);
+                       $this->cookie = '';
+                       $this->token = '';
+                       $this->derivedk = '';
                        
-                       return $json;
-               }
-               else {
-                       throw new Exception('logout failed');
+                       return true;
                }
+               
+               return false;
        }
        
        /**
         * reboot the router
         * 
-        * @return      array
+        * @return      boolean
         */
        public function reboot () {
-               $path = 'data/Reboot.json';
-               $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'reboot_device' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               $json = json_decode($data['body'], true);
+               $this->checkLogin();
                
-               return $json;
-       }
-       
-       /**
-        * change dsl connection status
-        * 
-        * @param       string  $status
-        */
-       public function changeConnectionStatus ($status) {
-               $path = 'data/Connect.json';
+               $path = 'data/Reboot.json';
+               $fields = array('csrf_token' => $this->token, 'reboot_device' => 'true');
+               $data = $this->sentEncryptedRequest($path, $fields, true);
+               $data = $this->getValues($data['body']);
                
-               if ($status == 'online' || $status == 'offline') {
-                       $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'req_connect' => $status);
-                       $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-                       $data = $this->sentRequest($path, $fields, $cookie);
-                       
-                       $json = json_decode($this->decrypt($data['body']), true);
+               if ($data['status'] == 'ok') {
+                       // reset challenge and session
+                       $this->challenge = '';
+                       $this->cookie = '';
+                       $this->token = '';
+                       $this->derivedk = ''; 
                        
-                       return $json;
-               }
-               else {
-                       throw new Exception();
-               }
-       }
-       
-       /**
-        * return the given json as array
-        * 
-        * @param       string  $file
-        * @return      array
-        */
-       public function getData ($file) {
-               $path = 'data/'.$file.'.json';
-               $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get '.$file.' data');
-               }
-               
-               $json = json_decode($data['body'], true);
-               
-               return $json;
-       }
-       
-       /**
-        * get the router syslog
-        * 
-        * @return      array
-        */
-       public function getSyslog() {
-               $path = 'data/Syslog.json';
-               $fields = array('exporttype' => '0');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
-               }
-               
-               return explode("\n", $data['body']);
-       }
-       
-       /**
-        * get the Missed Calls from router
-        * 
-        * @return      array
-        */
-       public function getMissedCalls() {
-               $path = 'data/ExportMissedCalls.json';
-               $fields = array('exporttype' => '1');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
+                       // throw an exception because router is unavailable for other tasks
+                       // like $this->logout() or $this->checkLogin
+                       throw new RebootException('Router Reboot');
                }
                
-               return explode("\n", $data['body']);
-       }
-       
-       /**
-        * get the Taken Calls from router
-        * 
-        * @return      array
-        */
-       public function getTakenCalls() {
-               $path = 'data/ExportTakenCalls.json';
-               $fields = array('exporttype' => '2');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
-               }
-               
-               return explode("\n", $data['body']);
-       }
-       
-       /**
-        * get the Dialed Calls from router
-        * 
-        * @return      array
-        */
-       public function getDialedCalls() {
-               $path = 'data/ExportDialedCalls.json';
-               $fields = array('exporttype' => '3');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
-               }
-               
-               return explode("\n", $data['body']);
-       }
-       
-       /**
-        * reconnect LTE
-        *
-        * @return      array
-        */
-       public function reconnectLte () {
-               $path = 'data/modules.json';
-               $fields = array('csrf_token' => $this->token, 'lte_reconn' => '1');
-               $fields = $this->encrypt($fields);
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie, 2);
-               $json = json_decode($data['body'], true);
-               
-               return $json;
-       }
-       
-       /**
-        * reset the router to Factory Default
-        * not tested
-        *
-        * @return      array
-        */
-       public function resetToFactoryDefault () {
-               $path = 'data/resetAllSetting.json';
-               $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'reset_all' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               $json = json_decode($data['body'], true);
-               
-               return $json;
-       }
-       
-       
-       /**
-        * check if firmware is actual
-        * 
-        * @return      array
-        */
-       public function checkFirmware () {
-               $path = 'data/checkfirmware.json';
-               $fields = array('checkfirmware' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get checkfirmware data');
-               }
-               
-               $json = json_decode($data['body'], true);
-               
-               return $json;
+               return false;
        }
        
        /**
@@ -358,16 +202,14 @@ class SpeedportHybrid {
         * @return      array
         */
        private function decrypt ($data) {
-               require_once 'CryptLib/CryptLib.php';
-               $factory = new CryptLib\Cipher\Factory();
-               $aes = $factory->getBlockCipher('rijndael-128');
-               
                $iv = hex2bin(substr($this->challenge, 16, 16));
                $adata = hex2bin(substr($this->challenge, 32, 16));
-               $dkey = hex2bin($this->derivedk);
+               $key = hex2bin($this->derivedk);
                $enc = hex2bin($data);
                
-               $aes->setKey($dkey);
+               $factory = new CryptLib\Cipher\Factory();
+               $aes = $factory->getBlockCipher('rijndael-128');
+               $aes->setKey($key);
                $mode = $factory->getMode('ccm', $aes, $iv, [ 'adata' => $adata, 'lSize' => 7]);
                
                $mode->decrypt($enc);
@@ -378,21 +220,19 @@ class SpeedportHybrid {
        /**
         * decrypt data for the router
         * 
-        * @param       array   $data
+        * @param       string  $data
         * @return      string
         */
        private function encrypt ($data) {
-               require_once 'CryptLib/CryptLib.php';
-               $factory = new CryptLib\Cipher\Factory();
-               $aes = $factory->getBlockCipher('rijndael-128');
-               
                $iv = hex2bin(substr($this->challenge, 16, 16));
                $adata = hex2bin(substr($this->challenge, 32, 16));
-               $dkey = hex2bin($this->derivedk);
+               $key = hex2bin($this->derivedk);
                
-               $aes->setKey($dkey);
+               $factory = new CryptLib\Cipher\Factory();
+               $aes = $factory->getBlockCipher('rijndael-128');
+               $aes->setKey($key);
                $mode = $factory->getMode('ccm', $aes, $iv, [ 'adata' => $adata, 'lSize' => 7]);
-               $mode->encrypt(http_build_query($data));
+               $mode->encrypt($data);
                
                return bin2hex($mode->finish());
        }
@@ -406,12 +246,43 @@ class SpeedportHybrid {
        private function getValues($array) {
                $data = array();
                foreach ($array as $item) {
-                       $data[$item['varid']] = $item['varvalue'];
+                       // thank you telekom for this piece of shit
+                       if ($item['vartype'] == 'template') {
+                               if (is_array($item['varvalue'])) {
+                                       $data[$item['varid']][] = $this->getValues($item['varvalue']);
+                               }
+                               else {
+                                       // i dont know if we need this
+                                       $data[$item['varid']] = $item['varvalue'];
+                               }
+                       }
+                       else {
+                               if (is_array($item['varvalue'])) {
+                                       $data[$item['varid']] = $this->getValues($item['varvalue']);
+                               }
+                               else {
+                                       $data[$item['varid']] = $item['varvalue'];
+                               }
+                       }
                }
                
                return $data;
        }
        
+       /**
+        * sends the encrypted request to router
+        * 
+        * @param       string  $path
+        * @param       mixed   $fields
+        * @param       string  $cookie
+        * @return      array
+        */
+       private function sentEncryptedRequest ($path, $fields, $cookie = false) {
+               $count = count($fields);
+               $fields = $this->encrypt(http_build_query($fields));
+               return $this->sentRequest($path, $fields, $cookie, $count);
+       }
+       
        /**
         * sends the request to router
         * 
@@ -421,8 +292,8 @@ class SpeedportHybrid {
         * @param       integer $count
         * @return      array
         */
-       private function sentRequest ($path, $fields, $cookie = '', $count = 0) {
-               $url = $this->url.$path;
+       private function sentRequest ($path, $fields, $cookie = false, $count = 0) {
+               $url = $this->url.$path.'?lang=en';
                $ch = curl_init();
                curl_setopt($ch, CURLOPT_URL, $url);
                
@@ -437,17 +308,13 @@ class SpeedportHybrid {
                        }
                }
                
-               if (!empty($cookie)) {
-                       curl_setopt($ch, CURLOPT_COOKIE, $cookie);
+               if ($cookie === true) {
+                       curl_setopt($ch, CURLOPT_COOKIE, 'challengev='.$this->challenge.'; '.$this->cookie);
                }
                
                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                curl_setopt($ch, CURLOPT_HEADER, true);
                
-               if ($cookie) {
-                       
-               }
-               
                $result = curl_exec($ch);
                
                $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
@@ -455,13 +322,27 @@ class SpeedportHybrid {
                $body = substr($result, $header_size);
                curl_close($ch);
                
-               // fix invalid json
+               // check if response is empty
+               if (empty($body)) {
+                       throw new RouterException('empty response');
+               }
+               
+               // check if body is encrypted (hex instead of json)
+               if (ctype_xdigit($body)) {
+                       $body = $this->decrypt($body);
+               }
                
+               // fix invalid json
                $body = preg_replace("/(\r\n)|(\r)/", "\n", $body);
                $body = preg_replace('/\'/i', '"', $body);
                $body = preg_replace("/\[\s+\]/i", '[ {} ]', $body);
                $body = preg_replace("/},\s+]/", "}\n]", $body);
                
+               // decode json
+               if (strpos($url, '.json') !== false) {
+                       $body = json_decode($body, true);
+               }
+               
                return array('header' => $this->parse_headers($header), 'body' => $body);
        }
        
@@ -471,14 +352,11 @@ class SpeedportHybrid {
         * @return      string
         */
        private function getToken () {
-               $path = 'html/content/overview/index.html?lang=de';
-               $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $this->checkLogin();
                
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get csrf_token');
-               }
+               $path = 'html/content/overview/index.html';
+               $fields = array();
+               $data = $this->sentRequest($path, $fields, true);
                
                $a = explode('csrf_token = "', $data['body']);
                $a = explode('";', $a[1]);
@@ -487,10 +365,58 @@ class SpeedportHybrid {
                        return $a[0];
                }
                else {
-                       throw new Exception('unable to get csrf_token');
+                       throw new RouterException('unable to get csrf_token');
                }
        }
        
+       /**
+        * calculate the derivedk
+        *
+        * @param       string  $password
+        * @return      string
+        */
+       private function getDerviedk ($password) {
+               $derivedk = '';
+               
+               // calculate derivedk
+               if (!function_exists('hash_pbkdf2')) {
+                       $pbkdf2 = new CryptLib\Key\Derivation\PBKDF\PBKDF2(array('hash' => 'sha1'));
+                       $derivedk = bin2hex($pbkdf2->derive(hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32));
+                       $derivedk = substr($derivedk, 0, 32);
+               }
+               else {
+                       $derivedk = hash_pbkdf2('sha1', hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
+               }
+               
+               if (empty($derivedk)) {
+                       throw new RouterException('unable to calculate derivedk');
+               }
+               
+               return $derivedk;
+       }
+       
+       /**
+        * get cookie from header data
+        *
+        * @param       array   $data
+        * @return      string
+        */
+       private function getCookie ($data) {
+               $cookie = '';
+               if (isset($data['header']['Set-Cookie']) && !empty($data['header']['Set-Cookie'])) {
+                       preg_match('/^.*(SessionID_R3=[a-z0-9]*).*/i', $data['header']['Set-Cookie'], $match);
+                       if (isset($match[1]) && !empty($match[1])) {
+                               $cookie = $match[1];
+                       }
+               }
+               
+               if (empty($cookie)) {
+                       throw new RouterException('unable to get the session cookie from the router');
+               }
+               
+               return $cookie;
+       }
+       
        /**
         * parse the curl return header into an array
         *