xref: /freebsd/contrib/tcpdump/netdissect.h (revision 195ebc7e9e4b129de810833791a19dfb4349d6a9)
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.23.2.2 2008-04-04 19:42:52 guy 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_eflag;		/* print ethernet header */
88   int ndo_fflag;		/* don't translate "foreign" IP address */
89   int ndo_Kflag;		/* don't check TCP checksums */
90   int ndo_nflag;		/* leave addresses as numbers */
91   int ndo_Nflag;		/* remove domains from printed host names */
92   int ndo_qflag;		/* quick (shorter) output */
93   int ndo_Rflag;		/* print sequence # field in AH/ESP*/
94   int ndo_sflag;		/* use the libsmi to translate OIDs */
95   int ndo_Sflag;		/* print raw TCP sequence numbers */
96   int ndo_tflag;		/* print packet arrival time */
97   int ndo_Uflag;		/* "unbuffered" output of dump files */
98   int ndo_uflag;		/* Print undecoded NFS handles */
99   int ndo_vflag;		/* verbose */
100   int ndo_xflag;		/* print packet in hex */
101   int ndo_Xflag;		/* print packet in hex/ascii */
102   int ndo_Aflag;		/* print packet only in ascii observing TAB,
103 				 * LF, CR and SPACE as graphical chars
104 				 */
105   int ndo_Bflag;		/* buffer size */
106   int ndo_Iflag;		/* rfmon (monitor) mode */
107   int ndo_Oflag;                /* run filter code optimizer */
108   int ndo_dlt;                  /* if != -1, ask libpcap for the DLT it names*/
109   int ndo_pflag;                /* don't go promiscuous */
110 
111   int ndo_Cflag;                /* rotate dump files after this many bytes */
112   int ndo_Cflag_count;      /* Keep track of which file number we're writing */
113   int ndo_Gflag;            /* rotate dump files after this many seconds */
114   int ndo_Gflag_count;      /* number of files created with Gflag rotation */
115   time_t ndo_Gflag_time;    /* The last time_t the dump file was rotated. */
116   int ndo_Wflag;          /* recycle output files after this number of files */
117   int ndo_WflagChars;
118   int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
119   const char *ndo_dltname;
120 
121   char *ndo_espsecret;
122   struct sa_list *ndo_sa_list_head;  /* used by print-esp.c */
123   struct sa_list *ndo_sa_default;
124 
125   char *ndo_tcpmd5secret;     	/* TCP-MD5 secret key */
126 
127   struct esp_algorithm *ndo_espsecret_xform;   /* cache of decoded  */
128   char                 *ndo_espsecret_key;
129 
130   int   ndo_packettype;	/* as specified by -T */
131 
132   char *ndo_program_name;	/*used to generate self-identifying messages */
133 
134   int32_t ndo_thiszone;	/* seconds offset from gmt to local time */
135 
136   int   ndo_snaplen;
137 
138   /*global pointers to beginning and end of current packet (during printing) */
139   const u_char *ndo_packetp;
140   const u_char *ndo_snapend;
141 
142   /* bookkeeping for ^T output */
143   int ndo_infodelay;
144 
145   /* pointer to void function to output stuff */
146   void (*ndo_default_print)(netdissect_options *,
147   		      register const u_char *bp, register u_int length);
148   void (*ndo_info)(netdissect_options *, int verbose);
149 
150   int  (*ndo_printf)(netdissect_options *,
151 		     const char *fmt, ...);
152   void (*ndo_error)(netdissect_options *,
153 		    const char *fmt, ...);
154   void (*ndo_warning)(netdissect_options *,
155 		      const char *fmt, ...);
156 };
157 
158 #define PT_VAT		1	/* Visual Audio Tool */
159 #define PT_WB		2	/* distributed White Board */
160 #define PT_RPC		3	/* Remote Procedure Call */
161 #define PT_RTP		4	/* Real-Time Applications protocol */
162 #define PT_RTCP		5	/* Real-Time Applications control protocol */
163 #define PT_SNMP		6	/* Simple Network Management Protocol */
164 #define PT_CNFP		7	/* Cisco NetFlow protocol */
165 
166 #ifndef min
167 #define min(a,b) ((a)>(b)?(b):(a))
168 #endif
169 #ifndef max
170 #define max(a,b) ((b)>(a)?(b):(a))
171 #endif
172 
173 #ifndef INET6
174 /*
175  * The default snapshot length.  This value allows most printers to print
176  * useful information while keeping the amount of unwanted data down.
177  * In particular, it allows for an ethernet header, tcp/ip header, and
178  * 14 bytes of data (assuming no ip options).
179  */
180 #define DEFAULT_SNAPLEN 68
181 #else
182 #define DEFAULT_SNAPLEN 96
183 #endif
184 
185 #ifndef BIG_ENDIAN
186 #define BIG_ENDIAN 4321
187 #define LITTLE_ENDIAN 1234
188 #endif
189 
190 #define ESRC(ep) ((ep)->ether_shost)
191 #define EDST(ep) ((ep)->ether_dhost)
192 
193 #ifndef NTOHL
194 #define NTOHL(x)	(x) = ntohl(x)
195 #define NTOHS(x)	(x) = ntohs(x)
196 #define HTONL(x)	(x) = htonl(x)
197 #define HTONS(x)	(x) = htons(x)
198 #endif
199 
200 /*
201  * True if "l" bytes of "var" were captured.
202  *
203  * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
204  * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
205  *
206  * The check is for <= rather than < because "l" might be 0.
207  */
208 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
209 			(const u_char *)&(var) <= ndo->ndo_snapend - (l))
210 
211 /* True if "var" was captured */
212 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
213 
214 /* Bail if "l" bytes of "var" were not captured */
215 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
216 
217 /* Bail if "var" was not captured */
218 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
219 
220 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
221 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
222 
223 #if 0
224 extern void ts_print(netdissect_options *ipdo,
225 		     const struct timeval *);
226 extern void relts_print(int);
227 #endif
228 
229 extern int fn_print(const u_char *, const u_char *);
230 extern int fn_printn(const u_char *, u_int, const u_char *);
231 extern const char *tok2str(const struct tok *, const char *, int);
232 
233 extern void wrapup(int);
234 
235 #if 0
236 extern char *read_infile(netdissect_options *, char *);
237 extern char *copy_argv(netdissect_options *, char **);
238 #endif
239 
240 extern void safeputchar(int);
241 extern void safeputs(const char *, int);
242 
243 #if 0
244 extern const char *isonsap_string(netdissect_options *, const u_char *);
245 extern const char *protoid_string(netdissect_options *, const u_char *);
246 extern const char *dnname_string(netdissect_options *, u_short);
247 extern const char *dnnum_string(netdissect_options *, u_short);
248 #endif
249 
250 /* The printer routines. */
251 
252 #include <pcap.h>
253 
254 
255 extern void eap_print(netdissect_options *,const u_char *, u_int);
256 extern int esp_print(netdissect_options *,
257 		     register const u_char *bp, int len, register const u_char *bp2,
258 		     int *nhdr, int *padlen);
259 extern void arp_print(netdissect_options *,const u_char *, u_int, u_int);
260 extern void isakmp_print(netdissect_options *,const u_char *,
261 			 u_int, const u_char *);
262 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
263 				 u_int, const u_char *);
264 extern void ip_print(netdissect_options *,const u_char *, u_int);
265 extern void ip_print_inner(netdissect_options *ndo,
266 			   const u_char *bp, u_int length, u_int nh,
267 			   const u_char *bp2);
268 extern void rrcp_print(netdissect_options *,const u_char *, u_int);
269 
270 /* stuff that has not yet been rototiled */
271 #if 0
272 extern void ascii_print(netdissect_options *,u_int);
273 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
274 				    u_int, u_int);
275 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
276 extern void hex_print_with_offset(netdissect_options *,const char *,
277 				  u_int, u_int);
278 extern void hex_print(netdissect_options *,const char *, u_int);
279 extern void telnet_print(netdissect_options *,const u_char *, u_int);
280 extern int ether_encap_print(netdissect_options *,u_short, const u_char *,
281 			     u_int, u_int, u_short *);
282 extern int llc_print(netdissect_options *,
283 		     const u_char *, u_int, u_int, const u_char *,
284 		     const u_char *, u_short *);
285 extern void aarp_print(netdissect_options *,const u_char *, u_int);
286 extern void atalk_print(netdissect_options *,const u_char *, u_int);
287 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
288 extern void bootp_print(netdissect_options *,const u_char *,
289 			u_int, u_short, u_short);
290 extern void bgp_print(netdissect_options *,const u_char *, int);
291 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
292 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
293 			   register const u_char *p);
294 extern void chdlc_print(netdissect_options *ndo,
295 			register const u_char *p, u_int length, u_int caplen);
296 extern void cisco_autorp_print(netdissect_options *,
297 			       const u_char *, u_int);
298 extern void cnfp_print(netdissect_options *,const u_char *cp,
299 		       u_int len, const u_char *bp);
300 extern void decnet_print(netdissect_options *,const u_char *,
301 			 u_int, u_int);
302 extern void default_print(netdissect_options *,const u_char *, u_int);
303 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
304 extern void egp_print(netdissect_options *,const u_char *, u_int,
305 		      const u_char *);
306 
307 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
308 extern void ether_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
309 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
310 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
311 
312 extern void gre_print(netdissect_options *,const u_char *, u_int);
313 extern void icmp_print(netdissect_options *,const u_char *, u_int,
314 		       const u_char *);
315 extern void hsrp_print(netdissect_options *ndo,
316 		       register const u_char *bp, register u_int len);
317 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
318 extern void igmp_print(netdissect_options *,
319 		       register const u_char *, u_int);
320 extern void igrp_print(netdissect_options *,const u_char *, u_int,
321 		       const u_char *);
322 extern void ipN_print(netdissect_options *,const u_char *, u_int);
323 extern void ipx_print(netdissect_options *,const u_char *, u_int);
324 extern void isoclns_print(netdissect_options *,const u_char *,
325 			  u_int, u_int, const u_char *,	const u_char *);
326 extern void krb_print(netdissect_options *,const u_char *, u_int);
327 extern void llap_print(netdissect_options *,const u_char *, u_int);
328 extern const char *linkaddr_string(netdissect_options *ndo,
329 				   const u_char *ep, const unsigned int len);
330 extern void ltalk_if_print(netdissect_options *ndo,
331 			   u_char *user, const struct pcap_pkthdr *h,
332 			   const u_char *p);
333 extern void mpls_print(netdissect_options *ndo,
334 		       const u_char *bp, u_int length);
335 extern void msdp_print(netdissect_options *ndo,
336 		       const unsigned char *sp, u_int length);
337 extern void nfsreply_print(netdissect_options *,const u_char *,
338 			   u_int, const u_char *);
339 extern void nfsreq_print(netdissect_options *,const u_char *,
340 			 u_int, const u_char *);
341 extern void ns_print(netdissect_options *,const u_char *, u_int);
342 extern void ntp_print(netdissect_options *,const u_char *, u_int);
343 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
344 extern void ospf_print(netdissect_options *,const u_char *,
345 		       u_int, const u_char *);
346 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
347 extern void mobile_print(netdissect_options *,const u_char *, u_int);
348 extern void pim_print(netdissect_options *,const u_char *, u_int);
349 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
350 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
351 extern void ppp_print(netdissect_options *,
352 		      register const u_char *, u_int);
353 
354 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
355 extern void ppp_hdlc_if_print(u_char *,
356 			      const struct pcap_pkthdr *, const u_char *);
357 extern void ppp_bsdos_if_print(u_char *,
358 			       const struct pcap_pkthdr *, const u_char *);
359 
360 extern int vjc_print(netdissect_options *,register const char *,
361 		     register u_int, u_short);
362 
363 extern void raw_if_print(u_char *,
364 			 const struct pcap_pkthdr *, const u_char *);
365 
366 extern void rip_print(netdissect_options *,const u_char *, u_int);
367 
368 extern void sctp_print(netdissect_options *ndo,
369 		       const u_char *bp, const u_char *bp2,
370 		       u_int sctpPacketLength);
371 
372 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
373 
374 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
375 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
376 extern void sl_bsdos_if_print(u_char *,
377 			      const struct pcap_pkthdr *, const u_char *);
378 extern void sll_if_print(u_char *,
379 			 const struct pcap_pkthdr *, const u_char *);
380 
381 extern void snmp_print(netdissect_options *,const u_char *, u_int);
382 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
383 				u_int, const u_char *);
384 extern void tcp_print(netdissect_options *,const u_char *, u_int,
385 		      const u_char *, int);
386 extern void tftp_print(netdissect_options *,const u_char *, u_int);
387 extern void timed_print(netdissect_options *,const u_char *, u_int);
388 extern void udp_print(netdissect_options *,const u_char *, u_int,
389 		      const u_char *, int);
390 extern void wb_print(netdissect_options *,const void *, u_int);
391 extern int ah_print(netdissect_options *,register const u_char *,
392 		    register const u_char *);
393 extern void esp_print_decodesecret(netdissect_options *ndo);
394 extern int ipcomp_print(netdissect_options *,register const u_char *,
395 			register const u_char *, int *);
396 extern void rx_print(netdissect_options *,register const u_char *,
397 		     int, int, int, u_char *);
398 extern void netbeui_print(netdissect_options *,u_short,
399 			  const u_char *, int);
400 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
401 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
402 extern void nbt_udp137_print(netdissect_options *,
403 			     const u_char *data, int);
404 extern void nbt_udp138_print(netdissect_options *,
405 			     const u_char *data, int);
406 extern char *smb_errstr(netdissect_options *,int, int);
407 extern const char *nt_errstr(netdissect_options *, u_int32_t);
408 extern void print_data(netdissect_options *,const unsigned char *, int);
409 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
410 extern void lcp_print(netdissect_options *,const u_char *, u_int);
411 extern void vrrp_print(netdissect_options *,const u_char *bp,
412 		       u_int len, int ttl);
413 extern void cdp_print(netdissect_options *,const u_char *,
414 		      u_int, u_int, const u_char *, const u_char *);
415 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
416 extern void radius_print(netdissect_options *,const u_char *, u_int);
417 extern void lwres_print(netdissect_options *,const u_char *, u_int);
418 extern void pptp_print(netdissect_options *,const u_char *, u_int);
419 
420 #ifdef INET6
421 extern void ip6_print(netdissect_options *,const u_char *, u_int);
422 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
423 extern int hbhopt_print(netdissect_options *,const u_char *);
424 extern int dstopt_print(netdissect_options *,const u_char *);
425 extern int frag6_print(netdissect_options *,const u_char *,
426 		       const u_char *);
427 extern void icmp6_print(netdissect_options *,const u_char *,
428 			const u_char *);
429 extern void ripng_print(netdissect_options *,const u_char *, int);
430 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
431 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
432 extern void dhcp6_print(netdissect_options *,const u_char *,
433 			u_int, u_int16_t, u_int16_t);
434 
435 extern void zephyr_print(netdissect_options * ndo,
436 			 const u_char *cp, int length);
437 
438 #endif /*INET6*/
439 extern u_short in_cksum(const u_short *,
440 			register u_int, int);
441 
442 #endif
443 
444 #endif  /* netdissect_h */
445