This repository has been archived on 2020-12-30. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Marcel 1a3b59ed74 added field prop 'reflength' to reference another field as length info 2015-02-24 20:31:27 +01:00
protocols made own schema for layer transition ids and updated protocols and lists 2015-01-04 22:34:34 +01:00
README.md little readme addition 2015-02-24 19:53:21 +01:00
example.yml kwalify structure schema, eth-frame, tcp and a example (which is tcp...) 2015-01-04 11:23:12 +01:00
structure-schema.yml added field prop 'reflength' to reference another field as length info 2015-02-24 20:31:27 +01:00
transition-schema.yml made own schema for layer transition ids and updated protocols and lists 2015-01-04 22:34:34 +01:00

README.md

Network Protocol Dictionary

This is a YAML network protocol dictionary for all (binary based) OSI-Layer 1-4 protocols, eg. Ethernet, IP, TCP, UDP, etc.

  • What this dictionary should be:

    • A complete machine readable structure definition dictionary for all binary based network protocols
    • Addon: some protocol documentation from wikipedia or RFCs for display use.
    • A reference for building a network packet from scratch in an application, mostly for applications dealing with network packets.
  • What it is clearly NOT:

    • Currently: complete.
    • A replacement for reading RFCs: Dependencies and constraints are NOT defined in this dictionary
    • A source for implementing network stacks

How to add a new protocol

  • Clone.
  • Install ruby+kwalify (gem install kwalify).
  • Check structure-schema.yml.
  • Write protocol file in ./protocols/osi[layer]/[protocolname].yml.
  • Validate structure with 'kwalify -lf structure-schema.yml [path/to/protocolname].yml' or validate all at once with 'kwalify -lf structure-schema.yml ./protocols/osi*/*.yml'.
  • Set up a merge request.
  • Be happy.

How to use this dictionary

Currently not recommended, because the project lacks deeper tests than just schema validation. ;)

  • Clone.
  • Get a YAML library for your program language. Or get a converter for JSON or XML, to use these markup languages.
  • Load desired protocol files, or all of them.
  • Use resulting data structures to build protocol packet structures.

This repository will provide examples or useable code snippets for specific programming languages in the future...