nanokvm 0.0.1__tar.gz

nanokvm-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

nanokvm-0.0.1/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: nanokvm
+Version: 0.0.1
+Summary: Async client for NanoKVM devices.
+Author-email: puddly <puddly3@gmail.com>
+License: Apache-2.0
+Project-URL: repository, https://github.com/puddly/python-nanokvm
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: cryptography
+Requires-Dist: yarl
+Requires-Dist: pillow
+Provides-Extra: testing
+Requires-Dist: tomli; extra == "testing"
+Requires-Dist: coverage[toml]; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-xdist; extra == "testing"
+Requires-Dist: pytest-asyncio; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: pytest-timeout; extra == "testing"
+Requires-Dist: aioresponses; extra == "testing"
+Dynamic: license-file
+
+# python-nanokvm
+
+Async Python client for [NanoKVM](https://github.com/sipeed/NanoKVM).
+
+## Usage
+
+```python
+
+from aiohttp import ClientSession
+from nanokvm import NanoKVMClient
+
+
+async with ClientSession() as session:
+    client = NanoKVMClient("http://kvm-8b76.local/api/", session)
+    await client.authenticate("username", "password")
+
+    hw_info = await client.get_hardware_info()
+    dev_info = await client.get_device_info()
+    gpio_state = await client.get_gpio_state()
+
+    await client.send_keys("Hello\nworld!")
+
+    async for frame in client.mjpeg_stream():
+        print(frame)
+```

nanokvm-0.0.1/README.md

@@ -0,0 +1,25 @@
+# python-nanokvm
+
+Async Python client for [NanoKVM](https://github.com/sipeed/NanoKVM).
+
+## Usage
+
+```python
+
+from aiohttp import ClientSession
+from nanokvm import NanoKVMClient
+
+
+async with ClientSession() as session:
+    client = NanoKVMClient("http://kvm-8b76.local/api/", session)
+    await client.authenticate("username", "password")
+
+    hw_info = await client.get_hardware_info()
+    dev_info = await client.get_device_info()
+    gpio_state = await client.get_gpio_state()
+
+    await client.send_keys("Hello\nworld!")
+
+    async for frame in client.mjpeg_stream():
+        print(frame)
+```

nanokvm-0.0.1/nanokvm/__init__.py

@@ -0,0 +1,3 @@
+from .client import NanoKVMClient
+
+__all__ = ["NanoKVMClient"]

nanokvm-0.0.1/nanokvm/client.py

@@ -0,0 +1,122 @@
+"""Firmware update client."""
+
+from __future__ import annotations
+
+import asyncio
+from collections.abc import AsyncIterator
+import io
+import logging
+from typing import Any
+
+from aiohttp import ClientSession, MultipartReader
+from PIL import Image
+import yarl
+
+from .utils import obfuscate_password
+
+_LOGGER = logging.getLogger(__name__)
+
+PASTE_CHAR_MAP = set(
+    "\t\n !\"#$%&'()*+,-./0123456789"
+    ":;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    "[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
+)
+
+
+class NanoKVMNotAuthenticated(Exception):
+    pass
+
+
+class NanoKVMApiError(Exception):
+    pass
+
+
+class NanoKVMClient:
+    def __init__(self, url: str, session: ClientSession) -> None:
+        self.url = yarl.URL(url)
+        self.session = session
+        self.token = None
+
+    async def _api(
+        self,
+        method: str,
+        endpoint: str,
+        data: Any | None = None,
+        authenticate: bool = True,
+    ) -> Any:
+        if authenticate and self.token is None:
+            raise NanoKVMNotAuthenticated()
+
+        _LOGGER.debug("Sending API request %s %s: %s", method, endpoint, data)
+
+        async with self.session.request(
+            method=method,
+            url=self.url / endpoint,
+            json=data,
+            raise_for_status=True,
+            cookies={"nano-kvm-token": self.token} if authenticate else None,
+        ) as rsp:
+            api_rsp = await rsp.json()
+
+        _LOGGER.debug("Got API response: %s", api_rsp)
+
+        if api_rsp["code"] != 0:
+            raise NanoKVMApiError(f"API error: {api_rsp}")
+
+        return api_rsp["data"]
+
+    async def authenticate(self, username: str, password: str) -> None:
+        rsp = await self._api(
+            "POST",
+            "auth/login",
+            data={
+                "username": username,
+                "password": obfuscate_password(password),
+            },
+            authenticate=False,
+        )
+        _LOGGER.debug("Authenticated: %s", rsp)
+
+        self.token = rsp["token"]
+
+    async def get_device_info(self) -> Any:
+        return await self._api("GET", "vm/info")
+
+    async def get_hardware_info(self) -> Any:
+        return await self._api("GET", "vm/hardware")
+
+    async def get_gpio_state(self) -> Any:
+        return await self._api("GET", "vm/gpio")
+
+    async def send_wake_on_lan(self, mac: str) -> Any:
+        return await self._api("POST", "network/wol", data={"mac": mac})
+
+    async def mjpeg_stream(self) -> AsyncIterator[Image]:
+        if self.token is None:
+            raise NanoKVMNotAuthenticated()
+
+        async with self.session.get(
+            url=self.url / "stream/mjpeg",
+            raise_for_status=True,
+            cookies={"nano-kvm-token": self.token},
+        ) as rsp:
+            reader = MultipartReader.from_response(rsp)
+            loop = asyncio.get_running_loop()
+
+            while True:
+                part = await reader.next()
+                data = await part.read()
+
+                image = await loop.run_in_executor(
+                    None,
+                    lambda data=data: Image.open(io.BytesIO(data), formats=["JPEG"]),
+                )
+
+                yield image
+
+    async def send_keys(self, text: str) -> Any:
+        invalid_chars = set(text) - PASTE_CHAR_MAP
+        if invalid_chars:
+            raise ValueError(f"Invalid characters in text: {invalid_chars}")
+
+        return await self._api("POST", "hid/paste", data={"content": text})

nanokvm-0.0.1/nanokvm/utils.py

@@ -0,0 +1,54 @@
+import base64
+import hashlib
+import os
+import urllib.parse
+
+from cryptography.hazmat.primitives import padding
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+
+# XXX: this offers no security whatsoever, since this is a symmetric cipher with a
+# PUBLIC key. This is no more or less secure than ROT13.
+SECRET_KEY = b"nanokvm-sipeed-2024"
+
+
+def evp_bytes_to_key_aes256_md5(
+    password: bytes, salt: bytes, *, key_len: int = 32, iv_len: int = 16
+) -> tuple[bytes, bytes]:
+    """OpenSSL's `EVP_BytesToKey` function with a few hardcoded parameters."""
+    derived = b""
+    block = b""
+
+    while len(derived) < key_len + iv_len:
+        block = hashlib.md5(block + password + salt).digest()
+        derived += block
+
+    key = derived[0:key_len]
+    iv = derived[key_len : key_len + iv_len]
+
+    return key, iv
+
+
+def openssl_encrypt_aes256cbc_md5(plaintext: bytes, password: bytes) -> bytes:
+    """Implementation of `CryptoJS.AES.encrypt`."""
+
+    salt = os.urandom(8)
+    key, iv = evp_bytes_to_key_aes256_md5(password, salt)
+
+    padder = padding.PKCS7(128).padder()
+    padded_plaintext = padder.update(plaintext) + padder.finalize()
+
+    cipher = Cipher(algorithms.AES256(key), modes.CBC(iv))
+    encryptor = cipher.encryptor()
+    ciphertext: bytes = encryptor.update(padded_plaintext) + encryptor.finalize()
+
+    return b"Salted__" + salt + ciphertext
+
+
+def obfuscate_password(password: str) -> str:
+    """Obfuscate a password."""
+    password_enc = openssl_encrypt_aes256cbc_md5(
+        plaintext=password.encode("utf-8"),
+        password=SECRET_KEY,
+    )
+
+    return urllib.parse.quote(base64.b64encode(password_enc).decode("utf-8"), safe="")

nanokvm-0.0.1/nanokvm.egg-info/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: nanokvm
+Version: 0.0.1
+Summary: Async client for NanoKVM devices.
+Author-email: puddly <puddly3@gmail.com>
+License: Apache-2.0
+Project-URL: repository, https://github.com/puddly/python-nanokvm
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: cryptography
+Requires-Dist: yarl
+Requires-Dist: pillow
+Provides-Extra: testing
+Requires-Dist: tomli; extra == "testing"
+Requires-Dist: coverage[toml]; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-xdist; extra == "testing"
+Requires-Dist: pytest-asyncio; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: pytest-timeout; extra == "testing"
+Requires-Dist: aioresponses; extra == "testing"
+Dynamic: license-file
+
+# python-nanokvm
+
+Async Python client for [NanoKVM](https://github.com/sipeed/NanoKVM).
+
+## Usage
+
+```python
+
+from aiohttp import ClientSession
+from nanokvm import NanoKVMClient
+
+
+async with ClientSession() as session:
+    client = NanoKVMClient("http://kvm-8b76.local/api/", session)
+    await client.authenticate("username", "password")
+
+    hw_info = await client.get_hardware_info()
+    dev_info = await client.get_device_info()
+    gpio_state = await client.get_gpio_state()
+
+    await client.send_keys("Hello\nworld!")
+
+    async for frame in client.mjpeg_stream():
+        print(frame)
+```

nanokvm-0.0.1/nanokvm.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+nanokvm/__init__.py
+nanokvm/client.py
+nanokvm/models.py
+nanokvm/py.typed
+nanokvm/utils.py
+nanokvm.egg-info/PKG-INFO
+nanokvm.egg-info/SOURCES.txt
+nanokvm.egg-info/dependency_links.txt
+nanokvm.egg-info/requires.txt
+nanokvm.egg-info/top_level.txt
+tests/test_utils.py

nanokvm-0.0.1/nanokvm.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

nanokvm-0.0.1/nanokvm.egg-info/requires.txt

@@ -0,0 +1,14 @@
+aiohttp
+cryptography
+yarl
+pillow
+
+[testing]
+tomli
+coverage[toml]
+pytest
+pytest-xdist
+pytest-asyncio
+pytest-cov
+pytest-timeout
+aioresponses

nanokvm-0.0.1/nanokvm.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+nanokvm

nanokvm-0.0.1/pyproject.toml

@@ -0,0 +1,99 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel", "setuptools-git-versioning<3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "nanokvm"
+dynamic = ["version"]
+description = "Async client for NanoKVM devices."
+urls = {repository = "https://github.com/puddly/python-nanokvm"}
+authors = [
+    {name = "puddly", email = "puddly3@gmail.com"}
+]
+readme = "README.md"
+license = {text = "Apache-2.0"}
+requires-python = ">=3.13"
+dependencies = [
+    "aiohttp",
+    "cryptography",
+    "yarl",
+    "pillow",
+]
+
+[tool.setuptools.packages.find]
+exclude = ["tests", "tests.*"]
+
+[project.optional-dependencies]
+testing = [
+    "tomli",
+    "coverage[toml]",
+    "pytest",
+    "pytest-xdist",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-timeout",
+    "aioresponses",
+]
+
+[tool.setuptools-git-versioning]
+enabled = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+required-version = ">=0.5.0"
+target-version = "py39"
+line-length = 88
+
+exclude = [
+    ".venv",
+    ".git",
+    ".tox",
+    "docs",
+    "venv",
+    "bin",
+    "lib",
+    "deps",
+    "build",
+]
+
+[tool.ruff.lint]
+select = ["E", "F", "UP", "B", "SIM", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*.py" = ["F811"]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = [
+    "nanokvm",
+]
+combine-as-imports = true
+split-on-trailing-comma = false
+
+[tool.codespell]
+ignore-words-list = ["hass"]
+skip = ["./.*", "tests/*", "pyproject.toml"]
+quiet-level = 2
+
+[tool.mypy]
+strict = true
+install_types = true
+non_interactive = true
+show_error_codes = true
+show_error_context = true
+error_summary = true
+
+[tool.coverage.run]
+source = ["nanokvm"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "if typing.TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "raise NotImplementedError()",
+]

nanokvm-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

nanokvm-0.0.1/tests/test_utils.py

@@ -0,0 +1,10 @@
+import pytest
+
+from nanokvm.utils import obfuscate_password
+
+
+@pytest.mark.parametrize(
+    "password", ["something_simple", "Something !@# complex äöü'\""]
+)
+def test_obfuscate_password(password: str) -> None:
+    assert obfuscate_password(password)