2007-12-26 09:38:22 +00:00
|
|
|
.\"-
|
2008-04-25 17:34:09 +00:00
|
|
|
.\" Copyright (c) 2007-2008 Robert N. M. Watson
|
2007-12-26 09:38:22 +00:00
|
|
|
.\" 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 AUTHOR 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 AUTHOR 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.
|
|
|
|
.\"
|
|
|
|
.\" $FreeBSD$
|
|
|
|
.\"
|
2008-12-24 11:12:21 +00:00
|
|
|
.Dd December 24, 2008
|
2007-12-26 09:38:22 +00:00
|
|
|
.Dt DDB 8
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm ddb
|
2008-04-04 07:31:43 +00:00
|
|
|
.Nd "configure DDB kernel debugger properties"
|
2007-12-26 09:38:22 +00:00
|
|
|
.Sh SYNOPSIS
|
|
|
|
.Nm
|
2008-04-25 17:34:09 +00:00
|
|
|
.Cm capture
|
|
|
|
.Op Fl M core
|
|
|
|
.Op Fl N system
|
|
|
|
.Cm print
|
|
|
|
.Nm
|
|
|
|
.Cm capture
|
|
|
|
.Op Fl M core
|
|
|
|
.Op Fl N system
|
|
|
|
.Cm status
|
|
|
|
.Nm
|
2007-12-26 09:38:22 +00:00
|
|
|
.Cm script
|
|
|
|
.Ar scriptname
|
|
|
|
.Nm
|
|
|
|
.Cm script
|
2008-04-04 07:31:43 +00:00
|
|
|
.Ar scriptname Ns = Ns Ar script
|
2007-12-26 09:38:22 +00:00
|
|
|
.Nm
|
|
|
|
.Cm scripts
|
|
|
|
.Nm
|
|
|
|
.Cm unscript
|
|
|
|
.Ar scriptname
|
2008-03-05 17:51:06 +00:00
|
|
|
.Nm
|
|
|
|
.Ar pathname
|
2007-12-26 09:38:22 +00:00
|
|
|
.Sh DESCRIPTION
|
2008-04-04 07:31:43 +00:00
|
|
|
The
|
2007-12-26 09:38:22 +00:00
|
|
|
.Nm
|
2008-04-04 07:31:43 +00:00
|
|
|
utility configures certain aspects of the
|
|
|
|
.Xr ddb 4
|
2007-12-26 09:38:22 +00:00
|
|
|
kernel debugger from user space that are not configured at compile-time or
|
|
|
|
easily via
|
|
|
|
.Xr sysctl 8
|
|
|
|
MIB entries.
|
2008-03-05 17:51:06 +00:00
|
|
|
.Pp
|
|
|
|
To ease configuration, commands can be put in a file which is processed using
|
|
|
|
.Nm
|
|
|
|
as shown in the last synopsis line.
|
|
|
|
An absolute
|
|
|
|
.Ar pathname
|
|
|
|
must be used.
|
|
|
|
The file will be read line by line and applied as arguments to the
|
|
|
|
.Nm
|
|
|
|
utility.
|
|
|
|
Whitespace at the beginning of lines will be ignored as will lines where the
|
2008-04-04 07:31:43 +00:00
|
|
|
first non-whitespace character is
|
|
|
|
.Ql # .
|
2008-04-25 17:34:09 +00:00
|
|
|
.Sh OUTPUT CAPTURE
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
utility can be used to extract the contents of the
|
|
|
|
.Xr ddb 4
|
|
|
|
output capture buffer of the current live kernel, or from the crash dump of a
|
|
|
|
kernel on disk.
|
|
|
|
The following debugger commands are available from the command line:
|
|
|
|
.Bl -tag -width indent
|
|
|
|
.It Xo
|
2008-12-24 11:12:21 +00:00
|
|
|
.Cm capture
|
2008-04-25 17:34:09 +00:00
|
|
|
.Op Fl M Ar core
|
|
|
|
.Op Fl N Ar system
|
|
|
|
.Cm print
|
|
|
|
.Xc
|
|
|
|
Print the current contents of the
|
|
|
|
.Xr ddb 4
|
|
|
|
output capture buffer.
|
|
|
|
.It Xo
|
2008-12-24 11:12:21 +00:00
|
|
|
.Cm capture
|
2008-04-25 17:34:09 +00:00
|
|
|
.Op Fl M Ar core
|
|
|
|
.Op Fl N Ar system
|
|
|
|
.Cm status
|
|
|
|
.Xc
|
|
|
|
Print the current status of the
|
|
|
|
.Xr ddb 4
|
|
|
|
output capture buffer.
|
2008-12-24 11:12:21 +00:00
|
|
|
.El
|
2007-12-26 09:38:22 +00:00
|
|
|
.Sh SCRIPTING
|
2008-04-04 07:31:43 +00:00
|
|
|
The
|
2007-12-26 09:38:22 +00:00
|
|
|
.Nm
|
2008-04-04 07:31:43 +00:00
|
|
|
utility can be used to configure aspects of
|
|
|
|
.Xr ddb 4
|
2007-12-26 09:38:22 +00:00
|
|
|
scripting from user space; scripting support is described in more detail in
|
2008-04-04 07:31:43 +00:00
|
|
|
.Xr ddb 4 .
|
2007-12-26 09:38:22 +00:00
|
|
|
Each of the debugger commands is available from the command line:
|
|
|
|
.Bl -tag -width indent
|
|
|
|
.It Cm script Ar scriptname
|
|
|
|
Print the script named
|
|
|
|
.Ar scriptname .
|
2008-04-04 07:31:43 +00:00
|
|
|
.It Cm script Ar scriptname Ns = Ns Ar script
|
2007-12-26 09:38:22 +00:00
|
|
|
Define a script named
|
2008-04-04 07:31:43 +00:00
|
|
|
.Ar scriptname .
|
|
|
|
As many scripts contain characters interpreted in special ways by the shell,
|
2007-12-26 09:38:22 +00:00
|
|
|
it is advisable to enclose
|
2008-04-04 07:31:43 +00:00
|
|
|
.Ar script
|
2007-12-26 09:38:22 +00:00
|
|
|
in quotes.
|
|
|
|
.It Cm scripts
|
|
|
|
List currently defined scripts.
|
2011-06-18 22:32:55 +00:00
|
|
|
.It Cm unscript Ar scriptname
|
2007-12-26 09:38:22 +00:00
|
|
|
Delete the script named
|
|
|
|
.Ar scriptname .
|
|
|
|
.El
|
2008-04-04 07:31:43 +00:00
|
|
|
.Sh EXIT STATUS
|
|
|
|
.Ex -std
|
2007-12-26 09:38:22 +00:00
|
|
|
.Sh EXAMPLES
|
|
|
|
The following example defines a script that will execute when the kernel
|
|
|
|
debugger is entered as a result of a break signal:
|
|
|
|
.Bd -literal -offset indent
|
2007-12-26 12:20:19 +00:00
|
|
|
ddb script kdb.enter.break="show pcpu; bt"
|
2007-12-26 09:38:22 +00:00
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
The following example will delete the script:
|
2008-04-04 07:31:43 +00:00
|
|
|
.Pp
|
|
|
|
.Dl "ddb unscript kdb.enter.break"
|
2007-12-26 12:20:19 +00:00
|
|
|
.Pp
|
|
|
|
For further examples, see the
|
|
|
|
.Xr ddb 4
|
|
|
|
and
|
|
|
|
.Xr textdump 4
|
2008-04-04 07:31:43 +00:00
|
|
|
manual pages.
|
2007-12-26 09:38:22 +00:00
|
|
|
.Sh SEE ALSO
|
2007-12-26 12:20:19 +00:00
|
|
|
.Xr ddb 4 ,
|
mac: add new mac_ddb(4) policy
Generally, access to the kernel debugger is considered to be unsafe from
a security perspective since it presents an unrestricted interface to
inspect or modify the system state, including sensitive data such as
signing keys.
However, having some access to debugger functionality on production
systems may be useful in determining the cause of a panic or hang.
Therefore, it is desirable to have an optional policy which allows
limited use of ddb(4) while disabling the functionality which could
reveal system secrets.
This loadable MAC module allows for the use of some ddb(4) commands
while preventing the execution of others. The commands have been broadly
grouped into three categories:
- Those which are 'safe' and will not emit sensitive data (e.g. trace).
Generally, these commands are deterministic and don't accept
arguments.
- Those which are definitively unsafe (e.g. examine <addr>, search
<addr> <value>)
- Commands which may be safe to execute depending on the arguments
provided (e.g. show thread <addr>).
Safe commands have been flagged as such with the DB_CMD_MEMSAFE flag.
Commands requiring extra validation can provide a function to do so.
For example, 'show thread <addr>' can be used as long as addr can be
checked against the system's list of process structures.
The policy also prevents debugger backends other than ddb(4) from
executing, for example gdb(4).
Reviewed by: markj, pauamma_gundo.com (manpages)
Sponsored by: Juniper Networks, Inc.
Sponsored by: Klara, Inc.
Differential Revision: https://reviews.freebsd.org/D35371
2022-07-18 21:24:06 +00:00
|
|
|
.Xr mac_ddb 4 ,
|
2007-12-26 12:20:19 +00:00
|
|
|
.Xr textdump 4 ,
|
2007-12-26 09:38:22 +00:00
|
|
|
.Xr sysctl 8
|
|
|
|
.Sh HISTORY
|
2008-04-04 07:31:43 +00:00
|
|
|
The
|
2007-12-26 09:38:22 +00:00
|
|
|
.Nm
|
2008-04-04 07:31:43 +00:00
|
|
|
utility first appeared in
|
2008-08-03 14:27:06 +00:00
|
|
|
.Fx 7.1 .
|
2007-12-26 09:38:22 +00:00
|
|
|
.Sh AUTHORS
|
|
|
|
.An Robert N M Watson
|
|
|
|
.Sh BUGS
|
|
|
|
Ideally,
|
|
|
|
.Nm
|
|
|
|
would not exist, as all pertinent aspects of
|
2007-12-26 12:20:19 +00:00
|
|
|
.Xr ddb 4
|
2007-12-26 09:38:22 +00:00
|
|
|
could be configured directly via
|
|
|
|
.Xr sysctl 8 .
|