← Back to branch summary

~ubuntu-branches/ubuntu/hardy/openswan/hardy-updates

« back to all changes in this revision

Viewing changes to programs/klipsdebug/klipsdebug.8.xml

  • Committer: Bazaar Package Importer
  • Author(s): Rene Mayrhofer
  • Date: 2005-01-27 16:10:11 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050127161011-idgybmyz3vwhpfiq
Tags: 2.3.0-2
http://bugs.debian.org/292458
http://bugs.debian.org/291143
Urgency HIGH due to security issue and problems with build-deps in sarge.
* Fix the security issue. Please see
  http://www.idefense.com/application/poi/display?id=190&
      type=vulnerabilities&flashstatus=false
  for more details. Thanks to Martin Schulze for informing me about
  this issue.
  Closes: #292458: Openswan XAUTH/PAM Buffer Overflow Vulnerability
* Added a Build-Dependency to lynx.
  Closes: #291143: openswan: FTBFS: Missing build dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
programs/klipsdebug/klipsdebug.8.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<!-- lifted from troff+man by doclifter -->
 
5
<refentry>
 
6
<refmeta>
 
7
<refentrytitle>IPSEC_KLIPSDEBUG</refentrytitle>
 
8
<manvolnum>8</manvolnum>
 
9
<refmiscinfo class='date'>21 Jun 2000</refmiscinfo>
 
10
</refmeta>
 
11
<refnamediv id='name'>
 
12
<refname>ipsec klipsdebug</refname>
 
13
<refpurpose>set KLIPS (kernel IPSEC support) debug features and level</refpurpose>
 
14
</refnamediv>
 
15
<!-- body begins here -->
 
16
<refsynopsisdiv id='synopsis'>
 
17
<cmdsynopsis>
 
18
  <command>ipsec</command>    
 
19
    <arg choice='plain'><replaceable>klipsdebug</replaceable></arg>
 
20
    <sbr/>
 
21
    <arg choice='plain'><replaceable>ipsecklipsdebug</replaceable></arg>
 
22
    <arg choice='plain'>--set </arg>
 
23
    <arg choice='plain'><replaceable>flagname</replaceable></arg>
 
24
    <sbr/>
 
25
    <arg choice='plain'><replaceable>ipsecklipsdebug</replaceable></arg>
 
26
    <arg choice='plain'>--clear </arg>
 
27
    <arg choice='plain'><replaceable>flagname</replaceable></arg>
 
28
    <sbr/>
 
29
    <arg choice='plain'><replaceable>ipsecklipsdebug</replaceable></arg>
 
30
    <arg choice='plain'>--all </arg>
 
31
    <sbr/>
 
32
    <arg choice='plain'><replaceable>ipsecklipsdebug</replaceable></arg>
 
33
    <arg choice='plain'>--none </arg>
 
34
    <sbr/>
 
35
    <arg choice='plain'><replaceable>ipsecklipsdebug</replaceable></arg>
 
36
    <arg choice='plain'>--help </arg>
 
37
    <sbr/>
 
38
    <arg choice='plain'><replaceable>ipsecklipsdebug</replaceable></arg>
 
39
    <arg choice='plain'>--version </arg>
 
40
</cmdsynopsis>
 
41
</refsynopsisdiv>
 
42
 
 
43
 
 
44
<refsect1 id='description'><title>DESCRIPTION</title>
 
45
<para><emphasis remap='I'>Klipsdebug</emphasis>
 
46
sets and clears flags that control
 
47
various parts of the debugging output of Klips
 
48
(the kernel portion of FreeS/WAN IPSEC).
 
49
The form with no additional arguments lists the present contents of
 
50
/proc/net/ipsec_klipsdebug.
 
51
The
 
52
<option>--set</option>
 
53
form turns the specified flag on,
 
54
while the
 
55
<option>--clear</option>
 
56
form turns the specified flag off.
 
57
The 
 
58
<option>--all</option>
 
59
form 
 
60
turns all flags on except verbose, while the
 
