Home | History | Annotate | Line # | Download | only in netstat
fast_ipsec.c revision 1.7.12.1
      1 /*	$NetBSD: fast_ipsec.c,v 1.7.12.1 2008/01/09 02:00:50 matt 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.7.12.1 2008/01/09 02:00:50 matt 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, 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 };
    121 static const struct alg espalgs[] = {
    122 	{ SADB_EALG_NONE,	"none", },
    123 	{ SADB_EALG_DESCBC,	"des-cbc", },
    124 	{ SADB_EALG_3DESCBC,	"3des-cbc", },
    125 	{ SADB_EALG_NULL,	"null", },
    126 	{ SADB_X_EALG_CAST128CBC, "cast128-cbc", },
    127 	{ SADB_X_EALG_BLOWFISHCBC, "blowfish-cbc", },
    128 	{ SADB_X_EALG_RIJNDAELCBC, "aes-cbc", },
    129 };
    130 static const struct alg ipcompalgs[] = {
    131 	{ SADB_X_CALG_NONE,	"none", },
    132 	{ SADB_X_CALG_OUI,	"oui", },
    133 	{ SADB_X_CALG_DEFLATE,	"deflate", },
    134 	{ SADB_X_CALG_LZS,	"lzs", },
    135 };
    136 #define	N(a)	(sizeof(a)/sizeof(a[0]))
    137 
    138 static const char*
    139 algname(int a, const struct alg algs[], int nalgs)
    140 {
    141 	static char buf[80];
    142 	int i;
    143 
    144 	for (i = 0; i < nalgs; i++)
    145 		if (algs[i].a == a)
    146 			return algs[i].name;
    147 	snprintf(buf, sizeof(buf), "alg#%u", a);
    148 	return buf;
    149 }
    150 
    151 /*
    152  * Print the fast_ipsec statistics.
    153  * Since NetBSD's netstat(1) seems not to find us for "netstat -s",
    154  * but does(?) find KAME, be prepared to be called explicitly from
    155  * netstat's main program for "netstat -s"; but silently do nothing
    156  * if that happens when we are running on KAME IPsec.
    157  */
    158 void
    159 fast_ipsec_stats(u_long off, char *name)
    160 {
    161 	struct newipsecstat ipsecstats;
    162 	struct ahstat ahstats;
    163 	struct espstat espstats;
    164 	struct ipcompstat ipcs;
    165 	struct ipipstat ipips;
    166 	int status;
    167 	size_t slen;
    168 	int i;
    169 
    170 	memset(&ipsecstats, 0, sizeof(ipsecstats));
    171 	memset(&ahstats, 0, sizeof(ahstats));
    172 	memset(&espstats, 0, sizeof(espstats));
    173 	memset(&ipcs, 0, sizeof(ipcs));
    174 	memset(&ipips, 0, sizeof(ipips));
    175 
    176 	/* silence check */
    177 	if (!have_fast_ipsec())
    178 		return;
    179 
    180 	slen = sizeof(ipsecstats);
    181 	status = sysctlbyname("net.inet.ipsec.ipsecstats", &ipsecstats, &slen,
    182 			      NULL, 0);
    183 	if (status < 0 && errno != ENOMEM)
    184 		err(1, "net.inet.ipsec.ipsecstats");
    185 
    186 	slen = sizeof (ahstats);
    187 	status = sysctlbyname("net.inet.ah.ah_stats", &ahstats, &slen, NULL, 0);
    188 	if (status < 0 && errno != ENOMEM)
    189 		err(1, "net.inet.ah.ah_stats");
    190 
    191 	slen = sizeof (espstats);
    192 	status = sysctlbyname("net.inet.esp.esp_stats", &espstats, &slen, NULL, 0);
    193 	if (status < 0 && errno != ENOMEM)
    194 		err(1, "net.inet.esp.esp_stats");
    195 
    196 	slen = sizeof(ipcs);
    197 	status = sysctlbyname("net.inet.ipcomp.ipcomp_stats", &ipcs, &slen, NULL, 0);
    198 	if (status < 0 && errno != ENOMEM)
    199 		err(1, "net.inet.ipcomp.ipcomp_stats");
    200 
    201 	slen = sizeof(ipips);
    202 	status = sysctlbyname("net.inet.ipip.ipip_stats", &ipips, &slen, NULL, 0);
    203 	if (status < 0 && errno != ENOMEM)
    204 		err(1, "net.inet.ipip.ipip_stats");
    205 
    206 	printf("(Fast) IPsec:\n");
    207 
    208 #define	STAT(x,fmt)	if ((x) || sflag <= 1) printf("\t%"PRIu64" " fmt "\n", x)
    209 	if (ipsecstats.ips_in_polvio+ipsecstats.ips_out_polvio)
    210 		printf("\t%"PRIu64" policy violations: %"PRIu64" input %"PRIu64" output\n",
    211 		        ipsecstats.ips_in_polvio + ipsecstats.ips_out_polvio,
    212 			ipsecstats.ips_in_polvio, ipsecstats.ips_out_polvio);
    213 	STAT(ipsecstats.ips_out_nosa, "no SA found (output)");
    214 	STAT(ipsecstats.ips_out_nomem, "no memory available (output)");
    215 	STAT(ipsecstats.ips_out_noroute, "no route available (output)");
    216 	STAT(ipsecstats.ips_out_inval, "generic errors (output)");
    217 	STAT(ipsecstats.ips_out_bundlesa, "bundled SA processed (output)");
    218 	STAT(ipsecstats.ips_spdcache_lookup, "SPD cache lookups");
    219 	STAT(ipsecstats.ips_spdcache_miss, "SPD cache misses");
    220 #undef STAT
    221 	printf("\n");
    222 
    223 	printf("IPsec ah:\n");
    224 #define	AHSTAT(x,fmt)	if ((x) || sflag <= 1) printf("\t%"PRIu64" ah " fmt "\n", x)
    225 	AHSTAT(ahstats.ahs_input,   "input packets processed");
    226 	AHSTAT(ahstats.ahs_output,  "output packets processed");
    227 	AHSTAT(ahstats.ahs_hdrops,  "headers too short");
    228 	AHSTAT(ahstats.ahs_nopf,    "headers for unsupported address family");
    229 	AHSTAT(ahstats.ahs_notdb,   "packets with no SA");
    230 	AHSTAT(ahstats.ahs_badkcr, "packets dropped by crypto returning NULL mbuf");
    231 	AHSTAT(ahstats.ahs_badauth, "packets with bad authentication");
    232 	AHSTAT(ahstats.ahs_noxform, "packets with no xform");
    233 	AHSTAT(ahstats.ahs_qfull, "packets dropped due to queue full");
    234 	AHSTAT(ahstats.ahs_wrap,  "packets dropped for replay counter wrap");
    235 	AHSTAT(ahstats.ahs_replay,  "packets dropped for possible replay");
    236 	AHSTAT(ahstats.ahs_badauthl,"packets dropped for bad authenticator length");
    237 	AHSTAT(ahstats.ahs_invalid, "packets with an invalid SA");
    238 	AHSTAT(ahstats.ahs_toobig,  "packets too big");
    239 	AHSTAT(ahstats.ahs_pdrops,  "packets blocked due to policy");
    240 	AHSTAT(ahstats.ahs_crypto,  "failed crypto requests");
    241 	AHSTAT(ahstats.ahs_tunnel,  "tunnel sanity check failures");
    242 
    243 	printf("\tah histogram:\n");
    244 	for (i = 0; i < AH_ALG_MAX; i++)
    245 		if (ahstats.ahs_hist[i])
    246 			printf("\t\tah packets with %s: %"PRIu64"\n"
    247 				, algname(i, aalgs, N(aalgs))
    248 				, ahstats.ahs_hist[i]
    249 			);
    250 	AHSTAT(ahstats.ahs_ibytes, "bytes received");
    251 	AHSTAT(ahstats.ahs_obytes, "bytes transmitted");
    252 #undef AHSTAT
    253 	printf("\n");
    254 
    255 	printf("IPsec esp:\n");
    256 #define	ESPSTAT(x,fmt) if ((x) || sflag <= 1) printf("\t%"PRIu64" esp " fmt "\n", x)
    257 	ESPSTAT(espstats.esps_input,	"input packets processed");
    258 	ESPSTAT(espstats.esps_output,	"output packets processed");
    259 	ESPSTAT(espstats.esps_hdrops,	"headers too short");
    260 	ESPSTAT(espstats.esps_nopf,  "headers for unsupported address family");
    261 	ESPSTAT(espstats.esps_notdb,	"packets with no SA");
    262 	ESPSTAT(espstats.esps_badkcr,	"packets dropped by crypto returning NULL mbuf");
    263 	ESPSTAT(espstats.esps_qfull,	"packets dropped due to queue full");
    264 	ESPSTAT(espstats.esps_noxform,	"packets with no xform");
    265 	ESPSTAT(espstats.esps_badilen,	"packets with bad ilen");
    266 	ESPSTAT(espstats.esps_badenc,	"packets with bad encryption");
    267 	ESPSTAT(espstats.esps_badauth,	"packets with bad authentication");
    268 	ESPSTAT(espstats.esps_wrap, "packets dropped for replay counter wrap");
    269 	ESPSTAT(espstats.esps_replay,	"packets dropped for possible replay");
    270 	ESPSTAT(espstats.esps_invalid,	"packets with an invalid SA");
    271 	ESPSTAT(espstats.esps_toobig,	"packets too big");
    272 	ESPSTAT(espstats.esps_pdrops,	"packets blocked due to policy");
    273 	ESPSTAT(espstats.esps_crypto,	"failed crypto requests");
    274 	ESPSTAT(espstats.esps_tunnel,	"tunnel sanity check failures");
    275 	printf("\tesp histogram:\n");
    276 	for (i = 0; i < ESP_ALG_MAX; i++)
    277 		if (espstats.esps_hist[i])
    278 			printf("\t\tesp packets with %s: %"PRIu64"\n"
    279 				, algname(i, espalgs, N(espalgs))
    280 				, espstats.esps_hist[i]
    281 			);
    282 	ESPSTAT(espstats.esps_ibytes, "bytes received");
    283 	ESPSTAT(espstats.esps_obytes, "bytes transmitted");
    284 #undef ESPSTAT
    285 	printf("IPsec ipip:\n");
    286 
    287 #define	IPIPSTAT(x,fmt) \
    288 	if ((x) || sflag <= 1) printf("\t%"PRIu64" ipip " fmt "\n", x)
    289 	IPIPSTAT(ipips.ipips_ipackets,	"total input packets");
    290 	IPIPSTAT(ipips.ipips_opackets,	"total output packets");
    291 	IPIPSTAT(ipips.ipips_hdrops,	"packets too short for header length");
    292 	IPIPSTAT(ipips.ipips_qfull,	"packets dropped due to queue full");
    293 	IPIPSTAT(ipips.ipips_pdrops,	"packets blocked due to policy");
    294 	IPIPSTAT(ipips.ipips_spoof,	"IP spoofing attempts");
    295 	IPIPSTAT(ipips.ipips_family,	"protocol family mismatched");
    296 	IPIPSTAT(ipips.ipips_unspec,	"missing tunnel-endpoint address");
    297 	IPIPSTAT(ipips.ipips_ibytes,	"input bytes received");
    298 	IPIPSTAT(ipips.ipips_obytes,	"output bytes processed");
    299 #undef IPIPSTAT
    300 
    301 	printf("IPsec ipcomp:\n");
    302 #define	IPCOMP(x,fmt) \
    303 	if ((x) || sflag <= 1) printf("\t%"PRIu64" ipcomp " fmt "\n", x)
    304 
    305 	IPCOMP(ipcs.ipcomps_hdrops,	"packets too short for header length");
    306 	IPCOMP(ipcs.ipcomps_nopf,	"protocol family not supported");
    307 	IPCOMP(ipcs.ipcomps_notdb,	"not db");
    308 	IPCOMP(ipcs.ipcomps_badkcr,	"packets dropped by crypto returning NULL mbuf");
    309 	IPCOMP(ipcs.ipcomps_qfull,	"queue full");
    310         IPCOMP(ipcs.ipcomps_noxform,	"no support for transform");
    311 	IPCOMP(ipcs.ipcomps_wrap,  "packets dropped for replay counter wrap");
    312 	IPCOMP(ipcs.ipcomps_input,	"input IPcomp packets");
    313 	IPCOMP(ipcs.ipcomps_output,	"output IPcomp packets");
    314 	IPCOMP(ipcs.ipcomps_invalid,	"specified an invalid TDB");
    315 	IPCOMP(ipcs.ipcomps_toobig,	"packets decompressed as too big");
    316 	IPCOMP(ipcs.ipcomps_minlen, "packets too short to be compressed");
    317 	IPCOMP(ipcs.ipcomps_uselesscomp, "packet for which compression was useless");
    318 	IPCOMP(ipcs.ipcomps_pdrops,	"packets blocked due to policy");
    319 	IPCOMP(ipcs.ipcomps_crypto,	"failed crypto requests");
    320 
    321 	printf("\tIPcomp histogram:\n");
    322 	for (i = 0; i < IPCOMP_ALG_MAX; i++)
    323 		if (ipcs.ipcomps_hist[i])
    324 			printf("\t\tIPcomp packets with %s: %"PRIu64"\n"
    325 				, algname(i, ipcompalgs, N(ipcompalgs))
    326 				, ipcs.ipcomps_hist[i]
    327 			);
    328 	IPCOMP(ipcs.ipcomps_ibytes,	"input bytes");
    329 	IPCOMP(ipcs.ipcomps_obytes,	"output bytes");
    330 #undef IPCOMP
    331 }
    332