xref: /netbsd-src/usr.bin/netstat/fast_ipsec.c (revision b49cc1491953ef2348eff9c84520ffd0678a5c8d)
1 /*	$NetBSD: fast_ipsec.c,v 1.17 2011/05/26 21:50:03 drochner Exp $ */
2 /* 	$FreeBSD: src/tools/tools/crypto/ipsecstats.c,v 1.1.4.1 2003/06/03 00:13:13 sam Exp $ */
3 
4 /*-
5  * Copyright (c) 2003, 2004 Jonathan Stone
6  * Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting
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  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD: src/tools/tools/crypto/ipsecstats.c,v 1.1.4.1 2003/06/03 00:13:13 sam Exp $
31  */
32 
33 #include <sys/cdefs.h>
34 #ifndef lint
35 #ifdef __NetBSD__
36 __RCSID("$NetBSD: fast_ipsec.c,v 1.17 2011/05/26 21:50:03 drochner Exp $");
37 #endif
38 #endif /* not lint*/
39 
40 /* Kernel headers required, but not included, by netstat.h */
41 #include <sys/types.h>
42 #include <sys/socket.h>
43 
44 /* Kernel headers for sysctl(3). */
45 #include <sys/param.h>
46 #include <sys/sysctl.h>
47 
48 /* Kernel headers for FAST_IPSEC statistics */
49 #include <net/pfkeyv2.h>
50 #include <netipsec/esp_var.h>
51 #include <netipsec/ah_var.h>
52 #include <netipsec/ipip_var.h>
53 #include <netipsec/ipcomp_var.h>
54 #include <netipsec/ipsec_var.h>
55 #include <netipsec/keydb.h>
56 
57 #include <machine/int_fmtio.h>
58 
59 #include <kvm.h>
60 #include <err.h>
61 #include <errno.h>
62 #include <stdio.h>
63 #include <string.h>
64 
65 #include "netstat.h"
66 
67 /*
68  * Cache the check to see if we have fast_ipsec so that we don't
69  * have to go to the kernel repeatedly.
70  */
71 static int
72 have_fast_ipsec(void)
73 {
74 	static int haveit = -1;
75 
76 	if (haveit == -1) {
77 		if (sysctlbyname("net.inet.ipsec.ipsecstats", NULL, NULL,
78 		    NULL, 0) == -1)
79 			haveit = 0;
80 		else
81 			haveit = 1;
82 	}
83 
84 	return (haveit);
85 }
86 
87 /*
88  * Dispatch between fetching and printing (KAME) IPsec statistics,
89  * and FAST_IPSEC statistics, so the rest of netstat need not know
90  * about the vagaries of the two implementations.
91  */
92 void
93 ipsec_switch(u_long off, const char * name)
94 {
95 
96 	if (have_fast_ipsec())
97 		return fast_ipsec_stats(off, name);
98 
99 	return ipsec_stats(off, name);
100 }
101 
102 
103 /*
104  * Table-driven mapping from SADB algorithm codes to string names.
105  */
106 struct alg {
107 	int		a;
108 	const char	*name;
109 };
110 static const struct alg aalgs[] = {
111 	{ SADB_AALG_NONE,	"none", },
112 	{ SADB_AALG_MD5HMAC,	"hmac-md5", },
113 	{ SADB_AALG_SHA1HMAC,	"hmac-sha1", },
114 	{ SADB_X_AALG_MD5,	"md5", },
115 	{ SADB_X_AALG_SHA,	"sha", },
116 	{ SADB_X_AALG_NULL,	"null", },
117 	{ SADB_X_AALG_SHA2_256,	"hmac-sha2-256", },
118 	{ SADB_X_AALG_SHA2_384,	"hmac-sha2-384", },
119 	{ SADB_X_AALG_SHA2_512,	"hmac-sha2-512", },
120 	{ SADB_X_AALG_AES_XCBC_MAC, "aes-xcbc-mac", },
121 	{ SADB_X_AALG_AES128GMAC, "aes-128-gmac", },
122 	{ SADB_X_AALG_AES192GMAC, "aes-192-gmac", },
123 	{ SADB_X_AALG_AES256GMAC, "aes-256-gmac", },
124 };
125 static const struct alg espalgs[] = {
126 	{ SADB_EALG_NONE,	"none", },
127 	{ SADB_EALG_DESCBC,	"des-cbc", },
128 	{ SADB_EALG_3DESCBC,	"3des-cbc", },
129 	{ SADB_EALG_NULL,	"null", },
130 	{ SADB_X_EALG_CAST128CBC, "cast128-cbc", },
131 	{ SADB_X_EALG_BLOWFISHCBC, "blowfish-cbc", },
132 	{ SADB_X_EALG_RIJNDAELCBC, "aes-cbc", },
133 	{ SADB_X_EALG_CAMELLIACBC, "camellia-cbc", },
134 	{ SADB_X_EALG_AESCTR,	"aes-ctr", },
135 	{ SADB_X_EALG_AESGCM16,	"aes-gcm-16", },
136 	{ SADB_X_EALG_AESGMAC, "aes-gmac", },
137 };
138 static const struct alg ipcompalgs[] = {
139 	{ SADB_X_CALG_NONE,	"none", },
140 	{ SADB_X_CALG_OUI,	"oui", },
141 	{ SADB_X_CALG_DEFLATE,	"deflate", },
142 	{ SADB_X_CALG_LZS,	"lzs", },
143 };
144 #define	N(a)	(sizeof(a)/sizeof(a[0]))
145 
146 static const char*
147 algname(int a, const struct alg algs[], int nalgs)
148 {
149 	static char buf[80];
150 	int i;
151 
152 	for (i = 0; i < nalgs; i++)
153 		if (algs[i].a == a)
154 			return algs[i].name;
155 	snprintf(buf, sizeof(buf), "alg#%u", a);
156 	return buf;
157 }
158 
159 /*
160  * Print the fast_ipsec statistics.
161  * Since NetBSD's netstat(1) seems not to find us for "netstat -s",
162  * but does(?) find KAME, be prepared to be called explicitly from
163  * netstat's main program for "netstat -s"; but silently do nothing
164  * if that happens when we are running on KAME IPsec.
165  */
166 void
167 fast_ipsec_stats(u_long off, const char *name)
168 {
169 	uint64_t ipsecstats[IPSEC_NSTATS];
170 	uint64_t ahstats[AH_NSTATS];
171 	uint64_t espstats[ESP_NSTATS];
172 	uint64_t ipcs[IPCOMP_NSTATS];
173 	uint64_t ipips[IPIP_NSTATS];
174 	int status;
175 	size_t slen;
176 	int i;
177 
178 	if (! use_sysctl) {
179 		warnx("IPsec stats not available via KVM.");
180 		return;
181 	}
182 
183 	memset(ipsecstats, 0, sizeof(ipsecstats));
184 	memset(ahstats, 0, sizeof(ahstats));
185 	memset(espstats, 0, sizeof(espstats));
186 	memset(ipcs, 0, sizeof(ipcs));
187 	memset(ipips, 0, sizeof(ipips));
188 
189 	/* silence check */
190 	if (!have_fast_ipsec())
191 		return;
192 
193 	slen = sizeof(ipsecstats);
194 	status = sysctlbyname("net.inet.ipsec.ipsecstats", ipsecstats, &slen,
195 			      NULL, 0);
196 	if (status < 0 && errno != ENOMEM)
197 		err(1, "net.inet.ipsec.ipsecstats");
198 
199 	slen = sizeof (ahstats);
200 	status = sysctlbyname("net.inet.ah.ah_stats", ahstats, &slen, NULL, 0);
201 	if (status < 0 && errno != ENOMEM)
202 		err(1, "net.inet.ah.ah_stats");
203 
204 	slen = sizeof (espstats);
205 	status = sysctlbyname("net.inet.esp.esp_stats", espstats, &slen, NULL, 0);
206 	if (status < 0 && errno != ENOMEM)
207 		err(1, "net.inet.esp.esp_stats");
208 
209 	slen = sizeof(ipcs);
210 	status = sysctlbyname("net.inet.ipcomp.ipcomp_stats", ipcs, &slen, NULL, 0);
211 	if (status < 0 && errno != ENOMEM)
212 		err(1, "net.inet.ipcomp.ipcomp_stats");
213 
214 	slen = sizeof(ipips);
215 	status = sysctlbyname("net.inet.ipip.ipip_stats", ipips, &slen, NULL, 0);
216 	if (status < 0 && errno != ENOMEM)
217 		err(1, "net.inet.ipip.ipip_stats");
218 
219 	printf("(Fast) IPsec:\n");
220 
221 #define	STAT(x,fmt)	if ((x) || sflag <= 1) printf("\t%"PRIu64" " fmt "\n", x)
222 	if (ipsecstats[IPSEC_STAT_IN_POLVIO]+ipsecstats[IPSEC_STAT_OUT_POLVIO])
223 		printf("\t%"PRIu64" policy violations: %"PRIu64" input %"PRIu64" output\n",
224 		        ipsecstats[IPSEC_STAT_IN_POLVIO] + ipsecstats[IPSEC_STAT_OUT_POLVIO],
225 			ipsecstats[IPSEC_STAT_IN_POLVIO], ipsecstats[IPSEC_STAT_OUT_POLVIO]);
226 	STAT(ipsecstats[IPSEC_STAT_OUT_NOSA], "no SA found (output)");
227 	STAT(ipsecstats[IPSEC_STAT_OUT_NOMEM], "no memory available (output)");
228 	STAT(ipsecstats[IPSEC_STAT_OUT_NOROUTE], "no route available (output)");
229 	STAT(ipsecstats[IPSEC_STAT_OUT_INVAL], "generic errors (output)");
230 	STAT(ipsecstats[IPSEC_STAT_OUT_BUNDLESA], "bundled SA processed (output)");
231 	STAT(ipsecstats[IPSEC_STAT_SPDCACHELOOKUP], "SPD cache lookups");
232 	STAT(ipsecstats[IPSEC_STAT_SPDCACHEMISS], "SPD cache misses");
233 #undef STAT
234 	printf("\n");
235 
236 	printf("IPsec ah:\n");
237 #define	AHSTAT(x,fmt)	if ((x) || sflag <= 1) printf("\t%"PRIu64" ah " fmt "\n", x)
238 	AHSTAT(ahstats[AH_STAT_INPUT],   "input packets processed");
239 	AHSTAT(ahstats[AH_STAT_OUTPUT],  "output packets processed");
240 	AHSTAT(ahstats[AH_STAT_HDROPS],  "headers too short");
241 	AHSTAT(ahstats[AH_STAT_NOPF],    "headers for unsupported address family");
242 	AHSTAT(ahstats[AH_STAT_NOTDB],   "packets with no SA");
243 	AHSTAT(ahstats[AH_STAT_BADKCR], "packets dropped by crypto returning NULL mbuf");
244 	AHSTAT(ahstats[AH_STAT_BADAUTH], "packets with bad authentication");
245 	AHSTAT(ahstats[AH_STAT_NOXFORM], "packets with no xform");
246 	AHSTAT(ahstats[AH_STAT_QFULL], "packets dropped due to queue full");
247 	AHSTAT(ahstats[AH_STAT_WRAP],  "packets dropped for replay counter wrap");
248 	AHSTAT(ahstats[AH_STAT_REPLAY],  "packets dropped for possible replay");
249 	AHSTAT(ahstats[AH_STAT_BADAUTHL],"packets dropped for bad authenticator length");
250 	AHSTAT(ahstats[AH_STAT_INVALID], "packets with an invalid SA");
251 	AHSTAT(ahstats[AH_STAT_TOOBIG],  "packets too big");
252 	AHSTAT(ahstats[AH_STAT_PDROPS],  "packets blocked due to policy");
253 	AHSTAT(ahstats[AH_STAT_CRYPTO],  "failed crypto requests");
254 	AHSTAT(ahstats[AH_STAT_TUNNEL],  "tunnel sanity check failures");
255 
256 	printf("\tah histogram:\n");
257 	for (i = 0; i < AH_ALG_MAX; i++)
258 		if (ahstats[AH_STAT_HIST + i])
259 			printf("\t\tah packets with %s: %"PRIu64"\n"
260 				, algname(i, aalgs, N(aalgs))
261 				, ahstats[AH_STAT_HIST + i]
262 			);
263 	AHSTAT(ahstats[AH_STAT_IBYTES], "bytes received");
264 	AHSTAT(ahstats[AH_STAT_OBYTES], "bytes transmitted");
265 #undef AHSTAT
266 	printf("\n");
267 
268 	printf("IPsec esp:\n");
269 #define	ESPSTAT(x,fmt) if ((x) || sflag <= 1) printf("\t%"PRIu64" esp " fmt "\n", x)
270 	ESPSTAT(espstats[ESP_STAT_INPUT],"input packets processed");
271 	ESPSTAT(espstats[ESP_STAT_OUTPUT],"output packets processed");
272 	ESPSTAT(espstats[ESP_STAT_HDROPS],"headers too short");
273 	ESPSTAT(espstats[ESP_STAT_NOPF], "headers for unsupported address family");
274 	ESPSTAT(espstats[ESP_STAT_NOTDB],"packets with no SA");
275 	ESPSTAT(espstats[ESP_STAT_BADKCR],"packets dropped by crypto returning NULL mbuf");
276 	ESPSTAT(espstats[ESP_STAT_QFULL],"packets dropped due to queue full");
277 	ESPSTAT(espstats[ESP_STAT_NOXFORM],"packets with no xform");
278 	ESPSTAT(espstats[ESP_STAT_BADILEN],"packets with bad ilen");
279 	ESPSTAT(espstats[ESP_STAT_BADENC],"packets with bad encryption");
280 	ESPSTAT(espstats[ESP_STAT_BADAUTH],"packets with bad authentication");
281 	ESPSTAT(espstats[ESP_STAT_WRAP], "packets dropped for replay counter wrap");
282 	ESPSTAT(espstats[ESP_STAT_REPLAY],"packets dropped for possible replay");
283 	ESPSTAT(espstats[ESP_STAT_INVALID],"packets with an invalid SA");
284 	ESPSTAT(espstats[ESP_STAT_TOOBIG],"packets too big");
285 	ESPSTAT(espstats[ESP_STAT_PDROPS],"packets blocked due to policy");
286 	ESPSTAT(espstats[ESP_STAT_CRYPTO],"failed crypto requests");
287 	ESPSTAT(espstats[ESP_STAT_TUNNEL],"tunnel sanity check failures");
288 	printf("\tesp histogram:\n");
289 	for (i = 0; i < ESP_ALG_MAX; i++)
290 		if (espstats[ESP_STAT_HIST + i])
291 			printf("\t\tesp packets with %s: %"PRIu64"\n"
292 				, algname(i, espalgs, N(espalgs))
293 				, espstats[ESP_STAT_HIST + i]
294 			);
295 	ESPSTAT(espstats[ESP_STAT_IBYTES], "bytes received");
296 	ESPSTAT(espstats[ESP_STAT_OBYTES], "bytes transmitted");
297 #undef ESPSTAT
298 	printf("IPsec ipip:\n");
299 
300 #define	IPIPSTAT(x,fmt) \
301 	if ((x) || sflag <= 1) printf("\t%"PRIu64" ipip " fmt "\n", x)
302 	IPIPSTAT(ipips[IPIP_STAT_IPACKETS],"total input packets");
303 	IPIPSTAT(ipips[IPIP_STAT_OPACKETS],"total output packets");
304 	IPIPSTAT(ipips[IPIP_STAT_HDROPS],"packets too short for header length");
305 	IPIPSTAT(ipips[IPIP_STAT_QFULL],"packets dropped due to queue full");
306 	IPIPSTAT(ipips[IPIP_STAT_PDROPS],"packets blocked due to policy");
307 	IPIPSTAT(ipips[IPIP_STAT_SPOOF],"IP spoofing attempts");
308 	IPIPSTAT(ipips[IPIP_STAT_FAMILY],"protocol family mismatched");
309 	IPIPSTAT(ipips[IPIP_STAT_UNSPEC],"missing tunnel-endpoint address");
310 	IPIPSTAT(ipips[IPIP_STAT_IBYTES],"input bytes received");
311 	IPIPSTAT(ipips[IPIP_STAT_OBYTES],"output bytes processed");
312 #undef IPIPSTAT
313 
314 	printf("IPsec ipcomp:\n");
315 #define	IPCOMP(x,fmt) \
316 	if ((x) || sflag <= 1) printf("\t%"PRIu64" ipcomp " fmt "\n", x)
317 
318 	IPCOMP(ipcs[IPCOMP_STAT_HDROPS],"packets too short for header length");
319 	IPCOMP(ipcs[IPCOMP_STAT_NOPF],	"protocol family not supported");
320 	IPCOMP(ipcs[IPCOMP_STAT_NOTDB],	"packets with no SA");
321 	IPCOMP(ipcs[IPCOMP_STAT_BADKCR],"packets dropped by crypto returning NULL mbuf");
322 	IPCOMP(ipcs[IPCOMP_STAT_QFULL],	"queue full");
323         IPCOMP(ipcs[IPCOMP_STAT_NOXFORM],"no support for transform");
324 	IPCOMP(ipcs[IPCOMP_STAT_WRAP],  "packets dropped for replay counter wrap");
325 	IPCOMP(ipcs[IPCOMP_STAT_INPUT],	"input IPcomp packets");
326 	IPCOMP(ipcs[IPCOMP_STAT_OUTPUT],"output IPcomp packets");
327 	IPCOMP(ipcs[IPCOMP_STAT_INVALID],"packets with an invalid SA");
328 	IPCOMP(ipcs[IPCOMP_STAT_TOOBIG],"packets decompressed as too big");
329 	IPCOMP(ipcs[IPCOMP_STAT_MINLEN], "packets too short to be compressed");
330 	IPCOMP(ipcs[IPCOMP_STAT_USELESS],"packet for which compression was useless");
331 	IPCOMP(ipcs[IPCOMP_STAT_PDROPS],"packets blocked due to policy");
332 	IPCOMP(ipcs[IPCOMP_STAT_CRYPTO],"failed crypto requests");
333 
334 	printf("\tIPcomp histogram:\n");
335 	for (i = 0; i < IPCOMP_ALG_MAX; i++)
336 		if (ipcs[IPCOMP_STAT_HIST + i])
337 			printf("\t\tIPcomp packets with %s: %"PRIu64"\n"
338 				, algname(i, ipcompalgs, N(ipcompalgs))
339 				, ipcs[IPCOMP_STAT_HIST + i]
340 			);
341 	IPCOMP(ipcs[IPCOMP_STAT_IBYTES],"input bytes");
342 	IPCOMP(ipcs[IPCOMP_STAT_OBYTES],"output bytes");
343 #undef IPCOMP
344 }
345