| SUDOREPLAY(8) | System Manager's Manual | SUDOREPLAY(8) |
sudoreplay —
replay sudo session logs
sudoreplay |
[-FhnRS] [-d
dir] [-f
filter] [-m
num] [-s
num]
ID[@offset] |
sudoreplay |
[-h] [-d
dir] -l [search
expression] |
sudoreplay plays back or lists the output
logs created by sudo. When replaying,
sudoreplay can play the session back in real-time,
or the playback speed may be adjusted (faster or slower) based on the
command line options.
The ID should either be a six character sequence of digits and upper case letters, e.g., “0100A5” or a path name. The ID may include an optional @offset suffix which may be used to start replaying at a specific time offset. The @offset is specified as a number in seconds since the start of the session with an optional decimal fraction.
Path names may be relative to the I/O log
directory /var/log/sudo-io (unless overridden by the
-d option) or fully qualified, beginning with a
‘/’ character. When a command is run
via sudo with
log_output
enabled in the
sudoers
file, a “TSID=ID” string is logged via
syslog(3) or to the sudo log file.
The ID may also be determined using
sudoreplay's list mode.
In list mode, sudoreplay can be used to
find the ID of a session based on a number of criteria such as the user,
tty, or command run.
In replay mode, if the standard input and output are connected to
a terminal and the -n option is not specified,
sudoreplay will operate interactively. In
interactive mode, sudoreplay will attempt to adjust
the terminal size to match that of the session and write directly to the
terminal (not all terminals support this). Additionally, it will poll the
keyboard and act on the following keys:
\n’ or
‘\r’ ’ (space)<’>’The session can be interrupted via control-C. When the session has finished, the terminal is restored to its original size if it was changed during playback.
The options are as follows:
-d
dir,
--directory=dir-f
filter,
--filter=filtersudoreplay will display the command's standard
output, standard error, and tty output. The filter
argument is a comma-separated list, consisting of one or more of
following: stdin, stdout,
stderr,
ttyin,
and
ttyout.-F,
--followsudoreplay will ignore end-of-file and keep
replaying until the log is complete. This can be used to replay a session
that is still in progress, similar to “tail -f”. An I/O log
file is considered to be complete when the write bits have been cleared on
the session's timing file. Versions of sudo prior
to 1.9.1 do not clear the write bits upon completion.-h,
--help-l,
--list [search
expression]sudoreplay will list available sessions in a
format similar to the sudo log file format, sorted
by file name (or sequence number). Any control characters present in the
log data are formatted in octal with a leading
‘#’ character. For example, a
horizontal tab is displayed as
‘#011’ and an embedded carriage
return is displayed as ‘#015’. Space
characters in the command name and arguments are also formatted in octal.
If a search expression is specified, it will be used to restrict the IDs that are displayed. An expression is composed of the following predicates:
sudo was run this field will be empty in the
log.sudo runs commands as the
root
user.Predicates may be abbreviated to the shortest unique string.
Predicates may be combined using and,
or, and
! operators as well
as ‘(’ and
‘)’ grouping (parentheses must
generally be escaped from the shell). The and operator
is optional, adjacent predicates have an implied and
unless separated by an or.
-m,
--max-wait max_waitsudoreplay will accurately
reproduce the delays between key presses or program output. However, this
can be tedious when the session includes long pauses. When the
-m option is specified,
sudoreplay will limit these pauses to at most
max_wait seconds. The value may be specified as a
floating point number, e.g.,
2.5. A
max_wait of zero or less will eliminate the pauses
entirely.-n,
--non-interactive-R,
--no-resize-S,
--suspend-waitsudoreplay will ignore the time interval between
when the command was suspended and when it was resumed. If the
-S option is specified,
sudoreplay will wait instead.-s,
--speed speed_factorsudoreplay to adjust the number
of seconds it will wait between key presses or program output. This can be
used to slow down or speed up the display. For example, a
speed_factor of
2 would make
the output twice as fast whereas a speed_factor of
.5 would
make the output twice as slow.-V,
--versionsudoreplay versions version number and
exit.The time and date may be specified multiple ways, common formats include:
Either time or date may be omitted, the am/pm and timezone are optional. If no date is specified, the current day is assumed; if no time is specified, the first second of the specified date is used. The less significant parts of both time and date may also be omitted, in which case zero is assumed.
The following are all valid time and date specifications:
Relative time specifications do not always work as expected. For
example, the “next” qualifier is intended to be used in
conjunction with a day such as “next Monday”. When used with
units of weeks, months, years, etc the result will be one more than
expected. For example, “next week” will result in a time
exactly two weeks from now, which is probably not what was intended. This
will be addressed in a future version of
sudoreplay.
sudoreplay versions 1.8.4 and higher
support a flexible debugging framework that is configured via
Debug
lines in the sudo.conf(5) file.
For more information on configuring sudo.conf(5), refer to its manual.
The stdin, stdout and
stderr files will be empty unless
sudo was used as part of a pipeline for a particular
command.
List sessions run by user millert:
# sudoreplay -l user millert
List sessions run by user bob with a command containing the string vi:
# sudoreplay -l user bob command vi
List sessions run by user jeff that match a regular expression:
# sudoreplay -l user jeff command '/bin/[a-z]*sh'
List sessions run by jeff or bob on the console:
# sudoreplay -l ( user jeff or user bob ) tty console
Many people have worked on sudo over the
years; this version consists of code written primarily by:
See the CONTRIBUTORS.md file in the sudo
distribution (https://www.sudo.ws/about/contributors/) for an exhaustive
list of people who have contributed to sudo.
If you believe you have found a bug in
sudoreplay, you can submit a bug report at
https://bugzilla.sudo.ws/
Limited free support is available via the sudo-users mailing list, see https://www.sudo.ws/mailman/listinfo/sudo-users to subscribe or search the archives.
sudoreplay is provided “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. See the LICENSE.md file distributed with
sudo or https://www.sudo.ws/about/license/ for
complete details.
| January 16, 2023 | Sudo 1.9.13p3 |