9323bbe11a9478159b9c1961ea5cff7974b86974
[obnox/wireshark/wip.git] / packet.h
1 /* packet.h
2  * Definitions for packet disassembly structures and routines
3  *
4  * $Id: packet.h,v 1.20 1998/10/16 06:46:55 guy Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@zing.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * 
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  * 
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  * 
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26
27 #ifndef __PACKET_H__
28 #define __PACKET_H__
29
30 /* Pointer versions of ntohs and ntohl.  Given a pointer to a member of a
31  * byte array, returns the value of the two or four bytes at the pointer.
32  * The pletoh[sl] versions return the little-endian representation.
33  */
34
35 #define pntohs(p)  ((guint16)                       \
36                     ((guint16)*((guint8 *)p+0)<<8|  \
37                      (guint16)*((guint8 *)p+1)<<0))
38
39 #define pntohl(p)  ((guint32)*((guint8 *)p+0)<<24|  \
40                     (guint32)*((guint8 *)p+1)<<16|  \
41                     (guint32)*((guint8 *)p+2)<<8|   \
42                     (guint32)*((guint8 *)p+3)<<0)
43
44 #define pletohs(p) ((guint16)                       \
45                     ((guint16)*((guint8 *)p+1)<<8|  \
46                      (guint16)*((guint8 *)p+0)<<0))
47
48 #define pletohl(p) ((guint32)*((guint8 *)p+3)<<24|  \
49                     (guint32)*((guint8 *)p+2)<<16|  \
50                     (guint32)*((guint8 *)p+1)<<8|   \
51                     (guint32)*((guint8 *)p+0)<<0)
52
53
54 /* Useful when highlighting regions inside a dissect_*() function. With this
55  * macro, you can highlight from the start of the packet to the end of the
56  * frame. See dissect_data() for an example.
57  */
58 #define END_OF_FRAME    (fd->cap_len - offset)
59
60 #define IEEE_802_3_MAX_LEN 1500
61 #define BYTE_VIEW_WIDTH    16
62
63 typedef struct _frame_data {
64   guint32  pkt_len;         /* Packet length */
65   guint32  cap_len;         /* Amount actually captured */
66   guint32  secs;            /* Seconds */
67   guint32  usecs;           /* Microseconds */
68   long     file_off;        /* File offset */
69   gchar   *win_info[NUM_COLS]; /* Text for packet summary list fields */
70 } frame_data;
71
72 typedef struct _packet_info {
73   char *srcip;
74   int ip_src;
75   char *destip;
76   int ipproto;
77   int srcport;
78   int destport;
79   int iplen;
80   int iphdrlen;
81 } packet_info;
82
83 /* Struct for the match_strval function */
84
85 typedef struct _value_string {
86   guint32  value;
87   gchar   *strptr;
88 } value_string;
89
90 /* Many of the structs and definitions below were taken from include files
91  * in the Linux distribution. */
92
93 /* ARP / RARP structs and definitions */
94
95 typedef struct _e_ether_arp {
96   guint16 ar_hrd;
97   guint16 ar_pro;
98   guint8  ar_hln;
99   guint8  ar_pln;
100   guint16 ar_op;
101   guint8  arp_sha[6];
102   guint8  arp_spa[4];
103   guint8  arp_tha[6];
104   guint8  arp_tpa[4];
105 } e_ether_arp;
106
107 #ifndef ARPOP_REQUEST
108 #define ARPOP_REQUEST  1       /* ARP request.  */
109 #endif
110 #ifndef ARPOP_REPLY
111 #define ARPOP_REPLY    2       /* ARP reply.  */
112 #endif
113 /* Some OSes have different names, or don't define these at all */
114 #ifndef ARPOP_RREQUEST
115 #define ARPOP_RREQUEST 3       /* RARP request.  */
116 #endif
117 #ifndef ARPOP_RREPLY
118 #define ARPOP_RREPLY   4       /* RARP reply.  */
119 #endif
120
121 /* ICMP structs and definitions */
122
123 typedef struct _e_icmp {
124   guint8  icmp_type;
125   guint8  icmp_code;
126   guint16 icmp_cksum;
127   union {
128     struct {  /* Address mask request/reply */
129       guint16 id;
130       guint16 seq;
131       guint32 sn_mask;
132     } am;
133     struct {  /* Timestap request/reply */
134       guint16 id;
135       guint16 seq;
136       guint32 orig;
137       guint32 recv;
138       guint32 xmit;
139     } ts;
140     guint32 zero;  /* Unreachable */
141   } opt;
142 } e_icmp;
143
144 #define ICMP_ECHOREPLY     0
145 #define ICMP_UNREACH       3
146 #define ICMP_SOURCEQUENCH  4
147 #define ICMP_REDIRECT      5
148 #define ICMP_ECHO          8
149 #define ICMP_TIMXCEED     11
150 #define ICMP_PARAMPROB    12
151 #define ICMP_TSTAMP       13
152 #define ICMP_TSTAMPREPLY  14
153 #define ICMP_IREQ         15
154 #define ICMP_IREQREPLY    16
155 #define ICMP_MASKREQ      17
156 #define ICMP_MASKREPLY    18
157
158 /* IGMP structs and definitions */
159
160 typedef struct _e_igmp {
161 #if BYTE_ORDER == BIG_ENDIAN
162   guint8  igmp_v:4;
163   guint8  igmp_t:4;
164 #else /* Little endian */
165   guint8  igmp_t:4;
166   guint8  igmp_v:4;
167 #endif
168   guint8  igmp_unused;
169   guint16 igmp_cksum;
170   guint32 igmp_gaddr;
171 } e_igmp;
172
173 #define IGMP_M_QRY     0x01
174 #define IGMP_V1_M_RPT  0x02
175 #define IGMP_V2_LV_GRP 0x07
176 #define IGMP_DVMRP     0x03
177 #define IGMP_PIM       0x04
178 #define IGMP_V2_M_RPT  0x06
179 #define IGMP_MTRC_RESP 0x1e
180 #define IGMP_MTRC      0x1f
181
182 /* IP structs and definitions */
183
184 typedef struct _e_ip {
185 #if BYTE_ORDER == BIG_ENDIAN
186   guint8  ip_v:4;
187   guint8  ip_hl:4;
188 #else /* Little endian */
189   guint8  ip_hl:4;
190   guint8  ip_v:4;
191 #endif
192   guint8  ip_tos;
193   guint16 ip_len;
194   guint16 ip_id;
195   guint16 ip_off;
196   guint8  ip_ttl;
197   guint8  ip_p;
198   guint16 ip_sum;
199   guint32 ip_src;
200   guint32 ip_dst;
201 } e_ip;
202
203 /* IP flags. */
204 #define IP_CE           0x8000          /* Flag: "Congestion"           */
205 #define IP_DF           0x4000          /* Flag: "Don't Fragment"       */
206 #define IP_MF           0x2000          /* Flag: "More Fragments"       */
207 #define IP_OFFSET       0x1FFF          /* "Fragment Offset" part       */
208
209 #define IPTOS_TOS_MASK    0x1E
210 #define IPTOS_TOS(tos)    ((tos) & IPTOS_TOS_MASK)
211 #define IPTOS_NONE        0x00
212 #define IPTOS_LOWDELAY    0x10
213 #define IPTOS_THROUGHPUT  0x08
214 #define IPTOS_RELIABILITY 0x04
215 #define IPTOS_LOWCOST     0x02
216
217 #define IPTOS_PREC_MASK         0xE0
218 #define IPTOS_PREC(tos)         ((tos)&IPTOS_PREC_MASK)
219 #define IPTOS_PREC_NETCONTROL           0xe0
220 #define IPTOS_PREC_INTERNETCONTROL      0xc0
221 #define IPTOS_PREC_CRITIC_ECP           0xa0
222 #define IPTOS_PREC_FLASHOVERRIDE        0x80
223 #define IPTOS_PREC_FLASH                0x60
224 #define IPTOS_PREC_IMMEDIATE            0x40
225 #define IPTOS_PREC_PRIORITY             0x20
226 #define IPTOS_PREC_ROUTINE              0x00
227
228 /* IP options */
229 #define IPOPT_COPY              0x80
230
231 #define IPOPT_CONTROL           0x00
232 #define IPOPT_RESERVED1         0x20
233 #define IPOPT_MEASUREMENT       0x40
234 #define IPOPT_RESERVED2         0x60
235
236 #define IPOPT_END       (0 |IPOPT_CONTROL)
237 #define IPOPT_NOOP      (1 |IPOPT_CONTROL)
238 #define IPOPT_SEC       (2 |IPOPT_CONTROL|IPOPT_COPY)
239 #define IPOPT_LSRR      (3 |IPOPT_CONTROL|IPOPT_COPY)
240 #define IPOPT_TIMESTAMP (4 |IPOPT_MEASUREMENT)
241 #define IPOPT_RR        (7 |IPOPT_CONTROL)
242 #define IPOPT_SID       (8 |IPOPT_CONTROL|IPOPT_COPY)
243 #define IPOPT_SSRR      (9 |IPOPT_CONTROL|IPOPT_COPY)
244 #define IPOPT_RA        (20|IPOPT_CONTROL|IPOPT_COPY)
245
246 /* IP option lengths */
247 #define IPOLEN_SEC      11
248 #define IPOLEN_LSRR_MIN 3
249 #define IPOLEN_TIMESTAMP_MIN 5
250 #define IPOLEN_RR_MIN   3
251 #define IPOLEN_SID      4
252 #define IPOLEN_SSRR_MIN 3
253
254 #define IPSEC_UNCLASSIFIED      0x0000
255 #define IPSEC_CONFIDENTIAL      0xF135
256 #define IPSEC_EFTO              0x789A
257 #define IPSEC_MMMM              0xBC4D
258 #define IPSEC_RESTRICTED        0xAF13
259 #define IPSEC_SECRET            0xD788
260 #define IPSEC_TOPSECRET         0x6BC5
261 #define IPSEC_RESERVED1         0x35E2
262 #define IPSEC_RESERVED2         0x9AF1
263 #define IPSEC_RESERVED3         0x4D78
264 #define IPSEC_RESERVED4         0x24BD
265 #define IPSEC_RESERVED5         0x135E
266 #define IPSEC_RESERVED6         0x89AF
267 #define IPSEC_RESERVED7         0xC4D6
268 #define IPSEC_RESERVED8         0xE26B
269
270 #define IPOPT_TS_TSONLY         0               /* timestamps only */
271 #define IPOPT_TS_TSANDADDR      1               /* timestamps and addresses */
272 #define IPOPT_TS_PRESPEC        3               /* specified modules only */
273
274 #define IP_PROTO_ICMP  1
275 #define IP_PROTO_IGMP  2
276 #define IP_PROTO_TCP   6
277 #define IP_PROTO_UDP  17
278 #define IP_PROTO_OSPF 89
279
280 /* Null/loopback structs and definitions */
281
282 typedef struct _e_nullhdr {
283   guint8  null_next;
284   guint8  null_len;
285   guint16 null_family;
286 } e_nullhdr;
287
288 /* PPP structs and definitions */
289
290 typedef struct _e_ppphdr {
291   guint8  ppp_addr;
292   guint8  ppp_ctl;
293   guint16 ppp_prot;
294 } e_ppphdr;
295
296 /* TCP structs and definitions */
297
298 typedef struct _e_tcphdr {
299   guint16 th_sport;
300   guint16 th_dport;
301   guint32 th_seq;
302   guint32 th_ack;
303 #if BYTE_ORDER == LITTLE_ENDIAN
304   guint8  th_x2:4;
305   guint8  th_off:4;
306 #else
307   guint8  th_off:4;
308   guint8  th_x2:4;
309 #endif
310   guint8  th_flags;
311 #define TH_FIN  0x01
312 #define TH_SYN  0x02
313 #define TH_RST  0x04
314 #define TH_PUSH 0x08
315 #define TH_ACK  0x10
316 #define TH_URG  0x20
317   guint16 th_win;
318   guint16 th_sum;
319   guint16 th_urp;
320 } e_tcphdr;
321
322 /*
323  *      TCP option
324  */
325  
326 #define TCPOPT_NOP              1       /* Padding */
327 #define TCPOPT_EOL              0       /* End of options */
328 #define TCPOPT_MSS              2       /* Segment size negotiating */
329 #define TCPOPT_WINDOW           3       /* Window scaling */
330 #define TCPOPT_SACK_PERM        4       /* SACK Permitted */
331 #define TCPOPT_SACK             5       /* SACK Block */
332 #define TCPOPT_ECHO             6
333 #define TCPOPT_ECHOREPLY        7
334 #define TCPOPT_TIMESTAMP        8       /* Better RTT estimations/PAWS */
335 #define TCPOPT_CC               11
336 #define TCPOPT_CCNEW            12
337 #define TCPOPT_CCECHO           13
338
339 /*
340  *     TCP option lengths
341  */
342
343 #define TCPOLEN_MSS            4
344 #define TCPOLEN_WINDOW         3
345 #define TCPOLEN_SACK_PERM      2
346 #define TCPOLEN_SACK_MIN       2
347 #define TCPOLEN_ECHO           6
348 #define TCPOLEN_ECHOREPLY      6
349 #define TCPOLEN_TIMESTAMP      10
350 #define TCPOLEN_CC             6
351 #define TCPOLEN_CCNEW          6
352 #define TCPOLEN_CCECHO         6
353
354 /* UDP structs and definitions */
355
356 typedef struct _e_udphdr {
357   guint16 uh_sport;
358   guint16 uh_dport;
359   guint16 uh_ulen;
360   guint16 uh_sum;
361 } e_udphdr;
362
363 /* UDP Ports -> should go in packet-udp.h */
364
365 #define UDP_PORT_DNS     53
366 #define UDP_PORT_BOOTPS  67
367 #define UDP_PORT_IPX    213
368 #define UDP_PORT_NBNS   137
369 #define UDP_PORT_RIP    520
370
371 /* TCP Ports */
372
373 #define TCP_PORT_PRINTER 515
374
375 /* Tree types.  Each dissect_* routine should have one for each
376    add_subtree() call. */
377
378 enum {
379         ETT_FRAME,
380         ETT_IEEE8023,
381         ETT_ETHER2,
382         ETT_LLC,
383         ETT_TOKEN_RING,
384         ETT_TR_IERR_CNT,
385         ETT_TR_NERR_CNT,
386         ETT_TR_MAC,
387         ETT_PPP,
388         ETT_ARP,
389         ETT_FDDI,
390         ETT_NULL,
391         ETT_IP,
392         ETT_IP_OPTIONS,
393         ETT_IP_OPTION_SEC,
394         ETT_IP_OPTION_ROUTE,
395         ETT_IP_OPTION_TIMESTAMP,
396         ETT_UDP,
397         ETT_TCP,
398         ETT_TCP_OPTIONS,
399         ETT_TCP_OPTION_SACK,
400         ETT_ICMP,
401         ETT_IGMP,
402         ETT_IPX,
403         ETT_SPX,
404         ETT_NCP,
405         ETT_DNS,
406         ETT_DNS_QRY,
407         ETT_DNS_QD,
408         ETT_DNS_ANS,
409         ETT_DNS_RR,
410         ETT_RIP,
411         ETT_RIP_VEC,
412         ETT_OSPF,
413         ETT_OSPF_HDR,
414         ETT_OSPF_HELLO,
415         ETT_OSPF_DESC,
416         ETT_OSPF_LSR,
417         ETT_OSPF_LSA_UPD,
418         ETT_OSPF_LSA,
419         ETT_LPD,
420         ETT_RAW,
421         ETT_BOOTP,
422         ETT_BOOTP_OPTION,
423         ETT_IPv6,
424         ETT_CLNP,
425         ETT_COTP,
426         ETT_VINES,
427         ETT_VSPP,
428         ETT_IPXRIP,
429         ETT_IPXSAP,
430         ETT_IPXSAP_SERVER,
431         ETT_NBNS,
432         ETT_NBNS_QRY,
433         ETT_NBNS_QD,
434         ETT_NBNS_ANS,
435         ETT_NBNS_RR,
436         ETT_NBIPX,
437         ETT_AARP,
438         NUM_TREE_TYPES  /* last item number plus one */
439 };
440
441 /* The version of pcap.h that comes with some systems is missing these
442  * #defines.
443  */
444
445 #ifndef DLT_RAW
446 #define DLT_RAW 12
447 #endif
448
449 #ifndef DLT_SLIP_BSDOS
450 #define DLT_SLIP_BSDOS 13
451 #endif
452
453 #ifndef DLT_PPP_BSDOS
454 #define DLT_PPP_BSDOS 14
455 #endif
456
457 typedef enum {
458   NO_LENGTH,            /* option has no data, hence no length */
459   FIXED_LENGTH,         /* option always has the same length */
460   VARIABLE_LENGTH       /* option is variable-length - optlen is minimum */
461 } opt_len_type;
462
463 /* Member of table of IP or TCP options. */
464 typedef struct {
465   int   optcode;        /* code for option */
466   char *name;           /* name of option */
467   opt_len_type len_type; /* type of option length field */
468   int   optlen;         /* value length should be (minimum if VARIABLE) */
469   void  (*dissect)(GtkWidget *, const char *, const u_char *, int, guint);
470                         /* routine to dissect option */
471 } ip_tcp_opt;
472
473 /* Routine to dissect IP or TCP options. */
474 void       dissect_ip_tcp_options(GtkWidget *, const u_char *, int, guint,
475     ip_tcp_opt *, int, int);
476
477 /* Utility routines used by packet*.c */
478 gchar*     ether_to_str(guint8 *);
479 gchar*     ip_to_str(guint8 *);
480 void       packet_hex_print(GtkText *, guint8 *, gint, gint, gint);
481 #define E_TREEINFO_START_KEY "tree_info_start"
482 #define E_TREEINFO_LEN_KEY   "tree_info_len"
483 #if __GNUC__ == 2
484 GtkWidget* add_item_to_tree(GtkWidget *, gint, gint, gchar *, ...)
485     __attribute__((format (printf, 4, 5)));
486 #else
487 GtkWidget* add_item_to_tree(GtkWidget *, gint, gint, gchar *, ...);
488 #endif
489 gchar*     match_strval(guint32, value_string*);
490
491 /* Routines in packet.c */
492
493 void dissect_packet(const u_char *, guint32 ts_secs, guint32 ts_usecs,
494   frame_data *, GtkTree *);
495 void add_subtree(GtkWidget *, GtkWidget*, gint);
496 void expand_tree(GtkWidget *, gpointer);
497 void collapse_tree(GtkWidget *, gpointer);
498
499 /*
500  * Routines in packet-*.c
501  * Routines should take three args: packet data *, frame_data *, tree *
502  * They should never modify the packet data.
503  */
504 void dissect_eth(const u_char *, frame_data *, GtkTree *);
505 void dissect_fddi(const u_char *, frame_data *, GtkTree *);
506 void dissect_null(const u_char *, frame_data *, GtkTree *);
507 void dissect_ppp(const u_char *, frame_data *, GtkTree *);
508 void dissect_raw(const u_char *, frame_data *, GtkTree *);
509 void dissect_tr(const u_char *, frame_data *, GtkTree *);
510
511 /*
512  * Routines in packet-*.c
513  * Routines should take four args: packet data *, offset, frame_data *,
514  * tree *
515  * They should never modify the packet data.
516  */
517 void dissect_aarp(const u_char *, int, frame_data *, GtkTree *);
518 void dissect_arp(const u_char *, int, frame_data *, GtkTree *);
519 void dissect_bootp(const u_char *, int, frame_data *, GtkTree *);
520 void dissect_data(const u_char *, int, frame_data *, GtkTree *);
521 void dissect_ddp(const u_char *, int, frame_data *, GtkTree *);
522 void dissect_dns(const u_char *, int, frame_data *, GtkTree *);
523 void dissect_icmp(const u_char *, int, frame_data *, GtkTree *);
524 void dissect_igmp(const u_char *, int, frame_data *, GtkTree *);
525 void dissect_ip(const u_char *, int, frame_data *, GtkTree *);
526 void dissect_ipv6(const u_char *, int, frame_data *, GtkTree *);
527 void dissect_ipx(const u_char *, int, frame_data *, GtkTree *);
528 void dissect_llc(const u_char *, int, frame_data *, GtkTree *);
529 void dissect_lpd(const u_char *, int, frame_data *, GtkTree *);
530 void dissect_nbipx_ns(const u_char *, int, frame_data *, GtkTree *);
531 void dissect_nbns(const u_char *, int, frame_data *, GtkTree *);
532 void dissect_ncp(const u_char *, int, frame_data *, GtkTree *);
533 void dissect_nwlink_dg(const u_char *, int, frame_data *, GtkTree *);
534 void dissect_osi(const u_char *, int, frame_data *, GtkTree *);
535 void dissect_ospf(const u_char *, int, frame_data *, GtkTree *);
536 void dissect_ospf_hello(const u_char *, int, frame_data *, GtkTree *);
537 void dissect_rip(const u_char *, int, frame_data *, GtkTree *);
538 void dissect_tcp(const u_char *, int, frame_data *, GtkTree *);
539 void dissect_trmac(const u_char *, int, frame_data *, GtkTree *);
540 void dissect_udp(const u_char *, int, frame_data *, GtkTree *);
541 void dissect_vines(const u_char *, int, frame_data *, GtkTree *);
542 void dissect_vspp(const u_char *, int, frame_data *, GtkTree *);
543
544 /* This function is in ethertype.c */
545 void ethertype(guint16 etype, int offset,
546                 const u_char *pd, frame_data *fd, GtkTree *tree,
547                 GtkWidget *fh_tree);
548
549 #endif /* packet.h */