iotsploit-protocols 0.0.9__tar.gz

iotsploit_protocols-0.0.9/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: iotsploit-protocols
+Version: 0.0.9
+Summary: Automotive protocol clients and description parsers for IoTSploit
+License: GPL-3.0-or-later
+Keywords: someip,doip,uds,automotive,security,testing
+Author: IoTSploit Team
+Author-email: support@iotsploit.org
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Security
+Requires-Dist: cantools (==42.0.3)
+Requires-Dist: iotsploit-core
+Requires-Dist: psutil (>=5.9)
+Requires-Dist: pydantic (>=2.0)
+Requires-Dist: python-can (>=4.5)
+Requires-Dist: scapy (>=2.6,<3)
+Project-URL: Homepage, https://www.iotsploit.org/
+Project-URL: Repository, https://github.com/TKXB/iotsploit
+Description-Content-Type: text/markdown
+
+# iotsploit-protocols
+
+Automotive protocol clients and description parsers for IoTSploit: SOME/IP,
+DoIP/UDS, and AUTOSAR ARXML.
+
+Nothing in this package reads the IoTSploit database, runtime configuration,
+environment variables, or the current target, and nothing runs `sudo` or
+prompts a human. Clients receive explicit config objects and description
+parsers receive caller-selected files. That is what lets them run under
+Celery, under MCP, in a test, or from a plugin — and what keeps one lab bench's
+IP addresses out of a library.
+
+scapy is used as a **codec, not as a socket**: packets are built and parsed with
+`scapy.contrib.automotive`, but I/O happens on ordinary sockets, so calling a
+method needs no root.
+
+## SOME/IP
+
+Call a method:
+
+```python
+from iotsploit_protocols.someip import SomeIpClient, SomeIpConfig
+
+with SomeIpClient(SomeIpConfig(host="198.18.34.10", port=30509)) as client:
+    response = client.call(service=0x1234, instance=0x0001, method=0x0002, payload=b"\x01")
+    if response.ok:
+        print(response.payload.hex())
+    else:
+        print("refused:", response.return_code_name)
+```
+
+Fire-and-forget:
+
+```python
+client.notify(service=0x1234, instance=0x0001, method=0x0003, payload=b"\x07")
+```
+
+Hear what a segment announces — passive, no traffic generated, no root:
+
+```python
+from iotsploit_protocols.someip import ServiceDiscovery, SdConfig
+
+sd = ServiceDiscovery(SdConfig(group="224.244.224.245", interface="eth0"))
+for offer in sd.listen(timeout=10.0):
+    print(offer.canonical_id, offer.endpoints)   # "1234:0001" [('198.18.34.10', 30509, 'tcp')]
+```
+
+`canonical_id` is the form observations store as `subject_id`, so a discovered
+service joins against the reference catalog without any string munging at the
+call site.
+
+## Configuration from a target
+
+Inside the IoTSploit app, don't build the config by hand — the Django binding
+layer resolves it from the current target's `someip` facet and component
+address:
+
+```python
+from iotsploit_django.adapters.django.protocol_binding import someip_client_for
+
+with someip_client_for("TCAM") as client:
+    ...
+```
+
+An unconfigured target raises `NotConfigured` rather than falling back to a
+built-in address, because a helper that guesses a host probes whatever is at
+that address and reports its silence as a finding.
+
+## Errors
+
+| exception | meaning |
+|---|---|
+| `NotConfigured` | settings are missing — fix the target, not the code |
+| `NegativeResponse` | the peer answered and said no |
+| `ProtocolError` | malformed or unmatchable traffic |
+
+Transport failures are left as stdlib `ConnectionError` / `TimeoutError` rather
+than re-spelled in a new namespace.
+
+## Tests
+
+```bash
+poetry run pytest iotsploit-protocols/tests
+```
+
+No hardware and no network: loopback servers stand in for ECUs.
+

iotsploit_protocols-0.0.9/README.md

