1995-05-12 19:10:09 +00:00
|
|
|
.\" Copyright (c) 1980, 1991, 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
2017-02-28 23:42:47 +00:00
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
1995-05-12 19:10:09 +00:00
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" From: @(#)swapon.8 8.1 (Berkeley) 6/5/93
|
|
|
|
.\"
|
2020-04-23 18:04:52 +00:00
|
|
|
.Dd April 23, 2020
|
1995-05-12 19:10:09 +00:00
|
|
|
.Dt DUMPON 8
|
2001-07-10 11:04:34 +00:00
|
|
|
.Os
|
1995-05-12 19:10:09 +00:00
|
|
|
.Sh NAME
|
|
|
|
.Nm dumpon
|
|
|
|
.Nd "specify a device for crash dumps"
|
|
|
|
.Sh SYNOPSIS
|
2000-11-20 16:52:27 +00:00
|
|
|
.Nm
|
2019-05-06 18:24:07 +00:00
|
|
|
.Op Fl i Ar index
|
|
|
|
.Op Fl r
|
1995-05-12 19:10:09 +00:00
|
|
|
.Op Fl v
|
2019-05-23 20:12:24 +00:00
|
|
|
.Op Fl C Ar cipher
|
2018-05-06 00:42:30 +00:00
|
|
|
.Op Fl k Ar pubkey
|
|
|
|
.Op Fl Z
|
2017-10-25 00:51:00 +00:00
|
|
|
.Op Fl z
|
2018-05-06 00:42:30 +00:00
|
|
|
.Ar device
|
|
|
|
.Nm
|
2019-05-06 18:24:07 +00:00
|
|
|
.Op Fl i Ar index
|
|
|
|
.Op Fl r
|
2018-05-06 00:42:30 +00:00
|
|
|
.Op Fl v
|
2019-05-23 20:12:24 +00:00
|
|
|
.Op Fl C Ar cipher
|
2018-05-06 00:42:30 +00:00
|
|
|
.Op Fl k Ar pubkey
|
2018-02-13 19:28:02 +00:00
|
|
|
.Op Fl Z
|
2018-05-06 00:42:30 +00:00
|
|
|
.Op Fl z
|
2018-11-18 01:58:48 +00:00
|
|
|
.Op Fl g Ar gateway
|
2018-05-06 00:42:30 +00:00
|
|
|
.Fl s Ar server
|
|
|
|
.Fl c Ar client
|
|
|
|
.Ar iface
|
2000-11-20 16:52:27 +00:00
|
|
|
.Nm
|
1998-05-27 11:05:59 +00:00
|
|
|
.Op Fl v
|
2004-07-18 09:57:47 +00:00
|
|
|
.Cm off
|
2012-11-01 18:59:19 +00:00
|
|
|
.Nm
|
2012-11-02 17:30:08 +00:00
|
|
|
.Op Fl v
|
2012-11-01 18:59:19 +00:00
|
|
|
.Fl l
|
1995-05-12 19:10:09 +00:00
|
|
|
.Sh DESCRIPTION
|
2002-07-06 19:34:18 +00:00
|
|
|
The
|
|
|
|
.Nm
|
2018-10-26 20:03:59 +00:00
|
|
|
utility is used to configure where the kernel can save a crash dump in the case
|
|
|
|
of a panic.
|
1998-05-25 08:54:40 +00:00
|
|
|
.Pp
|
2018-10-26 20:03:59 +00:00
|
|
|
System administrators should typically configure
|
1998-05-27 11:05:59 +00:00
|
|
|
.Nm
|
2018-10-26 20:03:59 +00:00
|
|
|
in a persistent fashion using the
|
|
|
|
.Xr rc.conf 5
|
|
|
|
variables
|
|
|
|
.Va dumpdev
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
and
|
2018-10-26 20:03:59 +00:00
|
|
|
.Va dumpon_flags .
|
|
|
|
For more information on this usage, see
|
|
|
|
.Xr rc.conf 5 .
|
2019-05-06 18:24:07 +00:00
|
|
|
.Pp
|
|
|
|
Starting in
|
|
|
|
.Fx 13.0 ,
|
|
|
|
.Nm
|
|
|
|
can configure a series of fallback dump devices.
|
|
|
|
For example, an administrator may prefer
|
|
|
|
.Xr netdump 4
|
|
|
|
by default, but if the
|
|
|
|
.Xr netdump 4
|
|
|
|
service cannot be reached or some other failure occurs, they might choose a
|
|
|
|
local disk dump as a second choice option.
|
2018-10-26 20:03:59 +00:00
|
|
|
.Ss General options
|
|
|
|
.Bl -tag -width _k_pubkey
|
2019-05-06 18:24:07 +00:00
|
|
|
.It Fl i Ar index
|
|
|
|
Insert the specified dump configuration into the prioritized fallback dump
|
|
|
|
device list at the specified index, starting at zero.
|
|
|
|
.Pp
|
|
|
|
If
|
|
|
|
.Fl i
|
|
|
|
is not specified, the configured dump device is appended to the prioritized
|
|
|
|
list.
|
|
|
|
.It Fl r
|
|
|
|
Remove the specified dump device configuration or configurations from the
|
|
|
|
fallback dump device list rather than inserting or appending it.
|
|
|
|
In contrast,
|
|
|
|
.Do
|
|
|
|
.Nm
|
|
|
|
off
|
|
|
|
.Dc
|
|
|
|
removes all configured devices.
|
|
|
|
Conflicts with
|
|
|
|
.Fl i .
|
2018-10-26 20:03:59 +00:00
|
|
|
.It Fl k Ar pubkey
|
|
|
|
Configure encrypted kernel dumps.
|
|
|
|
.Pp
|
|
|
|
A random, one-time symmetric key is automatically generated for bulk kernel
|
|
|
|
dump encryption every time
|
|
|
|
.Nm
|
|
|
|
is used.
|
|
|
|
The provided
|
|
|
|
.Ar pubkey
|
|
|
|
is used to encrypt a copy of the symmetric key.
|
|
|
|
The encrypted dump contents consist of a standard dump header, the
|
|
|
|
pubkey-encrypted symmetric key contents, and the symmetric key encrypted core
|
|
|
|
dump contents.
|
1998-05-27 11:05:59 +00:00
|
|
|
.Pp
|
2018-10-26 20:03:59 +00:00
|
|
|
As a result, only someone with the corresponding private key can decrypt the symmetric key.
|
|
|
|
The symmetric key is necessary to decrypt the kernel core.
|
|
|
|
The goal of the mechanism is to provide confidentiality.
|
|
|
|
.Pp
|
|
|
|
The
|
|
|
|
.Va pubkey
|
2020-04-23 18:04:52 +00:00
|
|
|
file should be a PEM-formatted RSA key of at least 2048 bits.
|
2019-05-23 20:12:24 +00:00
|
|
|
.It Fl C Ar cipher
|
|
|
|
Select the symmetric algorithm used for encrypted kernel crash dump.
|
|
|
|
The default is
|
|
|
|
.Dq chacha20
|
|
|
|
but
|
|
|
|
.Dq aes256-cbc
|
|
|
|
is also available.
|
|
|
|
(AES256-CBC mode does not work in conjunction with compression.)
|
2018-10-26 20:03:59 +00:00
|
|
|
.It Fl l
|
2019-05-06 18:24:07 +00:00
|
|
|
List the currently configured dump device(s), or /dev/null if no devices are
|
2018-10-26 20:03:59 +00:00
|
|
|
configured.
|
|
|
|
.It Fl v
|
|
|
|
Enable verbose mode.
|
|
|
|
.It Fl Z
|
|
|
|
Enable compression (Zstandard).
|
|
|
|
.It Fl z
|
|
|
|
Enable compression (gzip).
|
|
|
|
Only one compression method may be enabled at a time, so
|
|
|
|
.Fl z
|
|
|
|
is incompatible with
|
|
|
|
.Fl Z .
|
|
|
|
.Pp
|
|
|
|
Zstandard provides superior compression ratio and performance.
|
|
|
|
.El
|
|
|
|
.Ss Netdump
|
|
|
|
.Nm
|
|
|
|
may also configure the kernel to dump to a remote
|
|
|
|
.Xr netdumpd 8
|
|
|
|
server.
|
|
|
|
(The
|
|
|
|
.Xr netdumpd 8
|
|
|
|
server is available in ports.)
|
|
|
|
.Xr netdump 4
|
|
|
|
eliminates the need to reserve space for crash dumps.
|
|
|
|
It is especially useful in diskless environments.
|
|
|
|
When
|
|
|
|
.Nm
|
|
|
|
is used to configure netdump, the
|
|
|
|
.Ar device
|
|
|
|
(or
|
|
|
|
.Ar iface )
|
|
|
|
parameter should specify a network interface (e.g.,
|
|
|
|
.Va igb1 ) .
|
|
|
|
The specified NIC must be up (online) to configure netdump.
|
|
|
|
.Pp
|
|
|
|
.Xr netdump 4
|
|
|
|
specific options include:
|
|
|
|
.Bl -tag -width _g_gateway
|
|
|
|
.It Fl c Ar client
|
|
|
|
The local IP address of the
|
|
|
|
.Xr netdump 4
|
|
|
|
client.
|
|
|
|
.It Fl g Ar gateway
|
2018-11-18 01:58:48 +00:00
|
|
|
The first-hop router between
|
2018-10-26 20:03:59 +00:00
|
|
|
.Ar client
|
2018-11-18 01:58:48 +00:00
|
|
|
and
|
2018-10-26 20:03:59 +00:00
|
|
|
.Ar server .
|
2018-11-18 01:58:48 +00:00
|
|
|
If the
|
|
|
|
.Fl g
|
|
|
|
option is not specified and the system has a default route, the default
|
|
|
|
router is used as the
|
|
|
|
.Xr netdump 4
|
|
|
|
gateway.
|
|
|
|
If the
|
|
|
|
.Fl g
|
|
|
|
option is not specified and the system does not have a default route,
|
|
|
|
.Ar server
|
|
|
|
is assumed to be on the same link as
|
|
|
|
.Ar client .
|
2018-10-26 20:03:59 +00:00
|
|
|
.It Fl s Ar server
|
|
|
|
The IP address of the
|
|
|
|
.Xr netdumpd 8
|
|
|
|
server.
|
|
|
|
.El
|
|
|
|
.Pp
|
|
|
|
All of these options can be specified in the
|
|
|
|
.Xr rc.conf 5
|
|
|
|
variable
|
|
|
|
.Va dumpon_flags .
|
|
|
|
.Ss Minidumps
|
2013-04-30 07:22:03 +00:00
|
|
|
The default type of kernel crash dump is the mini crash dump.
|
|
|
|
Mini crash dumps hold only memory pages in use by the kernel.
|
|
|
|
Alternatively, full memory dumps can be enabled by setting the
|
|
|
|
.Va debug.minidump
|
|
|
|
.Xr sysctl 8
|
|
|
|
variable to 0.
|
2018-10-26 20:03:59 +00:00
|
|
|
.Ss Full dumps
|
2013-04-30 07:22:03 +00:00
|
|
|
For systems using full memory dumps, the size of the specified dump
|
2018-05-06 00:42:30 +00:00
|
|
|
device must be at least the size of physical memory.
|
2006-01-07 19:17:13 +00:00
|
|
|
Even though an additional 64 kB header is added to the dump, the BIOS for a
|
2004-10-03 23:35:34 +00:00
|
|
|
platform typically holds back some memory, so it is not usually
|
2002-08-13 11:39:38 +00:00
|
|
|
necessary to size the dump device larger than the actual amount of RAM
|
|
|
|
available in the machine.
|
2013-04-30 07:22:03 +00:00
|
|
|
Also, when using full memory dumps, the
|
2004-10-03 23:38:49 +00:00
|
|
|
.Nm
|
|
|
|
utility will refuse to enable a dump device which is smaller than the
|
|
|
|
total amount of physical memory as reported by the
|
|
|
|
.Va hw.physmem
|
|
|
|
.Xr sysctl 8
|
|
|
|
variable.
|
2003-05-07 19:37:51 +00:00
|
|
|
.Sh IMPLEMENTATION NOTES
|
2018-10-26 20:03:59 +00:00
|
|
|
Because the file system layer is already dead by the time a crash dump
|
|
|
|
is taken, it is not possible to send crash dumps directly to a file.
|
1998-05-25 08:54:40 +00:00
|
|
|
.Pp
|
1995-05-12 19:10:09 +00:00
|
|
|
The
|
2014-10-08 12:19:48 +00:00
|
|
|
.Xr loader 8
|
2018-10-26 20:03:59 +00:00
|
|
|
variable
|
|
|
|
.Va dumpdev
|
|
|
|
may be used to enable early kernel core dumps for system panics which occur
|
|
|
|
before userspace starts.
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Sh EXAMPLES
|
2018-10-26 20:03:59 +00:00
|
|
|
In order to generate an RSA private key, a user can use the
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Xr genrsa 1
|
|
|
|
tool:
|
|
|
|
.Pp
|
|
|
|
.Dl # openssl genrsa -out private.pem 4096
|
|
|
|
.Pp
|
|
|
|
A public key can be extracted from the private key using the
|
|
|
|
.Xr rsa 1
|
|
|
|
tool:
|
|
|
|
.Pp
|
|
|
|
.Dl # openssl rsa -in private.pem -out public.pem -pubout
|
|
|
|
.Pp
|
2018-10-26 20:03:59 +00:00
|
|
|
Once the RSA keys are created in a safe place, the public key may be moved to
|
|
|
|
the untrusted netdump client machine.
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
Now
|
|
|
|
.Pa public.pem
|
|
|
|
can be used by
|
|
|
|
.Nm
|
|
|
|
to configure encrypted kernel crash dumps:
|
|
|
|
.Pp
|
|
|
|
.Dl # dumpon -k public.pem /dev/ada0s1b
|
|
|
|
.Pp
|
|
|
|
It is recommended to test if the kernel saves encrypted crash dumps using the
|
|
|
|
current configuration.
|
|
|
|
The easiest way to do that is to cause a kernel panic using the
|
|
|
|
.Xr ddb 4
|
|
|
|
debugger:
|
|
|
|
.Pp
|
|
|
|
.Dl # sysctl debug.kdb.panic=1
|
|
|
|
.Pp
|
|
|
|
In the debugger the following commands should be typed to write a core dump and
|
|
|
|
reboot:
|
|
|
|
.Pp
|
2021-03-08 17:39:05 +00:00
|
|
|
.Dl db> dump
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Dl db> reset
|
|
|
|
.Pp
|
|
|
|
After reboot
|
|
|
|
.Xr savecore 8
|
2018-10-26 20:03:59 +00:00
|
|
|
should be able to save the core dump in the
|
|
|
|
.Va Dq dumpdir
|
|
|
|
directory, which is
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Pa /var/crash
|
|
|
|
by default:
|
|
|
|
.Pp
|
2018-10-26 20:03:59 +00:00
|
|
|
.Dl # savecore /dev/ada0s1b
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Pp
|
|
|
|
Three files should be created in the core directory:
|
|
|
|
.Pa info.# ,
|
|
|
|
.Pa key.#
|
|
|
|
and
|
|
|
|
.Pa vmcore_encrypted.#
|
2018-10-26 20:03:59 +00:00
|
|
|
(where
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Dq #
|
|
|
|
is the number of the last core dump saved by
|
2018-10-26 20:03:59 +00:00
|
|
|
.Xr savecore 8 ) .
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
The
|
|
|
|
.Pa vmcore_encrypted.#
|
|
|
|
can be decrypted using the
|
|
|
|
.Xr decryptcore 8
|
|
|
|
utility:
|
|
|
|
.Pp
|
|
|
|
.Dl # decryptcore -p private.pem -k key.# -e vmcore_encrypted.# -c vmcore.#
|
|
|
|
.Pp
|
|
|
|
or shorter:
|
|
|
|
.Pp
|
|
|
|
.Dl # decryptcore -p private.pem -n #
|
|
|
|
.Pp
|
|
|
|
The
|
|
|
|
.Pa vmcore.#
|
|
|
|
can be now examined using
|
2022-08-17 17:13:22 +00:00
|
|
|
.Xr kgdb 1 Pq Pa ports/devel/gdb :
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Pp
|
2018-06-13 09:28:47 +00:00
|
|
|
.Dl # kgdb /boot/kernel/kernel vmcore.#
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Pp
|
|
|
|
or shorter:
|
|
|
|
.Pp
|
2018-06-13 09:28:47 +00:00
|
|
|
.Dl # kgdb -n #
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Pp
|
|
|
|
The core was decrypted properly if
|
2022-08-17 17:13:22 +00:00
|
|
|
.Xr kgdb 1 Pq Pa ports/devel/gdb
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
does not print any errors.
|
2018-06-13 09:28:47 +00:00
|
|
|
Note that the live kernel might be at a different path
|
2018-10-26 20:03:59 +00:00
|
|
|
which can be examined by looking at the
|
|
|
|
.Va kern.bootfile
|
|
|
|
.Xr sysctl 8 .
|
2019-05-22 03:49:38 +00:00
|
|
|
.Pp
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
.Xr rc 8
|
|
|
|
script runs early during boot, typically before networking is configured.
|
|
|
|
This makes it unsuitable for configuring
|
2020-12-28 15:48:58 +00:00
|
|
|
.Xr netdump 4
|
2019-05-22 03:49:38 +00:00
|
|
|
when the client address is dynamic.
|
|
|
|
To configure
|
2020-12-28 15:48:58 +00:00
|
|
|
.Xr netdump 4
|
2019-05-22 03:49:38 +00:00
|
|
|
when
|
2020-12-28 15:48:58 +00:00
|
|
|
.Xr dhclient 8
|
2019-05-22 03:49:38 +00:00
|
|
|
binds to a server,
|
2020-12-28 15:48:58 +00:00
|
|
|
.Xr dhclient-script 8
|
2019-05-22 03:49:38 +00:00
|
|
|
can be used to run
|
2020-12-28 15:48:58 +00:00
|
|
|
.Xr dumpon 8 .
|
2019-05-22 03:49:38 +00:00
|
|
|
For example, to automatically configure
|
2020-12-28 15:48:58 +00:00
|
|
|
.Xr netdump 4
|
2019-05-22 03:49:38 +00:00
|
|
|
on the vtnet0 interface, add the following to
|
|
|
|
.Pa /etc/dhclient-exit-hooks .
|
|
|
|
.Bd -literal
|
|
|
|
case $reason in
|
|
|
|
BOUND|REBIND|REBOOT|RENEW)
|
|
|
|
if [ "$interface" != vtnet0 ] || [ -n "$old_ip_address" -a \\
|
|
|
|
"$old_ip_address" = "$new_ip_address" ]; then
|
|
|
|
break
|
|
|
|
fi
|
|
|
|
if [ -n "$new_routers" ]; then
|
2019-05-22 03:52:39 +00:00
|
|
|
# Take the first router in the list.
|
2019-05-22 03:49:38 +00:00
|
|
|
gateway_flag="-g ${new_routers%% *}"
|
|
|
|
fi
|
2019-05-22 03:52:39 +00:00
|
|
|
# Configure as the highest-priority dump device.
|
|
|
|
dumpon -i 0 -c $new_ip_address -s $server $gateway_flag vtnet0
|
2019-05-22 03:49:38 +00:00
|
|
|
;;
|
|
|
|
esac
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
Be sure to fill in the server IP address and change the interface name if
|
2019-05-22 03:52:39 +00:00
|
|
|
needed.
|
1995-05-12 19:10:09 +00:00
|
|
|
.Sh SEE ALSO
|
2018-02-13 19:28:02 +00:00
|
|
|
.Xr gzip 1 ,
|
2022-08-17 17:13:22 +00:00
|
|
|
.Xr kgdb 1 Pq Pa ports/devel/gdb ,
|
2018-02-13 19:28:02 +00:00
|
|
|
.Xr zstd 1 ,
|
Add support for encrypted kernel crash dumps.
Changes include modifications in kernel crash dump routines, dumpon(8) and
savecore(8). A new tool called decryptcore(8) was added.
A new DIOCSKERNELDUMP I/O control was added to send a kernel crash dump
configuration in the diocskerneldump_arg structure to the kernel.
The old DIOCSKERNELDUMP I/O control was renamed to DIOCSKERNELDUMP_FREEBSD11 for
backward ABI compatibility.
dumpon(8) generates an one-time random symmetric key and encrypts it using
an RSA public key in capability mode. Currently only AES-256-CBC is supported
but EKCD was designed to implement support for other algorithms in the future.
The public key is chosen using the -k flag. The dumpon rc(8) script can do this
automatically during startup using the dumppubkey rc.conf(5) variable. Once the
keys are calculated dumpon sends them to the kernel via DIOCSKERNELDUMP I/O
control.
When the kernel receives the DIOCSKERNELDUMP I/O control it generates a random
IV and sets up the key schedule for the specified algorithm. Each time the
kernel tries to write a crash dump to the dump device, the IV is replaced by
a SHA-256 hash of the previous value. This is intended to make a possible
differential cryptanalysis harder since it is possible to write multiple crash
dumps without reboot by repeating the following commands:
# sysctl debug.kdb.enter=1
db> call doadump(0)
db> continue
# savecore
A kernel dump key consists of an algorithm identifier, an IV and an encrypted
symmetric key. The kernel dump key size is included in a kernel dump header.
The size is an unsigned 32-bit integer and it is aligned to a block size.
The header structure has 512 bytes to match the block size so it was required to
make a panic string 4 bytes shorter to add a new field to the header structure.
If the kernel dump key size in the header is nonzero it is assumed that the
kernel dump key is placed after the first header on the dump device and the core
dump is encrypted.
Separate functions were implemented to write the kernel dump header and the
kernel dump key as they need to be unencrypted. The dump_write function encrypts
data if the kernel was compiled with the EKCD option. Encrypted kernel textdumps
are not supported due to the way they are constructed which makes it impossible
to use the CBC mode for encryption. It should be also noted that textdumps don't
contain sensitive data by design as a user decides what information should be
dumped.
savecore(8) writes the kernel dump key to a key.# file if its size in the header
is nonzero. # is the number of the current core dump.
decryptcore(8) decrypts the core dump using a private RSA key and the kernel
dump key. This is performed by a child process in capability mode.
If the decryption was not successful the parent process removes a partially
decrypted core dump.
Description on how to encrypt crash dumps was added to the decryptcore(8),
dumpon(8), rc.conf(5) and savecore(8) manual pages.
EKCD was tested on amd64 using bhyve and i386, mipsel and sparc64 using QEMU.
The feature still has to be tested on arm and arm64 as it wasn't possible to run
FreeBSD due to the problems with QEMU emulation and lack of hardware.
Designed by: def, pjd
Reviewed by: cem, oshogbo, pjd
Partial review: delphij, emaste, jhb, kib
Approved by: pjd (mentor)
Differential Revision: https://reviews.freebsd.org/D4712
2016-12-10 16:20:39 +00:00
|
|
|
.Xr ddb 4 ,
|
2018-10-26 20:03:59 +00:00
|
|
|
.Xr netdump 4 ,
|
1998-05-25 08:54:40 +00:00
|
|
|
.Xr fstab 5 ,
|
|
|
|
.Xr rc.conf 5 ,
|
|
|
|
.Xr config 8 ,
|
2018-02-13 19:28:02 +00:00
|
|
|
.Xr decryptcore 8 ,
|
1998-08-31 16:41:09 +00:00
|
|
|
.Xr init 8 ,
|
2014-10-08 12:19:48 +00:00
|
|
|
.Xr loader 8 ,
|
1995-05-12 19:10:09 +00:00
|
|
|
.Xr rc 8 ,
|
1998-05-25 08:54:40 +00:00
|
|
|
.Xr savecore 8 ,
|
|
|
|
.Xr swapon 8 ,
|
|
|
|
.Xr panic 9
|
1995-05-12 19:10:09 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Nm
|
2002-07-06 19:34:18 +00:00
|
|
|
utility appeared in
|
2016-10-02 23:35:45 +00:00
|
|
|
.Fx 2.0.5 .
|
2017-10-25 00:51:00 +00:00
|
|
|
.Pp
|
2018-10-26 20:03:59 +00:00
|
|
|
Support for encrypted kernel core dumps and netdump was added in
|
|
|
|
.Fx 12.0 .
|
|
|
|
.Sh AUTHORS
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
manual page was written by
|
|
|
|
.An Mark Johnston Aq Mt markj@FreeBSD.org ,
|
|
|
|
.An Conrad Meyer Aq Mt cem@FreeBSD.org ,
|
|
|
|
.An Konrad Witaszczyk Aq Mt def@FreeBSD.org ,
|
|
|
|
and countless others.
|
|
|
|
.Sh CAVEATS
|
|
|
|
To configure encrypted kernel core dumps, the running kernel must have been
|
|
|
|
compiled with the
|
|
|
|
.Dv EKCD
|
|
|
|
option.
|
|
|
|
.Pp
|
|
|
|
Netdump does not automatically update the configured
|
|
|
|
.Ar gateway
|
|
|
|
if routing topology changes.
|
|
|
|
.Pp
|
|
|
|
The size of a compressed dump or a minidump is not a fixed function of RAM
|
|
|
|
size.
|
|
|
|
Therefore, when at least one of these options is enabled, the
|
|
|
|
.Nm
|
|
|
|
utility cannot verify that the
|
|
|
|
.Ar device
|
|
|
|
has sufficient space for a dump.
|
|
|
|
.Nm
|
|
|
|
is also unable to verify that a configured
|
|
|
|
.Xr netdumpd 8
|
|
|
|
server has sufficient space for a dump.
|
|
|
|
.Pp
|
|
|
|
.Fl Z
|
|
|
|
requires a kernel compiled with the
|
|
|
|
.Dv ZSTDIO
|
|
|
|
kernel option.
|
|
|
|
Similarly,
|
|
|
|
.Fl z
|
|
|
|
requires the
|
|
|
|
.Dv GZIO
|
|
|
|
option.
|
|
|
|
.Sh BUGS
|
|
|
|
Netdump only supports IPv4 at this time.
|
2018-10-26 19:53:59 +00:00
|
|
|
.Sh SECURITY CONSIDERATIONS
|
2018-10-26 20:03:59 +00:00
|
|
|
The current encrypted kernel core dump scheme does not provide integrity nor
|
|
|
|
authentication.
|
|
|
|
That is, the recipient of an encrypted kernel core dump cannot know if they
|
|
|
|
received an intact core dump, nor can they verify the provenance of the dump.
|
|
|
|
.Pp
|
2018-10-26 19:53:59 +00:00
|
|
|
RSA keys smaller than 1024 bits are practical to factor and therefore weak.
|
|
|
|
Even 1024 bit keys may not be large enough to ensure privacy for many
|
|
|
|
years, so NIST recommends a minimum of 2048 bit RSA keys.
|
|
|
|
As a seatbelt,
|
|
|
|
.Nm
|
2018-10-26 20:03:59 +00:00
|
|
|
prevents users from configuring encrypted kernel dumps with extremely weak RSA
|
|
|
|
keys.
|
2018-10-26 19:53:59 +00:00
|
|
|
If you do not care for cryptographic privacy guarantees, just use
|
|
|
|
.Nm
|
|
|
|
without specifying a
|
|
|
|
.Fl k Ar pubkey
|
|
|
|
option.
|
2018-10-26 20:03:59 +00:00
|
|
|
.Pp
|
|
|
|
This process is sandboxed using
|
|
|
|
.Xr capsicum 4 .
|