fix reconnectLte
[GitHub/Stricted/speedport-hybrid-php-api.git] / SpeedportHybrid.class.php
index 1281c6987954705a371cea3c94601072931fefa8..c135643cd5163d77b29c03fef5f52a4a9e0d8315 100644 (file)
@@ -1,42 +1,35 @@
 <?php
-require_once('RebootException.class.php');
-require_once('RouterException.class.php');
+require_once('lib/exception/RebootException.class.php');
+require_once('lib/exception/RouterException.class.php');
+require_once('lib/exception/NotImplementedException.class.php');
+require_once('CryptLib/CryptLib.php');
+require_once('lib/trait/Connection.class.php');
+require_once('lib/trait/CryptLib.class.php');
+require_once('lib/trait/Login.class.php');
+require_once('lib/trait/Firewall.class.php');
+require_once('lib/trait/Network.class.php');
+require_once('lib/trait/Phone.class.php');
+require_once('lib/trait/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)
+ * @copyright   2015-2016 Jan Altensen (Stricted)
  */
 class SpeedportHybrid {
-       /**
-        *
-        *
-        */
-       const VERSION = '1.0.2';
-       
-       /**
-        * password-challenge
-        * @var string
-        */
-       private $challenge = '';
-       
-       /**
-        * csrf_token
-        * @var string
-        */
-       private $token = '';
-       
-       /**
-        * hashed password
-        * @var string
-        */
-       private $hash = '';
+       use Connection;
+       use CryptLib;
+       use Firewall;
+       use Login;
+       use Network;
+       use Phone;
+       use System;
        
        /**
-        * session cookie
-        * @var string
+        * class version
+        * @const       string
         */
-       private $cookie = '';
+       const VERSION = '1.0.5';
        
        /**
         * router url
@@ -45,356 +38,39 @@ class SpeedportHybrid {
        private $url = '';
        
        /**
-        * derivedk cookie
-        * @var string
+        * inititalize this class
+        *
+        * @param       string  $url
         */
-       private $derivedk = '';
-       
        public function __construct ($url = 'http://speedport.ip/') {
                $this->url = $url;
+               $this->checkRequirements();
        }
        
        /**
-        * Requests the password-challenge from the router.
-        */
-       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);
-               
-               if (isset($data['challengev']) && !empty($data['challengev'])) {
-                       return $data['challengev'];
-               }
-               else {
-                       throw new RouterExeption('unable to get the challenge from the router');
-               }
-       }
-       
-       /**
-        * login into the router with the given password
-        * 
-        * @param       string  $password
-        * @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);
-               
-               if (isset($json['login']) && $json['login'] == 'success') {
-                       $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;
-                       }
-               }
-               
-               return false;
-       }
-       
-       /**
-        * check if we are logged in
-        *
-        * @param       boolean $exception
-        * @return      boolean
-        */
-       public function checkLogin ($exception = true) {
-               // 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');
-                       }
-                       
-                       return false;
-               }
-               
-               $path = 'data/SecureStatus.json';
-               $fields = array();
-               $data = $this->sentRequest($path, $fields, true);
-               
-               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 ($exception === true) {
-                               throw new RouterExeption('you musst be logged in to use this method');
-                       }
-                       
-                       return false;
-               }
-               
-               return true;
-       }
-       
-       /**
-        * logout
-        * 
-        * @return      array
+        * check php requirements
         */
