xref: /freebsd/usr.bin/netstat/pfkey.c (revision 1db64f89363c97858961c4df0b7d02f3223723cf)
1 /*	$NetBSD: inet.c,v 1.35.2.1 1999/04/29 14:57:08 perry Exp $	*/
2 /*	$KAME: ipsec.c,v 1.25 2001/03/12 09:04:39 itojun Exp $	*/
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
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  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the project nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 /*-
34  * Copyright (c) 1983, 1988, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  */
61 
62 #include <sys/param.h>
63 #include <sys/queue.h>
64 #include <sys/socket.h>
65 #include <sys/socketvar.h>
66 
67 #include <netinet/in.h>
68 
69 #ifdef IPSEC
70 #include <netipsec/keysock.h>
71 #endif
72 
73 #include <stdint.h>
74 #include <stdio.h>
75 #include <string.h>
76 #include <unistd.h>
77 #include <stdbool.h>
78 #include <libxo/xo.h>
79 #include "netstat.h"
80 
81 #ifdef IPSEC
82 
83 static const char *pfkey_msgtypenames[] = {
84 	"reserved", "getspi", "update", "add", "delete",
85 	"get", "acquire", "register", "expire", "flush",
86 	"dump", "x_promisc", "x_pchange", "x_spdupdate", "x_spdadd",
87 	"x_spddelete", "x_spdget", "x_spdacquire", "x_spddump", "x_spdflush",
88 	"x_spdsetidx", "x_spdexpire", "x_spddelete2"
89 };
90 
91 static const char *pfkey_msgtype_names (int);
92 
93 
94 static const char *
95 pfkey_msgtype_names(int x)
96 {
97 	const int max = nitems(pfkey_msgtypenames);
98 	static char buf[20];
99 
100 	if (x < max && pfkey_msgtypenames[x])
101 		return pfkey_msgtypenames[x];
102 	snprintf(buf, sizeof(buf), "#%d", x);
103 	return buf;
104 }
105 
106 void
107 pfkey_stats(u_long off, const char *name, int family __unused,
108     int proto __unused)
109 {
110 	struct pfkeystat pfkeystat;
111 	unsigned first, type;
112 
113 	if (off == 0)
114 		return;
115 	xo_emit("{T:/%s}:\n", name);
116 	xo_open_container(name);
117 	kread_counters(off, (char *)&pfkeystat, sizeof(pfkeystat));
118 
119 #define	p(f, m) if (pfkeystat.f || sflag <= 1) \
120 	xo_emit(m, (uintmax_t)pfkeystat.f, plural(pfkeystat.f))
121 
122 	/* userland -> kernel */
123 	p(out_total, "\t{:sent-requests/%ju} "
124 	    "{N:/request%s sent from userland}\n");
125 	p(out_bytes, "\t{:sent-bytes/%ju} "
126 	    "{N:/byte%s sent from userland}\n");
127 	for (first = 1, type = 0;
128 	    type<sizeof(pfkeystat.out_msgtype)/sizeof(pfkeystat.out_msgtype[0]);
129 	    type++) {
130 		if (pfkeystat.out_msgtype[type] <= 0)
131 			continue;
132 		if (first) {
133 			xo_open_list("output-histogram");
134 			xo_emit("\t{T:histogram by message type}:\n");
135 			first = 0;
136 		}
137 		xo_open_instance("output-histogram");
138 		xo_emit("\t\t{k::type/%s}: {:count/%ju}\n",
139 		    pfkey_msgtype_names(type),
140 		    (uintmax_t)pfkeystat.out_msgtype[type]);
141 		xo_close_instance("output-histogram");
142 	}
143 	if (!first)
144 		xo_close_list("output-histogram");
145 
146 	p(out_invlen, "\t{:dropped-bad-length/%ju} "
147 	    "{N:/message%s with invalid length field}\n");
148 	p(out_invver, "\t{:dropped-bad-version/%ju} "
149 	    "{N:/message%s with invalid version field}\n");
150 	p(out_invmsgtype, "\t{:dropped-bad-type/%ju} "
151 	    "{N:/message%s with invalid message type field}\n");
152 	p(out_tooshort, "\t{:dropped-too-short/%ju} "
153 	    "{N:/message%s too short}\n");
154 	p(out_nomem, "\t{:dropped-no-memory/%ju} "
155 	    "{N:/message%s with memory allocation failure}\n");
156 	p(out_dupext, "\t{:dropped-duplicate-extension/%ju} "
157 	    "{N:/message%s with duplicate extension}\n");
158 	p(out_invexttype, "\t{:dropped-bad-extension/%ju} "
159 	    "{N:/message%s with invalid extension type}\n");
160 	p(out_invsatype, "\t{:dropped-bad-sa-type/%ju} "
161 	    "{N:/message%s with invalid sa type}\n");
162 	p(out_invaddr, "\t{:dropped-bad-address-extension/%ju} "
163 	    "{N:/message%s with invalid address extension}\n");
164 
165 	/* kernel -> userland */
166 	p(in_total, "\t{:received-requests/%ju} "
167 	    "{N:/request%s sent to userland}\n");
168 	p(in_bytes, "\t{:received-bytes/%ju} "
169 	    "{N:/byte%s sent to userland}\n");
170 	for (first = 1, type = 0;
171 	    type < sizeof(pfkeystat.in_msgtype)/sizeof(pfkeystat.in_msgtype[0]);
172 	    type++) {
173 		if (pfkeystat.in_msgtype[type] <= 0)
174 			continue;
175 		if (first) {
176 			xo_open_list("input-histogram");
177 			xo_emit("\t{T:histogram by message type}:\n");
178 			first = 0;
179 		}
180 		xo_open_instance("input-histogram");
181 		xo_emit("\t\t{k:type/%s}: {:count/%ju}\n",
182 		    pfkey_msgtype_names(type),
183 		    (uintmax_t)pfkeystat.in_msgtype[type]);
184 		xo_close_instance("input-histogram");
185 	}
186 	if (!first)
187 		xo_close_list("input-histogram");
188 	p(in_msgtarget[KEY_SENDUP_ONE], "\t{:received-one-socket/%ju} "
189 	    "{N:/message%s toward single socket}\n");
190 	p(in_msgtarget[KEY_SENDUP_ALL], "\t{:received-all-sockets/%ju} "
191 	    "{N:/message%s toward all sockets}\n");
192 	p(in_msgtarget[KEY_SENDUP_REGISTERED],
193 	    "\t{:received-registered-sockets/%ju} "
194 	    "{N:/message%s toward registered sockets}\n");
195 	p(in_nomem, "\t{:discarded-no-memory/%ju} "
196 	    "{N:/message%s with memory allocation failure}\n");
197 #undef p
198 	xo_close_container(name);
199 }
200 #endif /* IPSEC */
201