2 * Definitions for packet disassembly structures and routines
4 * $Id: packet.h,v 1.23 1998/11/03 07:45:10 guy Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@zing.org>
8 * Copyright 1998 Gerald Combs
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.
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.
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.
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.
35 #define pntohs(p) ((guint16) \
36 ((guint16)*((guint8 *)p+0)<<8| \
37 (guint16)*((guint8 *)p+1)<<0))
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)
44 #define pletohs(p) ((guint16) \
45 ((guint16)*((guint8 *)p+1)<<8| \
46 (guint16)*((guint8 *)p+0)<<0))
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)
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.
58 #define END_OF_FRAME (fd->cap_len - offset)
60 #define IEEE_802_3_MAX_LEN 1500
61 #define BYTE_VIEW_WIDTH 16
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 */
72 typedef struct _packet_info {
83 /* Struct for the match_strval function */
85 typedef struct _value_string {
90 /* Many of the structs and definitions below were taken from include files
91 * in the Linux distribution. */
93 /* ARP / RARP structs and definitions */
96 #define ARPOP_REQUEST 1 /* ARP request. */
99 #define ARPOP_REPLY 2 /* ARP reply. */
101 /* Some OSes have different names, or don't define these at all */
102 #ifndef ARPOP_RREQUEST
103 #define ARPOP_RREQUEST 3 /* RARP request. */
106 #define ARPOP_RREPLY 4 /* RARP reply. */
109 /* ICMP structs and definitions */
111 typedef struct _e_icmp {
116 struct { /* Address mask request/reply */
121 struct { /* Timestap request/reply */
128 guint32 zero; /* Unreachable */
132 #define ICMP_ECHOREPLY 0
133 #define ICMP_UNREACH 3
134 #define ICMP_SOURCEQUENCH 4
135 #define ICMP_REDIRECT 5
137 #define ICMP_TIMXCEED 11
138 #define ICMP_PARAMPROB 12
139 #define ICMP_TSTAMP 13
140 #define ICMP_TSTAMPREPLY 14
142 #define ICMP_IREQREPLY 16
143 #define ICMP_MASKREQ 17
144 #define ICMP_MASKREPLY 18
146 /* IGMP structs and definitions */
148 typedef struct _e_igmp {
149 #if BYTE_ORDER == BIG_ENDIAN
152 #else /* Little endian */
161 #define IGMP_M_QRY 0x01
162 #define IGMP_V1_M_RPT 0x02
163 #define IGMP_V2_LV_GRP 0x07
164 #define IGMP_DVMRP 0x03
165 #define IGMP_PIM 0x04
166 #define IGMP_V2_M_RPT 0x06
167 #define IGMP_MTRC_RESP 0x1e
168 #define IGMP_MTRC 0x1f
170 /* IP structs and definitions */
172 typedef struct _e_ip {
173 #if BYTE_ORDER == BIG_ENDIAN
176 #else /* Little endian */
192 #define IP_CE 0x8000 /* Flag: "Congestion" */
193 #define IP_DF 0x4000 /* Flag: "Don't Fragment" */
194 #define IP_MF 0x2000 /* Flag: "More Fragments" */
195 #define IP_OFFSET 0x1FFF /* "Fragment Offset" part */
197 #define IPTOS_TOS_MASK 0x1E
198 #define IPTOS_TOS(tos) ((tos) & IPTOS_TOS_MASK)
199 #define IPTOS_NONE 0x00
200 #define IPTOS_LOWCOST 0x02
201 #define IPTOS_RELIABILITY 0x04
202 #define IPTOS_THROUGHPUT 0x08
203 #define IPTOS_LOWDELAY 0x10
204 #define IPTOS_SECURITY 0x1E
206 #define IPTOS_PREC_MASK 0xE0
207 #define IPTOS_PREC(tos) ((tos)&IPTOS_PREC_MASK)
208 #define IPTOS_PREC_NETCONTROL 0xe0
209 #define IPTOS_PREC_INTERNETCONTROL 0xc0
210 #define IPTOS_PREC_CRITIC_ECP 0xa0
211 #define IPTOS_PREC_FLASHOVERRIDE 0x80
212 #define IPTOS_PREC_FLASH 0x60
213 #define IPTOS_PREC_IMMEDIATE 0x40
214 #define IPTOS_PREC_PRIORITY 0x20
215 #define IPTOS_PREC_ROUTINE 0x00
218 #define IPOPT_COPY 0x80
220 #define IPOPT_CONTROL 0x00
221 #define IPOPT_RESERVED1 0x20
222 #define IPOPT_MEASUREMENT 0x40
223 #define IPOPT_RESERVED2 0x60
225 #define IPOPT_END (0 |IPOPT_CONTROL)
226 #define IPOPT_NOOP (1 |IPOPT_CONTROL)
227 #define IPOPT_SEC (2 |IPOPT_CONTROL|IPOPT_COPY)
228 #define IPOPT_LSRR (3 |IPOPT_CONTROL|IPOPT_COPY)
229 #define IPOPT_TIMESTAMP (4 |IPOPT_MEASUREMENT)
230 #define IPOPT_RR (7 |IPOPT_CONTROL)
231 #define IPOPT_SID (8 |IPOPT_CONTROL|IPOPT_COPY)
232 #define IPOPT_SSRR (9 |IPOPT_CONTROL|IPOPT_COPY)
233 #define IPOPT_RA (20|IPOPT_CONTROL|IPOPT_COPY)
235 /* IP option lengths */
236 #define IPOLEN_SEC 11
237 #define IPOLEN_LSRR_MIN 3
238 #define IPOLEN_TIMESTAMP_MIN 5
239 #define IPOLEN_RR_MIN 3
241 #define IPOLEN_SSRR_MIN 3
243 #define IPSEC_UNCLASSIFIED 0x0000
244 #define IPSEC_CONFIDENTIAL 0xF135
245 #define IPSEC_EFTO 0x789A
246 #define IPSEC_MMMM 0xBC4D
247 #define IPSEC_RESTRICTED 0xAF13
248 #define IPSEC_SECRET 0xD788
249 #define IPSEC_TOPSECRET 0x6BC5
250 #define IPSEC_RESERVED1 0x35E2
251 #define IPSEC_RESERVED2 0x9AF1
252 #define IPSEC_RESERVED3 0x4D78
253 #define IPSEC_RESERVED4 0x24BD
254 #define IPSEC_RESERVED5 0x135E
255 #define IPSEC_RESERVED6 0x89AF
256 #define IPSEC_RESERVED7 0xC4D6
257 #define IPSEC_RESERVED8 0xE26B
259 #define IPOPT_TS_TSONLY 0 /* timestamps only */
260 #define IPOPT_TS_TSANDADDR 1 /* timestamps and addresses */
261 #define IPOPT_TS_PRESPEC 3 /* specified modules only */
263 #define IP_PROTO_ICMP 1
264 #define IP_PROTO_IGMP 2
265 #define IP_PROTO_TCP 6
266 #define IP_PROTO_UDP 17
267 #define IP_PROTO_OSPF 89
269 /* Null/loopback structs and definitions */
271 typedef struct _e_nullhdr {
277 /* PPP structs and definitions */
279 typedef struct _e_ppphdr {
285 /* TCP structs and definitions */
287 typedef struct _e_tcphdr {
292 #if BYTE_ORDER == LITTLE_ENDIAN
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 */
325 #define TCPOPT_CCNEW 12
326 #define TCPOPT_CCECHO 13
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
340 #define TCPOLEN_CCNEW 6
341 #define TCPOLEN_CCECHO 6
343 /* UDP structs and definitions */
345 typedef struct _e_udphdr {
352 /* UDP Ports -> should go in packet-udp.h */
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_RIP 520
362 #define TCP_PORT_PRINTER 515
364 /* Tree types. Each dissect_* routine should have one for each
365 add_subtree() call. */
384 ETT_IP_OPTION_TIMESTAMP,
427 NUM_TREE_TYPES /* last item number plus one */
430 /* The version of pcap.h that comes with some systems is missing these
438 #ifndef DLT_SLIP_BSDOS
439 #define DLT_SLIP_BSDOS 13
442 #ifndef DLT_PPP_BSDOS
443 #define DLT_PPP_BSDOS 14
447 NO_LENGTH, /* option has no data, hence no length */
448 FIXED_LENGTH, /* option always has the same length */
449 VARIABLE_LENGTH /* option is variable-length - optlen is minimum */
452 /* Member of table of IP or TCP options. */
454 int optcode; /* code for option */
455 char *name; /* name of option */
456 opt_len_type len_type; /* type of option length field */
457 int optlen; /* value length should be (minimum if VARIABLE) */
458 void (*dissect)(GtkWidget *, const char *, const u_char *, int, guint);
459 /* routine to dissect option */
462 /* Routine to dissect IP or TCP options. */
463 void dissect_ip_tcp_options(GtkWidget *, const u_char *, int, guint,
464 ip_tcp_opt *, int, int);
466 /* Utility routines used by packet*.c */
467 gchar* ether_to_str(guint8 *);
468 gchar* ip_to_str(guint8 *);
469 void packet_hex_print(GtkText *, guint8 *, gint, gint, gint);
470 #define E_TREEINFO_START_KEY "tree_info_start"
471 #define E_TREEINFO_LEN_KEY "tree_info_len"
473 GtkWidget* add_item_to_tree(GtkWidget *, gint, gint, gchar *, ...)
474 __attribute__((format (printf, 4, 5)));
476 GtkWidget* add_item_to_tree(GtkWidget *, gint, gint, gchar *, ...);
478 gchar* val_to_str(guint32, const value_string *, const char *);
479 gchar* match_strval(guint32, const value_string*);
481 /* Routines in packet.c */
483 void dissect_packet(const u_char *, guint32 ts_secs, guint32 ts_usecs,
484 frame_data *, GtkTree *);
485 void add_subtree(GtkWidget *, GtkWidget*, gint);
486 void expand_tree(GtkWidget *, gpointer);
487 void collapse_tree(GtkWidget *, gpointer);
490 * Routines in packet-*.c
491 * Routines should take three args: packet data *, frame_data *, tree *
492 * They should never modify the packet data.
494 void dissect_eth(const u_char *, frame_data *, GtkTree *);
495 void dissect_fddi(const u_char *, frame_data *, GtkTree *);
496 void dissect_null(const u_char *, frame_data *, GtkTree *);
497 void dissect_ppp(const u_char *, frame_data *, GtkTree *);
498 void dissect_raw(const u_char *, frame_data *, GtkTree *);
499 void dissect_tr(const u_char *, frame_data *, GtkTree *);
502 * Routines in packet-*.c
503 * Routines should take four args: packet data *, offset, frame_data *,
505 * They should never modify the packet data.
507 void dissect_aarp(const u_char *, int, frame_data *, GtkTree *);
508 void dissect_arp(const u_char *, int, frame_data *, GtkTree *);
509 void dissect_bootp(const u_char *, int, frame_data *, GtkTree *);
510 void dissect_data(const u_char *, int, frame_data *, GtkTree *);
511 void dissect_ddp(const u_char *, int, frame_data *, GtkTree *);
512 void dissect_dns(const u_char *, int, frame_data *, GtkTree *);
513 void dissect_icmp(const u_char *, int, frame_data *, GtkTree *);
514 void dissect_igmp(const u_char *, int, frame_data *, GtkTree *);
515 void dissect_ip(const u_char *, int, frame_data *, GtkTree *);
516 void dissect_ipv6(const u_char *, int, frame_data *, GtkTree *);
517 void dissect_ipx(const u_char *, int, frame_data *, GtkTree *);
518 void dissect_llc(const u_char *, int, frame_data *, GtkTree *);
519 void dissect_lpd(const u_char *, int, frame_data *, GtkTree *);
520 void dissect_nbipx_ns(const u_char *, int, frame_data *, GtkTree *);
521 void dissect_nbns(const u_char *, int, frame_data *, GtkTree *);
522 void dissect_ncp(const u_char *, int, frame_data *, GtkTree *);
523 void dissect_nwlink_dg(const u_char *, int, frame_data *, GtkTree *);
524 void dissect_osi(const u_char *, int, frame_data *, GtkTree *);
525 void dissect_ospf(const u_char *, int, frame_data *, GtkTree *);
526 void dissect_ospf_hello(const u_char *, int, frame_data *, GtkTree *);
527 void dissect_rip(const u_char *, int, frame_data *, GtkTree *);
528 void dissect_tcp(const u_char *, int, frame_data *, GtkTree *);
529 void dissect_trmac(const u_char *, int, frame_data *, GtkTree *);
530 void dissect_udp(const u_char *, int, frame_data *, GtkTree *);
531 void dissect_vines(const u_char *, int, frame_data *, GtkTree *);
532 void dissect_vspp(const u_char *, int, frame_data *, GtkTree *);
534 /* These functions are in ethertype.c */
535 gchar *ethertype_to_str(guint16 etype, const char *fmt);
536 void ethertype(guint16 etype, int offset,
537 const u_char *pd, frame_data *fd, GtkTree *tree,
540 #endif /* packet.h */