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


c557f6ae4996f80e3a0a080efdcfb89b6c28aca6
[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_pflag; /* don't go promiscuous */
111
112 int ndo_Cflag; /* rotate dump files after this many bytes */
113 int ndo_Cflag_count; /* Keep track of which file number we're writing */
114 int ndo_Gflag; /* rotate dump files after this many seconds */
115 int ndo_Gflag_count; /* number of files created with Gflag rotation */
116 time_t ndo_Gflag_time; /* The last time_t the dump file was rotated. */
117 int ndo_Wflag; /* recycle output files after this number of files */
118 int ndo_WflagChars;
119 int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
120 const char *ndo_dltname;
121
122 char *ndo_espsecret;
123 struct sa_list *ndo_sa_list_head; /* used by print-esp.c */
124 struct sa_list *ndo_sa_default;
125
126 char *ndo_sigsecret; /* Signature verification secret key */
127
128 struct esp_algorithm *ndo_espsecret_xform; /* cache of decoded */
129 char *ndo_espsecret_key;
130
131 int ndo_packettype; /* as specified by -T */
132
133 char *ndo_program_name; /*used to generate self-identifying messages */
134
135 int32_t ndo_thiszone; /* seconds offset from gmt to local time */
136
137 int ndo_snaplen;
138
139 /*global pointers to beginning and end of current packet (during printing) */
140 const u_char *ndo_packetp;
141 const u_char *ndo_snapend;
142
143 /* bookkeeping for ^T output */
144 int ndo_infodelay;
145
146 /* pointer to void function to output stuff */
147 void (*ndo_default_print)(netdissect_options *,
148 register const u_char *bp, register u_int length);
149 void (*ndo_info)(netdissect_options *, int verbose);
150
151 int (*ndo_printf)(netdissect_options *,
152 const char *fmt, ...)
153 __attribute__ ((format (printf, 2, 3)));
154 void (*ndo_error)(netdissect_options *,
155 const char *fmt, ...)
156 __attribute__ ((format (printf, 2, 3)));
157 void (*ndo_warning)(netdissect_options *,
158 const char *fmt, ...)
159 __attribute__ ((format (printf, 2, 3)));
160 };
161
162 #define PT_VAT 1 /* Visual Audio Tool */
163 #define PT_WB 2 /* distributed White Board */
164 #define PT_RPC 3 /* Remote Procedure Call */
165 #define PT_RTP 4 /* Real-Time Applications protocol */
166 #define PT_RTCP 5 /* Real-Time Applications control protocol */
167 #define PT_SNMP 6 /* Simple Network Management Protocol */
168 #define PT_CNFP 7 /* Cisco NetFlow protocol */
169
170 #ifndef min
171 #define min(a,b) ((a)>(b)?(b):(a))
172 #endif
173 #ifndef max
174 #define max(a,b) ((b)>(a)?(b):(a))
175 #endif
176
177 /*
178 * Maximum snapshot length. This should be enough to capture the full
179 * packet on most network interfaces.
180 *
181 * XXX - could it be larger? If so, should it? Some applications might
182 * use the snapshot length in a savefile header to control the size of
183 * the buffer they allocate, so a size of, say, 2^31-1 might not work
184 * well.
185 */
186 #define MAXIMUM_SNAPLEN 65535
187
188 /*
189 * The default snapshot length is the maximum.
190 */
191 #define DEFAULT_SNAPLEN MAXIMUM_SNAPLEN
192
193 #ifndef BIG_ENDIAN
194 #define BIG_ENDIAN 4321
195 #define LITTLE_ENDIAN 1234
196 #endif
197
198 #define ESRC(ep) ((ep)->ether_shost)
199 #define EDST(ep) ((ep)->ether_dhost)
200
201 #ifndef NTOHL
202 #define NTOHL(x) (x) = ntohl(x)
203 #define NTOHS(x) (x) = ntohs(x)
204 #define HTONL(x) (x) = htonl(x)
205 #define HTONS(x) (x) = htons(x)
206 #endif
207
208 /*
209 * True if "l" bytes of "var" were captured.
210 *
211 * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
212 * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
213 *
214 * The check is for <= rather than < because "l" might be 0.
215 */
216 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
217 (const u_char *)&(var) <= ndo->ndo_snapend - (l))
218
219 /* True if "var" was captured */
220 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
221
222 /* Bail if "l" bytes of "var" were not captured */
223 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
224
225 /* Bail if "var" was not captured */
226 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
227
228 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
229 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
230
231 #if 0
232 extern void ts_print(netdissect_options *ipdo,
233 const struct timeval *);
234 extern void relts_print(int);
235 #endif
236
237 extern int fn_print(const u_char *, const u_char *);
238 extern int fn_printn(const u_char *, u_int, const u_char *);
239 extern const char *tok2str(const struct tok *, const char *, int);
240
241 extern void wrapup(int);
242
243 #if 0
244 extern char *read_infile(netdissect_options *, char *);
245 extern char *copy_argv(netdissect_options *, char **);
246 #endif
247
248 extern void safeputchar(int);
249 extern void safeputs(const char *, int);
250
251 #if 0
252 extern const char *isonsap_string(netdissect_options *, const u_char *);
253 extern const char *protoid_string(netdissect_options *, const u_char *);
254 extern const char *dnname_string(netdissect_options *, u_short);
255 extern const char *dnnum_string(netdissect_options *, u_short);
256 #endif
257
258 /* The printer routines. */
259
260 #include <pcap.h>
261
262
263 extern void eap_print(netdissect_options *,const u_char *, u_int);
264 extern int esp_print(netdissect_options *,
265 register const u_char *bp, int len, register const u_char *bp2,
266 int *nhdr, int *padlen);
267 extern void arp_print(netdissect_options *,const u_char *, u_int, u_int);
268 extern void isakmp_print(netdissect_options *,const u_char *,
269 u_int, const u_char *);
270 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
271 u_int, const u_char *);
272 extern void ip_print(netdissect_options *,const u_char *, u_int);
273 extern void ip_print_inner(netdissect_options *ndo,
274 const u_char *bp, u_int length, u_int nh,
275 const u_char *bp2);
276 extern void rrcp_print(netdissect_options *,const u_char *, u_int);
277
278 /* stuff that has not yet been rototiled */
279 #if 0
280 extern void ascii_print(netdissect_options *,u_int);
281 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
282 u_int, u_int);
283 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
284 extern void hex_print_with_offset(netdissect_options *,const char *,
285 u_int, u_int);
286 extern void hex_print(netdissect_options *,const char *, u_int);
287 extern void telnet_print(netdissect_options *,const u_char *, u_int);
288 extern int ether_encap_print(netdissect_options *,u_short, const u_char *,
289 u_int, u_int, u_short *);
290 extern int llc_print(netdissect_options *,
291 const u_char *, u_int, u_int, const u_char *,
292 const u_char *, u_short *);
293 extern void aarp_print(netdissect_options *,const u_char *, u_int);
294 extern void atalk_print(netdissect_options *,const u_char *, u_int);
295 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
296 extern void bootp_print(netdissect_options *,const u_char *,
297 u_int, u_short, u_short);
298 extern void bgp_print(netdissect_options *,const u_char *, int);
299 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
300 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
301 register const u_char *p);
302 extern void chdlc_print(netdissect_options *ndo,
303 register const u_char *p, u_int length, u_int caplen);
304 extern void cisco_autorp_print(netdissect_options *,
305 const u_char *, u_int);
306 extern void cnfp_print(netdissect_options *,const u_char *cp,
307 u_int len, const u_char *bp);
308 extern void decnet_print(netdissect_options *,const u_char *,
309 u_int, u_int);
310 extern void default_print(netdissect_options *,const u_char *, u_int);
311 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
312 extern void egp_print(netdissect_options *,const u_char *, u_int,
313 const u_char *);
314
315 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
316 extern void ether_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
317 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
318 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
319
320 extern void gre_print(netdissect_options *,const u_char *, u_int);
321 extern void icmp_print(netdissect_options *,const u_char *, u_int,
322 const u_char *);
323 extern void hsrp_print(netdissect_options *ndo,
324 register const u_char *bp, register u_int len);
325 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
326 extern void igmp_print(netdissect_options *,
327 register const u_char *, u_int);
328 extern void igrp_print(netdissect_options *,const u_char *, u_int,
329 const u_char *);
330 extern void ipN_print(netdissect_options *,const u_char *, u_int);
331 extern void ipx_print(netdissect_options *,const u_char *, u_int);
332 extern void isoclns_print(netdissect_options *,const u_char *,
333 u_int, u_int, const u_char *, const u_char *);
334 extern void krb_print(netdissect_options *,const u_char *, u_int);
335 extern void llap_print(netdissect_options *,const u_char *, u_int);
336 extern const char *linkaddr_string(netdissect_options *ndo,
337 const u_char *ep, const unsigned int len);
338 extern void ltalk_if_print(netdissect_options *ndo,
339 u_char *user, const struct pcap_pkthdr *h,
340 const u_char *p);
341 extern void mpls_print(netdissect_options *ndo,
342 const u_char *bp, u_int length);
343 extern void msdp_print(netdissect_options *ndo,
344 const unsigned char *sp, u_int length);
345 extern void nfsreply_print(netdissect_options *,const u_char *,
346 u_int, const u_char *);
347 extern void nfsreq_print(netdissect_options *,const u_char *,
348 u_int, const u_char *);
349 extern void ns_print(netdissect_options *,const u_char *, u_int);
350 extern void ntp_print(netdissect_options *,const u_char *, u_int);
351 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
352 extern void ospf_print(netdissect_options *,const u_char *,
353 u_int, const u_char *);
354 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
355 extern void mobile_print(netdissect_options *,const u_char *, u_int);
356 extern void pim_print(netdissect_options *,const u_char *, u_int);
357 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
358 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
359 extern void ppp_print(netdissect_options *,
360 register const u_char *, u_int);
361
362 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
363 extern void ppp_hdlc_if_print(u_char *,
364 const struct pcap_pkthdr *, const u_char *);
365 extern void ppp_bsdos_if_print(u_char *,
366 const struct pcap_pkthdr *, const u_char *);
367
368 extern int vjc_print(netdissect_options *,register const char *,
369 register u_int, u_short);
370
371 extern void raw_if_print(u_char *,
372 const struct pcap_pkthdr *, const u_char *);
373
374 extern void rip_print(netdissect_options *,const u_char *, u_int);
375
376 extern void sctp_print(netdissect_options *ndo,
377 const u_char *bp, const u_char *bp2,
378 u_int sctpPacketLength);
379
380 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
381
382 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
383 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
384 extern void sl_bsdos_if_print(u_char *,
385 const struct pcap_pkthdr *, const u_char *);
386 extern void sll_if_print(u_char *,
387 const struct pcap_pkthdr *, const u_char *);
388
389 extern void snmp_print(netdissect_options *,const u_char *, u_int);
390 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
391 u_int, const u_char *);
392 extern void tcp_print(netdissect_options *,const u_char *, u_int,
393 const u_char *, int);
394 extern void tftp_print(netdissect_options *,const u_char *, u_int);
395 extern void timed_print(netdissect_options *,const u_char *, u_int);
396 extern void udp_print(netdissect_options *,const u_char *, u_int,
397 const u_char *, int);
398 extern void wb_print(netdissect_options *,const void *, u_int);
399 extern int ah_print(netdissect_options *,register const u_char *,
400 register const u_char *);
401 extern void esp_print_decodesecret(netdissect_options *ndo);
402 extern int ipcomp_print(netdissect_options *,register const u_char *,
403 register const u_char *, int *);
404 extern void rx_print(netdissect_options *,register const u_char *,
405 int, int, int, u_char *);
406 extern void netbeui_print(netdissect_options *,u_short,
407 const u_char *, int);
408 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
409 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
410 extern void nbt_udp137_print(netdissect_options *,
411 const u_char *data, int);
412 extern void nbt_udp138_print(netdissect_options *,
413 const u_char *data, int);
414 extern char *smb_errstr(netdissect_options *,int, int);
415 extern const char *nt_errstr(netdissect_options *, u_int32_t);
416 extern void print_data(netdissect_options *,const unsigned char *, int);
417 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
418 extern void lcp_print(netdissect_options *,const u_char *, u_int);
419 extern void vrrp_print(netdissect_options *,const u_char *bp,
420 u_int len, int ttl);
421 extern void cdp_print(netdissect_options *,const u_char *,
422 u_int, u_int, const u_char *, const u_char *);
423 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
424 extern void radius_print(netdissect_options *,const u_char *, u_int);
425 extern void lwres_print(netdissect_options *,const u_char *, u_int);
426 extern void pptp_print(netdissect_options *,const u_char *, u_int);
427
428 #ifdef INET6
429 extern void ip6_print(netdissect_options *,const u_char *, u_int);
430 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
431 extern int hbhopt_print(netdissect_options *,const u_char *);
432 extern int dstopt_print(netdissect_options *,const u_char *);
433 extern int frag6_print(netdissect_options *,const u_char *,
434 const u_char *);
435 extern void icmp6_print(netdissect_options *,const u_char *,
436 const u_char *);
437 extern void ripng_print(netdissect_options *,const u_char *, int);
438 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
439 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
440 extern void dhcp6_print(netdissect_options *,const u_char *,
441 u_int, u_int16_t, u_int16_t);
442
443 extern void zephyr_print(netdissect_options * ndo,
444 const u_char *cp, int length);
445
446 #endif /*INET6*/
447 extern u_short in_cksum(const u_short *,
448 register u_int, int);
449
450 #endif
451
452 extern void esp_print_decodesecret(netdissect_options *ndo);
453 extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo,
454 int initiator,
455 u_char spii[8], u_char spir[8],
456 u_char *buf, u_char *end);
457
458
459 #endif /* netdissect_h */
[mirror] the TCPdump network dissector