Add single layer UDS configuration mode by Copilot · Pull Request #31 · polybassa/scapy-1

Copilot · 2026-04-05T18:10:36Z

- Add split_layers import and orb from scapy.compat - Add 'single_layer_UDS': False to default UDS contribs config - Add _uds_service_cls dict and dispatch_hook classmethod to UDS to support direct dispatch in single layer mode - Add _uds_service(service_id) class decorator that: - Prepends a conditional 'service' field (shown only in single layer mode) - Registers the class in UDS._uds_service_cls dispatch table - Binds the layer to UDS in multi-layer mode - Injects a hashret for single layer mode - Add uds_single_layer_mode(enable) function to toggle modes at runtime - Replace all 55 bind_layers(UDS, ...) calls with @_uds_service(...) decorators Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

- Use len(_pkt) >= 1 instead of truthiness check in dispatch_hook - Add comment explaining _sid closure variable captures by value Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/8125374f-f4ee-41eb-b908-21bc9363a30f Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/98843579-9ca6-43b4-958a-457a46b29a63 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

…anges Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/84433859-6054-4e3c-a058-5bd51c1fcb56 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/6cbead0f-e508-411e-a433-5ba980dfbc5d Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

…yer_mode; use config directly Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/68821df8-a572-42b8-a882-d8026ab945fc Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

…of helper functions Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/68821df8-a572-42b8-a882-d8026ab945fc Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

…ery service packet Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/5dbfa702-3238-4f56-9d29-7868afb27512 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

polybassa · 2026-04-06T17:30:38Z

+    (0x7F, OBD_NR),
+]
+
+for _sid, _cls in _OBD_SERVICES:


Modify the obd service packets explicitly

Done in a8f05e9. Replaced the loop with an explicit block for each OBD service class — fields_desc prepend, bind_layers, and _service_cls registration are now written out individually for all 19 service classes.

polybassa

make the OBD Service modifications explicitly

…stead of loop Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/c30eedc4-0783-44f0-86b8-2a0dcdf0fb75 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot · 2026-04-06T17:36:32Z

make the OBD Service modifications explicitly

Done in a8f05e9 — each OBD service class now has its ConditionalField prepended explicitly, with individual bind_layers() and OBD._service_cls[] statements per class instead of a loop.

polybassa · 2026-04-06T17:45:22Z

@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: GPL-2.0-only


this file is not necessary.

Deleted in c137bec — utils.py has been removed entirely.

polybassa · 2026-04-06T17:45:55Z

+The same API is available for the other protocols — use the ``single_layer_mode``
+config key in the corresponding ``conf.contribs`` entry:
+
+----------+-----------------------------------------------+


simplify this table or remove.

Simplified in c137bec — replaced the per-protocol table with a single-line note: "The same single_layer_mode key works for all protocols: replace 'UDS' with 'KWP', 'OBD', or 'GMLAN' as appropriate." Also removed the bullet-point explanation and the reference to the deleted automotive.utils module.

polybassa · 2026-04-06T17:46:32Z

            return struct.pack('B', self.requestServiceId & ~0x40)
        return struct.pack('B', self.service & ~0x40)

+    _service_cls = {}  # type: ignore


provide the proper type: Dict[int, Type[Packet]]

Fixed in c137bec — _service_cls = {} # type: Dict[int, Type[Packet]] in gmlan.py (and same correction applied to uds.py and kwp.py). Type added to from typing imports in all three files; a from typing block was also added to gmlan.py which had none.

polybassa · 2026-04-06T17:47:48Z

+        return cls

