2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 static const char copyright[] =
35 "@(#) Copyright (c) 1980, 1993\n\
36 The Regents of the University of California. All rights reserved.\n";
40 static char sccsid[] = "From: @(#)swapon.c 8.1 (Berkeley) 6/5/93";
43 #include <sys/cdefs.h>
44 __FBSDID("$FreeBSD$");
46 #include <sys/param.h>
47 #include <sys/capsicum.h>
49 #include <sys/socket.h>
50 #include <sys/sysctl.h>
53 #include <capsicum_helpers.h>
68 #include <arpa/inet.h>
71 #include <net/if_dl.h>
72 #include <net/route.h>
74 #include <netinet/in.h>
75 #include <netinet/netdump/netdump.h>
78 #include <openssl/err.h>
79 #include <openssl/pem.h>
80 #include <openssl/rsa.h>
89 "usage: dumpon [-i index] [-r] [-v] [-k <pubkey>] [-Zz] <device>\n"
90 " dumpon [-i index] [-r] [-v] [-k <pubkey>] [-Zz]\n"
91 " [-g <gateway>] -s <server> -c <client> <iface>\n"
98 * Look for a default route on the specified interface.
101 find_gateway(const char *ifname)
103 struct ifaddrs *ifa, *ifap;
104 struct rt_msghdr *rtm;
106 struct sockaddr_dl *sdl;
107 struct sockaddr_in *dst, *mask, *gw;
108 char *buf, *next, *ret;
110 int error, i, ifindex, mib[7];
112 /* First look up the interface index. */
113 if (getifaddrs(&ifap) != 0)
114 err(EX_OSERR, "getifaddrs");
115 for (ifa = ifap; ifa != NULL; ifa = ifa->ifa_next) {
116 if (ifa->ifa_addr->sa_family != AF_LINK)
118 if (strcmp(ifa->ifa_name, ifname) == 0) {
119 sdl = (struct sockaddr_dl *)(void *)ifa->ifa_addr;
120 ifindex = sdl->sdl_index;
125 errx(1, "couldn't find interface index for '%s'", ifname);
128 /* Now get the IPv4 routing table. */
133 mib[4] = NET_RT_DUMP;
135 mib[6] = -1; /* FIB */
138 if (sysctl(mib, nitems(mib), NULL, &sz, NULL, 0) != 0)
139 err(EX_OSERR, "sysctl(NET_RT_DUMP)");
141 error = sysctl(mib, nitems(mib), buf, &sz, NULL, 0);
145 err(EX_OSERR, "sysctl(NET_RT_DUMP)");
150 for (next = buf; next < buf + sz; next += rtm->rtm_msglen) {
151 rtm = (struct rt_msghdr *)(void *)next;
152 if (rtm->rtm_version != RTM_VERSION)
154 if ((rtm->rtm_flags & RTF_GATEWAY) == 0 ||
155 rtm->rtm_index != ifindex)
158 dst = gw = mask = NULL;
159 sa = (struct sockaddr *)(rtm + 1);
160 for (i = 0; i < RTAX_MAX; i++) {
161 if ((rtm->rtm_addrs & (1 << i)) != 0) {
174 sa = (struct sockaddr *)((char *)sa + SA_SIZE(sa));
177 if (dst->sin_addr.s_addr == INADDR_ANY &&
178 mask->sin_addr.s_addr == 0) {
179 ret = inet_ntoa(gw->sin_addr);
188 check_size(int fd, const char *fn)
190 int name[] = { CTL_HW, HW_PHYSMEM };
191 size_t namelen = nitems(name);
192 unsigned long physmem;
197 len = sizeof(minidump);
198 if (sysctlbyname("debug.minidump", &minidump, &len, NULL, 0) == 0 &&
201 len = sizeof(physmem);
202 if (sysctl(name, namelen, &physmem, &len, NULL, 0) != 0)
203 err(EX_OSERR, "can't get memory size");
204 if (ioctl(fd, DIOCGMEDIASIZE, &mediasize) != 0)
205 err(EX_OSERR, "%s: can't get size", fn);
206 if ((uintmax_t)mediasize < (uintmax_t)physmem)
207 errx(EX_IOERR, "%s is smaller than physical memory", fn);
212 genkey(const char *pubkeyfile, struct diocskerneldump_arg *kdap)
217 assert(pubkeyfile != NULL);
218 assert(kdap != NULL);
223 fp = fopen(pubkeyfile, "r");
225 err(1, "Unable to open %s", pubkeyfile);
227 if (caph_enter() < 0)
228 err(1, "Unable to enter capability mode");
231 if (pubkey == NULL) {
232 errx(1, "Unable to allocate an RSA structure: %s",
233 ERR_error_string(ERR_get_error(), NULL));
236 pubkey = PEM_read_RSA_PUBKEY(fp, &pubkey, NULL, NULL);
240 errx(1, "Unable to read data from %s.", pubkeyfile);
243 * RSA keys under ~1024 bits are trivially factorable (2018). OpenSSL
244 * provides an API for RSA keys to estimate the symmetric-cipher
245 * "equivalent" bits of security (defined in NIST SP800-57), which as
246 * of this writing equates a 2048-bit RSA key to 112 symmetric cipher
249 * Use this API as a seatbelt to avoid suggesting to users that their
250 * privacy is protected by encryption when the key size is insufficient
251 * to prevent compromise via factoring.
253 * Future work: Sanity check for weak 'e', and sanity check for absence
254 * of 'd' (i.e., the supplied key is a public key rather than a full
257 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
258 if (RSA_security_bits(pubkey) < 112)
260 if (RSA_size(pubkey) * 8 < 2048)
262 errx(1, "Small RSA keys (you provided: %db) can be "
263 "factored cheaply. Please generate a larger key.",
264 RSA_size(pubkey) * 8);
266 kdap->kda_encryptedkeysize = RSA_size(pubkey);
267 if (kdap->kda_encryptedkeysize > KERNELDUMP_ENCKEY_MAX_SIZE) {
268 errx(1, "Public key has to be at most %db long.",
269 8 * KERNELDUMP_ENCKEY_MAX_SIZE);
272 kdap->kda_encryptedkey = calloc(1, kdap->kda_encryptedkeysize);
273 if (kdap->kda_encryptedkey == NULL)
274 err(1, "Unable to allocate encrypted key");
277 * If no cipher was specified, choose a reasonable default.
279 if (kdap->kda_encryption == KERNELDUMP_ENC_NONE)
280 kdap->kda_encryption = KERNELDUMP_ENC_CHACHA20;
281 else if (kdap->kda_encryption == KERNELDUMP_ENC_AES_256_CBC &&
282 kdap->kda_compression != KERNELDUMP_COMP_NONE)
283 errx(EX_USAGE, "Unpadded AES256-CBC mode cannot be used "
284 "with compression.");
286 arc4random_buf(kdap->kda_key, sizeof(kdap->kda_key));
287 if (RSA_public_encrypt(sizeof(kdap->kda_key), kdap->kda_key,
288 kdap->kda_encryptedkey, pubkey,
289 RSA_PKCS1_PADDING) != (int)kdap->kda_encryptedkeysize) {
290 errx(1, "Unable to encrypt the one-time key.");
301 char dumpdev[PATH_MAX];
302 struct diocskerneldump_arg ndconf;
304 const char *sysctlname = "kern.shutdown.dumpdevname";
307 len = sizeof(dumpdev);
308 if (sysctlbyname(sysctlname, &dumpdev, &len, NULL, 0) != 0) {
309 if (errno == ENOMEM) {
310 err(EX_OSERR, "Kernel returned too large of a buffer for '%s'\n",
313 err(EX_OSERR, "Sysctl get '%s'\n", sysctlname);
316 if (strlen(dumpdev) == 0)
317 (void)strlcpy(dumpdev, _PATH_DEVNULL, sizeof(dumpdev));
323 printf("kernel dumps on priority: device\n");
326 while ((dd = strsep(&ctx, ",")) != NULL)
327 printf("%u: %s\n", idx++, dd);
329 printf("%s\n", dumpdev);
331 /* If netdump is enabled, print the configuration parameters. */
333 fd = open(_PATH_NETDUMP, O_RDONLY);
336 err(EX_OSERR, "opening %s", _PATH_NETDUMP);
339 if (ioctl(fd, DIOCGKERNELDUMP, &ndconf) != 0) {
341 err(EX_OSERR, "ioctl(DIOCGKERNELDUMP)");
346 printf("server address: %s\n",
347 inet_ntop(ndconf.kda_af, &ndconf.kda_server, ip,
349 printf("client address: %s\n",
350 inet_ntop(ndconf.kda_af, &ndconf.kda_client, ip,
352 printf("gateway address: %s\n",
353 inet_ntop(ndconf.kda_af, &ndconf.kda_gateway, ip,
360 opendumpdev(const char *arg, char *dumpdev)
364 if (strncmp(arg, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
365 strlcpy(dumpdev, arg, PATH_MAX);
367 i = snprintf(dumpdev, PATH_MAX, "%s%s", _PATH_DEV, arg);
369 err(EX_OSERR, "%s", arg);
371 errc(EX_DATAERR, EINVAL, "%s", arg);
374 fd = open(dumpdev, O_RDONLY);
376 err(EX_OSFILE, "%s", dumpdev);
381 main(int argc, char *argv[])
383 char dumpdev[PATH_MAX];
384 struct diocskerneldump_arg ndconf, *kdap;
385 struct addrinfo hints, *res;
386 const char *dev, *pubkeyfile, *server, *client, *gateway;
387 int ch, error, fd, cipher;
388 bool gzip, list, netdump, zstd, insert, rflag;
391 gzip = list = netdump = zstd = insert = rflag = false;
394 server = client = gateway = NULL;
395 ins_idx = KDA_APPEND;
396 cipher = KERNELDUMP_ENC_NONE;
398 while ((ch = getopt(argc, argv, "C:c:g:i:k:lrs:vZz")) != -1)
401 if (strcasecmp(optarg, "chacha") == 0 ||
402 strcasecmp(optarg, "chacha20") == 0)
403 cipher = KERNELDUMP_ENC_CHACHA20;
404 else if (strcasecmp(optarg, "aes-cbc") == 0 ||
405 strcasecmp(optarg, "aes256-cbc") == 0)
406 cipher = KERNELDUMP_ENC_AES_256_CBC;
408 errx(EX_USAGE, "Unrecognized cipher algorithm "
422 if (i < 0 || i >= KDA_APPEND - 1)
424 "-i index must be between zero and %d.",
425 (int)KDA_APPEND - 2);
456 errx(EX_USAGE, "The -z and -Z options are mutually exclusive.");
459 errx(EX_USAGE, "The -i and -r options are mutually exclusive.");
473 if (cipher != KERNELDUMP_ENC_NONE && pubkeyfile == NULL)
474 errx(EX_USAGE, "-C option requires a public key file.");
476 if (pubkeyfile != NULL)
477 errx(EX_UNAVAILABLE,"Unable to use the public key."
478 " Recompile dumpon with OpenSSL support.");
481 if (server != NULL && client != NULL) {
484 } else if (server == NULL && client == NULL && argc > 0) {
485 if (strcmp(argv[0], "off") == 0) {
494 fd = opendumpdev(dev, dumpdev);
495 if (!netdump && !gzip && !zstd && !rflag)
496 check_size(fd, dumpdev);
499 bzero(kdap, sizeof(*kdap));
502 kdap->kda_index = KDA_REMOVE;
504 kdap->kda_index = ins_idx;
506 kdap->kda_compression = KERNELDUMP_COMP_NONE;
508 kdap->kda_compression = KERNELDUMP_COMP_ZSTD;
510 kdap->kda_compression = KERNELDUMP_COMP_GZIP;
513 memset(&hints, 0, sizeof(hints));
514 hints.ai_family = AF_INET;
515 hints.ai_protocol = IPPROTO_UDP;
517 error = getaddrinfo(server, NULL, &hints, &res);
519 err(1, "%s", gai_strerror(error));
521 errx(1, "failed to resolve '%s'", server);
523 ((struct sockaddr_in *)(void *)res->ai_addr)->sin_addr);
526 if (strlcpy(ndconf.kda_iface, argv[0],
527 sizeof(ndconf.kda_iface)) >= sizeof(ndconf.kda_iface))
528 errx(EX_USAGE, "invalid interface name '%s'", argv[0]);
529 if (inet_aton(server, &ndconf.kda_server.in4) == 0)
530 errx(EX_USAGE, "invalid server address '%s'", server);
531 if (inet_aton(client, &ndconf.kda_client.in4) == 0)
532 errx(EX_USAGE, "invalid client address '%s'", client);
534 if (gateway == NULL) {
535 gateway = find_gateway(argv[0]);
536 if (gateway == NULL) {
539 "failed to look up gateway for %s\n",
544 if (inet_aton(gateway, &ndconf.kda_gateway.in4) == 0)
545 errx(EX_USAGE, "invalid gateway address '%s'", gateway);
546 ndconf.kda_af = AF_INET;
550 if (pubkeyfile != NULL) {
551 kdap->kda_encryption = cipher;
552 genkey(pubkeyfile, kdap);
555 error = ioctl(fd, DIOCSKERNELDUMP, kdap);
558 explicit_bzero(kdap->kda_encryptedkey, kdap->kda_encryptedkeysize);
559 free(kdap->kda_encryptedkey);
560 explicit_bzero(kdap, sizeof(*kdap));
564 * Be slightly less user-hostile for some common
565 * errors, especially as users don't have any great
566 * discoverability into which NICs support netdump.
569 errx(EX_OSERR, "Unable to configure netdump "
570 "because the interface's link is down.");
571 else if (error == ENODEV)
572 errx(EX_OSERR, "Unable to configure netdump "
573 "because the interface driver does not yet "
576 errc(EX_OSERR, error, "ioctl(DIOCSKERNELDUMP)");