split the stuff into different files
[GitHub/Stricted/speedport-hybrid-php-api.git] / SpeedportHybrid.class.php
index 1281c6987954705a371cea3c94601072931fefa8..892355a252ccac363dfcd17d6afe21d3a9338258 100644 (file)
@@ -1,6 +1,10 @@
 <?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)
@@ -8,11 +12,15 @@ require_once('RouterException.class.php');
  * @copyright   2015 Jan Altensen (Stricted)
  */
 class SpeedportHybrid {
+       use Connection;
+       use Phone;
+       use System;
+       
        /**
-        *
-        *
+        * class version
+        * @const       string
         */
-       const VERSION = '1.0.2';
+       const VERSION = '1.0.3';
        
        /**
         * password-challenge
@@ -61,14 +69,13 @@ class SpeedportHybrid {
                $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'])) {
                        return $data['challengev'];
                }
                else {
-                       throw new RouterExeption('unable to get the challenge from the router');
+                       throw new RouterException('unable to get the challenge from the router');
                }
        }
        
@@ -85,8 +92,7 @@ class SpeedportHybrid {
                $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') {
                        $this->cookie = $this->getCookie($data);
@@ -114,7 +120,7 @@ class SpeedportHybrid {
                // check if challenge or session is empty
                if (empty($this->challenge) || empty($this->cookie)) {
                        if ($exception === true) {
-                               throw new RouterExeption('you musst be logged in to use this method');
+                               throw new RouterException('you musst be logged in to use this method');
                        }
                        
                        return false;
@@ -123,17 +129,11 @@ class SpeedportHybrid {
                $path = 'data/SecureStatus.json';
                $fields = array();
                $data = $this->sentRequest($path, $fields, true);
+               $data = $this->getValues($data['body']);
                
-               if (empty($data['body'])) {
-                       throw new RouterExeption('unable to get SecureStatus data');
-               }
-               
-               $json = json_decode($data['body'], true);
-               $json = $this->getValues($json);
-               
-               if ($json['loginstate'] != 1) {
+               if ($data['loginstate'] != 1) {
                        if ($exception === true) {
-                               throw new RouterExeption('you musst be logged in to use this method');
+                               throw new RouterException('you musst be logged in to use this method');
                        }
                        
                        return false;
@@ -145,34 +145,32 @@ class SpeedportHybrid {
        /**
         * logout
         * 
-        * @return      array
+        * @return      boolean
         */
        public function logout () {
                $this->checkLogin();
                
                $path = 'data/Login.json';
-               $fields = array('csrf_token' =>  $this->token, 'logout' => 'byby');
+               $fields = array('csrf_token' => $this->token, 'logout' => 'byby');
                $data = $this->sentRequest($path, $fields, true);
-               if ($this->checkLogin(false) === false) {
+               $data = $this->getValues($data['body']);
+               if ((isset($data['status']) && $data['status'] == 'ok') && $this->checkLogin(false) === false) {
                        // reset challenge and session
                        $this->challenge = '';
                        $this->cookie = '';
                        $this->token = '';
                        $this->derivedk = '';
                        
-                       $json = json_decode($data['body'], true);
-                       
-                       return $json;
-               }
-               else {
-                       throw new RouterExeption('logout failed');
+                       return true;
                }
+               
+               return false;
        }
        
        /**
         * reboot the router
         * 
-        * @return      array
+        * @return      boolean
         */
        public function reboot () {
                $this->checkLogin();
@@ -180,173 +178,21 @@ class SpeedportHybrid {
                $path = 'data/Reboot.json';
                $fields = array('csrf_token' => $this->token, 'reboot_device' => 'true');
                $data = $this->sentEncryptedRequest($path, $fields, true);
+               $data = $this->getValues($data['body']);
                
-               $json = json_decode($data['body'], true);
-               $json = $this->getValues($json);
-               
-               if ($json['status'] == 'ok') {
+               if ($data['status'] == 'ok') {
+                       // reset challenge and session
+                       $this->challenge = '';
+                       $this->cookie = '';
+                       $this->token = '';
+                       $this->derivedk = ''; 
+                       
                        // throw an exception because router is unavailable for other tasks
                        // like $this->logout() or $this->checkLogin
                        throw new RebootException('Router Reboot');
                }
-               else {
-                       throw new RouterException('unable to reboot');
-               }
-       }
-       
-       /**
-        * change dsl connection status
-        * 
-        * @param       string  $status
-        */
-       public function changeConnectionStatus ($status) {
-               $this->checkLogin();
-               
-               $path = 'data/Connect.json';
-               
-               if ($status == 'online' || $status == 'offline') {
-                       $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'req_connect' => $status);
-                       $data = $this->sentRequest($path, $fields, true);
-                       
-                       $json = json_decode($data['body'], true);
-                       
-                       return $json;
-               }
-               else {
-                       throw new RouterExeption();
-               }
-       }
-       
-       /**
-        * return the given json as array
-        * 
-        * @param       string  $file
-        * @return      array
-        */
-       public function getData ($file) {
-               if ($file != 'Status') $this->checkLogin();
-               
-               $path = 'data/'.$file.'.json';
-               $fields = array();
-               $data = $this->sentRequest($path, $fields, true);
-               
-               if (empty($data['body'])) {
-                       throw new RouterExeption('unable to get '.$file.' data');
-               }
                
-               $json = json_decode($data['body'], true);
-               
-               return $json;
-       }
-       
-       /**
-        * get the router syslog
-        * 
-        * @return      array
-        */
-       public function getSyslog() {
-               return $this->exportData('0');
-       }
-       
-       /**
-        * get the Missed Calls from router
-        * 
-        * @return      array
-        */
-       public function getMissedCalls() {
-               return $this->exportData('1');
-       }
-       
-       /**
-        * get the Taken Calls from router
-        * 
-        * @return      array
-        */
-       public function getTakenCalls() {
-               return $this->exportData('2');
-       }
-       
-       /**
-        * get the Dialed Calls from router
-        * 
-        * @return      array
-        */
-       public function getDialedCalls() {
-               return $this->exportData('3');
-       }
-       
-       /**
-        * export data from router
-        * 
-        * @return      array
-        */
-       private function exportData ($type) {
-               $this->checkLogin();
-               
-               $path = 'data/Syslog.json';
-               $fields = array('exporttype' => $type);
-               $data = $this->sentRequest($path, $fields, true);
-               
-               if (empty($data['body'])) {
-                       throw new RouterExeption('unable to get export data');
-               }
-               
-               return explode("\n", $data['body']);
-       }
-       
-       /**
-        * reconnect LTE
-        *
-        * @return      array
-        */
-       public function reconnectLte () {
-               $this->checkLogin();
-               
-               $path = 'data/modules.json';
-               $fields = array('csrf_token' => $this->token, 'lte_reconn' => '1');
-               $data = $this->sentEncryptedRequest($path, $fields, true);
-               $json = json_decode($data['body'], true);
-               
-               return $json;
-       }
-       
-       /**
-        * reset the router to Factory Default
-        * not tested
-        *
-        * @return      array
-        */
-       public function resetToFactoryDefault () {
-               $this->checkLogin();
-               
-               $path = 'data/resetAllSetting.json';
-               $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'reset_all' => 'true');
-               $data = $this->sentRequest($path, $fields, true);
-               $json = json_decode($data['body'], true);
-               
-               return $json;
-       }
-       
-       
-       /**
-        * check if firmware is actual
-        * 
-        * @return      array
-        */
-       public function checkFirmware () {
-               $this->checkLogin();
-               
-               $path = 'data/checkfirmware.json';
-               $fields = array('checkfirmware' => 'true');
-               $data = $this->sentRequest($path, $fields, true);
-               
-               if (empty($data['body'])) {
-                       throw new RouterExeption('unable to get checkfirmware data');
-               }
-               
-               $json = json_decode($data['body'], true);
-               
-               return $json;
+               return false;
        }
        
        /**
@@ -356,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);
@@ -376,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());
        }
@@ -404,7 +246,24 @@ 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;
@@ -420,7 +279,7 @@ class SpeedportHybrid {
         */
        private function sentEncryptedRequest ($path, $fields, $cookie = false) {
                $count = count($fields);
-               $fields = $this->encrypt($fields);
+               $fields = $this->encrypt(http_build_query($fields));
                return $this->sentRequest($path, $fields, $cookie, $count);
        }
        
@@ -456,10 +315,6 @@ class SpeedportHybrid {
                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);
@@ -467,6 +322,11 @@ class SpeedportHybrid {
                $body = substr($result, $header_size);
                curl_close($ch);
                
+               // 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);
@@ -478,6 +338,11 @@ class SpeedportHybrid {
                $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);
        }
        
@@ -493,10 +358,6 @@ class SpeedportHybrid {
                $fields = array();
                $data = $this->sentRequest($path, $fields, true);
                
-               if (empty($data['body'])) {
-                       throw new RouterExeption('unable to get csrf_token');
-               }
-               
                $a = explode('csrf_token = "', $data['body']);
                $a = explode('";', $a[1]);
                
@@ -504,7 +365,7 @@ class SpeedportHybrid {
                        return $a[0];
                }
                else {
-                       throw new RouterExeption('unable to get csrf_token');
+                       throw new RouterException('unable to get csrf_token');
                }
        }
        
@@ -519,15 +380,18 @@ class SpeedportHybrid {
                
                // calculate derivedk
                if (!function_exists('hash_pbkdf2')) {
-                       require_once 'CryptLib/CryptLib.php';
                        $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($this->derivedk, 0, 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;
        }
        
@@ -538,14 +402,19 @@ class SpeedportHybrid {
         * @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])) {
-                               return $match[1];
+                               $cookie = $match[1];
                        }
                }
                
-               throw new RouterExeption('unable to get the session cookie from the router');
+               if (empty($cookie)) {
+                       throw new RouterException('unable to get the session cookie from the router');
+               }
+               
+               return $cookie;
        }
        
        /**