Changeset View
Changeset View
Standalone View
Standalone View
sbin/decryptcore/decryptcore.8
- This file was added.
.\" Copyright (c) 2015 Konrad Witaszczyk <def@FreeBSD.org> | |||||
.\" 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. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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. | |||||
.\" | |||||
.Dd December 1, 2015 | |||||
.Dt DECRYPTCORE 8 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm decryptcore | |||||
.Nd "decrypt a core dump of the operating system" | |||||
.Sh SYNOPSIS | |||||
.Nm | |||||
.Op Fl Lv | |||||
.Fl p Ar privatekey | |||||
.Fl k Ar key | |||||
.Fl e Ar encryptedcore | |||||
.Fl c Ar core | |||||
.Nm | |||||
.Op Fl Lv | |||||
.Op Fl d Ar crashdir | |||||
.Fl p Ar privatekey | |||||
.Fl n Ar dumpnr | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
first decrypts | |||||
.Ar key | |||||
using | |||||
.Ar privatekey | |||||
and then uses the resulting key to decrypt | |||||
.Ar encryptedcore | |||||
saved by | |||||
.Xr savecore 8 . | |||||
Result is saved in | |||||
.Ar core . | |||||
.Pp | |||||
Alternatively a user can decrypt a core dump numbered | |||||
.Ar dumpnr | |||||
from the | |||||
.Ar crashdir | |||||
directory. | |||||
In this case a dump key from the | |||||
.Pa key.# | |||||
file is used and the result is saved in the | |||||
.Pa vmcore.# | |||||
file where | |||||
.Dq # | |||||
corresponds to | |||||
.Ar dumpnr . | |||||
.Pp | |||||
The | |||||
.Nm | |||||
utility can be started with the following command line arguments: | |||||
.Bl -tag -width ".Fl e Ar encryptedcore" | |||||
.It Fl L | |||||
Write log messages to | |||||
.Xr syslogd 8 . | |||||
.It Fl v | |||||
Print or log verbose/debugging information. | |||||
This option can be specified multiple times to raise the verbosity | |||||
level. | |||||
.It Fl p Ar privatekey | |||||
Specify location of a private key which will be used to decrypt the | |||||
.Ar key | |||||
file. | |||||
.It Fl k Ar key | |||||
Specify location of a dump key. | |||||
.It Fl e Ar encrytpedcore | |||||
Specify location of an encrypted core. | |||||
.It Fl c Ar core | |||||
Specify location of a resulting decrypted core dump. | |||||
.It Fl d Ar crashdir | |||||
Specify an alternative crash dump directory. The default crash dump directory is | |||||
.Pa /var/crash . | |||||
.It Fl n Ar dumpnr | |||||
Specify a number of a crash dump to be decrypted. | |||||
.El | |||||
.Sh EXIT STATUS | |||||
The | |||||
.Nm | |||||
utility exits 0 on success, and >0 if an error occurs. | |||||
.Sh SEE ALSO | |||||
.Xr capsicum 4 , | |||||
.Xr dumpon 8 , | |||||
.Xr kgdb 1 , | |||||
.Xr savecore 8 , | |||||
.Xr syslogd 8 | |||||
.Sh AUTHORS | |||||
The | |||||
.Nm | |||||
was implemented by | |||||
.An -nosplit | |||||
.An Konrad Witaszczyk Aq Mt def@FreeBSD.org . |