docs: add a preliminary protocol description #162
Conversation
| @@ -25,7 +25,7 @@ | |||
|
|
|||
| # Add any Sphinx extension module names here, as strings. They can be extensions | |||
| # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |||
| extensions = ['sphinx.ext.intersphinx'] | |||
| extensions = ['sphinx.ext.intersphinx', 'sphinxcontrib.packetdiag'] | |||
There was a problem hiding this comment.
Allows to use packet diagrams. http://blockdiag.com/en/nwdiag/packetdiag-examples.html
docs/protocol.rst
Outdated
| Tunneldigger is only supporting the T bit in the first bit to | ||
| mark a packet as control data. All other fields of RFC3931 | ||
| are ignore and have a different meaning.. | ||
| All fields are encoding as network byte order. |
There was a problem hiding this comment.
| All fields are encoding as network byte order. | |
| All fields are encoded with network byte order. |
|
|
||
| * The T bit must be 1 | ||
| * Version must be 1 | ||
| * Type of the PDU |
There was a problem hiding this comment.
Tunneldigger calls these CONTROL_TYPE or msg_type; that might be more suited terminology.
There was a problem hiding this comment.
Protocol data unit https://en.wikipedia.org/wiki/Protocol_data_unit
There was a problem hiding this comment.
I see. I don't think we use this term anywhere in tunneldigger though?
| 24-31: Version | ||
| 32-39: Type | ||
| 40-47: Length | ||
| 48-63: Value |
There was a problem hiding this comment.
The length of Value is given by Length; why do you write 48-63 here?
There was a problem hiding this comment.
Because it's a packet diagraph. I would like to have a value in there. It's only an example.
There was a problem hiding this comment.
The problem is that it is not at all clear this is just an example. And that makes it very confusing IMO.
| cd tunneldigger/docs/ | ||
| wireshark -Xlua_script:wireshark-tunneldigger.lua | ||
|
|
||
| Wireshark might decode the user data as a different protocol (e.g. Cisco HDLC). This can be changed by: |
There was a problem hiding this comment.
It might be worth also explaining how to change the port; tunneldiger is often run on a port different than 8942.
Describe the protocol using packetdiag.
Add tcpdump pcap filter examples and describe how to use the wireshark dissector.
Describe the protocol using packetdiag.