secdev / secdev/scapy

[enhancement] Handle CBOR-based protocols in a consistent way

Open
#4,874 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
12.6k
Forks
2.2k
Avg merge
1d 4h
Merged PRs (30d)
56

Description

I am interested in defining some CBOR-based protocols in scapy to take advantage of the good visualization and consistent user-facing interface provided by scapy.

The nice thing about CBOR is that it is composeable, with a sequence of items simply being the concatenation of the encoded forms of those items. But many CBOR-based protocols use array- and map-enveloping of fields as packets, which would need to be dealt with at the scapy integration layer.

I had created some basic field and packet subclasses to do this kind of thing in a scapy_cbor module but this breaks the scapy model of the encoded form being raw bytes (in the case of those classes the encoded form is a Python value which is then cbor2 encoded outside of scapy). I would like to massage this module into a more scapy-friendly one and submit this as a contrib module eventually.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked scapy_cbor module and reviewing Scapy's conventions for contrib modules. Determine how CBOR array and map envelopes can fit Scapy's raw-byte packet model while supporting consistent field and packet behavior; done means a scapy-friendly contrib module suitable for the proposed CBOR-based protocols.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.