90193e033307887ed78e1f74fa8b0cdd96c22f0b
[obnox/wireshark/wip.git] / packet.h
1 /* packet.h
2  * Definitions for packet disassembly structures and routines
3  *
4  * $Id: packet.h,v 1.35 1999/02/08 20:02:33 gram 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 #define hi_nibble(b) ((b & 0xf0) >> 4)
55 #define lo_nibble(b) (b & 0x0f)
56
57 /* Useful when highlighting regions inside a dissect_*() function. With this
58  * macro, you can highlight from the start of the packet to the end of the
59  * frame. See dissect_data() for an example.
60  */
61 #define END_OF_FRAME    (fd->cap_len - offset)
62
63 #define IEEE_802_3_MAX_LEN 1500
64 #define BYTE_VIEW_WIDTH    16
65
66 typedef struct _column_info {
67   gint       num_cols; /* Number of columns */
68   gboolean **fmt_matx; /* Specifies which formats apply to a column */
69   gchar    **col_data; /* Column data */
70 } column_info;
71
72 #define COL_MAX_LEN 256
73
74 typedef struct _frame_data {
75   guint32      pkt_len;   /* Packet length */
76   guint32      cap_len;   /* Amount actually captured */
77   guint32      rel_secs;  /* Relative seconds */
78   guint32      rel_usecs; /* Relative microseconds */
79   guint32      abs_secs;  /* Absolute seconds */
80   guint32      abs_usecs; /* Absolute microseconds */
81   guint32      del_secs;  /* Delta seconds */
82   guint32      del_usecs; /* Delta microseconds */
83   long         file_off;  /* File offset */
84   column_info *cinfo;     /* Column formatting information */
85 #ifdef WITH_WIRETAP
86   int           lnk_t;     /* Per-packet encapsulation/data-link type */
87 #endif
88 } frame_data;
89
90 typedef struct _packet_info {
91   char *srcip;
92   int ip_src;
93   char *destip;
94   int ipproto;
95   int srcport;
96   int destport;
97   int iplen;
98   int iphdrlen;
99 } packet_info;
100
101 /* Struct for the match_strval function */
102
103 typedef struct _value_string {
104   guint32  value;
105   gchar   *strptr;
106 } value_string;
107
108 /* Many of the structs and definitions below were taken from include files
109  * in the Linux distribution. */
110
111 /* ARP / RARP structs and definitions */
112
113 #ifndef ARPOP_REQUEST
114 #define ARPOP_REQUEST  1       /* ARP request.  */
115 #endif
116 #ifndef ARPOP_REPLY
117 #define ARPOP_REPLY    2       /* ARP reply.  */
118 #endif
119 /* Some OSes have different names, or don't define these at all */
120 #ifndef ARPOP_RREQUEST
121 #define ARPOP_RREQUEST 3       /* RARP request.  */
122 #endif
123 #ifndef ARPOP_RREPLY
124 #define ARPOP_RREPLY   4       /* RARP reply.  */
125 #endif
126
127 /* ICMP structs and definitions */
128
129 typedef struct _e_icmp {
130   guint8  icmp_type;
131   guint8  icmp_code;
132   guint16 icmp_cksum;
133   union {
134     struct {  /* Address mask request/reply */
135       guint16 id;
136       guint16 seq;
137       guint32 sn_mask;
138     } am;
139     struct {  /* Timestap request/reply */
140       guint16 id;
141       guint16 seq;
142       guint32 orig;
143       guint32 recv;
144       guint32 xmit;
145     } ts;
146     guint32 zero;  /* Unreachable */
147   } opt;
148 } e_icmp;
149
150 #define ICMP_ECHOREPLY     0
151 #define ICMP_UNREACH       3
152 #define ICMP_SOURCEQUENCH  4
153 #define ICMP_REDIRECT      5
154 #define ICMP_ECHO          8
155 #define ICMP_TIMXCEED     11
156 #define ICMP_PARAMPROB    12
157 #define ICMP_TSTAMP       13
158 #define ICMP_TSTAMPREPLY  14
159 #define ICMP_IREQ         15
160 #define ICMP_IREQREPLY    16
161 #define ICMP_MASKREQ      17
162 #define ICMP_MASKREPLY    18
163
164 /* IGMP structs and definitions */
165
166 typedef struct _e_igmp {
167   guint8  igmp_v_t; /* combines igmp_v and igmp_t */
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   guint8  ip_v_hl; /* combines ip_v and ip_hl */
186   guint8  ip_tos;
187   guint16 ip_len;
188   guint16 ip_id;
189   guint16 ip_off;
190   guint8  ip_ttl;
191   guint8  ip_p;
192   guint16 ip_sum;
193   guint32 ip_src;
194   guint32 ip_dst;
195 } e_ip;
196
197 /* IP flags. */
198 #define IP_CE           0x8000          /* Flag: "Congestion"           */
199 #define IP_DF           0x4000          /* Flag: "Don't Fragment"       */
200 #define IP_MF           0x2000          /* Flag: "More Fragments"       */
201 #define IP_OFFSET       0x1FFF          /* "Fragment Offset" part       */
202
203 #define IPTOS_TOS_MASK    0x1E
204 #define IPTOS_TOS(tos)    ((tos) & IPTOS_TOS_MASK)
205 #define IPTOS_NONE        0x00
206 #define IPTOS_LOWCOST     0x02
207 #define IPTOS_RELIABILITY 0x04
208 #define IPTOS_THROUGHPUT  0x08
209 #define IPTOS_LOWDELAY    0x10
210 #define IPTOS_SECURITY    0x1E
211
212 #define IPTOS_PREC_MASK         0xE0
213 #define IPTOS_PREC(tos)         ((tos)&IPTOS_PREC_MASK)
214 #define IPTOS_PREC_NETCONTROL           0xe0
215 #define IPTOS_PREC_INTERNETCONTROL      0xc0
216 #define IPTOS_PREC_CRITIC_ECP           0xa0
217 #define IPTOS_PREC_FLASHOVERRIDE        0x80
218 #define IPTOS_PREC_FLASH                0x60
219 #define IPTOS_PREC_IMMEDIATE            0x40
220 #define IPTOS_PREC_PRIORITY             0x20
221 #define IPTOS_PREC_ROUTINE              0x00
222
223 /* IP options */
224 #define IPOPT_COPY              0x80
225
226 #define IPOPT_CONTROL           0x00
227 #define IPOPT_RESERVED1         0x20
228 #define IPOPT_MEASUREMENT       0x40
229 #define IPOPT_RESERVED2         0x60
230
231 #define IPOPT_END       (0 |IPOPT_CONTROL)
232 #define IPOPT_NOOP      (1 |IPOPT_CONTROL)
233 #define IPOPT_SEC       (2 |IPOPT_CONTROL|IPOPT_COPY)
234 #define IPOPT_LSRR      (3 |IPOPT_CONTROL|IPOPT_COPY)
235 #define IPOPT_TIMESTAMP (4 |IPOPT_MEASUREMENT)
236 #define IPOPT_RR        (7 |IPOPT_CONTROL)
237 #define IPOPT_SID       (8 |IPOPT_CONTROL|IPOPT_COPY)
238 #define IPOPT_SSRR      (9 |IPOPT_CONTROL|IPOPT_COPY)
239 #define IPOPT_RA        (20|IPOPT_CONTROL|IPOPT_COPY)
240
241 /* IP option lengths */
242 #define IPOLEN_SEC      11
243 #define IPOLEN_LSRR_MIN 3
244 #define IPOLEN_TIMESTAMP_MIN 5
245 #define IPOLEN_RR_MIN   3
246 #define IPOLEN_SID      4
247 #define IPOLEN_SSRR_MIN 3
248
249 #define IPSEC_UNCLASSIFIED      0x0000
250 #define IPSEC_CONFIDENTIAL      0xF135
251 #define IPSEC_EFTO              0x789A
252 #define IPSEC_MMMM              0xBC4D
253 #define IPSEC_RESTRICTED        0xAF13
254 #define IPSEC_SECRET            0xD788
255 #define IPSEC_TOPSECRET         0x6BC5
256 #define IPSEC_RESERVED1         0x35E2
257 #define IPSEC_RESERVED2         0x9AF1
258 #define IPSEC_RESERVED3         0x4D78
259 #define IPSEC_RESERVED4         0x24BD
260 #define IPSEC_RESERVED5         0x135E
261 #define IPSEC_RESERVED6         0x89AF
262 #define IPSEC_RESERVED7         0xC4D6
263 #define IPSEC_RESERVED8         0xE26B
264
265 #define IPOPT_TS_TSONLY         0               /* timestamps only */
266 #define IPOPT_TS_TSANDADDR      1               /* timestamps and addresses */
267 #define IPOPT_TS_PRESPEC        3               /* specified modules only */
268
269 #define IP_PROTO_ICMP  1
270 #define IP_PROTO_IGMP  2
271 #define IP_PROTO_TCP   6
272 #define IP_PROTO_UDP  17
273 #define IP_PROTO_OSPF 89
274
275 /* Null/loopback structs and definitions */
276
277 typedef struct _e_nullhdr {
278   guint8  null_next;
279   guint8  null_len;
280   guint16 null_family;
281 } e_nullhdr;
282
283 /* PPP structs and definitions */
284
285 typedef struct _e_ppphdr {
286   guint8  ppp_addr;
287   guint8  ppp_ctl;
288   guint16 ppp_prot;
289 } e_ppphdr;
290
291 /* TCP structs and definitions */
292
293 typedef struct _e_tcphdr {
294   guint16 th_sport;
295   guint16 th_dport;
296   guint32 th_seq;
297   guint32 th_ack;
298   guint8  th_off_x2; /* combines th_off and th_x2 */
299   guint8  th_flags;
300 #define TH_FIN  0x01
301 #define TH_SYN  0x02
302 #define TH_RST  0x04
303 #define TH_PUSH 0x08
304 #define TH_ACK  0x10
305 #define TH_URG  0x20
306   guint16 th_win;
307   guint16 th_sum;
308   guint16 th_urp;
309 } e_tcphdr;
310
311 /*
312  *      TCP option
313  */
314  
315 #define TCPOPT_NOP              1       /* Padding */
316 #define TCPOPT_EOL              0       /* End of options */
317 #define TCPOPT_MSS              2       /* Segment size negotiating */
318 #define TCPOPT_WINDOW           3       /* Window scaling */
319 #define TCPOPT_SACK_PERM        4       /* SACK Permitted */
320 #define TCPOPT_SACK             5       /* SACK Block */
321 #define TCPOPT_ECHO             6
322 #define TCPOPT_ECHOREPLY        7
323 #define TCPOPT_TIMESTAMP        8       /* Better RTT estimations/PAWS */
324 #define TCPOPT_CC               11
325 #define TCPOPT_CCNEW            12
326 #define TCPOPT_CCECHO           13
327
328 /*
329  *     TCP option lengths
330  */
331
332 #define TCPOLEN_MSS            4
333 #define TCPOLEN_WINDOW         3
334 #define TCPOLEN_SACK_PERM      2
335 #define TCPOLEN_SACK_MIN       2
336 #define TCPOLEN_ECHO           6
337 #define TCPOLEN_ECHOREPLY      6
338 #define TCPOLEN_TIMESTAMP      10
339 #define TCPOLEN_CC             6
340 #define TCPOLEN_CCNEW          6
341 #define TCPOLEN_CCECHO         6
342
343 /* UDP structs and definitions */
344
345 typedef struct _e_udphdr {
346   guint16 uh_sport;
347   guint16 uh_dport;
348   guint16 uh_ulen;
349   guint16 uh_sum;
350 } e_udphdr;
351
352 /* UDP Ports -> should go in packet-udp.h */
353
354 #define UDP_PORT_DNS     53
355 #define UDP_PORT_BOOTPS  67
356 #define UDP_PORT_IPX    213
357 #define UDP_PORT_NBNS   137
358 #define UDP_PORT_NBDGM  138
359 #define UDP_PORT_RIP    520
360 #define UDP_PORT_VINES  573
361
362 /* TCP Ports */
363
364 #define TCP_PORT_PRINTER 515
365
366 /* Tree types.  Each dissect_* routine should have one for each
367    add_subtree() call. */
368
369 enum {
370         ETT_FRAME,
371         ETT_IEEE8023,
372         ETT_ETHER2,
373         ETT_LLC,
374         ETT_TOKEN_RING,
375         ETT_TR_IERR_CNT,
376         ETT_TR_NERR_CNT,
377         ETT_TR_MAC,
378         ETT_PPP,
379         ETT_ARP,
380         ETT_FDDI,
381         ETT_NULL,
382         ETT_IP,
383         ETT_IP_OPTIONS,
384         ETT_IP_OPTION_SEC,
385         ETT_IP_OPTION_ROUTE,
386         ETT_IP_OPTION_TIMESTAMP,
387         ETT_IP_TOS,
388         ETT_IP_OFF,
389         ETT_UDP,
390         ETT_TCP,
391         ETT_TCP_OPTIONS,
392         ETT_TCP_OPTION_SACK,
393         ETT_TCP_FLAGS,
394         ETT_ICMP,
395         ETT_IGMP,
396         ETT_IPX,
397         ETT_SPX,
398         ETT_NCP,
399         ETT_DNS,
400         ETT_DNS_FLAGS,
401         ETT_DNS_QRY,
402         ETT_DNS_QD,
403         ETT_DNS_ANS,
404         ETT_DNS_RR,
405         ETT_RIP,
406         ETT_RIP_VEC,
407         ETT_OSPF,
408         ETT_OSPF_HDR,
409         ETT_OSPF_HELLO,
410         ETT_OSPF_DESC,
411         ETT_OSPF_LSR,
412         ETT_OSPF_LSA_UPD,
413         ETT_OSPF_LSA,
414         ETT_LPD,
415         ETT_RAW,
416         ETT_BOOTP,
417         ETT_BOOTP_OPTION,
418         ETT_IPv6,
419         ETT_CLNP,
420         ETT_COTP,
421         ETT_VINES_FRP,
422         ETT_VINES,
423         ETT_VINES_ARP,
424         ETT_VINES_ICP,
425         ETT_VINES_IPC,
426         ETT_VINES_RTP,
427         ETT_VINES_SPP,
428         ETT_IPXRIP,
429         ETT_IPXSAP,
430         ETT_IPXSAP_SERVER,
431         ETT_NBNS,
432         ETT_NBNS_FLAGS,
433         ETT_NBNS_NB_FLAGS,
434         ETT_NBNS_NAME_FLAGS,
435         ETT_NBNS_QRY,
436         ETT_NBNS_QD,
437         ETT_NBNS_ANS,
438         ETT_NBNS_RR,
439         ETT_NBIPX,
440         ETT_AARP,
441         ETT_GIOP,
442         ETT_NBDGM,
443         ETT_CDP,
444         NUM_TREE_TYPES  /* last item number plus one */
445 };
446
447 /* The version of pcap.h that comes with some systems is missing these
448  * #defines.
449  */
450
451 #ifndef DLT_RAW
452 #define DLT_RAW 12
453 #endif
454
455 #ifndef DLT_SLIP_BSDOS
456 #define DLT_SLIP_BSDOS 13
457 #endif
458
459 #ifndef DLT_PPP_BSDOS
460 #define DLT_PPP_BSDOS 14
461 #endif
462
463 typedef enum {
464   NO_LENGTH,            /* option has no data, hence no length */
465   FIXED_LENGTH,         /* option always has the same length */
466   VARIABLE_LENGTH       /* option is variable-length - optlen is minimum */
467 } opt_len_type;
468
469 /* Member of table of IP or TCP options. */
470 typedef struct {
471   int   optcode;        /* code for option */
472   char *name;           /* name of option */
473   opt_len_type len_type; /* type of option length field */
474   int   optlen;         /* value length should be (minimum if VARIABLE) */
475   void  (*dissect)(GtkWidget *, const char *, const u_char *, int, guint);
476                         /* routine to dissect option */
477 } ip_tcp_opt;
478
479 /* Routine to dissect IP or TCP options. */
480 void       dissect_ip_tcp_options(GtkWidget *, const u_char *, int, guint,
481     ip_tcp_opt *, int, int);
482
483 /* Utility routines used by packet*.c */
484 gchar*     ether_to_str(const guint8 *);
485 gchar*     ip_to_str(const guint8 *);
486 gchar*     time_secs_to_str(guint32);
487 void       packet_hex_print(GtkText *, guint8 *, gint, gint, gint);
488 #define E_TREEINFO_START_KEY "tree_info_start"
489 #define E_TREEINFO_LEN_KEY   "tree_info_len"
490 #if __GNUC__ == 2
491 GtkWidget* add_item_to_tree(GtkWidget *, gint, gint, gchar *, ...)
492     __attribute__((format (printf, 4, 5)));
493 #else
494 GtkWidget* add_item_to_tree(GtkWidget *, gint, gint, gchar *, ...);
495 #endif
496 void       set_item_len(GtkWidget *, gint);
497 gchar*     val_to_str(guint32, const value_string *, const char *);
498 gchar*     match_strval(guint32, const value_string*);
499 gint       check_col(frame_data *, gint);
500 #if __GNUC__ == 2
501 void       col_add_fstr(frame_data *, gint, gchar *, ...)
502     __attribute__((format (printf, 3, 4)));
503 #else
504 void       col_add_fstr(frame_data *, gint, gchar *, ...);
505 #endif
506 void       col_add_str(frame_data *, gint, gchar *);
507
508 /* Routines in packet.c */
509
510 void dissect_packet(const u_char *, frame_data *, GtkTree *);
511 void add_subtree(GtkWidget *, GtkWidget*, gint);
512 void expand_tree(GtkWidget *, gpointer);
513 void collapse_tree(GtkWidget *, gpointer);
514
515 /*
516  * Routines in packet-*.c
517  * Routines should take three args: packet data *, frame_data *, tree *
518  * They should never modify the packet data.
519  */
520 void dissect_eth(const u_char *, frame_data *, GtkTree *);
521 void dissect_fddi(const u_char *, frame_data *, GtkTree *);
522 void dissect_null(const u_char *, frame_data *, GtkTree *);
523 void dissect_ppp(const u_char *, frame_data *, GtkTree *);
524 void dissect_raw(const u_char *, frame_data *, GtkTree *);
525 void dissect_tr(const u_char *, frame_data *, GtkTree *);
526
527 /*
528  * Routines in packet-*.c
529  * Routines should take four args: packet data *, offset, frame_data *,
530  * tree *
531  * They should never modify the packet data.
532  */
533 void dissect_aarp(const u_char *, int, frame_data *, GtkTree *);
534 void dissect_arp(const u_char *, int, frame_data *, GtkTree *);
535 void dissect_bootp(const u_char *, int, frame_data *, GtkTree *);
536 void dissect_cdp(const u_char *, int, frame_data *, GtkTree *);
537 void dissect_data(const u_char *, int, frame_data *, GtkTree *);
538 void dissect_ddp(const u_char *, int, frame_data *, GtkTree *);
539 void dissect_dns(const u_char *, int, frame_data *, GtkTree *);
540 void dissect_giop(const u_char *, int, frame_data *, GtkTree *);
541 void dissect_icmp(const u_char *, int, frame_data *, GtkTree *);
542 void dissect_igmp(const u_char *, int, frame_data *, GtkTree *);
543 void dissect_ip(const u_char *, int, frame_data *, GtkTree *);
544 void dissect_ipv6(const u_char *, int, frame_data *, GtkTree *);
545 void dissect_ipx(const u_char *, int, frame_data *, GtkTree *);
546 void dissect_llc(const u_char *, int, frame_data *, GtkTree *);
547 void dissect_lpd(const u_char *, int, frame_data *, GtkTree *);
548 void dissect_nbdgm(const u_char *, int, frame_data *, GtkTree *);
549 void dissect_nbipx_ns(const u_char *, int, frame_data *, GtkTree *);
550 void dissect_nbns(const u_char *, int, frame_data *, GtkTree *);
551 void dissect_ncp(const u_char *, int, frame_data *, GtkTree *);
552 void dissect_nwlink_dg(const u_char *, int, frame_data *, GtkTree *);
553 void dissect_osi(const u_char *, int, frame_data *, GtkTree *);
554 void dissect_ospf(const u_char *, int, frame_data *, GtkTree *);
555 void dissect_ospf_hello(const u_char *, int, frame_data *, GtkTree *);
556 void dissect_rip(const u_char *, int, frame_data *, GtkTree *);
557 void dissect_tcp(const u_char *, int, frame_data *, GtkTree *);
558 void dissect_trmac(const u_char *, int, frame_data *, GtkTree *);
559 void dissect_udp(const u_char *, int, frame_data *, GtkTree *);
560 void dissect_vines(const u_char *, int, frame_data *, GtkTree *);
561 void dissect_vines_arp(const u_char *, int, frame_data *, GtkTree *);
562 void dissect_vines_frp(const u_char *, int, frame_data *, GtkTree *);
563 void dissect_vines_icp(const u_char *, int, frame_data *, GtkTree *);
564 void dissect_vines_ipc(const u_char *, int, frame_data *, GtkTree *);
565 void dissect_vines_rtp(const u_char *, int, frame_data *, GtkTree *);
566 void dissect_vines_spp(const u_char *, int, frame_data *, GtkTree *);
567
568 /* These functions are in ethertype.c */
569 gchar *ethertype_to_str(guint16 etype, const char *fmt);
570 void ethertype(guint16 etype, int offset,
571                 const u_char *pd, frame_data *fd, GtkTree *tree,
572                 GtkWidget *fh_tree);
573
574 /* These functions are in packet-arp.c */
575 gchar *arphrdaddr_to_str(guint8 *ad, int ad_len, guint16 type);
576 gchar *arphrdtype_to_str(guint16 hwtype, const char *fmt);
577
578 #endif /* packet.h */