1/*	$OpenBSD: interface.h,v 1.88 2024/05/21 05:00:48 jsg 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.88 2024/05/21 05:00:48 jsg 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
33struct tok {
34	int v;			/* value */
35	char *s;		/* string */
36};
37
38extern int aflag;		/* translate network and broadcast addresses */
39extern int dflag;		/* print filter code */
40extern int eflag;		/* print ethernet header */
41extern int fflag;		/* don't translate "foreign" IP address */
42extern int Iflag;		/* include interface in output */
43extern int nflag;		/* leave addresses as numbers */
44extern int Nflag;		/* remove domains from printed host names */
45extern int oflag;		/* OS fingerprint */
46extern int qflag;		/* quick (shorter) output */
47extern int Sflag;		/* print raw TCP sequence numbers */
48extern int tflag;		/* print packet arrival time */
49extern int vflag;		/* verbose */
50extern int xflag;		/* print packet in hex */
51extern int Xflag;		/* print packet in hex/ascii */
52
53extern int packettype;		/* as specified by -T */
54extern 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
126extern char *program_name;	/* used to generate self-identifying messages */
127
128extern int32_t thiszone;	/* seconds offset from gmt to local time */
129
130extern int snaplen;
131/* global pointers to beginning and end of current packet (during printing) */
132extern const u_char *packetp;
133extern 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
155struct timeval;
156struct bpf_timeval;
157
158extern void ts_print(const struct bpf_timeval *);
159
160extern int fn_print(const u_char *, const u_char *);
161extern int fn_printn(const u_char *, u_int, const u_char *);
162extern void relts_print(int);
163extern const char *tok2str(const struct tok *, const char *, int);
164extern char *dnaddr_string(u_short);
165extern void safeputs(const char *);
166extern void safeputchar(int);
167extern void printb(char *, unsigned short, char *);
168
169extern __dead void error(const char *, ...)
170    __attribute__((__format__ (printf, 1, 2)));
171extern void warning(const char *, ...)
172    __attribute__ ((__format__ (printf, 1, 2)));
173
174extern char *read_infile(char *);
175extern char *copy_argv(char * const *);
176
177extern char *isonsap_string(const u_char *);
178extern char *llcsap_string(u_char);
179extern char *protoid_string(const u_char *);
180extern char *dnname_string(u_short);
181extern char *dnnum_string(u_short);
182
183/* The printer routines. */
184
185struct pcap_pkthdr;
186
187extern int ether_encap_print(u_short, const u_char *, u_int, u_int);
188extern int llc_print(const u_char *, u_int, u_int, const u_char *,
189	const u_char *);
190extern int pppoe_if_print(u_short, const u_char *, u_int, u_int);
191extern void aarp_print(const u_char *, u_int);
192extern void arp_print(const u_char *, u_int, u_int);
193extern void atalk_print(const u_char *, u_int);
194extern void atalk_print_llap(const u_char *, u_int);
195extern void atm_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
196extern void bootp_print(const u_char *, u_int, u_short, u_short);
197extern void bgp_print(const u_char *, int);
198extern void decnet_print(const u_char *, u_int, u_int);
199extern void default_print(const u_char *, u_int);
200extern void dvmrp_print(const u_char *, u_int);
201extern void enc_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
202extern void pflog_if_print(u_char *, const struct pcap_pkthdr *,
203        const u_char *);
204extern void pfsync_if_print(u_char *, const struct pcap_pkthdr *,
205        const u_char *);
206extern void pfsync_ip_print(const u_char *, u_int, const u_char *);
207extern void ether_if_print(u_char *, const struct pcap_pkthdr *,
208	const u_char *);
209extern void ether_tryprint(const u_char *, u_int, int);
210extern void fddi_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
211extern void ppp_ether_if_print(u_char *, const struct pcap_pkthdr *,
212	const u_char *);
213extern void gre_print(const u_char *, u_int);
214extern void vxlan_print(const u_char *, u_int);
215extern void geneve_print(const u_char *, u_int);
216extern void nsh_print(const u_char *, u_int);
217extern void nhrp_print(const u_char *, u_int);
218extern void icmp_print(const u_char *, u_int, const u_char *);
219extern void ieee802_11_if_print(u_char *, const struct pcap_pkthdr *,
220    const u_char *);
221extern void ieee802_11_radio_if_print(u_char *, const struct pcap_pkthdr *,
222    const u_char *);
223extern void iapp_print(const u_char *, u_int);
224extern void igrp_print(const u_char *, u_int, const u_char *);
225extern void ip_print(const u_char *, u_int);
226extern void ipx_print(const u_char *, u_int);
227extern void isoclns_print(const u_char *, u_int, u_int, const u_char *,
228	const u_char *);
229extern void krb_print(const u_char *, u_int);
230extern void netbeui_print(u_short, const u_char *, const u_char *);
231extern void ipx_netbios_print(const u_char *, const u_char *);
232extern void nbt_tcp_print(const u_char *, int);
233extern void nbt_udp137_print(const u_char *data, int);
234extern void nbt_udp138_print(const u_char *data, int);
235extern char *smb_errstr(int, int);
236extern void print_data(const unsigned char *, int);
237extern void l2tp_print(const u_char *dat, u_int length);
238extern void vrrp_print(const u_char *bp, u_int len, int ttl);
239extern void carp_print(const u_char *bp, u_int len, int ttl);
240extern void hsrp_print(const u_char *, u_int);
241extern void vqp_print(const u_char *, u_int);
242extern void nfsreply_print(const u_char *, u_int, const u_char *);
243extern void nfsreq_print(const u_char *, u_int, const u_char *);
244extern void ns_print(const u_char *, u_int, int);
245extern void ntp_print(const u_char *, u_int);
246extern void loop_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
247extern void null_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
248extern void ospf_print(const u_char *, u_int, const u_char *);
249extern void mobile_print(const u_char *, u_int);
250extern void pim_print(const u_char *, u_int);
251extern void ppp_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
252extern void ppp_hdlc_if_print(u_char *, const struct pcap_pkthdr *,
253    const u_char *);
254extern void ppp_print(const u_char *, u_int);
255extern void ppp_hdlc_print(const u_char *, u_int);
256extern void raw_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
257extern void rip_print(const u_char *, u_int);
258extern void sl_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
259extern void sl_bsdos_if_print(u_char *, const struct pcap_pkthdr *,
260    const u_char *);
261extern void snmp_print(const u_char *, u_int);
262extern void sunrpcrequest_print(const u_char *, u_int, const u_char *);
263extern void cnfp_print(const u_char *, u_int);
264extern void tcp_print(const u_char *, u_int, const u_char *);
265extern void tftp_print(const u_char *, u_int);
266extern void wg_print(const u_char *, u_int);
267extern void timed_print(const u_char *, u_int);
268extern void udp_print(const u_char *, u_int, const void *);
269extern void wb_print(const void *, u_int);
270extern void ike_print(const u_char *, u_int);
271extern void udpencap_print(const u_char *, u_int, const u_char *);
272extern void ah_print(const u_char *, u_int, const u_char *);
273extern void esp_print(const u_char *, u_int, const u_char *);
274extern void cdp_print(const u_char *, u_int, u_int, int);
275extern void stp_print(const u_char *, u_int);
276extern void radius_print(const u_char *, u_int);
277extern void lwres_print(const u_char *, u_int);
278extern void ether_print(const u_char *, u_int);
279extern void etherip_print(const u_char *, u_int, u_int);
280extern void ipcomp_print(const u_char *, u_int, const u_char *);
281extern void mpls_print(const u_char *, u_int);
282extern void lldp_print(const u_char *, u_int);
283extern void slow_print(const u_char *, u_int);
284extern void gtp_print(const u_char *, u_int, u_short, u_short);
285extern void ofp_print(const u_char *, u_int);
286extern void ofp_if_print(u_char *, const struct pcap_pkthdr *, const u_char *);
287extern void usbpcap_if_print(u_char *, const struct pcap_pkthdr *,
288    const u_char *);
289
290extern void ip6_print(const u_char *, u_int);
291extern void ip6_opt_print(const u_char *, int);
292extern int hbhopt_print(const u_char *);
293extern int dstopt_print(const u_char *);
294extern int frag6_print(const u_char *, const u_char *);
295extern void icmp6_print(const u_char *, u_int, const u_char *);
296extern void ripng_print(const u_char *, int);
297extern int rt6_print(const u_char *, const u_char *);
298extern void ospf6_print(const u_char *, u_int);
299extern void dhcp6_print(const u_char *, u_int);
300
301extern uint32_t in_cksum_add(const void *, size_t, uint32_t);
302extern uint16_t in_cksum_fini(uint32_t);
303extern uint16_t in_cksum(const void *, size_t, uint32_t);
304extern u_int16_t in_cksum_shouldbe(u_int16_t, u_int16_t);
305
306extern uint32_t wg_match(const u_char *, u_int);
307