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

« back to all changes in this revision

Viewing changes to programs/klipsdebug/klipsdebug.5.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
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:
 
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>5</manvolnum>
 
9
<refmiscinfo class='date'>26 Jun 2000</refmiscinfo>
 
10
</refmeta>
 
11
<refnamediv id='name'>
 
12
<refname>ipsec_klipsdebug</refname>
 
13
<refpurpose>list 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>cat/proc/net/ipsec_klipsdebug</replaceable></arg>
 
22
</cmdsynopsis>
 
23
</refsynopsisdiv>
 
24
 
 
25
 
 
26
<refsect1 id='description'><title>DESCRIPTION</title>
 
27
<para><filename>/proc/net/ipsec_klipsdebug</filename>
 
28
lists flags that control various parts of the debugging output of Klips
 
29
(the kernel portion of FreeS/WAN IPSEC).
 
30
At this point it is a read-only file.</para>
 
31
 
 
32
<para>A table entry consists of:</para>
 
33
<variablelist remap='IP'>
 
34
  <varlistentry>
 
35
  <term>+</term>
 
36
  <listitem>
 
37
<para>a KLIPS debug variable</para>
 
38
  </listitem>
 
39
  </varlistentry>
 
40
  <varlistentry>
 
41
  <term>+</term>
 
42
  <listitem>
 
43
<para>a '=' separator for visual and automated parsing between the variable
 
44
name and its current value</para>
 
45
  </listitem>
 
46
  </varlistentry>
 
47
  <varlistentry>
 
48
  <term>+</term>
 
49
  <listitem>
 
50
<para>hexadecimal bitmap of variable's flags.</para>
 
51
  </listitem>
 
52
  </varlistentry>
 
53
</variablelist>
 
54
 
 
55
<para>The variable names roughly describe the scope of the debugging variable.
 
56
Currently, no flags are documented or individually accessible yet except
 
57
tunnel-xmit.</para>
 
58
<!-- .ne 5 -->
 
59
 
 
60
<para>The variable names are:</para>
 
61
<variablelist remap='TP'>
 
62
  <varlistentry>
 
63
  <term><emphasis remap='B'>tunnel</emphasis></term>
 
64
  <listitem>
 
65
<para>tunnelling code</para>
 
66
  </listitem>
 
67
  </varlistentry>
 
68
  <varlistentry>
 
69
  <term><emphasis remap='B'>netlink</emphasis></term>
 
70
  <listitem>
 
71
<para>userspace communication code (obsolete)</para>
 
72
  </listitem>
 
73
  </varlistentry>
 
74
  <varlistentry>
 
75
  <term><emphasis remap='B'>xform</emphasis></term>
 
76
  <listitem>
 
77
<para>transform selection and manipulation code</para>
 
78
  </listitem>
 
79
  </varlistentry>
 
80
  <varlistentry>
 
81
  <term><emphasis remap='B'>eroute</emphasis></term>
 
82
  <listitem>
 
83
<para>eroute table manipulation code</para>
 
84
  </listitem>
 
85
  </varlistentry>
 
86
  <varlistentry>
 
87
  <term><emphasis remap='B'>spi</emphasis></term>
 
88
  <listitem>
 
89
<para>SA table manipulation code</para>
 
90
  </listitem>
 
91
  </varlistentry>
 
92
  <varlistentry>
 
93
  <term><emphasis remap='B'>radij</emphasis></term>
 
94
  <listitem>
 
95
<para>radij tree manipulation code</para>
 
96
  </listitem>
 
97
  </varlistentry>
 
98
  <varlistentry>
 
99
  <term><emphasis remap='B'>esp</emphasis></term>
 
100
  <listitem>
 
101
<para>encryptions transforms code</para>
 
102
  </listitem>
 
103
  </varlistentry>
 
104
  <varlistentry>
 
105
  <term><emphasis remap='B'>ah</emphasis></term>
 
106
  <listitem>
 
107
<para>authentication transforms code</para>
 
108
  </listitem>
 
109
  </varlistentry>
 
110
  <varlistentry>
 
111
  <term><emphasis remap='B'>rcv</emphasis></term>
 
112
  <listitem>
 
113
<para>receive code</para>
 
114
  </listitem>
 
115
  </varlistentry>
 
116
  <varlistentry>
 
117
  <term><emphasis remap='B'>ipcomp</emphasis></term>
 
118
  <listitem>
 
119
<para>ip compression transforms code</para>
 
120
  </listitem>
 
121
  </varlistentry>
 
