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 #ifdef __ATTRIBUTE___FORMAT_OK
46 __attribute__((format (printf
, 3, 4)))
47 #endif /* __ATTRIBUTE___FORMAT_OK */
49 #endif /* !defined(HAVE_SNPRINTF) */
51 #if !defined(HAVE_VSNPRINTF)
52 int vsnprintf (char *str
, size_t sz
, const char *format
, va_list ap
)
53 #ifdef __ATTRIBUTE___FORMAT_OK
54 __attribute__((format (printf
, 3, 0)))
55 #endif /* __ATTRIBUTE___FORMAT_OK */
57 #endif /* !defined(HAVE_SNPRINTF) */
60 extern size_t strlcat (char *, const char *, size_t);
63 extern size_t strlcpy (char *, const char *, size_t);
67 extern char *strdup (const char *str
);
71 extern char *strsep(char **, const char *);
76 const char *s
; /* string */
79 #define TOKBUFSIZE 128
80 extern const char *tok2strbuf(const struct tok
*, const char *, int,
81 char *buf
, size_t bufsize
);
83 /* tok2str is deprecated */
84 extern const char *tok2str(const struct tok
*, const char *, int);
85 extern char *bittok2str(const struct tok
*, const char *, int);
86 extern char *bittok2str_nosep(const struct tok
*, const char *, int);
89 typedef struct netdissect_options netdissect_options
;
91 struct netdissect_options
{
92 int ndo_aflag
; /* translate network and broadcast addresses */
93 int ndo_bflag
; /* print 4 byte ASes in ASDOT notation */
94 int ndo_eflag
; /* print ethernet header */
95 int ndo_fflag
; /* don't translate "foreign" IP address */
96 int ndo_Kflag
; /* don't check TCP checksums */
97 int ndo_nflag
; /* leave addresses as numbers */
98 int ndo_Nflag
; /* remove domains from printed host names */
99 int ndo_qflag
; /* quick (shorter) output */
100 int ndo_Rflag
; /* print sequence # field in AH/ESP*/
101 int ndo_sflag
; /* use the libsmi to translate OIDs */
102 int ndo_Sflag
; /* print raw TCP sequence numbers */
103 int ndo_tflag
; /* print packet arrival time */
104 int ndo_Uflag
; /* "unbuffered" output of dump files */
105 int ndo_uflag
; /* Print undecoded NFS handles */
106 int ndo_vflag
; /* verbose */
107 int ndo_xflag
; /* print packet in hex */
108 int ndo_Xflag
; /* print packet in hex/ascii */
109 int ndo_Aflag
; /* print packet only in ascii observing TAB,
110 * LF, CR and SPACE as graphical chars
112 int ndo_Bflag
; /* buffer size */
113 int ndo_Iflag
; /* rfmon (monitor) mode */
114 int ndo_Oflag
; /* run filter code optimizer */
115 int ndo_dlt
; /* if != -1, ask libpcap for the DLT it names*/
116 int ndo_jflag
; /* packet time stamp source */
117 int ndo_pflag
; /* don't go promiscuous */
119 int ndo_Cflag
; /* rotate dump files after this many bytes */
120 int ndo_Cflag_count
; /* Keep track of which file number we're writing */
121 int ndo_Gflag
; /* rotate dump files after this many seconds */
122 int ndo_Gflag_count
; /* number of files created with Gflag rotation */
123 time_t ndo_Gflag_time
; /* The last time_t the dump file was rotated. */
124 int ndo_Wflag
; /* recycle output files after this number of files */
126 int ndo_Hflag
; /* dissect 802.11s draft mesh standard */
127 int ndo_suppress_default_print
; /* don't use default_print() for unknown packet types */
128 const char *ndo_dltname
;
131 struct sa_list
*ndo_sa_list_head
; /* used by print-esp.c */
132 struct sa_list
*ndo_sa_default
;
134 char *ndo_sigsecret
; /* Signature verification secret key */
136 struct esp_algorithm
*ndo_espsecret_xform
; /* cache of decoded */
137 char *ndo_espsecret_key
;
139 int ndo_packettype
; /* as specified by -T */
141 char *ndo_program_name
; /*used to generate self-identifying messages */
143 int32_t ndo_thiszone
; /* seconds offset from gmt to local time */
147 /*global pointers to beginning and end of current packet (during printing) */
148 const u_char
*ndo_packetp
;
149 const u_char
*ndo_snapend
;
151 /* bookkeeping for ^T output */
154 /* pointer to void function to output stuff */
155 void (*ndo_default_print
)(netdissect_options
*,
156 register const u_char
*bp
, register u_int length
);
157 void (*ndo_info
)(netdissect_options
*, int verbose
);
159 int (*ndo_printf
)(netdissect_options
*,
160 const char *fmt
, ...)
161 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
162 __attribute__ ((format (printf
, 2, 3)))
165 void (*ndo_error
)(netdissect_options
*,
166 const char *fmt
, ...)
167 #ifdef __ATTRIBUTE___NORETURN_OK_FOR_FUNCTION_POINTERS
168 __attribute__ ((noreturn
))
169 #endif /* __ATTRIBUTE___NORETURN_OK_FOR_FUNCTION_POINTERS */
170 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
171 __attribute__ ((format (printf
, 2, 3)))
172 #endif /* __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS */
174 void (*ndo_warning
)(netdissect_options
*,
175 const char *fmt
, ...)
176 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
177 __attribute__ ((format (printf
, 2, 3)))
182 #define PT_VAT 1 /* Visual Audio Tool */
183 #define PT_WB 2 /* distributed White Board */
184 #define PT_RPC 3 /* Remote Procedure Call */
185 #define PT_RTP 4 /* Real-Time Applications protocol */
186 #define PT_RTCP 5 /* Real-Time Applications control protocol */
187 #define PT_SNMP 6 /* Simple Network Management Protocol */
188 #define PT_CNFP 7 /* Cisco NetFlow protocol */
189 #define PT_TFTP 8 /* trivial file transfer protocol */
190 #define PT_AODV 9 /* Ad-hoc On-demand Distance Vector Protocol */
191 #define PT_CARP 10 /* Common Address Redundancy Protocol */
192 #define PT_RADIUS 11 /* RADIUS authentication Protocol */
193 #define PT_ZMTP1 12 /* ZeroMQ Message Transport Protocol 1.0 */
194 #define PT_VXLAN 13 /* Virtual eXtensible Local Area Network */
195 #define PT_PGM 14 /* [UDP-encapsulated] Pragmatic General Multicast */
196 #define PT_PGM_ZMTP1 15 /* ZMTP/1.0 inside PGM (native or UDP-encapsulated) */
197 #define PT_LMP 16 /* Link Management Protocol */
200 #define min(a,b) ((a)>(b)?(b):(a))
203 #define max(a,b) ((b)>(a)?(b):(a))
207 * Maximum snapshot length. This should be enough to capture the full
208 * packet on most network interfaces.
210 * XXX - could it be larger? If so, should it? Some applications might
211 * use the snapshot length in a savefile header to control the size of
212 * the buffer they allocate, so a size of, say, 2^31-1 might not work
215 #define MAXIMUM_SNAPLEN 65535
218 * The default snapshot length is the maximum.
220 #define DEFAULT_SNAPLEN MAXIMUM_SNAPLEN
222 #define ESRC(ep) ((ep)->ether_shost)
223 #define EDST(ep) ((ep)->ether_dhost)
226 #define NTOHL(x) (x) = ntohl(x)
227 #define NTOHS(x) (x) = ntohs(x)
228 #define HTONL(x) (x) = htonl(x)
229 #define HTONS(x) (x) = htons(x)
233 * True if "l" bytes of "var" were captured.
235 * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
236 * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
238 * The check is for <= rather than < because "l" might be 0.
240 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
241 (const u_char *)&(var) <= ndo->ndo_snapend - (l))
243 /* True if "var" was captured */
244 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
246 /* Bail if "l" bytes of "var" were not captured */
247 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
249 /* Bail if "var" was not captured */
250 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
252 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
253 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
256 extern void ts_print(netdissect_options
*ipdo
,
257 const struct timeval
*);
258 extern void relts_print(int);
261 extern int fn_print(const u_char
*, const u_char
*);
262 extern int fn_printn(const u_char
*, u_int
, const u_char
*);
263 extern const char *tok2str(const struct tok
*, const char *, int);
265 extern void wrapup(int);
268 extern char *read_infile(netdissect_options
*, char *);
269 extern char *copy_argv(netdissect_options
*, char **);
272 extern void safeputchar(int);
273 extern void safeputs(const char *, int);
275 #define PLURAL_SUFFIX(n) \
276 (((n) != 1) ? "s" : "")
279 extern const char *isonsap_string(netdissect_options
*, const u_char
*);
280 extern const char *protoid_string(netdissect_options
*, const u_char
*);
281 extern const char *dnname_string(netdissect_options
*, u_short
);
282 extern const char *dnnum_string(netdissect_options
*, u_short
);
285 /* The printer routines. */
289 typedef u_int (*if_ndo_printer
)(struct netdissect_options
*ndo
,
290 const struct pcap_pkthdr
*, const u_char
*);
291 typedef u_int (*if_printer
)(const struct pcap_pkthdr
*, const u_char
*);
293 extern if_ndo_printer
lookup_ndo_printer(int);
294 extern if_printer
lookup_printer(int);
296 extern void eap_print(netdissect_options
*,const u_char
*, u_int
);
297 extern int esp_print(netdissect_options
*,
298 register const u_char
*bp
, int len
, register const u_char
*bp2
,
299 int *nhdr
, int *padlen
);
300 extern void arp_print(netdissect_options
*,const u_char
*, u_int
, u_int
);
301 extern void tipc_print(netdissect_options
*, const u_char
*, u_int
, u_int
);
302 extern void msnlb_print(netdissect_options
*, const u_char
*);
303 extern void icmp6_print(netdissect_options
*ndo
, const u_char
*,
304 u_int
, const u_char
*, int);
305 extern void isakmp_print(netdissect_options
*,const u_char
*,
306 u_int
, const u_char
*);
307 extern void isakmp_rfc3948_print(netdissect_options
*,const u_char
*,
308 u_int
, const u_char
*);
309 extern void ip_print(netdissect_options
*,const u_char
*, u_int
);
310 extern void ip_print_inner(netdissect_options
*ndo
,
311 const u_char
*bp
, u_int length
, u_int nh
,
313 extern void rrcp_print(netdissect_options
*,const u_char
*, u_int
);
315 extern void ether_print(netdissect_options
*,
316 const u_char
*, u_int
, u_int
,
317 void (*)(netdissect_options
*, const u_char
*),
320 extern u_int
ether_if_print(netdissect_options
*,
321 const struct pcap_pkthdr
*,const u_char
*);
322 extern u_int
netanalyzer_if_print(netdissect_options
*,
323 const struct pcap_pkthdr
*,const u_char
*);
324 extern u_int
netanalyzer_transparent_if_print(netdissect_options
*,
325 const struct pcap_pkthdr
*,
328 extern int ethertype_print(netdissect_options
*,u_short
, const u_char
*,
331 extern int print_unknown_data(netdissect_options
*,const u_char
*, const char *,int);
332 extern void hex_print_with_offset(netdissect_options
*, const char *ident
, const u_char
*cp
,
334 extern void hex_print(netdissect_options
*,const char *ident
, const u_char
*cp
,u_int
);
336 /* stuff that has not yet been rototiled */
338 extern void ascii_print(netdissect_options
*,u_int
);
339 extern void hex_and_ascii_print_with_offset(netdissect_options
*,const char *,
341 extern void hex_and_ascii_print(netdissect_options
*,const char *, u_int
);
342 extern void telnet_print(netdissect_options
*,const u_char
*, u_int
);
343 extern int llc_print(netdissect_options
*,
344 const u_char
*, u_int
, u_int
, const u_char
*,
345 const u_char
*, u_short
*);
346 extern void aarp_print(netdissect_options
*,const u_char
*, u_int
);
347 extern void atalk_print(netdissect_options
*,const u_char
*, u_int
);
348 extern void atm_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
349 extern void bootp_print(netdissect_options
*,const u_char
*,
350 u_int
, u_short
, u_short
);
351 extern void bgp_print(netdissect_options
*,const u_char
*, int);
352 extern void bxxp_print(netdissect_options
*,const u_char
*, u_int
);
353 extern void chdlc_if_print(u_char
*user
, const struct pcap_pkthdr
*h
,
354 register const u_char
*p
);
355 extern void chdlc_print(netdissect_options
*ndo
,
356 register const u_char
*p
, u_int length
, u_int caplen
);
357 extern void cisco_autorp_print(netdissect_options
*,
358 const u_char
*, u_int
);
359 extern void cnfp_print(netdissect_options
*,const u_char
*cp
,
360 u_int len
, const u_char
*bp
);
361 extern void decnet_print(netdissect_options
*,const u_char
*,
363 extern void default_print(netdissect_options
*,const u_char
*, u_int
);
364 extern void dvmrp_print(netdissect_options
*,const u_char
*, u_int
);
365 extern void egp_print(netdissect_options
*,const u_char
*, u_int
,
368 extern void arcnet_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
369 extern void token_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
370 extern void fddi_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
372 extern void gre_print(netdissect_options
*,const u_char
*, u_int
);
373 extern void icmp_print(netdissect_options
*,const u_char
*, u_int
,
375 extern void hsrp_print(netdissect_options
*ndo
,
376 register const u_char
*bp
, register u_int len
);
377 extern void ieee802_11_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
378 extern void igmp_print(netdissect_options
*,
379 register const u_char
*, u_int
);
380 extern void igrp_print(netdissect_options
*,const u_char
*, u_int
,
382 extern int nextproto4_cksum(const struct ip
*, const u_int8_t
*, u_int
, u_int
);
383 extern void ipN_print(netdissect_options
*,const u_char
*, u_int
);
384 extern void ipx_print(netdissect_options
*,const u_char
*, u_int
);
385 extern void isoclns_print(netdissect_options
*,const u_char
*,
386 u_int
, u_int
, const u_char
*, const u_char
*);
387 extern void krb_print(netdissect_options
*,const u_char
*, u_int
);
388 extern void llap_print(netdissect_options
*,const u_char
*, u_int
);
389 extern const char *linkaddr_string(netdissect_options
*ndo
,
390 const u_char
*ep
, const unsigned int len
);
391 extern void ltalk_if_print(netdissect_options
*ndo
,
392 u_char
*user
, const struct pcap_pkthdr
*h
,
394 extern void mpls_print(netdissect_options
*ndo
,
395 const u_char
*bp
, u_int length
);
396 extern void msdp_print(netdissect_options
*ndo
,
397 const unsigned char *sp
, u_int length
);
398 extern void nfsreply_print(netdissect_options
*,const u_char
*,
399 u_int
, const u_char
*);
400 extern void nfsreq_print(netdissect_options
*,const u_char
*,
401 u_int
, const u_char
*);
402 extern void ns_print(netdissect_options
*,const u_char
*, u_int
);
403 extern void ntp_print(netdissect_options
*,const u_char
*, u_int
);
404 extern void null_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
405 extern void ospf_print(netdissect_options
*,const u_char
*,
406 u_int
, const u_char
*);
407 extern void pimv1_print(netdissect_options
*,const u_char
*, u_int
);
408 extern void mobile_print(netdissect_options
*,const u_char
*, u_int
);
409 extern void pim_print(netdissect_options
*,const u_char
*, u_int
, u_int
);
410 extern void pppoe_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
411 extern void pppoe_print(netdissect_options
*,const u_char
*, u_int
);
412 extern void ppp_print(netdissect_options
*,
413 register const u_char
*, u_int
);
415 extern void ppp_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
416 extern void ppp_hdlc_if_print(u_char
*,
417 const struct pcap_pkthdr
*, const u_char
*);
418 extern void ppp_bsdos_if_print(u_char
*,
419 const struct pcap_pkthdr
*, const u_char
*);
421 extern int vjc_print(netdissect_options
*,register const char *,
422 register u_int
, u_short
);
424 extern void raw_if_print(u_char
*,
425 const struct pcap_pkthdr
*, const u_char
*);
427 extern void rip_print(netdissect_options
*,const u_char
*, u_int
);
428 extern void rpki_rtr_print(netdissect_options
*,const u_char
*, u_int
);
430 extern void sctp_print(netdissect_options
*ndo
,
431 const u_char
*bp
, const u_char
*bp2
,
432 u_int sctpPacketLength
);
434 extern void sl_if_print(u_char
*,const struct pcap_pkthdr
*, const u_char
*);
436 extern void lane_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
437 extern void cip_if_print(u_char
*,const struct pcap_pkthdr
*,const u_char
*);
438 extern void sl_bsdos_if_print(u_char
*,
439 const struct pcap_pkthdr
*, const u_char
*);
440 extern void sll_if_print(u_char
*,
441 const struct pcap_pkthdr
*, const u_char
*);
443 extern void snmp_print(netdissect_options
*,const u_char
*, u_int
);
444 extern void sunrpcrequest_print(netdissect_options
*,const u_char
*,
445 u_int
, const u_char
*);
446 extern void tcp_print(netdissect_options
*,const u_char
*, u_int
,
447 const u_char
*, int);
448 extern void tftp_print(netdissect_options
*,const u_char
*, u_int
);
449 extern void timed_print(netdissect_options
*,const u_char
*, u_int
);
450 extern void udp_print(netdissect_options
*,const u_char
*, u_int
,
451 const u_char
*, int);
452 extern void wb_print(netdissect_options
*,const void *, u_int
);
453 extern int ah_print(netdissect_options
*,register const u_char
*,
454 register const u_char
*);
455 extern void esp_print_decodesecret(netdissect_options
*ndo
);
456 extern int ipcomp_print(netdissect_options
*,register const u_char
*,
457 register const u_char
*, int *);
458 extern void rx_print(netdissect_options
*,register const u_char
*,
459 int, int, int, u_char
*);
460 extern void netbeui_print(netdissect_options
*,u_short
,
461 const u_char
*, int);
462 extern void ipx_netbios_print(netdissect_options
*,const u_char
*, u_int
);
463 extern void nbt_tcp_print(netdissect_options
*,const u_char
*, int);
464 extern void nbt_udp137_print(netdissect_options
*,
465 const u_char
*data
, int);
466 extern void nbt_udp138_print(netdissect_options
*,
467 const u_char
*data
, int);
468 extern char *smb_errstr(netdissect_options
*,int, int);
469 extern const char *nt_errstr(netdissect_options
*, u_int32_t
);
470 extern void print_data(netdissect_options
*,const unsigned char *, int);
471 extern void l2tp_print(netdissect_options
*,const u_char
*, u_int
);
472 extern void lcp_print(netdissect_options
*,const u_char
*, u_int
);
473 extern void vrrp_print(netdissect_options
*,const u_char
*bp
,
475 extern void carp_print(netdissect_options
*,const u_char
*bp
,
477 extern void cdp_print(netdissect_options
*,const u_char
*,
478 u_int
, u_int
, const u_char
*, const u_char
*);
479 extern void stp_print(netdissect_options
*,const u_char
*p
, u_int length
);
480 extern void radius_print(netdissect_options
*,const u_char
*, u_int
);
481 extern void lwres_print(netdissect_options
*,const u_char
*, u_int
);
482 extern void pptp_print(netdissect_options
*,const u_char
*, u_int
);
485 extern u_int
ipnet_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
486 extern u_int
ppi_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
487 extern u_int
nflog_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
488 extern u_int
ieee802_15_4_if_print(netdissect_options
*,const struct pcap_pkthdr
*, const u_char
*);
491 extern void ip6_print(netdissect_options
*,const u_char
*, u_int
);
493 extern void ip6_opt_print(netdissect_options
*,const u_char
*, int);
494 extern int nextproto6_cksum(const struct ip6_hdr
*, const u_int8_t
*, u_int
, u_int
);
495 extern int hbhopt_print(netdissect_options
*,const u_char
*);
496 extern int dstopt_print(netdissect_options
*,const u_char
*);
497 extern int frag6_print(netdissect_options
*,const u_char
*,
499 extern void icmp6_print(netdissect_options
*,const u_char
*,
501 extern void ripng_print(netdissect_options
*,const u_char
*, int);
502 extern int rt6_print(netdissect_options
*,const u_char
*, const u_char
*);
503 extern void ospf6_print(netdissect_options
*,const u_char
*, u_int
);
504 extern void dhcp6_print(netdissect_options
*,const u_char
*,
505 u_int
, u_int16_t
, u_int16_t
);
507 extern void zephyr_print(netdissect_options
* ndo
,
508 const u_char
*cp
, int length
);
518 extern u_int16_t
in_cksum(const struct cksum_vec
*, int);
519 extern u_int16_t
in_cksum_shouldbe(u_int16_t
, u_int16_t
);
522 extern void esp_print_decodesecret(netdissect_options
*ndo
);
523 extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options
*ndo
,
525 u_char spii
[8], u_char spir
[8],
526 u_char
*buf
, u_char
*end
);
529 extern void geonet_print(netdissect_options
*ndo
,const u_char
*eth_hdr
,const u_char
*geo_pck
, u_int len
);
530 extern void calm_fast_print(netdissect_options
*ndo
,const u_char
*eth_hdr
,const u_char
*calm_pck
, u_int len
);
532 #endif /* netdissect_h */