freeswan/doc/manpage.d/ipsec_spigrp.8.html

   1 Content-type: text/html
   2
   3 <HTML><HEAD><TITLE>Manpage of IPSEC_SPIGRP</TITLE>
   4 </HEAD><BODY>
   5 <H1>IPSEC_SPIGRP</H1>
   6 Section: Maintenance Commands (8)<BR>Updated: 21 Jun 2000<BR><A HREF="#index">Index</A>
   7 <A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
   8
   9
  10
  11
  12 <A NAME="lbAB">&nbsp;</A>
  13 <H2>NAME</H2>
  14
  15 ipsec spigrp - group/ungroup IPSEC Security Associations
  16 <A NAME="lbAC">&nbsp;</A>
  17 <H2>SYNOPSIS</H2>
  18
  19 <B>ipsec</B>
  20
  21 <B>spigrp</B>
  22
  23 <P>
  24
  25 <B>ipsec</B>
  26
  27 <B>spigrp</B>
  28
  29 [
  30 <B>--label</B>
  31
  32 label ]
  33 af1 dst1 spi1 proto1 [ af2 dst2 spi2 proto2 [ af3 dst3 spi3 proto3 [ af4 dst4 spi4 proto4 ] ] ]
  34 <P>
  35
  36 <B>ipsec</B>
  37
  38 <B>spigrp</B>
  39
  40 [
  41 <B>--label</B>
  42
  43 label ]
  44 <B>--said</B>
  45
  46 SA1 [ SA2 [ SA3 [ SA4 ] ] ]
  47 <P>
  48
  49 <B>ipsec</B>
  50
  51 <B>spigrp</B>
  52
  53 <B>--help</B>
  54
  55 <P>
  56
  57 <B>ipsec</B>
  58
  59 <B>spigrp</B>
  60
  61 <B>--version</B>
  62
  63 <P>
  64
  65 <A NAME="lbAD">&nbsp;</A>
  66 <H2>DESCRIPTION</H2>
  67
  68 <I>Spigrp</I>
  69
  70 groups IPSEC Security Associations (SAs) together or ungroups
  71 previously grouped SAs.
  72 An entry in the IPSEC extended
  73 routing table can only point
  74 (via a destination address, a Security Parameters Index (SPI) and
  75 a protocol identifier) to one SA.
  76 If more than one transform must be applied to a given type of packet,
  77 this can be accomplished by setting up several SAs
  78 with the same destination address but potentially different SPIs and protocols,
  79 and grouping them with
  80 <I>spigrp</I>.
  81
  82 <P>
  83
  84 The SAs to be grouped,
  85 specified by destination address (DNS name lookup, IPv4 dotted quad or IPv6 coloned hex), SPI
  86 ('0x'-prefixed hexadecimal number) and protocol (&quot;ah&quot;, &quot;esp&quot;, &quot;comp&quot; or &quot;tun&quot;),
  87 are listed from the inside transform to the
  88 outside;
  89 in other words, the transforms are applied in
  90 the order of the command line and removed in the reverse
  91 order.
  92 The resulting SA group is referred to by its first SA (by
  93 <I>af1</I>,
  94
  95 <I>dst1</I>,
  96
  97 <I>spi1</I>
  98
  99 and
 100 <I>proto1</I>).
 101
 102 <P>
 103
 104 The --said option indicates that the SA IDs are to be specified as
 105 one argument each, in the format &lt;proto&gt;&lt;af&gt;&lt;spi&gt;@&lt;dest&gt;.  The SA IDs must
 106 all be specified as separate parameters without the --said option or
 107 all as monolithic parameters after the --said option.
 108 <P>
 109
 110 The SAs must already exist and must not already
 111 be part of a group.
 112 <P>
 113
 114 If
 115 <I>spigrp</I>
 116
 117 is invoked with only one SA specification,
 118 it ungroups the previously-grouped set of SAs containing
 119 the SA specified.
 120 <P>
 121
 122 The --label option identifies all responses from that command
 123 invocation with a user-supplied label, provided as an argument to the
 124 label option.  This can be helpful for debugging one invocation of the
 125 command out of a large number.
 126 <P>
 127
 128 The command form with no additional arguments lists the contents of
 129 /proc/net/ipsec_spigrp.  The format of /proc/net/ipsec_spigrp is
 130 discussed in <A HREF="ipsec_spigrp.5.html">ipsec_spigrp</A>(5).
 131 <A NAME="lbAE">&nbsp;</A>
 132 <H2>EXAMPLES</H2>
 133
 134 <DL COMPACT>
 135 <DT><B>ipsec spigrp inet gw2 0x113 tun inet gw2 0x115 esp inet gw2 0x116 ah</B>
 136
 137 <DD>
 138 groups 3 SAs together, all destined for
 139 <B>gw2</B>,
 140
 141 but with an IPv4-in-IPv4 tunnel SA applied first with SPI
 142 <B>0x113</B>,
 143
 144 then an ESP header to encrypt the packet with SPI
 145 <B>0x115</B>,
 146
 147 and finally an AH header to authenticate the packet with SPI
 148 <B>0x116</B>.
 149
 150 </DL>
 151 <P>
 152
 153 <DL COMPACT>
 154 <DT><B>ipsec spigrp --said tun.113@gw2 esp.115@gw2 ah.116@gw2 </B>
 155
 156 <DD>
 157 groups 3 SAs together, all destined for
 158 <B>gw2</B>,
 159
 160 but with an IPv4-in-IPv4 tunnel SA applied first with SPI
 161 <B>0x113</B>,
 162
 163 then an ESP header to encrypt the packet with SPI
 164 <B>0x115</B>,
 165
 166 and finally an AH header to authenticate the packet with SPI
 167 <B>0x116</B>.
 168
 169 </DL>
 170 <P>
 171
 172 <DL COMPACT>
 173 <DT><B>ipsec spigrp --said tun:<A HREF="mailto:233@3049">233@3049</A>:1::1 esp:<A HREF="mailto:235@3049">235@3049</A>:1::1 ah:<A HREF="mailto:236@3049">236@3049</A>:1::1 </B>
 174
 175 <DD>
 176 groups 3 SAs together, all destined for
 177 <B>3049:1::1,</B>
 178
 179 but with an IPv6-in-IPv6 tunnel SA applied first with SPI
 180 <B>0x233</B>,
 181
 182 then an ESP header to encrypt the packet with SPI
 183 <B>0x235</B>,
 184
 185 and finally an AH header to authenticate the packet with SPI
 186 <B>0x236</B>.
 187
 188 </DL>
 189 <P>
 190
 191 <DL COMPACT>
 192 <DT><B>ipsec spigrp inet6 3049:1::1 0x233 tun inet6 3049:1::1 0x235 esp inet6 3049:1::1 0x236 ah</B>
 193
 194 <DD>
 195 groups 3 SAs together, all destined for
 196 <B>3049:1::1,</B>
 197
 198 but with an IPv6-in-IPv6 tunnel SA applied first with SPI
 199 <B>0x233</B>,
 200
 201 then an ESP header to encrypt the packet with SPI
 202 <B>0x235</B>,
 203
 204 and finally an AH header to authenticate the packet with SPI
 205 <B>0x236</B>.
 206
 207 </DL>
 208 <P>
 209
 210 <A NAME="lbAF">&nbsp;</A>
 211 <H2>FILES</H2>
 212
 213 /proc/net/ipsec_spigrp, /usr/local/bin/ipsec
 214 <A NAME="lbAG">&nbsp;</A>
 215 <H2>SEE ALSO</H2>
 216
 217 <A HREF="ipsec.8.html">ipsec</A>(8), <A HREF="ipsec_manual.8.html">ipsec_manual</A>(8), <A HREF="ipsec_tncfg.8.html">ipsec_tncfg</A>(8), <A HREF="ipsec_eroute.8.html">ipsec_eroute</A>(8),
 218 <A HREF="ipsec_spi.8.html">ipsec_spi</A>(8), <A HREF="ipsec_klipsdebug.8.html">ipsec_klipsdebug</A>(8), <A HREF="ipsec_spigrp.5.html">ipsec_spigrp</A>(5)
 219 <A NAME="lbAH">&nbsp;</A>
 220 <H2>HISTORY</H2>
 221
 222 Written for the Linux FreeS/WAN project
 223 &lt;<A HREF="http://www.freeswan.org/">http://www.freeswan.org/</A>&gt;
 224 by Richard Guy Briggs.
 225 <A NAME="lbAI">&nbsp;</A>
 226 <H2>BUGS</H2>
 227
 228 Yes, it really is limited to a maximum of four SAs,
 229 although admittedly it's hard to see why you would need more.
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257 <P>
 258
 259 <HR>
 260 <A NAME="index">&nbsp;</A><H2>Index</H2>
 261 <DL>
 262 <DT><A HREF="#lbAB">NAME</A><DD>
 263 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 264 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
 265 <DT><A HREF="#lbAE">EXAMPLES</A><DD>
 266 <DT><A HREF="#lbAF">FILES</A><DD>
 267 <DT><A HREF="#lbAG">SEE ALSO</A><DD>
 268 <DT><A HREF="#lbAH">HISTORY</A><DD>
 269 <DT><A HREF="#lbAI">BUGS</A><DD>
 270 </DL>
 271 <HR>
 272 This document was created by
 273 <A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
 274 using the manual pages.<BR>
 275 Time: 05:09:33 GMT, June 19, 2001
 276 </BODY>
 277 </HTML>