tplinkrouterc6u 5.12.4__tar.gz → 5.13.0__tar.gz

{tplinkrouterc6u-5.12.4/tplinkrouterc6u.egg-info → tplinkrouterc6u-5.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tplinkrouterc6u
-Version: 5.12.4
+Version: 5.13.0
 Summary: TP-Link Router API (supports also Mercusys Router)
 Home-page: https://github.com/AlexandrErohin/TP-Link-Archer-C6U
 Author: Alex Erohin
@@ -56,6 +56,7 @@ Python package for API access and management for TP-Link and Mercusys Routers. S
 ```python
 from tplinkrouterc6u import (
     TplinkRouterProvider,
+    TplinkRouterV1_11,
     TplinkRouter,
     TplinkC1200Router,
     TplinkC5400XRouter,
@@ -66,6 +67,7 @@ from tplinkrouterc6u import (
     TPLinkVR400v2Client,
     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
+    TPLinkRClient,
     TPLinkXDRClient,
     TPLinkDecoClient,
     TplinkC80Router,
@@ -83,7 +85,7 @@ router = TplinkRouterProvider.get_client('http://192.168.0.1', 'password')
 # If you have the TP-link C5400X or similar, you can use the TplinkC5400XRouter class instead of the TplinkRouter class.
 # Remember that the password for this router is different, here you need to use the web encrypted password.
 # To get web encrypted password, read Web Encrypted Password section
-# router = TplinkC5400XRouter('http://192.168.0.1','WebEncryptedPassword', Logger('test'))
+# router = TplinkC5400XRouter('http://192.168.0.1','WebEncryptedPassword', logger: Logger('test'))
 
 try:
     router.authorize()  # authorizing
@@ -380,7 +382,10 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Deco XE75PRO (v3.0)
 - EX511 v2.0
 - HX510 v1.0
+- M8550 v1
+- NE200-Outdoor v1.0
 - NX510v v1.0
+- NX600 v2.0
 - TD-W9960 (v1, V1.20)
 - TL-MR100 v2.0
 - TL-MR105
@@ -389,10 +394,13 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - TL-MR150 v2
 - TL-MR6400 (v5, v5.3)
 - TL-MR6500v
+- TL-R470GP-AC 4.0
+- TL-R488GPM-AC 2.0
 - TL-WA1201 3.0
 - TL-WA3001 v1.0
 - TL-XDR3010 V2
 - TL-WDR3600 V1
+- TL-XDR5410 1.0
 - TL-XDR6088 v1.0.30
 - VX420-G2h v1.1
 - VX800v v1

{tplinkrouterc6u-5.12.4 → tplinkrouterc6u-5.13.0}/README.md

@@ -23,6 +23,7 @@ Python package for API access and management for TP-Link and Mercusys Routers. S
 ```python
 from tplinkrouterc6u import (
     TplinkRouterProvider,
+    TplinkRouterV1_11,
     TplinkRouter,
     TplinkC1200Router,
     TplinkC5400XRouter,
@@ -33,6 +34,7 @@ from tplinkrouterc6u import (
     TPLinkVR400v2Client,
     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
+    TPLinkRClient,
     TPLinkXDRClient,
     TPLinkDecoClient,
     TplinkC80Router,
@@ -50,7 +52,7 @@ router = TplinkRouterProvider.get_client('http://192.168.0.1', 'password')
 # If you have the TP-link C5400X or similar, you can use the TplinkC5400XRouter class instead of the TplinkRouter class.
 # Remember that the password for this router is different, here you need to use the web encrypted password.
 # To get web encrypted password, read Web Encrypted Password section
-# router = TplinkC5400XRouter('http://192.168.0.1','WebEncryptedPassword', Logger('test'))
+# router = TplinkC5400XRouter('http://192.168.0.1','WebEncryptedPassword', logger: Logger('test'))
 
 try:
     router.authorize()  # authorizing
@@ -347,7 +349,10 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Deco XE75PRO (v3.0)
 - EX511 v2.0
 - HX510 v1.0
+- M8550 v1
+- NE200-Outdoor v1.0
 - NX510v v1.0
+- NX600 v2.0
 - TD-W9960 (v1, V1.20)
 - TL-MR100 v2.0
 - TL-MR105
@@ -356,10 +361,13 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - TL-MR150 v2
 - TL-MR6400 (v5, v5.3)
 - TL-MR6500v
+- TL-R470GP-AC 4.0
+- TL-R488GPM-AC 2.0
 - TL-WA1201 3.0
 - TL-WA3001 v1.0
 - TL-XDR3010 V2
 - TL-WDR3600 V1
+- TL-XDR5410 1.0
 - TL-XDR6088 v1.0.30
 - VX420-G2h v1.1
 - VX800v v1

{tplinkrouterc6u-5.12.4 → tplinkrouterc6u-5.13.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="tplinkrouterc6u",
-    version="5.12.4",
+    version="5.13.0",
     author="Alex Erohin",
     author_email="alexanderErohin@yandex.ru",
     description="TP-Link Router API (supports also Mercusys Router)",

{tplinkrouterc6u-5.12.4 → tplinkrouterc6u-5.13.0}/test/test_client_c6u.py

@@ -14,6 +14,12 @@ from tplinkrouterc6u import (
 
 
 class TestTPLinkClient(TestCase):
+    router_class = TplinkRouter
+    game_accelerator_path = 'admin/smart_network?form=game_accelerator'
+    openvpn_config_path = 'admin/openvpn?form=config'
+    pptpd_config_path = 'admin/pptpd?form=config'
+    vpn_uses_data_param = True
+
     def test_get_status(self) -> None:
         response_status = '''
 {
@@ -211,7 +217,9 @@ class TestTPLinkClient(TestCase):
   }
                 '''
 
-        class TPLinkRouterTest(TplinkRouter):
+        router_class = self.router_class
+
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/status?form=all&operation=read':
@@ -339,7 +347,9 @@ class TestTPLinkClient(TestCase):
   }
                 '''
 
-        class TPLinkRouterTest(TplinkRouter):
+        router_class = self.router_class
+
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/status?form=all&operation=read':
@@ -484,12 +494,15 @@ class TestTPLinkClient(TestCase):
   }
 '''
 
-        class TPLinkRouterTest(TplinkRouter):
+        router_class = self.router_class
+        game_accelerator_path = self.game_accelerator_path
+
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/status?form=all&operation=read':
                     return loads(response_status)['data']
-                elif path == 'admin/smart_network?form=game_accelerator':
+                elif path == game_accelerator_path:
                     return loads(response_game_accelerator)['data']
                 elif path == 'admin/wireless?form=statistics':
                     return loads(response_stats)['data']
@@ -618,7 +631,9 @@ class TestTPLinkClient(TestCase):
       }
     '''
 
-        class TPLinkRouterTest(TplinkRouter):
+        router_class = self.router_class
+
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/status?form=all&operation=read':
@@ -661,8 +676,9 @@ class TestTPLinkClient(TestCase):
     def test_set_wifi(self) -> None:
         check_url = ''
         check_data = ''
+        router_class = self.router_class
 
-        class TPLinkRouterTest(TplinkRouter):
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 nonlocal check_url, check_data
@@ -705,8 +721,9 @@ class TestTPLinkClient(TestCase):
 
     def test_get_ipv4_status_empty(self) -> None:
         response_network = '{"result": {}, "error_code": 0}'
+        router_class = self.router_class
 
-        class TPLinkRouterTest(TplinkRouter):
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/network?form=status_ipv4&operation=read':
@@ -750,8 +767,9 @@ class TestTPLinkClient(TestCase):
           "operator": "load"
       }
     '''
+        router_class = self.router_class
 
-        class TPLinkRouterTest(TplinkRouter):
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/status?form=all&operation=read':
@@ -800,8 +818,9 @@ class TestTPLinkClient(TestCase):
         }
     }
     '''
+        router_class = self.router_class
 
-        class TPLinkRouterTest(TplinkRouter):
+        class TPLinkRouterTest(router_class):
             def request(self, path: str, data: str,
                         ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
                 if path == 'admin/status?form=all&operation=read':
@@ -871,7 +890,12 @@ class TestTPLinkClient(TestCase):
              "extra": "7450", "vpntype": "pptp", "key": "7450"}
         ]"""
 
-        class TPLinkRouterTest(TplinkRouter):
+        router_class = self.router_class
+        openvpn_config_path = self.openvpn_config_path
+        pptpd_config_path = self.pptpd_config_path
+        vpn_uses_data_param = self.vpn_uses_data_param
+
+        class TPLinkRouterTest(router_class):
             def request(
                 self,
                 path: str,
@@ -879,14 +903,20 @@ class TestTPLinkClient(TestCase):
                 ignore_response: bool = False,
                 ignore_errors: bool = False,
             ) -> dict | None:
-                if path == "admin/openvpn?form=config":
+                if path == openvpn_config_path:
                     return loads(response_openvpn_read)
-                if path == "admin/pptpd?form=config":
+                if path == pptpd_config_path:
                     return loads(response_pptp_read)
-                if path == "admin/vpnconn?form=config" and data == "operation=list&vpntype=openvpn":
-                    return loads(respone_vpnconn_openvpn)
-                if path == "admin/vpnconn?form=config" and data == "operation=list&vpntype=pptp":
-                    return loads(respone_vpnconn_pptpvpn)
+                if vpn_uses_data_param:
+                    if path == "admin/vpnconn?form=config" and data == "operation=list&vpntype=openvpn":
+                        return loads(respone_vpnconn_openvpn)
+                    if path == "admin/vpnconn?form=config" and data == "operation=list&vpntype=pptp":
+                        return loads(respone_vpnconn_pptpvpn)
+                else:
+                    if path == "admin/vpnconn?form=config&operation=list&vpntype=openvpn":
+                        return loads(respone_vpnconn_openvpn)
+                    if path == "admin/vpnconn?form=config&operation=list&vpntype=pptp":
+                        return loads(respone_vpnconn_pptpvpn)
                 raise ClientException()
 
         client = TPLinkRouterTest("", "")
@@ -910,7 +940,10 @@ class TestTPLinkClient(TestCase):
         }
         """
 
-        class TPLinkRouterTest(TplinkRouter):
+        router_class = self.router_class
+        openvpn_config_path = self.openvpn_config_path
+
+        class TPLinkRouterTest(router_class):
             def request(
                 self,
                 path: str,
@@ -918,7 +951,7 @@ class TestTPLinkClient(TestCase):
                 ignore_response: bool = False,
                 ignore_errors: bool = False,
             ) -> dict | None:
-                if path == "admin/openvpn?form=config" and data == "operation=read":
+                if path == openvpn_config_path and data == "operation=read":
                     return loads(response_openvpn_read)
                 self.captured_path = path
                 self.captured_data = data
@@ -930,7 +963,7 @@ class TestTPLinkClient(TestCase):
             "operation=write&enabled=on"
             "&proto=udp&access=home&cert_exist=True&mask=255.255.255.0&port=1194&serverip=10.8.0.0"
         )
-        self.assertEqual(client.captured_path, 'admin/openvpn?form=config')
+        self.assertEqual(client.captured_path, self.openvpn_config_path)
         self.assertEqual(client.captured_data, expected_data)
 
 

tplinkrouterc6u-5.13.0/test/test_client_c6u_v1_11.py

@@ -0,0 +1,95 @@
+from unittest import main
+from unittest.mock import patch, Mock
+from test_client_c6u import TestTPLinkClient
+from tplinkrouterc6u import TplinkRouterV1_11, ClientException
+
+
+class TestTPLinkClientV1_11(TestTPLinkClient):
+    """Inherits all tests from TestTPLinkClient, using TplinkRouterV1_11."""
+
+    router_class = TplinkRouterV1_11
+    game_accelerator_path = 'admin/smart_network?form=game_accelerator&operation=loadDevice'
+    openvpn_config_path = 'admin/openvpn?form=config&operation=read'
+    pptpd_config_path = 'admin/pptpd?form=config&operation=read'
+    vpn_uses_data_param = False
+
+    # V1_11-specific tests only
+
+    def test_supports_password_too_long(self) -> None:
+        long_password = 'a' * 126
+        client = TplinkRouterV1_11('http://192.168.0.1', long_password)
+        self.assertFalse(client.supports())
+
+    @patch('tplinkrouterc6u.client.c6u.EncryptionWrapper.rsa_encrypt')
+    @patch('tplinkrouterc6u.client.c6u.post')
+    def test_authorize_success(self, mock_post: Mock, mock_rsa: Mock) -> None:
+        mock_rsa.return_value = 'encrypted_password_hex'
+
+        keys_response = Mock()
+        keys_response.json.return_value = {
+            'success': True,
+            'data': {
+                'password': ['mock_nn_value', '010001']
+            }
+        }
+
+        login_response = Mock()
+        login_response.json.return_value = {
+            'success': True,
+            'data': {
+                'stok': 'test_stok_12345'
+            }
+        }
+        login_response.headers = {'set-cookie': 'sysauth=test_sysauth_cookie; path=/'}
+
+        mock_post.side_effect = [keys_response, login_response]
+
+        client = TplinkRouterV1_11('http://192.168.0.1', 'testpassword')
+        client.authorize()
+
+        self.assertTrue(client._logged)
+        self.assertEqual(client._stok, 'test_stok_12345')
+        self.assertEqual(client._sysauth, 'test_sysauth_cookie')
+        self.assertEqual(mock_post.call_count, 2)
+
+        first_call = mock_post.call_args_list[0]
+        self.assertIn('login?form=keys', first_call[0][0])
+
+        second_call = mock_post.call_args_list[1]
+        self.assertIn('login?form=login', second_call[0][0])
+        login_data = second_call[1]['data']
+        self.assertTrue(login_data.startswith('operation=login&password='))
+
+    @patch('tplinkrouterc6u.client.c6u.EncryptionWrapper.rsa_encrypt')
+    @patch('tplinkrouterc6u.client.c6u.post')
+    def test_authorize_failure(self, mock_post: Mock, mock_rsa: Mock) -> None:
+        mock_rsa.return_value = 'encrypted_password_hex'
+
+        keys_response = Mock()
+        keys_response.json.return_value = {
+            'success': True,
+            'data': {
+                'password': ['mock_nn_value', '010001']
+            }
+        }
+
+        login_response = Mock()
+        login_response.json.return_value = {
+            'success': False,
+            'data': {'errorcode': 'invalid password'}
+        }
+        login_response.headers = {}
+
+        mock_post.side_effect = [keys_response, login_response]
+
+        client = TplinkRouterV1_11('http://192.168.0.1', 'wrongpassword')
+
+        with self.assertRaises(ClientException) as context:
+            client.authorize()
+
+        self.assertIn('Login failed', str(context.exception))
+        self.assertFalse(client._logged)
+
+
+if __name__ == '__main__':
+    main()

{tplinkrouterc6u-5.12.4 → tplinkrouterc6u-5.13.0}/test/test_client_ex.py

@@ -204,6 +204,86 @@ class TestTPLinkEXClient(TestCase):
         self.assertEqual(status.devices[1].packets_sent, None)  # TODO
         self.assertEqual(status.devices[1].packets_received, None)  # TODO
 
+    def test_get_status_NE200(self) -> None:
+        DEV2_ADT_LAN = ('{"data":[{"MACAddress":"a0:28:84:de:dd:5c","IPAddress":"192.168.4.1","stack":"1,0,0,0,0,0"}],'
+                        '"operation":"gl","oid":"DEV2_ADT_LAN","success":true}')
+        DEV2_ADT_WAN = ('{"data":[{"enable":"1","MACAddr":"","connIPv4Address":"","connIPv4Gateway":""'
+                        ',"stack":"1,0,0,0,0,0"}],"operation":"gl","oid":"DEV2_ADT_WAN","success":true}')
+        DEV2_ADT_WIFI_COMMON = ('{"data":[],"operation":"gl",'
+                                '"oid":"DEV2_ADT_WIFI_COMMON","success":true}')
+        DEV2_HOST_ENTRY = ('{"data":[{"active":"1","X_TP_LanConnType":"1","physAddress":"66-E2-02-BD-B5-1B",'
+                           '"IPAddress":"192.168.30.10","hostName":"host1","stack":"1,0,0,0,0,0"},'
+                           '{"active":"1","X_TP_LanConnType":"1","physAddress":"F4-A3-86-2D-41-B5",'
+                           '"IPAddress":"192.168.30.11","hostName":"host2","stack":"2,0,0,0,0,0"}],"operation":"gl",'
+                           '"oid":"DEV2_HOST_ENTRY","success":true}')
+        DEV2_MEM_STATUS = ('{"data":{"total":"192780","free":"78400","stack":"0,0,0,0,0,0"},"operation":"go",'
+                           '"oid":"DEV2_MEM_STATUS","success":true}')
+        DEV2_PROC_STATUS = ('{"data":{"CPUUsage":"69","stack":"0,0,0,0,0,0"},"operation":"go",'
+                            '"oid":"DEV2_PROC_STATUS","success":true}')
+
+        class TPLinkEXClientTest(TPLinkEXClient):
+            self._token = True
+
+            def _request(self, url, method='POST', data_str=None, encrypt=False):
+                if 'DEV2_ADT_LAN' in data_str:
+                    return 200, DEV2_ADT_LAN
+                elif 'DEV2_ADT_WAN' in data_str:
+                    return 200, DEV2_ADT_WAN
+                elif 'DEV2_ADT_WIFI_COMMON' in data_str:
+                    return 200, DEV2_ADT_WIFI_COMMON
+                elif 'DEV2_HOST_ENTRY' in data_str:
+                    return 200, DEV2_HOST_ENTRY
+                elif 'DEV2_MEM_STATUS' in data_str:
+                    return 200, DEV2_MEM_STATUS
+                elif 'DEV2_PROC_STATUS' in data_str:
+                    return 200, DEV2_PROC_STATUS
+                raise ClientException()
+
+        client = TPLinkEXClientTest('', '')
+        status = client.get_status()
+
+        self.assertIsInstance(status, Status)
+        self.assertEqual(status.wan_macaddr, None)
+        self.assertEqual(status.lan_macaddr, 'A0-28-84-DE-DD-5C')
+        self.assertIsInstance(status.lan_macaddress, EUI48)
+        self.assertEqual(status.wan_ipv4_addr, None)
+        self.assertEqual(status.lan_ipv4_addr, '192.168.4.1')
+        self.assertEqual(status.wan_ipv4_gateway, None)
+        self.assertEqual(status.wired_total, 0)
+        self.assertEqual(status.wifi_clients_total, 2)
+        self.assertEqual(status.guest_clients_total, 0)
+        self.assertEqual(status.clients_total, 2)
+        self.assertEqual(status.guest_2g_enable, None)
+        self.assertEqual(status.guest_5g_enable, None)
+        self.assertEqual(status.iot_2g_enable, None)
+        self.assertEqual(status.iot_5g_enable, None)
+        self.assertEqual(status.wifi_2g_enable, None)
+        self.assertEqual(status.wifi_5g_enable, None)
+        self.assertEqual(status.wan_ipv4_uptime, None)
+        self.assertGreaterEqual(status.mem_usage, 0)
+        self.assertLessEqual(status.mem_usage, 1)
+        self.assertGreaterEqual(status.cpu_usage, 0)
+        self.assertLessEqual(status.cpu_usage, 1)
+        self.assertEqual(len(status.devices), 2)
+        self.assertIsInstance(status.devices[0], Device)
+        self.assertEqual(status.devices[0].type, Connection.HOST_2G)
+        self.assertEqual(status.devices[0].macaddr, '66-E2-02-BD-B5-1B')
+        self.assertIsInstance(status.devices[0].macaddress, EUI48)
+        self.assertEqual(status.devices[0].ipaddr, '192.168.30.10')
+        self.assertIsInstance(status.devices[0].ipaddress, IPv4Address)
+        self.assertEqual(status.devices[0].hostname, 'host1')
+        self.assertEqual(status.devices[0].packets_sent, None)
+        self.assertEqual(status.devices[0].packets_received, None)
+        self.assertIsInstance(status.devices[1], Device)
+        self.assertEqual(status.devices[1].type, Connection.HOST_2G)
+        self.assertEqual(status.devices[1].macaddr, 'F4-A3-86-2D-41-B5')
+        self.assertIsInstance(status.devices[1].macaddress, EUI48)
+        self.assertEqual(status.devices[1].ipaddr, '192.168.30.11')
+        self.assertIsInstance(status.devices[1].ipaddress, IPv4Address)
+        self.assertEqual(status.devices[1].hostname, 'host2')
+        self.assertEqual(status.devices[1].packets_sent, None)  # TODO
+        self.assertEqual(status.devices[1].packets_received, None)  # TODO
+
     def test_get_ipv4_reservations(self) -> None:
 
         response = ('{"data":[{"enable":"1","chaddr":"bf:75:44:4c:dc:9e","yiaddr":"192.168.8.21",'