mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
07af48e41a
* Discover refactoring, enhancements to the cli tool * Discover tries to detect the type of the device from sysinfo response * Discover.discover() returns an IP address keyed dictionary, values are initialized instances of the automatically detected device type. * When no IP is given, autodetect all supported devices and print out their states * When only IP but no type is given, autodetect type and make a call based on that information. * One can define --bulb or --plug to skip the detection. * renamed pyHS100.py -> smartdevice.py * SmartPlugException -> SmartDeviceException in comments * fix mic_type check * make time() return None on failure as we don't know which devices support getting the time and it's used in the cli tool * hw_info: check if key exists before accessing it, add mic_mac and mic_type * Check for mic_mac on mac, based on work by kdschloesser on issue #59 * make hound happy, __init__ on SmartDevice cannot error out so removing 'raises' documentation
116 lines
3.4 KiB
Python
116 lines
3.4 KiB
Python
import json
|
|
import socket
|
|
import struct
|
|
import logging
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class TPLinkSmartHomeProtocol:
|
|
"""
|
|
Implementation of the TP-Link Smart Home Protocol
|
|
|
|
Encryption/Decryption methods based on the works of
|
|
Lubomir Stroetmann and Tobias Esser
|
|
|
|
https://www.softscheck.com/en/reverse-engineering-tp-link-hs110/
|
|
https://github.com/softScheck/tplink-smartplug/
|
|
|
|
which are licensed under the Apache License, Version 2.0
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
"""
|
|
INITIALIZATION_VECTOR = 171
|
|
DEFAULT_PORT = 9999
|
|
DEFAULT_TIMEOUT = 5
|
|
|
|
@staticmethod
|
|
def query(host, request, port=DEFAULT_PORT):
|
|
"""
|
|
Request information from a TP-Link SmartHome Device and return the
|
|
response.
|
|
|
|
:param str host: ip address of the device
|
|
:param int port: port on the device (default: 9999)
|
|
:param request: command to send to the device (can be either dict or
|
|
json string)
|
|
:return:
|
|
"""
|
|
if isinstance(request, dict):
|
|
request = json.dumps(request)
|
|
|
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
sock.settimeout(TPLinkSmartHomeProtocol.DEFAULT_TIMEOUT)
|
|
try:
|
|
sock.connect((host, port))
|
|
|
|
_LOGGER.debug("> (%i) %s", len(request), request)
|
|
sock.send(TPLinkSmartHomeProtocol.encrypt(request))
|
|
|
|
buffer = bytes()
|
|
# Some devices send responses with a length header of 0 and
|
|
# terminate with a zero size chunk. Others send the length and
|
|
# will hang if we attempt to read more data.
|
|
length = -1
|
|
while True:
|
|
chunk = sock.recv(4096)
|
|
if length == -1:
|
|
length = struct.unpack(">I", chunk[0:4])[0]
|
|
buffer += chunk
|
|
if (length > 0 and len(buffer) >= length + 4) or not chunk:
|
|
break
|
|
|
|
finally:
|
|
try:
|
|
sock.shutdown(socket.SHUT_RDWR)
|
|
sock.close()
|
|
except OSError:
|
|
# OSX raises OSError when shutdown() gets called on a closed
|
|
# socket. We ignore it here as the data has already been read
|
|
# into the buffer at this point.
|
|
pass
|
|
|
|
response = TPLinkSmartHomeProtocol.decrypt(buffer[4:])
|
|
_LOGGER.debug("< (%i) %s", len(response), response)
|
|
|
|
return json.loads(response)
|
|
|
|
@staticmethod
|
|
def encrypt(request):
|
|
"""
|
|
Encrypt a request for a TP-Link Smart Home Device.
|
|
|
|
:param request: plaintext request data
|
|
:return: ciphertext request
|
|
"""
|
|
key = TPLinkSmartHomeProtocol.INITIALIZATION_VECTOR
|
|
buffer = bytearray(struct.pack(">I", len(request)))
|
|
|
|
for char in request:
|
|
cipher = key ^ ord(char)
|
|
key = cipher
|
|
buffer.append(cipher)
|
|
|
|
return buffer
|
|
|
|
@staticmethod
|
|
def decrypt(ciphertext):
|
|
"""
|
|
Decrypt a response of a TP-Link Smart Home Device.
|
|
|
|
:param ciphertext: encrypted response data
|
|
:return: plaintext response
|
|
"""
|
|
key = TPLinkSmartHomeProtocol.INITIALIZATION_VECTOR
|
|
buffer = []
|
|
|
|
ciphertext = ciphertext.decode('latin-1')
|
|
|
|
for char in ciphertext:
|
|
plain = key ^ ord(char)
|
|
key = ord(char)
|
|
buffer.append(chr(plain))
|
|
|
|
plaintext = ''.join(buffer)
|
|
|
|
return plaintext
|