xref: /freebsd/sbin/pfctl/pf_print_state.c (revision 466ac79e47fe6d486956096ae6724fdfd5776c39)
1 /*	$OpenBSD: pf_print_state.c,v 1.52 2008/08/12 16:40:18 david Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause
5  *
6  * Copyright (c) 2001 Daniel Hartmeier
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  *    - Redistributions of source code must retain the above copyright
14  *      notice, this list of conditions and the following disclaimer.
15  *    - Redistributions in binary form must reproduce the above
16  *      copyright notice, this list of conditions and the following
17  *      disclaimer in the documentation and/or other materials provided
18  *      with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 #include <sys/types.h>
36 #include <sys/socket.h>
37 #include <sys/endian.h>
38 #include <net/if.h>
39 #define TCPSTATES
40 #include <netinet/tcp_fsm.h>
41 #include <netinet/sctp.h>
42 #include <net/pfvar.h>
43 #include <arpa/inet.h>
44 #include <netdb.h>
45 
46 #include <stdint.h>
47 #include <stdio.h>
48 #include <string.h>
49 
50 #include "pfctl_parser.h"
51 #include "pfctl.h"
52 
53 void	print_name(struct pf_addr *, sa_family_t);
54 
55 void
print_addr(struct pf_addr_wrap * addr,sa_family_t af,int verbose)56 print_addr(struct pf_addr_wrap *addr, sa_family_t af, int verbose)
57 {
58 	switch (addr->type) {
59 	case PF_ADDR_DYNIFTL:
60 		printf("(%s", addr->v.ifname);
61 		if (addr->iflags & PFI_AFLAG_NETWORK)
62 			printf(":network");
63 		if (addr->iflags & PFI_AFLAG_BROADCAST)
64 			printf(":broadcast");
65 		if (addr->iflags & PFI_AFLAG_PEER)
66 			printf(":peer");
67 		if (addr->iflags & PFI_AFLAG_NOALIAS)
68 			printf(":0");
69 		if (verbose) {
70 			if (addr->p.dyncnt <= 0)
71 				printf(":*");
72 			else
73 				printf(":%d", addr->p.dyncnt);
74 		}
75 		printf(")");
76 		break;
77 	case PF_ADDR_TABLE:
78 		if (verbose)
79 			if (addr->p.tblcnt == -1)
80 				printf("<%s:*>", addr->v.tblname);
81 			else
82 				printf("<%s:%d>", addr->v.tblname,
83 				    addr->p.tblcnt);
84 		else
85 			printf("<%s>", addr->v.tblname);
86 		return;
87 	case PF_ADDR_RANGE: {
88 		print_addr_str(af, &addr->v.a.addr);
89 		printf(" - ");
90 		print_addr_str(af, &addr->v.a.mask);
91 
92 		break;
93 	}
94 	case PF_ADDR_ADDRMASK:
95 		if (PF_AZERO(&addr->v.a.addr, AF_INET6) &&
96 		    PF_AZERO(&addr->v.a.mask, AF_INET6))
97 			printf("any");
98 		else
99 			print_addr_str(af, &addr->v.a.addr);
100 		break;
101 	case PF_ADDR_NOROUTE:
102 		printf("no-route");
103 		return;
104 	case PF_ADDR_URPFFAILED:
105 		printf("urpf-failed");
106 		return;
107 	default:
108 		printf("?");
109 		return;
110 	}
111 
112 	/* mask if not _both_ address and mask are zero */
113 	if (addr->type != PF_ADDR_RANGE &&
114 	    !(PF_AZERO(&addr->v.a.addr, AF_INET6) &&
115 	    PF_AZERO(&addr->v.a.mask, AF_INET6))) {
116 		int bits = unmask(&addr->v.a.mask, af);
117 
118 		if (bits < (af == AF_INET ? 32 : 128))
119 			printf("/%d", bits);
120 	}
121 }
122 
123 void
print_addr_str(sa_family_t af,struct pf_addr * addr)124 print_addr_str(sa_family_t af, struct pf_addr *addr)
125 {
126 	static char buf[48];
127 
128 	if (inet_ntop(af, addr, buf, sizeof(buf)) == NULL)
129 		printf("?");
130 	else
131 		printf("%s", buf);
132 }
133 
134 void
print_name(struct pf_addr * addr,sa_family_t af)135 print_name(struct pf_addr *addr, sa_family_t af)
136 {
137 	char host[NI_MAXHOST];
138 
139 	strlcpy(host, "?", sizeof(host));
140 	switch (af) {
141 	case AF_INET: {
142 		struct sockaddr_in sin;
143 
144 		memset(&sin, 0, sizeof(sin));
145 		sin.sin_len = sizeof(sin);
146 		sin.sin_family = AF_INET;
147 		sin.sin_addr = addr->v4;
148 		getnameinfo((struct sockaddr *)&sin, sin.sin_len,
149 		    host, sizeof(host), NULL, 0, NI_NOFQDN);
150 		break;
151 	}
152 	case AF_INET6: {
153 		struct sockaddr_in6 sin6;
154 
155 		memset(&sin6, 0, sizeof(sin6));
156 		sin6.sin6_len = sizeof(sin6);
157 		sin6.sin6_family = AF_INET6;
158 		sin6.sin6_addr = addr->v6;
159 		getnameinfo((struct sockaddr *)&sin6, sin6.sin6_len,
160 		    host, sizeof(host), NULL, 0, NI_NOFQDN);
161 		break;
162 	}
163 	}
164 	printf("%s", host);
165 }
166 
167 void
print_host(struct pf_addr * addr,u_int16_t port,sa_family_t af,int opts)168 print_host(struct pf_addr *addr, u_int16_t port, sa_family_t af, int opts)
169 {
170 	if (opts & PF_OPT_USEDNS)
171 		print_name(addr, af);
172 	else {
173 		struct pf_addr_wrap aw;
174 
175 		memset(&aw, 0, sizeof(aw));
176 		aw.v.a.addr = *addr;
177 		if (af == AF_INET)
178 			aw.v.a.mask.addr32[0] = 0xffffffff;
179 		else {
180 			memset(&aw.v.a.mask, 0xff, sizeof(aw.v.a.mask));
181 			af = AF_INET6;
182 		}
183 		print_addr(&aw, af, opts & PF_OPT_VERBOSE2);
184 	}
185 
186 	if (port) {
187 		if (af == AF_INET)
188 			printf(":%u", ntohs(port));
189 		else
190 			printf("[%u]", ntohs(port));
191 	}
192 }
193 
194 void
print_seq(struct pfctl_state_peer * p)195 print_seq(struct pfctl_state_peer *p)
196 {
197 	if (p->seqdiff)
198 		printf("[%u + %u](+%u)", p->seqlo,
199 		    p->seqhi - p->seqlo, p->seqdiff);
200 	else
201 		printf("[%u + %u]", p->seqlo,
202 		    p->seqhi - p->seqlo);
203 }
204 
205 
206 static const char *
sctp_state_name(int state)207 sctp_state_name(int state)
208 {
209 	switch (state) {
210 	case SCTP_CLOSED:
211 		return ("CLOSED");
212 	case SCTP_BOUND:
213 		return ("BOUND");
214 	case SCTP_LISTEN:
215 		return ("LISTEN");
216 	case SCTP_COOKIE_WAIT:
217 		return ("COOKIE_WAIT");
218 	case SCTP_COOKIE_ECHOED:
219 		return ("COOKIE_ECHOED");
220 	case SCTP_ESTABLISHED:
221 		return ("ESTABLISHED");
222 	case SCTP_SHUTDOWN_SENT:
223 		return ("SHUTDOWN_SENT");
224 	case SCTP_SHUTDOWN_RECEIVED:
225 		return ("SHUTDOWN_RECEIVED");
226 	case SCTP_SHUTDOWN_ACK_SENT:
227 		return ("SHUTDOWN_ACK_SENT");
228 	case SCTP_SHUTDOWN_PENDING:
229 		return ("SHUTDOWN_PENDING");
230 	default:
231 		return ("?");
232 	}
233 }
234 
235 void
print_state(struct pfctl_state * s,int opts)236 print_state(struct pfctl_state *s, int opts)
237 {
238 	struct pfctl_state_peer *src, *dst;
239 	struct pfctl_state_key *key, *sk, *nk;
240 	const char *protoname;
241 	int min, sec;
242 	sa_family_t af;
243 	uint8_t proto;
244 	int afto = (s->key[PF_SK_STACK].af != s->key[PF_SK_WIRE].af);
245 	int idx;
246 	const char *sn_type_names[] = PF_SN_TYPE_NAMES;
247 #ifndef __NO_STRICT_ALIGNMENT
248 	struct pfctl_state_key aligned_key[2];
249 
250 	bcopy(&s->key, aligned_key, sizeof(aligned_key));
251 	key = aligned_key;
252 #else
253 	key = s->key;
254 #endif
255 
256 	af = s->key[PF_SK_WIRE].af;
257 	proto = s->key[PF_SK_WIRE].proto;
258 
259 	if (s->direction == PF_OUT) {
260 		src = &s->src;
261 		dst = &s->dst;
262 		sk = &key[PF_SK_STACK];
263 		nk = &key[PF_SK_WIRE];
264 		if (proto == IPPROTO_ICMP || proto == IPPROTO_ICMPV6)
265 			sk->port[0] = nk->port[0];
266 	} else {
267 		src = &s->dst;
268 		dst = &s->src;
269 		sk = &key[PF_SK_WIRE];
270 		nk = &key[PF_SK_STACK];
271 		if (proto == IPPROTO_ICMP || proto == IPPROTO_ICMPV6)
272 			sk->port[1] = nk->port[1];
273 	}
274 	printf("%s ", s->ifname);
275 	if ((protoname = pfctl_proto2name(proto)) != NULL)
276 		printf("%s ", protoname);
277 	else
278 		printf("%u ", proto);
279 
280 	print_host(&nk->addr[1], nk->port[1], nk->af, opts);
281 	if (nk->af != sk->af || PF_ANEQ(&nk->addr[1], &sk->addr[1], nk->af) ||
282 	    nk->port[1] != sk->port[1]) {
283 		idx = afto ? 0 : 1;
284 		printf(" (");
285 		print_host(&sk->addr[idx], sk->port[idx], sk->af,
286 		    opts);
287 		printf(")");
288 	}
289 	if (s->direction == PF_OUT || (afto && s->direction == PF_IN))
290 		printf(" -> ");
291 	else
292 		printf(" <- ");
293 	print_host(&nk->addr[0], nk->port[0], nk->af, opts);
294 	if (nk->af != sk->af || PF_ANEQ(&nk->addr[0], &sk->addr[0], nk->af) ||
295 	    nk->port[0] != sk->port[0]) {
296 		idx = afto ? 1 : 0;
297 		printf(" (");
298 		print_host(&sk->addr[idx], sk->port[idx], sk->af,
299 		    opts);
300 		printf(")");
301 	}
302 
303 	printf("    ");
304 	if (proto == IPPROTO_TCP) {
305 		if (src->state <= TCPS_TIME_WAIT &&
306 		    dst->state <= TCPS_TIME_WAIT)
307 			printf("   %s:%s\n", tcpstates[src->state],
308 			    tcpstates[dst->state]);
309 		else if (src->state == PF_TCPS_PROXY_SRC ||
310 		    dst->state == PF_TCPS_PROXY_SRC)
311 			printf("   PROXY:SRC\n");
312 		else if (src->state == PF_TCPS_PROXY_DST ||
313 		    dst->state == PF_TCPS_PROXY_DST)
314 			printf("   PROXY:DST\n");
315 		else
316 			printf("   <BAD STATE LEVELS %u:%u>\n",
317 			    src->state, dst->state);
318 		if (opts & PF_OPT_VERBOSE) {
319 			printf("   ");
320 			print_seq(src);
321 			if (src->wscale && dst->wscale)
322 				printf(" wscale %u",
323 				    src->wscale & PF_WSCALE_MASK);
324 			printf("  ");
325 			print_seq(dst);
326 			if (src->wscale && dst->wscale)
327 				printf(" wscale %u",
328 				    dst->wscale & PF_WSCALE_MASK);
329 			printf("\n");
330 		}
331 	} else if (proto == IPPROTO_UDP && src->state < PFUDPS_NSTATES &&
332 	    dst->state < PFUDPS_NSTATES) {
333 		const char *states[] = PFUDPS_NAMES;
334 
335 		printf("   %s:%s\n", states[src->state], states[dst->state]);
336 	} else if (proto == IPPROTO_SCTP) {
337 		printf("   %s:%s\n", sctp_state_name(src->state),
338 		    sctp_state_name(dst->state));
339 #ifndef INET6
340 	} else if (proto != IPPROTO_ICMP && src->state < PFOTHERS_NSTATES &&
341 	    dst->state < PFOTHERS_NSTATES) {
342 #else
343 	} else if (proto != IPPROTO_ICMP && proto != IPPROTO_ICMPV6 &&
344 	    src->state < PFOTHERS_NSTATES && dst->state < PFOTHERS_NSTATES) {
345 #endif
346 		/* XXX ICMP doesn't really have state levels */
347 		const char *states[] = PFOTHERS_NAMES;
348 
349 		printf("   %s:%s\n", states[src->state], states[dst->state]);
350 	} else {
351 		printf("   %u:%u\n", src->state, dst->state);
352 	}
353 
354 	if (opts & PF_OPT_VERBOSE) {
355 		u_int32_t creation = s->creation;
356 		u_int32_t expire = s->expire;
357 
358 		sec = creation % 60;
359 		creation /= 60;
360 		min = creation % 60;
361 		creation /= 60;
362 		printf("   age %.2u:%.2u:%.2u", creation, min, sec);
363 		sec = expire % 60;
364 		expire /= 60;
365 		min = expire % 60;
366 		expire /= 60;
367 		printf(", expires in %.2u:%.2u:%.2u", expire, min, sec);
368 
369 		printf(", %ju:%ju pkts, %ju:%ju bytes",
370 		    s->packets[0],
371 		    s->packets[1],
372 		    s->bytes[0],
373 		    s->bytes[1]);
374 		if (s->anchor != -1)
375 			printf(", anchor %u", s->anchor);
376 		if (s->rule != -1)
377 			printf(", rule %u", s->rule);
378 		if (s->state_flags & PFSTATE_ALLOWOPTS)
379 			printf(", allow-opts");
380 		if (s->state_flags & PFSTATE_SLOPPY)
381 			printf(", sloppy");
382 		if (s->state_flags & PFSTATE_NOSYNC)
383 			printf(", no-sync");
384 		if (s->state_flags & PFSTATE_PFLOW)
385 			printf(", pflow");
386 		if (s->state_flags & PFSTATE_ACK)
387 			printf(", psync-ack");
388 		if (s->state_flags & PFSTATE_NODF)
389 			printf(", no-df");
390 		if (s->state_flags & PFSTATE_SETTOS)
391 			printf(", set-tos 0x%2.2x", s->set_tos);
392 		if (s->state_flags & PFSTATE_RANDOMID)
393 			printf(", random-id");
394 		if (s->state_flags & PFSTATE_SCRUB_TCP)
395 			printf(", reassemble-tcp");
396 		if (s->state_flags & PFSTATE_SETPRIO)
397 			printf(", set-prio (0x%02x 0x%02x)",
398 			    s->set_prio[0], s->set_prio[1]);
399 		if (s->dnpipe || s->dnrpipe) {
400 			if (s->state_flags & PFSTATE_DN_IS_PIPE)
401 				printf(", dummynet pipe (%d %d)",
402 				s->dnpipe, s->dnrpipe);
403 			if (s->state_flags & PFSTATE_DN_IS_QUEUE)
404 				printf(", dummynet queue (%d %d)",
405 				s->dnpipe, s->dnrpipe);
406 		}
407 		if (s->src_node_flags & PFSTATE_SRC_NODE_LIMIT)
408 			printf(", %s", sn_type_names[PF_SN_LIMIT]);
409 		if (s->src_node_flags & PFSTATE_SRC_NODE_LIMIT_GLOBAL)
410 			printf(" global");
411 		if (s->src_node_flags & PFSTATE_SRC_NODE_NAT)
412 			printf(", %s", sn_type_names[PF_SN_NAT]);
413 		if (s->src_node_flags & PFSTATE_SRC_NODE_ROUTE)
414 			printf(", %s", sn_type_names[PF_SN_ROUTE]);
415 		if (s->log)
416 			printf(", log");
417 		if (s->log & PF_LOG_ALL)
418 			printf(" (all)");
419 		if (s->min_ttl)
420 			printf(", min-ttl %d", s->min_ttl);
421 		if (s->max_mss)
422 			printf(", max-mss %d", s->max_mss);
423 		printf("\n");
424 	}
425 	if (opts & PF_OPT_VERBOSE2) {
426 		u_int64_t id;
427 
428 		bcopy(&s->id, &id, sizeof(u_int64_t));
429 		printf("   id: %016jx creatorid: %08x", id, s->creatorid);
430 		if (s->rt) {
431 			switch (s->rt) {
432 				case PF_ROUTETO:
433 					printf(" route-to: ");
434 					break;
435 				case PF_DUPTO:
436 					printf(" dup-to: ");
437 					break;
438 				case PF_REPLYTO:
439 					printf(" reply-to: ");
440 					break;
441 				default:
442 					printf(" gateway: ");
443 			}
444 			print_host(&s->rt_addr, 0, af, opts);
445 			if (s->rt_ifname[0])
446 				printf("@%s", s->rt_ifname);
447 		}
448 		if (s->rtableid != -1)
449 			printf(" rtable: %d", s->rtableid);
450 		printf("\n");
451 
452 		if (strcmp(s->ifname, s->orig_ifname) != 0)
453 			printf("   origif: %s\n", s->orig_ifname);
454 	}
455 }
456 
457 int
unmask(struct pf_addr * m,sa_family_t af)458 unmask(struct pf_addr *m, sa_family_t af)
459 {
460 	int i = 31, j = 0, b = 0;
461 	u_int32_t tmp;
462 
463 	while (j < 4 && m->addr32[j] == 0xffffffff) {
464 		b += 32;
465 		j++;
466 	}
467 	if (j < 4) {
468 		tmp = ntohl(m->addr32[j]);
469 		for (i = 31; tmp & (1 << i); --i)
470 			b++;
471 	}
472 	return (b);
473 }
474