xref: /freebsd/contrib/tcpdump/print-pflog.c (revision 87b759f0fa1f7554d50ce640c40138512bbded44)
1 /*
2  * Copyright (c) 1990, 1991, 1993, 1994, 1995, 1996
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that: (1) source code distributions
7  * retain the above copyright notice and this paragraph in its entirety, (2)
8  * distributions including binary code include the above copyright notice and
9  * this paragraph in its entirety in the documentation or other materials
10  * provided with the distribution, and (3) all advertising materials mentioning
11  * features or use of this software display the following acknowledgement:
12  * ``This product includes software developed by the University of California,
13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14  * the University nor the names of its contributors may be used to endorse
15  * or promote products derived from this software without specific prior
16  * written permission.
17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20  */
21 
22 /* \summary: *BSD/Darwin packet filter log file printer */
23 
24 #include <config.h>
25 
26 #include "netdissect-stdinc.h"
27 
28 #include "netdissect.h"
29 #include "extract.h"
30 #include "af.h"
31 
32 #include "pflog.h"
33 
34 static const struct tok pf_reasons[] = {
35 	{ PFRES_MATCH,		"0(match)" },
36 	{ PFRES_BADOFF,		"1(bad-offset)" },
37 	{ PFRES_FRAG,		"2(fragment)" },
38 	{ PFRES_SHORT,		"3(short)" },
39 	{ PFRES_NORM,		"4(normalize)" },
40 	{ PFRES_MEMORY,		"5(memory)" },
41 	{ PFRES_TS,		"6(bad-timestamp)" },
42 	{ PFRES_CONGEST,	"7(congestion)" },
43 	{ PFRES_IPOPTIONS,	"8(ip-option)" },
44 	{ PFRES_PROTCKSUM,	"9(proto-cksum)" },
45 	{ PFRES_BADSTATE,	"10(state-mismatch)" },
46 	{ PFRES_STATEINS,	"11(state-insert)" },
47 	{ PFRES_MAXSTATES,	"12(state-limit)" },
48 	{ PFRES_SRCLIMIT,	"13(src-limit)" },
49 	{ PFRES_SYNPROXY,	"14(synproxy)" },
50 #if defined(__FreeBSD__)
51 	{ PFRES_MAPFAILED,	"15(map-failed)" },
52 #elif defined(__NetBSD__)
53 	{ PFRES_STATELOCKED,	"15(state-locked)" },
54 #elif defined(__OpenBSD__)
55 	{ PFRES_TRANSLATE,	"15(translate)" },
56 	{ PFRES_NOROUTE,	"16(no-route)" },
57 #elif defined(__APPLE__)
58 	{ PFRES_DUMMYNET,	"15(dummynet)" },
59 #endif
60 	{ 0,	NULL }
61 };
62 
63 static const struct tok pf_actions[] = {
64 	{ PF_PASS,		"pass" },
65 	{ PF_DROP,		"block" },
66 	{ PF_SCRUB,		"scrub" },
67 	{ PF_NOSCRUB,		"scrub" },
68 	{ PF_NAT,		"nat" },
69 	{ PF_NONAT,		"nonat" },
70 	{ PF_BINAT,		"binat" },
71 	{ PF_NOBINAT,		"nobinat" },
72 	{ PF_RDR,		"rdr" },
73 	{ PF_NORDR,		"nordr" },
74 	{ PF_SYNPROXY_DROP,	"synproxy-drop" },
75 #if defined(__FreeBSD__)
76 	{ PF_DEFER,		"defer" },
77 	{ PF_MATCH,		"match" },
78 #elif defined(__OpenBSD__)
79 	{ PF_DEFER,		"defer" },
80 	{ PF_MATCH,		"match" },
81 	{ PF_DIVERT,		"divert" },
82 	{ PF_RT,		"rt" },
83 	{ PF_AFRT,		"afrt" },
84 #elif defined(__APPLE__)
85 	{ PF_DUMMYNET,		"dummynet" },
86 	{ PF_NODUMMYNET,	"nodummynet" },
87 	{ PF_NAT64,		"nat64" },
88 	{ PF_NONAT64,		"nonat64" },
89 #endif
90 	{ 0,			NULL }
91 };
92 
93 static const struct tok pf_directions[] = {
94 	{ PF_INOUT,	"in/out" },
95 	{ PF_IN,	"in" },
96 	{ PF_OUT,	"out" },
97 #if defined(__OpenBSD__)
98 	{ PF_FWD,	"fwd" },
99 #endif
100 	{ 0,		NULL }
101 };
102 
103 static void
104 pflog_print(netdissect_options *ndo, const struct pfloghdr *hdr)
105 {
106 	uint32_t rulenr, subrulenr, ridentifier;
107 
108 	ndo->ndo_protocol = "pflog";
109 	rulenr = GET_BE_U_4(hdr->rulenr);
110 	subrulenr = GET_BE_U_4(hdr->subrulenr);
111 	ridentifier = GET_BE_U_4(hdr->ridentifier);
112 	if (subrulenr == (uint32_t)-1)
113 		ND_PRINT("rule %u/", rulenr);
114 	else {
115 		ND_PRINT("rule %u.", rulenr);
116 		nd_printjnp(ndo, (const u_char*)hdr->ruleset, PFLOG_RULESET_NAME_SIZE);
117 		ND_PRINT(".%u/", subrulenr);
118 	}
119 
120 	ND_PRINT("%s", tok2str(pf_reasons, "unkn(%u)", GET_U_1(hdr->reason)));
121 
122 	if (GET_BE_U_4(hdr->uid) != UID_MAX)
123 		ND_PRINT(" [uid %u]", (unsigned)GET_BE_U_4(hdr->uid));
124 
125 	if (ridentifier != 0)
126 		ND_PRINT(" [ridentifier %u]", ridentifier);
127 
128 	ND_PRINT(": %s %s on ",
129 	    tok2str(pf_actions, "unkn(%u)", GET_U_1(hdr->action)),
130 	    tok2str(pf_directions, "unkn(%u)", GET_U_1(hdr->dir)));
131 	nd_printjnp(ndo, (const u_char*)hdr->ifname, PFLOG_IFNAMSIZ);
132 	ND_PRINT(": ");
133 }
134 
135 void
136 pflog_if_print(netdissect_options *ndo, const struct pcap_pkthdr *h,
137                const u_char *p)
138 {
139 	u_int length = h->len;
140 	u_int hdrlen;
141 	u_int caplen = h->caplen;
142 	const struct pfloghdr *hdr;
143 	uint8_t af;
144 
145 	ndo->ndo_protocol = "pflog";
146 	/* check length */
147 	if (caplen < sizeof(uint8_t)) {
148 		nd_print_trunc(ndo);
149 		ndo->ndo_ll_hdr_len += h->caplen;
150 		return;
151 	}
152 
153 	hdr = (const struct pfloghdr *)p;
154 	hdrlen = GET_U_1(hdr->length);
155 	if (hdrlen < MIN_PFLOG_HDRLEN) {
156 		ND_PRINT("[pflog: invalid header length!]");
157 		ndo->ndo_ll_hdr_len += hdrlen;	/* XXX: not really */
158 		return;
159 	}
160 	hdrlen = roundup2(hdrlen, 4);
161 
162 	if (caplen < hdrlen) {
163 		nd_print_trunc(ndo);
164 		ndo->ndo_ll_hdr_len += hdrlen;	/* XXX: true? */
165 		return;
166 	}
167 
168 	/* print what we know */
169 	ND_TCHECK_SIZE(hdr);
170 	if (ndo->ndo_eflag)
171 		pflog_print(ndo, hdr);
172 
173 	/* skip to the real packet */
174 	af = GET_U_1(hdr->af);
175 	length -= hdrlen;
176 	caplen -= hdrlen;
177 	p += hdrlen;
178 	switch (af) {
179 
180 		/*
181 		 * If there's a system that doesn't use the AF_INET
182 		 * from 4.2BSD, feel free to add its value to af.h
183 		 * and use it here.
184 		 *
185 		 * Hopefully, there isn't.
186 		 */
187 		case BSD_AFNUM_INET:
188 		        ip_print(ndo, p, length);
189 			break;
190 
191 		/*
192 		 * Try all AF_INET6 values for all systems with pflog,
193 		 * including Darwin.
194 		 */
195 		case BSD_AFNUM_INET6_BSD:
196 		case BSD_AFNUM_INET6_FREEBSD:
197 		case BSD_AFNUM_INET6_DARWIN:
198 			ip6_print(ndo, p, length);
199 			break;
200 
201 	default:
202 		/* address family not handled, print raw packet */
203 		if (!ndo->ndo_eflag)
204 			pflog_print(ndo, hdr);
205 		if (!ndo->ndo_suppress_default_print)
206 			ND_DEFAULTPRINT(p, caplen);
207 	}
208 
209 	ndo->ndo_ll_hdr_len += hdrlen;
210 	return;
211 trunc:
212 	nd_print_trunc(ndo);
213 	ndo->ndo_ll_hdr_len += hdrlen;
214 }
215