solarlog-cli 0.5.0__tar.gz → 0.6.1__tar.gz

{solarlog_cli-0.5.0 → solarlog_cli-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: solarlog_cli
-Version: 0.5.0
+Version: 0.6.1
 Summary: Python library to access the Solar-Log
 Project-URL: Repository, https://github.com/dontinelli/solarlog_cli.git
 Project-URL: Issues, https://github.com/dontinelli/solarlog_cli/issues
@@ -15,6 +15,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Requires-Dist: aiohttp
+Requires-Dist: bcrypt>=4.3.0
 Requires-Dist: mashumaro>=3.13
 Description-Content-Type: text/markdown
 

{solarlog_cli-0.5.0 → solarlog_cli-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "solarlog_cli"
-version = "0.5.0"
+version = "0.6.1"
 authors = [
   { name="dontinelli", email="73341522+dontinelli@users.noreply.github.com" },
 ]
@@ -9,6 +9,7 @@ readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
   "aiohttp",
+  "bcrypt>=4.3.0",
   "mashumaro>=3.13",
 ]
 classifiers = [

{solarlog_cli-0.5.0 → solarlog_cli-0.6.1}/requirements.txt

@@ -1,5 +1,6 @@
 aiohttp>=3.9.5
 aioresponses == 0.7.6
+bcrypt >= 4.3.0
 mashumaro>=3.13
 pytest-aio==1.9.0
 pytest-cov==5.0.0

{solarlog_cli-0.5.0 → solarlog_cli-0.6.1}/src/solarlog_cli/solarlog_client.py

@@ -9,6 +9,7 @@ import logging
 from typing import Any
 
 from aiohttp import ClientResponse, ClientSession, ClientTimeout
+import bcrypt
 
 from .solarlog_exceptions import (
     SolarLogAuthenticationError,
@@ -21,6 +22,7 @@ from .solarlog_models import SolarlogData
 SOLARLOG_REQUEST_PAYLOAD = '{ "801": { "170": null } }'
 _LOGGER = logging.getLogger(__name__)
 
+
 class Client:
     """Client class to access Solar-Log."""
 
@@ -29,7 +31,6 @@ class Client:
     def __init__(self, host: str, session: ClientSession | None, password: str = "") -> None:
         self.host: str = host
         self.password: str = password
-        self.token: str = ""
 
         self.request_timeout = 30
 
@@ -38,9 +39,9 @@ class Client:
         else:
             self.session = session
 
+        self._hashed_pwd: bool = False
         self._close_session: bool = True
 
-
     async def test_connection(self) -> bool:
         """Test the connection to Solar-Log."""
         if self.session is None:
@@ -67,21 +68,54 @@ class Client:
 
         payload: str = f"u=user&p={self.password}"
 
-        response = await self.execute_http_request(payload,"login")
+        response = await self.execute_http_request(payload, "login")
 
         text = await response.text()
-        if text.count("FAILED - Password was wrong"):
-            raise SolarLogAuthenticationError
+        _LOGGER.debug("Response: %s", text)
         if text.count("FAILED - User was wrong"):
-            #Response means, that no password is required
+            # Response means, that no password is required
             self.password = ""
             return False
 
-        self.token = response.cookies["SolarLog"].value
+        if text.count("FAILED - Password was wrong"):
+            # For newer firmware, login with encrypted PWD is required.
+            # Therefore test with encrypted PWD and only raise authentication error,
+            # if login with encrypted PWD fails as well.
+
+            payload = '{ "550": None }'
 
-        _LOGGER.debug("response: %s",text)
-        _LOGGER.debug("cookies: %s",response.cookies)
-        _LOGGER.debug("Login successful, token: %s",self.token)
+            response = await self.execute_http_request(payload)
+
+            text = await response.text()
+            _LOGGER.debug("Response to request for user salts: %s", text)
+            r_dict: dict[str, Any] = json.loads(text)
+
+            salt: str = r_dict.get('550', {}).get('104')
+            _LOGGER.debug("Salt to hash pwd: %s", salt)
+
+            try:
+                if salt != 'QUERY IMPOSSIBLE 000' and salt is not None:
+                    hashed_password = bcrypt.hashpw(
+                        self.password.encode(), salt.encode())
+                    payload = f"u=user&p={hashed_password.decode('utf-8')}"
+                    response = await self.execute_http_request(payload, "login")
+                    text = await response.text()
+                    _LOGGER.debug(
+                        "Response of login with hashed pwd: %s", text)
+                    if text.count("FAILED - Password was wrong"):
+                        _LOGGER.debug("Wrong password (hashed)")
+                        raise SolarLogAuthenticationError
+                    self.password = hashed_password.decode('utf-8')
+            except Exception as exception:
+                raise SolarLogAuthenticationError from exception
+
+            self._hashed_pwd = True
+
+        self.session.cookie_jar.update_cookies({"SolarLog": response.cookies["SolarLog"].value})
+
+        _LOGGER.debug("response: %s", text)
+        _LOGGER.debug("cookies: %s", response.cookies)
+        _LOGGER.debug("Login successful, token: %s", response.cookies["SolarLog"].value)
 
         return True
 
@@ -93,12 +127,9 @@ class Client:
 
         url = f"{self.host}/{path}"
 
-        header = {"Content-Type": "text/html"}
-        if self.token != "":
-            header |= {"Cookie": f"SolarLog={self.token}"}
-            body = f"token={self.token}; " + body
+        header = {"Content-Type": "text/html", "X-SL-CSRF-PROTECTION": "1"}
 
-        _LOGGER.debug("HTTP-request header: %s",header)
+        _LOGGER.debug("HTTP-request header: %s", header)
         _LOGGER.debug("HTTP-request body: %s", body)
 
         try:
@@ -123,19 +154,19 @@ class Client:
                 {"Content-Type": content_type, "response": text},
             )
 
-        _LOGGER.debug("HTTP-request successful: %s",response)
+        _LOGGER.debug("HTTP-request successful: %s", response)
         return response
 
     async def parse_http_response(self, response: ClientResponse) -> dict[str, Any]:
         """Helper function to parse the HTTP response."""
 
-        text = await response.text()
-        _LOGGER.debug("Parsing http response: %s",text)
+        text = await response.text(errors="replace")
+        _LOGGER.debug("Parsing http response: %s", text)
 
         if text.count('{"QUERY IMPOSSIBLE 000"}'):
             raise SolarLogUpdateError(f"Server response: {text}")
 
-        if text.count("ACCESS DENIED"):
+        if text.count("ACCESS DENIED") and not text.startswith('{"550":{'):
             raise SolarLogAuthenticationError(f"Server response: {text}")
 
         try:
@@ -158,29 +189,30 @@ class Client:
         raw_data = raw_data["801"]["170"]
 
         data = SolarlogData(
-            last_updated = datetime.strptime(raw_data["100"], "%d.%m.%y %H:%M:%S"),
-            power_ac = raw_data["101"],
-            power_dc = raw_data["102"],
-            voltage_ac = raw_data["103"],
-            voltage_dc = raw_data["104"],
-            yield_day = raw_data["105"],
-            yield_yesterday = raw_data["106"],
-            yield_month = raw_data["107"],
-            yield_year = raw_data["108"],
-            yield_total = raw_data["109"],
-            consumption_ac = raw_data["110"],
-            consumption_day = raw_data["111"],
-            consumption_yesterday = raw_data["112"],
-            consumption_month = raw_data["113"],
-            consumption_year = raw_data["114"],
-            consumption_total = raw_data["115"],
-            total_power = raw_data["116"],
+            last_updated=datetime.strptime(
+                raw_data["100"], "%d.%m.%y %H:%M:%S"),
+            power_ac=raw_data["101"],
+            power_dc=raw_data["102"],
+            voltage_ac=raw_data["103"],
+            voltage_dc=raw_data["104"],
+            yield_day=raw_data["105"],
+            yield_yesterday=raw_data["106"],
+            yield_month=raw_data["107"],
+            yield_year=raw_data["108"],
+            yield_total=raw_data["109"],
+            consumption_ac=raw_data["110"],
+            consumption_day=raw_data["111"],
+            consumption_yesterday=raw_data["112"],
+            consumption_month=raw_data["113"],
+            consumption_year=raw_data["114"],
+            consumption_total=raw_data["115"],
+            total_power=raw_data["116"],
         )
 
         return data
 
     async def get_battery_data(self) -> list[float]:
-        """Get power data from Solar-Log"""
+        """Get battery data from Solar-Log"""
 
         raw_data: dict = await self.parse_http_response(
             await self.execute_http_request('{ "858": null }')
@@ -197,7 +229,8 @@ class Client:
             await self.execute_http_request('{ "782": null }')
         )
 
-        data = {int(key): val for key, val in raw_data["782"].items() if val != "0"}
+        data = {int(key): val for key,
+                val in raw_data["782"].items() if val != "0"}
 
         return data
 

{solarlog_cli-0.5.0 → solarlog_cli-0.6.1}/src/solarlog_cli/solarlog_connector.py

@@ -63,8 +63,13 @@ class SolarLogConnector:
             return False
         except SolarLogAuthenticationError as err:
             #User has no unprotected access to extended API, try to log in
-            _LOGGER.debug("Authentication error: %s", err)
-            self.extended_data = await self.login()
+            #(login returns false, if no pwd is set)
+            _LOGGER.debug("Auth error during test for extended data: %s", err)
+            try:
+                self.extended_data = await self.login()
+            except SolarLogAuthenticationError as error:
+                _LOGGER.debug("Auth error during login in test for extended data: %s", err)
+                raise SolarLogAuthenticationError from error
             _LOGGER.debug("Login successful?: %s", self.extended_data)
         else:
             self.extended_data = True

solarlog_cli-0.6.1/tests/fixtures/user_salts.json

@@ -0,0 +1,16 @@
+{
+    "550": {
+        "100":"ACCESS DENIED",
+        "101":"ACCESS DENIED",
+        "102":"ACCESS DENIED",
+        "103":0,
+        "104":"$2b$08$yw.OTuzhjCHukKjYO0diL.",
+        "105":"ACCESS DENIED",
+        "106":1,
+        "107":"SALT2",
+        "108":"ACCESS DENIED",
+        "109":0,"110":"SALT3",
+        "111":"ACCESS DENIED",
+        "112":1
+    }
+}

{solarlog_cli-0.5.0 → solarlog_cli-0.6.1}/tests/test_solarlog_cli.py

@@ -58,7 +58,8 @@ async def test_existing_session(
         status=200,
     )
 
-    solarlog_connector = SolarLogConnector("localhost", session=ClientSession())
+    solarlog_connector = SolarLogConnector(
+        "localhost", session=ClientSession())
 
     assert await solarlog_connector.test_connection()
 
@@ -69,12 +70,14 @@ async def test_existing_session(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_extended_data_available(
     responses: aioresponses,
 ) -> None:
     """Test extended data available."""
 
-    solarlog_connector = SolarLogConnector("http://solarlog.com", password="pwd")
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
 
     responses.post(
         "http://solarlog.com/getjp",
@@ -99,6 +102,27 @@ async def test_extended_data_available(
     assert not await solarlog_connector.test_extended_data_available()
     assert solarlog_connector.password == ""
 
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("device_list_access_denied.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        body="FAILED - Password was wrong",
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("user_salts.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        exception=SolarLogAuthenticationError('test'),
+    )
+    solarlog_connector.client.password = "pwd"
+    # type: ignore [call-overload]
+    with pytest.raises(SolarLogAuthenticationError):
+        await solarlog_connector.test_extended_data_available()
+
     responses.post(
         "http://solarlog.com/getjp",
         body=load_fixture("device_list.json"),
@@ -108,6 +132,7 @@ async def test_extended_data_available(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_login_and_data_retreival(responses: aioresponses) -> None:
     """Test login into Solar-Log."""
     responses.post(
@@ -115,10 +140,10 @@ async def test_login_and_data_retreival(responses: aioresponses) -> None:
         headers={"Set-Cookie": "SolarLog=token"},
         body="SUCCESS - Password was correct, you are now logged in",
     )
-    solarlog_connector = SolarLogConnector("http://solarlog.com", password="pwd")
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
 
     assert await solarlog_connector.login()
-    assert solarlog_connector.client.token == "token"
 
     responses.post(
         "http://solarlog.com/getjp",
@@ -129,15 +154,51 @@ async def test_login_and_data_retreival(responses: aioresponses) -> None:
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
+async def test_login_hashed_pwd(responses: aioresponses) -> None:
+    """Test login into Solar-Log."""
+
+    responses.post(
+        "http://solarlog.com/login",
+        body="FAILED - Password was wrong",
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("user_salts.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        headers={"Set-Cookie": "SolarLog=token"},
+        body="SUCCESS - Password was correct, you are now logged in",
+    )
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
+
+    assert await solarlog_connector.login()
+
+    await solarlog_connector.client.close()
+    assert solarlog_connector.client.session.closed
+
+
 async def test_login_exceptions(responses: aioresponses) -> None:
     """Test exceptions at login into Solar-Log."""
-    solarlog_connector = SolarLogConnector("http://solarlog.com", password="pwd")
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
 
     responses.post(
         "http://solarlog.com/login",
         body="FAILED - Password was wrong",
     )
-    with pytest.raises(SolarLogAuthenticationError):  # type: ignore [call-overload]
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("user_salts.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        body="FAILED - Password was wrong",
+    )
+    # type: ignore [call-overload]
+    with pytest.raises(SolarLogAuthenticationError):
         await solarlog_connector.client.login()
 
     responses.post(
@@ -155,6 +216,7 @@ async def test_login_exceptions(responses: aioresponses) -> None:
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_update_data(
     responses: aioresponses,
     snapshot: SnapshotAssertion
@@ -195,6 +257,7 @@ async def test_update_data(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_update_data_without_battery(
     responses: aioresponses,
 ) -> None:
@@ -234,6 +297,7 @@ async def test_update_data_without_battery(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 @pytest.mark.parametrize(
     ("status", "request_timeout", "error"),
     [
@@ -364,11 +428,13 @@ async def test_enabled_devices(responses: aioresponses) -> None:
         body=load_fixture("device_list.json"),
     )
 
-    solarlog_connector = SolarLogConnector("http://solarlog.com",device_enabled={})
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", device_enabled={})
     assert solarlog_connector.device_enabled() == {}
     assert await solarlog_connector.update_device_list() == {}
 
-    solarlog_connector.set_enabled_devices({0: True, 1: False, 2: False, 3: True})
+    solarlog_connector.set_enabled_devices(
+        {0: True, 1: False, 2: False, 3: True})
 
     assert solarlog_connector.device_enabled(0)
     assert not solarlog_connector.device_enabled(1)