tplinkrouterc6u 5.11.0__tar.gz → 5.12.1__tar.gz

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tplinkrouterc6u
-Version: 5.11.0
+Version: 5.12.1
 Summary: TP-Link Router API (supports also Mercusys Router)
 Home-page: https://github.com/AlexandrErohin/TP-Link-Archer-C6U
 Author: Alex Erohin
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -48,7 +49,7 @@ Python package for API access and management for TP-Link and Mercusys Routers. S
  - [pycryptodome](https://pypi.org/project/pycryptodome/)
 
 ## Usage
-Enter the host & credentials used to log in to your router management page. Username is admin by default. But you may pass username as third parameter
+Enter the host & credentials used to log in to your router management page. Username is `admin` by default. But you may pass username as third parameter. Some routers have default username - `user`
 
 ```python
 from tplinkrouterc6u import (
@@ -56,13 +57,17 @@ from tplinkrouterc6u import (
     TplinkRouter,
     TplinkC1200Router,
     TplinkC5400XRouter,
-    TPLinkMRClient,
+    TPLinkMRClient, # Class for MR series routers which supports old firmwares with AES cipher CBC mode
+    TPLinkMRClientGCM, # Class for MR series routers which supports AES cipher GCM mode
+    TPLinkMR200Client,
     TPLinkVRClient,
-    TPLinkEXClient,
+    TPLinkEXClient, # Class for EX series routers which supports old firmwares with AES cipher CBC mode
+    TPLinkEXClientGCM, # Class for EX series routers which supports AES cipher GCM mode
     TPLinkXDRClient,
     TPLinkDecoClient,
     TplinkC80Router,
     TplinkWDRRouter,
+    TplinkRE330Router,
     Connection
 )
 from logging import Logger
@@ -243,6 +248,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 | --- |---|---|
 | openvpn_enable | OpenVPN is enabled | bool |
 | pptpvpn_enable | PPTPVPN is enabled | bool |
+| ipsecvpn_enable | IPSEC is enabled | bool |
 | openvpn_clients_total | OpenVPN clients connected | int |
 | pptpvpn_clients_total | PPTPVPN clients connected | int |
 
@@ -292,6 +298,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 ### <a id="vpn">VPN</a>
 - VPN.OPEN_VPN
 - VPN.PPTP_VPN
+- VPN.IPSEC
 
 ## <a id="supports">Supported routers</a>
 - [TP-LINK routers](#tplink)
@@ -316,6 +323,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer AX73 (V1, V2.0)
 - Archer AX75 V1
 - Archer AX90 V1.20
+- Archer AX95 v1.0
 - Archer AXE75 V1
 - Archer AXE5400 v1.0
 - Archer AXE16000
@@ -323,6 +331,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer AX3000 V1
 - Archer AX6000 V1
 - Archer AX11000 V1
+- Archer BE220 v1.0
 - Archer BE230 v1.0
 - Archer BE400 v1.0
 - Archer BE550 v1.0
@@ -340,7 +349,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer C80 (1.0, 2.20)
 - Archer C5400X V1
 - Archer GX90 v1.0
-- Archer MR200 (v5, v5.3, v6.0)
+- Archer MR200 (v2, v5, v5.3, v6.0)
 - Archer MR550 v1
 - Archer MR600 (v1, v2, v3)
 - Archer NX200 v2.0
@@ -349,6 +358,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer VR900v
 - Archer VR1200v v1
 - Archer VR2100v v1
+- Archer VX231v v1.0
 - Archer VX1800v v1.0
 - BE11000 2.0
 - Deco M4 2.0
@@ -379,11 +389,15 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - TL-WA3001 v1.0
 - TL-XDR3010 V2
 - TL-WDR3600 V1
+- TL-XDR6088 v1.0.30
 - VX420-G2h v1.1
 - VX800v v1
 - XC220-G3v v2.30
+- RE305 4.0
+- RE315 1.0
 - RE330 v1
 ### <a id="mercusys">MERCUSYS routers</a>
+- AC10 1.20
 - MR47BE v1.0
 - MR50G 1.0
 - H60XR 1.0

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/README.md

@@ -16,7 +16,7 @@ Python package for API access and management for TP-Link and Mercusys Routers. S
  - [pycryptodome](https://pypi.org/project/pycryptodome/)
 
 ## Usage
-Enter the host & credentials used to log in to your router management page. Username is admin by default. But you may pass username as third parameter
+Enter the host & credentials used to log in to your router management page. Username is `admin` by default. But you may pass username as third parameter. Some routers have default username - `user`
 
 ```python
 from tplinkrouterc6u import (
@@ -24,13 +24,17 @@ from tplinkrouterc6u import (
     TplinkRouter,
     TplinkC1200Router,
     TplinkC5400XRouter,
-    TPLinkMRClient,
+    TPLinkMRClient, # Class for MR series routers which supports old firmwares with AES cipher CBC mode
+    TPLinkMRClientGCM, # Class for MR series routers which supports AES cipher GCM mode
+    TPLinkMR200Client,
     TPLinkVRClient,
-    TPLinkEXClient,
+    TPLinkEXClient, # Class for EX series routers which supports old firmwares with AES cipher CBC mode
+    TPLinkEXClientGCM, # Class for EX series routers which supports AES cipher GCM mode
     TPLinkXDRClient,
     TPLinkDecoClient,
     TplinkC80Router,
     TplinkWDRRouter,
+    TplinkRE330Router,
     Connection
 )
 from logging import Logger
@@ -211,6 +215,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 | --- |---|---|
 | openvpn_enable | OpenVPN is enabled | bool |
 | pptpvpn_enable | PPTPVPN is enabled | bool |
+| ipsecvpn_enable | IPSEC is enabled | bool |
 | openvpn_clients_total | OpenVPN clients connected | int |
 | pptpvpn_clients_total | PPTPVPN clients connected | int |
 
@@ -260,6 +265,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 ### <a id="vpn">VPN</a>
 - VPN.OPEN_VPN
 - VPN.PPTP_VPN
+- VPN.IPSEC
 
 ## <a id="supports">Supported routers</a>
 - [TP-LINK routers](#tplink)
@@ -284,6 +290,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer AX73 (V1, V2.0)
 - Archer AX75 V1
 - Archer AX90 V1.20
+- Archer AX95 v1.0
 - Archer AXE75 V1
 - Archer AXE5400 v1.0
 - Archer AXE16000
@@ -291,6 +298,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer AX3000 V1
 - Archer AX6000 V1
 - Archer AX11000 V1
+- Archer BE220 v1.0
 - Archer BE230 v1.0
 - Archer BE400 v1.0
 - Archer BE550 v1.0
@@ -308,7 +316,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer C80 (1.0, 2.20)
 - Archer C5400X V1
 - Archer GX90 v1.0
-- Archer MR200 (v5, v5.3, v6.0)
+- Archer MR200 (v2, v5, v5.3, v6.0)
 - Archer MR550 v1
 - Archer MR600 (v1, v2, v3)
 - Archer NX200 v2.0
@@ -317,6 +325,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer VR900v
 - Archer VR1200v v1
 - Archer VR2100v v1
+- Archer VX231v v1.0
 - Archer VX1800v v1.0
 - BE11000 2.0
 - Deco M4 2.0
@@ -347,11 +356,15 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - TL-WA3001 v1.0
 - TL-XDR3010 V2
 - TL-WDR3600 V1
+- TL-XDR6088 v1.0.30
 - VX420-G2h v1.1
 - VX800v v1
 - XC220-G3v v2.30
+- RE305 4.0
+- RE315 1.0
 - RE330 v1
 ### <a id="mercusys">MERCUSYS routers</a>
+- AC10 1.20
 - MR47BE v1.0
 - MR50G 1.0
 - H60XR 1.0

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="tplinkrouterc6u",
-    version="5.11.0",
+    version="5.12.1",
     author="Alex Erohin",
     author_email="alexanderErohin@yandex.ru",
     description="TP-Link Router API (supports also Mercusys Router)",
@@ -21,6 +21,7 @@ setuptools.setup(
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "Programming Language :: Python :: Implementation :: PyPy",
     ],
     install_requires=['requests', 'pycryptodome', 'macaddress'],

tplinkrouterc6u-5.12.1/test/test_client_mr_200.py

@@ -0,0 +1,43 @@
+from unittest import main, TestCase
+from unittest.mock import patch, MagicMock
+from requests import Session
+from tplinkrouterc6u import TPLinkMR200Client
+
+
+class TestTPLinkMR200Client(TestCase):
+    def setUp(self):
+        self.obj = TPLinkMR200Client('', '')
+
+    def test_supports_false(self):
+        responses = [
+            'var param1="0x1A"\nvar param2="0x2B"\nignored line\n',
+            '404',
+            'var nn="dfgdfg"\nvar ee="0x2B"\n'
+        ]
+
+        fake_responses = []
+        for text in responses:
+            r = MagicMock()
+            r.text = text
+            fake_responses.append(r)
+
+        with patch.object(Session, "get", side_effect=fake_responses):
+            for _ in range(len(fake_responses)):
+                result = self.obj.supports()
+                self.assertFalse(result)
+
+    def test_supports_true(self):
+        fake_response = MagicMock()
+        fake_response.text = (
+            'var nn="0x1A"\n'
+            'var ee="0x2B"\n'
+        )
+
+        with patch.object(Session, "get", return_value=fake_response):
+            result = self.obj.supports()
+
+        self.assertEqual(result, True)
+
+
+if __name__ == '__main__':
+    main()

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/tplinkrouterc6u/__init__.py

@@ -1,9 +1,9 @@
 from tplinkrouterc6u.client.c6u import TplinkRouter
 from tplinkrouterc6u.client.deco import TPLinkDecoClient
 from tplinkrouterc6u.client_abstract import AbstractRouter
-from tplinkrouterc6u.client.mr import TPLinkMRClient
+from tplinkrouterc6u.client.mr import TPLinkMRClient, TPLinkMRClientGCM
 from tplinkrouterc6u.client.mr200 import TPLinkMR200Client
-from tplinkrouterc6u.client.ex import TPLinkEXClient
+from tplinkrouterc6u.client.ex import TPLinkEXClient, TPLinkEXClientGCM
 from tplinkrouterc6u.client.vr import TPLinkVRClient
 from tplinkrouterc6u.client.c80 import TplinkC80Router
 from tplinkrouterc6u.client.c5400x import TplinkC5400XRouter

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/tplinkrouterc6u/client/c80.py

@@ -1,12 +1,9 @@
 from dataclasses import dataclass
 from logging import Logger
 from urllib import parse
-from base64 import b64encode, b64decode
 from collections import defaultdict
 from ipaddress import IPv4Address
 import re
-from Crypto.Cipher import AES
-from Crypto.Util.Padding import pad, unpad
 from macaddress import EUI48
 import requests
 from requests import Session
@@ -21,7 +18,6 @@ from tplinkrouterc6u.client_abstract import AbstractRouter
 class RouterConstants:
     AUTH_TOKEN_INDEX1 = 3
     AUTH_TOKEN_INDEX2 = 4
-    DEFAULT_AES_VALUE = "0000000000000000"
 
     HOST_WIFI_2G_REQUEST = '33|1,1,0'
     HOST_WIFI_5G_REQUEST = '33|2,1,0'
@@ -64,9 +60,7 @@ class EncryptionState:
         self.nn_rsa = ''
         self.ee_rsa = ''
         self.seq = ''
-        self.key_aes = ''
-        self.iv_aes = ''
-        self.aes_string = ''
+        self.aes = EncryptionWrapper()
         self.token = ''
 
 
@@ -105,14 +99,11 @@ class TplinkC80Router(AbstractRouter):
         self._encryption.nn_rsa = responseText[2]
         self._encryption.seq = responseText[3]
 
-        # Generate key and initialization vector
-        self._encryption.key_aes = RouterConstants.DEFAULT_AES_VALUE
-        self._encryption.iv_aes = RouterConstants.DEFAULT_AES_VALUE
-        self._encryption.aes_string = f'k={self._encryption.key_aes}&i={self._encryption.iv_aes}'
-
         # Encrypt AES string
-        aes_string_encrypted = EncryptionWrapper.rsa_encrypt(self._encryption.aes_string, self._encryption.nn_rsa,
+        aes_string_encrypted = EncryptionWrapper.rsa_encrypt(self._encryption.aes._get_aes_string(),
+                                                             self._encryption.nn_rsa,
                                                              self._encryption.ee_rsa)
+
         # Register AES string for decryption on server side
         self.request(16, 0, True, data=f'set {aes_string_encrypted}')
         # Some auth request, might be redundant
@@ -368,7 +359,7 @@ class TplinkC80Router(AbstractRouter):
 
     def _get_signature(self, datalen: int) -> str:
         encryption = self._encryption
-        r = f'{encryption.aes_string}&s={str(int(encryption.seq) + datalen)}'
+        r = f'{encryption.aes._get_aes_string()}&s={str(int(encryption.seq) + datalen)}'
         e = ''
         n = 0
         while n < len(r):
@@ -377,24 +368,12 @@ class TplinkC80Router(AbstractRouter):
         return e
 
     def _encrypt_body(self, text: str) -> str:
-        encryption = self._encryption
-
-        key_bytes = encryption.key_aes.encode("utf-8")
-        iv_bytes = encryption.iv_aes.encode("utf-8")
-
-        cipher = AES.new(key_bytes, AES.MODE_CBC, iv_bytes)
-        data = b64encode(cipher.encrypt(pad(text.encode("utf-8"), AES.block_size))).decode()
-
+        data = self._encryption.aes.aes_encrypt(text)
         sign = self._get_signature(len(data))
         return f'sign={sign}\r\ndata={data}'
 
     def _decrypt_data(self, encrypted_text: str) -> str:
-        key_bytes = self._encryption.key_aes.encode("utf-8")
-        iv_bytes = self._encryption.iv_aes.encode("utf-8")
-
-        cipher = AES.new(key_bytes, AES.MODE_CBC, iv_bytes)
-        decrypted_padded = cipher.decrypt(b64decode(encrypted_text))
-        return unpad(decrypted_padded, AES.block_size).decode("utf-8")
+        return self._encryption.aes.aes_decrypt(encrypted_text)
 
     def _extract_value(self, response_list, prefix):
         return next((s.split(prefix, 1)[1] for s in response_list if s.startswith(prefix)), None)

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/tplinkrouterc6u/client/ex.py

@@ -15,9 +15,10 @@ from tplinkrouterc6u.common.dataclass import (
     IPv4Status,
     VPNStatus)
 from tplinkrouterc6u.common.exception import ClientException, ClientError
-from tplinkrouterc6u.client.mr import TPLinkMRClientBase
+from tplinkrouterc6u.client.mr import TPLinkMRClientBase, TPLinkMRClientBaseGCM
 
 
+# Class for EX series routers which supports old firmwares with AES cipher CBC mode
 class TPLinkEXClient(TPLinkMRClientBase):
     WIFI_SET = {
         Connection.HOST_2G: '1,0,0,0,0,0',
@@ -331,3 +332,39 @@ class TPLinkEXClient(TPLinkMRClientBase):
         ]
 
         self.req_act(acts)
+
+
+# Class for EX series routers which supports AES cipher GCM mode
+class TPLinkEXClientGCM(TPLinkMRClientBaseGCM, TPLinkEXClient):
+
+    def _req_login(self) -> None:
+        login_data = ('{"data":{"UserName":"%s","Passwd":"%s","Action": "1","stack":"0,0,0,0,0,0",'
+                      '"pstack":"0,0,0,0,0,0"},"operation":"cgi","oid":"/cgi/login"}') % (
+            b64encode(bytes(self.username, "utf-8")).decode("utf-8"),
+            b64encode(bytes(self.password, "utf-8")).decode("utf-8")
+        )
+
+        sign, data, tag = self._prepare_data(login_data, True)
+        assert len(sign) == 256
+
+        request_data = f"sign={sign}\r\ndata={data}\r\ntag={tag}\r\n"
+
+        url = f"{self.host}/cgi_gdpr?9"
+        (code, response) = self._request(url, data_str=request_data)
+        response = self._encryption.aes_decrypt(response)
+
+        # parse and match return code
+        ret_code = self._parse_ret_val(response)
+        error = ''
+        if ret_code == self.HTTP_ERR_USER_PWD_NOT_CORRECT:
+            error = ('TplinkRouter - EX - Login failed, wrong user or password. '
+                     'Try to pass user instead of admin in username')
+        elif ret_code == self.HTTP_ERR_USER_BAD_REQUEST:
+            error = 'TplinkRouter - EX - Login failed. Generic error code: {}'.format(ret_code)
+        elif ret_code != self.HTTP_RET_OK:
+            error = 'TplinkRouter - EX - Login failed. Unknown error code: {}'.format(ret_code)
+
+        if error:
+            if self._logger:
+                self._logger.debug(error)
+            raise ClientException(error)

{tplinkrouterc6u-5.11.0 → tplinkrouterc6u-5.12.1}/tplinkrouterc6u/client/mr.py

@@ -8,7 +8,7 @@ from macaddress import EUI48
 from ipaddress import IPv4Address
 from logging import Logger
 from tplinkrouterc6u.common.helper import get_ip, get_mac, get_value
-from tplinkrouterc6u.common.encryption import EncryptionWrapperMR
+from tplinkrouterc6u.common.encryption import EncryptionWrapperMR, EncryptionWrapperMRGCM
 from tplinkrouterc6u.common.package_enum import Connection, VPN
 from tplinkrouterc6u.common.dataclass import (
     Firmware,
@@ -80,6 +80,7 @@ class TPLinkMRClientBase(AbstractRouter):
         if self._verify_ssl is False:
             self.req.verify = False
         self._token = None
+        self._authorized_at = None
         self._hash = md5(f"{self.username}{self.password}".encode()).hexdigest()
         self._nn = None
         self._ee = None
@@ -96,10 +97,9 @@ class TPLinkMRClientBase(AbstractRouter):
             return False
 
     def authorize(self) -> None:
-        '''
-        Establishes a login session to the host using provided credentials
-        '''
-        # hash the password
+        if self._token is not None and self._authorized_at >= (datetime.now() - timedelta(seconds=3)):
+            return
+        self._token = None
 
         # request the RSA public key from the host
         self._nn, self._ee, self._seq = self._req_rsa_key()
@@ -109,6 +109,7 @@ class TPLinkMRClientBase(AbstractRouter):
 
         # request TokenID
         self._token = self._req_token()
+        self._authorized_at = datetime.now()
 
     def reboot(self) -> None:
         acts = [
@@ -587,6 +588,71 @@ class TPLinkMRClientBase(AbstractRouter):
         return signature, encrypted_data
 
 
+class TPLinkMRClientBaseGCM(TPLinkMRClientBase):
+    def __init__(self, host: str, password: str, username: str = 'admin', logger: Logger = None,
+                 verify_ssl: bool = True, timeout: int = 30) -> None:
+        super().__init__(host, password, username, logger, verify_ssl, timeout)
+
+        self._encryption = EncryptionWrapperMRGCM()
+
+    def supports(self) -> bool:
+        try:
+            self.authorize()
+            return True
+        except Exception:
+            pass
+
+        return False
+
+    def _request(self, url, method='POST', data_str=None, encrypt=False, is_login=False):
+        headers = self.HEADERS
+        headers['Referer'] = self.host
+
+        if self._token is not None:
+            headers['TokenID'] = self._token
+
+        if encrypt:
+            sign, data, tag = self._prepare_data(data_str, is_login)
+            data = 'sign={}\r\ndata={}\r\ntag={}\r\n'.format(sign, data, tag)
+        else:
+            data = data_str
+
+        retry = 0
+        while retry < self.REQUEST_RETRIES:
+            # send the request
+            if method == 'POST':
+                r = self.req.post(url, data=data, headers=headers, timeout=self.timeout, verify=self._verify_ssl)
+            elif method == 'GET':
+                r = self.req.get(url, data=data, headers=headers, timeout=self.timeout, verify=self._verify_ssl)
+            else:
+                raise Exception('Unsupported method ' + str(method))
+
+            # sometimes we get 500 here, not sure why... just retry the request
+            if (r.status_code not in [500, 406]
+                    and '<title>500 Internal Server Error</title>' not in r.text
+                    and '<title>406 Not Acceptable</title>' not in r.text):
+                break
+
+            sleep(0.1)
+            retry += 1
+
+        # decrypt the response, if needed
+        if encrypt and (r.status_code == 200) and (r.text != ''):
+            return r.status_code, self._encryption.aes_decrypt(r.text)
+        else:
+            return r.status_code, r.text
+
+    def _prepare_data(self, data: str, is_login: bool) -> tuple[str, str, str]:
+        encrypted_data, tag = self._encryption.aes_encrypt(data)
+        data_len = len(encrypted_data)
+        # get encrypted signature
+        signature = self._encryption.get_signature(int(self._seq) + data_len, is_login, self._hash, self._nn, self._ee)
+
+        # format expected raw request data
+        return signature, encrypted_data, tag
+
+
+# Class for MR series routers which supports old firmwares with AES cipher CBC mode
 class TPLinkMRClient(TPLinkMRClientBase):
 
     def logout(self) -> None:
@@ -716,3 +782,8 @@ class TPLinkMRClient(TPLinkMRClientBase):
         status.isp_name = values['3']['ispName']
 
         return status
+
+
+# Class for MR series routers which supports AES cipher GCM mode
+class TPLinkMRClientGCM(TPLinkMRClientBaseGCM, TPLinkMRClient):
+    pass