Module kyros.client
21 |
24 |
275 | 25 | Expand source code 26 |
27 |from __future__ import annotations
28 |
29 | import asyncio
30 | import base64
31 | import logging
32 | from typing import Any, Awaitable, Callable, Sequence, Union
33 |
34 | import donna25519
35 |
36 | from . import (constants, crypto, exceptions, message, session, utilities,
37 | websocket)
38 |
39 | logger = logging.getLogger(__name__) # pylint: disable=invalid-name
40 |
41 |
42 | class Client:
43 | """This class is the wrapper for WhatsApp Web.
44 | Errors mainly shown as log messages (using `logging`).
45 | Some methods might raise an exception that will interrupt the
46 | whole session. Please make sure to catch any exception thrown.
47 | You might want to use the `Client.ensure_safe` method.
48 | Please note that some exceptions should not be ignored as it might
49 | be important (example: a timeout error when sending a message will
50 | result in the failing of message delivery). A much better and pythonic
51 | way to handle and raise exception is still a pending task."""
52 | @classmethod
53 | async def create(cls) -> Client:
54 | """The proper way to instantiate `Client` class. Connects to
55 | websocket server, also sets up the default client profile.
56 | Returns a ready to use `Client` instance."""
57 | instance = cls()
58 | await instance.setup_ws()
59 | instance.load_profile(constants.CLIENT_VERSION,
60 | constants.CLIENT_LONG_DESC,
61 | constants.CLIENT_SHORT_DESC)
62 | logger.info("Kyros instance created")
63 | return instance
64 |
65 | def __init__(self) -> None:
66 | """Initiate class. Do not initiate this way, use `Client.create()`
67 | instead."""
68 | self.profile = None
69 | self.message_handler = message.MessageHandler()
70 | self.session = session.Session()
71 | self.session.client_id = utilities.generate_client_id()
72 | self.session.private_key = donna25519.PrivateKey()
73 | self.session.public_key = self.session.private_key.get_public()
74 | self.phone_info = {}
75 | self.websocket = None
76 |
77 | async def setup_ws(self) -> None:
78 | """Connect to websocket server."""
79 | self.websocket = websocket.WebsocketClient(self.message_handler)
80 | await self.websocket.connect()
81 | self.websocket.load_session(self.session)
82 |
83 | def load_profile(self, ver: Sequence[Union[float, int]], long_desc: str,
84 | short_desc: str) -> None:
85 | """Loads a new client profile (which will be shown in the WhatsApp
86 | mobile app). Please note that the client profile is unchangeable after
87 | logging in (after admin init)."""
88 | logger.debug("Loaded new profile")
89 | self.profile = {
90 | "version": ver,
91 | "long_description": long_desc,
92 | "short_description": short_desc,
93 | }
94 |
95 | async def send_init(self) -> None:
96 | """Send an admin init message. Usually not used directly. Used whens
97 | doing QR login or restoring session."""
98 | init_message = websocket.WebsocketMessage(None, [
99 | "admin", "init", self.profile["version"],
100 | [
101 | self.profile["long_description"],
102 | self.profile["short_description"]
103 | ], self.session.client_id, True
104 | ])
105 | await self.websocket.send_message(init_message)
106 |
107 | resp = await self.websocket.messages.get(init_message.tag)
108 | if resp["status"] != 200:
109 | logger.error("unexpected init stts code, resp:%s", resp)
110 | raise exceptions.StatusCodeError(resp["status"])
111 |
112 | self.session.server_id = resp["ref"]
113 |
114 | async def qr_login(self) -> (str, Awaitable):
115 | """Does a QR login. Sends init then return the qr data
116 | which will be shown using `pyqrcode` or another library and.
117 | also returns a waitable which will timeout in 20 seconds.
118 | 20 seconds is the maximum amount of time for the QR code to be
119 | considered valid.
120 | Raises `asyncio.TimeoutError` if timeout reached.
121 | Another exception might also possible."""
122 | await self.send_init()
123 |
124 | async def wait_qr_scan():
125 | ws_message = await self.websocket.messages.get("s1", 20)
126 | connection_data = ws_message[1]
127 |
128 | self.phone_info = connection_data["phone"]
129 | self.session.secret = base64.b64decode(
130 | connection_data["secret"].encode())
131 | self.session.server_token = connection_data["serverToken"]
132 | self.session.client_token = connection_data["clientToken"]
133 | self.session.browser_token = connection_data["browserToken"]
134 | self.session.wid = connection_data["wid"]
135 |
136 | self.session.shared_secret = self.session.private_key.do_exchange(
137 | donna25519.PublicKey(self.session.secret[:32]))
138 | self.session.shared_secret_expanded = crypto.hkdf_expand(
139 | self.session.shared_secret, 80)
140 |
141 | if not crypto.validate_secrets(
142 | self.session.secret, self.session.shared_secret_expanded):
143 | raise exceptions.HMACValidationError
144 |
145 | self.session.keys_encrypted = self.session.shared_secret_expanded[
146 | 64:] + self.session.secret[64:]
147 | self.session.keys_decrypted = crypto.aes_decrypt(
148 | self.session.shared_secret_expanded[:32],
149 | self.session.keys_encrypted)
150 |
151 | self.session.enc_key = self.session.keys_decrypted[:32]
152 | self.session.mac_key = self.session.keys_decrypted[32:64]
153 | print(self.session.enc_key, self.session.mac_key)
154 |
155 | qr_fragments = [
156 | self.session.server_id,
157 | base64.b64encode(self.session.public_key.public).decode(),
158 | self.session.client_id
159 | ]
160 | qr_data = ",".join(qr_fragments)
161 |
162 | return qr_data, wait_qr_scan()
163 |
164 | async def restore_session( # noqa: mc0001
165 | self, new_session: session.Session = None) -> session.Session:
166 | """Restores a session. Returns the new session object.
167 | If `new_session` argument specified, replace current session with
168 | the new one.
169 | Raises asyncio.TimeoutError when a websocket request reaches timeout.
170 | Old session is restored when it fails restoring the new one."""
171 | old_session = self.session
172 | if new_session:
173 | self.session = new_session
174 |
175 | async def restore():
176 | await self.send_init()
177 |
178 | login_message = websocket.WebsocketMessage(None, [
179 | "admin", "login", self.session.client_token,
180 | self.session.server_token, self.session.client_id, "takeover"
181 | ])
182 | await self.websocket.send_message(login_message)
183 |
184 | s1_message = None
185 | try:
186 | s1_message = await self.websocket.messages.get("s1")
187 | except asyncio.TimeoutError:
188 | logger.error("s1 message timed out")
189 |
190 | login_resp = await self.websocket.messages.get(
191 | login_message.tag)
192 | if login_resp["status"] != 200:
193 | raise exceptions.StatusCodeError(login_resp["status"])
194 | self.websocket.messages.add(login_message.tag, login_resp)
195 |
196 | s2_message = None
197 | if len(s1_message) == 2 and s1_message[0] == "Cmd" \
198 | and s1_message[1]["type"] == "challenge":
199 | if not self.resolve_challenge(s1_message["challenge"]):
200 | logger.error("failed to solve challenge")
201 | return False
202 |
203 | s2_message = self.websocket.messages.get("s2")
204 |
205 | login_resp = await self.websocket.messages.get(login_message.tag)
206 | if login_resp["status"] != 200:
207 | raise exceptions.StatusCodeError(login_resp["status"])
208 |
209 | conn_resp = s2_message if s2_message else s1_message
210 | self.phone_info = conn_resp["phone"]
211 | self.session.wid = conn_resp["wid"]
212 | self.session.client_token = conn_resp["clientToken"]
213 | self.session.server_token = conn_resp["serverToken"]
214 |
215 | self.websocket.load_session(self.session) # reload references
216 |
217 | return self.session
218 |
219 | try:
220 | return await restore()
221 | except Exception: # pylint: disable=broad-except
222 | if old_session:
223 | self.session = old_session
224 | raise
225 |
226 | async def resolve_challenge(self, challenge: str) -> None:
227 | """Resolve a challenge string. Sings challenge with mac_key and send
228 | a challenge response ws message. Usually called when restoring session.
229 | Raises `asyncio.TimeoutError` when timeout reached."""
230 | challenge = base64.b64decode(challenge.encode()).decode()
231 | signed = crypto.hmac_sha256(self.session.mac_key, challenge)
232 |
233 | chall_reply_message = websocket.WebsocketMessage(
234 | None, [
235 | "admin", "challenge",
236 | base64.b64encode(signed).decode(), self.session.server_token,
237 | self.session.client_id
238 | ])
239 | await self.websocket.send_message(chall_reply_message)
240 |
241 | status = self.websocket.messages.get(chall_reply_message)["status"]
242 | if status != 200:
243 | raise exceptions.StatusCodeError(status)
244 |
245 | return
246 |
247 | async def ensure_safe(self, func: Callable, *args: Any,
248 | **kwargs: Any) -> (Union[None, Exception], Any):
249 | """A function intended to be used to run another function without
250 | raising any exception. Returns an exception as first element of
251 | the tuple if available. Also returns the result of the function call
252 | as the second element of the tuple if no exceptions raised. If `func`
253 | is a coroutine function, this function returns the awaited result.
254 | """
255 | try:
256 | return_value = func(*args, **kwargs)
257 | if asyncio.iscoroutine(return_value):
258 | return None, await return_value
259 | return None, return_value
260 | except Exception as exc: # pylint: disable=broad-except
261 | logger.error("Exception %s raised at %s", exc, func.__name__)
262 | return exc, None
263 |
264 | async def logout(self) -> None:
265 | """Sends a logout message to the websocket server. This will
266 | invalidate the session."""
267 | await self.websocket.send_message(
268 | websocket.WebsocketMessage(None, ["admin", "Conn", "disconnect"]))
269 |
270 | async def shutdown(self) -> None:
271 | """Do a cleanup. Closes websocket connection."""
272 | logger.info("Shutting down")
273 | await self.websocket.shutdown()Classes
284 |-
285 |
286 | class Client 287 |
288 | -
289 | 300 |
This class is the wrapper for WhatsApp Web. 290 | Errors mainly shown as log messages (using
298 |logging). 291 | Some methods might raise an exception that will interrupt the 292 | whole session. Please make sure to catch any exception thrown. 293 | You might want to use theClient.ensure_safe()method. 294 | Please note that some exceptions should not be ignored as it might 295 | be important (example: a timeout error when sending a message will 296 | result in the failing of message delivery). A much better and pythonic 297 | way to handle and raise exception is still a pending task.Initiate class. Do not initiate this way, use
Client.create()299 | instead.301 |537 |302 | Expand source code 303 |
304 |
536 |class Client: 305 | """This class is the wrapper for WhatsApp Web. 306 | Errors mainly shown as log messages (using `logging`). 307 | Some methods might raise an exception that will interrupt the 308 | whole session. Please make sure to catch any exception thrown. 309 | You might want to use the `Client.ensure_safe` method. 310 | Please note that some exceptions should not be ignored as it might 311 | be important (example: a timeout error when sending a message will 312 | result in the failing of message delivery). A much better and pythonic 313 | way to handle and raise exception is still a pending task.""" 314 | @classmethod 315 | async def create(cls) -> Client: 316 | """The proper way to instantiate `Client` class. Connects to 317 | websocket server, also sets up the default client profile. 318 | Returns a ready to use `Client` instance.""" 319 | instance = cls() 320 | await instance.setup_ws() 321 | instance.load_profile(constants.CLIENT_VERSION, 322 | constants.CLIENT_LONG_DESC, 323 | constants.CLIENT_SHORT_DESC) 324 | logger.info("Kyros instance created") 325 | return instance 326 | 327 | def __init__(self) -> None: 328 | """Initiate class. Do not initiate this way, use `Client.create()` 329 | instead.""" 330 | self.profile = None 331 | self.message_handler = message.MessageHandler() 332 | self.session = session.Session() 333 | self.session.client_id = utilities.generate_client_id() 334 | self.session.private_key = donna25519.PrivateKey() 335 | self.session.public_key = self.session.private_key.get_public() 336 | self.phone_info = {} 337 | self.websocket = None 338 | 339 | async def setup_ws(self) -> None: 340 | """Connect to websocket server.""" 341 | self.websocket = websocket.WebsocketClient(self.message_handler) 342 | await self.websocket.connect() 343 | self.websocket.load_session(self.session) 344 | 345 | def load_profile(self, ver: Sequence[Union[float, int]], long_desc: str, 346 | short_desc: str) -> None: 347 | """Loads a new client profile (which will be shown in the WhatsApp 348 | mobile app). Please note that the client profile is unchangeable after 349 | logging in (after admin init).""" 350 | logger.debug("Loaded new profile") 351 | self.profile = { 352 | "version": ver, 353 | "long_description": long_desc, 354 | "short_description": short_desc, 355 | } 356 | 357 | async def send_init(self) -> None: 358 | """Send an admin init message. Usually not used directly. Used whens 359 | doing QR login or restoring session.""" 360 | init_message = websocket.WebsocketMessage(None, [ 361 | "admin", "init", self.profile["version"], 362 | [ 363 | self.profile["long_description"], 364 | self.profile["short_description"] 365 | ], self.session.client_id, True 366 | ]) 367 | await self.websocket.send_message(init_message) 368 | 369 | resp = await self.websocket.messages.get(init_message.tag) 370 | if resp["status"] != 200: 371 | logger.error("unexpected init stts code, resp:%s", resp) 372 | raise exceptions.StatusCodeError(resp["status"]) 373 | 374 | self.session.server_id = resp["ref"] 375 | 376 | async def qr_login(self) -> (str, Awaitable): 377 | """Does a QR login. Sends init then return the qr data 378 | which will be shown using `pyqrcode` or another library and. 379 | also returns a waitable which will timeout in 20 seconds. 380 | 20 seconds is the maximum amount of time for the QR code to be 381 | considered valid. 382 | Raises `asyncio.TimeoutError` if timeout reached. 383 | Another exception might also possible.""" 384 | await self.send_init() 385 | 386 | async def wait_qr_scan(): 387 | ws_message = await self.websocket.messages.get("s1", 20) 388 | connection_data = ws_message[1] 389 | 390 | self.phone_info = connection_data["phone"] 391 | self.session.secret = base64.b64decode( 392 | connection_data["secret"].encode()) 393 | self.session.server_token = connection_data["serverToken"] 394 | self.session.client_token = connection_data["clientToken"] 395 | self.session.browser_token = connection_data["browserToken"] 396 | self.session.wid = connection_data["wid"] 397 | 398 | self.session.shared_secret = self.session.private_key.do_exchange( 399 | donna25519.PublicKey(self.session.secret[:32])) 400 | self.session.shared_secret_expanded = crypto.hkdf_expand( 401 | self.session.shared_secret, 80) 402 | 403 | if not crypto.validate_secrets( 404 | self.session.secret, self.session.shared_secret_expanded): 405 | raise exceptions.HMACValidationError 406 | 407 | self.session.keys_encrypted = self.session.shared_secret_expanded[ 408 | 64:] + self.session.secret[64:] 409 | self.session.keys_decrypted = crypto.aes_decrypt( 410 | self.session.shared_secret_expanded[:32], 411 | self.session.keys_encrypted) 412 | 413 | self.session.enc_key = self.session.keys_decrypted[:32] 414 | self.session.mac_key = self.session.keys_decrypted[32:64] 415 | print(self.session.enc_key, self.session.mac_key) 416 | 417 | qr_fragments = [ 418 | self.session.server_id, 419 | base64.b64encode(self.session.public_key.public).decode(), 420 | self.session.client_id 421 | ] 422 | qr_data = ",".join(qr_fragments) 423 | 424 | return qr_data, wait_qr_scan() 425 | 426 | async def restore_session( # noqa: mc0001 427 | self, new_session: session.Session = None) -> session.Session: 428 | """Restores a session. Returns the new session object. 429 | If `new_session` argument specified, replace current session with 430 | the new one. 431 | Raises asyncio.TimeoutError when a websocket request reaches timeout. 432 | Old session is restored when it fails restoring the new one.""" 433 | old_session = self.session 434 | if new_session: 435 | self.session = new_session 436 | 437 | async def restore(): 438 | await self.send_init() 439 | 440 | login_message = websocket.WebsocketMessage(None, [ 441 | "admin", "login", self.session.client_token, 442 | self.session.server_token, self.session.client_id, "takeover" 443 | ]) 444 | await self.websocket.send_message(login_message) 445 | 446 | s1_message = None 447 | try: 448 | s1_message = await self.websocket.messages.get("s1") 449 | except asyncio.TimeoutError: 450 | logger.error("s1 message timed out") 451 | 452 | login_resp = await self.websocket.messages.get( 453 | login_message.tag) 454 | if login_resp["status"] != 200: 455 | raise exceptions.StatusCodeError(login_resp["status"]) 456 | self.websocket.messages.add(login_message.tag, login_resp) 457 | 458 | s2_message = None 459 | if len(s1_message) == 2 and s1_message[0] == "Cmd" \ 460 | and s1_message[1]["type"] == "challenge": 461 | if not self.resolve_challenge(s1_message["challenge"]): 462 | logger.error("failed to solve challenge") 463 | return False 464 | 465 | s2_message = self.websocket.messages.get("s2") 466 | 467 | login_resp = await self.websocket.messages.get(login_message.tag) 468 | if login_resp["status"] != 200: 469 | raise exceptions.StatusCodeError(login_resp["status"]) 470 | 471 | conn_resp = s2_message if s2_message else s1_message 472 | self.phone_info = conn_resp["phone"] 473 | self.session.wid = conn_resp["wid"] 474 | self.session.client_token = conn_resp["clientToken"] 475 | self.session.server_token = conn_resp["serverToken"] 476 | 477 | self.websocket.load_session(self.session) # reload references 478 | 479 | return self.session 480 | 481 | try: 482 | return await restore() 483 | except Exception: # pylint: disable=broad-except 484 | if old_session: 485 | self.session = old_session 486 | raise 487 | 488 | async def resolve_challenge(self, challenge: str) -> None: 489 | """Resolve a challenge string. Sings challenge with mac_key and send 490 | a challenge response ws message. Usually called when restoring session. 491 | Raises `asyncio.TimeoutError` when timeout reached.""" 492 | challenge = base64.b64decode(challenge.encode()).decode() 493 | signed = crypto.hmac_sha256(self.session.mac_key, challenge) 494 | 495 | chall_reply_message = websocket.WebsocketMessage( 496 | None, [ 497 | "admin", "challenge", 498 | base64.b64encode(signed).decode(), self.session.server_token, 499 | self.session.client_id 500 | ]) 501 | await self.websocket.send_message(chall_reply_message) 502 | 503 | status = self.websocket.messages.get(chall_reply_message)["status"] 504 | if status != 200: 505 | raise exceptions.StatusCodeError(status) 506 | 507 | return 508 | 509 | async def ensure_safe(self, func: Callable, *args: Any, 510 | **kwargs: Any) -> (Union[None, Exception], Any): 511 | """A function intended to be used to run another function without 512 | raising any exception. Returns an exception as first element of 513 | the tuple if available. Also returns the result of the function call 514 | as the second element of the tuple if no exceptions raised. If `func` 515 | is a coroutine function, this function returns the awaited result. 516 | """ 517 | try: 518 | return_value = func(*args, **kwargs) 519 | if asyncio.iscoroutine(return_value): 520 | return None, await return_value 521 | return None, return_value 522 | except Exception as exc: # pylint: disable=broad-except 523 | logger.error("Exception %s raised at %s", exc, func.__name__) 524 | return exc, None 525 | 526 | async def logout(self) -> None: 527 | """Sends a logout message to the websocket server. This will 528 | invalidate the session.""" 529 | await self.websocket.send_message( 530 | websocket.WebsocketMessage(None, ["admin", "Conn", "disconnect"])) 531 | 532 | async def shutdown(self) -> None: 533 | """Do a cleanup. Closes websocket connection.""" 534 | logger.info("Shutting down") 535 | await self.websocket.shutdown()Static methods
538 |-
539 |
540 | async def create() -> Client 541 |
542 | -
543 | 546 |
The proper way to instantiate
Clientclass. Connects to 544 | websocket server, also sets up the default client profile. 545 | Returns a ready to useClientinstance.547 |563 |548 | Expand source code 549 |
550 |
562 |@classmethod 551 | async def create(cls) -> Client: 552 | """The proper way to instantiate `Client` class. Connects to 553 | websocket server, also sets up the default client profile. 554 | Returns a ready to use `Client` instance.""" 555 | instance = cls() 556 | await instance.setup_ws() 557 | instance.load_profile(constants.CLIENT_VERSION, 558 | constants.CLIENT_LONG_DESC, 559 | constants.CLIENT_SHORT_DESC) 560 | logger.info("Kyros instance created") 561 | return instance
564 |
Methods
566 |-
567 |
568 | async def ensure_safe(self, func: Callable, *args: Any, **kwargs: Any) -> '(Union[None, Exception], Any)' 569 |
570 | -
571 | 576 |
A function intended to be used to run another function without 572 | raising any exception. Returns an exception as first element of 573 | the tuple if available. Also returns the result of the function call 574 | as the second element of the tuple if no exceptions raised. If
func575 | is a coroutine function, this function returns the awaited result.577 |597 |578 | Expand source code 579 |
580 |
596 |async def ensure_safe(self, func: Callable, *args: Any, 581 | **kwargs: Any) -> (Union[None, Exception], Any): 582 | """A function intended to be used to run another function without 583 | raising any exception. Returns an exception as first element of 584 | the tuple if available. Also returns the result of the function call 585 | as the second element of the tuple if no exceptions raised. If `func` 586 | is a coroutine function, this function returns the awaited result. 587 | """ 588 | try: 589 | return_value = func(*args, **kwargs) 590 | if asyncio.iscoroutine(return_value): 591 | return None, await return_value 592 | return None, return_value 593 | except Exception as exc: # pylint: disable=broad-except 594 | logger.error("Exception %s raised at %s", exc, func.__name__) 595 | return exc, None
598 | 599 | def load_profile(self, ver: Sequence[Union[float, int]], long_desc: str, short_desc: str) -> NoneType 600 |
601 | -
602 | 605 |
Loads a new client profile (which will be shown in the WhatsApp 603 | mobile app). Please note that the client profile is unchangeable after 604 | logging in (after admin init).
606 |621 |607 | Expand source code 608 |
609 |
620 |def load_profile(self, ver: Sequence[Union[float, int]], long_desc: str, 610 | short_desc: str) -> None: 611 | """Loads a new client profile (which will be shown in the WhatsApp 612 | mobile app). Please note that the client profile is unchangeable after 613 | logging in (after admin init).""" 614 | logger.debug("Loaded new profile") 615 | self.profile = { 616 | "version": ver, 617 | "long_description": long_desc, 618 | "short_description": short_desc, 619 | }
622 | 623 | async def logout(self) -> NoneType 624 |
625 | -
626 | 628 |
Sends a logout message to the websocket server. This will 627 | invalidate the session.
629 |638 |630 | Expand source code 631 |
632 |
637 |async def logout(self) -> None: 633 | """Sends a logout message to the websocket server. This will 634 | invalidate the session.""" 635 | await self.websocket.send_message( 636 | websocket.WebsocketMessage(None, ["admin", "Conn", "disconnect"]))
639 | 640 | async def qr_login(self) -> '(str, Awaitable)' 641 |
642 | -
643 | 650 |
Does a QR login. Sends init then return the qr data 644 | which will be shown using
pyqrcodeor another library and. 645 | also returns a waitable which will timeout in 20 seconds. 646 | 20 seconds is the maximum amount of time for the QR code to be 647 | considered valid. 648 | Raisesasyncio.TimeoutErrorif timeout reached. 649 | Another exception might also possible.651 |704 |652 | Expand source code 653 |
654 |
703 |async def qr_login(self) -> (str, Awaitable): 655 | """Does a QR login. Sends init then return the qr data 656 | which will be shown using `pyqrcode` or another library and. 657 | also returns a waitable which will timeout in 20 seconds. 658 | 20 seconds is the maximum amount of time for the QR code to be 659 | considered valid. 660 | Raises `asyncio.TimeoutError` if timeout reached. 661 | Another exception might also possible.""" 662 | await self.send_init() 663 | 664 | async def wait_qr_scan(): 665 | ws_message = await self.websocket.messages.get("s1", 20) 666 | connection_data = ws_message[1] 667 | 668 | self.phone_info = connection_data["phone"] 669 | self.session.secret = base64.b64decode( 670 | connection_data["secret"].encode()) 671 | self.session.server_token = connection_data["serverToken"] 672 | self.session.client_token = connection_data["clientToken"] 673 | self.session.browser_token = connection_data["browserToken"] 674 | self.session.wid = connection_data["wid"] 675 | 676 | self.session.shared_secret = self.session.private_key.do_exchange( 677 | donna25519.PublicKey(self.session.secret[:32])) 678 | self.session.shared_secret_expanded = crypto.hkdf_expand( 679 | self.session.shared_secret, 80) 680 | 681 | if not crypto.validate_secrets( 682 | self.session.secret, self.session.shared_secret_expanded): 683 | raise exceptions.HMACValidationError 684 | 685 | self.session.keys_encrypted = self.session.shared_secret_expanded[ 686 | 64:] + self.session.secret[64:] 687 | self.session.keys_decrypted = crypto.aes_decrypt( 688 | self.session.shared_secret_expanded[:32], 689 | self.session.keys_encrypted) 690 | 691 | self.session.enc_key = self.session.keys_decrypted[:32] 692 | self.session.mac_key = self.session.keys_decrypted[32:64] 693 | print(self.session.enc_key, self.session.mac_key) 694 | 695 | qr_fragments = [ 696 | self.session.server_id, 697 | base64.b64encode(self.session.public_key.public).decode(), 698 | self.session.client_id 699 | ] 700 | qr_data = ",".join(qr_fragments) 701 | 702 | return qr_data, wait_qr_scan()
705 | 706 | async def resolve_challenge(self, challenge: str) -> NoneType 707 |
708 | -
709 | 712 |
Resolve a challenge string. Sings challenge with mac_key and send 710 | a challenge response ws message. Usually called when restoring session. 711 | Raises
asyncio.TimeoutErrorwhen timeout reached.713 |737 |714 | Expand source code 715 |
716 |
736 |async def resolve_challenge(self, challenge: str) -> None: 717 | """Resolve a challenge string. Sings challenge with mac_key and send 718 | a challenge response ws message. Usually called when restoring session. 719 | Raises `asyncio.TimeoutError` when timeout reached.""" 720 | challenge = base64.b64decode(challenge.encode()).decode() 721 | signed = crypto.hmac_sha256(self.session.mac_key, challenge) 722 | 723 | chall_reply_message = websocket.WebsocketMessage( 724 | None, [ 725 | "admin", "challenge", 726 | base64.b64encode(signed).decode(), self.session.server_token, 727 | self.session.client_id 728 | ]) 729 | await self.websocket.send_message(chall_reply_message) 730 | 731 | status = self.websocket.messages.get(chall_reply_message)["status"] 732 | if status != 200: 733 | raise exceptions.StatusCodeError(status) 734 | 735 | return
738 | 739 | async def restore_session(self, new_session: session.Session = None) -> Session 740 |
741 | -
742 | 747 |
Restores a session. Returns the new session object. 743 | If
new_sessionargument specified, replace current session with 744 | the new one. 745 | Raises asyncio.TimeoutError when a websocket request reaches timeout. 746 | Old session is restored when it fails restoring the new one.748 |813 |749 | Expand source code 750 |
751 |
812 |async def restore_session( # noqa: mc0001 752 | self, new_session: session.Session = None) -> session.Session: 753 | """Restores a session. Returns the new session object. 754 | If `new_session` argument specified, replace current session with 755 | the new one. 756 | Raises asyncio.TimeoutError when a websocket request reaches timeout. 757 | Old session is restored when it fails restoring the new one.""" 758 | old_session = self.session 759 | if new_session: 760 | self.session = new_session 761 | 762 | async def restore(): 763 | await self.send_init() 764 | 765 | login_message = websocket.WebsocketMessage(None, [ 766 | "admin", "login", self.session.client_token, 767 | self.session.server_token, self.session.client_id, "takeover" 768 | ]) 769 | await self.websocket.send_message(login_message) 770 | 771 | s1_message = None 772 | try: 773 | s1_message = await self.websocket.messages.get("s1") 774 | except asyncio.TimeoutError: 775 | logger.error("s1 message timed out") 776 | 777 | login_resp = await self.websocket.messages.get( 778 | login_message.tag) 779 | if login_resp["status"] != 200: 780 | raise exceptions.StatusCodeError(login_resp["status"]) 781 | self.websocket.messages.add(login_message.tag, login_resp) 782 | 783 | s2_message = None 784 | if len(s1_message) == 2 and s1_message[0] == "Cmd" \ 785 | and s1_message[1]["type"] == "challenge": 786 | if not self.resolve_challenge(s1_message["challenge"]): 787 | logger.error("failed to solve challenge") 788 | return False 789 | 790 | s2_message = self.websocket.messages.get("s2") 791 | 792 | login_resp = await self.websocket.messages.get(login_message.tag) 793 | if login_resp["status"] != 200: 794 | raise exceptions.StatusCodeError(login_resp["status"]) 795 | 796 | conn_resp = s2_message if s2_message else s1_message 797 | self.phone_info = conn_resp["phone"] 798 | self.session.wid = conn_resp["wid"] 799 | self.session.client_token = conn_resp["clientToken"] 800 | self.session.server_token = conn_resp["serverToken"] 801 | 802 | self.websocket.load_session(self.session) # reload references 803 | 804 | return self.session 805 | 806 | try: 807 | return await restore() 808 | except Exception: # pylint: disable=broad-except 809 | if old_session: 810 | self.session = old_session 811 | raise
814 | 815 | async def send_init(self) -> NoneType 816 |
817 | -
818 | 820 |
Send an admin init message. Usually not used directly. Used whens 819 | doing QR login or restoring session.
821 |843 |822 | Expand source code 823 |
824 |
842 |async def send_init(self) -> None: 825 | """Send an admin init message. Usually not used directly. Used whens 826 | doing QR login or restoring session.""" 827 | init_message = websocket.WebsocketMessage(None, [ 828 | "admin", "init", self.profile["version"], 829 | [ 830 | self.profile["long_description"], 831 | self.profile["short_description"] 832 | ], self.session.client_id, True 833 | ]) 834 | await self.websocket.send_message(init_message) 835 | 836 | resp = await self.websocket.messages.get(init_message.tag) 837 | if resp["status"] != 200: 838 | logger.error("unexpected init stts code, resp:%s", resp) 839 | raise exceptions.StatusCodeError(resp["status"]) 840 | 841 | self.session.server_id = resp["ref"]
844 | 845 | async def setup_ws(self) -> NoneType 846 |
847 | -
848 | 849 |
Connect to websocket server.
850 |859 |851 | Expand source code 852 |
853 |
858 |async def setup_ws(self) -> None: 854 | """Connect to websocket server.""" 855 | self.websocket = websocket.WebsocketClient(self.message_handler) 856 | await self.websocket.connect() 857 | self.websocket.load_session(self.session)
860 | 861 | async def shutdown(self) -> NoneType 862 |
863 | -
864 | 865 |
Do a cleanup. Closes websocket connection.
866 |874 |867 | Expand source code 868 |
869 |
873 |async def shutdown(self) -> None: 870 | """Do a cleanup. Closes websocket connection.""" 871 | logger.info("Shutting down") 872 | await self.websocket.shutdown()
875 |
877 |