journalctl.c revision 8d98da3f1107529d5ba49aea1fa285f7264b7cba
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
/***
This file is part of systemd.
Copyright 2011 Lennart Poettering
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include <locale.h>
#include <fcntl.h>
#include <errno.h>
#include <stddef.h>
#include <string.h>
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <time.h>
#include <getopt.h>
#include <signal.h>
#ifdef HAVE_ACL
#include "acl-util.h"
#endif
#include <systemd/sd-journal.h>
#include "log.h"
#include "logs-show.h"
#include "util.h"
#include "path-util.h"
#include "build.h"
#include "pager.h"
#include "logs-show.h"
#include "strv.h"
#include "journal-internal.h"
#include "journal-def.h"
#include "journal-verify.h"
#include "journal-authenticate.h"
#include "journal-qrcode.h"
#include "fsprg.h"
#include "unit-name.h"
#include "catalog.h"
static bool arg_pager_end = false;
static bool arg_follow = false;
static bool arg_full = false;
static bool arg_all = false;
static bool arg_no_pager = false;
static int arg_lines = -1;
static bool arg_no_tail = false;
static bool arg_quiet = false;
static bool arg_merge = false;
static bool arg_this_boot = false;
static bool arg_dmesg = false;
static const char *arg_cursor = NULL;
static const char *arg_directory = NULL;
static int arg_priorities = 0xFF;
static const char *arg_verify_key = NULL;
#ifdef HAVE_GCRYPT
#endif
static bool arg_since_set = false, arg_until_set = false;
static char **arg_system_units = NULL;
static char **arg_user_units = NULL;
static bool arg_catalog = false;
static bool arg_reverse = false;
static int arg_journal_type = 0;
static enum {
} arg_action = ACTION_SHOW;
static int help(void) {
printf("%s [OPTIONS...] [MATCHES...]\n\n"
"Query the journal.\n\n"
"Flags:\n"
" --system Show only the system journal\n"
" --user Show only the user journal for current user\n"
" --since=DATE Start showing entries newer or of the specified date\n"
" --until=DATE Stop showing entries older or of the specified date\n"
" -c --cursor=CURSOR Start showing entries from specified cursor\n"
" -b --this-boot Show data only from current boot\n"
" -k --dmesg Show kmsg log from current boot\n"
" -u --unit=UNIT Show data only from the specified unit\n"
" --user-unit=UNIT Show data only from the specified user session unit\n"
" -p --priority=RANGE Show only messages within the specified priority range\n"
" -e --pager-end Immediately jump to end of the journal in the pager\n"
" -f --follow Follow journal\n"
" -n --lines[=INTEGER] Number of journal entries to show\n"
" --no-tail Show all lines, even in follow mode\n"
" -r --reverse Show the newest entries first\n"
" -o --output=STRING Change journal output mode (short, short-monotonic,\n"
" verbose, export, json, json-pretty, json-sse, cat)\n"
" -x --catalog Add message explanations where available\n"
" --full Do not ellipsize fields\n"
" -a --all Show all fields, including long and unprintable\n"
" -q --quiet Don't show privilege warning\n"
" --no-pager Do not pipe output into a pager\n"
" -m --merge Show entries from all available journals\n"
" -D --directory=PATH Show journal files from directory\n"
" --file=PATH Show journal file\n"
" --root=ROOT Operate on catalog files underneath the root ROOT\n"
#ifdef HAVE_GCRYPT
" --interval=TIME Time interval for changing the FSS sealing key\n"
" --verify-key=KEY Specify FSS verification key\n"
#endif
"\nCommands:\n"
" -h --help Show this help\n"
" --version Show package version\n"
" --new-id128 Generate a new 128 Bit ID\n"
" --header Show journal header information\n"
" --disk-usage Show total disk usage\n"
" -F --field=FIELD List all values a certain field takes\n"
" --list-catalog Show message IDs of all entries in the message catalog\n"
" --dump-catalog Show entries in the message catalog\n"
" --update-catalog Update the message catalog database\n"
#ifdef HAVE_GCRYPT
" --setup-keys Generate new FSS key pair\n"
" --verify Verify journal file consistency\n"
#endif
return 0;
}
enum {
ARG_VERSION = 0x100,
};
};
int c, r;
switch (c) {
case 'h':
help();
return 0;
case ARG_VERSION:
return 0;
case ARG_NO_PAGER:
arg_no_pager = true;
break;
case 'e':
arg_pager_end = true;
if (arg_lines < 0)
arg_lines = 1000;
break;
case 'f':
arg_follow = true;
break;
case 'o':
if (arg_output < 0) {
return -EINVAL;
}
if (arg_output == OUTPUT_EXPORT ||
arg_output == OUTPUT_JSON ||
arg_output == OUTPUT_JSON_PRETTY ||
arg_output == OUTPUT_JSON_SSE ||
arg_output == OUTPUT_CAT)
arg_quiet = true;
break;
case ARG_FULL:
arg_full = true;
break;
case 'a':
arg_all = true;
break;
case 'n':
if (optarg) {
if (r < 0 || arg_lines < 0) {
return -EINVAL;
}
} else {
int n;
/* Hmm, no argument? Maybe the next
* word on the command line is
* supposed to be the argument? Let's
* see if there is one, and is
* parsable as a positive
* integer... */
n >= 0) {
arg_lines = n;
optind++;
} else
arg_lines = 10;
}
break;
case ARG_NO_TAIL:
arg_no_tail = true;
break;
case ARG_NEW_ID128:
break;
case 'q':
arg_quiet = true;
break;
case 'm':
arg_merge = true;
break;
case 'b':
arg_this_boot = true;
break;
case 'k':
arg_this_boot = arg_dmesg = true;
break;
case ARG_SYSTEM:
break;
case ARG_USER:
break;
case 'D':
break;
case ARG_FILE:
if (r < 0) {
return r;
};
break;
case ARG_ROOT:
break;
case 'c':
arg_cursor = optarg;
break;
case ARG_HEADER:
break;
case ARG_VERIFY:
break;
case ARG_DISK_USAGE:
break;
#ifdef HAVE_GCRYPT
case ARG_SETUP_KEYS:
break;
case ARG_VERIFY_KEY:
arg_merge = false;
break;
case ARG_INTERVAL:
if (r < 0 || arg_interval <= 0) {
return -EINVAL;
}
break;
#else
case ARG_SETUP_KEYS:
case ARG_VERIFY_KEY:
case ARG_INTERVAL:
log_error("Forward-secure sealing not available.");
return -ENOTSUP;
#endif
case 'p': {
const char *dots;
if (dots) {
char *a;
/* a range */
if (!a)
return log_oom();
from = log_level_from_string(a);
free(a);
return -EINVAL;
}
arg_priorities = 0;
arg_priorities |= 1 << i;
} else {
arg_priorities |= 1 << i;
}
} else {
int p, i;
p = log_level_from_string(optarg);
if (p < 0) {
return -EINVAL;
}
arg_priorities = 0;
for (i = 0; i <= p; i++)
arg_priorities |= 1 << i;
}
break;
}
case ARG_SINCE:
if (r < 0) {
return -EINVAL;
}
arg_since_set = true;
break;
case ARG_UNTIL:
if (r < 0) {
return -EINVAL;
}
arg_until_set = true;
break;
case 'u':
if (r < 0)
return log_oom();
break;
case ARG_USER_UNIT:
if (r < 0)
return log_oom();
break;
case '?':
return -EINVAL;
case 'F':
break;
case 'x':
arg_catalog = true;
break;
case ARG_LIST_CATALOG:
break;
case ARG_DUMP_CATALOG:
break;
case ARG_UPDATE_CATALOG:
break;
case 'r':
arg_reverse = true;
break;
default:
log_error("Unknown option code %c", c);
return -EINVAL;
}
}
arg_lines = 10;
if (arg_directory && arg_file) {
log_error("Please specify either -D/--directory= or --file=, not both.");
return -EINVAL;
}
log_error("--since= must be before --until=.");
return -EINVAL;
}
if (arg_cursor && arg_since_set) {
log_error("Please specify either --since= or --cursor=, not both.");
return -EINVAL;
}
if (arg_follow && arg_reverse) {
log_error("Please specify either --reverse= or --follow=, not both.");
return -EINVAL;
}
return 1;
}
static int generate_new_id128(void) {
int r;
unsigned i;
r = sd_id128_randomize(&id);
if (r < 0) {
return r;
}
printf("As string:\n"
SD_ID128_FORMAT_STR "\n\n"
"As UUID:\n"
"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\n\n"
"As macro:\n"
"#define MESSAGE_XYZ SD_ID128_MAKE(",
for (i = 0; i < 16; i++)
printf("As Python constant:\n"
">>> import uuid\n"
return 0;
}
char **i;
assert(j);
STRV_FOREACH(i, args) {
int r;
if (streq(*i, "+"))
r = sd_journal_add_disjunction(j);
else if (path_is_absolute(*i)) {
_cleanup_free_ char *p, *t = NULL;
const char *path;
p = canonicalize_file_name(*i);
path = p ? p : *i;
log_error("Couldn't stat file: %m");
return -errno;
}
else {
log_error("File is neither a device node, nor regular file, nor executable: %s", *i);
return -EINVAL;
}
if (!t)
return log_oom();
r = sd_journal_add_match(j, t, 0);
} else
r = sd_journal_add_match(j, *i, 0);
if (r < 0) {
return r;
}
}
return 0;
}
static int add_this_boot(sd_journal *j) {
if (!arg_this_boot)
return 0;
return add_match_this_boot(j);
}
static int add_dmesg(sd_journal *j) {
int r;
assert(j);
if (!arg_dmesg)
return 0;
if (r < 0) {
return r;
}
r = sd_journal_add_conjunction(j);
if (r < 0)
return r;
return 0;
}
static int add_units(sd_journal *j) {
_cleanup_free_ char *u = NULL;
int r;
char **i;
assert(j);
STRV_FOREACH(i, arg_system_units) {
u = unit_name_mangle(*i);
if (!u)
return log_oom();
r = add_matches_for_unit(j, u);
if (r < 0)
return r;
r = sd_journal_add_disjunction(j);
if (r < 0)
return r;
}
STRV_FOREACH(i, arg_user_units) {
u = unit_name_mangle(*i);
if (!u)
return log_oom();
r = add_matches_for_user_unit(j, u, getuid());
if (r < 0)
return r;
r = sd_journal_add_disjunction(j);
if (r < 0)
return r;
}
r = sd_journal_add_conjunction(j);
if (r < 0)
return r;
return 0;
}
static int add_priorities(sd_journal *j) {
char match[] = "PRIORITY=0";
int i, r;
assert(j);
if (arg_priorities == 0xFF)
return 0;
if (arg_priorities & (1 << i)) {
if (r < 0) {
return r;
}
}
r = sd_journal_add_conjunction(j);
if (r < 0)
return r;
return 0;
}
static int setup_keys(void) {
#ifdef HAVE_GCRYPT
ssize_t l;
struct FSSHeader h;
uint64_t n;
r = sd_id128_get_machine(&machine);
if (r < 0) {
return r;
}
r = sd_id128_get_boot(&boot);
if (r < 0) {
return r;
}
SD_ID128_FORMAT_VAL(machine)) < 0)
return log_oom();
log_error("Sealing key file %s exists already.", p);
r = -EEXIST;
goto finish;
}
SD_ID128_FORMAT_VAL(machine)) < 0) {
r = log_oom();
goto finish;
}
if (fd < 0) {
r = -errno;
goto finish;
}
log_info("Generating seed...");
r = -EIO;
goto finish;
}
log_info("Generating key pair...");
log_info("Generating sealing key...");
assert(arg_interval > 0);
n = now(CLOCK_REALTIME);
n /= arg_interval;
if (fd < 0) {
log_error("Failed to open %s: %m", k);
r = -errno;
goto finish;
}
/* Enable secure remove, exclusion from dump, synchronous
* writing and in-place updating */
log_warning("FS_IOC_GETFLAGS failed: %m");
log_warning("FS_IOC_SETFLAGS failed: %m");
zero(h);
h.machine_id = machine;
h.header_size = htole64(sizeof(h));
l = loop_write(fd, &h, sizeof(h), false);
if (l < 0 || (size_t) l != sizeof(h)) {
r = -EIO;
goto finish;
}
if (l < 0 || (size_t) l != state_size) {
r = -EIO;
goto finish;
}
if (link(k, p) < 0) {
log_error("Failed to link file: %m");
r = -errno;
goto finish;
}
if (on_tty()) {
"\n"
"The new key pair has been generated. The " ANSI_HIGHLIGHT_ON "secret sealing key" ANSI_HIGHLIGHT_OFF " has been written to\n"
"the following local file. This key file is automatically updated when the\n"
"sealing key is advanced. It should not be used on multiple hosts.\n"
"\n"
"\t%s\n"
"\n"
"Please write down the following " ANSI_HIGHLIGHT_ON "secret verification key" ANSI_HIGHLIGHT_OFF ". It should be stored\n"
"at a safe location and should not be saved locally on disk.\n"
"\n\t" ANSI_HIGHLIGHT_RED_ON, p);
}
for (i = 0; i < seed_size; i++) {
if (i > 0 && i % 3 == 0)
putchar('-');
}
if (on_tty()) {
ANSI_HIGHLIGHT_OFF "\n"
"The sealing key is automatically changed every %s.\n",
hn = gethostname_malloc();
if (hn) {
hostname_cleanup(hn, false);
fprintf(stderr, "\nThe keys have been generated for host %s/" SD_ID128_FORMAT_STR ".\n", hn, SD_ID128_FORMAT_VAL(machine));
} else
fprintf(stderr, "\nThe keys have been generated for host " SD_ID128_FORMAT_STR ".\n", SD_ID128_FORMAT_VAL(machine));
#ifdef HAVE_QRENCODE
/* If this is not an UTF-8 system don't print any QR codes */
if (is_locale_utf8()) {
fputs("\nTo transfer the verification key to your phone please scan the QR code below:\n\n", stderr);
}
#endif
}
r = 0;
if (fd >= 0)
if (k) {
unlink(k);
free(k);
}
free(p);
return r;
#else
log_error("Forward-secure sealing not available.");
return -ENOTSUP;
#endif
}
static int verify(sd_journal *j) {
int r = 0;
Iterator i;
JournalFile *f;
assert(j);
log_show_color(true);
HASHMAP_FOREACH(f, j->files, i) {
int k;
#ifdef HAVE_GCRYPT
log_notice("Journal file %s has sealing enabled but verification key has not been passed using --verify-key=.", f->path);
#endif
if (k == -EINVAL) {
/* If the key was invalid give up right-away. */
return k;
} else if (k < 0) {
r = k;
} else {
if (validated > 0) {
log_info("=> Validated from %s to %s, final %s entries not sealed.",
format_timestamp(a, sizeof(a), first),
format_timestamp(b, sizeof(b), validated),
} else if (last > 0)
log_info("=> No sealing yet, %s of entries not sealed.",
else
log_info("=> No sealing yet, no entries in file.");
}
}
}
return r;
}
#ifdef HAVE_ACL
static int access_check_var_log_journal(sd_journal *j) {
_cleanup_strv_free_ char **g = NULL;
bool have_access;
int r;
assert(j);
if (!have_access) {
/* Let's enumerate all groups from the default ACL of
* the directory, which generally should allow access
* to most journal files too */
if (r < 0)
return r;
}
if (!have_access) {
if (strv_isempty(g))
log_notice("Hint: You are currently not seeing messages from other users and the system.\n"
" Users in the 'systemd-journal' group can see all messages. Pass -q to\n"
" turn off this notice.");
else {
_cleanup_free_ char *s = NULL;
r = strv_extend(&g, "systemd-journal");
if (r < 0)
return log_oom();
strv_sort(g);
strv_uniq(g);
s = strv_join(g, "', '");
if (!s)
return log_oom();
log_notice("Hint: You are currently not seeing messages from other users and the system.\n"
" Users in the groups '%s' can see all messages.\n"
" Pass -q to turn off this notice.", s);
}
}
return 0;
}
#endif
static int access_check(sd_journal *j) {
void *code;
int r = 0;
assert(j);
if (set_isempty(j->errors)) {
if (hashmap_isempty(j->files))
log_notice("No journal files were found.");
return 0;
}
#ifdef HAVE_ACL
* unprivileged users have no access at all */
geteuid() != 0 &&
in_group("systemd-journal") <= 0) {
log_error("Unprivileged users cannot access messages, unless persistent log storage is\n"
"enabled. Users in the 'systemd-journal' group may always access messages.");
return -EACCES;
}
notice if the user lacks access to it */
r = access_check_var_log_journal(j);
if (r < 0)
return r;
}
#else
log_error("Unprivileged users cannot access messages. Users in the 'systemd-journal' group\n"
"group may access messages.");
return -EACCES;
}
#endif
if (hashmap_isempty(j->files)) {
log_error("No journal files were opened due to insufficient permissions.");
r = -EACCES;
}
}
int err;
log_warning("Error was encountered while opening journal files: %s",
}
return r;
}
int r;
bool need_seek = false;
bool previous_boot_id_valid = false, first_line = true;
int n_shown = 0;
log_open();
if (r <= 0)
goto finish;
if (arg_action == ACTION_NEW_ID128) {
r = generate_new_id128();
goto finish;
}
if (arg_action == ACTION_SETUP_KEYS) {
r = setup_keys();
goto finish;
}
if (arg_action == ACTION_UPDATE_CATALOG ||
const char* database = CATALOG_DATABASE;
if (arg_root) {
if (!copy) {
r = log_oom();
goto finish;
}
}
if (arg_action == ACTION_UPDATE_CATALOG) {
if (r < 0)
} else {
else
if (r < 0)
}
goto finish;
}
if (arg_directory)
else if (arg_file)
r = sd_journal_open_files(&j, (const char**) arg_file, 0);
else
if (r < 0) {
log_error("Failed to open %s: %s",
strerror(-r));
return EXIT_FAILURE;
}
r = access_check(j);
if (r < 0)
return EXIT_FAILURE;
if (arg_action == ACTION_VERIFY) {
r = verify(j);
goto finish;
}
if (arg_action == ACTION_PRINT_HEADER) {
return EXIT_SUCCESS;
}
if (arg_action == ACTION_DISK_USAGE) {
char sbytes[FORMAT_BYTES_MAX];
r = sd_journal_get_usage(j, &bytes);
if (r < 0)
return EXIT_FAILURE;
printf("Journals take up %s on disk.\n",
return EXIT_SUCCESS;
}
r = add_this_boot(j);
if (r < 0)
return EXIT_FAILURE;
r = add_dmesg(j);
if (r < 0)
return EXIT_FAILURE;
r = add_units(j);
if (r < 0)
return EXIT_FAILURE;
r = add_priorities(j);
if (r < 0)
return EXIT_FAILURE;
if (r < 0)
return EXIT_FAILURE;
if (arg_field) {
const void *data;
r = sd_journal_set_data_threshold(j, 0);
if (r < 0) {
log_error("Failed to unset data size threshold");
return EXIT_FAILURE;
}
r = sd_journal_query_unique(j, arg_field);
if (r < 0) {
return EXIT_FAILURE;
}
const void *eq;
break;
if (eq)
printf("%.*s\n", (int) (size - ((const uint8_t*) eq - (const uint8_t*) data + 1)), (const char*) eq + 1);
else
n_shown ++;
}
return EXIT_SUCCESS;
}
/* Opening the fd now means the first sd_journal_wait() will actually wait */
if (arg_follow) {
r = sd_journal_get_fd(j);
if (r < 0)
return EXIT_FAILURE;
}
if (arg_cursor) {
r = sd_journal_seek_cursor(j, arg_cursor);
if (r < 0) {
return EXIT_FAILURE;
}
if (!arg_reverse)
r = sd_journal_next(j);
else
r = sd_journal_previous(j);
} else if (arg_since_set && !arg_reverse) {
r = sd_journal_seek_realtime_usec(j, arg_since);
if (r < 0) {
return EXIT_FAILURE;
}
r = sd_journal_next(j);
} else if (arg_until_set && arg_reverse) {
r = sd_journal_seek_realtime_usec(j, arg_until);
if (r < 0) {
return EXIT_FAILURE;
}
r = sd_journal_previous(j);
} else if (arg_lines >= 0) {
r = sd_journal_seek_tail(j);
if (r < 0) {
return EXIT_FAILURE;
}
r = sd_journal_previous_skip(j, arg_lines);
} else if (arg_reverse) {
r = sd_journal_seek_tail(j);
if (r < 0) {
return EXIT_FAILURE;
}
r = sd_journal_previous(j);
} else {
r = sd_journal_seek_head(j);
if (r < 0) {
return EXIT_FAILURE;
}
r = sd_journal_next(j);
}
if (r < 0) {
return EXIT_FAILURE;
}
if (!arg_no_pager && !arg_follow)
if (!arg_quiet) {
if (r < 0) {
goto finish;
}
if (r > 0) {
if (arg_follow)
printf("-- Logs begin at %s. --\n",
else
printf("-- Logs begin at %s, end at %s. --\n",
}
}
for (;;) {
int flags;
if (need_seek) {
if (!arg_reverse)
r = sd_journal_next(j);
else
r = sd_journal_previous(j);
if (r < 0) {
goto finish;
}
if (r == 0)
break;
}
if (arg_until_set && !arg_reverse) {
r = sd_journal_get_realtime_usec(j, &usec);
if (r < 0) {
goto finish;
}
goto finish;
}
if (arg_since_set && arg_reverse) {
r = sd_journal_get_realtime_usec(j, &usec);
if (r < 0) {
goto finish;
}
goto finish;
}
if (!arg_merge) {
if (r >= 0) {
if (previous_boot_id_valid &&
previous_boot_id_valid = true;
}
}
flags =
on_tty() * OUTPUT_COLOR |
need_seek = true;
if (r == -EADDRNOTAVAIL)
break;
goto finish;
n_shown++;
}
if (!arg_follow)
break;
if (r < 0) {
goto finish;
}
first_line = false;
}
pager_close();
return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
}