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 [-v] [-k <pubkey>] [-Zz] <device>\n"
90 " dumpon [-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) {
208 printf("%s is smaller than physical memory\n", fn);
215 genkey(const char *pubkeyfile, struct diocskerneldump_arg *kdap)
220 assert(pubkeyfile != NULL);
221 assert(kdap != NULL);
226 fp = fopen(pubkeyfile, "r");
228 err(1, "Unable to open %s", pubkeyfile);
230 if (caph_enter() < 0)
231 err(1, "Unable to enter capability mode");
234 if (pubkey == NULL) {
235 errx(1, "Unable to allocate an RSA structure: %s",
236 ERR_error_string(ERR_get_error(), NULL));
239 pubkey = PEM_read_RSA_PUBKEY(fp, &pubkey, NULL, NULL);
243 errx(1, "Unable to read data from %s.", pubkeyfile);
246 * RSA keys under ~1024 bits are trivially factorable (2018). OpenSSL
247 * provides an API for RSA keys to estimate the symmetric-cipher
248 * "equivalent" bits of security (defined in NIST SP800-57), which as
249 * of this writing equates a 2048-bit RSA key to 112 symmetric cipher
252 * Use this API as a seatbelt to avoid suggesting to users that their
253 * privacy is protected by encryption when the key size is insufficient
254 * to prevent compromise via factoring.
256 * Future work: Sanity check for weak 'e', and sanity check for absence
257 * of 'd' (i.e., the supplied key is a public key rather than a full
260 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
261 if (RSA_security_bits(pubkey) < 112)
263 if (RSA_size(pubkey) * 8 < 2048)
265 errx(1, "Small RSA keys (you provided: %db) can be "
266 "factored cheaply. Please generate a larger key.",
267 RSA_size(pubkey) * 8);
269 kdap->kda_encryptedkeysize = RSA_size(pubkey);
270 if (kdap->kda_encryptedkeysize > KERNELDUMP_ENCKEY_MAX_SIZE) {
271 errx(1, "Public key has to be at most %db long.",
272 8 * KERNELDUMP_ENCKEY_MAX_SIZE);
275 kdap->kda_encryptedkey = calloc(1, kdap->kda_encryptedkeysize);
276 if (kdap->kda_encryptedkey == NULL)
277 err(1, "Unable to allocate encrypted key");
279 kdap->kda_encryption = KERNELDUMP_ENC_AES_256_CBC;
280 arc4random_buf(kdap->kda_key, sizeof(kdap->kda_key));
281 if (RSA_public_encrypt(sizeof(kdap->kda_key), kdap->kda_key,
282 kdap->kda_encryptedkey, pubkey,
283 RSA_PKCS1_PADDING) != (int)kdap->kda_encryptedkeysize) {
284 errx(1, "Unable to encrypt the one-time key.");
293 char dumpdev[PATH_MAX];
294 struct netdump_conf ndconf;
296 const char *sysctlname = "kern.shutdown.dumpdevname";
299 len = sizeof(dumpdev);
300 if (sysctlbyname(sysctlname, &dumpdev, &len, NULL, 0) != 0) {
301 if (errno == ENOMEM) {
302 err(EX_OSERR, "Kernel returned too large of a buffer for '%s'\n",
305 err(EX_OSERR, "Sysctl get '%s'\n", sysctlname);
308 if (strlen(dumpdev) == 0)
309 (void)strlcpy(dumpdev, _PATH_DEVNULL, sizeof(dumpdev));
312 printf("kernel dumps on ");
313 printf("%s\n", dumpdev);
315 /* If netdump is enabled, print the configuration parameters. */
317 fd = open(_PATH_NETDUMP, O_RDONLY);
320 err(EX_OSERR, "opening %s", _PATH_NETDUMP);
323 if (ioctl(fd, NETDUMPGCONF, &ndconf) != 0) {
325 err(EX_OSERR, "ioctl(NETDUMPGCONF)");
330 printf("server address: %s\n", inet_ntoa(ndconf.ndc_server));
331 printf("client address: %s\n", inet_ntoa(ndconf.ndc_client));
332 printf("gateway address: %s\n", inet_ntoa(ndconf.ndc_gateway));
338 opendumpdev(const char *arg, char *dumpdev)
342 if (strncmp(arg, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
343 strlcpy(dumpdev, arg, PATH_MAX);
345 i = snprintf(dumpdev, PATH_MAX, "%s%s", _PATH_DEV, arg);
347 err(EX_OSERR, "%s", arg);
349 errc(EX_DATAERR, EINVAL, "%s", arg);
352 fd = open(dumpdev, O_RDONLY);
354 err(EX_OSFILE, "%s", dumpdev);
359 main(int argc, char *argv[])
361 char dumpdev[PATH_MAX];
362 struct diocskerneldump_arg _kda, *kdap;
363 struct netdump_conf ndconf;
364 struct addrinfo hints, *res;
365 const char *dev, *pubkeyfile, *server, *client, *gateway;
367 bool enable, gzip, list, netdump, zstd;
369 gzip = list = netdump = zstd = false;
372 server = client = gateway = NULL;
374 while ((ch = getopt(argc, argv, "c:g:k:ls:vZz")) != -1)
405 errx(EX_USAGE, "The -z and -Z options are mutually exclusive.");
419 if (pubkeyfile != NULL)
420 errx(EX_UNAVAILABLE,"Unable to use the public key."
421 " Recompile dumpon with OpenSSL support.");
424 if (server != NULL && client != NULL) {
428 kdap = &ndconf.ndc_kda;
429 } else if (server == NULL && client == NULL && argc > 0) {
430 enable = strcmp(argv[0], "off") != 0;
431 dev = enable ? argv[0] : _PATH_DEVNULL;
437 fd = opendumpdev(dev, dumpdev);
438 if (!netdump && !gzip)
439 check_size(fd, dumpdev);
441 bzero(kdap, sizeof(*kdap));
442 kdap->kda_enable = 0;
443 if (ioctl(fd, DIOCSKERNELDUMP, kdap) != 0)
444 err(EX_OSERR, "ioctl(DIOCSKERNELDUMP)");
448 explicit_bzero(kdap, sizeof(*kdap));
449 kdap->kda_enable = 1;
450 kdap->kda_compression = KERNELDUMP_COMP_NONE;
452 kdap->kda_compression = KERNELDUMP_COMP_ZSTD;
454 kdap->kda_compression = KERNELDUMP_COMP_GZIP;
457 memset(&hints, 0, sizeof(hints));
458 hints.ai_family = AF_INET;
459 hints.ai_protocol = IPPROTO_UDP;
461 error = getaddrinfo(server, NULL, &hints, &res);
463 err(1, "%s", gai_strerror(error));
465 errx(1, "failed to resolve '%s'", server);
467 ((struct sockaddr_in *)(void *)res->ai_addr)->sin_addr);
470 if (strlcpy(ndconf.ndc_iface, argv[0],
471 sizeof(ndconf.ndc_iface)) >= sizeof(ndconf.ndc_iface))
472 errx(EX_USAGE, "invalid interface name '%s'", argv[0]);
473 if (inet_aton(server, &ndconf.ndc_server) == 0)
474 errx(EX_USAGE, "invalid server address '%s'", server);
475 if (inet_aton(client, &ndconf.ndc_client) == 0)
476 errx(EX_USAGE, "invalid client address '%s'", client);
478 if (gateway == NULL) {
479 gateway = find_gateway(argv[0]);
480 if (gateway == NULL) {
483 "failed to look up gateway for %s\n",
488 if (inet_aton(gateway, &ndconf.ndc_gateway) == 0)
489 errx(EX_USAGE, "invalid gateway address '%s'", gateway);
492 if (pubkeyfile != NULL)
493 genkey(pubkeyfile, kdap);
495 error = ioctl(fd, NETDUMPSCONF, &ndconf);
498 explicit_bzero(kdap->kda_encryptedkey,
499 kdap->kda_encryptedkeysize);
500 free(kdap->kda_encryptedkey);
501 explicit_bzero(kdap, sizeof(*kdap));
503 errc(EX_OSERR, error, "ioctl(NETDUMPSCONF)");
506 if (pubkeyfile != NULL)
507 genkey(pubkeyfile, kdap);
509 error = ioctl(fd, DIOCSKERNELDUMP, kdap);
512 explicit_bzero(kdap->kda_encryptedkey,
513 kdap->kda_encryptedkeysize);
514 free(kdap->kda_encryptedkey);
515 explicit_bzero(kdap, sizeof(*kdap));
517 errc(EX_OSERR, error, "ioctl(DIOCSKERNELDUMP)");
520 printf("kernel dumps on %s\n", dumpdev);