1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 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 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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry>
<refmeta>
<refentrytitle>IPSEC-_UPDOWN</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='date'>28 Oct 2006</refmiscinfo>
<refmiscinfo class="source">Libreswan</refmiscinfo>
<refmiscinfo class="version">@@IPSECVERSION@@</refmiscinfo>
<refmiscinfo class="manual">Executable programs</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>ipsec-_updown</refname>
<refpurpose>routing manipulation script</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<para>
<command>_updown</command>
is invoked by pluto when it has brought up a new connection. This script
is used to insert the appropriate routing entries for IPsec operation on
some kernel IPsec stacks, and may do other
necessary work that is kernel or user specific, such as defining custom
firewall rules.
The interface to the script is documented in the pluto man page.
</para>
</refsynopsisdiv>
<refsect1 id='variables'>
<title>VARIABLES</title>
<para>
The <command>_updown</command> is passed along a number of
variables which can be used to act differently based on the information:
</para>
<variablelist>
<varlistentry>
<term>
<emphasis>PLUTO_VERB</emphasis>
</term>
<listitem>
<para>
specifies the name of the operation to be performed, which
can be one of <option>prepare-host</option>, <option>prepare-client</option>,
<option>up-host</option>, <option>up-client</option>,
<option>down-host</option> or <option>down-client</option>. If the address
family for security gateway to security gateway communications is IPv6, then
a suffix of -v6 is added to this verb.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_CONNECTION</emphasis>
</term>
<listitem>
<para>
is the name of the connection for which we are routing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_NEXT_HOP</emphasis>
</term>
<listitem>
<para>
is the next hop to which packets bound for the peer must be sent.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_INTERFACE</emphasis>
</term>
<listitem>
<para>
is the name of the real interface used by encrypted traffic and IKE traffic.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_ME</emphasis>
</term>
<listitem>
<para>
is the IP address of our host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_MY_CLIENT</emphasis>
</term>
<listitem>
<para>
is the IP address / count of our client subnet. If the client
is just the host, this will be the host's own IP address / max
(where max is 32 for IPv4 and 128 for IPv6).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_MY_CLIENT_NET</emphasis>
</term>
<listitem>
<para>
is the IP address of our client net. If the client is just the
host, this will be the host's own IP address.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_MY_CLIENT_MASK</emphasis>
</term>
<listitem>
<para>
is the mask for our client net. If the client is just the host,
this will be 255.255.255.255.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER</emphasis>
</term>
<listitem>
<para>
is the IP address of our peer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_CLIENT</emphasis>
</term>
<listitem>
<para>
is the IP address / count of the peer's client subnet. If the
client is just the peer, this will be the peer's own IP address / max
(where max is 32 for IPv4 and 128 for IPv6).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_CLIENT_NET</emphasis>
</term>
<listitem>
<para>
is the IP address of the peer's client net. If the client is
just the peer, this will be the peer's own IP address.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_CLIENT_MASK</emphasis>
</term>
<listitem>
<para>
is the mask for the peer's client net. If the client is just
the peer, this will be 255.255.255.255.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_MY_PROTOCOL</emphasis>
</term>
<listitem>
<para>
lists the protocols allowed over this IPsec SA.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_PROTOCOL</emphasis>
</term>
<listitem>
<para>
lists the protocols the peer allows over this IPsec SA.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_MY_PORT</emphasis>
</term>
<listitem>
<para>
lists the ports allowed over this IPsec SA.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_PORT</emphasis>
</term>
<listitem>
<para>
lists the ports the peer allows over this IPsec SA.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_MY_ID</emphasis>
</term>
<listitem>
<para>
lists our id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_ID</emphasis>
</term>
<listitem>
<para>
lists our peer's id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis>PLUTO_PEER_CA</emphasis>
</term>
<listitem>
<para>
lists the peer's CA.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>ipsec</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec-pluto</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id='history'>
<title>HISTORY</title>
<para>
Man page written for the Linux FreeS/WAN project
<<ulink url='https://www.freeswan.org/'>https://www.freeswan.org/</ulink>>
by Michael Richardson. Original program written by Henry Spencer.
</para>
</refsect1>
<refsect1 id='author'>
<title>AUTHOR</title>
<para>
<author><personname><firstname>Paul</firstname><surname>Wouters</surname></personname></author>
</para>
</refsect1>
</refentry>
|