SpeedportHybrid.class.php

   1 <?php
   2 require_once('RebootException.class.php');
   3 require_once('RouterException.class.php');
   4 require_once('CryptLib/CryptLib.php');
   5
   6 /**
   7  * @author      Jan Altensen (Stricted)
   8  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
   9  * @copyright   2015 Jan Altensen (Stricted)
  10  */
  11 class SpeedportHybrid {
  12         /**
  13          * class version
  14          * @const       string
  15          */
  16         const VERSION = '1.0.3';
  17
  18         /**
  19          * password-challenge
  20          * @var string
  21          */
  22         private $challenge = '';
  23
  24         /**
  25          * csrf_token
  26          * @var string
  27          */
  28         private $token = '';
  29
  30         /**
  31          * hashed password
  32          * @var string
  33          */
  34         private $hash = '';
  35
  36         /**
  37          * session cookie
  38          * @var string
  39          */
  40         private $cookie = '';
  41
  42         /**
  43          * router url
  44          * @var string
  45          */
  46         private $url = '';
  47
  48         /**
  49          * derivedk cookie
  50          * @var string
  51          */
  52         private $derivedk = '';
  53
  54         public function __construct ($url = 'http://speedport.ip/') {
  55                 $this->url = $url;
  56         }
  57
  58         /**
  59          * Requests the password-challenge from the router.
  60          */
  61         private function getChallenge () {
  62                 $path = 'data/Login.json';
  63                 $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'challengev' => 'null');
  64                 $data = $this->sentRequest($path, $fields);
  65                 $data = $this->getValues($data['body']);
  66
  67                 if (isset($data['challengev']) && !empty($data['challengev'])) {
  68                         return $data['challengev'];
  69                 }
  70                 else {
  71                         throw new RouterException('unable to get the challenge from the router');
  72                 }
  73         }
  74
  75         /**
  76          * login into the router with the given password
  77          *
  78          * @param       string  $password
  79          * @return      boolean
  80          */
  81         public function login ($password) {
  82                 $this->challenge = $this->getChallenge();
  83
  84                 $path = 'data/Login.json';
  85                 $this->hash = hash('sha256', $this->challenge.':'.$password);
  86                 $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash);
  87                 $data = $this->sentRequest($path, $fields);
  88                 $json = $this->getValues($data['body']);
  89
  90                 if (isset($json['login']) && $json['login'] == 'success') {
  91                         $this->cookie = $this->getCookie($data);
  92
  93                         $this->derivedk = $this->getDerviedk($password);
  94
  95                         // get the csrf_token
  96                         $this->token = $this->getToken();
  97
  98                         if ($this->checkLogin(false) === true) {
  99                                 return true;
 100                         }
 101                 }
 102
 103                 return false;
 104         }
 105
 106         /**
 107          * check if we are logged in
 108          *
 109          * @param       boolean $exception
 110          * @return      boolean
 111          */
 112         public function checkLogin ($exception = true) {
 113                 // check if challenge or session is empty
 114                 if (empty($this->challenge) || empty($this->cookie)) {
 115                         if ($exception === true) {
 116                                 throw new RouterException('you musst be logged in to use this method');
 117                         }
 118
 119                         return false;
 120                 }
 121
 122                 $path = 'data/SecureStatus.json';
 123                 $fields = array();
 124                 $data = $this->sentRequest($path, $fields, true);
 125                 $data = $this->getValues($data['body']);
 126
 127                 if ($data['loginstate'] != 1) {
 128                         if ($exception === true) {
 129                                 throw new RouterException('you musst be logged in to use this method');
 130                         }
 131
 132                         return false;
 133                 }
 134
 135                 return true;
 136         }
 137
 138         /**
 139          * logout
 140          *
 141          * @return      boolean
 142          */
 143         public function logout () {
 144                 $this->checkLogin();
 145
 146                 $path = 'data/Login.json';
 147                 $fields = array('csrf_token' =>  $this->token, 'logout' => 'byby');
 148                 $data = $this->sentRequest($path, $fields, true);
 149                 $data = $this->getValues($data['body']);
 150                 if ((isset($data['status']) && $data['status'] == 'ok') && $this->checkLogin(false) === false) {
 151                         // reset challenge and session
 152                         $this->challenge = '';
 153                         $this->cookie = '';
 154                         $this->token = '';
 155                         $this->derivedk = '';
 156
 157                         return true;
 158                 }
 159
 160                 return false;
 161         }
 162
 163         /**
 164          * reboot the router
 165          *
 166          * @return      boolean
 167          */
 168         public function reboot () {
 169                 $this->checkLogin();
 170
 171                 $path = 'data/Reboot.json';
 172                 $fields = array('csrf_token' => $this->token, 'reboot_device' => 'true');
 173                 $data = $this->sentEncryptedRequest($path, $fields, true);
 174                 $data = $this->getValues($data['body']);
 175
 176                 if ($data['status'] == 'ok') {
 177                         // reset challenge and session
 178                         $this->challenge = '';
 179                         $this->cookie = '';
 180                         $this->token = '';
 181                         $this->derivedk = '';
 182
 183                         // throw an exception because router is unavailable for other tasks
 184                         // like $this->logout() or $this->checkLogin
 185                         throw new RebootException('Router Reboot');
 186                 }
 187
 188                 return false;
 189         }
 190
 191         /**
 192          * change dsl connection status
 193          *
 194          * @param       string  $status
 195          * @return      boolean
 196          */
 197         public function changeDSLStatus ($status) {
 198                 $this->checkLogin();
 199
 200                 $path = 'data/Connect.json';
 201
 202                 if ($status == 'online' || $status == 'offline') {
 203                         $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'req_connect' => $status);
 204                         $data = $this->sentRequest($path, $fields, true);
 205                         $data = $this->getValues($data['body']);
 206
 207                         if ($data['status'] == 'ok') {
 208                                 return true;
 209                         }
 210                         else {
 211                                 return false;
 212                         }
 213                 }
 214                 else {
 215                         throw new RouterException('unknown status');
 216                 }
 217         }
 218
 219         /**
 220          * change lte connection status
 221          *
 222          * @param       string  $status
 223          * @return      boolean
 224          */
 225         public function changeLTEStatus ($status) {
 226                 throw new Exception('unstable funtion');
 227                 $path = 'data/Modules.json';
 228
 229                 if ($status == '0' || $status == '1' || $status == 'yes' || $status == 'no') {
 230                         if ($status == 'yes') $status = '1';
 231                         else if ($status == 'no') $status = '0';
 232
 233                         $fields = array('csrf_token' => $this->token, 'use_lte' => $status);
 234                         $data = $this->sentEncryptedRequest($path, $fields, true);
 235
 236                         // debug only
 237                         return $data;
 238                 }
 239                 else {
 240                         throw new RouterException('unknown status');
 241                 }
 242         }
 243
 244         /**
 245          * get phone book entrys
 246          *
 247          * @return      array
 248          */
 249         public function getPhoneBookEntrys () {
 250                 $data = $this->getData('PhoneBook');
 251                 $data = $this->getValues($data);
 252
 253                 if (isset($data['addbookentry'])) {
 254                         return $data['addbookentry'];
 255                 }
 256                 else {
 257                         return array();
 258                 }
 259         }
 260
 261         /**
 262          * get uptime based on online (connection) time
 263          *
 264          * @return      string
 265          */
 266         public function getUptime () {
 267                 $data = $this->getData('LAN');
 268                 $data = $this->getValues($data);
 269
 270                 return $data['days_online'];
 271         }
 272
 273         /**
 274          * return the given json as array
 275          *
 276          * @param       string  $file
 277          * @return      array
 278          */
 279         public function getData ($file) {
 280                 if ($file != 'Status') $this->checkLogin();
 281
 282                 $path = 'data/'.$file.'.json';
 283                 $fields = array();
 284                 $data = $this->sentRequest($path, $fields, true);
 285
 286                 return $data['body'];
 287         }
 288
 289         /**
 290          * get the router syslog
 291          *
 292          * @return      array
 293          */
 294         public function getSyslog() {
 295                 $data = $this->getData('SystemMessages');
 296                 $data = $this->getValues($data);
 297
 298                 if (isset($data['addmessage'])) {
 299                         return $data['addmessage'];
 300                 }
 301                 else {
 302                         return array();
 303                 }
 304         }
 305
 306         /**
 307          * get the Missed Calls from router
 308          *
 309          * @return      array
 310          */
 311         public function getMissedCalls() {
 312                 $data = $this->getData('PhoneCalls');
 313                 $data = $this->getValues($data);
 314
 315                 if (isset($data['addmissedcalls'])) {
 316                         return $data['addmissedcalls'];
 317                 }
 318                 else {
 319                         return array();
 320                 }
 321         }
 322
 323         /**
 324          * get the Taken Calls from router
 325          *
 326          * @return      array
 327          */
 328         public function getTakenCalls() {
 329                 $data = $this->getData('PhoneCalls');
 330                 $data = $this->getValues($data);
 331
 332                 if (isset($data['addtakencalls'])) {
 333                         return $data['addtakencalls'];
 334                 }
 335                 else {
 336                         return array();
 337                 }
 338         }
 339
 340         /**
 341          * get the Dialed Calls from router
 342          *
 343          * @return      array
 344          */
 345         public function getDialedCalls() {
 346                 $data = $this->getData('PhoneCalls');
 347                 $data = $this->getValues($data);
 348
 349                 if (isset($data['adddialedcalls'])) {
 350                         return $data['adddialedcalls'];
 351                 }
 352                 else {
 353                         return array();
 354                 }
 355         }
 356
 357         /**
 358          * reconnect LTE
 359          *
 360          * @return      array
 361          */
 362         public function reconnectLte () {
 363                 $this->checkLogin();
 364
 365                 $path = 'data/modules.json';
 366                 $fields = array('csrf_token' => $this->token, 'lte_reconn' => '1');
 367                 $data = $this->sentEncryptedRequest($path, $fields, true);
 368
 369                 return $data['body'];
 370         }
 371
 372         /**
 373          * reset the router to Factory Default
 374          * not tested
 375          *
 376          * @return      array
 377          */
 378         public function resetToFactoryDefault () {
 379                 $this->checkLogin();
 380
 381                 $path = 'data/resetAllSetting.json';
 382                 $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'reset_all' => 'true');
 383                 $data = $this->sentRequest($path, $fields, true);
 384
 385                 return $data['body'];
 386         }
 387
 388
 389         /**
 390          * check if firmware is actual
 391          *
 392          * @return      array
 393          */
 394         public function checkFirmware () {
 395                 $this->checkLogin();
 396
 397                 $path = 'data/checkfirmware.json';
 398                 $fields = array('checkfirmware' => 'true');
 399                 $data = $this->sentRequest($path, $fields, true);
 400
 401                 return $data['body'];
 402         }
 403
 404         /**
 405          * decrypt data from router
 406          *
 407          * @param       string  $data
 408          * @return      array
 409          */
 410         private function decrypt ($data) {
 411                 $iv = hex2bin(substr($this->challenge, 16, 16));
 412                 $adata = hex2bin(substr($this->challenge, 32, 16));
 413                 $key = hex2bin($this->derivedk);
 414                 $enc = hex2bin($data);
 415
 416                 $factory = new CryptLib\Cipher\Factory();
 417                 $aes = $factory->getBlockCipher('rijndael-128');
 418                 $aes->setKey($key);
 419                 $mode = $factory->getMode('ccm', $aes, $iv, [ 'adata' => $adata, 'lSize' => 7]);
 420
 421                 $mode->decrypt($enc);
 422
 423                 return $mode->finish();
 424         }
 425
 426         /**
 427          * decrypt data for the router
 428          *
 429          * @param       string  $data
 430          * @return      string
 431          */
 432         private function encrypt ($data) {
 433                 $iv = hex2bin(substr($this->challenge, 16, 16));
 434                 $adata = hex2bin(substr($this->challenge, 32, 16));
 435                 $key = hex2bin($this->derivedk);
 436
 437                 $factory = new CryptLib\Cipher\Factory();
 438                 $aes = $factory->getBlockCipher('rijndael-128');
 439                 $aes->setKey($key);
 440                 $mode = $factory->getMode('ccm', $aes, $iv, [ 'adata' => $adata, 'lSize' => 7]);
 441                 $mode->encrypt($data);
 442
 443                 return bin2hex($mode->finish());
 444         }
 445
 446         /**
 447          * get the values from array
 448          *
 449          * @param       array   $array
 450          * @return      array
 451          */
 452         private function getValues($array) {
 453                 $data = array();
 454                 foreach ($array as $item) {
 455                         // thank you telekom for this piece of shit
 456                         if ($item['vartype'] == 'template') {
 457                                 if (is_array($item['varvalue'])) {
 458                                         $data[$item['varid']][] = $this->getValues($item['varvalue']);
 459                                 }
 460                                 else {
 461                                         // i dont know if we need this
 462                                         $data[$item['varid']] = $item['varvalue'];
 463                                 }
 464                         }
 465                         else {
 466                                 if (is_array($item['varvalue'])) {
 467                                         $data[$item['varid']] = $this->getValues($item['varvalue']);
 468                                 }
 469                                 else {
 470                                         $data[$item['varid']] = $item['varvalue'];
 471                                 }
 472                         }
 473                 }
 474
 475                 return $data;
 476         }
 477
 478         /**
 479          * sends the encrypted request to router
 480          *
 481          * @param       string  $path
 482          * @param       mixed   $fields
 483          * @param       string  $cookie
 484          * @return      array
 485          */
 486         private function sentEncryptedRequest ($path, $fields, $cookie = false) {
 487                 $count = count($fields);
 488                 $fields = $this->encrypt(http_build_query($fields));
 489                 return $this->sentRequest($path, $fields, $cookie, $count);
 490         }
 491
 492         /**
 493          * sends the request to router
 494          *
 495          * @param       string  $path
 496          * @param       mixed   $fields
 497          * @param       string  $cookie
 498          * @param       integer $count
 499          * @return      array
 500          */
 501         private function sentRequest ($path, $fields, $cookie = false, $count = 0) {
 502                 $url = $this->url.$path.'?lang=en';
 503                 $ch = curl_init();
 504                 curl_setopt($ch, CURLOPT_URL, $url);
 505
 506                 if (!empty($fields)) {
 507                         if (is_array($fields)) {
 508                                 curl_setopt($ch, CURLOPT_POST, count($fields));
 509                                 curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
 510                         }
 511                         else {
 512                                 curl_setopt($ch, CURLOPT_POST, $count);
 513                                 curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
 514                         }
 515                 }
 516
 517                 if ($cookie === true) {
 518                         curl_setopt($ch, CURLOPT_COOKIE, 'lang=en; challengev='.$this->challenge.'; '.$this->cookie);
 519                 }
 520
 521                 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 522                 curl_setopt($ch, CURLOPT_HEADER, true);
 523
 524                 $result = curl_exec($ch);
 525
 526                 $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
 527                 $header = substr($result, 0, $header_size);
 528                 $body = substr($result, $header_size);
 529                 curl_close($ch);
 530
 531                 // check if response is empty
 532                 if (empty($body)) {
 533                         throw new RouterException('empty response');
 534                 }
 535
 536                 // check if body is encrypted (hex instead of json)
 537                 if (ctype_xdigit($body)) {
 538                         $body = $this->decrypt($body);
 539                 }
 540
 541                 // fix invalid json
 542                 $body = preg_replace("/(\r\n)|(\r)/", "\n", $body);
 543                 $body = preg_replace('/\'/i', '"', $body);
 544                 $body = preg_replace("/\[\s+\]/i", '[ {} ]', $body);
 545                 $body = preg_replace("/},\s+]/", "}\n]", $body);
 546
 547                 // decode json
 548                 if (strpos($url, '.json') !== false) {
 549                         $body = json_decode($body, true);
 550                 }
 551
 552                 return array('header' => $this->parse_headers($header), 'body' => $body);
 553         }
 554
 555         /**
 556          * get the csrf_token
 557          *
 558          * @return      string
 559          */
 560         private function getToken () {
 561                 $this->checkLogin();
 562
 563                 $path = 'html/content/overview/index.html';
 564                 $fields = array();
 565                 $data = $this->sentRequest($path, $fields, true);
 566
 567                 $a = explode('csrf_token = "', $data['body']);
 568                 $a = explode('";', $a[1]);
 569
 570                 if (isset($a[0]) && !empty($a[0])) {
 571                         return $a[0];
 572                 }
 573                 else {
 574                         throw new RouterException('unable to get csrf_token');
 575                 }
 576         }
 577
 578         /**
 579          * calculate the derivedk
 580          *
 581          * @param       string  $password
 582          * @return      string
 583          */
 584         private function getDerviedk ($password) {
 585                 $derivedk = '';
 586
 587                 // calculate derivedk
 588                 if (!function_exists('hash_pbkdf2')) {
 589                         $pbkdf2 = new CryptLib\Key\Derivation\PBKDF\PBKDF2(array('hash' => 'sha1'));
 590                         $derivedk = bin2hex($pbkdf2->derive(hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32));
 591                         $derivedk = substr($derivedk, 0, 32);
 592                 }
 593                 else {
 594                         $derivedk = hash_pbkdf2('sha1', hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
 595                 }
 596
 597                 if (empty($derivedk)) {
 598                         throw new RouterException('unable to calculate derivedk');
 599                 }
 600
 601                 return $derivedk;
 602         }
 603
 604         /**
 605          * get cookie from header data
 606          *
 607          * @param       array   $data
 608          * @return      string
 609          */
 610         private function getCookie ($data) {
 611                 $cookie = '';
 612                 if (isset($data['header']['Set-Cookie']) && !empty($data['header']['Set-Cookie'])) {
 613                         preg_match('/^.*(SessionID_R3=[a-z0-9]*).*/i', $data['header']['Set-Cookie'], $match);
 614                         if (isset($match[1]) && !empty($match[1])) {
 615                                 $cookie = $match[1];
 616                         }
 617                 }
 618
 619                 if (empty($cookie)) {
 620                         throw new RouterException('unable to get the session cookie from the router');
 621                 }
 622
 623                 return $cookie;
 624         }
 625
 626         /**
 627          * parse the curl return header into an array
 628          *
 629          * @param       string  $response
 630          * @return      array
 631          */
 632         private function parse_headers($response) {
 633                 $headers = array();
 634                 $header_text = substr($response, 0, strpos($response, "\r\n\r\n"));
 635
 636                 $header_text = explode("\r\n", $header_text);
 637                 foreach ($header_text as $i => $line) {
 638                         if ($i === 0) {
 639                                 $headers['http_code'] = $line;
 640                         }
 641                         else {
 642                                 list ($key, $value) = explode(': ', $line);
 643                                 $headers[$key] = $value;
 644                         }
 645                 }
 646
 647                 return $headers;
 648         }
 649 }