xref: /freebsd/contrib/tcpdump/netdissect.h (revision 724b4bfdf1306e4f2c451b6d146fe0fe0353b2c8)
1 /*
2  * Copyright (c) 1988-1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Copyright (c) 1998-2004  Michael Richardson <mcr@tcpdump.org>
6  *      The TCPDUMP project
7  *
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
19  * written permission.
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.
23  *
24  * @(#) $Header: /tcpdump/master/tcpdump/netdissect.h,v 1.27 2008-08-16 11:36:20 hannes Exp $ (LBL)
25  */
26 
27 #ifndef netdissect_h
28 #define netdissect_h
29 
30 #ifdef HAVE_OS_PROTO_H
31 #include "os-proto.h"
32 #endif
33 #include <sys/types.h>
34 
35 #ifndef HAVE___ATTRIBUTE__
36 #define __attribute__(x)
37 #endif
38 
39 /* snprintf et al */
40 
41 #include <stdarg.h>
42 
43 #if !defined(HAVE_SNPRINTF)
44 int snprintf (char *str, size_t sz, const char *format, ...)
45      __attribute__ ((format (printf, 3, 4)));
46 #endif
47 
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)));
51 #endif
52 
53 #ifndef HAVE_STRLCAT
54 extern size_t strlcat (char *, const char *, size_t);
55 #endif
56 #ifndef HAVE_STRLCPY
57 extern size_t strlcpy (char *, const char *, size_t);
58 #endif
59 
60 #ifndef HAVE_STRDUP
61 extern char *strdup (const char *str);
62 #endif
63 
64 #ifndef HAVE_STRSEP
65 extern char *strsep(char **, const char *);
66 #endif
67 
68 struct tok {
69 	int v;			/* value */
70 	const char *s;		/* string */
71 };
72 
73 #define TOKBUFSIZE 128
74 extern const char *tok2strbuf(const struct tok *, const char *, int,
75 			      char *buf, size_t bufsize);
76 
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);
81 
82 
83 typedef struct netdissect_options netdissect_options;
84 
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
105 				 */
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 */
112 
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 */
119   int ndo_WflagChars;
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;
123 
124   char *ndo_espsecret;
125   struct sa_list *ndo_sa_list_head;  /* used by print-esp.c */
126   struct sa_list *ndo_sa_default;
127 
128   char *ndo_sigsecret;     	/* Signature verification secret key */
129 
130   struct esp_algorithm *ndo_espsecret_xform;   /* cache of decoded  */
131   char                 *ndo_espsecret_key;
132 
133   int   ndo_packettype;	/* as specified by -T */
134 
135   char *ndo_program_name;	/*used to generate self-identifying messages */
136 
137   int32_t ndo_thiszone;	/* seconds offset from gmt to local time */
138 
139   int   ndo_snaplen;
140 
141   /*global pointers to beginning and end of current packet (during printing) */
142   const u_char *ndo_packetp;
143   const u_char *ndo_snapend;
144 
145   /* bookkeeping for ^T output */
146   int ndo_infodelay;
147 
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);
152 
153   int  (*ndo_printf)(netdissect_options *,
154 		     const char *fmt, ...)
155 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
156 		     __attribute__ ((format (printf, 2, 3)))
157 #endif
158 		     ;
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)))
163 #endif
164 		     ;
165   void (*ndo_warning)(netdissect_options *,
166 		      const char *fmt, ...)
167 #ifdef __ATTRIBUTE___FORMAT_OK_FOR_FUNCTION_POINTERS
168 		     __attribute__ ((format (printf, 2, 3)))
169 #endif
170 		     ;
171 };
172 
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 
181 #ifndef min
182 #define min(a,b) ((a)>(b)?(b):(a))
183 #endif
184 #ifndef max
185 #define max(a,b) ((b)>(a)?(b):(a))
186 #endif
187 
188 /*
189  * Maximum snapshot length.  This should be enough to capture the full
190  * packet on most network interfaces.
191  *
192  * XXX - could it be larger?  If so, should it?  Some applications might
193  * use the snapshot length in a savefile header to control the size of
194  * the buffer they allocate, so a size of, say, 2^31-1 might not work
195  * well.
196  */
197 #define MAXIMUM_SNAPLEN	65535
198 
199 /*
200  * The default snapshot length is the maximum.
201  */
202 #define DEFAULT_SNAPLEN	MAXIMUM_SNAPLEN
203 
204 #define ESRC(ep) ((ep)->ether_shost)
205 #define EDST(ep) ((ep)->ether_dhost)
206 
207 #ifndef NTOHL
208 #define NTOHL(x)	(x) = ntohl(x)
209 #define NTOHS(x)	(x) = ntohs(x)
210 #define HTONL(x)	(x) = htonl(x)
211 #define HTONS(x)	(x) = htons(x)
212 #endif
213 
214 /*
215  * True if "l" bytes of "var" were captured.
216  *
217  * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
218  * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
219  *
220  * The check is for <= rather than < because "l" might be 0.
221  */
222 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
223 			(const u_char *)&(var) <= ndo->ndo_snapend - (l))
224 
225 /* True if "var" was captured */
226 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
227 
228 /* Bail if "l" bytes of "var" were not captured */
229 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
230 
231 /* Bail if "var" was not captured */
232 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
233 
234 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
235 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
236 
237 #if 0
238 extern void ts_print(netdissect_options *ipdo,
239 		     const struct timeval *);
240 extern void relts_print(int);
241 #endif
242 
243 extern int fn_print(const u_char *, const u_char *);
244 extern int fn_printn(const u_char *, u_int, const u_char *);
245 extern const char *tok2str(const struct tok *, const char *, int);
246 
247 extern void wrapup(int);
248 
249 #if 0
250 extern char *read_infile(netdissect_options *, char *);
251 extern char *copy_argv(netdissect_options *, char **);
252 #endif
253 
254 extern void safeputchar(int);
255 extern void safeputs(const char *, int);
256 
257 #define PLURAL_SUFFIX(n) \
258 	(((n) != 1) ? "s" : "")
259 
260 #if 0
261 extern const char *isonsap_string(netdissect_options *, const u_char *);
262 extern const char *protoid_string(netdissect_options *, const u_char *);
263 extern const char *dnname_string(netdissect_options *, u_short);
264 extern const char *dnnum_string(netdissect_options *, u_short);
265 #endif
266 
267 /* The printer routines. */
268 
269 #include <pcap.h>
270 
271 typedef u_int (*if_ndo_printer)(struct netdissect_options *ndo,
272 				const struct pcap_pkthdr *, const u_char *);
273 typedef u_int (*if_printer)(const struct pcap_pkthdr *, const u_char *);
274 
275 extern if_ndo_printer lookup_ndo_printer(int);
276 extern if_printer lookup_printer(int);
277 
278 extern void eap_print(netdissect_options *,const u_char *, u_int);
279 extern int esp_print(netdissect_options *,
280 		     register const u_char *bp, int len, register const u_char *bp2,
281 		     int *nhdr, int *padlen);
282 extern void arp_print(netdissect_options *,const u_char *, u_int, u_int);
283 extern void tipc_print(netdissect_options *, const u_char *, u_int, u_int);
284 extern void icmp6_print(netdissect_options *ndo, const u_char *,
285                         u_int, const u_char *, int);
286 extern void isakmp_print(netdissect_options *,const u_char *,
287 			 u_int, const u_char *);
288 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
289 				 u_int, const u_char *);
290 extern void ip_print(netdissect_options *,const u_char *, u_int);
291 extern void ip_print_inner(netdissect_options *ndo,
292 			   const u_char *bp, u_int length, u_int nh,
293 			   const u_char *bp2);
294 extern void rrcp_print(netdissect_options *,const u_char *, u_int);
295 
296 extern void ether_print(netdissect_options *,
297                         const u_char *, u_int, u_int,
298                         void (*)(netdissect_options *, const u_char *),
299                         const u_char *);
300 
301 extern u_int ether_if_print(netdissect_options *,
302                             const struct pcap_pkthdr *,const u_char *);
303 extern u_int netanalyzer_if_print(netdissect_options *,
304                                   const struct pcap_pkthdr *,const u_char *);
305 extern u_int netanalyzer_transparent_if_print(netdissect_options *,
306                                               const struct pcap_pkthdr *,
307                                               const u_char *);
308 
309 extern int ethertype_print(netdissect_options *,u_short, const u_char *,
310 			     u_int, u_int);
311 
312 /* stuff that has not yet been rototiled */
313 #if 0
314 extern void ascii_print(netdissect_options *,u_int);
315 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
316 				    u_int, u_int);
317 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
318 extern void hex_print_with_offset(netdissect_options *,const char *,
319 				  u_int, u_int);
320 extern void hex_print(netdissect_options *,const char *, u_int);
321 extern void telnet_print(netdissect_options *,const u_char *, u_int);
322 extern int llc_print(netdissect_options *,
323 		     const u_char *, u_int, u_int, const u_char *,
324 		     const u_char *, u_short *);
325 extern void aarp_print(netdissect_options *,const u_char *, u_int);
326 extern void atalk_print(netdissect_options *,const u_char *, u_int);
327 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
328 extern void bootp_print(netdissect_options *,const u_char *,
329 			u_int, u_short, u_short);
330 extern void bgp_print(netdissect_options *,const u_char *, int);
331 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
332 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
333 			   register const u_char *p);
334 extern void chdlc_print(netdissect_options *ndo,
335 			register const u_char *p, u_int length, u_int caplen);
336 extern void cisco_autorp_print(netdissect_options *,
337 			       const u_char *, u_int);
338 extern void cnfp_print(netdissect_options *,const u_char *cp,
339 		       u_int len, const u_char *bp);
340 extern void decnet_print(netdissect_options *,const u_char *,
341 			 u_int, u_int);
342 extern void default_print(netdissect_options *,const u_char *, u_int);
343 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
344 extern void egp_print(netdissect_options *,const u_char *, u_int,
345 		      const u_char *);
346 
347 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
348 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
349 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
350 
351 extern void gre_print(netdissect_options *,const u_char *, u_int);
352 extern void icmp_print(netdissect_options *,const u_char *, u_int,
353 		       const u_char *);
354 extern void hsrp_print(netdissect_options *ndo,
355 		       register const u_char *bp, register u_int len);
356 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
357 extern void igmp_print(netdissect_options *,
358 		       register const u_char *, u_int);
359 extern void igrp_print(netdissect_options *,const u_char *, u_int,
360 		       const u_char *);
361 extern int nextproto4_cksum(const struct ip *, const u_int8_t *, u_int, u_int);
362 extern void ipN_print(netdissect_options *,const u_char *, u_int);
363 extern void ipx_print(netdissect_options *,const u_char *, u_int);
364 extern void isoclns_print(netdissect_options *,const u_char *,
365 			  u_int, u_int, const u_char *,	const u_char *);
366 extern void krb_print(netdissect_options *,const u_char *, u_int);
367 extern void llap_print(netdissect_options *,const u_char *, u_int);
368 extern const char *linkaddr_string(netdissect_options *ndo,
369 				   const u_char *ep, const unsigned int len);
370 extern void ltalk_if_print(netdissect_options *ndo,
371 			   u_char *user, const struct pcap_pkthdr *h,
372 			   const u_char *p);
373 extern void mpls_print(netdissect_options *ndo,
374 		       const u_char *bp, u_int length);
375 extern void msdp_print(netdissect_options *ndo,
376 		       const unsigned char *sp, u_int length);
377 extern void nfsreply_print(netdissect_options *,const u_char *,
378 			   u_int, const u_char *);
379 extern void nfsreq_print(netdissect_options *,const u_char *,
380 			 u_int, const u_char *);
381 extern void ns_print(netdissect_options *,const u_char *, u_int);
382 extern void ntp_print(netdissect_options *,const u_char *, u_int);
383 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
384 extern void ospf_print(netdissect_options *,const u_char *,
385 		       u_int, const u_char *);
386 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
387 extern void mobile_print(netdissect_options *,const u_char *, u_int);
388 extern void pim_print(netdissect_options *,const u_char *, u_int, u_int);
389 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
390 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
391 extern void ppp_print(netdissect_options *,
392 		      register const u_char *, u_int);
393 
394 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
395 extern void ppp_hdlc_if_print(u_char *,
396 			      const struct pcap_pkthdr *, const u_char *);
397 extern void ppp_bsdos_if_print(u_char *,
398 			       const struct pcap_pkthdr *, const u_char *);
399 
400 extern int vjc_print(netdissect_options *,register const char *,
401 		     register u_int, u_short);
402 
403 extern void raw_if_print(u_char *,
404 			 const struct pcap_pkthdr *, const u_char *);
405 
406 extern void rip_print(netdissect_options *,const u_char *, u_int);
407 extern void rpki_rtr_print(netdissect_options *,const u_char *, u_int);
408 
409 extern void sctp_print(netdissect_options *ndo,
410 		       const u_char *bp, const u_char *bp2,
411 		       u_int sctpPacketLength);
412 
413 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
414 
415 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
416 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
417 extern void sl_bsdos_if_print(u_char *,
418 			      const struct pcap_pkthdr *, const u_char *);
419 extern void sll_if_print(u_char *,
420 			 const struct pcap_pkthdr *, const u_char *);
421 
422 extern void snmp_print(netdissect_options *,const u_char *, u_int);
423 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
424 				u_int, const u_char *);
425 extern void tcp_print(netdissect_options *,const u_char *, u_int,
426 		      const u_char *, int);
427 extern void tftp_print(netdissect_options *,const u_char *, u_int);
428 extern void timed_print(netdissect_options *,const u_char *, u_int);
429 extern void udp_print(netdissect_options *,const u_char *, u_int,
430 		      const u_char *, int);
431 extern void wb_print(netdissect_options *,const void *, u_int);
432 extern int ah_print(netdissect_options *,register const u_char *,
433 		    register const u_char *);
434 extern void esp_print_decodesecret(netdissect_options *ndo);
435 extern int ipcomp_print(netdissect_options *,register const u_char *,
436 			register const u_char *, int *);
437 extern void rx_print(netdissect_options *,register const u_char *,
438 		     int, int, int, u_char *);
439 extern void netbeui_print(netdissect_options *,u_short,
440 			  const u_char *, int);
441 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
442 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
443 extern void nbt_udp137_print(netdissect_options *,
444 			     const u_char *data, int);
445 extern void nbt_udp138_print(netdissect_options *,
446 			     const u_char *data, int);
447 extern char *smb_errstr(netdissect_options *,int, int);
448 extern const char *nt_errstr(netdissect_options *, u_int32_t);
449 extern void print_data(netdissect_options *,const unsigned char *, int);
450 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
451 extern void lcp_print(netdissect_options *,const u_char *, u_int);
452 extern void vrrp_print(netdissect_options *,const u_char *bp,
453 		       u_int len, int ttl);
454 extern void carp_print(netdissect_options *,const u_char *bp,
455 		       u_int len, int ttl);
456 extern void cdp_print(netdissect_options *,const u_char *,
457 		      u_int, u_int, const u_char *, const u_char *);
458 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
459 extern void radius_print(netdissect_options *,const u_char *, u_int);
460 extern void lwres_print(netdissect_options *,const u_char *, u_int);
461 extern void pptp_print(netdissect_options *,const u_char *, u_int);
462 #endif
463 
464 extern u_int ipnet_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
465 extern u_int ppi_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
466 
467 extern u_int ieee802_15_4_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
468 
469 #ifdef INET6
470 extern void ip6_print(netdissect_options *,const u_char *, u_int);
471 #if 0
472 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
473 extern int nextproto6_cksum(const struct ip6_hdr *, const u_int8_t *, u_int, u_int);
474 extern int hbhopt_print(netdissect_options *,const u_char *);
475 extern int dstopt_print(netdissect_options *,const u_char *);
476 extern int frag6_print(netdissect_options *,const u_char *,
477 		       const u_char *);
478 extern void icmp6_print(netdissect_options *,const u_char *,
479 			const u_char *);
480 extern void ripng_print(netdissect_options *,const u_char *, int);
481 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
482 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
483 extern void dhcp6_print(netdissect_options *,const u_char *,
484 			u_int, u_int16_t, u_int16_t);
485 
486 extern void zephyr_print(netdissect_options * ndo,
487 			 const u_char *cp, int length);
488 #endif /* 0 */
489 
490 #endif /*INET6*/
491 
492 #if 0
493 struct cksum_vec {
494 	const u_int8_t	*ptr;
495 	int		len;
496 };
497 extern u_int16_t in_cksum(const struct cksum_vec *, int);
498 extern u_int16_t in_cksum_shouldbe(u_int16_t, u_int16_t);
499 #endif
500 
501 extern void esp_print_decodesecret(netdissect_options *ndo);
502 extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo,
503 					     int initiator,
504 					     u_char spii[8], u_char spir[8],
505 					     u_char *buf, u_char *end);
506 
507 
508 #endif  /* netdissect_h */
509