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

« back to all changes in this revision

Viewing changes to doc/manpage.d/ipsec_spi.5.html

  • 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
 
Content-type: text/html
2
 
 
3
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
 
<HTML><HEAD><TITLE>Man page of IPSEC_SPI</TITLE>
5
 
</HEAD><BODY>
6
 
<H1>IPSEC_SPI</H1>
7
 
Section: File Formats (5)<BR>Updated: 26 Jun 2000<BR><A HREF="#index">Index</A>
8
 
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
9
 
 
10
 
 
11
 
 
12
 
 
13
 
<A NAME="lbAB">&nbsp;</A>
14
 
<H2>NAME</H2>
15
 
 
16
 
ipsec_spi - list IPSEC Security Associations
17
 
<A NAME="lbAC">&nbsp;</A>
18
 
<H2>SYNOPSIS</H2>
19
 
 
20
 
<B>ipsec</B>
21
 
 
22
 
<B>spi</B>
23
 
 
24
 
<P>
25
 
 
26
 
<B>cat</B>
27
 
 
28
 
<B>/proc/net/ipsec_spi</B>
29
 
 
30
 
<P>
31
 
 
32
 
<A NAME="lbAD">&nbsp;</A>
33
 
<H2>DESCRIPTION</H2>
34
 
 
35
 
<I>/proc/net/ipsec_spi</I>
36
 
 
37
 
is a read-only file that lists the current IPSEC Security Associations.
38
 
A Security Association (SA) is a transform through which packet contents
39
 
are to be processed before being forwarded.  A transform can be an
40
 
IPv4-in-IPv4 or IPv6-in-IPv6 encapsulation, an IPSEC Authentication Header (authentication
41
 
with no encryption), or an IPSEC Encapsulation Security Payload
42
 
(encryption, possibly including authentication).
43
 
<P>
44
 
 
45
 
When a packet is passed from a higher networking layer through an IPSEC
46
 
virtual interface, a search in the extended routing table (see
47
 
<I><A HREF="/cgi-bin/man/man2html?5+ipsec_eroute">ipsec_eroute</A></I>(5))
48
 
 
49
 
yields
50
 
a IP protocol number
51
 
,
52
 
a Security Parameters Index (SPI)
53
 
and
54
 
an effective destination address
55
 
When an IPSEC packet arrives from the network,
56
 
its ostensible destination, an SPI and an IP protocol
57
 
specified by its outermost IPSEC header are used.
58
 
The destination/SPI/protocol combination is used to select a relevant SA.
59
 
(See
60
 
<I><A HREF="/cgi-bin/man/man2html?5+ipsec_spigrp">ipsec_spigrp</A></I>(5)
61
 
 
62
 
for discussion of how multiple transforms are combined.)
63
 
<P>
64
 
 
65
 
An
66
 
<I>spi ,</I>
67
 
 
68
 
<I>proto, </I>
69
 
 
70
 
<I>daddr</I>
71
 
 
72
 
and
73
 
<I>address_family</I>
74
 
 
75
 
arguments specify an SAID.
76
 
<I>Proto</I>
77
 
 
78
 
is an ASCII string, &quot;ah&quot;, &quot;esp&quot;, &quot;comp&quot; or &quot;tun&quot;, specifying the IP protocol.
79
 
<I>Spi</I>
80
 
 
81
 
is a number, preceded by '.' indicating hexadecimal and IPv4 or by ':' indicating hexadecimal and IPv6,
82
 
where each hexadecimal digit represents 4 bits,
83
 
between
84
 
<B>0x100</B>
85
 
 
86
 
and
87
 
<B>0xffffffff</B>;
88
 
 
89
 
values from
90
 
<B>0x0</B>
91
 
 
92
 
to
93
 
<B>0xff</B>
94
 
 
95
 
are reserved.
96
 
<I>Daddr</I>
97
 
 
98
 
is a dotted-decimal IPv4 destination address or a coloned hex IPv6 destination address.
99
 
<P>
100
 
 
101
 
An
102
 
<I>SAID</I>
103
 
 
104
 
combines the three parameters above, such as: &quot;<A HREF="mailto:tun.101@1.2.3.4">tun.101@1.2.3.4</A>&quot; for IPv4 or &quot;tun:<A HREF="mailto:101@3049">101@3049</A>:1::1&quot; for IPv6
105
 
<P>
106
 
 
107
 
A table entry consists of:
108
 
<DL COMPACT>
109
 
<DT>+<DD>
110
 
<B>SAID</B>
111
 
 
112
 
<DT>+<DD>
113
 
&lt;transform name (proto,encalg,authalg)&gt;:
114
 
