improve checkLogin
[GitHub/Stricted/speedport-hybrid-php-api.git] / SpeedportHybrid.class.php
index 3e40be4b1c7acc952a83751a0e5d56677c2a6344..d1fbd7e82b91736380c86c6464888c3ee7b54e38 100644 (file)
@@ -1,10 +1,19 @@
 <?php
+require_once('RebootException.class.php');
+require_once('RouterException.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 {
+       /**
+        *
+        *
+        */
+       const VERSION = '1.0.2';
+       
        /**
         * password-challenge
         * @var string
@@ -41,25 +50,14 @@ 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);
@@ -78,6 +76,12 @@ class SpeedportHybrid {
         * @return      boolean
         */
        public function login ($password) {
+               $this->getChallenge();
+               
+               if (empty($this->challenge)) {
+                       throw new RouterExeption('unable to get the challenge from the router');
+               }
+               
                $path = 'data/Login.json';
                $this->hash = hash('sha256', $this->challenge.':'.$password);
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash);
@@ -91,39 +95,93 @@ class SpeedportHybrid {
                                        $this->session = $match[1];
                                }
                                else {
-                                       throw new Exception('unable to get the session cookie from the router');
+                                       throw new RouterExeption('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);
+                               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();
                                
-                               return true;
+                               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) {
+               if (empty($this->challenge) && empty($this->session)) {
+                       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
         */
        public function logout () {
-               $path = 'data/Login.json';
-               $fields = array('logout' => 'byby');
-               $data = $this->sentRequest($path, $fields);
-               // reset challenge and session
-               $this->challenge = '';
-               $this->session = '';
-               $this->token = "";
+               $this->checkLogin();
                
-               $json = json_decode($data['body'], true);
-               
-               return $json;
+               $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->session = '';
+                       $this->token = "";
+                       
+                       $json = json_decode($data['body'], true);
+                       
+                       return $json;
+               }
+               else {
+                       throw new RouterExeption('logout failed');
+               }
        }
        
        /**
@@ -132,14 +190,23 @@ class SpeedportHybrid {
         * @return      array
         */
        public function reboot () {
+               $this->checkLogin();
+               
                $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);
+               $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);
                
-               return $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 {
+                       throw new RouterException('unable to reboot');
+               }
        }
        
        /**
@@ -148,19 +215,20 @@ class SpeedportHybrid {
         * @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);
-                       $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-                       $data = $this->sentRequest($path, $fields, $cookie);
+                       $data = $this->sentRequest($path, $fields, true);
                        
-                       $json = json_decode($this->decrypt($data['body']), true);
+                       $json = json_decode($data['body'], true);
                        
                        return $json;
                }
                else {
-                       throw new Exception();
+                       throw new RouterExeption();
                }
        }
        
@@ -171,13 +239,14 @@ class SpeedportHybrid {
         * @return      array
         */
        public function getData ($file) {
+               if ($file != "Status") $this->checkLogin();
+               
                $path = 'data/'.$file.'.json';
                $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
-                       throw new Exception('unable to get '.$file.' data');
+                       throw new RouterExeption('unable to get '.$file.' data');
                }
                
                $json = json_decode($data['body'], true);
@@ -191,16 +260,7 @@ class SpeedportHybrid {
         * @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']);
+               return $this->exportData('0');
        }
        
        /**
@@ -209,16 +269,7 @@ class SpeedportHybrid {
         * @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']);
+               return $this->exportData('1');
        }
        
        /**
@@ -227,16 +278,7 @@ class SpeedportHybrid {
         * @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']);
+               return $this->exportData('2');
        }
        
        /**
@@ -245,13 +287,23 @@ class SpeedportHybrid {
         * @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);
+               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 Exception('unable to get syslog data');
+                       throw new RouterExeption('unable to get export data');
                }
                
                return explode("\n", $data['body']);
@@ -263,11 +315,11 @@ class SpeedportHybrid {
         * @return      array
         */
        public function reconnectLte () {
+               $this->checkLogin();
+               
                $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);
+               $data = $this->sentEncryptedRequest($path, $fields, true);
                $json = json_decode($data['body'], true);
                
                return $json;
@@ -280,10 +332,11 @@ class SpeedportHybrid {
         * @return      array
         */
        public function resetToFactoryDefault () {
+               $this->checkLogin();
+               
                $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);
+               $data = $this->sentRequest($path, $fields, true);
                $json = json_decode($data['body'], true);
                
                return $json;
@@ -296,13 +349,14 @@ class SpeedportHybrid {
         * @return      array
         */
        public function checkFirmware () {
+               $this->checkLogin();
+               
                $path = 'data/checkfirmware.json';
                $fields = array('checkfirmware' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
-                       throw new Exception('unable to get checkfirmware data');
+                       throw new RouterExeption('unable to get checkfirmware data');
                }
                
                $json = json_decode($data['body'], true);
@@ -371,6 +425,20 @@ class SpeedportHybrid {
                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
         * 
@@ -380,8 +448,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);
                
@@ -396,8 +464,8 @@ class SpeedportHybrid {
                        }
                }
                
-               if (!empty($cookie)) {
-                       curl_setopt($ch, CURLOPT_COOKIE, $cookie);
+               if ($cookie === true) {
+                       curl_setopt($ch, CURLOPT_COOKIE, 'challengev='.$this->challenge.'; '.$this->session);
                }
                
                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
@@ -414,8 +482,12 @@ class SpeedportHybrid {
                $body = substr($result, $header_size);
                curl_close($ch);
                
-               // fix invalid json
+               // 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);
@@ -430,13 +502,14 @@ class SpeedportHybrid {
         * @return      string
         */
        private function getToken () {
-               $path = 'html/content/overview/index.html?lang=de';
+               $this->checkLogin();
+               
+               $path = 'html/content/overview/index.html';
                $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
-                       throw new Exception('unable to get csrf_token');
+                       throw new RouterExeption('unable to get csrf_token');
                }
                
                $a = explode('csrf_token = "', $data['body']);
@@ -446,7 +519,7 @@ class SpeedportHybrid {
                        return $a[0];
                }
                else {
-                       throw new Exception('unable to get csrf_token');
+                       throw new RouterExeption('unable to get csrf_token');
                }
        }