2 * Copyright (c) 1988-1997
3 * The Regents of the University of California. All rights reserved.
5 * Copyright (c) 1998-2012 Michael Richardson <mcr@tcpdump.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that: (1) source code distributions
10 * retain the above copyright notice and this paragraph in its entirety, (2)
11 * distributions including binary code include the above copyright notice and
12 * this paragraph in its entirety in the documentation or other materials
13 * provided with the distribution, and (3) all advertising materials mentioning
14 * features or use of this software display the following acknowledgement:
15 * ``This product includes software developed by the University of California,
16 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
17 * the University nor the names of its contributors may be used to endorse
18 * or promote products derived from this software without specific prior
20 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
21 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
22 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
24 * @(#) $Header: /tcpdump/master/tcpdump/netdissect.h,v 1.27 2008-08-16 11:36:20 hannes Exp $ (LBL)
30 #ifdef HAVE_OS_PROTO_H
33 #include <sys/types.h>
35 #ifndef HAVE___ATTRIBUTE__
36 #define __attribute__(x)
43 #if !defined(HAVE_SNPRINTF)
44 int snprintf (char *str
, size_t sz
, const char *format
, ...)
45 __attribute__ ((format (printf
, 3, 4)));
48 #if !defined(HAVE_VSNPRINTF)
49 int vsnprintf (char *str
, size_t sz
, const char *format
, va_list ap
)
50 __attribute__((format (printf
, 3, 0)));
54 extern size_t strlcat (char *, const char *, size_t);
57 extern size_t strlcpy (char *, const char *, size_t);
61 extern char *strdup (const char *str
);
65 extern char *strsep(char **, const char *);
70 const char *s
; /* string */
73 #define TOKBUFSIZE 128
74 extern const char *tok2strbuf(const struct tok
*, const char *, int,
75 char *buf
, size_t bufsize
);
77 /* tok2str is deprecated */
78 extern const char *tok2str(const struct tok
*, const char *, int);
79 extern char *bittok2str(const struct tok
*, const char *, int);
80 extern char *bittok2str_nosep(const struct tok
*, const char *, int);
83 typedef struct netdissect_options netdissect_options
;
85 struct netdissect_options
{
86 int ndo_aflag
; /* translate network and broadcast addresses */
87 int ndo_bflag
; /* print 4 byte ASes in ASDOT notation */
88 int ndo_eflag
; /* print ethernet header */
89 int ndo_fflag
; /* don't translate "foreign" IP address */
90 int ndo_Kflag
; /* don't check TCP checksums */
91 int ndo_nflag
; /* leave addresses as numbers */
92 int ndo_Nflag
; /* remove domains from printed host names */
93 int ndo_qflag
; /* quick (shorter) output */
94 int ndo_Rflag
; /* print sequence # field in AH/ESP*/
95 int ndo_sflag
; /* use the libsmi to translate OIDs */
96 int ndo_Sflag
; /* print raw TCP sequence numbers */
97 int ndo_tflag
; /* print packet arrival time */
98 int ndo_Uflag
; /* "unbuffered" output of dump files */
99 int ndo_uflag
; /* Print undecoded NFS handles */
100 int ndo_vflag
; /* verbose */
101 int ndo_xflag
; /* print packet in hex */
102 int ndo_Xflag
; /* print packet in hex/ascii */
103 int ndo_Aflag
; /* print packet only in ascii observing TAB,
104 * LF, CR and SPACE as graphical chars
106 int ndo_Bflag
; /* buffer size */
107 int ndo_Iflag
; /* rfmon (monitor) mode */
108 int ndo_Oflag
; /* run filter code optimizer */
109 int ndo_dlt
; /* if != -1, ask libpcap for the DLT it names*/
110 int ndo_jflag
; /* packet time stamp source */
111 int ndo_pflag
; /* don't go promiscuous */
113 int ndo_Cflag
; /* rotate dump files after this many bytes */
114 int ndo_Cflag_count
; /* Keep track of which file number we're writing */
115 int ndo_Gflag
; /* rotate dump files after this many seconds */
116 int ndo_Gflag_count
; /* number of files created with Gflag rotation */
117 time_t ndo_Gflag_time
; /* The last time_t the dump file was rotated. */
118 int ndo_Wflag
; /* recycle output files after this number of files */
120 int ndo_Hflag
; /* dissect 802.11s draft mesh standard */
121 int ndo_suppress_default_print
; /* don't use default_print() for unknown packet types */
122 const char *ndo_dltname
;
125 struct sa_list
*ndo_sa_list_head
; /* used by print-esp.c */
126 struct sa_list
*ndo_sa_default
;
128 char *ndo_sigsecret
; /* Signature verification secret key */
130 struct esp_algorithm
*ndo_espsecret_xform
; /* cache of decoded */
131 char *ndo_espsecret_key
;
133 int ndo_packettype
; /* as specified by -T */
135 char *ndo_program_name
; /*used to generate self-identifying messages */
137 int32_t ndo_thiszone
; /* seconds offset from gmt to local time */
141 /*global pointers to beginning and end of current packet (during printing) */
142 const u_char
*ndo_packetp
;
143 const u_char
*ndo_snapend
;
145 /* bookkeeping for ^T output */
148 /* pointer to void function to output stuff */
149 void (*ndo_default_print
)(netdissect_options
*,
150 register const u_char
*bp
, register u_int length
);
151 void (*ndo_info
)(netdissect_options
*, int verbose
);
153 int (*ndo_printf
)(netdissect_options
*,
154 const char *fmt
, ...)
155 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
156 __attribute__ ((format (printf
, 2, 3)))
159 void (*ndo_error
)(netdissect_options
*,
160 const char *fmt
, ...)
161 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
162 __attribute__ ((noreturn
, format (printf
, 2, 3)))
165 void (*ndo_warning
)(netdissect_options
*,
166 const char *fmt
, ...)
167 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
168 __attribute__ ((format (printf
, 2, 3)))
173 #define PT_VAT 1 /* Visual Audio Tool */
174 #define PT_WB 2 /* distributed White Board */
175 #define PT_RPC 3 /* Remote Procedure Call */
176 #define PT_RTP 4 /* Real-Time Applications protocol */
177 #define PT_RTCP 5 /* Real-Time Applications control protocol */
178 #define PT_SNMP 6 /* Simple Network Management Protocol */
179 #define PT_CNFP 7 /* Cisco NetFlow protocol */
180 #define PT_TFTP 8 /* trivial file transfer protocol */
181 #define PT_AODV 9 /* Ad-hoc On-demand Distance Vector Protocol */
182 #define PT_CARP 10 /* Common Address Redundancy Protocol */
183 #define PT_RADIUS 11 /* RADIUS authentication Protocol */
184 #define PT_ZMTP1 12 /* ZeroMQ Message Transport Protocol 1.0 */
185 #define PT_VXLAN 13 /* Virtual eXtensible Local Area Network */
186 #define PT_PGM 14 /* [UDP-encapsulated] Pragmatic General Multicast */
187 #define PT_PGM_ZMTP1 15 /* ZMTP/1.0 inside PGM (native or UDP-encapsulated) */
190 #define min(a,b) ((a)>(b)?(b):(a))
193 #define max(a,b) ((b)>(a)?(b):(a))
197 * Maximum snapshot length. This should be enough to capture the full
198 * packet on most network interfaces.
200 * XXX - could it be larger? If so, should it? Some applications might
201 * use the snapshot length in a savefile header to control the size of
202 * the buffer they allocate, so a size of, say, 2^31-1 might not work
205 #define MAXIMUM_SNAPLEN 65535
208 * The default snapshot length is the maximum.
210 #define DEFAULT_SNAPLEN MAXIMUM_SNAPLEN
212 #define ESRC(ep) ((ep)->ether_shost)
213 #define EDST(ep) ((ep)->ether_dhost)
216 #define NTOHL(x) (x) = ntohl(x)
217 #define NTOHS(x) (x) = ntohs(x)
218 #define HTONL(x) (x) = htonl(x)
219 #define HTONS(x) (x) = htons(x)
223 * True if "l" bytes of "var" were captured.
225 * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
226 * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
228 * The check is for <= rather than < because "l" might be 0.
230 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
231 (const u_char *)&(var) <= ndo->ndo_snapend - (l))
233 /* True if "var" was captured */
234 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
236 /* Bail if "l" bytes of "var" were not captured */
237 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
239 /* Bail if "var" was not captured */
240 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
242 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
243 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
246 extern void ts_print(netdissect_options
*ipdo
,
247 const struct timeval
*);
248 extern void relts_print(int);
251 extern int fn_print(const u_char
*, const u_char
*);
252 extern int fn_printn(const u_char
*, u_int
, const u_char
*);
253 extern const char *tok2str(const struct tok
*, const char *, int);
255 extern void wrapup(int);
258 extern char *read_infile(netdissect_options
*, char *);
259 extern char *copy_argv(netdissect_options
*, char **);
262 extern void safeputchar(int);
263 extern void safeputs(const char *, int);
265 #define PLURAL_SUFFIX(n) \
266 (((n) != 1) ? "s" : "")
269 extern const char *isonsap_string(netdissect_options
*, const u_char
*);
270 extern const char *protoid_string(netdissect_options
*, const u_char
*);
271 extern const char *dnname_string(netdissect_options
*, u_short
);
272 extern const char *dnnum_string(netdissect_options
*, u_short
);
275 /* The printer routines. */
279 typedef u_int (*if_ndo_printer
)(struct netdissect_options
*ndo
,
280 const struct pcap_pkthdr
*, const u_char
*);
281 typedef u_int (*if_printer
)(const struct pcap_pkthdr
*, const u_char
*);
283 extern if_ndo_printer
lookup_ndo_printer(int);
284 extern if_printer
lookup_printer(int);
286 extern void eap_print(netdissect_options
*,const u_char
*, u_int
);
287 extern int esp_print(netdissect_options
*,
288 register const u_char
*bp
, int len
, register const u_char
*bp2
,
289 int *nhdr
, int *padlen
);
290 extern void arp_print(netdissect_options
*,const u_char
*, u_int
, u_int
);
291 extern void tipc_print(netdissect_options
*, const u_char
*, u_int
, u_int
);
292 extern void msnlb_print(netdissect_options
*, const u_char
*);
293 extern void icmp6_print(netdissect_options
*ndo
, const u_char
*,
294 u_int
, const u_char
*, int);
295 extern void isakmp_print(netdissect_options
*,const u_char
*,
296 u_int
, const u_char
*);
297 extern void isakmp_rfc3948_print(netdissect_options
*,const u_char
*,
298 u_int
, const u_char
*);
299 extern void ip_print(netdissect_options
*,const u_char
*, u_int
);
300 extern void ip_print_inner(netdissect_options
*ndo
,
301 const u_char
*bp
, u_int length
, u_int nh
,
303 extern void rrcp_print(netdissect_options
*,const u_char
*, u_int
);
305 extern void ether_print(netdissect_options
*,
306 const u_char
*, u_int
, u_int
,
307 void (*)(netdissect_options
*, const u_char
*),
310 extern u_int
ether_if_print(netdissect_options
*,
311 const struct pcap_pkthdr
*,const u_char
*);
312 extern u_int
netanalyzer_if_print(netdissect_options
*,
313 const struct pcap_pkthdr
*,const u_char
*);
314 extern u_int
netanalyzer_transparent_if_print(netdissect_options
*,
315 const struct pcap_pkthdr
*,
318 extern int ethertype_print(netdissect_options
*,u_short
, const u_char
*,
321 /* stuff that has not yet been rototiled */
323 extern void ascii_print(netdissect_options
*,u_int
);
324 extern void hex_and_ascii_print_with_offset(netdissect_options
*,const char *,
326 extern void hex_and_ascii_print(netdissect_options
*,const char *, u_int
);
327 extern void hex_print_with_offset(netdissect_options
*,const char *,
329 extern void hex_print(netdissect_options
*,const char *, u_int
);
330 extern void telnet_print(netdissect_options
*,const u_char
*, u_int
);
331 extern int llc_print(netdissect_options
*,
332 const u_char
*, u_int
, u_int
, const u_char
*,
333 const u_char
*, u_short
*);
334 extern void aarp_print(netdissect_options
*,const u_char
*, u_int
);
335 extern void atalk_print(netdissect_options
*,const u_char
*, u_int
);
336 extern void atm_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
337 extern void bootp_print(netdissect_options
*,const u_char
*,
338 u_int
, u_short
, u_short
);
339 extern void bgp_print(netdissect_options
*,const u_char
*, int);
340 extern void bxxp_print(netdissect_options
*,const u_char
*, u_int
);
341 extern void chdlc_if_print(u_char
*user
, const struct pcap_pkthdr
*h
,
342 register const u_char
*p
);
343 extern void chdlc_print(netdissect_options
*ndo
,
344 register const u_char
*p
, u_int length
, u_int caplen
);
345 extern void cisco_autorp_print(netdissect_options
*,
346 const u_char
*, u_int
);
347 extern void cnfp_print(netdissect_options
*,const u_char
*cp
,
348 u_int len
, const u_char
*bp
);
349 extern void decnet_print(netdissect_options
*,const u_char
*,
351 extern void default_print(netdissect_options
*,const u_char
*, u_int
);
352 extern void dvmrp_print(netdissect_options
*,const u_char
*, u_int
);
353 extern void egp_print(netdissect_options
*,const u_char
*, u_int
,
356 extern void arcnet_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
357 extern void token_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
358 extern void fddi_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
360 extern void gre_print(netdissect_options
*,const u_char
*, u_int
);
361 extern void icmp_print(netdissect_options
*,const u_char
*, u_int
,
363 extern void hsrp_print(netdissect_options
*ndo
,
364 register const u_char
*bp
, register u_int len
);
365 extern void ieee802_11_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
366 extern void igmp_print(netdissect_options
*,
367 register const u_char
*, u_int
);
368 extern void igrp_print(netdissect_options
*,const u_char
*, u_int
,
370 extern int nextproto4_cksum(const struct ip
*, const u_int8_t
*, u_int
, u_int
);
371 extern void ipN_print(netdissect_options
*,const u_char
*, u_int
);
372 extern void ipx_print(netdissect_options
*,const u_char
*, u_int
);
373 extern void isoclns_print(netdissect_options
*,const u_char
*,
374 u_int
, u_int
, const u_char
*, const u_char
*);
375 extern void krb_print(netdissect_options
*,const u_char
*, u_int
);
376 extern void llap_print(netdissect_options
*,const u_char
*, u_int
);
377 extern const char *linkaddr_string(netdissect_options
*ndo
,
378 const u_char
*ep
, const unsigned int len
);
379 extern void ltalk_if_print(netdissect_options
*ndo
,
380 u_char
*user
, const struct pcap_pkthdr
*h
,
382 extern void mpls_print(netdissect_options
*ndo
,
383 const u_char
*bp
, u_int length
);
384 extern void msdp_print(netdissect_options
*ndo
,
385 const unsigned char *sp
, u_int length
);
386 extern void nfsreply_print(netdissect_options
*,const u_char
*,
387 u_int
, const u_char
*);
388 extern void nfsreq_print(netdissect_options
*,const u_char
*,
389 u_int
, const u_char
*);
390 extern void ns_print(netdissect_options
*,const u_char
*, u_int
);
391 extern void ntp_print(netdissect_options
*,const u_char
*, u_int
);
392 extern void null_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
393 extern void ospf_print(netdissect_options
*,const u_char
*,
394 u_int
, const u_char
*);
395 extern void pimv1_print(netdissect_options
*,const u_char
*, u_int
);
396 extern void mobile_print(netdissect_options
*,const u_char
*, u_int
);
397 extern void pim_print(netdissect_options
*,const u_char
*, u_int
, u_int
);
398 extern void pppoe_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
399 extern void pppoe_print(netdissect_options
*,const u_char
*, u_int
);
400 extern void ppp_print(netdissect_options
*,
401 register const u_char
*, u_int
);
403 extern void ppp_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
404 extern void ppp_hdlc_if_print(u_char
*,
405 const struct pcap_pkthdr
*, const u_char
*);
406 extern void ppp_bsdos_if_print(u_char
*,
407 const struct pcap_pkthdr
*, const u_char
*);
409 extern int vjc_print(netdissect_options
*,register const char *,
410 register u_int
, u_short
);
412 extern void raw_if_print(u_char
*,
413 const struct pcap_pkthdr
*, const u_char
*);
415 extern void rip_print(netdissect_options
*,const u_char
*, u_int
);
416 extern void rpki_rtr_print(netdissect_options
*,const u_char
*, u_int
);
418 extern void sctp_print(netdissect_options
*ndo
,
419 const u_char
*bp
, const u_char
*bp2
,
420 u_int sctpPacketLength
);
422 extern void sl_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
424 extern void lane_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
425 extern void cip_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
426 extern void sl_bsdos_if_print(u_char
*,
427 const struct pcap_pkthdr
*, const u_char
*);
428 extern void sll_if_print(u_char
*,
429 const struct pcap_pkthdr
*, const u_char
*);
431 extern void snmp_print(netdissect_options
*,const u_char
*, u_int
);
432 extern void sunrpcrequest_print(netdissect_options
*,const u_char
*,
433 u_int
, const u_char
*);
434 extern void tcp_print(netdissect_options
*,const u_char
*, u_int
,
435 const u_char
*, int);
436 extern void tftp_print(netdissect_options
*,const u_char
*, u_int
);
437 extern void timed_print(netdissect_options
*,const u_char
*, u_int
);
438 extern void udp_print(netdissect_options
*,const u_char
*, u_int
,
439 const u_char
*, int);
440 extern void wb_print(netdissect_options
*,const void *, u_int
);
441 extern int ah_print(netdissect_options
*,register const u_char
*,
442 register const u_char
*);
443 extern void esp_print_decodesecret(netdissect_options
*ndo
);
444 extern int ipcomp_print(netdissect_options
*,register const u_char
*,
445 register const u_char
*, int *);
446 extern void rx_print(netdissect_options
*,register const u_char
*,
447 int, int, int, u_char
*);
448 extern void netbeui_print(netdissect_options
*,u_short
,
449 const u_char
*, int);
450 extern void ipx_netbios_print(netdissect_options
*,const u_char
*, u_int
);
451 extern void nbt_tcp_print(netdissect_options
*,const u_char
*, int);
452 extern void nbt_udp137_print(netdissect_options
*,
453 const u_char
*data
, int);
454 extern void nbt_udp138_print(netdissect_options
*,
455 const u_char
*data
, int);
456 extern char *smb_errstr(netdissect_options
*,int, int);
457 extern const char *nt_errstr(netdissect_options
*, u_int32_t
);
458 extern void print_data(netdissect_options
*,const unsigned char *, int);
459 extern void l2tp_print(netdissect_options
*,const u_char
*, u_int
);
460 extern void lcp_print(netdissect_options
*,const u_char
*, u_int
);
461 extern void vrrp_print(netdissect_options
*,const u_char
*bp
,
463 extern void carp_print(netdissect_options
*,const u_char
*bp
,
465 extern void cdp_print(netdissect_options
*,const u_char
*,
466 u_int
, u_int
, const u_char
*, const u_char
*);
467 extern void stp_print(netdissect_options
*,const u_char
*p
, u_int length
);
468 extern void radius_print(netdissect_options
*,const u_char
*, u_int
);
469 extern void lwres_print(netdissect_options
*,const u_char
*, u_int
);
470 extern void pptp_print(netdissect_options
*,const u_char
*, u_int
);
473 extern u_int
ipnet_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
474 extern u_int
ppi_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
476 extern u_int
nflog_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
478 extern u_int
ieee802_15_4_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
481 extern void ip6_print(netdissect_options
*,const u_char
*, u_int
);
483 extern void ip6_opt_print(netdissect_options
*,const u_char
*, int);
484 extern int nextproto6_cksum(const struct ip6_hdr
*, const u_int8_t
*, u_int
, u_int
);
485 extern int hbhopt_print(netdissect_options
*,const u_char
*);
486 extern int dstopt_print(netdissect_options
*,const u_char
*);
487 extern int frag6_print(netdissect_options
*,const u_char
*,
489 extern void icmp6_print(netdissect_options
*,const u_char
*,
491 extern void ripng_print(netdissect_options
*,const u_char
*, int);
492 extern int rt6_print(netdissect_options
*,const u_char
*, const u_char
*);
493 extern void ospf6_print(netdissect_options
*,const u_char
*, u_int
);
494 extern void dhcp6_print(netdissect_options
*,const u_char
*,
495 u_int
, u_int16_t
, u_int16_t
);
497 extern void zephyr_print(netdissect_options
* ndo
,
498 const u_char
*cp
, int length
);
508 extern u_int16_t
in_cksum(const struct cksum_vec
*, int);
509 extern u_int16_t
in_cksum_shouldbe(u_int16_t
, u_int16_t
);
512 extern void esp_print_decodesecret(netdissect_options
*ndo
);
513 extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options
*ndo
,
515 u_char spii
[8], u_char spir
[8],
516 u_char
*buf
, u_char
*end
);
519 #endif /* netdissect_h */