add reconnect example/test file
[GitHub/Stricted/speedport-hybrid-php-api.git] / speedport.class.php
index 36837cef33c7c4b5de695fe0671da36a9d5bb6fd..39f26a9d2709b13f47ea84471293038d0c3d4449 100644 (file)
@@ -11,6 +11,12 @@ class speedport {
         */
        private $challenge = '';
        
+       /**
+        * csrf_token
+        * @var string
+        */
+       private $token = '';
+       
        /**
         * hashed password
         * @var string
@@ -27,9 +33,16 @@ class speedport {
         * router url
         * @var string
         */
-       private $url = 'http://speedport.ip/';
+       private $url = '';
+       
+       /**
+        * derivedk cookie
+        * @var string
+        */
+       private $derivedk = '';
        
-       public function __construct ($password) {
+       public function __construct ($password, $url = 'http://speedport.ip/') {
+               $this->url = $url;
                $this->getChallenge();
                
                if (empty($this->challenge)) {
@@ -47,9 +60,9 @@ class speedport {
         * Requests the password-challenge from the router.
         */
        public function getChallenge () {
-               $url = 'data/Login.json';
+               $path = 'data/Login.json';
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'challengev' => 'null');
-               $data = $this->sentRequest($url, $fields);
+               $data = $this->sentRequest($path, $fields);
                $data = json_decode($data['body'], true);
                if ($data[1]['varid'] == 'challengev') {
                        $this->challenge = $data[1]['varvalue'];
@@ -58,15 +71,15 @@ class speedport {
        
        /**
         * login into the router with the given password
-        *
+        * 
         * @param       string  $password
         * @return      boolean
         */
        public function login ($password) {
-               $url = 'data/Login.json';
+               $path = 'data/Login.json';
                $this->hash = hash('sha256', $this->challenge.':'.$password);
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash);
-               $data = $this->sentRequest($url, $fields);
+               $data = $this->sentRequest($path, $fields);
                $json = json_decode($data['body'], true);
                if ($json[15]['varid'] == 'login' && $json[15]['varvalue'] == 'success') {
                        if (isset($data['header']['Set-Cookie']) && !empty($data['header']['Set-Cookie'])) {
@@ -78,6 +91,12 @@ class speedport {
                                        throw new Exception('unable to get the session cookie from the router');
                                }
                                
+                               // calculate derivedk
+                               $this->derivedk = hash_pbkdf2('sha1', hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
+                               
+                               // get the csrf_token
+                               $this->token = $this->getToken();
+                               
                                return true;
                        }
                }
@@ -87,13 +106,13 @@ class speedport {
        
        /**
         * logout
-        *
+        * 
         * @return      array
         */
        public function logout () {
-               $url = 'data/Login.json';
+               $path = 'data/Login.json';
                $fields = array('logout' => 'byby');
-               $data = $this->sentRequest($url, $fields);
+               $data = $this->sentRequest($path, $fields);
                // reset challenge and session
                $this->challenge = '';
                $this->session = '';
@@ -105,14 +124,15 @@ class speedport {
        
        /**
         * reboot the router
-        *
+        * 
         * @return      array
         */
        public function reboot () {
-               $url = 'data/Reboot.json';
+               $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($url, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, $cookie);
+               
                $json = json_decode($data['body'], true);
                
                return $json;
@@ -120,16 +140,16 @@ class speedport {
        
        /**
         * change dsl connection status
-        *
+        * 
         * @param       string  $status
         */
        public function changeConnectionStatus ($status) {
-               $url = 'data/Connect.json';
+               $path = 'data/Connect.json';
                
                if ($status == 'online' || $status == 'offline') {
                        $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'req_connect' => $status);
                        $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-                       $this->sentRequest($url, $fields, $cookie);
+                       $this->sentRequest($path, $fields, $cookie);
                }
                else {
                        throw new Exception();
@@ -138,7 +158,7 @@ class speedport {
        
        /**
         * return the given json as array
-        *
+        * 
         * the following paths are known to be valid:
         * /data/dsl.json
         * /data/interfaces.json
@@ -161,17 +181,17 @@ class speedport {
         * /data/filterlist.json
         * /data/bonding_tr181.json
         * /data/letinfo.json
-        *
+        * 
         * /data/Status.json (No login needed)
-        *
+        * 
         * @param       string  $file
         * @return      array
         */
        public function getData ($file) {
-               $url = 'data/'.$file.'.json';
+               $path = 'data/'.$file.'.json';
                $fields = array();
                $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($url, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, $cookie);
                
                if (empty($data['body'])) {
                        throw new Exception('unable to get '.$file.' data');
@@ -183,21 +203,195 @@ class speedport {
        }
        
        /**
-        * sends the request to router
+        * 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');
+               }
+               
+               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
         *
-        * @param       string  $url
-        * @param       array   $fields
+        * @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;
+       }
+       
+       /*
+       // i dont want test this :D, feel free to test it and report if it works or not
+       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;
+       }
+       
+       /**
+        * decrypt data from router
+        * 
+        * @param       string  $data
+        * @return      array
+        */
+       public 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
+        */
+       public 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());
+       }
+       
+       /**
+        * sends the request to router
+        * 
+        * @param       string  $path
+        * @param       mixed   $fields
         * @param       string  $cookie
+        * @param       integer $count
         * @return      array
         */
-       private function sentRequest ($url, $fields = array(), $cookie = '') {
-               $url = $this->url.$url;
+       private function sentRequest ($path, $fields, $cookie = '', $count = 0) {
+               $url = $this->url.$path;
                $ch = curl_init();
                curl_setopt($ch, CURLOPT_URL, $url);
                
                if (!empty($fields)) {
-                       curl_setopt($ch, CURLOPT_POST, count($fields));
-                       curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
+                       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);
+                       }
                }
                
                if (!empty($cookie)) {
@@ -220,20 +414,44 @@ class speedport {
                curl_close($ch);
                
                // fix invalid json
+               
                $body = preg_replace("/(\r\n)|(\r)/", "\n", $body);
                $body = preg_replace('/\'/i', '"', $body);
-               $body = preg_replace("/},\n\n]/", "}\n]", $body);
-               $body = preg_replace('/\s+/', ' ', $body);
-               $body = preg_replace("/\[ \]/i", '[ {} ]', $body);
-               $body = preg_replace("/}, ]/", "} ]", $body);
-               $body = preg_replace("/\n/", " ", $body);
+               $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 () {
+               $path = 'html/content/overview/index.html?lang=de';
+               $fields = array();
+               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
+               $data = $this->sentRequest($path, $fields, $cookie);
+               
+               if (empty($data['body'])) {
+                       throw new Exception('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 Exception('unable to get csrf_token');
+               }
+       }
+       
        /**
         * parse the curl return header into an array
-        *
+        * 
         * @param       string  $response
         * @return      array
         */