<DT>+<DD>
115
 
direction (dir=)
116
 
<DT>+<DD>
117
 
source address (src=)
118
 
<DT>+<DD>
119
 
source and destination addresses and masks for inner header policy check
120
 
addresses (policy=), as dotted-quads or coloned hex, separated by '-&gt;',
121
 
for IPv4-in-IPv4 or IPv6-in-IPv6 SAs only
122
 
<DT>+<DD>
123
 
initialisation vector length and value (iv_bits=, iv=) if non-zero
124
 
<DT>+<DD>
125
 
out-of-order window size, number of out-of-order errors, sequence
126
 
number, recently received packet bitmask, maximum difference between
127
 
sequence numbers (ooowin=, ooo_errs=, seq=, bit=, max_seq_diff=) if SA
128
 
is AH or ESP and if individual items are non-zero
129
 
<DT>+<DD>
130
 
extra flags (flags=) if any are set
131
 
<DT>+<DD>
132
 
authenticator length in bits (alen=) if non-zero
133
 
<DT>+<DD>
134
 
authentication key length in bits (aklen=) if non-zero
135
 
<DT>+<DD>
136
 
authentication errors (auth_errs=) if non-zero
137
 
<DT>+<DD>
138
 
encryption key length in bits (eklen=) if non-zero
139
 
<DT>+<DD>
140
 
encryption size errors (encr_size_errs=) if non-zero
141
 
<DT>+<DD>
142
 
encryption padding error warnings (encr_pad_errs=) if non-zero
143
 
<DT>+<DD>
144
 
lifetimes legend, c=Current status, s=Soft limit when exceeded will
145
 
initiate rekeying, h=Hard limit will cause termination of SA (life(c,s,h)=)
146
 
<DT>+<DD>
147
 
number of connections to which the SA is allocated (c), that will cause a
148
 
rekey (s), that will cause an expiry (h) (alloc=), if any value is non-zero
149
 
<DT>+<DD>
150
 
number of bytes processesd by this SA (c), that will cause a rekey (s), that
151
 
will cause an expiry (h) (bytes=), if any value is non-zero
152
 
<DT>+<DD>
153
 
time since the SA was added (c), until rekey (s), until expiry (h), in seconds (add=)
154
 
<DT>+<DD>
155
 
time since the SA was first used (c), until rekey (s), until expiry (h), in seconds (used=),
156
 
if any value is non-zero
157
 
<DT>+<DD>
158
 
number of packets processesd by this SA (c), that will cause a rekey (s), that
159
 
will cause an expiry (h) (packets=), if any value is non-zero
160
 
<DT>+<DD>
161
 
time since the last packet was processed, in seconds (idle=), if SA has
162
 
been used
163
 
<DT><DD>
164
 
average compression ratio (ratio=)
165
 
</DL>
166
 
<A NAME="lbAE">&nbsp;</A>
167
 
<H2>EXAMPLES</H2>
168
 
 
169
 
<B><A HREF="mailto:tun.12a@192.168.43.1">tun.12a@192.168.43.1</A> IPIP: dir=out src=192.168.43.2</B>
170
 
 
171
 
<BR>
172
 
 
173
 
<B>      life(c,s,h)=bytes(14073,0,0)add(269,0,0)</B>
174
 
 
175
 
<BR>
176
 
 
177
 
<B>      use(149,0,0)packets(14,0,0)</B>
178
 
 
179
 
<BR>
180
 
 
181
 
<B>      idle=23</B>
182
 
 
183
 
<P>
184
 
 
185
 
is an outbound IPv4-in-IPv4 (protocol 4) tunnel-mode SA set up between machines
186
 
192.168.43.2 and 192.168.43.1 with an SPI of 12a in hexadecimal that has
187
 
passed about 14 kilobytes of traffic in 14 packets since it was created,
188
 
269 seconds ago, first used 149 seconds ago and has been idle for 23
189
 
seconds.
190
 
<P>
191
 
 
192
 
<B>esp:<A HREF="mailto:9a35fc02@3049">9a35fc02@3049</A>:1::1 ESP_3DES_HMAC_MD5:</B>
193
 
 
194
 
<BR>
195
 
 
196
 
<B>      dir=in src=<A HREF="mailto:9a35fc02@3049">9a35fc02@3049</A>:1::2</B>
197
 
 
198
 
<BR>
199
 
 
200
 
<B>      ooowin=32 seq=7149 bit=0xffffffff</B>
201
 
 
202
 
<BR>
203
 
 
204
 
<B>      alen=128 aklen=128 eklen=192</B>
205
 
 
206
 