122
  <varlistentry>
 
123
  <term><emphasis remap='B'>verbose</emphasis></term>
 
124
  <listitem>
 
125
<para>give even more information, beware this will probably trample the 4k kernel printk buffer giving inaccurate output</para>
 
126
  </listitem>
 
127
  </varlistentry>
 
128
</variablelist>
 
129
 
 
130
<para>All KLIPS debug output appears as
 
131
<emphasis remap='B'>kernel.info</emphasis>
 
132
messages to
 
133
<citerefentry><refentrytitle>syslogd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
134
Most systems are set up
 
135
to log these messages to
 
136
<filename>/var/log/messages</filename>.</para>
 
137
 
 
138
</refsect1>
 
139
 
 
140
<refsect1 id='examples'><title>EXAMPLES</title>
 
141
<para><emphasis remap='B'>debug_tunnel=00000010.</emphasis>
 
142
<!-- .br -->
 
143
<emphasis remap='B'>debug_netlink=00000000.</emphasis>
 
144
<!-- .br -->
 
145
<emphasis remap='B'>debug_xform=00000000.</emphasis>
 
146
<!-- .br -->
 
147
<emphasis remap='B'>debug_eroute=00000000.</emphasis>
 
148
<!-- .br -->
 
149
<emphasis remap='B'>debug_spi=00000000.</emphasis>
 
150
<!-- .br -->
 
151
<emphasis remap='B'>debug_radij=00000000.</emphasis>
 
152
<!-- .br -->
 
153
<emphasis remap='B'>debug_esp=00000000.</emphasis>
 
154
<!-- .br -->
 
155
<emphasis remap='B'>debug_ah=00000000.</emphasis>
 
156
<!-- .br -->
 
157
<emphasis remap='B'>debug_rcv=00000000.</emphasis>
 
158
<!-- .br -->
 
159
<emphasis remap='B'>debug_pfkey=ffffffff.</emphasis></para>
 
160
 
 
161
<para>means that one
 
162
<emphasis remap='B'>tunnel</emphasis>
 
163
flag has been set (tunnel-xmit),
 
164
full
 
165
<emphasis remap='B'>pfkey</emphasis>
 
166
sockets debugging has been set and everything else is not set.</para>
 
167
 
 
168
</refsect1>
 
169
 
 
170
<refsect1 id='files'><title>FILES</title>
 
171
<para>/proc/net/ipsec_klipsdebug, /usr/local/bin/ipsec</para>
 
172
</refsect1>
 
173
 
 
174
<refsect1 id='see_also'><title>SEE ALSO</title>
 
175
<para>ipsec(8), ipsec_manual(8), ipsec_tncfg(8), ipsec_eroute(8),
 
176
ipsec_spi(8), ipsec_spigrp(8), ipsec_klipsdebug(5), ipsec_version(5),
 
177
ipsec_pf_key(5)</para>
 
178
</refsect1>
 
179
 
 
180
<refsect1 id='history'><title>HISTORY</title>
 
181
<para>Written for the Linux FreeS/WAN project
 
182
&lt;<ulink url='http://www.freeswan.org/'>http://www.freeswan.org/</ulink>&gt;
 
183
by Richard Guy Briggs.</para>
 
184
 
 
185
<!--  $Log: klipsdebug.5.xml,v $
 
186
<!--  Revision 1.1  2004/05/26 17:49:15  ken
 
187
<!--  Import XML version
 
188
<!-- -->
 
189
<!--  Revision 1.5  2002/04/24 07:35:38  mcr -->
 
190
<!--  Moved from ./klips/utils/klipsdebug.5,v -->
 
191
 
 
192
<!--  Revision 1.4  2000/10/10 20:10:19  rgb -->
 
193
<!--  Added support for debug_ipcomp and debug_verbose to klipsdebug. -->
 
194
 
 
195
<!--  Revision 1.3  2000/06/30 18:21:55  rgb -->
 
196
<!--  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> -->
 
197
<!--  and correct FILES sections to no longer refer to /dev/ipsec which has -->
 
198
<!--  been removed since PF_KEY does not use it. -->
 
199
 
 
200
<!--  Revision 1.2  2000/06/28 12:44:12  henry -->
 
201
<!--  format touchup -->
 
202
 
 
203
<!--  Revision 1.1  2000/06/28 05:43:00  rgb -->
 
204
<!--  Added manpages for all 5 klips utils. -->
 
205
 
 
206
 
 
207
 
 
208
</refsect1>
 
209
</refentry>
 
210