xref: /freebsd/sbin/pfctl/pf_print_state.c (revision d2761422eb0a811976390743921b3f15e9d8331a)
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 		if (af == AF_INET || af == AF_INET6) {
117 			int bits = unmask(&addr->v.a.mask);
118 			if (bits < (af == AF_INET ? 32 : 128))
119 				printf("/%d", bits);
120 		}
121 	}
122 }
123 
124 void
print_addr_str(sa_family_t af,struct pf_addr * addr)125 print_addr_str(sa_family_t af, struct pf_addr *addr)
126 {
127 	static char buf[48];
128 
129 	if (inet_ntop(af, addr, buf, sizeof(buf)) == NULL)
130 		printf("?");
131 	else
132 		printf("%s", buf);
133 }
134 
135 void
print_name(struct pf_addr * addr,sa_family_t af)136 print_name(struct pf_addr *addr, sa_family_t af)
137 {
138 	struct sockaddr_storage	 ss;
139 	struct sockaddr_in	*sin;
140 	struct sockaddr_in6	*sin6;
141 	char			 host[NI_MAXHOST];
142 
143 	memset(&ss, 0, sizeof(ss));
144 	ss.ss_family = af;
145 	if (ss.ss_family == AF_INET) {
146 		sin = (struct sockaddr_in *)&ss;
147 		sin->sin_len = sizeof(*sin);
148 		sin->sin_addr = addr->v4;
149 	} else {
150 		sin6 = (struct sockaddr_in6 *)&ss;
151 		sin6->sin6_len = sizeof(*sin6);
152 		sin6->sin6_addr = addr->v6;
153 	}
154 
155 	if (getnameinfo((struct sockaddr *)&ss, ss.ss_len, host, sizeof(host),
156 		NULL, 0, NI_NOFQDN) != 0)
157 		printf("?");
158 	else
159 		printf("%s", host);
160 }
161 
162 void
print_host(struct pf_addr * addr,u_int16_t port,sa_family_t af,int opts)163 print_host(struct pf_addr *addr, u_int16_t port, sa_family_t af, int opts)
164 {
165 	struct pf_addr_wrap	 aw;
166 
167 	if (opts & PF_OPT_USEDNS)
168 		print_name(addr, af);
169 	else {
170 		memset(&aw, 0, sizeof(aw));
171 		aw.v.a.addr = *addr;
172 		memset(&aw.v.a.mask, 0xff, sizeof(aw.v.a.mask));
173 		print_addr(&aw, af, opts & PF_OPT_VERBOSE2);
174 	}
175 
176 	if (port) {
177 		if (af == AF_INET)
178 			printf(":%u", ntohs(port));
179 		else
180 			printf("[%u]", ntohs(port));
181 	}
182 }
183 
184 void
print_seq(struct pfctl_state_peer * p)185 print_seq(struct pfctl_state_peer *p)
186 {
187 	if (p->seqdiff)
188 		printf("[%u + %u](+%u)", p->seqlo,
189 		    p->seqhi - p->seqlo, p->seqdiff);
190 	else
191 		printf("[%u + %u]", p->seqlo,
192 		    p->seqhi - p->seqlo);
193 }
194 
195 
196 static const char *
sctp_state_name(int state)197 sctp_state_name(int state)
198 {
199 	switch (state) {
200 	case SCTP_CLOSED:
201 		return ("CLOSED");
202 	case SCTP_BOUND:
203 		return ("BOUND");
204 	case SCTP_LISTEN:
205 		return ("LISTEN");
206 	case SCTP_COOKIE_WAIT:
207 		return ("COOKIE_WAIT");
208 	case SCTP_COOKIE_ECHOED:
209 		return ("COOKIE_ECHOED");
210 	case SCTP_ESTABLISHED:
211 		return ("ESTABLISHED");
212 	case SCTP_SHUTDOWN_SENT:
213 		return ("SHUTDOWN_SENT");
214 	case SCTP_SHUTDOWN_RECEIVED:
215 		return ("SHUTDOWN_RECEIVED");
216 	case SCTP_SHUTDOWN_ACK_SENT:
217 		return ("SHUTDOWN_ACK_SENT");
218 	case SCTP_SHUTDOWN_PENDING:
219 		return ("SHUTDOWN_PENDING");
220 	default:
221 		return ("?");
222 	}
223 }
224 
225 void
print_state(struct pfctl_state * s,int opts)226 print_state(struct pfctl_state *s, int opts)
227 {
228 	struct pfctl_state_peer *src, *dst;
229 	struct pfctl_state_key *key, *sk, *nk;
230 	const char *protoname;
231 	int min, sec;
232 	uint8_t proto;
233 	int afto = (s->key[PF_SK_STACK].af != s->key[PF_SK_WIRE].af);
234 	int idx;
235 	const char *sn_type_names[] = PF_SN_TYPE_NAMES;
236 #ifndef __NO_STRICT_ALIGNMENT
237 	struct pfctl_state_key aligned_key[2];
238 
239 	bcopy(&s->key, aligned_key, sizeof(aligned_key));
240 	key = aligned_key;
241 #else
242 	key = s->key;
243 #endif
244 
245 	proto = s->key[PF_SK_WIRE].proto;
246 
247 	if (s->direction == PF_OUT) {
248 		src = &s->src;
249 		dst = &s->dst;
250 		sk = &key[PF_SK_STACK];
251 		nk = &key[PF_SK_WIRE];
252 		if (proto == IPPROTO_ICMP || proto == IPPROTO_ICMPV6)
253 			sk->port[0] = nk->port[0];
254 	} else {
255 		src = &s->dst;
256 		dst = &s->src;
257 		sk = &key[PF_SK_WIRE];
258 		nk = &key[PF_SK_STACK];
259 		if (proto == IPPROTO_ICMP || proto == IPPROTO_ICMPV6)
260 			sk->port[1] = nk->port[1];
261 	}
262 	printf("%s ", s->ifname);
263 	if ((protoname = pfctl_proto2name(proto)) != NULL)
264 		printf("%s ", protoname);
265 	else
266 		printf("%u ", proto);
267 
268 	print_host(&nk->addr[1], nk->port[1], nk->af, opts);
269 	if (nk->af != sk->af || PF_ANEQ(&nk->addr[1], &sk->addr[1], nk->af) ||
270 	    nk->port[1] != sk->port[1]) {
271 		idx = afto ? 0 : 1;
272 		printf(" (");
273 		print_host(&sk->addr[idx], sk->port[idx], sk->af,
274 		    opts);
275 		printf(")");
276 	}
277 	if (s->direction == PF_OUT || (afto && s->direction == PF_IN))
278 		printf(" -> ");
279 	else
280 		printf(" <- ");
281 	print_host(&nk->addr[0], nk->port[0], nk->af, opts);
282 	if (nk->af != sk->af || PF_ANEQ(&nk->addr[0], &sk->addr[0], nk->af) ||
283 	    nk->port[0] != sk->port[0]) {
284 		idx = afto ? 1 : 0;
285 		printf(" (");
286 		print_host(&sk->addr[idx], sk->port[idx], sk->af,
287 		    opts);
288 		printf(")");
289 	}
290 
291 	printf("    ");
292 	if (proto == IPPROTO_TCP) {
293 		if (src->state <= TCPS_TIME_WAIT &&
294 		    dst->state <= TCPS_TIME_WAIT)
295 			printf("   %s:%s\n", tcpstates[src->state],
296 			    tcpstates[dst->state]);
297 		else if (src->state == PF_TCPS_PROXY_SRC ||
298 		    dst->state == PF_TCPS_PROXY_SRC)
299 			printf("   PROXY:SRC\n");
300 		else if (src->state == PF_TCPS_PROXY_DST ||
301 		    dst->state == PF_TCPS_PROXY_DST)
302 			printf("   PROXY:DST\n");
303 		else
304 			printf("   <BAD STATE LEVELS %u:%u>\n",
305 			    src->state, dst->state);
306 		if (opts & PF_OPT_VERBOSE) {
307 			printf("   ");
308 			print_seq(src);
309 			if (src->wscale && dst->wscale)
310 				printf(" wscale %u",
311 				    src->wscale & PF_WSCALE_MASK);
312 			printf("  ");
313 			print_seq(dst);
314 			if (src->wscale && dst->wscale)
315 				printf(" wscale %u",
316 				    dst->wscale & PF_WSCALE_MASK);
317 			printf("\n");
318 		}
319 	} else if (proto == IPPROTO_UDP && src->state < PFUDPS_NSTATES &&
320 	    dst->state < PFUDPS_NSTATES) {
321 		const char *states[] = PFUDPS_NAMES;
322 
323 		printf("   %s:%s\n", states[src->state], states[dst->state]);
324 	} else if (proto == IPPROTO_SCTP) {
325 		printf("   %s:%s\n", sctp_state_name(src->state),
326 		    sctp_state_name(dst->state));
327 #ifndef INET6
328 	} else if (proto != IPPROTO_ICMP && src->state < PFOTHERS_NSTATES &&
329 	    dst->state < PFOTHERS_NSTATES) {
330 #else
331 	} else if (proto != IPPROTO_ICMP && proto != IPPROTO_ICMPV6 &&
332 	    src->state < PFOTHERS_NSTATES && dst->state < PFOTHERS_NSTATES) {
333 #endif
334 		/* XXX ICMP doesn't really have state levels */
335 		const char *states[] = PFOTHERS_NAMES;
336 
337 		printf("   %s:%s\n", states[src->state], states[dst->state]);
338 	} else {
339 		printf("   %u:%u\n", src->state, dst->state);
340 	}
341 
342 	if (opts & PF_OPT_VERBOSE) {
343 		u_int32_t creation = s->creation;
344 		u_int32_t expire = s->expire;
345 
346 		sec = creation % 60;
347 		creation /= 60;
348 		min = creation % 60;
349 		creation /= 60;
350 		printf("   age %.2u:%.2u:%.2u", creation, min, sec);
351 		sec = expire % 60;
352 		expire /= 60;
353 		min = expire % 60;
354 		expire /= 60;
355 		printf(", expires in %.2u:%.2u:%.2u", expire, min, sec);
356 
357 		printf(", %ju:%ju pkts, %ju:%ju bytes",
358 		    s->packets[0],
359 		    s->packets[1],
360 		    s->bytes[0],
361 		    s->bytes[1]);
362 		if (s->anchor != -1)
363 			printf(", anchor %u", s->anchor);
364 		if (s->rule != -1)
365 			printf(", rule %u", s->rule);
366 		if (s->state_flags & PFSTATE_ALLOWOPTS)
367 			printf(", allow-opts");
368 		if (s->state_flags & PFSTATE_SLOPPY)
369 			printf(", sloppy");
370 		if (s->state_flags & PFSTATE_NOSYNC)
371 			printf(", no-sync");
372 		if (s->state_flags & PFSTATE_PFLOW)
373 			printf(", pflow");
374 		if (s->state_flags & PFSTATE_ACK)
375 			printf(", psync-ack");
376 		if (s->state_flags & PFSTATE_NODF)
377 			printf(", no-df");
378 		if (s->state_flags & PFSTATE_SETTOS)
379 			printf(", set-tos 0x%2.2x", s->set_tos);
380 		if (s->state_flags & PFSTATE_RANDOMID)
381 			printf(", random-id");
382 		if (s->state_flags & PFSTATE_SCRUB_TCP)
383 			printf(", reassemble-tcp");
384 		if (s->state_flags & PFSTATE_SETPRIO)
385 			printf(", set-prio (0x%02x 0x%02x)",
386 			    s->set_prio[0], s->set_prio[1]);
387 		if (s->dnpipe || s->dnrpipe) {
388 			if (s->state_flags & PFSTATE_DN_IS_PIPE)
389 				printf(", dummynet pipe (%d %d)",
390 				s->dnpipe, s->dnrpipe);
391 			if (s->state_flags & PFSTATE_DN_IS_QUEUE)
392 				printf(", dummynet queue (%d %d)",
393 				s->dnpipe, s->dnrpipe);
394 		}
395 		if (s->src_node_flags & PFSTATE_SRC_NODE_LIMIT)
396 			printf(", %s", sn_type_names[PF_SN_LIMIT]);
397 		if (s->src_node_flags & PFSTATE_SRC_NODE_LIMIT_GLOBAL)
398 			printf(" global");
399 		if (s->src_node_flags & PFSTATE_SRC_NODE_NAT)
400 			printf(", %s", sn_type_names[PF_SN_NAT]);
401 		if (s->src_node_flags & PFSTATE_SRC_NODE_ROUTE)
402 			printf(", %s", sn_type_names[PF_SN_ROUTE]);
403 		if (s->log)
404 			printf(", log");
405 		if (s->log & PF_LOG_ALL)
406 			printf(" (all)");
407 		if (s->min_ttl)
408 			printf(", min-ttl %d", s->min_ttl);
409 		if (s->max_mss)
410 			printf(", max-mss %d", s->max_mss);
411 		printf("\n");
412 	}
413 	if (opts & PF_OPT_VERBOSE2) {
414 		u_int64_t id;
415 
416 		bcopy(&s->id, &id, sizeof(u_int64_t));
417 		printf("   id: %016jx creatorid: %08x", id, s->creatorid);
418 		if (s->rt) {
419 			switch (s->rt) {
420 				case PF_ROUTETO:
421 					printf(" route-to: ");
422 					break;
423 				case PF_DUPTO:
424 					printf(" dup-to: ");
425 					break;
426 				case PF_REPLYTO:
427 					printf(" reply-to: ");
428 					break;
429 				default:
430 					printf(" gateway: ");
431 			}
432 			print_host(&s->rt_addr, 0, s->rt_af, opts);
433 			if (s->rt_ifname[0])
434 				printf("@%s", s->rt_ifname);
435 		}
436 		if (s->rtableid != -1)
437 			printf(" rtable: %d", s->rtableid);
438 		printf("\n");
439 
440 		if (strcmp(s->ifname, s->orig_ifname) != 0)
441 			printf("   origif: %s\n", s->orig_ifname);
442 	}
443 }
444 
445 int
unmask(struct pf_addr * m)446 unmask(struct pf_addr *m)
447 {
448 	int i = 31, j = 0, b = 0;
449 	u_int32_t tmp;
450 
451 	while (j < 4 && m->addr32[j] == 0xffffffff) {
452 		b += 32;
453 		j++;
454 	}
455 	if (j < 4) {
456 		tmp = ntohl(m->addr32[j]);
457 		for (i = 31; tmp & (1 << i); --i)
458 			b++;
459 	}
460 	return (b);
461 }
462