usr.bin/netstat/ipsec.c

   1 /*      $KAME: ipsec.c,v 1.33 2003/07/25 09:54:32 itojun Exp $  */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-3-Clause
   5  *
   6  * Copyright (c) 2005 NTT Multimedia Communications Laboratories, Inc.
   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 /*-
  31  * Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
  32  * All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. Neither the name of the project nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  */
  58 /*-
  59  * Copyright (c) 1983, 1988, 1993
  60  *      The Regents of the University of California.  All rights reserved.
  61  *
  62  * Redistribution and use in source and binary forms, with or without
  63  * modification, are permitted provided that the following conditions
  64  * are met:
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in the
  69  *    documentation and/or other materials provided with the distribution.
  70  * 3. Neither the name of the University nor the names of its contributors
  71  *    may be used to endorse or promote products derived from this software
  72  *    without specific prior written permission.
  73  *
  74  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  75  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  76  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  77  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  78  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  79  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  80  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  81  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  82  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  83  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  84  * SUCH DAMAGE.
  85  */
  86
  87 #if 0
  88 #ifndef lint
  89 static char sccsid[] = "@(#)inet.c      8.5 (Berkeley) 5/24/95";
  90 #endif /* not lint */
  91 #endif
  92
  93 #include <sys/cdefs.h>
  94 __FBSDID("$FreeBSD$");
  95
  96 #include <sys/param.h>
  97 #include <sys/queue.h>
  98 #include <sys/socket.h>
  99 #include <sys/socketvar.h>
 100
 101 #include <netinet/in.h>
 102
 103 #ifdef IPSEC
 104 #include <netipsec/ipsec.h>
 105 #include <netipsec/ah_var.h>
 106 #include <netipsec/esp_var.h>
 107 #include <netipsec/ipcomp_var.h>
 108 #endif
 109
 110 #include <stdint.h>
 111 #include <stdio.h>
 112 #include <stdbool.h>
 113 #include <string.h>
 114 #include <unistd.h>
 115 #include <libxo/xo.h>
 116 #include "netstat.h"
 117
 118 #ifdef IPSEC
 119 struct val2str {
 120         int val;
 121         const char *str;
 122 };
 123
 124 static struct val2str ipsec_ahnames[] = {
 125         { SADB_AALG_NONE, "none", },
 126         { SADB_AALG_SHA1HMAC, "hmac-sha1", },
 127         { SADB_X_AALG_NULL, "null", },
 128         { SADB_X_AALG_SHA2_256, "hmac-sha2-256", },
 129         { SADB_X_AALG_SHA2_384, "hmac-sha2-384", },
 130         { SADB_X_AALG_SHA2_512, "hmac-sha2-512", },
 131         { SADB_X_AALG_AES_XCBC_MAC, "aes-xcbc-mac", },
 132         { SADB_X_AALG_TCP_MD5, "tcp-md5", },
 133         { SADB_X_AALG_AES128GMAC, "aes-gmac-128", },
 134         { SADB_X_AALG_AES192GMAC, "aes-gmac-192", },
 135         { SADB_X_AALG_AES256GMAC, "aes-gmac-256", },
 136         { -1, NULL },
 137 };
 138
 139 static struct val2str ipsec_espnames[] = {
 140         { SADB_EALG_NONE, "none", },
 141         { SADB_EALG_NULL, "null", },
 142         { SADB_X_EALG_AESCBC, "aes-cbc", },
 143         { SADB_X_EALG_AESCTR, "aes-ctr", },
 144         { SADB_X_EALG_AESGCM16, "aes-gcm-16", },
 145         { SADB_X_EALG_AESGMAC, "aes-gmac", },
 146         { -1, NULL },
 147 };
 148
 149 static struct val2str ipsec_compnames[] = {
 150         { SADB_X_CALG_NONE, "none", },
 151         { SADB_X_CALG_OUI, "oui", },
 152         { SADB_X_CALG_DEFLATE, "deflate", },
 153         { SADB_X_CALG_LZS, "lzs", },
 154         { -1, NULL },
 155 };
 156
 157 static void print_ipsecstats(const struct ipsecstat *ipsecstat);
 158
 159 static void
 160 print_ipsecstats(const struct ipsecstat *ipsecstat)
 161 {
 162         xo_open_container("ipsec-statistics");
 163
 164 #define p(f, m) if (ipsecstat->f || sflag <= 1) \
 165         xo_emit(m, (uintmax_t)ipsecstat->f, plural(ipsecstat->f))
 166 #define p2(f, m) if (ipsecstat->f || sflag <= 1) \
 167         xo_emit(m, (uintmax_t)ipsecstat->f, plurales(ipsecstat->f))
 168
 169         p(ips_in_polvio, "\t{:dropped-policy-violation/%ju} "
 170             "{N:/inbound packet%s violated process security policy}\n");
 171         p(ips_in_nomem, "\t{:dropped-no-memory/%ju} "
 172             "{N:/inbound packet%s failed due to insufficient memory}\n");
 173         p(ips_in_inval, "\t{:dropped-invalid/%ju} "
 174             "{N:/invalid inbound packet%s}\n");
 175         p(ips_out_polvio, "\t{:discarded-policy-violation/%ju} "
 176             "{N:/outbound packet%s violated process security policy}\n");
 177         p(ips_out_nosa, "\t{:discarded-no-sa/%ju} "
 178             "{N:/outbound packet%s with no SA available}\n");
 179         p(ips_out_nomem, "\t{:discarded-no-memory/%ju} "
 180             "{N:/outbound packet%s failed due to insufficient memory}\n");
 181         p(ips_out_noroute, "\t{:discarded-no-route/%ju} "
 182             "{N:/outbound packet%s with no route available}\n");
 183         p(ips_out_inval, "\t{:discarded-invalid/%ju} "
 184             "{N:/invalid outbound packet%s}\n");
 185         p(ips_out_bundlesa, "\t{:send-bundled-sa/%ju} "
 186             "{N:/outbound packet%s with bundled SAs}\n");
 187         p(ips_spdcache_hits, "\t{:spdcache-hits/%ju} "
 188             "{N:/spd cache hit%s}\n");
 189         p2(ips_spdcache_misses, "\t{:spdcache-misses/%ju} "
 190             "{N:/spd cache miss%s}\n");
 191         p(ips_clcopied, "\t{:clusters-copied-during-clone/%ju} "
 192             "{N:/cluster%s copied during clone}\n");
 193         p(ips_mbinserted, "\t{:mbufs-inserted/%ju} "
 194             "{N:/mbuf%s inserted during makespace}\n");
 195 #undef p2
 196 #undef p
 197         xo_close_container("ipsec-statistics");
 198 }
 199
 200 void
 201 ipsec_stats(u_long off, const char *name, int af1 __unused, int proto __unused)
 202 {
 203         struct ipsecstat ipsecstat;
 204
 205         if (strcmp(name, "ipsec6") == 0) {
 206                 if (fetch_stats("net.inet6.ipsec6.ipsecstats", off,&ipsecstat,
 207                                 sizeof(ipsecstat), kread_counters) != 0)
 208                         return;
 209         } else {
 210                 if (fetch_stats("net.inet.ipsec.ipsecstats", off, &ipsecstat,
 211                                 sizeof(ipsecstat), kread_counters) != 0)
 212                         return;
 213         }
 214
 215         xo_emit("{T:/%s}:\n", name);
 216
 217         print_ipsecstats(&ipsecstat);
 218 }
 219
 220
 221 static void print_ahstats(const struct ahstat *ahstat);
 222 static void print_espstats(const struct espstat *espstat);
 223 static void print_ipcompstats(const struct ipcompstat *ipcompstat);
 224
 225 /*
 226  * Dump IPSEC statistics structure.
 227  */
 228 static void
 229 ipsec_hist_new(const uint64_t *hist, size_t histmax,
 230     const struct val2str *name, const char *title, const char *cname)
 231 {
 232         int first;
 233         size_t proto;
 234         const struct val2str *p;
 235
 236         first = 1;
 237         for (proto = 0; proto < histmax; proto++) {
 238                 if (hist[proto] <= 0)
 239                         continue;
 240                 if (first) {
 241                         xo_open_list(cname);
 242                         xo_emit("\t{T:/%s histogram}:\n", title);
 243                         first = 0;
 244                 }
 245                 xo_open_instance(cname);
 246                 for (p = name; p && p->str; p++) {
 247                         if (p->val == (int)proto)
 248                                 break;
 249                 }
 250                 if (p && p->str) {
 251                         xo_emit("\t\t{k:name}: {:count/%ju}\n", p->str,
 252                             (uintmax_t)hist[proto]);
 253                 } else {
 254                         xo_emit("\t\t#{k:name/%lu}: {:count/%ju}\n",
 255                             (unsigned long)proto, (uintmax_t)hist[proto]);
 256                 }
 257                 xo_close_instance(cname);
 258         }
 259         if (!first)
 260                 xo_close_list(cname);
 261 }
 262
 263 static void
 264 print_ahstats(const struct ahstat *ahstat)
 265 {
 266         xo_open_container("ah-statictics");
 267
 268 #define p(f, n, m) if (ahstat->f || sflag <= 1) \
 269         xo_emit("\t{:" n "/%ju} {N:/" m "}\n",  \
 270             (uintmax_t)ahstat->f, plural(ahstat->f))
 271 #define hist(f, n, t, c) \
 272         ipsec_hist_new((f), sizeof(f)/sizeof(f[0]), (n), (t), (c))
 273
 274         p(ahs_hdrops, "dropped-short-header",
 275             "packet%s shorter than header shows");
 276         p(ahs_nopf, "dropped-bad-protocol",
 277             "packet%s dropped; protocol family not supported");
 278         p(ahs_notdb, "dropped-no-tdb", "packet%s dropped; no TDB");
 279         p(ahs_badkcr, "dropped-bad-kcr", "packet%s dropped; bad KCR");
 280         p(ahs_qfull, "dropped-queue-full", "packet%s dropped; queue full");
 281         p(ahs_noxform, "dropped-no-transform",
 282             "packet%s dropped; no transform");
 283         p(ahs_wrap, "replay-counter-wraps", "replay counter wrap%s");
 284         p(ahs_badauth, "dropped-bad-auth",
 285             "packet%s dropped; bad authentication detected");
 286         p(ahs_badauthl, "dropped-bad-auth-level",
 287             "packet%s dropped; bad authentication length");
 288         p(ahs_replay, "possile-replay-detected",
 289             "possible replay packet%s detected");
 290         p(ahs_input, "received-packets", "packet%s in");
 291         p(ahs_output, "send-packets", "packet%s out");
 292         p(ahs_invalid, "dropped-bad-tdb", "packet%s dropped; invalid TDB");
 293         p(ahs_ibytes, "received-bytes", "byte%s in");
 294         p(ahs_obytes, "send-bytes", "byte%s out");
 295         p(ahs_toobig, "dropped-too-large",
 296             "packet%s dropped; larger than IP_MAXPACKET");
 297         p(ahs_pdrops, "dropped-policy-violation",
 298             "packet%s blocked due to policy");
 299         p(ahs_crypto, "crypto-failures", "crypto processing failure%s");
 300         p(ahs_tunnel, "tunnel-failures", "tunnel sanity check failure%s");
 301         hist(ahstat->ahs_hist, ipsec_ahnames,
 302             "AH output", "ah-output-histogram");
 303
 304 #undef p
 305 #undef hist
 306         xo_close_container("ah-statictics");
 307 }
 308
 309 void
 310 ah_stats(u_long off, const char *name, int family __unused, int proto __unused)
 311 {
 312         struct ahstat ahstat;
 313
 314         if (fetch_stats("net.inet.ah.stats", off, &ahstat,
 315             sizeof(ahstat), kread_counters) != 0)
 316                 return;
 317
 318         xo_emit("{T:/%s}:\n", name);
 319
 320         print_ahstats(&ahstat);
 321 }
 322
 323 static void
 324 print_espstats(const struct espstat *espstat)
 325 {
 326         xo_open_container("esp-statictics");
 327 #define p(f, n, m) if (espstat->f || sflag <= 1)        \
 328         xo_emit("\t{:" n "/%ju} {N:/" m "}\n",          \
 329             (uintmax_t)espstat->f, plural(espstat->f))
 330 #define hist(f, n, t, c) \
 331         ipsec_hist_new((f), sizeof(f)/sizeof(f[0]), (n), (t), (c));
 332
 333         p(esps_hdrops, "dropped-short-header",
 334             "packet%s shorter than header shows");
 335         p(esps_nopf, "dropped-bad-protocol",
 336             "packet%s dropped; protocol family not supported");
 337         p(esps_notdb, "dropped-no-tdb", "packet%s dropped; no TDB");
 338         p(esps_badkcr, "dropped-bad-kcr", "packet%s dropped; bad KCR");
 339         p(esps_qfull, "dropped-queue-full", "packet%s dropped; queue full");
 340         p(esps_noxform, "dropped-no-transform",
 341             "packet%s dropped; no transform");
 342         p(esps_badilen, "dropped-bad-length", "packet%s dropped; bad ilen");
 343         p(esps_wrap, "replay-counter-wraps", "replay counter wrap%s");
 344         p(esps_badenc, "dropped-bad-crypto",
 345             "packet%s dropped; bad encryption detected");
 346         p(esps_badauth, "dropped-bad-auth",
 347             "packet%s dropped; bad authentication detected");
 348         p(esps_replay, "possible-replay-detected",
 349             "possible replay packet%s detected");
 350         p(esps_input, "received-packets", "packet%s in");
 351         p(esps_output, "sent-packets", "packet%s out");
 352         p(esps_invalid, "dropped-bad-tdb", "packet%s dropped; invalid TDB");
 353         p(esps_ibytes, "receieve-bytes", "byte%s in");
 354         p(esps_obytes, "sent-bytes", "byte%s out");
 355         p(esps_toobig, "dropped-too-large",
 356             "packet%s dropped; larger than IP_MAXPACKET");
 357         p(esps_pdrops, "dropped-policy-violation",
 358             "packet%s blocked due to policy");
 359         p(esps_crypto, "crypto-failures", "crypto processing failure%s");
 360         p(esps_tunnel, "tunnel-failures", "tunnel sanity check failure%s");
 361         hist(espstat->esps_hist, ipsec_espnames,
 362             "ESP output", "esp-output-histogram");
 363
 364 #undef p
 365 #undef hist
 366         xo_close_container("esp-statictics");
 367 }
 368
 369 void
 370 esp_stats(u_long off, const char *name, int family __unused, int proto __unused)
 371 {
 372         struct espstat espstat;
 373
 374         if (fetch_stats("net.inet.esp.stats", off, &espstat,
 375             sizeof(espstat), kread_counters) != 0)
 376                 return;
 377
 378         xo_emit("{T:/%s}:\n", name);
 379
 380         print_espstats(&espstat);
 381 }
 382
 383 static void
 384 print_ipcompstats(const struct ipcompstat *ipcompstat)
 385 {
 386         xo_open_container("ipcomp-statictics");
 387
 388 #define p(f, n, m) if (ipcompstat->f || sflag <= 1)     \
 389         xo_emit("\t{:" n "/%ju} {N:/" m "}\n",          \
 390             (uintmax_t)ipcompstat->f, plural(ipcompstat->f))
 391 #define hist(f, n, t, c) \
 392         ipsec_hist_new((f), sizeof(f)/sizeof(f[0]), (n), (t), (c));
 393
 394         p(ipcomps_hdrops, "dropped-short-header",
 395             "packet%s shorter than header shows");
 396         p(ipcomps_nopf, "dropped-bad-protocol",
 397             "packet%s dropped; protocol family not supported");
 398         p(ipcomps_notdb, "dropped-no-tdb", "packet%s dropped; no TDB");
 399         p(ipcomps_badkcr, "dropped-bad-kcr", "packet%s dropped; bad KCR");
 400         p(ipcomps_qfull, "dropped-queue-full", "packet%s dropped; queue full");
 401         p(ipcomps_noxform, "dropped-no-transform",
 402             "packet%s dropped; no transform");
 403         p(ipcomps_wrap, "replay-counter-wraps", "replay counter wrap%s");
 404         p(ipcomps_input, "receieve-packets", "packet%s in");
 405         p(ipcomps_output, "sent-packets", "packet%s out");
 406         p(ipcomps_invalid, "dropped-bad-tdb", "packet%s dropped; invalid TDB");
 407         p(ipcomps_ibytes, "receieved-bytes", "byte%s in");
 408         p(ipcomps_obytes, "sent-bytes", "byte%s out");
 409         p(ipcomps_toobig, "dropped-too-large",
 410             "packet%s dropped; larger than IP_MAXPACKET");
 411         p(ipcomps_pdrops, "dropped-policy-violation",
 412             "packet%s blocked due to policy");
 413         p(ipcomps_crypto, "crypto-failure", "crypto processing failure%s");
 414         hist(ipcompstat->ipcomps_hist, ipsec_compnames,
 415             "COMP output", "comp-output-histogram");
 416         p(ipcomps_threshold, "sent-uncompressed-small-packets",
 417             "packet%s sent uncompressed; size < compr. algo. threshold");
 418         p(ipcomps_uncompr, "sent-uncompressed-useless-packets",
 419             "packet%s sent uncompressed; compression was useless");
 420
 421 #undef p
 422 #undef hist
 423         xo_close_container("ipcomp-statictics");
 424 }
 425
 426 void
 427 ipcomp_stats(u_long off, const char *name, int family __unused,
 428     int proto __unused)
 429 {
 430         struct ipcompstat ipcompstat;
 431
 432         if (fetch_stats("net.inet.ipcomp.stats", off, &ipcompstat,
 433             sizeof(ipcompstat), kread_counters) != 0)
 434                 return;
 435
 436         xo_emit("{T:/%s}:\n", name);
 437
 438         print_ipcompstats(&ipcompstat);
 439 }
 440
 441 #endif /*IPSEC*/