freeswan/utils/barf.8

   1 .TH IPSEC_BARF 8 "17 March 2002"
   2 .\" RCSID $Id: barf.8,v 1.20 2002/03/18 00:29:51 henry Exp $
   3 .SH NAME
   4 ipsec barf \- spew out collected IPsec debugging information
   5 .br
   6 ipsec look \- show minimal debugging information
   7 .SH SYNOPSIS
   8 .B ipsec
   9 .B barf
  10 [
  11 .B \-\-short
  12 ]
  13 .sp
  14 .B ipsec
  15 .B look
  16 .SH DESCRIPTION
  17 .I Barf
  18 outputs (on standard output) a collection of debugging information
  19 (contents of files, selections from logs, etc.)
  20 related to the IPsec encryption/authentication system.
  21 It is primarily a convenience for remote debugging,
  22 a single command which packages up (and labels) all information
  23 that might be relevant to diagnosing a problem in IPsec.
  24 .PP
  25 .I Look
  26 outputs a minimal subset of this,
  27 intended as a quick look at current connections and related information,
  28 in a somewhat less self-explanatory format optimized for terseness.
  29 .PP
  30 The
  31 .B \-\-short
  32 option limits the length of
  33 the log portion of
  34 .IR barf 's
  35 output, which can otherwise be extremely voluminous
  36 if debug logging is turned on.
  37 .PP
  38 .I Barf
  39 censors its output,
  40 replacing keys
  41 and secrets with brief checksums to avoid revealing sensitive information.
  42 .I Look
  43 output does not contain such information.
  44 .PP
  45 Beware that the output of both commands is aimed at humans,
  46 not programs,
  47 and the output format is subject to change without warning.
  48 .PP
  49 .I Barf
  50 has to figure out which files in
  51 .I /var/log
  52 contain the IPsec log messages.
  53 It looks for KLIPS and general log messages first in
  54 .IR messages
  55 and
  56 .IR syslog ,
  57 and for Pluto messages first in
  58 .IR secure ,
  59 .IR auth.log ,
  60 and
  61 .IR debug .
  62 In both cases,
  63 if it does not find what it is looking for in one of those ``likely'' places,
  64 it will resort to a brute-force search of most (non-compressed) files in
  65 .IR /var/log .
  66 .SH FILES
  67 .nf
  68 /proc/net/*
  69 /var/log/*
  70 /etc/ipsec.conf
  71 /etc/ipsec.secrets
  72 .fi
  73 .SH HISTORY
  74 Written for the Linux FreeS/WAN project
  75 <http://www.freeswan.org>
  76 by Henry Spencer.
  77 .SH BUGS
  78 .I Barf
  79 uses heuristics to try to pick relevant material out of the logs,
  80 and relevant messages
  81 which are not labelled with any of the tags that
  82 .I barf
  83 looks for will be lost.
  84 We think we've eliminated the last such case, but one never knows...
  85 .PP
  86 Finding
  87 .I updown
  88 scripts (so they can be included in output) is, in general, difficult.
  89 .I Barf
  90 uses a very simple heuristic that is easily fooled.
  91 .PP
  92 The brute-force search for the right log files can get expensive on
  93 systems with a lot of clutter in
  94 .IR /var/log .