aioamazondevices 1.0.0__tar.gz → 1.2.0__tar.gz

{aioamazondevices-1.0.0 → aioamazondevices-1.2.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: aioamazondevices
-Version: 1.0.0
+Version: 1.2.0
 Summary: Python library to control Amazon devices
-Home-page: https://github.com/chemelli74/aioamazondevices
 License: Apache-2.0
 Author: Simone Chemelli
 Author-email: simone.chemelli@gmail.com
@@ -70,12 +69,22 @@ Install this via pip (or your favourite package manager):
 
 `pip install aioamazondevices`
 
-## Usage
+## Test
 
-Start by importing it:
+Test the library with:
 
-```python
-import aioamazondevices
+`python library_test.py`
+
+The script accept command line arguments or a library_test.json config file:
+
+```json
+{
+  "country": "IT",
+  "email": "<my_address@gmail.com>",
+  "password": "<my_password>",
+  "login_data_file": "out/login_data.json",
+  "save_raw_data": "True"
+}
 ```
 
 ## Contributors ✨

{aioamazondevices-1.0.0 → aioamazondevices-1.2.0}/README.md

@@ -41,12 +41,22 @@ Install this via pip (or your favourite package manager):
 
 `pip install aioamazondevices`
 
-## Usage
+## Test
 
-Start by importing it:
+Test the library with:
 
-```python
-import aioamazondevices
+`python library_test.py`
+
+The script accept command line arguments or a library_test.json config file:
+
+```json
+{
+  "country": "IT",
+  "email": "<my_address@gmail.com>",
+  "password": "<my_password>",
+  "login_data_file": "out/login_data.json",
+  "save_raw_data": "True"
+}
 ```
 
 ## Contributors ✨

{aioamazondevices-1.0.0 → aioamazondevices-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aioamazondevices"
-version = "1.0.0"
+version = "1.2.0"
 description = "Python library to control Amazon devices"
 authors = ["Simone Chemelli <simone.chemelli@gmail.com>"]
 license = "Apache-2.0"

{aioamazondevices-1.0.0 → aioamazondevices-1.2.0}/src/aioamazondevices/__init__.py

@@ -1,6 +1,6 @@
 """aioamazondevices library."""
 
-__version__ = "1.0.0"
+__version__ = "1.2.0"
 
 
 from .api import AmazonDevice, AmazonEchoApi

{aioamazondevices-1.0.0 → aioamazondevices-1.2.0}/src/aioamazondevices/api.py

@@ -14,9 +14,8 @@ from urllib.parse import parse_qs, urlencode
 
 import orjson
 from bs4 import BeautifulSoup, Tag
-from httpx import URL, AsyncClient, Auth, Response
+from httpx import URL, AsyncClient, Response
 
-from .auth import Authenticator
 from .const import (
     _LOGGER,
     AMAZON_APP_BUNDLE_ID,
@@ -98,7 +97,7 @@ class AmazonEchoApi:
         if not self._login_stored_data:
             return {}
 
-        return cast(dict, self._login_stored_data["website_cookies"])
+        return cast("dict", self._login_stored_data["website_cookies"])
 
     def _serial_number(self) -> str:
         """Get or calculate device serial number."""
@@ -109,7 +108,7 @@ class AmazonEchoApi:
 
         _LOGGER.debug("Found previous login data, loading serial number")
         return cast(
-            str,
+            "str",
             self._login_stored_data["device_info"]["device_serial_number"],
         )
 
@@ -207,16 +206,15 @@ class AmazonEchoApi:
         parsed_url = parse_qs(url.query.decode())
         return parsed_url["openid.oa2.authorization_code"][0]
 
-    def _client_session(self, auth: Auth | None = None) -> None:
-        """Create httpx ClientSession."""
+    def _client_session(self) -> None:
+        """Create HTTP client session."""
         if not hasattr(self, "session") or self.session.is_closed:
-            _LOGGER.debug("Creating HTTP ClientSession")
+            _LOGGER.debug("Creating HTTP session (httpx)")
             self.session = AsyncClient(
                 base_url=f"https://www.amazon.{self._domain}",
                 headers=DEFAULT_HEADERS,
                 cookies=self._cookies,
                 follow_redirects=True,
-                auth=auth,
             )
 
     async def _session_request(
@@ -224,19 +222,28 @@ class AmazonEchoApi:
         method: str,
         url: str,
         input_data: dict[str, Any] | None = None,
+        json_data: bool = False,
     ) -> tuple[BeautifulSoup, Response]:
         """Return request response context data."""
-        _LOGGER.debug("%s request: %s with payload %s", method, url, input_data)
+        _LOGGER.debug(
+            "%s request: %s with payload %s [json=%s]",
+            method,
+            url,
+            input_data,
+            json_data,
+        )
         resp = await self.session.request(
             method,
             url,
-            data=input_data,
+            data=input_data if not json_data else orjson.dumps(input_data),
             cookies=self._website_cookies,
+            headers={"Content-Type": "application/json"} if json_data else None,
         )
         content_type: str = resp.headers.get("Content-Type", "")
         _LOGGER.debug(
-            "Response %s with content type: %s",
+            "Response %s for url %s with content type: %s",
             resp.status_code,
+            url,
             content_type,
         )
 
@@ -331,13 +338,12 @@ class AmazonEchoApi:
             ],
         }
 
-        headers = {"Content-Type": "application/json"}
-
         register_url = f"https://api.amazon.{self._domain}/auth/register"
-        resp = await self.session.post(
-            register_url,
-            json=body,
-            headers=headers,
+        _, resp = await self._session_request(
+            method="POST",
+            url=register_url,
+            input_data=body,
+            json_data=True,
         )
         resp_json = resp.json()
 
@@ -398,7 +404,7 @@ class AmazonEchoApi:
         _LOGGER.debug("Build oauth URL")
         login_url = self._build_oauth_url(code_verifier, client_id)
 
-        login_soup, _ = await self._session_request("GET", login_url)
+        login_soup, _ = await self._session_request(method="GET", url=login_url)
         login_method, login_url = self._get_request_from_soup(login_soup)
         login_inputs = self._get_inputs_from_soup(login_soup)
         login_inputs["email"] = self._login_email
@@ -406,13 +412,15 @@ class AmazonEchoApi:
 
         _LOGGER.debug("Register at %s", login_url)
         login_soup, _ = await self._session_request(
-            login_method,
-            login_url,
-            login_inputs,
+            method=login_method,
+            url=login_url,
+            input_data=login_inputs,
         )
 
         if not login_soup.find("input", id="auth-mfa-otpcode"):
-            _LOGGER.debug('Cannot find "auth-mfa-otpcode" in html source')
+            _LOGGER.debug(
+                'Cannot find "auth-mfa-otpcode" in html source [%s]', login_url
+            )
             raise CannotAuthenticate
 
         login_method, login_url = self._get_request_from_soup(login_soup)
@@ -423,9 +431,9 @@ class AmazonEchoApi:
         login_inputs["rememberDevice"] = "false"
 
         login_soup, login_resp = await self._session_request(
-            login_method,
-            login_url,
-            login_inputs,
+            method=login_method,
+            url=login_url,
+            input_data=login_inputs,
         )
 
         authcode_url = None
@@ -457,7 +465,7 @@ class AmazonEchoApi:
         if not self._login_stored_data:
             _LOGGER.debug(
                 "Cannot find previous login data,\
-                    use login_interactive() method instead",
+                    use login_mode_interactive() method instead",
             )
             raise WrongMethod
 
@@ -466,18 +474,14 @@ class AmazonEchoApi:
             self._login_email,
         )
 
-        auth = Authenticator.from_dict(
-            self._login_stored_data,
-            self._domain,
-        )
-        self._client_session(auth)
+        self._client_session()
 
         return self._login_stored_data
 
     async def close(self) -> None:
-        """Close httpx session."""
+        """Close http client session."""
         if hasattr(self, "session"):
-            _LOGGER.debug("Closing httpx session")
+            _LOGGER.debug("Closing HTTP session (httpx)")
             await self.session.aclose()
 
     async def get_devices_data(
@@ -487,8 +491,8 @@ class AmazonEchoApi:
         devices: dict[str, Any] = {}
         for key in URI_QUERIES:
             _, raw_resp = await self._session_request(
-                "GET",
-                f"https://alexa.amazon.{self._domain}{URI_QUERIES[key]}",
+                method="GET",
+                url=f"https://alexa.amazon.{self._domain}{URI_QUERIES[key]}",
             )
             _LOGGER.debug("Response URL: %s", raw_resp.url)
             response_code = raw_resp.status_code
@@ -496,7 +500,7 @@ class AmazonEchoApi:
 
             response_data = raw_resp.text
             _LOGGER.debug("Response data: |%s|", response_data)
-            json_data = {} if len(raw_resp.content) == 0 else raw_resp.json()
+            json_data = {} if len(response_data) == 0 else raw_resp.json()
 
             _LOGGER.debug("JSON data: |%s|", json_data)
 
@@ -532,3 +536,25 @@ class AmazonEchoApi:
             )
 
         return final_devices_list
+
+    async def auth_check_status(self) -> bool:
+        """Check AUTH status."""
+        _, raw_resp = await self._session_request(
+            method="GET",
+            url=f"https://alexa.amazon.{self._domain}/api/bootstrap?version=0",
+        )
+        if raw_resp.status_code != HTTPStatus.OK:
+            _LOGGER.debug(
+                "Session not authenticated: reply error %s",
+                raw_resp.status_code,
+            )
+            return False
+
+        resp_json = raw_resp.json()
+        if not (authentication := resp_json.get("authentication")):
+            _LOGGER.debug('Session not authenticated: reply missing "authentication"')
+            return False
+
+        authenticated = authentication.get("authenticated")
+        _LOGGER.debug("Session authenticated: %s", authenticated)
+        return bool(authenticated)

aioamazondevices-1.0.0/src/aioamazondevices/auth.py

@@ -1,315 +0,0 @@
-"""Custom authentication module for httpx."""
-
-import base64
-from collections.abc import Generator
-from datetime import UTC, datetime, timedelta
-from typing import (
-    Any,
-    cast,
-)
-
-import httpx
-from httpx import Cookies
-from pyasn1.codec.der import decoder
-from pyasn1.type import namedtype, univ
-from rsa import PrivateKey, pkcs1
-
-from .const import _LOGGER, AMAZON_APP_NAME, AMAZON_APP_VERSION
-from .exceptions import (
-    AuthFlowError,
-    AuthMissingAccessToken,
-    AuthMissingRefreshToken,
-    AuthMissingSigningData,
-    AuthMissingTimestamp,
-    AuthMissingWebsiteCookies,
-)
-
-
-def base64_der_to_pkcs1(base64_key: str) -> str:
-    """Convert DER private key to PEM format."""
-
-    class PrivateKeyAlgorithm(univ.Sequence):  # type: ignore[misc]
-        component_type = namedtype.NamedTypes(
-            namedtype.NamedType("algorithm", univ.ObjectIdentifier()),
-            namedtype.NamedType("parameters", univ.Any()),
-        )
-
-    class PrivateKeyInfo(univ.Sequence):  # type: ignore[misc]
-        component_type = namedtype.NamedTypes(
-            namedtype.NamedType("version", univ.Integer()),
-            namedtype.NamedType("pkalgo", PrivateKeyAlgorithm()),
-            namedtype.NamedType("key", univ.OctetString()),
-        )
-
-    encoded_key = base64.b64decode(base64_key)
-    (key_info, _) = decoder.decode(encoded_key, asn1Spec=PrivateKeyInfo())
-    key_octet_string = key_info.components[2]
-    key = PrivateKey.load_pkcs1(key_octet_string, format="DER")
-    return cast(str, key.save_pkcs1().decode("utf-8"))
-
-
-def refresh_access_token(
-    refresh_token: str,
-    domain: str,
-) -> dict[str, Any]:
-    """Refresh an access token."""
-    body = {
-        "app_name": AMAZON_APP_NAME,
-        "app_version": AMAZON_APP_VERSION,
-        "source_token": refresh_token,
-        "requested_token_type": "access_token",
-        "source_token_type": "refresh_token",
-    }
-
-    resp = httpx.post(f"https://api.amazon.{domain}/auth/token", data=body)
-    resp.raise_for_status()
-    resp_dict = resp.json()
-
-    expires_in_sec = int(resp_dict["expires_in"])
-    expires = (datetime.now(UTC) + timedelta(seconds=expires_in_sec)).timestamp()
-
-    return {"access_token": resp_dict["access_token"], "expires": expires}
-
-
-def refresh_website_cookies(
-    refresh_token: str,
-    domain: str,
-) -> dict[str, str]:
-    """Fetch website cookies for a specific domain."""
-    url = f"https://www.amazon.{domain}/ap/exchangetoken/cookies"
-
-    body = {
-        "app_name": AMAZON_APP_NAME,
-        "app_version": AMAZON_APP_VERSION,
-        "source_token": refresh_token,
-        "requested_token_type": "auth_cookies",
-        "source_token_type": "refresh_token",
-        "domain": f".amazon.{domain}",
-    }
-
-    resp = httpx.post(url, data=body)
-    resp.raise_for_status()
-    resp_dict = resp.json()
-
-    raw_cookies = resp_dict["response"]["tokens"]["cookies"]
-    website_cookies = {}
-    for domain_cookies in raw_cookies:
-        for cookie in raw_cookies[domain_cookies]:
-            website_cookies[cookie["Name"]] = cookie["Value"].replace(r'"', r"")
-
-    return website_cookies
-
-
-def user_profile(access_token: str, domain: str) -> dict[str, Any]:
-    """Return Amazon user profile from Amazon."""
-    headers = {"Authorization": f"Bearer {access_token}"}
-
-    resp = httpx.get(f"https://api.amazon.{domain}/user/profile", headers=headers)
-    resp.raise_for_status()
-    profile: dict[str, Any] = resp.json()
-
-    if "user_id" not in profile:
-        raise ValueError("Malformed user profile response.")
-
-    return profile
-
-
-def sign_request(
-    method: str,
-    path: str,
-    body: bytes,
-    adp_token: str,
-    private_key: str,
-) -> dict[str, str]:
-    """Create signed headers for http requests."""
-    date = datetime.now(UTC).isoformat("T") + "Z"
-    str_body = body.decode("utf-8")
-
-    data = f"{method}\n{path}\n{date}\n{str_body}\n{adp_token}"
-
-    key = PrivateKey.load_pkcs1(private_key.encode("utf-8"))
-    cipher = pkcs1.sign(data.encode(), key, "SHA-256")
-    signed_encoded = base64.b64encode(cipher)
-
-    signature = f"{signed_encoded.decode()}:{date}"
-
-    return {
-        "x-adp-token": adp_token,
-        "x-adp-alg": "SHA256withRSA:1.0",
-        "x-adp-signature": signature,
-    }
-
-
-class Authenticator(httpx.Auth):  # type: ignore[misc]
-    """Amazon Authenticator class."""
-
-    access_token: str | None = None
-    activation_bytes: str | None = None
-    adp_token: str | None = None
-    customer_info: dict[str, Any] | None = None
-    device_info: dict[str, Any] | None = None
-    device_private_key: str | None = None
-    expires: float | None = None
-    domain: str
-    refresh_token: str | None = None
-    store_authentication_cookie: dict[str, Any] | None = None
-    website_cookies: dict[str, Any] | None = None
-    requires_request_body: bool = True
-    _forbid_new_attrs: bool = True
-    _apply_test_convert: bool = True
-
-    def update_attrs(self, **kwargs: Any) -> None:  # noqa: ANN401
-        """Update attributes from dict."""
-        for attr, value in kwargs.items():
-            setattr(self, attr, value)
-
-    @classmethod
-    def from_dict(
-        cls,
-        data: dict[str, Any],
-        domain: str,
-    ) -> "Authenticator":
-        """Instantiate an Authenticator from authentication dictionary."""
-        auth = cls()
-
-        auth.domain = domain
-
-        if "login_cookies" in data:
-            auth.website_cookies = data.pop("login_cookies")
-
-        if data["device_private_key"].startswith("MII"):
-            pk_der = data["device_private_key"]
-            data["device_private_key"] = base64_der_to_pkcs1(pk_der)
-
-        auth.update_attrs(**data)
-
-        _LOGGER.info("load data from dictionary for domain %s", auth.domain)
-
-        return auth
-
-    def auth_flow(
-        self,
-        request: httpx.Request,
-    ) -> Generator[httpx.Request, httpx.Response, None]:
-        """Auth flow to be executed on every request by :mod:`httpx`."""
-        available_modes = self.available_auth_modes
-
-        _LOGGER.debug("Auth flow modes: %s", available_modes)
-        if "signing" in available_modes:
-            self._apply_signing_auth_flow(request)
-        elif "bearer" in available_modes:
-            self._apply_bearer_auth_flow(request)
-        else:
-            message = "signing or bearer auth flow are not available."
-            _LOGGER.critical(message)
-            raise AuthFlowError(message)
-
-        yield request
-
-    def _apply_signing_auth_flow(self, request: httpx.Request) -> None:
-        if self.adp_token is None or self.device_private_key is None:
-            raise AuthMissingSigningData
-
-        headers = sign_request(
-            method=request.method,
-            path=request.url.raw_path.decode(),
-            body=request.content,
-            adp_token=self.adp_token,
-            private_key=self.device_private_key,
-        )
-
-        request.headers.update(headers)
-        _LOGGER.info("signing auth flow applied to request")
-
-    def _apply_bearer_auth_flow(self, request: httpx.Request) -> None:
-        if self.access_token_expired:
-            self.refresh_access_token()
-
-        if self.access_token is None:
-            raise AuthMissingAccessToken
-
-        headers = {"Authorization": "Bearer " + self.access_token, "client-id": "0"}
-        request.headers.update(headers)
-        _LOGGER.info("bearer auth flow applied to request")
-
-    def _apply_cookies_auth_flow(self, request: httpx.Request) -> None:
-        if self.website_cookies is None:
-            raise AuthMissingWebsiteCookies
-        cookies = self.website_cookies.copy()
-
-        Cookies(cookies).set_cookie_header(request)
-        _LOGGER.info("cookies auth flow applied to request")
-
-    @property
-    def available_auth_modes(self) -> list[str]:
-        """List available authentication modes."""
-        available_modes = []
-
-        if self.adp_token and self.device_private_key:
-            available_modes.append("signing")
-
-        if self.access_token:
-            if self.access_token_expired and not self.refresh_token:
-                pass
-            else:
-                available_modes.append("bearer")
-
-        if self.website_cookies:
-            available_modes.append("cookies")
-
-        return available_modes
-
-    def refresh_access_token(self, force: bool = False) -> None:
-        """Refresh access token."""
-        if force or self.access_token_expired:
-            if self.refresh_token is None:
-                message = "No refresh token found. Can't refresh access token."
-                _LOGGER.critical(message)
-                raise AuthMissingRefreshToken(message)
-
-            refresh_data = refresh_access_token(
-                refresh_token=self.refresh_token,
-                domain=self.domain,
-            )
-
-            self.update_attrs(**refresh_data)
-        else:
-            _LOGGER.info(
-                "Access Token not expired. No refresh necessary. "
-                "To force refresh please use force=True",
-            )
-
-    def set_website_cookies_for_country(self) -> None:
-        """Set website cookies for country."""
-        if self.refresh_token is None:
-            raise AuthMissingRefreshToken
-
-        self.website_cookies = refresh_website_cookies(
-            self.refresh_token,
-            self.domain,
-        )
-
-    def user_profile(self) -> dict[str, Any]:
-        """Get user profile."""
-        if self.access_token is None:
-            raise AuthMissingAccessToken
-
-        return user_profile(access_token=self.access_token, domain=self.domain)
-
-    @property
-    def access_token_expires(self) -> timedelta:
-        """Time to access token expiration."""
-        if self.expires is None:
-            raise AuthMissingTimestamp
-        return datetime.fromtimestamp(self.expires, UTC) - datetime.now(
-            UTC,
-        )
-
-    @property
-    def access_token_expired(self) -> bool:
-        """Return True if access token is expired."""
-        if self.expires is None:
-            raise AuthMissingTimestamp
-        return datetime.fromtimestamp(self.expires, UTC) <= datetime.now(
-            UTC,
-        )