sbin/dumpon/dumpon.8

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)swapon.8      8.1 (Berkeley) 6/5/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 10, 2016
  32 .Dt DUMPON 8
  33 .Os
  34 .Sh NAME
  35 .Nm dumpon
  36 .Nd "specify a device for crash dumps"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl v
  40 .Op Fl k Ar public_key_file
  41 .Ar special_file
  42 .Nm
  43 .Op Fl v
  44 .Cm off
  45 .Nm
  46 .Op Fl v
  47 .Fl l
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility is used to specify a device where the kernel can save a crash
  52 dump in the case of a panic.
  53 .Pp
  54 Calls to
  55 .Nm
  56 normally occur from the system multi-user initialization file
  57 .Pa /etc/rc ,
  58 controlled by the
  59 .Dq dumpdev
  60 and
  61 .Dq dumppubkey
  62 variables in the boot time configuration file
  63 .Pa /etc/rc.conf .
  64 .Pp
  65 The default type of kernel crash dump is the mini crash dump.
  66 Mini crash dumps hold only memory pages in use by the kernel.
  67 Alternatively, full memory dumps can be enabled by setting the
  68 .Va debug.minidump
  69 .Xr sysctl 8
  70 variable to 0.
  71 .Pp
  72 For systems using full memory dumps, the size of the specified dump
  73 device must be at
  74 least the size of physical memory.
  75 Even though an additional 64 kB header is added to the dump, the BIOS for a
  76 platform typically holds back some memory, so it is not usually
  77 necessary to size the dump device larger than the actual amount of RAM
  78 available in the machine.
  79 Also, when using full memory dumps, the
  80 .Nm
  81 utility will refuse to enable a dump device which is smaller than the
  82 total amount of physical memory as reported by the
  83 .Va hw.physmem
  84 .Xr sysctl 8
  85 variable.
  86 .Pp
  87 The
  88 .Op Fl k Ar public_key_file
  89 flag causes
  90 .Nm
  91 to generate a one-time key for kernel crash dump encryption.
  92 The key will be replaced by a new one when the
  93 .Nm
  94 utility is run again.
  95 The key is encrypted using
  96 .Ar public_key_file .
  97 This process is sandboxed using
  98 .Xr capsicum 4 .
  99 Both plain and encrypted keys are sent to the kernel using
 100 .Dv DIOCSKERNELDUMP
 101 .Xr ioctl 2 .
 102 A user can specify the
 103 .Ar public_key_file
 104 in the
 105 .Dq dumppubkey
 106 variable defined in
 107 .Pa /etc/rc.conf
 108 for use with the
 109 .Pa /etc/rc.d/dumpon
 110 .Xr rc 8
 111 script.
 112 This flag requires a kernel compiled with the
 113 .Dv EKCD
 114 kernel option.
 115 .Pp
 116 The
 117 .Fl l
 118 flag causes
 119 .Nm
 120 to print the current dump device or _PATH_DEVNULL ("/dev/null") if no device is
 121 configured.
 122 .Pp
 123 The
 124 .Fl v
 125 flag causes
 126 .Nm
 127 to be verbose about its activity.
 128 .Sh IMPLEMENTATION NOTES
 129 Since a
 130 .Xr panic 9
 131 condition may occur in a situation
 132 where the kernel cannot trust its internal representation
 133 of the state of any given file system,
 134 one of the system swap devices,
 135 and
 136 .Em not
 137 a device containing a file system,
 138 should be used as the dump device.
 139 .Pp
 140 The
 141 .Nm
 142 utility operates by opening
 143 .Ar special_file
 144 and making a
 145 .Dv DIOCSKERNELDUMP
 146 .Xr ioctl 2
 147 request on it to save kernel crash dumps.
 148 If
 149 .Ar special_file
 150 is the text string:
 151 .Dq Li off ,
 152 .Nm
 153 performs a
 154 .Dv DIOCSKERNELDUMP
 155 .Xr ioctl 2
 156 on
 157 .Pa /dev/null
 158 and thus instructs the kernel not to save crash dumps.
 159 .Pp
 160 Since
 161 .Nm
 162 cannot be used during kernel initialization, the
 163 .Va dumpdev
 164 variable of
 165 .Xr loader 8
 166 must be used to enable dumps for system panics which occur
 167 during kernel initialization.
 168 .Sh FILES
 169 .Bl -tag -width "/dev/{ada,da}?s?b" -compact
 170 .It Pa /dev/{ada,da}?s?b
 171 standard swap areas
 172 .It Pa /etc/rc.conf
 173 boot-time system configuration
 174 .El
 175 .Sh EXAMPLES
 176 In order to generate an RSA private key a user can use the
 177 .Xr genrsa 1
 178 tool:
 179 .Pp
 180 .Dl # openssl genrsa -out private.pem 4096
 181 .Pp
 182 A public key can be extracted from the private key using the
 183 .Xr rsa 1
 184 tool:
 185 .Pp
 186 .Dl # openssl rsa -in private.pem -out public.pem -pubout
 187 .Pp
 188 Once the RSA keys are created the private key should be moved to a safe place.
 189 Now
 190 .Pa public.pem
 191 can be used by
 192 .Nm
 193 to configure encrypted kernel crash dumps:
 194 .Pp
 195 .Dl # dumpon -k public.pem /dev/ada0s1b
 196 .Pp
 197 It is recommended to test if the kernel saves encrypted crash dumps using the
 198 current configuration.
 199 The easiest way to do that is to cause a kernel panic using the
 200 .Xr ddb 4
 201 debugger:
 202 .Pp
 203 .Dl # sysctl debug.kdb.panic=1
 204 .Pp
 205 In the debugger the following commands should be typed to write a core dump and
 206 reboot:
 207 .Pp
 208 .Dl db> call doadump(0)
 209 .Dl db> reset
 210 .Pp
 211 After reboot
 212 .Xr savecore 8
 213 should be able to save the core dump in the core directory which is
 214 .Pa /var/crash
 215 by default:
 216 .Pp
 217 .Dl # savecore /var/crash /dev/ada0s1b
 218 .Pp
 219 Three files should be created in the core directory:
 220 .Pa info.# ,
 221 .Pa key.#
 222 and
 223 .Pa vmcore_encrypted.#
 224 where
 225 .Dq #
 226 is the number of the last core dump saved by
 227 .Xr savecore 8 .
 228 The
 229 .Pa vmcore_encrypted.#
 230 can be decrypted using the
 231 .Xr decryptcore 8
 232 utility:
 233 .Pp
 234 .Dl # decryptcore -p private.pem -k key.# -e vmcore_encrypted.# -c vmcore.#
 235 .Pp
 236 or shorter:
 237 .Pp
 238 .Dl # decryptcore -p private.pem -n #
 239 .Pp
 240 The
 241 .Pa vmcore.#
 242 can be now examined using
 243 .Xr kgdb 1 :
 244 .Pp
 245 .Dl # kgdb /usr/obj/sys/GENERIC/kernel.debug vmcore.#
 246 .Pp
 247 or shorter:
 248 .Pp
 249 .Dl # kgdb -n # /usr/obj/sys/GENERIC/kernel.debug
 250 .Pp
 251 The core was decrypted properly if
 252 .Xr kgdb 1
 253 does not print any errors.
 254 .Sh SEE ALSO
 255 .Xr kgdb 1 ,
 256 .Xr ddb 4 ,
 257 .Xr fstab 5 ,
 258 .Xr rc.conf 5 ,
 259 .Xr config 8 ,
 260 .Xr init 8 ,
 261 .Xr loader 8 ,
 262 .Xr rc 8 ,
 263 .Xr decryptcore 8 ,
 264 .Xr savecore 8 ,
 265 .Xr swapon 8 ,
 266 .Xr panic 9
 267 .Sh HISTORY
 268 The
 269 .Nm
 270 utility appeared in
 271 .Fx 2.0.5 .
 272 .Sh BUGS
 273 Because the file system layer is already dead by the time a crash dump
 274 is taken, it is not possible to send crash dumps directly to a file.