61
<option>--none</option>
 
62
form turns all flags off.</para>
 
63
 
 
64
<para>The current flag names are:</para>
 
65
<variablelist remap='TP'>
 
66
  <varlistentry>
 
67
  <term><emphasis remap='B'>tunnel</emphasis></term>
 
68
  <listitem>
 
69
<para>tunnelling code</para>
 
70
  </listitem>
 
71
  </varlistentry>
 
72
  <varlistentry>
 
73
  <term><emphasis remap='B'>tunnel-xmit</emphasis></term>
 
74
  <listitem>
 
75
<para>tunnelling transmit only code</para>
 
76
  </listitem>
 
77
  </varlistentry>
 
78
  <varlistentry>
 
79
  <term><emphasis remap='B'>pfkey</emphasis></term>
 
80
  <listitem>
 
81
<para>userspace communication code</para>
 
82
  </listitem>
 
83
  </varlistentry>
 
84
  <varlistentry>
 
85
  <term><emphasis remap='B'>xform</emphasis></term>
 
86
  <listitem>
 
87
<para>transform selection and manipulation code</para>
 
88
  </listitem>
 
89
  </varlistentry>
 
90
  <varlistentry>
 
91
  <term><emphasis remap='B'>eroute</emphasis></term>
 
92
  <listitem>
 
93
<para>eroute table manipulation code</para>
 
94
  </listitem>
 
95
  </varlistentry>
 
96
  <varlistentry>
 
97
  <term><emphasis remap='B'>spi</emphasis></term>
 
98
  <listitem>
 
99
<para>SA table manipulation code</para>
 
100
  </listitem>
 
101
  </varlistentry>
 
102
  <varlistentry>
 
103
  <term><emphasis remap='B'>radij</emphasis></term>
 
104
  <listitem>
 
105
<para>radij tree manipulation code</para>
 
106
  </listitem>
 
107
  </varlistentry>
 
108
  <varlistentry>
 
109
  <term><emphasis remap='B'>esp</emphasis></term>
 
110
  <listitem>
 
111
<para>encryptions transforms code</para>
 
112
  </listitem>
 
113
  </varlistentry>
 
114
  <varlistentry>
 
115
  <term><emphasis remap='B'>ah</emphasis></term>
 
116
  <listitem>
 
117
<para>authentication transforms code
 
118
<emphasis remap='B'>rcv</emphasis>
 
119
receive code</para>
 
120
  </listitem>
 
121
  </varlistentry>
 
122
  <varlistentry>
 
123
  <term><emphasis remap='B'>ipcomp</emphasis></term>
 
124
  <listitem>
 
125
<para>ip compression transforms code</para>
 
126
  </listitem>
 
127
  </varlistentry>
 
128
  <varlistentry>
 
129
  <term><emphasis remap='B'>verbose</emphasis></term>
 
130
  <listitem>
 
131
<para>give even more information, BEWARE:
 
132
a)this will print authentication and encryption keys in the logs
 
133
b)this will probably trample the 4k kernel printk buffer giving inaccurate output</para>
 
134
  </listitem>
 
135
  </varlistentry>
 
136
</variablelist>
 
137
 
 
138
<para>All Klips debug output appears as
 
139
<emphasis remap='B'>kernel.info</emphasis>
 
140
messages to
 
141
<citerefentry><refentrytitle>syslogd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
142
Most systems are set up
 
143
to log these messages to
 
144
<filename>/var/log/messages</filename>.
 
145
Beware that
 
146
<emphasis remap='B'>klipsdebug</emphasis>
 
147
<option>--all</option>
 
148
produces a lot of output and the log file will grow quickly.</para>
 
149
 
 
150
<para>The file format for /proc/net/ipsec_klipsdebug is discussed in
 
151
ipsec_klipsdebug(5).</para>
 
152
</refsect1>
 
153
 
 
154
<refsect1 id='examples'><title>EXAMPLES</title>
 
155
<variablelist remap='TP'>
 
156
  <varlistentry>
 
