tplinkrouterc6u 5.4.2__py3-none-any.whl → 5.6.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- test/test_client_c6u.py +2 -0
- test/test_client_c80.py +455 -0
- test/test_client_mr.py +1 -0
- tplinkrouterc6u/__init__.py +2 -1
- tplinkrouterc6u/client/c6u.py +1 -0
- tplinkrouterc6u/client/c80.py +406 -0
- tplinkrouterc6u/client/ex.py +2 -2
- tplinkrouterc6u/client/mr.py +209 -208
- tplinkrouterc6u/client/vr.py +129 -0
- tplinkrouterc6u/common/dataclass.py +1 -0
- tplinkrouterc6u/provider.py +21 -15
- {tplinkrouterc6u-5.4.2.dist-info → tplinkrouterc6u-5.6.0.dist-info}/METADATA +8 -1
- {tplinkrouterc6u-5.4.2.dist-info → tplinkrouterc6u-5.6.0.dist-info}/RECORD +16 -13
- {tplinkrouterc6u-5.4.2.dist-info → tplinkrouterc6u-5.6.0.dist-info}/WHEEL +1 -1
- {tplinkrouterc6u-5.4.2.dist-info → tplinkrouterc6u-5.6.0.dist-info}/LICENSE +0 -0
- {tplinkrouterc6u-5.4.2.dist-info → tplinkrouterc6u-5.6.0.dist-info}/top_level.txt +0 -0
tplinkrouterc6u/client/mr.py
CHANGED
|
@@ -114,6 +114,213 @@ class TPLinkMRClientBase(AbstractRouter):
|
|
|
114
114
|
]
|
|
115
115
|
self.req_act(acts)
|
|
116
116
|
|
|
117
|
+
def get_firmware(self) -> Firmware:
|
|
118
|
+
acts = [
|
|
119
|
+
self.ActItem(self.ActItem.GET, 'IGD_DEV_INFO', attrs=[
|
|
120
|
+
'hardwareVersion',
|
|
121
|
+
'modelName',
|
|
122
|
+
'softwareVersion'
|
|
123
|
+
])
|
|
124
|
+
]
|
|
125
|
+
_, values = self.req_act(acts)
|
|
126
|
+
|
|
127
|
+
firmware = Firmware(values.get('hardwareVersion', ''), values.get('modelName', ''),
|
|
128
|
+
values.get('softwareVersion', ''))
|
|
129
|
+
|
|
130
|
+
return firmware
|
|
131
|
+
|
|
132
|
+
def get_status(self) -> Status:
|
|
133
|
+
status = Status()
|
|
134
|
+
acts = [
|
|
135
|
+
self.ActItem(self.ActItem.GS, 'LAN_IP_INTF', attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress']),
|
|
136
|
+
self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
|
|
137
|
+
attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway', 'name']),
|
|
138
|
+
self.ActItem(self.ActItem.GL, 'LAN_WLAN', attrs=['enable', 'X_TP_Band']),
|
|
139
|
+
self.ActItem(self.ActItem.GL, 'LAN_WLAN_GUESTNET', attrs=['enable', 'name']),
|
|
140
|
+
self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=[
|
|
141
|
+
'IPAddress',
|
|
142
|
+
'MACAddress',
|
|
143
|
+
'hostName',
|
|
144
|
+
'X_TP_ConnType',
|
|
145
|
+
'active',
|
|
146
|
+
]),
|
|
147
|
+
self.ActItem(self.ActItem.GS, 'LAN_WLAN_ASSOC_DEV', attrs=[
|
|
148
|
+
'associatedDeviceMACAddress',
|
|
149
|
+
'X_TP_TotalPacketsSent',
|
|
150
|
+
'X_TP_TotalPacketsReceived',
|
|
151
|
+
]),
|
|
152
|
+
]
|
|
153
|
+
_, values = self.req_act(acts)
|
|
154
|
+
|
|
155
|
+
if values['0'].__class__ == list:
|
|
156
|
+
values['0'] = values['0'][0]
|
|
157
|
+
|
|
158
|
+
status._lan_macaddr = EUI48(values['0']['X_TP_MACAddress'])
|
|
159
|
+
status._lan_ipv4_addr = IPv4Address(values['0']['IPInterfaceIPAddress'])
|
|
160
|
+
|
|
161
|
+
for item in self._to_list(values.get('1')):
|
|
162
|
+
if int(item['enable']) == 0 and values.get('1').__class__ == list:
|
|
163
|
+
continue
|
|
164
|
+
status._wan_macaddr = EUI48(item['MACAddress']) if item.get('MACAddress') else None
|
|
165
|
+
status._wan_ipv4_addr = IPv4Address(item['externalIPAddress'])
|
|
166
|
+
status._wan_ipv4_gateway = IPv4Address(item['defaultGateway'])
|
|
167
|
+
status.conn_type = item.get('name', '')
|
|
168
|
+
|
|
169
|
+
if values['2'].__class__ != list:
|
|
170
|
+
status.wifi_2g_enable = bool(int(values['2']['enable']))
|
|
171
|
+
else:
|
|
172
|
+
status.wifi_2g_enable = bool(int(values['2'][0]['enable']))
|
|
173
|
+
status.wifi_5g_enable = bool(int(values['2'][1]['enable']))
|
|
174
|
+
|
|
175
|
+
if values['3'].__class__ != list:
|
|
176
|
+
status.guest_2g_enable = bool(int(values['3']['enable']))
|
|
177
|
+
else:
|
|
178
|
+
status.guest_2g_enable = bool(int(values['3'][0]['enable']))
|
|
179
|
+
status.guest_5g_enable = bool(int(values['3'][1]['enable']))
|
|
180
|
+
|
|
181
|
+
devices = {}
|
|
182
|
+
for val in self._to_list(values.get('4')):
|
|
183
|
+
if int(val['active']) == 0:
|
|
184
|
+
continue
|
|
185
|
+
conn = self.CLIENT_TYPES.get(int(val['X_TP_ConnType']))
|
|
186
|
+
if conn is None:
|
|
187
|
+
continue
|
|
188
|
+
elif conn == Connection.WIRED:
|
|
189
|
+
status.wired_total += 1
|
|
190
|
+
elif conn.is_guest_wifi():
|
|
191
|
+
status.guest_clients_total += 1
|
|
192
|
+
elif conn.is_host_wifi():
|
|
193
|
+
status.wifi_clients_total += 1
|
|
194
|
+
devices[val['MACAddress']] = Device(conn,
|
|
195
|
+
EUI48(val['MACAddress']),
|
|
196
|
+
IPv4Address(val['IPAddress']),
|
|
197
|
+
val['hostName'])
|
|
198
|
+
|
|
199
|
+
for val in self._to_list(values.get('5')):
|
|
200
|
+
if val['associatedDeviceMACAddress'] not in devices:
|
|
201
|
+
status.wifi_clients_total += 1
|
|
202
|
+
devices[val['associatedDeviceMACAddress']] = Device(
|
|
203
|
+
Connection.HOST_2G,
|
|
204
|
+
EUI48(val['associatedDeviceMACAddress']),
|
|
205
|
+
IPv4Address('0.0.0.0'),
|
|
206
|
+
'')
|
|
207
|
+
devices[val['associatedDeviceMACAddress']].packets_sent = int(val['X_TP_TotalPacketsSent'])
|
|
208
|
+
devices[val['associatedDeviceMACAddress']].packets_received = int(val['X_TP_TotalPacketsReceived'])
|
|
209
|
+
|
|
210
|
+
status.devices = list(devices.values())
|
|
211
|
+
status.clients_total = status.wired_total + status.wifi_clients_total + status.guest_clients_total
|
|
212
|
+
|
|
213
|
+
return status
|
|
214
|
+
|
|
215
|
+
def get_ipv4_reservations(self) -> [IPv4Reservation]:
|
|
216
|
+
acts = [
|
|
217
|
+
self.ActItem(self.ActItem.GL, 'LAN_DHCP_STATIC_ADDR', attrs=['enable', 'chaddr', 'yiaddr']),
|
|
218
|
+
]
|
|
219
|
+
_, values = self.req_act(acts)
|
|
220
|
+
|
|
221
|
+
ipv4_reservations = []
|
|
222
|
+
for item in self._to_list(values):
|
|
223
|
+
ipv4_reservations.append(
|
|
224
|
+
IPv4Reservation(
|
|
225
|
+
EUI48(item['chaddr']),
|
|
226
|
+
IPv4Address(item['yiaddr']),
|
|
227
|
+
'',
|
|
228
|
+
bool(int(item['enable']))
|
|
229
|
+
))
|
|
230
|
+
|
|
231
|
+
return ipv4_reservations
|
|
232
|
+
|
|
233
|
+
def get_ipv4_dhcp_leases(self) -> [IPv4DHCPLease]:
|
|
234
|
+
acts = [
|
|
235
|
+
self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=['IPAddress', 'MACAddress', 'hostName',
|
|
236
|
+
'leaseTimeRemaining']),
|
|
237
|
+
]
|
|
238
|
+
_, values = self.req_act(acts)
|
|
239
|
+
|
|
240
|
+
dhcp_leases = []
|
|
241
|
+
for item in self._to_list(values):
|
|
242
|
+
lease_time = item['leaseTimeRemaining']
|
|
243
|
+
dhcp_leases.append(
|
|
244
|
+
IPv4DHCPLease(
|
|
245
|
+
EUI48(item['MACAddress']),
|
|
246
|
+
IPv4Address(item['IPAddress']),
|
|
247
|
+
item['hostName'],
|
|
248
|
+
str(timedelta(seconds=int(lease_time))) if lease_time.isdigit() else 'Permanent',
|
|
249
|
+
))
|
|
250
|
+
|
|
251
|
+
return dhcp_leases
|
|
252
|
+
|
|
253
|
+
def get_ipv4_status(self) -> IPv4Status:
|
|
254
|
+
acts = [
|
|
255
|
+
self.ActItem(self.ActItem.GS, 'LAN_IP_INTF',
|
|
256
|
+
attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress', 'IPInterfaceSubnetMask']),
|
|
257
|
+
self.ActItem(self.ActItem.GET, 'LAN_HOST_CFG', '1,0,0,0,0,0', attrs=['DHCPServerEnable']),
|
|
258
|
+
self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
|
|
259
|
+
attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway', 'name', 'subnetMask',
|
|
260
|
+
'DNSServers']),
|
|
261
|
+
]
|
|
262
|
+
_, values = self.req_act(acts)
|
|
263
|
+
|
|
264
|
+
ipv4_status = IPv4Status()
|
|
265
|
+
ipv4_status._lan_macaddr = get_mac(get_value(values, ['0', 'X_TP_MACAddress'], '00:00:00:00:00:00'))
|
|
266
|
+
ipv4_status._lan_ipv4_ipaddr = get_ip(get_value(values, ['0', 'IPInterfaceIPAddress'], '0.0.0.0'))
|
|
267
|
+
ipv4_status._lan_ipv4_netmask = get_ip(get_value(values, ['0', 'IPInterfaceSubnetMask'], '0.0.0.0'))
|
|
268
|
+
ipv4_status.lan_ipv4_dhcp_enable = bool(int(get_value(values, ['1', 'DHCPServerEnable'], '0')))
|
|
269
|
+
|
|
270
|
+
for item in self._to_list(values.get('2')):
|
|
271
|
+
if int(item.get('enable', '0')) == 0 and values.get('2').__class__ == list:
|
|
272
|
+
continue
|
|
273
|
+
ipv4_status._wan_macaddr = get_mac(item.get('MACAddress', '00:00:00:00:00:00'))
|
|
274
|
+
ipv4_status._wan_ipv4_ipaddr = get_ip(item.get('externalIPAddress', '0.0.0.0'))
|
|
275
|
+
ipv4_status._wan_ipv4_gateway = get_ip(item.get('defaultGateway', '0.0.0.0'))
|
|
276
|
+
ipv4_status._wan_ipv4_conntype = item.get('name', '')
|
|
277
|
+
ipv4_status._wan_ipv4_netmask = get_ip(item.get('subnetMask', '0.0.0.0'))
|
|
278
|
+
dns = item.get('DNSServers', '').split(',')
|
|
279
|
+
ipv4_status._wan_ipv4_pridns = get_ip(dns[0] if len(dns) > 0 else '0.0.0.0')
|
|
280
|
+
ipv4_status._wan_ipv4_snddns = get_ip(dns[1] if len(dns) > 1 else '0.0.0.0')
|
|
281
|
+
|
|
282
|
+
return ipv4_status
|
|
283
|
+
|
|
284
|
+
def set_wifi(self, wifi: Connection, enable: bool) -> None:
|
|
285
|
+
acts = [
|
|
286
|
+
self.ActItem(
|
|
287
|
+
self.ActItem.SET,
|
|
288
|
+
'LAN_WLAN' if wifi in [Connection.HOST_2G, Connection.HOST_5G] else 'LAN_WLAN_MSSIDENTRY',
|
|
289
|
+
self.WIFI_SET[wifi],
|
|
290
|
+
attrs=['enable={}'.format(int(enable))]),
|
|
291
|
+
]
|
|
292
|
+
self.req_act(acts)
|
|
293
|
+
|
|
294
|
+
def get_vpn_status(self) -> VPNStatus:
|
|
295
|
+
status = VPNStatus()
|
|
296
|
+
acts = [
|
|
297
|
+
self.ActItem(self.ActItem.GET, 'OPENVPN', attrs=['enable']),
|
|
298
|
+
self.ActItem(self.ActItem.GET, 'PPTPVPN', attrs=['enable']),
|
|
299
|
+
self.ActItem(self.ActItem.GL, 'OVPN_CLIENT', attrs=['connAct']),
|
|
300
|
+
self.ActItem(self.ActItem.GL, 'PVPN_CLIENT', attrs=['connAct']),
|
|
301
|
+
]
|
|
302
|
+
_, values = self.req_act(acts)
|
|
303
|
+
|
|
304
|
+
status.openvpn_enable = values['0']['enable'] == '1'
|
|
305
|
+
status.pptpvpn_enable = values['1']['enable'] == '1'
|
|
306
|
+
|
|
307
|
+
for item in values['2']:
|
|
308
|
+
if item['connAct'] == '1':
|
|
309
|
+
status.openvpn_clients_total += 1
|
|
310
|
+
|
|
311
|
+
for item in values['3']:
|
|
312
|
+
if item['connAct'] == '1':
|
|
313
|
+
status.pptpvpn_clients_total += 1
|
|
314
|
+
|
|
315
|
+
return status
|
|
316
|
+
|
|
317
|
+
def set_vpn(self, vpn: VPN, enable: bool) -> None:
|
|
318
|
+
acts = [
|
|
319
|
+
self.ActItem(self.ActItem.SET, vpn.value, attrs=['enable={}'.format(int(enable))])
|
|
320
|
+
]
|
|
321
|
+
|
|
322
|
+
self.req_act(acts)
|
|
323
|
+
|
|
117
324
|
def req_act(self, acts: list):
|
|
118
325
|
'''
|
|
119
326
|
Requests ACTs via the cgi_gdpr proxy
|
|
@@ -303,7 +510,7 @@ class TPLinkMRClientBase(AbstractRouter):
|
|
|
303
510
|
self._logger.debug(error)
|
|
304
511
|
raise ClientException(error)
|
|
305
512
|
|
|
306
|
-
def _request(self, url, method='POST', data_str=None, encrypt=False):
|
|
513
|
+
def _request(self, url, method='POST', data_str=None, encrypt=False, is_login=False):
|
|
307
514
|
'''
|
|
308
515
|
Prepares and sends an HTTP request to the host
|
|
309
516
|
- sets up the headers, handles token auth
|
|
@@ -325,7 +532,7 @@ class TPLinkMRClientBase(AbstractRouter):
|
|
|
325
532
|
|
|
326
533
|
# encrypt request data if needed (for the /cgi_gdpr endpoint)
|
|
327
534
|
if encrypt:
|
|
328
|
-
sign, data = self._prepare_data(data_str,
|
|
535
|
+
sign, data = self._prepare_data(data_str, is_login)
|
|
329
536
|
data = 'sign={}\r\ndata={}\r\n'.format(sign, data)
|
|
330
537
|
else:
|
|
331
538
|
data = data_str
|
|
@@ -396,182 +603,6 @@ class TPLinkMRClient(TPLinkMRClientBase):
|
|
|
396
603
|
if ret_code == self.HTTP_RET_OK:
|
|
397
604
|
self._token = None
|
|
398
605
|
|
|
399
|
-
def get_firmware(self) -> Firmware:
|
|
400
|
-
acts = [
|
|
401
|
-
self.ActItem(self.ActItem.GET, 'IGD_DEV_INFO', attrs=[
|
|
402
|
-
'hardwareVersion',
|
|
403
|
-
'modelName',
|
|
404
|
-
'softwareVersion'
|
|
405
|
-
])
|
|
406
|
-
]
|
|
407
|
-
_, values = self.req_act(acts)
|
|
408
|
-
|
|
409
|
-
firmware = Firmware(values.get('hardwareVersion', ''), values.get('modelName', ''),
|
|
410
|
-
values.get('softwareVersion', ''))
|
|
411
|
-
|
|
412
|
-
return firmware
|
|
413
|
-
|
|
414
|
-
def get_status(self) -> Status:
|
|
415
|
-
status = Status()
|
|
416
|
-
acts = [
|
|
417
|
-
self.ActItem(self.ActItem.GS, 'LAN_IP_INTF', attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress']),
|
|
418
|
-
self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
|
|
419
|
-
attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway']),
|
|
420
|
-
self.ActItem(self.ActItem.GL, 'LAN_WLAN', attrs=['enable', 'X_TP_Band']),
|
|
421
|
-
self.ActItem(self.ActItem.GL, 'LAN_WLAN_GUESTNET', attrs=['enable', 'name']),
|
|
422
|
-
self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=[
|
|
423
|
-
'IPAddress',
|
|
424
|
-
'MACAddress',
|
|
425
|
-
'hostName',
|
|
426
|
-
'X_TP_ConnType',
|
|
427
|
-
'active',
|
|
428
|
-
]),
|
|
429
|
-
self.ActItem(self.ActItem.GS, 'LAN_WLAN_ASSOC_DEV', attrs=[
|
|
430
|
-
'associatedDeviceMACAddress',
|
|
431
|
-
'X_TP_TotalPacketsSent',
|
|
432
|
-
'X_TP_TotalPacketsReceived',
|
|
433
|
-
]),
|
|
434
|
-
]
|
|
435
|
-
_, values = self.req_act(acts)
|
|
436
|
-
|
|
437
|
-
if values['0'].__class__ == list:
|
|
438
|
-
values['0'] = values['0'][0]
|
|
439
|
-
|
|
440
|
-
status._lan_macaddr = EUI48(values['0']['X_TP_MACAddress'])
|
|
441
|
-
status._lan_ipv4_addr = IPv4Address(values['0']['IPInterfaceIPAddress'])
|
|
442
|
-
|
|
443
|
-
for item in self._to_list(values.get('1')):
|
|
444
|
-
if int(item['enable']) == 0 and values.get('1').__class__ == list:
|
|
445
|
-
continue
|
|
446
|
-
status._wan_macaddr = EUI48(item['MACAddress']) if item.get('MACAddress') else None
|
|
447
|
-
status._wan_ipv4_addr = IPv4Address(item['externalIPAddress'])
|
|
448
|
-
status._wan_ipv4_gateway = IPv4Address(item['defaultGateway'])
|
|
449
|
-
|
|
450
|
-
if values['2'].__class__ != list:
|
|
451
|
-
status.wifi_2g_enable = bool(int(values['2']['enable']))
|
|
452
|
-
else:
|
|
453
|
-
status.wifi_2g_enable = bool(int(values['2'][0]['enable']))
|
|
454
|
-
status.wifi_5g_enable = bool(int(values['2'][1]['enable']))
|
|
455
|
-
|
|
456
|
-
if values['3'].__class__ != list:
|
|
457
|
-
status.guest_2g_enable = bool(int(values['3']['enable']))
|
|
458
|
-
else:
|
|
459
|
-
status.guest_2g_enable = bool(int(values['3'][0]['enable']))
|
|
460
|
-
status.guest_5g_enable = bool(int(values['3'][1]['enable']))
|
|
461
|
-
|
|
462
|
-
devices = {}
|
|
463
|
-
for val in self._to_list(values.get('4')):
|
|
464
|
-
if int(val['active']) == 0:
|
|
465
|
-
continue
|
|
466
|
-
conn = self.CLIENT_TYPES.get(int(val['X_TP_ConnType']))
|
|
467
|
-
if conn is None:
|
|
468
|
-
continue
|
|
469
|
-
elif conn == Connection.WIRED:
|
|
470
|
-
status.wired_total += 1
|
|
471
|
-
elif conn.is_guest_wifi():
|
|
472
|
-
status.guest_clients_total += 1
|
|
473
|
-
elif conn.is_host_wifi():
|
|
474
|
-
status.wifi_clients_total += 1
|
|
475
|
-
devices[val['MACAddress']] = Device(conn,
|
|
476
|
-
EUI48(val['MACAddress']),
|
|
477
|
-
IPv4Address(val['IPAddress']),
|
|
478
|
-
val['hostName'])
|
|
479
|
-
|
|
480
|
-
for val in self._to_list(values.get('5')):
|
|
481
|
-
if val['associatedDeviceMACAddress'] not in devices:
|
|
482
|
-
status.wifi_clients_total += 1
|
|
483
|
-
devices[val['associatedDeviceMACAddress']] = Device(
|
|
484
|
-
Connection.HOST_2G,
|
|
485
|
-
EUI48(val['associatedDeviceMACAddress']),
|
|
486
|
-
IPv4Address('0.0.0.0'),
|
|
487
|
-
'')
|
|
488
|
-
devices[val['associatedDeviceMACAddress']].packets_sent = int(val['X_TP_TotalPacketsSent'])
|
|
489
|
-
devices[val['associatedDeviceMACAddress']].packets_received = int(val['X_TP_TotalPacketsReceived'])
|
|
490
|
-
|
|
491
|
-
status.devices = list(devices.values())
|
|
492
|
-
status.clients_total = status.wired_total + status.wifi_clients_total + status.guest_clients_total
|
|
493
|
-
|
|
494
|
-
return status
|
|
495
|
-
|
|
496
|
-
def get_ipv4_reservations(self) -> [IPv4Reservation]:
|
|
497
|
-
acts = [
|
|
498
|
-
self.ActItem(self.ActItem.GL, 'LAN_DHCP_STATIC_ADDR', attrs=['enable', 'chaddr', 'yiaddr']),
|
|
499
|
-
]
|
|
500
|
-
_, values = self.req_act(acts)
|
|
501
|
-
|
|
502
|
-
ipv4_reservations = []
|
|
503
|
-
for item in self._to_list(values):
|
|
504
|
-
ipv4_reservations.append(
|
|
505
|
-
IPv4Reservation(
|
|
506
|
-
EUI48(item['chaddr']),
|
|
507
|
-
IPv4Address(item['yiaddr']),
|
|
508
|
-
'',
|
|
509
|
-
bool(int(item['enable']))
|
|
510
|
-
))
|
|
511
|
-
|
|
512
|
-
return ipv4_reservations
|
|
513
|
-
|
|
514
|
-
def get_ipv4_dhcp_leases(self) -> [IPv4DHCPLease]:
|
|
515
|
-
acts = [
|
|
516
|
-
self.ActItem(self.ActItem.GL, 'LAN_HOST_ENTRY', attrs=['IPAddress', 'MACAddress', 'hostName',
|
|
517
|
-
'leaseTimeRemaining']),
|
|
518
|
-
]
|
|
519
|
-
_, values = self.req_act(acts)
|
|
520
|
-
|
|
521
|
-
dhcp_leases = []
|
|
522
|
-
for item in self._to_list(values):
|
|
523
|
-
lease_time = item['leaseTimeRemaining']
|
|
524
|
-
dhcp_leases.append(
|
|
525
|
-
IPv4DHCPLease(
|
|
526
|
-
EUI48(item['MACAddress']),
|
|
527
|
-
IPv4Address(item['IPAddress']),
|
|
528
|
-
item['hostName'],
|
|
529
|
-
str(timedelta(seconds=int(lease_time))) if lease_time.isdigit() else 'Permanent',
|
|
530
|
-
))
|
|
531
|
-
|
|
532
|
-
return dhcp_leases
|
|
533
|
-
|
|
534
|
-
def get_ipv4_status(self) -> IPv4Status:
|
|
535
|
-
acts = [
|
|
536
|
-
self.ActItem(self.ActItem.GS, 'LAN_IP_INTF',
|
|
537
|
-
attrs=['X_TP_MACAddress', 'IPInterfaceIPAddress', 'IPInterfaceSubnetMask']),
|
|
538
|
-
self.ActItem(self.ActItem.GET, 'LAN_HOST_CFG', '1,0,0,0,0,0', attrs=['DHCPServerEnable']),
|
|
539
|
-
self.ActItem(self.ActItem.GS, 'WAN_IP_CONN',
|
|
540
|
-
attrs=['enable', 'MACAddress', 'externalIPAddress', 'defaultGateway', 'name', 'subnetMask',
|
|
541
|
-
'DNSServers']),
|
|
542
|
-
]
|
|
543
|
-
_, values = self.req_act(acts)
|
|
544
|
-
|
|
545
|
-
ipv4_status = IPv4Status()
|
|
546
|
-
ipv4_status._lan_macaddr = get_mac(get_value(values, ['0', 'X_TP_MACAddress'], '00:00:00:00:00:00'))
|
|
547
|
-
ipv4_status._lan_ipv4_ipaddr = get_ip(get_value(values, ['0', 'IPInterfaceIPAddress'], '0.0.0.0'))
|
|
548
|
-
ipv4_status._lan_ipv4_netmask = get_ip(get_value(values, ['0', 'IPInterfaceSubnetMask'], '0.0.0.0'))
|
|
549
|
-
ipv4_status.lan_ipv4_dhcp_enable = bool(int(get_value(values, ['1', 'DHCPServerEnable'], '0')))
|
|
550
|
-
|
|
551
|
-
for item in self._to_list(values.get('2')):
|
|
552
|
-
if int(item.get('enable', '0')) == 0 and values.get('2').__class__ == list:
|
|
553
|
-
continue
|
|
554
|
-
ipv4_status._wan_macaddr = get_mac(item.get('MACAddress', '00:00:00:00:00:00'))
|
|
555
|
-
ipv4_status._wan_ipv4_ipaddr = get_ip(item.get('externalIPAddress', '0.0.0.0'))
|
|
556
|
-
ipv4_status._wan_ipv4_gateway = get_ip(item.get('defaultGateway', '0.0.0.0'))
|
|
557
|
-
ipv4_status._wan_ipv4_conntype = item.get('name', '')
|
|
558
|
-
ipv4_status._wan_ipv4_netmask = get_ip(item.get('subnetMask', '0.0.0.0'))
|
|
559
|
-
dns = item.get('DNSServers', '').split(',')
|
|
560
|
-
ipv4_status._wan_ipv4_pridns = get_ip(dns[0] if len(dns) > 0 else '0.0.0.0')
|
|
561
|
-
ipv4_status._wan_ipv4_snddns = get_ip(dns[1] if len(dns) > 1 else '0.0.0.0')
|
|
562
|
-
|
|
563
|
-
return ipv4_status
|
|
564
|
-
|
|
565
|
-
def set_wifi(self, wifi: Connection, enable: bool) -> None:
|
|
566
|
-
acts = [
|
|
567
|
-
self.ActItem(
|
|
568
|
-
self.ActItem.SET,
|
|
569
|
-
'LAN_WLAN' if wifi in [Connection.HOST_2G, Connection.HOST_5G] else 'LAN_WLAN_MSSIDENTRY',
|
|
570
|
-
self.WIFI_SET[wifi],
|
|
571
|
-
attrs=['enable={}'.format(int(enable))]),
|
|
572
|
-
]
|
|
573
|
-
self.req_act(acts)
|
|
574
|
-
|
|
575
606
|
def send_sms(self, phone_number: str, message: str) -> None:
|
|
576
607
|
acts = [
|
|
577
608
|
self.ActItem(
|
|
@@ -681,33 +712,3 @@ class TPLinkMRClient(TPLinkMRClientBase):
|
|
|
681
712
|
status.isp_name = values['3']['ispName']
|
|
682
713
|
|
|
683
714
|
return status
|
|
684
|
-
|
|
685
|
-
def get_vpn_status(self) -> VPNStatus:
|
|
686
|
-
status = VPNStatus()
|
|
687
|
-
acts = [
|
|
688
|
-
self.ActItem(self.ActItem.GET, 'OPENVPN', attrs=['enable']),
|
|
689
|
-
self.ActItem(self.ActItem.GET, 'PPTPVPN', attrs=['enable']),
|
|
690
|
-
self.ActItem(self.ActItem.GL, 'OVPN_CLIENT', attrs=['connAct']),
|
|
691
|
-
self.ActItem(self.ActItem.GL, 'PVPN_CLIENT', attrs=['connAct']),
|
|
692
|
-
]
|
|
693
|
-
_, values = self.req_act(acts)
|
|
694
|
-
|
|
695
|
-
status.openvpn_enable = values['0']['enable'] == '1'
|
|
696
|
-
status.pptpvpn_enable = values['1']['enable'] == '1'
|
|
697
|
-
|
|
698
|
-
for item in values['2']:
|
|
699
|
-
if item['connAct'] == '1':
|
|
700
|
-
status.openvpn_clients_total += 1
|
|
701
|
-
|
|
702
|
-
for item in values['3']:
|
|
703
|
-
if item['connAct'] == '1':
|
|
704
|
-
status.pptpvpn_clients_total += 1
|
|
705
|
-
|
|
706
|
-
return status
|
|
707
|
-
|
|
708
|
-
def set_vpn(self, vpn: VPN, enable: bool) -> None:
|
|
709
|
-
acts = [
|
|
710
|
-
self.ActItem(self.ActItem.SET, vpn.value, attrs=['enable={}'.format(int(enable))])
|
|
711
|
-
]
|
|
712
|
-
|
|
713
|
-
self.req_act(acts)
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import base64
|
|
2
|
+
from http import HTTPStatus
|
|
3
|
+
from tplinkrouterc6u.client.mr import TPLinkMRClientBase
|
|
4
|
+
from tplinkrouterc6u.common.exception import ClientException
|
|
5
|
+
from logging import Logger
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class TPLinkVRClient(TPLinkMRClientBase):
|
|
9
|
+
def __init__(self, host: str, password: str, username: str = 'admin', logger: Logger = None,
|
|
10
|
+
verify_ssl: bool = True, timeout: int = 30):
|
|
11
|
+
super().__init__(host, password, username, logger, verify_ssl, timeout)
|
|
12
|
+
self._url_rsa_key = 'cgi/getGDPRParm'
|
|
13
|
+
|
|
14
|
+
def supports(self):
|
|
15
|
+
return self._verify_router() and super().supports()
|
|
16
|
+
|
|
17
|
+
def _verify_router(self) -> bool:
|
|
18
|
+
"""
|
|
19
|
+
Verifies if the connected router is a supported TP-Link VR model.
|
|
20
|
+
|
|
21
|
+
This function checks if the router is a TP-Link VR model by sending a GET request
|
|
22
|
+
to the host and analyzing the response. It verifies the presence of specific
|
|
23
|
+
keywords and endpoints in the response to determine the model type.
|
|
24
|
+
|
|
25
|
+
Returns:
|
|
26
|
+
bool: True if the router is a supported TP-Link VR model and supports the RSA key endpoint,
|
|
27
|
+
otherwise False.
|
|
28
|
+
|
|
29
|
+
Raises:
|
|
30
|
+
Exception: If an error occurs during the request process, it logs the error
|
|
31
|
+
and returns False.
|
|
32
|
+
"""
|
|
33
|
+
|
|
34
|
+
is_VR = False
|
|
35
|
+
has_url_rsa_endpoint = False
|
|
36
|
+
|
|
37
|
+
try:
|
|
38
|
+
status_code, response = self._request(self.host, method='GET')
|
|
39
|
+
except Exception as e:
|
|
40
|
+
if self._logger is not None:
|
|
41
|
+
self._logger.error("Error while checking modem: {}".format(e))
|
|
42
|
+
|
|
43
|
+
return False
|
|
44
|
+
|
|
45
|
+
if status_code == HTTPStatus.OK:
|
|
46
|
+
is_VR = "Archer VR" in response
|
|
47
|
+
has_url_rsa_endpoint = self._url_rsa_key in response
|
|
48
|
+
|
|
49
|
+
if has_url_rsa_endpoint and is_VR:
|
|
50
|
+
return True
|
|
51
|
+
elif is_VR:
|
|
52
|
+
# check if lib.js is present. If response code is 200, it is okay. Check if self._url_rsa_key is present
|
|
53
|
+
try:
|
|
54
|
+
status_code, response = self._request("{}/js/lib.js".format(self.host), method='GET')
|
|
55
|
+
except Exception as e:
|
|
56
|
+
if self._logger is not None:
|
|
57
|
+
self._logger.error("Error while checking if lib.js is present in modem: {}".format(e))
|
|
58
|
+
|
|
59
|
+
# if lib.js is not present, return False. Are API not compatible to this class?
|
|
60
|
+
return False
|
|
61
|
+
|
|
62
|
+
if status_code == HTTPStatus.OK:
|
|
63
|
+
has_url_rsa_endpoint = (self._url_rsa_key in response)
|
|
64
|
+
|
|
65
|
+
return is_VR and has_url_rsa_endpoint
|
|
66
|
+
else:
|
|
67
|
+
# modem is not VR
|
|
68
|
+
return False
|
|
69
|
+
|
|
70
|
+
def logout(self) -> None:
|
|
71
|
+
'''
|
|
72
|
+
Logs out from the host
|
|
73
|
+
'''
|
|
74
|
+
acts = [
|
|
75
|
+
self.ActItem(self.ActItem.CGI, '/cgi/logout')
|
|
76
|
+
]
|
|
77
|
+
|
|
78
|
+
response, _ = self.req_act(acts)
|
|
79
|
+
|
|
80
|
+
if response == '[cgi]0\n[error]0\n':
|
|
81
|
+
self._token = None
|
|
82
|
+
|
|
83
|
+
def _req_login(self) -> None:
|
|
84
|
+
'''
|
|
85
|
+
Authenticates to the host
|
|
86
|
+
- sets the session token after successful login
|
|
87
|
+
- data/signature is passed as a GET parameter, NOT as a raw request data
|
|
88
|
+
(unlike for regular encrypted requests to the /cgi_gdpr endpoint)
|
|
89
|
+
|
|
90
|
+
Example session token (set as a cookie):
|
|
91
|
+
{'JSESSIONID': '4d786fede0164d7613411c7b6ec61e'}
|
|
92
|
+
'''
|
|
93
|
+
# self.password to base64 string
|
|
94
|
+
base64pwd = base64.b64encode(self.password.encode('utf-8')).decode('utf-8')
|
|
95
|
+
# sign, data = self._prepare_data(self.username + '\n' + str(base64pwd), True)
|
|
96
|
+
|
|
97
|
+
data_list = []
|
|
98
|
+
data_list.append("UserName={}".format(self.username))
|
|
99
|
+
data_list.append("Passwd={}".format(base64pwd))
|
|
100
|
+
|
|
101
|
+
actItem = self.ActItem(self.ActItem.CGI, '/cgi/login', attrs=data_list)
|
|
102
|
+
response, _ = self.req_act([actItem])
|
|
103
|
+
|
|
104
|
+
ret_code = self._parse_ret_val(response)
|
|
105
|
+
if ret_code == self.HTTP_RET_OK:
|
|
106
|
+
return
|
|
107
|
+
|
|
108
|
+
if ret_code == self.HTTP_ERR_USER_PWD_NOT_CORRECT:
|
|
109
|
+
|
|
110
|
+
error = 'TplinkRouter - VR - Login failed, wrong password.'
|
|
111
|
+
if self._logger:
|
|
112
|
+
self._logger.debug(error)
|
|
113
|
+
raise ClientException(error)
|
|
114
|
+
|
|
115
|
+
if ret_code == self.HTTP_ERR_USER_BAD_REQUEST:
|
|
116
|
+
error = 'TplinkRouter - VR - Login failed. Generic error code: {}'.format(ret_code)
|
|
117
|
+
if self._logger:
|
|
118
|
+
self._logger.debug(error)
|
|
119
|
+
raise ClientException(error)
|
|
120
|
+
|
|
121
|
+
# unknown error
|
|
122
|
+
error = 'TplinkRouter - VR - Login failed. Unknown error code: {}'.format(ret_code)
|
|
123
|
+
if self._logger:
|
|
124
|
+
self._logger.debug(error)
|
|
125
|
+
raise ClientException(error)
|
|
126
|
+
|
|
127
|
+
def _request(self, url, method='POST', data_str=None, encrypt=False, is_login=False):
|
|
128
|
+
is_login = encrypt and '/cgi/login' in data_str
|
|
129
|
+
return super()._request(url, method, data_str, encrypt, is_login)
|
tplinkrouterc6u/provider.py
CHANGED
|
@@ -1,39 +1,45 @@
|
|
|
1
1
|
from logging import Logger
|
|
2
2
|
|
|
3
3
|
from tplinkrouterc6u import TPLinkXDRClient
|
|
4
|
-
from tplinkrouterc6u.common.exception import ClientException
|
|
4
|
+
from tplinkrouterc6u.common.exception import ClientException
|
|
5
5
|
from tplinkrouterc6u.client.c6u import TplinkRouter
|
|
6
6
|
from tplinkrouterc6u.client.deco import TPLinkDecoClient
|
|
7
7
|
from tplinkrouterc6u.client_abstract import AbstractRouter
|
|
8
8
|
from tplinkrouterc6u.client.mr import TPLinkMRClient
|
|
9
9
|
from tplinkrouterc6u.client.ex import TPLinkEXClient
|
|
10
|
-
from tplinkrouterc6u.client.c6v4 import TplinkC6V4Router
|
|
11
10
|
from tplinkrouterc6u.client.c5400x import TplinkC5400XRouter
|
|
12
11
|
from tplinkrouterc6u.client.c1200 import TplinkC1200Router
|
|
12
|
+
from tplinkrouterc6u.client.c80 import TplinkC80Router
|
|
13
|
+
from tplinkrouterc6u.client.vr import TPLinkVRClient
|
|
13
14
|
|
|
14
15
|
|
|
15
16
|
class TplinkRouterProvider:
|
|
16
17
|
@staticmethod
|
|
17
18
|
def get_client(host: str, password: str, username: str = 'admin', logger: Logger = None,
|
|
18
19
|
verify_ssl: bool = True, timeout: int = 30) -> AbstractRouter:
|
|
19
|
-
for client in [TplinkC5400XRouter, TPLinkEXClient, TPLinkMRClient,
|
|
20
|
-
TPLinkXDRClient, TplinkRouter]:
|
|
20
|
+
for client in [TplinkC5400XRouter, TPLinkVRClient, TPLinkEXClient, TPLinkMRClient, TPLinkDecoClient,
|
|
21
|
+
TPLinkXDRClient, TplinkRouter, TplinkC80Router]:
|
|
21
22
|
router = client(host, password, username, logger, verify_ssl, timeout)
|
|
22
23
|
if router.supports():
|
|
23
24
|
return router
|
|
24
25
|
|
|
26
|
+
message = ('Login failed! Please check if your router local password is correct or '
|
|
27
|
+
'try to use web encrypted password instead. Check the documentation!')
|
|
25
28
|
router = TplinkC1200Router(host, password, username, logger, verify_ssl, timeout)
|
|
26
29
|
try:
|
|
27
30
|
router.authorize()
|
|
28
31
|
return router
|
|
29
|
-
except
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
32
|
+
except Exception:
|
|
33
|
+
pass
|
|
34
|
+
|
|
35
|
+
for client in [TPLinkVRClient, TPLinkXDRClient]:
|
|
36
|
+
router = client(host, password, username, None, verify_ssl, timeout)
|
|
37
|
+
try:
|
|
38
|
+
router.authorize()
|
|
39
|
+
message = ('Your router might be supported by {}. Please open the issue here '
|
|
40
|
+
'https://github.com/AlexandrErohin/TP-Link-Archer-C6U').format(router.__class__)
|
|
41
|
+
break
|
|
42
|
+
except Exception:
|
|
43
|
+
pass
|
|
44
|
+
|
|
45
|
+
raise ClientException(message)
|