-       public function logout () {
-               $this->checkLogin();
-               
-               $path = 'data/Login.json';
-               $fields = array('csrf_token' =>  $this->token, 'logout' => 'byby');
-               $data = $this->sentRequest($path, $fields, true);
-               if ($this->checkLogin(false) === false) {
-                       // reset challenge and session
-                       $this->challenge = '';
-                       $this->cookie = '';
-                       $this->token = '';
-                       $this->derivedk = '';
-                       
-                       $json = json_decode($data['body'], true);
-                       
-                       return $json;
+       private function checkRequirements () {
+               if (!extension_loaded('curl')) {
+                       throw new Exception("The PHP Extension 'curl' is missing.");
                }
-               else {
-                       throw new RouterExeption('logout failed');
+               else if (!extension_loaded('json')) {
+                       throw new Exception("The PHP Extension 'json' is missing.");
                }
-       }
-       
-       /**
-        * reboot the router
-        * 
-        * @return      array
-        */
-       public function reboot () {
-               $this->checkLogin();
-               
-               $path = 'data/Reboot.json';
-               $fields = array('csrf_token' => $this->token, 'reboot_device' => 'true');
-               $data = $this->sentEncryptedRequest($path, $fields, true);
-               
-               $json = json_decode($data['body'], true);
-               $json = $this->getValues($json);
-               
-               if ($json['status'] == 'ok') {
-                       // throw an exception because router is unavailable for other tasks
-                       // like $this->logout() or $this->checkLogin
-                       throw new RebootException('Router Reboot');
+               else if (!extension_loaded('pcre')) {
+                       throw new Exception("The PHP Extension 'pcre' is missing.");
                }
-               else {
-                       throw new RouterException('unable to reboot');
+               else if (!extension_loaded('ctype')) {
+                       throw new Exception("The PHP Extension 'ctype' is missing.");
                }
-       }
-       
-       /**
-        * 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 if (!extension_loaded('hash')) {
+                       throw new Exception("The PHP Extension 'hash' is missing.");
                }
-               else {
-                       throw new RouterExeption();
+               else if (!in_array('sha256', hash_algos())) {
+                       throw new Exception('SHA-256 algorithm is not Supported.');
                }
        }
        
-       /**
-        * 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;
-       }
-       
-       /**
-        * decrypt data from router
-        * 
-        * @param       string  $data
-        * @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);
-               $enc = hex2bin($data);
-               
-               $aes->setKey($dkey);
-               $mode = $factory->getMode('ccm', $aes, $iv, [ 'adata' => $adata, 'lSize' => 7]);
-               
-               $mode->decrypt($enc);
-               
-               return $mode->finish();
-       }
-
-       /**
-        * decrypt data for the router
-        * 
-        * @param       array   $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);
-               
-               $aes->setKey($dkey);
-               $mode = $factory->getMode('ccm', $aes, $iv, [ 'adata' => $adata, 'lSize' => 7]);
-               $mode->encrypt(http_build_query($data));
-               
-               return bin2hex($mode->finish());
-       }
-       
        /**
         * get the values from array
         * 
@@ -404,26 +80,31 @@ class SpeedportHybrid {
        private function getValues($array) {
                $data = array();
                foreach ($array as $item) {
-                       $data[$item['varid']] = $item['varvalue'];
+                       if (!isset($item['vartype']) || !isset($item['varid']) || !isset($item['varvalue'])) continue;
+                       
+                       // 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($fields);
-               return $this->sentRequest($path, $fields, $cookie, $count);
-       }
-       
        /**
         * sends the request to router
         * 
@@ -433,18 +114,18 @@ class SpeedportHybrid {
         * @param       integer $count
         * @return      array
         */
-       private function sentRequest ($path, $fields, $cookie = false, $count = 0) {
-               $url = $this->url.$path.'?lang=en';
+       private function sendRequest ($path, $fields, $cookie = false, $count = 0) {
+               $url = $this->url.$path;
                $ch = curl_init();
                curl_setopt($ch, CURLOPT_URL, $url);
                
                if (!empty($fields)) {
+                       curl_setopt($ch, CURLOPT_POST, true);
+                       
                        if (is_array($fields)) {
-                               curl_setopt($ch, CURLOPT_POST, count($fields));
                                curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
                        }
                        else {
-                               curl_setopt($ch, CURLOPT_POST, $count);
                                curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
                        }
                }
@@ -456,10 +137,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 +144,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,74 +160,16 @@ class SpeedportHybrid {
                $body = preg_replace("/\[\s+\]/i", '[ {} ]', $body);
                $body = preg_replace("/},\s+]/", "}\n]", $body);
                
-               return array('header' => $this->parse_headers($header), 'body' => $body);
-       }
-       
-       /**
-        * get the csrf_token
-        * 
-        * @return      string
-        */
-       private function getToken () {
-               $this->checkLogin();
-               
-               $path = 'html/content/overview/index.html';
-               $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]);
-               
-               if (isset($a[0]) && !empty($a[0])) {
-                       return $a[0];
-               }
-               else {
-                       throw new RouterExeption('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')) {
-                       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);
-               }
-               else {
-                       $derivedk = hash_pbkdf2('sha1', hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
-               }
-               
-               return $derivedk;
-       }
-       
-       /**
-        * get cookie from header data
-        *
-        * @param       array   $data
-        * @return      string
-        */
-       private function getCookie ($data) {
-               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];
+               // decode json
+               if (strpos($url, '.json') !== false) {
+                       $json = json_decode($body, true);
+                       
+                       if (is_array($json)) {
+                               $body = $json;
                        }
                }
                
-               throw new RouterExeption('unable to get the session cookie from the router');
+               return array('header' => $this->parse_headers($header), 'body' => $body);
        }
        
        /**