]> The Tcpdump Group git mirrors - tcpdump/blob - netdissect.h
projects / tcpdump / blob


c459b4c9f0936e647ec29e5bcd8859adf8828846
[tcpdump] / netdissect.h
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__ ((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 icmp6_print(netdissect_options *ndo, const u_char *,
284 u_int, const u_char *, int);
285 extern void isakmp_print(netdissect_options *,const u_char *,
286 u_int, const u_char *);
287 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
288 u_int, const u_char *);
289 extern void ip_print(netdissect_options *,const u_char *, u_int);
290 extern void ip_print_inner(netdissect_options *ndo,
291 const u_char *bp, u_int length, u_int nh,
292 const u_char *bp2);
293 extern void rrcp_print(netdissect_options *,const u_char *, u_int);
294
295 extern void ether_print(netdissect_options *,
296 const u_char *, u_int, u_int,
297 void (*)(netdissect_options *, const u_char *),
298 const u_char *);
299
300 extern u_int ether_if_print(netdissect_options *,
301 const struct pcap_pkthdr *,const u_char *);
302
303 extern int ethertype_print(netdissect_options *,u_short, const u_char *,
304 u_int, u_int);
305
306 /* stuff that has not yet been rototiled */
307 #if 0
308 extern void ascii_print(netdissect_options *,u_int);
309 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
310 u_int, u_int);
311 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
312 extern void hex_print_with_offset(netdissect_options *,const char *,
313 u_int, u_int);
314 extern void hex_print(netdissect_options *,const char *, u_int);
315 extern void telnet_print(netdissect_options *,const u_char *, u_int);
316 extern int llc_print(netdissect_options *,
317 const u_char *, u_int, u_int, const u_char *,
318 const u_char *, u_short *);
319 extern void aarp_print(netdissect_options *,const u_char *, u_int);
320 extern void atalk_print(netdissect_options *,const u_char *, u_int);
321 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
322 extern void bootp_print(netdissect_options *,const u_char *,
323 u_int, u_short, u_short);
324 extern void bgp_print(netdissect_options *,const u_char *, int);
325 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
326 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
327 register const u_char *p);
328 extern void chdlc_print(netdissect_options *ndo,
329 register const u_char *p, u_int length, u_int caplen);
330 extern void cisco_autorp_print(netdissect_options *,
331 const u_char *, u_int);
332 extern void cnfp_print(netdissect_options *,const u_char *cp,
333 u_int len, const u_char *bp);
334 extern void decnet_print(netdissect_options *,const u_char *,
335 u_int, u_int);
336 extern void default_print(netdissect_options *,const u_char *, u_int);
337 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
338 extern void egp_print(netdissect_options *,const u_char *, u_int,
339 const u_char *);
340
341 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
342 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
343 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
344
345 extern void gre_print(netdissect_options *,const u_char *, u_int);
346 extern void icmp_print(netdissect_options *,const u_char *, u_int,
347 const u_char *);
348 extern void hsrp_print(netdissect_options *ndo,
349 register const u_char *bp, register u_int len);
350 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
351 extern void igmp_print(netdissect_options *,
352 register const u_char *, u_int);
353 extern void igrp_print(netdissect_options *,const u_char *, u_int,
354 const u_char *);
355 extern void ipN_print(netdissect_options *,const u_char *, u_int);
356 extern void ipx_print(netdissect_options *,const u_char *, u_int);
357 extern void isoclns_print(netdissect_options *,const u_char *,
358 u_int, u_int, const u_char *, const u_char *);
359 extern void krb_print(netdissect_options *,const u_char *, u_int);
360 extern void llap_print(netdissect_options *,const u_char *, u_int);
361 extern const char *linkaddr_string(netdissect_options *ndo,
362 const u_char *ep, const unsigned int len);
363 extern void ltalk_if_print(netdissect_options *ndo,
364 u_char *user, const struct pcap_pkthdr *h,
365 const u_char *p);
366 extern void mpls_print(netdissect_options *ndo,
367 const u_char *bp, u_int length);
368 extern void msdp_print(netdissect_options *ndo,
369 const unsigned char *sp, u_int length);
370 extern void nfsreply_print(netdissect_options *,const u_char *,
371 u_int, const u_char *);
372 extern void nfsreq_print(netdissect_options *,const u_char *,
373 u_int, const u_char *);
374 extern void ns_print(netdissect_options *,const u_char *, u_int);
375 extern void ntp_print(netdissect_options *,const u_char *, u_int);
376 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
377 extern void ospf_print(netdissect_options *,const u_char *,
378 u_int, const u_char *);
379 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
380 extern void mobile_print(netdissect_options *,const u_char *, u_int);
381 extern void pim_print(netdissect_options *,const u_char *, u_int, u_int);
382 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
383 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
384 extern void ppp_print(netdissect_options *,
385 register const u_char *, u_int);
386
387 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
388 extern void ppp_hdlc_if_print(u_char *,
389 const struct pcap_pkthdr *, const u_char *);
390 extern void ppp_bsdos_if_print(u_char *,
391 const struct pcap_pkthdr *, const u_char *);
392
393 extern int vjc_print(netdissect_options *,register const char *,
394 register u_int, u_short);
395
396 extern void raw_if_print(u_char *,
397 const struct pcap_pkthdr *, const u_char *);
398
399 extern void rip_print(netdissect_options *,const u_char *, u_int);
400
401 extern void sctp_print(netdissect_options *ndo,
402 const u_char *bp, const u_char *bp2,
403 u_int sctpPacketLength);
404
405 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
406
407 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
408 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
409 extern void sl_bsdos_if_print(u_char *,
410 const struct pcap_pkthdr *, const u_char *);
411 extern void sll_if_print(u_char *,
412 const struct pcap_pkthdr *, const u_char *);
413
414 extern void snmp_print(netdissect_options *,const u_char *, u_int);
415 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
416 u_int, const u_char *);
417 extern void tcp_print(netdissect_options *,const u_char *, u_int,
418 const u_char *, int);
419 extern void tftp_print(netdissect_options *,const u_char *, u_int);
420 extern void timed_print(netdissect_options *,const u_char *, u_int);
421 extern void udp_print(netdissect_options *,const u_char *, u_int,
422 const u_char *, int);
423 extern void wb_print(netdissect_options *,const void *, u_int);
424 extern int ah_print(netdissect_options *,register const u_char *,
425 register const u_char *);
426 extern void esp_print_decodesecret(netdissect_options *ndo);
427 extern int ipcomp_print(netdissect_options *,register const u_char *,
428 register const u_char *, int *);
429 extern void rx_print(netdissect_options *,register const u_char *,
430 int, int, int, u_char *);
431 extern void netbeui_print(netdissect_options *,u_short,
432 const u_char *, int);
433 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
434 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
435 extern void nbt_udp137_print(netdissect_options *,
436 const u_char *data, int);
437 extern void nbt_udp138_print(netdissect_options *,
438 const u_char *data, int);
439 extern char *smb_errstr(netdissect_options *,int, int);
440 extern const char *nt_errstr(netdissect_options *, u_int32_t);
441 extern void print_data(netdissect_options *,const unsigned char *, int);
442 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
443 extern void lcp_print(netdissect_options *,const u_char *, u_int);
444 extern void vrrp_print(netdissect_options *,const u_char *bp,
445 u_int len, int ttl);
446 extern void cdp_print(netdissect_options *,const u_char *,
447 u_int, u_int, const u_char *, const u_char *);
448 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
449 extern void radius_print(netdissect_options *,const u_char *, u_int);
450 extern void lwres_print(netdissect_options *,const u_char *, u_int);
451 extern void pptp_print(netdissect_options *,const u_char *, u_int);
452 #endif
453
454 extern u_int ipnet_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
455 extern u_int ppi_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
456
457 extern u_int ieee802_15_4_if_print(netdissect_options *,const struct pcap_pkthdr *, const u_char *);
458
459 #ifdef INET6
460 extern void ip6_print(netdissect_options *,const u_char *, u_int);
461 #if 0
462 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
463 extern int nextproto6_cksum(const struct ip6_hdr *, const u_short *, u_int, u_int);
464 extern int hbhopt_print(netdissect_options *,const u_char *);
465 extern int dstopt_print(netdissect_options *,const u_char *);
466 extern int frag6_print(netdissect_options *,const u_char *,
467 const u_char *);
468 extern void icmp6_print(netdissect_options *,const u_char *,
469 const u_char *);
470 extern void ripng_print(netdissect_options *,const u_char *, int);
471 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
472 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
473 extern void dhcp6_print(netdissect_options *,const u_char *,
474 u_int, u_int16_t, u_int16_t);
475
476 extern void zephyr_print(netdissect_options * ndo,
477 const u_char *cp, int length);
478 #endif /* 0 */
479
480 #endif /*INET6*/
481
482 #if 0
483 struct cksum_vec {
484 const u_int8_t *ptr;
485 int len;
486 };
487 extern u_int16_t in_cksum(const struct cksum_vec *, int);
488 extern u_int16_t in_cksum_shouldbe(u_int16_t, u_int16_t);
489 #endif
490
491 extern void esp_print_decodesecret(netdissect_options *ndo);
492 extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo,
493 int initiator,
494 u_char spii[8], u_char spir[8],
495 u_char *buf, u_char *end);
496
497
498 #endif /* netdissect_h */
[mirror] the TCPdump network dissector