xref: /openbsd/usr.sbin/tcpdump/interface.h (revision d415bd75)
1 /*	$OpenBSD: interface.h,v 1.87 2023/02/28 10:04:50 claudio Exp $	*/
2 
3 /*
4  * Copyright (c) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that: (1) source code distributions
9  * retain the above copyright notice and this paragraph in its entirety, (2)
10  * distributions including binary code include the above copyright notice and
11  * this paragraph in its entirety in the documentation or other materials
12  * provided with the distribution, and (3) all advertising materials mentioning
13  * features or use of this software display the following acknowledgement:
14  * ``This product includes software developed by the University of California,
15  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
16  * the University nor the names of its contributors may be used to endorse
17  * or promote products derived from this software without specific prior
18  * written permission.
19  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
20  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
22  *
23  * @(#) $Id: interface.h,v 1.87 2023/02/28 10:04:50 claudio Exp $ (LBL)
24  */
25 
26 #ifndef tcpdump_interface_h
27 #define tcpdump_interface_h
28 
29 #ifdef HAVE_OS_PROTO_H
30 #include "os-proto.h"
31 #endif
32 
33 struct tok {
34 	int v;			/* value */
35 	char *s;		/* string */
36 };
37 
38 extern int aflag;		/* translate network and broadcast addresses */
39 extern int dflag;		/* print filter code */
40 extern int eflag;		/* print ethernet header */
41 extern int fflag;		/* don't translate "foreign" IP address */
42 extern int Iflag;		/* include interface in output */
43 extern int nflag;		/* leave addresses as numbers */
44 extern int Nflag;		/* remove domains from printed host names */
45 extern int oflag;		/* OS fingerprint */
46 extern int qflag;		/* quick (shorter) output */
47 extern int Sflag;		/* print raw TCP sequence numbers */
48 extern int tflag;		/* print packet arrival time */
49 extern int vflag;		/* verbose */
50 extern int xflag;		/* print packet in hex */
51 extern int Xflag;		/* print packet in hex/ascii */
52 
53 extern int packettype;		/* as specified by -T */
54 extern char *device;		/* as specified by -i  */
55 #define PT_VAT		1	/* Visual Audio Tool */
56 #define PT_WB		2	/* distributed White Board */
57 #define PT_RPC		3	/* Remote Procedure Call */
58 #define PT_RTP		4	/* Real-Time Applications protocol */
59 #define PT_RTCP		5	/* Real-Time Applications control protocol */
60 #define PT_CNFP		6	/* Cisco NetFlow protocol */
61 #define PT_VRRP		7	/* Virtual Router Redundancy protocol */
62 #define PT_TCP		8	/* TCP */
63 #define PT_GRE		9	/* Generic Routing Encapsulation (over UDP) */
64 #define PT_MPLS		10	/* MPLS (over UDP) */
65 #define PT_TFTP		11	/* Trivial File Transfer Protocol */
66 #define PT_VXLAN	12	/* Virtual eXtensible Local Area Network */
67 #define PT_ERSPAN	13	/* GRE ERSPAN Type I or II */
68 #define PT_WIREGUARD	14	/* WireGuard tunnel */
69 #define PT_GENEVE	15	/* Geneve */
70 
71 #ifndef min
72 #define min(a,b) ((a)>(b)?(b):(a))
73 #endif
74 #ifndef max
75 #define max(a,b) ((b)>(a)?(b):(a))
76 #endif
77 
78 /*
79  * The default snapshot length.  This value allows most printers to print
80  * useful information while keeping the amount of unwanted data down.
81  * In particular, it allows ethernet, tcp/ip headers, and a small amount
82  * of data, or to capture IPv6 and TCP headers after pflog encapsulation.
83  */
84 #define DEFAULT_SNAPLEN 116
85 #define IEEE802_11_SNAPLEN (DEFAULT_SNAPLEN + 30)
86 #define IEEE802_11_RADIO_SNAPLEN (IEEE802_11_SNAPLEN + 64)
87 
88 #ifndef BIG_ENDIAN
89 #define BIG_ENDIAN 4321
90 #define LITTLE_ENDIAN 1234
91 #endif
92 
93 #ifdef ETHER_HEADER_HAS_EA
94 #define ESRC(ep) ((ep)->ether_shost.ether_addr_octet)
95 #define EDST(ep) ((ep)->ether_dhost.ether_addr_octet)
96 #else
97 #define ESRC(ep) ((ep)->ether_shost)
98 #define EDST(ep) ((ep)->ether_dhost)
99 #endif
100 
101 #ifdef ETHER_ARP_HAS_X
102 #define SHA(ap) ((ap)->arp_xsha)
103 #define THA(ap) ((ap)->arp_xtha)
104 #define SPA(ap) ((ap)->arp_xspa)
105 #define TPA(ap) ((ap)->arp_xtpa)
106 #else
107 #ifdef ETHER_ARP_HAS_EA
108 #define SHA(ap) ((ap)->arp_sha.ether_addr_octet)
109 #define THA(ap) ((ap)->arp_tha.ether_addr_octet)
110 #else
111 #define SHA(ap) ((ap)->arp_sha)
112 #define THA(ap) ((ap)->arp_tha)
113 #endif
114 #define SPA(ap) ((ap)->arp_spa)
115 #define TPA(ap) ((ap)->arp_tpa)
116 #endif
117 
118 #ifndef NTOHL
119 #define NTOHL(x)	(x) = ntohl(x)
120 #define NTOHS(x)	(x) = ntohs(x)
121 #define HTONL(x)	(x) = htonl(x)
122 #define HTONS(x)	(x) = htons(x)
123 #endif
124 #endif
125 
126 extern char *program_name;	/* used to generate self-identifying messages */
127 
128 extern int32_t thiszone;	/* seconds offset from gmt to local time */
129 
130 extern int snaplen;
131 /* global pointers to beginning and end of current packet (during printing) */
132 extern const u_char *packetp;
133 extern const u_char *snapend;
134 
135 /*
136  * True if  "l" bytes of "var" were captured.
137  *
138  * The "snapend - (l) <= snapend" checks to make sure "l" isn't so large
139  * that "snapend - (l)" underflows.
140  *
141  * The check is for <= rather than < because "l" might be 0.
142  */
143 #define TTEST2(var, l) (snapend - (l) <= snapend && \
144 			(const u_char *)&(var) <= snapend - (l))
145 
146 /* True if "var" was captured */
147 #define TTEST(var) TTEST2(var, sizeof(var))
148 
149 /* Bail if "l" bytes of "var" were not captured */
150 #define TCHECK2(var, l) if (!TTEST2(var, l)) goto trunc
151 
152 /* Bail if "var" was not captured */
153 #define TCHECK(var) TCHECK2(var, sizeof(var))
154 
155 struct timeval;
156 struct bpf_timeval;
157 
158 extern void ts_print(const struct bpf_timeval *);
159 
160 extern int fn_print(const u_char *, const u_char *);
161 extern int fn_printn(const u_char *, u_int, const u_char *);
162 extern void relts_print(int);
163 extern const char *tok2str(const struct tok *, const char *, int);
164 extern char *dnaddr_string(u_short);
165 extern void safeputs(const char *);
166 extern void safeputchar(int);
167 extern void printb(char *, unsigned short, char *);
168 
169 extern void wrapup(int);
170 
171 extern __dead void error(const char *, ...)
172     __attribute__((__format__ (printf, 1, 2)));
173 extern void warning(const char *, ...)
174     __attribute__ ((__format__ (printf, 1, 2)));
175 
176 extern char *read_infile(char *);
177 extern char *copy_argv(char * const *);
178 
179 extern char *isonsap_string(const u_char *);
180 extern char *llcsap_string(u_char);
181 extern char *protoid_string(const u_char *);
182 extern char *dnname_string(u_short);
183 extern char *dnnum_string(u_short);
184 
185 /* The printer routines. */
186 
187 struct pcap_pkthdr;
188 
189 extern int ether_encap_print(u_short, const u_char *, u_int, u_int);
190 extern int llc_print(const u_char *, u_int, u_int, const u_char *,
191 	const u_char *);
192 extern int pppoe_if_print(u_short, const u_char *, u_int, u_int);
193 extern void aarp_print(const u_char *, u_int);
194 extern void arp_print(const u_char *, u_int, u_int);
195 extern void atalk_print(const u_char *, u_int);
196 extern void atalk_print_llap(const u_char *, u_int);
197 extern void atm_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
198 extern void bootp_print(const u_char *, u_int, u_short, u_short);
199 extern void bgp_print(const u_char *, int);
200 extern void decnet_print(const u_char *, u_int, u_int);
201 extern void default_print(const u_char *, u_int);
202 extern void dvmrp_print(const u_char *, u_int);
203 extern void egp_print(const u_char *, u_int, const u_char *);
204 extern void enc_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
205 extern void pflog_if_print(u_char *, const struct pcap_pkthdr *,
206         const u_char *);
207 extern void pflog_old_if_print(u_char *, const struct pcap_pkthdr *,
208         const u_char *);
209 extern void pfsync_if_print(u_char *, const struct pcap_pkthdr *,
210         const u_char *);
211 extern void pfsync_ip_print(const u_char *, u_int, const u_char *);
212 extern void ether_if_print(u_char *, const struct pcap_pkthdr *,
213 	const u_char *);
214 extern void ether_tryprint(const u_char *, u_int, int);
215 extern void fddi_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
216 extern void ppp_ether_if_print(u_char *, const struct pcap_pkthdr *,
217 	const u_char *);
218 extern void gre_print(const u_char *, u_int);
219 extern void vxlan_print(const u_char *, u_int);
220 extern void geneve_print(const u_char *, u_int);
221 extern void nsh_print(const u_char *, u_int);
222 extern void nhrp_print(const u_char *, u_int);
223 extern void icmp_print(const u_char *, u_int, const u_char *);
224 extern void ieee802_11_if_print(u_char *, const struct pcap_pkthdr *,
225     const u_char *);
226 extern void ieee802_11_radio_if_print(u_char *, const struct pcap_pkthdr *,
227     const u_char *);
228 extern void iapp_print(const u_char *, u_int);
229 extern void igrp_print(const u_char *, u_int, const u_char *);
230 extern void ip_print(const u_char *, u_int);
231 extern void ipx_print(const u_char *, u_int);
232 extern void isoclns_print(const u_char *, u_int, u_int, const u_char *,
233 	const u_char *);
234 extern void krb_print(const u_char *, u_int);
235 extern void netbeui_print(u_short, const u_char *, const u_char *);
236 extern void ipx_netbios_print(const u_char *, const u_char *);
237 extern void nbt_tcp_print(const u_char *, int);
238 extern void nbt_udp137_print(const u_char *data, int);
239 extern void nbt_udp138_print(const u_char *data, int);
240 extern char *smb_errstr(int, int);
241 extern void print_data(const unsigned char *, int);
242 extern void l2tp_print(const u_char *dat, u_int length);
243 extern void vrrp_print(const u_char *bp, u_int len, int ttl);
244 extern void carp_print(const u_char *bp, u_int len, int ttl);
245 extern void hsrp_print(const u_char *, u_int);
246 extern void vqp_print(const u_char *, u_int);
247 extern void nfsreply_print(const u_char *, u_int, const u_char *);
248 extern void nfsreq_print(const u_char *, u_int, const u_char *);
249 extern void ns_print(const u_char *, u_int, int);
250 extern void ntp_print(const u_char *, u_int);
251 extern void loop_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
252 extern void null_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
253 extern void ospf_print(const u_char *, u_int, const u_char *);
254 extern void mobile_print(const u_char *, u_int);
255 extern void pim_print(const u_char *, u_int);
256 extern void ppp_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
257 extern void ppp_hdlc_if_print(u_char *, const struct pcap_pkthdr *,
258     const u_char *);
259 extern void ppp_print(const u_char *, u_int);
260 extern void ppp_hdlc_print(const u_char *, u_int);
261 extern void raw_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
262 extern void rip_print(const u_char *, u_int);
263 extern void sl_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
264 extern void sl_bsdos_if_print(u_char *, const struct pcap_pkthdr *,
265     const u_char *);
266 extern void snmp_print(const u_char *, u_int);
267 extern void sunrpcrequest_print(const u_char *, u_int, const u_char *);
268 extern void cnfp_print(const u_char *, u_int);
269 extern void tcp_print(const u_char *, u_int, const u_char *);
270 extern void tftp_print(const u_char *, u_int);
271 extern void wg_print(const u_char *, u_int);
272 extern void timed_print(const u_char *, u_int);
273 extern void udp_print(const u_char *, u_int, const void *);
274 extern void wb_print(const void *, u_int);
275 extern void ike_print(const u_char *, u_int);
276 extern void udpencap_print(const u_char *, u_int, const u_char *);
277 extern void ah_print(const u_char *, u_int, const u_char *);
278 extern void esp_print(const u_char *, u_int, const u_char *);
279 extern void cdp_print(const u_char *, u_int, u_int, int);
280 extern void stp_print(const u_char *, u_int);
281 extern void radius_print(const u_char *, u_int);
282 extern void lwres_print(const u_char *, u_int);
283 extern void ether_print(const u_char *, u_int);
284 extern void etherip_print(const u_char *, u_int, u_int);
285 extern void ipcomp_print(const u_char *, u_int, const u_char *);
286 extern void mpls_print(const u_char *, u_int);
287 extern void lldp_print(const u_char *, u_int);
288 extern void slow_print(const u_char *, u_int);
289 extern void gtp_print(const u_char *, u_int, u_short, u_short);
290 extern void ofp_print(const u_char *, u_int);
291 extern void ofp_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
292 extern void usbpcap_if_print(u_char *, const struct pcap_pkthdr *,
293     const u_char *);
294 
295 extern void ip6_print(const u_char *, u_int);
296 extern void ip6_opt_print(const u_char *, int);
297 extern int hbhopt_print(const u_char *);
298 extern int dstopt_print(const u_char *);
299 extern int frag6_print(const u_char *, const u_char *);
300 extern void icmp6_print(const u_char *, u_int, const u_char *);
301 extern void ripng_print(const u_char *, int);
302 extern int rt6_print(const u_char *, const u_char *);
303 extern void ospf6_print(const u_char *, u_int);
304 extern void dhcp6_print(const u_char *, u_int);
305 
306 extern uint32_t in_cksum_add(const void *, size_t, uint32_t);
307 extern uint16_t in_cksum_fini(uint32_t);
308 extern uint16_t in_cksum(const void *, size_t, uint32_t);
309 extern u_int16_t in_cksum_shouldbe(u_int16_t, u_int16_t);
310 
311 extern uint32_t wg_match(const u_char *, u_int);
312