@@ -0,0 +1,86 @@
+# iotsploit-protocols
+
+Automotive protocol clients and description parsers for IoTSploit: SOME/IP,
+DoIP/UDS, and AUTOSAR ARXML.
+
+Nothing in this package reads the IoTSploit database, runtime configuration,
+environment variables, or the current target, and nothing runs `sudo` or
+prompts a human. Clients receive explicit config objects and description
+parsers receive caller-selected files. That is what lets them run under
+Celery, under MCP, in a test, or from a plugin — and what keeps one lab bench's
+IP addresses out of a library.
+
+scapy is used as a **codec, not as a socket**: packets are built and parsed with
+`scapy.contrib.automotive`, but I/O happens on ordinary sockets, so calling a
+method needs no root.
+
+## SOME/IP
+
+Call a method:
+
+```python
+from iotsploit_protocols.someip import SomeIpClient, SomeIpConfig
+
+with SomeIpClient(SomeIpConfig(host="198.18.34.10", port=30509)) as client:
+    response = client.call(service=0x1234, instance=0x0001, method=0x0002, payload=b"\x01")
+    if response.ok:
+        print(response.payload.hex())
+    else:
+        print("refused:", response.return_code_name)
+```
+
+Fire-and-forget:
+
+```python
+client.notify(service=0x1234, instance=0x0001, method=0x0003, payload=b"\x07")
+```
+
+Hear what a segment announces — passive, no traffic generated, no root:
+
+```python
+from iotsploit_protocols.someip import ServiceDiscovery, SdConfig
+
+sd = ServiceDiscovery(SdConfig(group="224.244.224.245", interface="eth0"))
+for offer in sd.listen(timeout=10.0):
+    print(offer.canonical_id, offer.endpoints)   # "1234:0001" [('198.18.34.10', 30509, 'tcp')]
+```
+
+`canonical_id` is the form observations store as `subject_id`, so a discovered
+service joins against the reference catalog without any string munging at the
+call site.
+
+## Configuration from a target
+
+Inside the IoTSploit app, don't build the config by hand — the Django binding
+layer resolves it from the current target's `someip` facet and component
+address:
+
+```python
+from iotsploit_django.adapters.django.protocol_binding import someip_client_for
+
+with someip_client_for("TCAM") as client:
+    ...
+```
+
+An unconfigured target raises `NotConfigured` rather than falling back to a
+built-in address, because a helper that guesses a host probes whatever is at
+that address and reports its silence as a finding.
+
+## Errors
+
+| exception | meaning |
+|---|---|
+| `NotConfigured` | settings are missing — fix the target, not the code |
+| `NegativeResponse` | the peer answered and said no |
+| `ProtocolError` | malformed or unmatchable traffic |
+
+Transport failures are left as stdlib `ConnectionError` / `TimeoutError` rather
+than re-spelled in a new namespace.
+
+## Tests
+
+```bash
+poetry run pytest iotsploit-protocols/tests
+```
+
+No hardware and no network: loopback servers stand in for ECUs.

iotsploit_protocols-0.0.9/pyproject.toml

@@ -0,0 +1,46 @@
+[tool.poetry]
+name = "iotsploit-protocols"
+version = "0.0.9"
+description = "Automotive protocol clients and description parsers for IoTSploit"
+authors = ["IoTSploit Team <support@iotsploit.org>"]
+readme = "README.md"
+license = "GPL-3.0-or-later"
+homepage = "https://www.iotsploit.org/"
+repository = "https://github.com/TKXB/iotsploit"
+keywords = ["someip", "doip", "uds", "automotive", "security", "testing"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Topic :: Security",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+packages = [{ include = "iotsploit_protocols", from = "src" }]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+iotsploit-core = "*"
+# SOME/IP service discovery parsing and the DoIP socket both come from
+# scapy.contrib.automotive, which needs 2.5+; 2.6 is what the workspace runs.
+scapy = ">=2.6,<3"
+pydantic = ">=2.0"
+cantools = "42.0.3"
+# Same range iotsploit-drivers already pins. The SocketCAN clients import it
+# lazily so that previewing a frame works on a host with no CAN interface.
+python-can = ">=4.5"
+psutil = ">=5.9"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=8.0"
+
+[build-system]
+requires = ["poetry-core>=1.8.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-q"]

iotsploit_protocols-0.0.9/src/iotsploit_protocols/__init__.py

@@ -0,0 +1,20 @@
+"""Automotive protocol clients and description parsers, free of runtime state.
+
+Nothing here reads the IoTSploit database, environment variables, or the
+current target, and nothing here runs sudo or prompts a human. Inputs are
+explicit config objects or caller-selected description files. That is what
+lets these run under Celery, under MCP, in a test, or from a plugin, and it is
+what keeps one lab bench's IP addresses out of the library.
+
+Importing this package is deliberately cheap: scapy costs hundreds of
+milliseconds and reads host network configuration at import time, so every
+scapy import lives inside the module that needs it rather than here.
+"""
+
+from __future__ import annotations
+
+__version__ = "0.0.9"
+
+__all__ = ["NegativeResponse", "NotConfigured", "ProtocolError"]
+
+from iotsploit_protocols.errors import NegativeResponse, NotConfigured, ProtocolError

iotsploit_protocols-0.0.9/src/iotsploit_protocols/autosar/__init__.py

@@ -0,0 +1,12 @@
+"""AUTOSAR communication-description readers."""
+
+from __future__ import annotations
+
+from iotsploit_protocols.autosar.arxml import (
+    ArxmlImportError,
+    ArxmlImportResult,
+    dump_target,
+    import_arxml,
+)
+
+__all__ = ["ArxmlImportError", "ArxmlImportResult", "dump_target", "import_arxml"]