1994-05-26 06:35:07 +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.
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
.\" 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.
|
|
|
|
.\"
|
1994-09-24 00:08:43 +00:00
|
|
|
.\" From: @(#)savecore.8 8.1 (Berkeley) 6/5/93
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-26 06:35:07 +00:00
|
|
|
.\"
|
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
|
|
|
.Dd December 10, 2016
|
1994-05-26 06:35:07 +00:00
|
|
|
.Dt SAVECORE 8
|
2001-07-10 11:04:34 +00:00
|
|
|
.Os
|
1994-05-26 06:35:07 +00:00
|
|
|
.Sh NAME
|
|
|
|
.Nm savecore
|
|
|
|
.Nd "save a core dump of the operating system"
|
|
|
|
.Sh SYNOPSIS
|
2000-11-20 16:52:27 +00:00
|
|
|
.Nm
|
1994-05-26 06:35:07 +00:00
|
|
|
.Fl c
|
2012-12-14 15:12:08 +00:00
|
|
|
.Op Fl v
|
|
|
|
.Op Ar device ...
|
2000-11-20 16:52:27 +00:00
|
|
|
.Nm
|
2003-09-04 10:07:01 +00:00
|
|
|
.Fl C
|
|
|
|
.Op Fl v
|
2012-12-14 15:12:08 +00:00
|
|
|
.Op Ar device ...
|
2003-09-04 10:07:01 +00:00
|
|
|
.Nm
|
2015-12-01 19:18:53 +00:00
|
|
|
.Op Fl -libxo
|
2001-02-16 16:28:36 +00:00
|
|
|
.Op Fl fkvz
|
2012-12-16 23:06:12 +00:00
|
|
|
.Op Fl m Ar maxdumps
|
2002-05-05 01:04:00 +00:00
|
|
|
.Op Ar directory Op Ar device ...
|
1994-05-26 06:35:07 +00:00
|
|
|
.Sh DESCRIPTION
|
2002-05-29 16:53:27 +00:00
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
utility
|
2002-05-05 01:04:00 +00:00
|
|
|
copies a core dump into
|
2002-05-29 16:53:27 +00:00
|
|
|
.Ar directory ,
|
2002-05-05 01:04:00 +00:00
|
|
|
or the current working directory if no
|
2002-05-29 16:53:27 +00:00
|
|
|
.Ar directory
|
2002-05-05 01:04:00 +00:00
|
|
|
argument is given,
|
1994-05-26 06:35:07 +00:00
|
|
|
and enters a reboot message and information about the core dump into
|
|
|
|
the system log.
|
|
|
|
.Pp
|
|
|
|
The options are as follows:
|
2012-12-16 23:06:12 +00:00
|
|
|
.Bl -tag -width ".Fl m Ar maxdumps"
|
2015-12-01 19:18:53 +00:00
|
|
|
.It Fl -libxo
|
|
|
|
Generate output via
|
|
|
|
.Xr libxo 3
|
|
|
|
in a selection of different human and machine readable formats.
|
|
|
|
See
|
|
|
|
.Xr xo_parse_args 3
|
|
|
|
for details on command line arguments.
|
2003-09-04 10:07:01 +00:00
|
|
|
.It Fl C
|
|
|
|
Check to see if a dump exists,
|
|
|
|
and display a brief message to indicate the status.
|
|
|
|
An exit status of 0 indicates that a dump is there,
|
|
|
|
1 indicates that none exists.
|
|
|
|
This option is compatible only with the
|
|
|
|
.Op Fl v
|
|
|
|
option.
|
1994-05-26 06:35:07 +00:00
|
|
|
.It Fl c
|
1998-07-28 06:38:57 +00:00
|
|
|
Clear the dump, so that future invocations of
|
|
|
|
.Nm
|
1994-05-26 06:35:07 +00:00
|
|
|
will ignore it.
|
|
|
|
.It Fl f
|
2005-02-24 02:45:10 +00:00
|
|
|
Force a dump to be taken even if either the dump was cleared or if the
|
|
|
|
dump header information is inconsistent.
|
2001-02-16 16:28:36 +00:00
|
|
|
.It Fl k
|
|
|
|
Do not clear the dump after saving it.
|
2012-12-16 23:06:12 +00:00
|
|
|
.It Fl m Ar maxdumps
|
|
|
|
Maximum number of dumps to store.
|
|
|
|
Once the number of stored dumps is equal to
|
|
|
|
.Ar maxdumps
|
|
|
|
the counter will restart from
|
|
|
|
.Dv 0 .
|
1994-05-26 06:35:07 +00:00
|
|
|
.It Fl v
|
1998-07-28 06:38:57 +00:00
|
|
|
Print out some additional debugging information.
|
2005-06-06 06:47:33 +00:00
|
|
|
Specify twice for more information.
|
1994-05-26 06:35:07 +00:00
|
|
|
.It Fl z
|
1998-07-28 06:38:57 +00:00
|
|
|
Compress the core dump and kernel (see
|
2001-09-06 09:30:09 +00:00
|
|
|
.Xr gzip 1 ) .
|
1994-05-26 06:35:07 +00:00
|
|
|
.El
|
|
|
|
.Pp
|
2002-05-29 16:53:27 +00:00
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
utility
|
2002-05-05 01:04:00 +00:00
|
|
|
looks for dumps on each device specified by the
|
|
|
|
.Ar device
|
|
|
|
argument(s), or on each device in
|
|
|
|
.Pa /etc/fstab
|
2002-05-29 16:53:27 +00:00
|
|
|
marked as
|
|
|
|
.Dq dump
|
|
|
|
or
|
|
|
|
.Dq swap .
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
utility
|
2002-05-05 01:04:00 +00:00
|
|
|
checks the core dump in various ways to make sure that it is complete.
|
1994-05-26 06:35:07 +00:00
|
|
|
If it passes these checks, it saves the core image in
|
|
|
|
.Ar directory Ns Pa /vmcore.#
|
2002-05-05 01:04:00 +00:00
|
|
|
and information about the core in
|
2009-09-17 19:15:49 +00:00
|
|
|
.Ar directory Ns Pa /info.# .
|
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
|
|
|
If the core is encrypted, it saves the dump key in
|
|
|
|
.Ar directory Ns Pa /key.# .
|
|
|
|
The core can be later decrypted using
|
|
|
|
.Xr decryptcore 8 .
|
2007-12-26 11:42:10 +00:00
|
|
|
For kernel textdumps generated with the
|
|
|
|
.Xr textdump 4
|
|
|
|
facility, output will be stored in the
|
|
|
|
.Xr tar 5
|
|
|
|
format and named
|
2009-09-17 19:15:49 +00:00
|
|
|
.Ar directory Ns Pa /textdump.tar.# .
|
|
|
|
The
|
|
|
|
.Dq #
|
|
|
|
is the number from the first line of the file
|
1994-05-26 06:35:07 +00:00
|
|
|
.Ar directory Ns Pa /bounds ,
|
|
|
|
and it is incremented and stored back into the file each time
|
1998-07-28 06:38:57 +00:00
|
|
|
.Nm
|
1994-05-26 06:35:07 +00:00
|
|
|
successfully runs.
|
|
|
|
.Pp
|
2002-05-29 16:53:27 +00:00
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
utility
|
1994-05-26 06:35:07 +00:00
|
|
|
also checks the available disk space before attempting to make the copies.
|
2002-08-21 18:11:48 +00:00
|
|
|
If there is insufficient disk space in the file system containing
|
1994-05-26 06:35:07 +00:00
|
|
|
.Ar directory ,
|
|
|
|
or if the file
|
|
|
|
.Ar directory Ns Pa /minfree
|
|
|
|
exists and the number of free kilobytes (for non-superusers) in the
|
2002-08-21 18:11:48 +00:00
|
|
|
file system after the copies were made would be less than the number
|
1994-05-26 06:35:07 +00:00
|
|
|
in the first line of this file, the copies are not attempted.
|
|
|
|
.Pp
|
|
|
|
If
|
1998-07-28 06:38:57 +00:00
|
|
|
.Nm
|
1994-05-26 06:35:07 +00:00
|
|
|
successfully copies the kernel and the core dump, the core dump is cleared
|
|
|
|
so that future invocations of
|
1998-07-28 06:38:57 +00:00
|
|
|
.Nm
|
1994-05-26 06:35:07 +00:00
|
|
|
will ignore it.
|
|
|
|
.Pp
|
2002-05-29 16:53:27 +00:00
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
utility
|
1994-05-26 06:35:07 +00:00
|
|
|
is meant to be called near the end of the initialization file
|
|
|
|
.Pa /etc/rc
|
|
|
|
(see
|
|
|
|
.Xr rc 8 ) .
|
|
|
|
.Sh SEE ALSO
|
2001-09-06 09:30:09 +00:00
|
|
|
.Xr gzip 1 ,
|
2001-09-11 09:58:34 +00:00
|
|
|
.Xr getbootfile 3 ,
|
2015-12-01 19:18:53 +00:00
|
|
|
.Xr libxo 3 ,
|
|
|
|
.Xr xo_parse_args 3 ,
|
2007-12-26 11:42:10 +00:00
|
|
|
.Xr textdump 4 ,
|
2008-12-24 11:12:21 +00:00
|
|
|
.Xr tar 5 ,
|
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 decryptcore 8 ,
|
2001-10-28 16:41:56 +00:00
|
|
|
.Xr dumpon 8 ,
|
1994-05-26 06:35:07 +00:00
|
|
|
.Xr syslogd 8
|
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Nm
|
2002-07-06 19:35:14 +00:00
|
|
|
utility appeared in
|
1994-05-26 06:35:07 +00:00
|
|
|
.Bx 4.1 .
|
2007-12-26 11:42:10 +00:00
|
|
|
.Pp
|
|
|
|
Support for kernel textdumps appeared in
|
2009-04-23 08:37:56 +00:00
|
|
|
.Fx 7.1 .
|
2005-01-18 10:09:38 +00:00
|
|
|
.Sh BUGS
|
|
|
|
The minfree code does not consider the effect of compression or sparse files.
|