<BR>
207
 
 
208
 
<B>      life(c,s,h)=bytes(1222304,0,0)add(4593,0,0)</B>
209
 
 
210
 
<BR>
211
 
 
212
 
<B>      use(3858,0,0)packets(7149,0,0)</B>
213
 
 
214
 
<BR>
215
 
 
216
 
<B>      idle=23</B>
217
 
 
218
 
<P>
219
 
 
220
 
is an inbound Encapsulating Security Payload (protocol 50) SA on machine
221
 
3049:1::1 with an SPI of 9a35fc02 that uses 3DES as the encryption
222
 
cipher, HMAC MD5 as the authentication algorithm, an out-of-order
223
 
window of 32 packets, a present sequence number of 7149, every one of
224
 
the last 32 sequence numbers was received, the authenticator length and
225
 
keys is 128 bits, the encryption key is 192 bits (actually 168 for 3DES
226
 
since 1 of 8 bits is a parity bit), has passed 1.2 Mbytes of data in
227
 
7149 packets, was added 4593 seconds ago, first used
228
 
3858 seconds ago and has been idle for 23 seconds.
229
 
<P>
230
 
 
231
 
<A NAME="lbAF">&nbsp;</A>
232
 
<H2>FILES</H2>
233
 
 
234
 
/proc/net/ipsec_spi, /usr/local/bin/ipsec
235
 
<A NAME="lbAG">&nbsp;</A>
236
 
<H2>SEE ALSO</H2>
237
 
 
238
 
<A HREF="/cgi-bin/man/man2html?8+ipsec">ipsec</A>(8), <A HREF="/cgi-bin/man/man2html?8+ipsec_manual">ipsec_manual</A>(8), <A HREF="/cgi-bin/man/man2html?5+ipsec_tncfg">ipsec_tncfg</A>(5), <A HREF="/cgi-bin/man/man2html?5+ipsec_eroute">ipsec_eroute</A>(5),
239
 
<A HREF="/cgi-bin/man/man2html?5+ipsec_spigrp">ipsec_spigrp</A>(5), <A HREF="/cgi-bin/man/man2html?5+ipsec_klipsdebug">ipsec_klipsdebug</A>(5), <A HREF="/cgi-bin/man/man2html?8+ipsec_spi">ipsec_spi</A>(8), <A HREF="/cgi-bin/man/man2html?5+ipsec_version">ipsec_version</A>(5),
240
 
<A HREF="/cgi-bin/man/man2html?5+ipsec_pf_key">ipsec_pf_key</A>(5)
241
 
<A NAME="lbAH">&nbsp;</A>
242
 
<H2>HISTORY</H2>
243
 
 
244
 
Written for the Linux FreeS/WAN project
245
 
&lt;<A HREF="http://www.freeswan.org/">http://www.freeswan.org/</A>&gt;
246
 
by Richard Guy Briggs.
247
 
<A NAME="lbAI">&nbsp;</A>
248
 
<H2>BUGS</H2>
249
 
 
250
 
The add and use times are awkward, displayed in seconds since machine
251
 
start.  It would be better to display them in seconds before now for
252
 
human readability.
253
 
 
254
 
 
255
 
 
256
 
 
257
 
 
258
 
 
259
 
 
260
 
 
261
 
 
262
 
 
263
 
 
264
 
 
265
 
 
266
 
 
267
 
 
268
 
 
269
 
 
270
 
 
271
 
 
272
 
 
273
 
 
274
 
 
275
 
 
276
 
 
277
 
 
278
 
 
279
 
 
280
 
 
281
 
 
282
 
 
283
 
 
284
 
 
285
 
 
286
 
<P>
287
 
 
288
 
<HR>
289
 
<A NAME="index">&nbsp;</A><H2>Index</H2>
290
 
<DL>
291
 
<DT><A HREF="#lbAB">NAME</A><DD>
292
 
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
293
 
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
294
 
<DT><A HREF="#lbAE">EXAMPLES</A><DD>
295
 
<DT><A HREF="#lbAF">FILES</A><DD>
296
 
<DT><A HREF="#lbAG">SEE ALSO</A><DD>
297
 
<DT><A HREF="#lbAH">HISTORY</A><DD>
298
 
<DT><A HREF="#lbAI">BUGS</A><DD>
299
 
</DL>
300
 
<HR>
301
 
This document was created by
302
 
<A HREF="/cgi-bin/man/man2html">man2html</A>,
303
 
using the manual pages.<BR>
304
 
Time: 10:29:43 GMT, June 17, 2004
305
 
</BODY>
306
 
</HTML>