소스 검색

waterutil: doc.go: added packet format diagrams

Song Gao 12 년 전
부모
커밋
f2108081c5
1개의 변경된 파일50개의 추가작업 그리고 1개의 파일을 삭제
  1. 50 1
      waterutil/doc.go

+ 50 - 1
waterutil/doc.go

@@ -1,2 +1,51 @@
-// Package waterutil provides utility functions for interpreting MAC farme headers and IP packet headers. It defines some constants such as protocol numbers and ethernet frame types. Use waterutil along with package water to work with TUN/TAP interface data.
+/*
+Package waterutil provides utility functions for interpreting TUN/TAP MAC farme headers and IP packet headers. It defines some constants such as protocol numbers and ethernet frame types. Use waterutil along with package water to work with TUN/TAP interface data.
+
+Frames/packets are interpreted in following format (as in TUN/TAP devices):
+
+TAP - MAC Frame:
+   No Tagging
+  +-----------------------------------------------------------------------------
+  | Octet |00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|...
+  +-----------------------------------------------------------------------------
+  | Field | MAC Destination |   MAC  Source   |EType| Payload        
+  +-----------------------------------------------------------------------------
+
+   Single-Tagged -- Octets [12,13] == {0x81, 0x00} 
+  +-----------------------------------------------------------------------------
+  | Octet |00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|...
+  +-----------------------------------------------------------------------------
+  | Field | MAC Destination |   MAC  Source   |    Tag    | Payload
+  +-----------------------------------------------------------------------------
+
+   Double-Tagged -- Octets [12,13] == {0x88, 0xA8}
+  +-----------------------------------------------------------------------------
+  | Octet |00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|...
+  +-----------------------------------------------------------------------------
+  | Field | MAC Destination |   MAC  Source   | Outer Tag | Inner Tag | Payload        
+  +-----------------------------------------------------------------------------
+
+TUN - IPv4 Packet:
+  +-----------------------------------------------------------------------------------------------------------------+
+  | Offsets | Octet |           0           |           1           |           2           |           3           |
+  |  Octet  |  Bit  |00|01|02|03|04|05|06|07|08|09|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|
+  +-----------------------------------------------------------------------------------------------------------------+
+  |    0    |   0   |  Version  |    IHL    |      DSCP       | ECN |                 Total  Length                 |
+  +-----------------------------------------------------------------------------------------------------------------+
+  |    4    |  32   |                Identification                 | Flags  |           Fragment Offset            |
+  +-----------------------------------------------------------------------------------------------------------------+
+  |    8    |  64   |     Time To Live      |       Protocol        |                Header Checksum                |
+  +-----------------------------------------------------------------------------------------------------------------+
+  |   12    |  96   |                                       Source IP Address                                       |
+  +-----------------------------------------------------------------------------------------------------------------+
+  |   16    |  128  |                                    Destination IP Address                                     |
+  +-----------------------------------------------------------------------------------------------------------------+
+  |   20    |  160  |                                     Options (if IHL > 5)                                      |
+  +-----------------------------------------------------------------------------------------------------------------+
+  |   24    |  192  |                                                                                               |
+  |   30    |  224  |                                            Payload                                            |
+  |   ...   |  ...  |                                                                                               |
+  +-----------------------------------------------------------------------------------------------------------------+
+
+*/
 package waterutil