+
+OBD_S01.fields_desc = [


modify the code where the packet is defined initially. not here

Done in c137bec — _OBD_SERVICES dict and _obd_slm function are now defined in services.py. Each OBD service class (OBD_S01, OBD_S02, OBD_S03, OBD_S03_PR, OBD_S04, OBD_S04_PR, OBD_S06, OBD_S07, OBD_S07_PR, OBD_S08, OBD_S09, OBD_S0A, OBD_S0A_PR, OBD_NR) has the ConditionalField directly in its fields_desc. The PR classes in pid/pids.py, iid/iids.py, mid/mids.py, tid/tids.py import _OBD_SERVICES and _obd_slm from services.py and also have the field inline. obd.py now only does bind_layers + _service_cls registration — no post-definition fields_desc manipulation.

polybassa · 2026-04-06T17:47:56Z

 bind_layers(OBD, OBD_S01, service=0x01)
+OBD._service_cls[0x01] = OBD_S01
+
+OBD_S02.fields_desc = [


polybassa · 2026-04-06T17:49:11Z

    fields_desc = [
+        ConditionalField(
+            XByteEnumField('service', 0xa9, GMLAN.services),
+            lambda pkt: conf.contribs['GMLAN'].get('single_layer_mode', False)),


globally define the lambda as function and reuse it. Try to make a one-liner

apply for all other conditional fields

Done in c137bec — defined _uds_slm, _kwp_slm, _gmlan_slm, and _obd_slm as module-level named functions; all 134 ConditionalField calls across UDS (55), KWP (53), GMLAN (26) are now one-liners, e.g. ConditionalField(XByteEnumField('service', 0x10, UDS.services), _uds_slm).

…unctions, OBD ConditionalField in class bodies, simplify doc Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/ce2f23f8-7fa9-462b-b281-7165aad3cb78 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

…r mode Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/d5e15641-5fee-4efa-8436-1e172bb245e4 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

…n tests Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/d5e15641-5fee-4efa-8436-1e172bb245e4 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

polybassa · 2026-04-07T08:56:14Z

 assert len(log) == 2
 assert log[1] == "0x80"
-assert log[0] == "DeviceControlPositiveResponse"
+assert log[0] == "DeviceControlPositiveResponse"


Some unit tests still fail, for example:

Single layer GMLAN mode

###(073)=[failed] Single layer mode: sub-subpacket bindings are unaffected

Fix this one in the CI

Fixed in ea02c8f. The 6-byte test data b'\x52\x01\x00\x01\x02\x03' left only 3 bytes for GMLAN_DTC (which needs 4), causing a dissection exception when conf.debug_dissector = True is active in CI (set globally by uds.py). Changed to b'\x52\x01\x00\x01\x02\x03\x04' (7 bytes) so the full GMLAN_DTC (failureRecordNumber + DTCHighByte + DTCLowByte + DTCFailureType) is valid.

…n SLM mode Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/987a3bb3-9f72-440b-8b2d-7e36a911bb39 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

polybassa

fix flake8 and mypy

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/7880b535-39ac-4795-83a2-06408efc1460 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot · 2026-04-07T09:21:07Z

fix flake8 and mypy

Fixed in b8ed598:

E302: added missing blank line before class GMLAN in gmlan.py and class KWP in kwp.py
E501: split long import lines in iids.py, mids.py, pids.py, and tids.py into multi-line parenthesised imports
F401: removed unused Packet from the obd.py import

All four test suites still pass (UDS 185/185, GMLAN 85/85, KWP 85/85, OBD 107/107).

Copilot AI and others added 4 commits April 5, 2026 17:45

Add single layer UDS config, tests, and documentation

e9467d8

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/8125374f-f4ee-41eb-b908-21bc9363a30f Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Fix uds_single_layer_mode idempotency and clarify test naming

4354e39

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/8125374f-f4ee-41eb-b908-21bc9363a30f Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot AI assigned Copilot and polybassa Apr 5, 2026

Copilot created this pull request from a session on behalf of polybassa April 5, 2026 18:10 View session

Copilot started work on behalf of polybassa April 5, 2026 18:16 View session

Make service decorator and single layer mode generic for KWP, OBD, GMLAN

db73b4a

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/98843579-9ca6-43b4-958a-457a46b29a63 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 5, 2026 18:34

Copilot AI requested a review from polybassa April 5, 2026 18:34

Copilot started work on behalf of polybassa April 5, 2026 18:39 View session

Fix flake8 and mypy issues introduced by generic service decorator ch…

7ea604d

…anges Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/84433859-6054-4e3c-a058-5bd51c1fcb56 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 5, 2026 18:51

Copilot started work on behalf of polybassa April 5, 2026 18:56 View session

Fix remaining flake8 and mypy issues in automotive protocol files

a7517ff

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/6cbead0f-e508-411e-a433-5ba980dfbc5d Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 5, 2026 19:06

Copilot started work on behalf of polybassa April 6, 2026 05:37 View session

Copilot AI and others added 2 commits April 6, 2026 05:45

Remove _make_single_layer_mode helper; rename config key to single_la…

0b07906

…yer_mode; use config directly Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/68821df8-a572-42b8-a882-d8026ab945fc Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Update documentation to reflect single_layer_mode rename and removal …

58162cf

…of helper functions Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/68821df8-a572-42b8-a882-d8026ab945fc Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 6, 2026 05:48

Copilot started work on behalf of polybassa April 6, 2026 17:04 View session

Remove _make_service_decorator; add ConditionalField explicitly in ev…

3fc4bd5

…ery service packet Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/5dbfa702-3238-4f56-9d29-7868afb27512 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 6, 2026 17:24

polybassa reviewed Apr 6, 2026

View reviewed changes

polybassa requested changes Apr 6, 2026

View reviewed changes

Copilot started work on behalf of polybassa April 6, 2026 17:34 View session

Make OBD service ConditionalField modifications explicit per-class in…

a8f05e9

…stead of loop Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/c30eedc4-0783-44f0-86b8-2a0dcdf0fb75 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 6, 2026 17:37

Copilot AI requested a review from polybassa April 6, 2026 17:37

polybassa requested changes Apr 6, 2026

View reviewed changes

Copilot started work on behalf of polybassa April 6, 2026 17:49 View session

Copilot finished work on behalf of polybassa April 6, 2026 18:06

Copilot AI requested a review from polybassa April 6, 2026 18:06

Copilot started work on behalf of polybassa April 6, 2026 18:36 View session

Copilot finished work on behalf of polybassa April 6, 2026 18:42

Copilot started work on behalf of polybassa April 7, 2026 06:05 View session

Copilot AI and others added 2 commits April 7, 2026 06:14

feat: add compatibility_mode flag to UDS, KWP, GMLAN, OBD single-laye…

45e6653

…r mode Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/d5e15641-5fee-4efa-8436-1e172bb245e4 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

fix: use Packet type annotation in _kwp_slm; simplify OBD assertion i…

242ab0d

…n tests Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/d5e15641-5fee-4efa-8436-1e172bb245e4 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 7, 2026 06:18

polybassa requested changes Apr 7, 2026

View reviewed changes

Copilot started work on behalf of polybassa April 7, 2026 08:56 View session

fix: use valid 7-byte test data for GMLAN_RFRDPR sub-subpacket test i…

ea02c8f

…n SLM mode Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/987a3bb3-9f72-440b-8b2d-7e36a911bb39 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot finished work on behalf of polybassa April 7, 2026 09:11

Copilot AI requested a review from polybassa April 7, 2026 09:11

polybassa requested changes Apr 7, 2026

View reviewed changes

Copilot started work on behalf of polybassa April 7, 2026 09:15 View session

fix: resolve flake8 E302/E501/F401 errors in changed automotive files

b8ed598

Agent-Logs-Url: https://github.com/polybassa/scapy-1/sessions/7880b535-39ac-4795-83a2-06408efc1460 Co-authored-by: polybassa <1676055+polybassa@users.noreply.github.com>

Copilot AI requested a review from polybassa April 7, 2026 09:27

Copilot finished work on behalf of polybassa April 7, 2026 09:27

polybassa closed this Apr 10, 2026

Conversation

Copilot AI commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

polybassa left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Single layer GMLAN mode

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

polybassa left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Apr 5, 2026 •

edited

Loading