Merge pull request #4 from GuyKh/patch-1

Add VR600 Support

README.md

@@ -58,7 +58,8 @@ Devices originally supported include the following:
 Additional devices added since the removal from Home Assistant:
 
 - TPLink N600 with latest firmware
+- TPLink VR600 with latest firmware
 
 If your device is not in the list, you can still give it a try and let me know if it works or not, I'll update the documentation.
 
-*Disclaimer*: I cannot add support for devices I don't own, unless you provide me with a list of HTTP requests leading to the page listing MAC address of connected devices, including authentication, and an example of the page.
+*Disclaimer*: I cannot add support for devices I don't own, unless you provide me with a list of HTTP requests leading to the page listing MAC address of connected devices, including authentication, and an example of the page.

custom_components/tplink_router/device_tracker.py

@@ -5,6 +5,12 @@
 import hashlib
 import logging
 import re
+from Crypto.PublicKey.RSA import construct
+from Crypto.Cipher import PKCS1_v1_5
+import binascii
+import string, random
+import time
+
 
 from aiohttp.hdrs import (
  ACCEPT,
@@ -41,9 +47,10 @@
 
 def get_scanner(hass, config):
  """Validate the configuration and return a TP-Link scanner."""
- for cls in [Tplink5DeviceScanner, Tplink4DeviceScanner,
- Tplink3DeviceScanner, Tplink2DeviceScanner,
- Tplink1DeviceScanner, TplinkDeviceScanner]:
+ for cls in [Tplink6DeviceScanner, Tplink5DeviceScanner, 
+ Tplink4DeviceScanner, Tplink3DeviceScanner, 
+ Tplink2DeviceScanner, Tplink1DeviceScanner, 
+ TplinkDeviceScanner]:
  scanner = cls(config[DOMAIN])
  if scanner.success_init:
  return scanner
@@ -494,3 +501,203 @@ def _update_info(self):
  return True
 
  return False
+
+class Tplink6DeviceScanner(TplinkDeviceScanner):
+ """This class queries an Archer VR600 router with TP-Link firmware."""
+
+ def __init__(self, config):
+ """Initialize the scanner."""
+ self.pubkey = ''
+ self.jsessionId = ''
+ self.token = ''
+ super(Tplink6DeviceScanner, self).__init__(config)
+
+ def scan_devices(self):
+ """Scan for new devices and return a list with found device IDs."""
+ self._update_info()
+ return self.last_results
+
+ # pylint: disable=no-self-use
+ def get_device_name(self, device):
+ """Get the name of the wireless device."""
+ return None
+
+
+ def _get_pub_key(self):
+ # Get the modulu and exponent from the router
+ url = 'http:https://{}/cgi/getParm'.format(self.host)
+ referer = 'http:https://{}'.format(self.host)
+ response = requests.post(url, headers={ 'REFERER': referer})
+ if not response.status_code == 200:
+ return False
+
+ ee = self._get_field_from_router_response(response.text, 'ee')
+ nn = self._get_field_from_router_response(response.text, 'nn')
+
+ e = int(ee, 16)
+ n = int(nn, 16) #snipped for brevity
+
+ pubkey = construct((n, e))
+ self.pubkey = PKCS1_v1_5.new(pubkey)
+
+ return True
+
+ def _get_field_from_router_response(self, rText, key):
+ lines = rText.split('\n')
+ for line in lines:
+ if (line.startswith('var '+ key)):
+ # var ee="010101" => "010101"
+ return line.split('=\"')[1].split('\";')[0]
+ return ''
+
+
+ def _get_jsession_id(self):
+ username = self.username.encode('utf-8')
+ password = self.password.encode('utf-8')
+
+ b64pass = base64.b64encode(password)
+ encryptedUsername = self.pubkey.encrypt(username)
+ encryptedPassword = self.pubkey.encrypt(b64pass)
+
+ base16username = base64.b16encode(encryptedUsername).decode('utf-8').lower()
+ base16password = base64.b16encode(encryptedPassword).decode('utf-8').lower()
+
+ referer = 'http:https://{}'.format(self.host)
+ url = 'http:https://{}/cgi/login?UserName={}&Passwd={}&Action=1&LoginStatus=0'.format(self.host, base16username, base16password)
+
+ randomSessionNum = self._get_random_alphaNumeric_string(15)
+
+ headers= { REFERER: referer }
+
+ response = requests.post(url, headers=headers)
+
+ if not response.status_code == 200:
+ _LOGGER.error("Error %s from router", page.response)
+ return False
+
+ self.jsessionId = dict(response.cookies)['JSESSIONID']
+ return True
+
+ def _get_random_alphaNumeric_string(self, stringLength=15):
+ lettersAndDigits = string.ascii_letters + string.digits
+ return ''.join((random.choice(lettersAndDigits) for i in range(stringLength)))
+
+ def _get_token(self):
+ url = 'http:https://{}/'.format(self.host)
+ referer = 'http:https://{}'.format(self.host)
+
+ headers= {
+ REFERER: referer,
+ COOKIE: 'loginErrorShow=1; JSESSIONID='+self.jsessionId,
+ }
+
+ cookies = {'JSESSIONID': self.jsessionId}
+ response = requests.get(url, headers=headers, cookies=cookies)
+
+ if not response.status_code == 200:
+ _LOGGER.error("Error %s from router", page.response)
+ return False
+
+
+ split = response.text.index('var token=') + len('var token=\"') 
+ token = response.text[split:split+30]
+
+ self.token = token
+ return True
+
+
+ def _get_auth_tokens(self):
+ """Retrieve auth tokens from the router."""
+ _LOGGER.info("Retrieving PublicKey...")
+
+ pubkey = self._get_pub_key()
+ if not pubkey:
+ return False
+
+ _LOGGER.info("Retrieving JSessionID...")
+ jsessionId = self._get_jsession_id()
+ if not jsessionId:
+ return False
+
+ _LOGGER.info("Retrieving Token...")
+ token = self._get_token()
+ if not token:
+ return False
+
+ return True
+
+ def _get_mac_results(self):
+ referer = 'http:https://{}'.format(self.host)
+ headers= {
+ 'TokenID': self.token,
+ REFERER: referer,
+ COOKIE: 'JSESSIONID=' + self.jsessionId
+ }
+
+ mac_results = []
+
+ # Check both the 2.4GHz and 5GHz client lists.
+ for clients_frequency in ('1', '2'):
+
+ # Refresh associated clients.
+ page = requests.post(
+ 'http:https://{}/cgi?7'.format(self.host),
+ headers=headers,
+ data=(
+ '[ACT_WLAN_UPDATE_ASSOC#1,{},0,0,0,0#0,0,0,0,0,0]0,0\r\n'
+ ).format(clients_frequency),
+ timeout=4)
+ if not page.status_code == 200:
+ _LOGGER.error("Error %s from router", page.status_code)
+ return False
+
+ # Retrieve associated clients.
+ page = requests.post(
+ 'http:https://{}/cgi?6'.format(self.host),
+ headers=headers,
+ data=(
+ '[LAN_WLAN_ASSOC_DEV#0,0,0,0,0,0#1,{},0,0,0,0]0,1\r\n'
+ 'AssociatedDeviceMACAddress\r\n'
+ ).format(clients_frequency),
+ timeout=4)
+ if not page.status_code == 200:
+ _LOGGER.error("Error %s from router", page.status_code)
+ return False
+
+ mac_results.extend(self.parse_macs_colons.findall(page.text))
+
+ self.last_results = mac_results
+ return True
+
+
+ def _update_info(self):
+ """Ensure the information from the TP-Link router is up to date.
+ Return boolean if scanning successful.
+ """
+
+ if (self.jsessionId == '') or (self.token == ''):
+ gotToken = self._get_auth_tokens()
+ if not gotToken:
+ # Retry
+ _LOGGER.info("Failed to get AuthTokens. Retrying in 3 secs.")
+ time.sleep(3)
+ gotToken = self._get_auth_tokens()
+ else:
+ gotToken = True
+
+ if not gotToken:
+ """ In case of failure - force re-login """
+ self.jsessionId = ''
+ self.token = ''
+ return False
+
+ _LOGGER.info("Loading wireless clients...")
+
+ macResults = self._get_mac_results()
+ if not macResults:
+ """ In case of failure - force re-login """
+ self.jsessionId = ''
+ self.token = ''
+ return False
+
+ return True

info.md

@@ -25,11 +25,12 @@ device_tracker:
 - Archer C9 firmware version 150811
 - EAP-225 AP with latest firmware version
 - Archer D9 firmware version 0.9.1 0.1 v0041.0 Build 160224 Rel.59129n
-- TPLink N600 with latest firmware (added since removal of the integration from Home Assistant)
+- TPLink N600 with latest firmware (added since removal of the integration from Home Assistant
+- VR600 with latest firmware (added since removal of the integration from Home Assistant)
 
 If your device is not in the list, you can still give it a try and let me know if it works or not, I'll update the documentation.
 
 *Disclaimer*: I cannot add support for devices I don't own, unless you provide me with a list of HTTP requests leading to the page listing MAC address of connected devices, including authentication, and an example of the page.
 
 ## Documentation
-See [README](https://github.com/ericpignet/home-assistant-tplink_router/blob/master/README.md) for full documentation.
+See [README](https://github.com/ericpignet/home-assistant-tplink_router/blob/master/README.md) for full documentation.