157
  <term><userinput>klipsdebug --all</userinput></term>
 
158
  <listitem>
 
159
<para>turns on all KLIPS debugging except verbose.</para>
 
160
  </listitem>
 
161
  </varlistentry>
 
162
  <varlistentry>
 
163
  <term><userinput>klipsdebug --clear tunnel</userinput></term>
 
164
  <listitem>
 
165
<para>turns off only the
 
166
<emphasis remap='B'>tunnel</emphasis>
 
167
debugging messages.</para>
 
168
  </listitem>
 
169
  </varlistentry>
 
170
</variablelist>
 
171
 
 
172
</refsect1>
 
173
 
 
174
<refsect1 id='files'><title>FILES</title>
 
175
<para>/proc/net/ipsec_klipsdebug, /usr/local/bin/ipsec</para>
 
176
</refsect1>
 
177
 
 
178
<refsect1 id='see_also'><title>SEE ALSO</title>
 
179
<para>ipsec(8), ipsec_manual(8), ipsec_tncfg(8), ipsec_eroute(8),
 
180
ipsec_spi(8), ipsec_spigrp(8), ipsec_klipsdebug(5)</para>
 
181
</refsect1>
 
182
 
 
183
<refsect1 id='history'><title>HISTORY</title>
 
184
<para>Written for the Linux FreeS/WAN project
 
185
&lt;<ulink url='http://www.freeswan.org/'>http://www.freeswan.org/</ulink>&gt;
 
186
by Richard Guy Briggs.</para>
 
187
</refsect1>
 
188
 
 
189
<refsect1 id='bugs'><title>BUGS</title>
 
190
<para>It really ought to be possible to set or unset selective combinations
 
191
of flags.</para>
 
192
 
 
193
<!--  $Log: klipsdebug.8.xml,v $
 
194
<!--  Revision 1.1  2004/05/26 17:49:20  ken
 
195
<!--  Import XML version
 
196
<!-- -->
 
197
<!--  Revision 1.18  2002/04/24 07:35:39  mcr -->
 
198
<!--  Moved from ./klips/utils/klipsdebug.8,v -->
 
199
 
 
200
<!--  Revision 1.17  2000/10/10 20:10:19  rgb -->
 
201
<!--  Added support for debug_ipcomp and debug_verbose to klipsdebug. -->
 
202
 
 
203
<!--  Revision 1.16  2000/08/18 17:33:11  rgb -->
 
204
<!--  Updated obsolete netlink reference and added pfkey and tunnel\-xmit. -->
 
205
 
 
206
<!--  Revision 1.15  2000/06/30 18:21:55  rgb -->
 
207
<!--  Update SEE ALSO sections to include <citerefentry><refentrytitle>ipsec_version</refentrytitle><manvolnum>5</manvolnum></citerefentry> and <citerefentry><refentrytitle>ipsec_pf_key</refentrytitle><manvolnum>5</manvolnum></citerefentry> -->
 
208
<!--  and correct FILES sections to no longer refer to /dev/ipsec which has -->
 
209
<!--  been removed since PF_KEY does not use it. -->
 
210
 
 
211
<!--  Revision 1.14  2000/06/28 05:53:09  rgb -->
 
212
<!--  Mention that netlink is obsolete. -->
 
213
 
 
214
<!--  Revision 1.13  2000/06/21 16:54:58  rgb -->
 
215
<!--  Added 'no additional args' text for listing contents of -->
 
216
<!--  /proc/net/ipsec_* files. -->
 
217
 
 
218
<!--  Revision 1.12  1999/07/19 18:47:24  henry -->
 
219
<!--  fix slightly\-misformed comments -->
 
220
 
 
221
<!--  Revision 1.11  1999/04/06 04:54:37  rgb -->
 
222
<!--  Fix/Add RCSID Id: and Log: bits to make PHMDs happy.  This includes -->
 
223
<!--  patch shell fixes. -->
 
224
 
 
225
 
 
226
</refsect1>
 
227
</refentry>
 
228